~ubuntu-branches/ubuntu/intrepid/perl-doc-html/intrepid

<div id="breadCrumbs"><a href="../index.html">Home</a> > <a href="../index-modules-A.html">Core modules</a> > <a href="../index-modules-F.html">F</a> > Fink::Services</div>

<div id="contentBody"><div class="title_container"><div class="page_title">Fink::Services</div></div><ul><li><a href="#NAME">NAME</a><li><a href="#SYNOPSIS">SYNOPSIS</a><li><a href="#DESCRIPTION">DESCRIPTION</a><ul><li><a href="#Functions">Functions</a></ul></ul><a name="NAME"></a><h1>NAME</h1>

Fink::Services - functions for text processing and system interaction

<a name="SYNOPSIS"></a><h1>SYNOPSIS</h1>

<a name="DESCRIPTION"></a><h1>DESCRIPTION</h1>

These functions handle a variety of text (file and string) parsing and

system interaction tasks.

<a name="Functions"></a><h2>Functions</h2>

No functions are exported by default. You can get whichever ones you

need with things like:

<pre class="verbatim"> <a class="l_k" href="../functions/use.html">use</a> <a class="l_w" href="../Fink/Services.html">Fink::Services</a> '&read_config';

<a class="l_k" href="../functions/use.html">use</a> <a class="l_w" href="../Fink/Services.html">Fink::Services</a> qw(&execute_script &expand_percent);</pre>

<ul>

<li><a name="read_config"></a>read_config

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $config = read_config $filename;

<a class="l_k" href="../functions/my.html">my</a> $config = read_config $filename, \%defaults;</pre>

Reads a fink.conf file given by $filename into a new Fink::Config

100

object and initializes Fink::Config globals from it. If %defaults is

101

given they will be used as defaults for any keys not in the config

102

file. The new object is returned.

103

</li>

104

<li><a name="read_properties"></a>read_properties

105

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties $filename;

106

<a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties $filename, $notLC;</pre>

107

Reads a text file $filename and returns a ref to a hash of its

108

fields. See the description of read_properties_lines for more

109

information.

110

If $filename cannot be read, program will die with an error message.

111

</li>

112

<li><a name="read_properties_var"></a>read_properties_var

113

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_var $filename, $string;

114

<a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_var $filename, $string, $notLC;</pre>

115

Parses the multiline text $string and returns a ref to a hash of

116

its fields. See the description of read_properties_lines for more

117

information. The string $filename is used in parsing-error messages

118

but the file is not accessed.

119

</li>

120

<li><a name="read_properties_lines"></a>read_properties_lines

121

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_lines $filename, $notLC, @lines;</pre>

122

This is function is not exported. You should use read_properties_var,

123

read_properties, or read_properties_multival instead.

124

Parses the list of text strings @lines and returns a ref to a hash of

125

its fields. The string $filename is used in parsing-error messages but

126

the file is not accessed.

127

If $notLC is true, fields are treated in a case-sensitive manner. If

128

$notLC is false (including undef), field case is ignored (and

129

cannonicalized to lower-case). In functions where passing $notLC is

130

optional, not passing is equivalent to false.

131

See the Fink Packaging Manual, section 2.2 "File Format" for

132

information about the format of @lines text.

133

If errors are encountered while parsing @lines, messages are sent to

134

STDOUT, but whatever (possibly incorrect) parsing is returned anyway.

135

The following situations are checked:

136

<pre class="verbatim"> More than one occurance of a key. In this situation, the last

137

occurance encountered in @lines is the one returned. Note that the

138

same key can occur in the main package and/or different splitoff

139

packages, up to one time in each.</pre><pre class="verbatim"> Use of RFC-822-style multilining (whitespace indent of second and

140

subsequent lines). This notation has been deprecated in favor of

141

heredoc notation.</pre>

142

<pre class="verbatim"> Any unknown/invalid syntax.</pre>

143

<pre class="verbatim"> Reaching the end of @lines while a heredoc multiline value is still

144

145

Note that no check is made for the validity of the fields being in the

146

file in which they were encountered. The filetype (fink.conf, *.info,

147

etc.) is not necessarily known and this routine is used for many

148

different filetypes.

149

Multiline values (including all the lines of fields in a splitoff) are

150

returned as a single multiline string (i.e., with embedded \n), not as

151

a ref to another hash or array.

152

</li>

153

<li><a name="read_properties_multival"></a>read_properties_multival

154

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_multival $filename;

155

<a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_multival $filename, $notLC;</pre>

156

Reads a text file $filename and returns a ref to a hash of its fields,

157

with each value being a ref to a list of values for that field. See

158

the description of read_properties_multival_lines for more

159

information.

160

If $filename cannot be read, program will die with an error message.

161

</li>

162

<li><a name="read_properties_multival_var"></a>read_properties_multival_var

163

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_multival_var $filename, $string;

164

<a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_multival_var $filename, $string, $notLC;</pre>

165

Parses the multiline text $string and returns a ref to a hash of its

166

fields, with each value being a ref to a list of values for that

167

field. See the description of read_properties_multival_lines for more

168

information. The string $filename is used in parsing-error messages

169

but the file is not accessed.

170

</li>

171

<li><a name="read_properties_multival_lines"></a>read_properties_multival_lines

172

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $property_hash = read_properties_multival_lines $filename, $notLC, @lines;</pre>

173

This is function is not exported. You should use read_properties_var,

174

read_properties, read_properties_multival, or read_properties_multival_var

175

instead.

176

Parses the list of text strings @lines and returns a ref to a hash of

177

its fields, with each value being a ref to a list of values for that

178

field. The string $filename is used in parsing-error messages but the

179

file is not accessed.

180

The function is similar to read_properties_lines, with the following

181

differences:

182

<pre class="verbatim"> Multiline values are can only be given in RFC-822 style notation,

183

not with heredoc.</pre><pre class="verbatim"> No sanity-checking is performed. Lines that could not be parsed are

184

silently ignored.</pre>

185

<pre class="verbatim"> Multiple occurances of a field are allowed.</pre>

186

<pre class="verbatim"> Each hash value is a <a class="l_k" href="../functions/ref.html">ref</a> to a list of key <a class="l_k" href="../functions/values.html">values</a> instead of a simple

187

value string. The list is in the order the <a class="l_k" href="../functions/values.html">values</a> appear in @lines.</pre>

188

</li>

189

<li><a name="execute"></a>execute

190

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $retval = execute $cmd;

191

<a class="l_k" href="../functions/my.html">my</a> $retval = execute $cmd, $quiet;</pre>

192

Executes $cmd as a single string via a perl system() call and returns

193

the exit code from it. The command is printed on STDOUT before being

194

executed. If $cmd begins with a # (preceeded optionally by whitespace)

195

it is treated as a comment and is not executed. If $quiet is false (or

196

not given) and the command failed, a message including the return code

197

is sent to STDOUT.

198

</li>

199

<li><a name="execute_script"></a>execute_script

200

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $retval = execute_script $script;

201

<a class="l_k" href="../functions/my.html">my</a> $retval = execute_script $script, $quiet;</pre>

202

Executes the multiline script $script.

203

If $script appears to specify an interpretter (i.e., the first line

204

begins with #!) the whole thing is stored in a temp file which is made

205

chmod +x and executed. If the tempfile could not be created, the

206

program dies with an error message. If executing the script fails, the

207

tempfile is not deleted and the failure code is returned.

208

If $script does not specify an interpretter, each line is executed

209

individually. In this latter case, the first line that fails causes

210

further lines to not be executed and the failure code is returned.

211

In either case, execution is performed by Fink::Services::execute

212

(which see for more information, including the meaning of $quiet).

213

</li>

214

<li><a name="expand_percent"></a>expand_percent

215

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $string = expand_percent $template;

216

<a class="l_k" href="../functions/my.html">my</a> $string = expand_percent $template, \%map;

217

218

Performs percent-expansion on the given multiline $template according

219

to %map (if one is defined). If a line in $template begins with #

220

(possibly preceeded with whitespace) it is treated as a comment and no

221

expansion is performed on that line.

222

The %map is a hash where the keys are the strings to be replaced (not

223

including the percent char). The mapping can be recursive (i.e., a

224

value that itself has a percent char), and multiple substitution

225

passes are made to deal with this situation. Recursing is currently

226

limitted to a single additional level (only (up to) two passes are

227

made). If there are still % chars left after the recursion, that means

228

$template needs more passes (beyond the recursion limit) or there are

229

% patterns in $template that are not in %map. If either of these two

230

cases occurs, the program will die with an error message. If given,

231

$err_info will be appended to this error message.

232

To get an actual percent char in the string, protect it as %% in

233

$template (similar to printf()). This occurs whether or not there is a

234

%map. This behavior is implemented internally in the function, so you

235

should not have ('%'=>'%') in %map. Pecent-delimited percent chars are

236

left-associative (again as in printf()).

237

Expansion keys are not limitted to single letters, however, having one

238

expansion key that is the beginning of a longer one (d and dir) will

239

cause unpredictable results (i.e., "a" and "arch" is bad but "c" and

240

"arch" is okay).

241

Curly-braces can be used to explicitly delimit a key. If both %f and

242

%foo exist, one should use %{foo} and %{f} to avoid ambiguity.

243

</li>

244

<li><a name="filename"></a>filename

245

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $file = filename $source_field;</pre>

246

Treats $source_field as a URL or "mirror:" construct as might be found

247

in Source: fields of a .info file and returns just the filename (skips

248

URL proto/host or mirror-type, and directory hierarchy). Note that the

249

presence of colons in the filename will break this function.

250

</li>

251

<li><a name="version_cmp"></a>version_cmp

252

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $bool = version_cmp $fullversion1, $op, $fullversion2;</pre>

253

Compares the two debian version strings $fullversion1 and

254

$fullversion2 according to the binary operator $op. Each version

255

string is of the form epoch:version-revision (though one or more of

256

these components may be omitted as usual--see the Debian Policy

257

Manual, section 5.6.11 "Version" for more information). The operators

258

are those used in the debian-package world: << and>> for

259

strictly-less-than and strictly-greater-than, <= and >= for

260

less-than-or-equal-to and greater-than-or-equal-to, and = for

261

equal-to.

262

The results of the basic comparison (similar to the perl <=> and cmp

263

operators) are cached in a package variable so repeated queries about

264

the same two version strings does not require repeated parsing and

265

element-by-element comparison. The result is cached in both the order

266

the packages are given and the reverse, so these later requests can be

267

either direction.

268

</li>

269

<li><a name="raw_version_cmp"></a>raw_version_cmp

270

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $cmp = raw_version_cmp $item1, $item2;</pre>

271

This is function is not exported. You should use version_cmp instead.

272

Compare $item1 and $item2 as debian epoch or version or revision

273

strings and return -1, 0, 1 as for the perl <=> or cmp operators.

274

</li>

275

<li><a name="latest_version"></a>latest_version

276

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $latest = latest_version @versionstrings;</pre>

277

Given a list of one or more debian version strings, return the one

278

that is the highest. See the Debian Policy Manual, section 5.6.11

279

"Version" for more information.

280

</li>

281

<li><a name="sort_versions-%7b"></a>sort_versions {

282

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> @sorted = sort_versions @versionstrings;</pre>

283

Given a list of one or more debian version strings, return the list

284

sorted lowest-to-highest. See the Debian Policy Manual, section 5.6.11

285

"Version" for more information.

286

</li>

287

<li><a name="parse_fullversion"></a>parse_fullversion

288

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> ($epoch, $version, $revision) = parse_fullversion $versionstring;</pre>

289

Parses the given $versionstring of the form epoch:version-revision and

290

returns a list of the three components. Epoch and revision are each

291

optional and default to zero if absent. Epoch must contain only

292

numbers and revision must not contain any hyphens.

293

If there is an error parsing $versionstring, () is returned.

294

</li>

295

<li><a name="collapse_space"></a>collapse_space

296

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $pretty_text = collapse_space $original_text;</pre>

297

Collapses whitespace inside a string. All whitespace sequences are

298

converted to a single space char. Newlines are removed.

299

</li>

300

<li><a name="pkglist2lol"></a>pkglist2lol

301

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $struct = pkglist2lol $pkglist;</pre>

302

Takes a string representing a pkglist field and returns a ref to a

303

list of lists of strings representing each pkg. The elements of the

304

list referenced by $struct are joined by logical AND (commas in

305

$pkglist). The pkgs in each list referenced by an element of @$srtuct

306

are joined by logical OR (delimited by vertical-bar within a comma-

307

delimited cluster). Leading and trailing whitespace are removed from

308

each pkg, and null pkgs are removed. A ref to an array is always

309

returned, though it may contain no elements. Each element of @$struct

310

is always an array ref, even if that list only has one element; none

311

of these will have no elements. A new $struct is returned on each

312

call, so changing one returned value does not afect the data returned

313

by another call or the underlying data.

314

</li>

315

<li><a name="lol2pkglist"></a>lol2pkglist

316

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $pkglist = lol2pkglist $struct;</pre>

317

Given a ref to a list of lists of pkgs, reconstitute the Debian

318

pkglist string. Blank/whitespace-only/undef elements are removed. The

319

return is always defined (though it may be null). $struct is not

320

modified.

321

</li>

322

<li><a name="file_MD5_checksum"></a>file_MD5_checksum

323

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $md5 = file_MD5_checksum $filename;</pre>

324

Returns the MD5 checksum of the given $filename. Uses /sbin/md5 if it

325

is available, otherwise uses the first md5sum in PATH. The output of

326

the chosen command is read via an open() pipe and matched against the

327

appropriate regexp. If the command returns failure or its output was

328

not in the expected format, the program dies with an error message.

329

</li>

330

<li><a name="get_arch"></a>get_arch

331

332

Returns the architecture string to be used on this platform. For

333

example, "powerpc" for ppc.

334

</li>

335

<li><a name="enforce_gcc"></a>enforce_gcc

336

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $gcc = enforce_gcc($message);

337

<a class="l_k" href="../functions/my.html">my</a> $gcc = enforce_gcc($message, $gcc_abi);</pre>

338

Check to see if the gcc version optionally supplied in $gcc_abi is the

339

same as the default GCC ABI for the installed version of Mac OS X or Darwin.

340

If it is not, we return the value for the deafult GCC ABI.

341

If it is, or if $gcc_abi is not supplied, then we check to see if the

342

gcc version obtained from /usr/sbin/gcc_select agrees with the expected

343

(default) gcc version corresponding to the installed version of

344

Mac OS X or Darwin. If the versions agree, the common value is returned.

345

If they do not agree, we print $message and exit fink.

346

The strings CURRENT_SYSTEM, INSTALLED_GCC, EXPECTED_GCC, and

347

GCC_SELECT_COMMAND within $message are converted to appropriate values.

348

Sample message:

349

This package must be compiled with GCC EXPECTED_GCC, but you currently have

350

GCC INSTALLED_GCC selected. To correct this problem, run the command:

351

<pre class="verbatim"> sudo gcc_select GCC_SELECT_COMMAND</pre>

352

(You may need to install a more recent version of the Developer Tools to be

353

able to do so.)

354

</li>

355

<li><a name="get_sw_vers"></a>get_sw_vers

356

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $os_x_version = get_sw_vers;</pre>

357

Returns OS X version (if that's what this platform appears to be, as

358

indicated by being able to run /usr/bin/sw_vers). The output of that

359

command is parsed and cached in a global configuration option in the

360

Fink::Config package so that multiple calls to this function do not

361

result in repeated spawning of sw_vers processes.

362

</li>

363

<li><a name="get_system_perl_version"></a>get_system_perl_version

364

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $perlversion = get_system_perl_version;</pre>

365

Returns the version of perl in that is /usr/bin/perl by running a

366

program with it to return its $^V variable. The value is cached, so

367

multiple calls to this function do not result in repeated spawning of

368

perl processes.

369

</li>

370

<li><a name="get_path"></a>get_path

371

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $path_to_file = get_path $filename;</pre>

372

Returns the full pathname of the first executable occurance of

373

$filename in PATH. The correct platform-dependent pathname separator

374

is used. This is an all-perl routine that emulates 'which' in csh.

375

</li>

376

<li><a name="count_files"></a>count_files

377

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $number_of_files = &count_files($path, $regexp);</pre>

378

Returns the number of files in $path. If $regexp is set only

379

files matching the regexp are returned.

380

</li>

381

<li><a name="eval_conditional"></a>eval_conditional

382

<pre class="verbatim"> <a class="l_k" href="../functions/my.html">my</a> $bool = &eval_conditional($expr, $where);</pre>

383

Evaluates the logical expression passed as a string in $expr and

384

returns its logical value. If there is a parsing error, abort and

385

print a message (including $where) is printed. Two syntaxes are

386

supported:

387

Leading and trailing whitespace is ignored. The strings themselves cannot

388

contain whitespace or any of the op operators (no quoting, delimiting,

389

or protection syntax is implemented).

390

</li>

391

</ul>

392

</div>

393

394

</div>

395

</div>

396

397

398

399

400

401

</div>

402

<h1>Search:</h1>

403

404

405

406

407

</form>

408

409

<h2>Labels:</h2>

410

411

412

413

414

</div>

415

</div>

416

</div>

417

418

</div>

419

420

</body>

421

</html>

Older »