Commit | Line | Data |
---|---|---|
68dc0745 | 1 | =head1 NAME |
2 | ||
33fd49fb | 3 | perlfaq5 - Files and Formats ($Revision: 1.31 $, $Date: 2004/02/07 04:29:50 $) |
68dc0745 | 4 | |
5 | =head1 DESCRIPTION | |
6 | ||
7 | This section deals with I/O and the "f" issues: filehandles, flushing, | |
8 | formats, and footers. | |
9 | ||
5a964f20 | 10 | =head2 How do I flush/unbuffer an output filehandle? Why must I do this? |
68dc0745 | 11 | |
c90536be JH |
12 | Perl does not support truly unbuffered output (except |
13 | insofar as you can C<syswrite(OUT, $char, 1)>), although it | |
14 | does support is "command buffering", in which a physical | |
15 | write is performed after every output command. | |
16 | ||
17 | The C standard I/O library (stdio) normally buffers | |
18 | characters sent to devices so that there isn't a system call | |
19 | for each byte. In most stdio implementations, the type of | |
20 | output buffering and the size of the buffer varies according | |
21 | to the type of device. Perl's print() and write() functions | |
22 | normally buffer output, while syswrite() bypasses buffering | |
23 | all together. | |
24 | ||
25 | If you want your output to be sent immediately when you | |
26 | execute print() or write() (for instance, for some network | |
27 | protocols), you must set the handle's autoflush flag. This | |
28 | flag is the Perl variable $| and when it is set to a true | |
29 | value, Perl will flush the handle's buffer after each | |
30 | print() or write(). Setting $| affects buffering only for | |
31 | the currently selected default file handle. You choose this | |
32 | handle with the one argument select() call (see | |
c997c2e0 | 33 | L<perlvar/$E<verbar>> and L<perlfunc/select>). |
c90536be JH |
34 | |
35 | Use select() to choose the desired handle, then set its | |
36 | per-filehandle variables. | |
5a964f20 TC |
37 | |
38 | $old_fh = select(OUTPUT_HANDLE); | |
39 | $| = 1; | |
40 | select($old_fh); | |
41 | ||
c90536be | 42 | Some idioms can handle this in a single statement: |
5a964f20 TC |
43 | |
44 | select((select(OUTPUT_HANDLE), $| = 1)[0]); | |
818c4caa | 45 | |
c90536be | 46 | $| = 1, select $_ for select OUTPUT_HANDLE; |
5a964f20 | 47 | |
c90536be JH |
48 | Some modules offer object-oriented access to handles and their |
49 | variables, although they may be overkill if this is the only | |
50 | thing you do with them. You can use IO::Handle: | |
68dc0745 | 51 | |
52 | use IO::Handle; | |
53 | open(DEV, ">/dev/printer"); # but is this? | |
54 | DEV->autoflush(1); | |
55 | ||
c90536be | 56 | or IO::Socket: |
68dc0745 | 57 | |
58 | use IO::Socket; # this one is kinda a pipe? | |
c90536be | 59 | my $sock = IO::Socket::INET->new( 'www.example.com:80' ) ; |
68dc0745 | 60 | |
61 | $sock->autoflush(); | |
68dc0745 | 62 | |
63 | =head2 How do I change one line in a file/delete a line in a file/insert a line in the middle of a file/append to the beginning of a file? | |
64 | ||
1f089b22 JH |
65 | Use the Tie::File module, which is included in the standard |
66 | distribution since Perl 5.8.0. | |
68dc0745 | 67 | |
68 | =head2 How do I count the number of lines in a file? | |
69 | ||
70 | One fairly efficient way is to count newlines in the file. The | |
71 | following program uses a feature of tr///, as documented in L<perlop>. | |
72 | If your text file doesn't end with a newline, then it's not really a | |
73 | proper text file, so this may report one fewer line than you expect. | |
74 | ||
75 | $lines = 0; | |
76 | open(FILE, $filename) or die "Can't open `$filename': $!"; | |
77 | while (sysread FILE, $buffer, 4096) { | |
78 | $lines += ($buffer =~ tr/\n//); | |
79 | } | |
80 | close FILE; | |
81 | ||
5a964f20 TC |
82 | This assumes no funny games with newline translations. |
83 | ||
4750257b MJD |
84 | =head2 How can I use Perl's C<-i> option from within a program? |
85 | ||
86 | C<-i> sets the value of Perl's C<$^I> variable, which in turn affects | |
87 | the behavior of C<< <> >>; see L<perlrun> for more details. By | |
88 | modifying the appropriate variables directly, you can get the same | |
89 | behavior within a larger program. For example: | |
90 | ||
91 | # ... | |
92 | { | |
93 | local($^I, @ARGV) = ('.orig', glob("*.c")); | |
94 | while (<>) { | |
95 | if ($. == 1) { | |
96 | print "This line should appear at the top of each file\n"; | |
97 | } | |
98 | s/\b(p)earl\b/${1}erl/i; # Correct typos, preserving case | |
99 | print; | |
100 | close ARGV if eof; # Reset $. | |
101 | } | |
102 | } | |
103 | # $^I and @ARGV return to their old values here | |
104 | ||
105 | This block modifies all the C<.c> files in the current directory, | |
106 | leaving a backup of the original data from each file in a new | |
107 | C<.c.orig> file. | |
108 | ||
68dc0745 | 109 | =head2 How do I make a temporary file name? |
110 | ||
16394a69 | 111 | Use the File::Temp module, see L<File::Temp> for more information. |
68dc0745 | 112 | |
c997c2e0 | 113 | use File::Temp qw/ tempfile tempdir /; |
a6dd486b | 114 | |
16394a69 JH |
115 | $dir = tempdir( CLEANUP => 1 ); |
116 | ($fh, $filename) = tempfile( DIR => $dir ); | |
5a964f20 | 117 | |
16394a69 | 118 | # or if you don't need to know the filename |
5a964f20 | 119 | |
16394a69 | 120 | $fh = tempfile( DIR => $dir ); |
5a964f20 | 121 | |
16394a69 JH |
122 | The File::Temp has been a standard module since Perl 5.6.1. If you |
123 | don't have a modern enough Perl installed, use the C<new_tmpfile> | |
124 | class method from the IO::File module to get a filehandle opened for | |
125 | reading and writing. Use it if you don't need to know the file's name: | |
5a964f20 | 126 | |
16394a69 JH |
127 | use IO::File; |
128 | $fh = IO::File->new_tmpfile() | |
129 | or die "Unable to make new temporary file: $!"; | |
5a964f20 | 130 | |
a6dd486b JB |
131 | If you're committed to creating a temporary file by hand, use the |
132 | process ID and/or the current time-value. If you need to have many | |
133 | temporary files in one process, use a counter: | |
5a964f20 TC |
134 | |
135 | BEGIN { | |
68dc0745 | 136 | use Fcntl; |
16394a69 | 137 | my $temp_dir = -d '/tmp' ? '/tmp' : $ENV{TMPDIR} || $ENV{TEMP}; |
68dc0745 | 138 | my $base_name = sprintf("%s/%d-%d-0000", $temp_dir, $$, time()); |
139 | sub temp_file { | |
5a964f20 | 140 | local *FH; |
68dc0745 | 141 | my $count = 0; |
5a964f20 | 142 | until (defined(fileno(FH)) || $count++ > 100) { |
68dc0745 | 143 | $base_name =~ s/-(\d+)$/"-" . (1 + $1)/e; |
11af7da0 | 144 | # O_EXCL is required for security reasons. |
5a964f20 | 145 | sysopen(FH, $base_name, O_WRONLY|O_EXCL|O_CREAT); |
68dc0745 | 146 | } |
5a964f20 TC |
147 | if (defined(fileno(FH)) |
148 | return (*FH, $base_name); | |
68dc0745 | 149 | } else { |
150 | return (); | |
151 | } | |
152 | } | |
153 | } | |
154 | ||
68dc0745 | 155 | =head2 How can I manipulate fixed-record-length files? |
156 | ||
84f2a134 EM |
157 | The most efficient way is using L<pack()|perlfunc/"pack"> and |
158 | L<unpack()|perlfunc/"unpack">. This is faster than using | |
159 | L<substr()|perlfunc/"substr"> when taking many, many strings. It is | |
160 | slower for just a few. | |
5a964f20 TC |
161 | |
162 | Here is a sample chunk of code to break up and put back together again | |
163 | some fixed-format input lines, in this case from the output of a normal, | |
164 | Berkeley-style ps: | |
68dc0745 | 165 | |
166 | # sample input line: | |
167 | # 15158 p5 T 0:00 perl /home/tchrist/scripts/now-what | |
84f2a134 EM |
168 | my $PS_T = 'A6 A4 A7 A5 A*'; |
169 | open my $ps, '-|', 'ps'; | |
170 | print scalar <$ps>; | |
171 | my @fields = qw( pid tt stat time command ); | |
172 | while (<$ps>) { | |
173 | my %process; | |
174 | @process{@fields} = unpack($PS_T, $_); | |
175 | for my $field ( @fields ) { | |
176 | print "$field: <$process{$field}>\n"; | |
68dc0745 | 177 | } |
84f2a134 | 178 | print 'line=', pack($PS_T, @process{@fields} ), "\n"; |
68dc0745 | 179 | } |
180 | ||
84f2a134 EM |
181 | We've used a hash slice in order to easily handle the fields of each row. |
182 | Storing the keys in an array means it's easy to operate on them as a | |
183 | group or loop over them with for. It also avoids polluting the program | |
184 | with global variables and using symbolic references. | |
5a964f20 | 185 | |
68dc0745 | 186 | =head2 How can I make a filehandle local to a subroutine? How do I pass filehandles between subroutines? How do I make an array of filehandles? |
187 | ||
c90536be JH |
188 | As of perl5.6, open() autovivifies file and directory handles |
189 | as references if you pass it an uninitialized scalar variable. | |
190 | You can then pass these references just like any other scalar, | |
191 | and use them in the place of named handles. | |
68dc0745 | 192 | |
c90536be | 193 | open my $fh, $file_name; |
818c4caa | 194 | |
c90536be | 195 | open local $fh, $file_name; |
818c4caa | 196 | |
c90536be | 197 | print $fh "Hello World!\n"; |
818c4caa | 198 | |
c90536be | 199 | process_file( $fh ); |
68dc0745 | 200 | |
c90536be JH |
201 | Before perl5.6, you had to deal with various typeglob idioms |
202 | which you may see in older code. | |
68dc0745 | 203 | |
c90536be JH |
204 | open FILE, "> $filename"; |
205 | process_typeglob( *FILE ); | |
206 | process_reference( \*FILE ); | |
818c4caa | 207 | |
c90536be JH |
208 | sub process_typeglob { local *FH = shift; print FH "Typeglob!" } |
209 | sub process_reference { local $fh = shift; print $fh "Reference!" } | |
5a964f20 | 210 | |
c90536be JH |
211 | If you want to create many anonymous handles, you should |
212 | check out the Symbol or IO::Handle modules. | |
5a964f20 TC |
213 | |
214 | =head2 How can I use a filehandle indirectly? | |
215 | ||
216 | An indirect filehandle is using something other than a symbol | |
217 | in a place that a filehandle is expected. Here are ways | |
a6dd486b | 218 | to get indirect filehandles: |
5a964f20 TC |
219 | |
220 | $fh = SOME_FH; # bareword is strict-subs hostile | |
221 | $fh = "SOME_FH"; # strict-refs hostile; same package only | |
222 | $fh = *SOME_FH; # typeglob | |
223 | $fh = \*SOME_FH; # ref to typeglob (bless-able) | |
224 | $fh = *SOME_FH{IO}; # blessed IO::Handle from *SOME_FH typeglob | |
225 | ||
c90536be | 226 | Or, you can use the C<new> method from one of the IO::* modules to |
5a964f20 TC |
227 | create an anonymous filehandle, store that in a scalar variable, |
228 | and use it as though it were a normal filehandle. | |
229 | ||
5a964f20 TC |
230 | use IO::Handle; # 5.004 or higher |
231 | $fh = IO::Handle->new(); | |
232 | ||
233 | Then use any of those as you would a normal filehandle. Anywhere that | |
234 | Perl is expecting a filehandle, an indirect filehandle may be used | |
235 | instead. An indirect filehandle is just a scalar variable that contains | |
368c9434 | 236 | a filehandle. Functions like C<print>, C<open>, C<seek>, or |
c90536be | 237 | the C<< <FH> >> diamond operator will accept either a named filehandle |
5a964f20 TC |
238 | or a scalar variable containing one: |
239 | ||
240 | ($ifh, $ofh, $efh) = (*STDIN, *STDOUT, *STDERR); | |
241 | print $ofh "Type it: "; | |
242 | $got = <$ifh> | |
243 | print $efh "What was that: $got"; | |
244 | ||
368c9434 | 245 | If you're passing a filehandle to a function, you can write |
5a964f20 TC |
246 | the function in two ways: |
247 | ||
248 | sub accept_fh { | |
249 | my $fh = shift; | |
250 | print $fh "Sending to indirect filehandle\n"; | |
46fc3d4c | 251 | } |
252 | ||
5a964f20 | 253 | Or it can localize a typeglob and use the filehandle directly: |
46fc3d4c | 254 | |
5a964f20 TC |
255 | sub accept_fh { |
256 | local *FH = shift; | |
257 | print FH "Sending to localized filehandle\n"; | |
46fc3d4c | 258 | } |
259 | ||
5a964f20 TC |
260 | Both styles work with either objects or typeglobs of real filehandles. |
261 | (They might also work with strings under some circumstances, but this | |
262 | is risky.) | |
263 | ||
264 | accept_fh(*STDOUT); | |
265 | accept_fh($handle); | |
266 | ||
267 | In the examples above, we assigned the filehandle to a scalar variable | |
a6dd486b JB |
268 | before using it. That is because only simple scalar variables, not |
269 | expressions or subscripts of hashes or arrays, can be used with | |
270 | built-ins like C<print>, C<printf>, or the diamond operator. Using | |
8305e449 | 271 | something other than a simple scalar variable as a filehandle is |
5a964f20 TC |
272 | illegal and won't even compile: |
273 | ||
274 | @fd = (*STDIN, *STDOUT, *STDERR); | |
275 | print $fd[1] "Type it: "; # WRONG | |
276 | $got = <$fd[0]> # WRONG | |
277 | print $fd[2] "What was that: $got"; # WRONG | |
278 | ||
279 | With C<print> and C<printf>, you get around this by using a block and | |
280 | an expression where you would place the filehandle: | |
281 | ||
282 | print { $fd[1] } "funny stuff\n"; | |
283 | printf { $fd[1] } "Pity the poor %x.\n", 3_735_928_559; | |
284 | # Pity the poor deadbeef. | |
285 | ||
286 | That block is a proper block like any other, so you can put more | |
287 | complicated code there. This sends the message out to one of two places: | |
288 | ||
c997c2e0 | 289 | $ok = -x "/bin/cat"; |
5a964f20 | 290 | print { $ok ? $fd[1] : $fd[2] } "cat stat $ok\n"; |
c997c2e0 | 291 | print { $fd[ 1+ ($ok || 0) ] } "cat stat $ok\n"; |
5a964f20 TC |
292 | |
293 | This approach of treating C<print> and C<printf> like object methods | |
294 | calls doesn't work for the diamond operator. That's because it's a | |
295 | real operator, not just a function with a comma-less argument. Assuming | |
296 | you've been storing typeglobs in your structure as we did above, you | |
c90536be | 297 | can use the built-in function named C<readline> to read a record just |
c47ff5f1 | 298 | as C<< <> >> does. Given the initialization shown above for @fd, this |
c90536be | 299 | would work, but only because readline() requires a typeglob. It doesn't |
5a964f20 TC |
300 | work with objects or strings, which might be a bug we haven't fixed yet. |
301 | ||
302 | $got = readline($fd[0]); | |
303 | ||
304 | Let it be noted that the flakiness of indirect filehandles is not | |
305 | related to whether they're strings, typeglobs, objects, or anything else. | |
306 | It's the syntax of the fundamental operators. Playing the object | |
307 | game doesn't help you at all here. | |
46fc3d4c | 308 | |
68dc0745 | 309 | =head2 How can I set up a footer format to be used with write()? |
310 | ||
54310121 | 311 | There's no builtin way to do this, but L<perlform> has a couple of |
68dc0745 | 312 | techniques to make it possible for the intrepid hacker. |
313 | ||
314 | =head2 How can I write() into a string? | |
315 | ||
65acb1b1 | 316 | See L<perlform/"Accessing Formatting Internals"> for an swrite() function. |
68dc0745 | 317 | |
318 | =head2 How can I output my numbers with commas added? | |
319 | ||
49d635f9 RGS |
320 | This subroutine will add commas to your number: |
321 | ||
322 | sub commify { | |
323 | local $_ = shift; | |
324 | 1 while s/^([-+]?\d+)(\d{3})/$1,$2/; | |
325 | return $_; | |
326 | } | |
327 | ||
328 | This regex from Benjamin Goldberg will add commas to numbers: | |
68dc0745 | 329 | |
881bdbd4 | 330 | s/(^[-+]?\d+?(?=(?>(?:\d{3})+)(?!\d))|\G\d{3}(?=\d))/$1,/g; |
68dc0745 | 331 | |
49d635f9 | 332 | It is easier to see with comments: |
68dc0745 | 333 | |
881bdbd4 JH |
334 | s/( |
335 | ^[-+]? # beginning of number. | |
336 | \d{1,3}? # first digits before first comma | |
337 | (?= # followed by, (but not included in the match) : | |
338 | (?>(?:\d{3})+) # some positive multiple of three digits. | |
339 | (?!\d) # an *exact* multiple, not x * 3 + 1 or whatever. | |
340 | ) | |
341 | | # or: | |
342 | \G\d{3} # after the last group, get three digits | |
343 | (?=\d) # but they have to have more digits after them. | |
344 | )/$1,/xg; | |
46fc3d4c | 345 | |
68dc0745 | 346 | =head2 How can I translate tildes (~) in a filename? |
347 | ||
575cc754 JH |
348 | Use the <> (glob()) operator, documented in L<perlfunc>. Older |
349 | versions of Perl require that you have a shell installed that groks | |
350 | tildes. Recent perl versions have this feature built in. The | |
d6260402 | 351 | File::KGlob module (available from CPAN) gives more portable glob |
575cc754 | 352 | functionality. |
68dc0745 | 353 | |
354 | Within Perl, you may use this directly: | |
355 | ||
356 | $filename =~ s{ | |
357 | ^ ~ # find a leading tilde | |
358 | ( # save this in $1 | |
359 | [^/] # a non-slash character | |
360 | * # repeated 0 or more times (0 means me) | |
361 | ) | |
362 | }{ | |
363 | $1 | |
364 | ? (getpwnam($1))[7] | |
365 | : ( $ENV{HOME} || $ENV{LOGDIR} ) | |
366 | }ex; | |
367 | ||
5a964f20 | 368 | =head2 How come when I open a file read-write it wipes it out? |
68dc0745 | 369 | |
370 | Because you're using something like this, which truncates the file and | |
371 | I<then> gives you read-write access: | |
372 | ||
5a964f20 | 373 | open(FH, "+> /path/name"); # WRONG (almost always) |
68dc0745 | 374 | |
375 | Whoops. You should instead use this, which will fail if the file | |
c997c2e0 | 376 | doesn't exist. |
d92eb7b0 GS |
377 | |
378 | open(FH, "+< /path/name"); # open for update | |
379 | ||
c47ff5f1 | 380 | Using ">" always clobbers or creates. Using "<" never does |
d92eb7b0 | 381 | either. The "+" doesn't change this. |
68dc0745 | 382 | |
5a964f20 TC |
383 | Here are examples of many kinds of file opens. Those using sysopen() |
384 | all assume | |
68dc0745 | 385 | |
5a964f20 | 386 | use Fcntl; |
68dc0745 | 387 | |
5a964f20 | 388 | To open file for reading: |
68dc0745 | 389 | |
5a964f20 TC |
390 | open(FH, "< $path") || die $!; |
391 | sysopen(FH, $path, O_RDONLY) || die $!; | |
392 | ||
393 | To open file for writing, create new file if needed or else truncate old file: | |
394 | ||
395 | open(FH, "> $path") || die $!; | |
396 | sysopen(FH, $path, O_WRONLY|O_TRUNC|O_CREAT) || die $!; | |
397 | sysopen(FH, $path, O_WRONLY|O_TRUNC|O_CREAT, 0666) || die $!; | |
398 | ||
399 | To open file for writing, create new file, file must not exist: | |
400 | ||
401 | sysopen(FH, $path, O_WRONLY|O_EXCL|O_CREAT) || die $!; | |
402 | sysopen(FH, $path, O_WRONLY|O_EXCL|O_CREAT, 0666) || die $!; | |
403 | ||
404 | To open file for appending, create if necessary: | |
405 | ||
406 | open(FH, ">> $path") || die $!; | |
407 | sysopen(FH, $path, O_WRONLY|O_APPEND|O_CREAT) || die $!; | |
408 | sysopen(FH, $path, O_WRONLY|O_APPEND|O_CREAT, 0666) || die $!; | |
409 | ||
410 | To open file for appending, file must exist: | |
411 | ||
412 | sysopen(FH, $path, O_WRONLY|O_APPEND) || die $!; | |
413 | ||
414 | To open file for update, file must exist: | |
415 | ||
416 | open(FH, "+< $path") || die $!; | |
417 | sysopen(FH, $path, O_RDWR) || die $!; | |
418 | ||
419 | To open file for update, create file if necessary: | |
420 | ||
421 | sysopen(FH, $path, O_RDWR|O_CREAT) || die $!; | |
422 | sysopen(FH, $path, O_RDWR|O_CREAT, 0666) || die $!; | |
423 | ||
424 | To open file for update, file must not exist: | |
425 | ||
426 | sysopen(FH, $path, O_RDWR|O_EXCL|O_CREAT) || die $!; | |
427 | sysopen(FH, $path, O_RDWR|O_EXCL|O_CREAT, 0666) || die $!; | |
428 | ||
429 | To open a file without blocking, creating if necessary: | |
430 | ||
11af7da0 SD |
431 | sysopen(FH, "/foo/somefile", O_WRONLY|O_NDELAY|O_CREAT) |
432 | or die "can't open /foo/somefile: $!": | |
5a964f20 TC |
433 | |
434 | Be warned that neither creation nor deletion of files is guaranteed to | |
435 | be an atomic operation over NFS. That is, two processes might both | |
a6dd486b JB |
436 | successfully create or unlink the same file! Therefore O_EXCL |
437 | isn't as exclusive as you might wish. | |
68dc0745 | 438 | |
87275199 | 439 | See also the new L<perlopentut> if you have it (new for 5.6). |
65acb1b1 | 440 | |
338501c1 | 441 | =head2 Why do I sometimes get an "Argument list too long" when I use E<lt>*E<gt>? |
68dc0745 | 442 | |
c47ff5f1 | 443 | The C<< <> >> operator performs a globbing operation (see above). |
3a4b19e4 GS |
444 | In Perl versions earlier than v5.6.0, the internal glob() operator forks |
445 | csh(1) to do the actual glob expansion, but | |
68dc0745 | 446 | csh can't handle more than 127 items and so gives the error message |
447 | C<Argument list too long>. People who installed tcsh as csh won't | |
448 | have this problem, but their users may be surprised by it. | |
449 | ||
3a4b19e4 | 450 | To get around this, either upgrade to Perl v5.6.0 or later, do the glob |
d6260402 | 451 | yourself with readdir() and patterns, or use a module like File::KGlob, |
3a4b19e4 | 452 | one that doesn't use the shell to do globbing. |
68dc0745 | 453 | |
454 | =head2 Is there a leak/bug in glob()? | |
455 | ||
456 | Due to the current implementation on some operating systems, when you | |
457 | use the glob() function or its angle-bracket alias in a scalar | |
a6dd486b | 458 | context, you may cause a memory leak and/or unpredictable behavior. It's |
68dc0745 | 459 | best therefore to use glob() only in list context. |
460 | ||
c47ff5f1 | 461 | =head2 How can I open a file with a leading ">" or trailing blanks? |
68dc0745 | 462 | |
463 | Normally perl ignores trailing blanks in filenames, and interprets | |
464 | certain leading characters (or a trailing "|") to mean something | |
c997c2e0 | 465 | special. |
68dc0745 | 466 | |
881bdbd4 JH |
467 | The three argument form of open() lets you specify the mode |
468 | separately from the filename. The open() function treats | |
c997c2e0 | 469 | special mode characters and whitespace in the filename as |
881bdbd4 | 470 | literals |
65acb1b1 | 471 | |
881bdbd4 JH |
472 | open FILE, "<", " file "; # filename is " file " |
473 | open FILE, ">", ">file"; # filename is ">file" | |
65acb1b1 | 474 | |
881bdbd4 | 475 | It may be a lot clearer to use sysopen(), though: |
65acb1b1 TC |
476 | |
477 | use Fcntl; | |
478 | $badpath = "<<<something really wicked "; | |
a6dd486b | 479 | sysopen (FH, $badpath, O_WRONLY | O_CREAT | O_TRUNC) |
65acb1b1 | 480 | or die "can't open $badpath: $!"; |
68dc0745 | 481 | |
68dc0745 | 482 | =head2 How can I reliably rename a file? |
483 | ||
49d635f9 RGS |
484 | If your operating system supports a proper mv(1) utility or its |
485 | functional equivalent, this works: | |
68dc0745 | 486 | |
487 | rename($old, $new) or system("mv", $old, $new); | |
488 | ||
d2321c93 JH |
489 | It may be more portable to use the File::Copy module instead. |
490 | You just copy to the new file to the new name (checking return | |
491 | values), then delete the old one. This isn't really the same | |
492 | semantically as a rename(), which preserves meta-information like | |
68dc0745 | 493 | permissions, timestamps, inode info, etc. |
494 | ||
d2321c93 | 495 | Newer versions of File::Copy export a move() function. |
5a964f20 | 496 | |
68dc0745 | 497 | =head2 How can I lock a file? |
498 | ||
54310121 | 499 | Perl's builtin flock() function (see L<perlfunc> for details) will call |
68dc0745 | 500 | flock(2) if that exists, fcntl(2) if it doesn't (on perl version 5.004 and |
501 | later), and lockf(3) if neither of the two previous system calls exists. | |
502 | On some systems, it may even use a different form of native locking. | |
503 | Here are some gotchas with Perl's flock(): | |
504 | ||
505 | =over 4 | |
506 | ||
507 | =item 1 | |
508 | ||
509 | Produces a fatal error if none of the three system calls (or their | |
510 | close equivalent) exists. | |
511 | ||
512 | =item 2 | |
513 | ||
514 | lockf(3) does not provide shared locking, and requires that the | |
515 | filehandle be open for writing (or appending, or read/writing). | |
516 | ||
517 | =item 3 | |
518 | ||
d92eb7b0 GS |
519 | Some versions of flock() can't lock files over a network (e.g. on NFS file |
520 | systems), so you'd need to force the use of fcntl(2) when you build Perl. | |
a6dd486b | 521 | But even this is dubious at best. See the flock entry of L<perlfunc> |
d92eb7b0 GS |
522 | and the F<INSTALL> file in the source distribution for information on |
523 | building Perl to do this. | |
524 | ||
525 | Two potentially non-obvious but traditional flock semantics are that | |
a6dd486b | 526 | it waits indefinitely until the lock is granted, and that its locks are |
d92eb7b0 GS |
527 | I<merely advisory>. Such discretionary locks are more flexible, but |
528 | offer fewer guarantees. This means that files locked with flock() may | |
529 | be modified by programs that do not also use flock(). Cars that stop | |
530 | for red lights get on well with each other, but not with cars that don't | |
531 | stop for red lights. See the perlport manpage, your port's specific | |
532 | documentation, or your system-specific local manpages for details. It's | |
533 | best to assume traditional behavior if you're writing portable programs. | |
a6dd486b | 534 | (If you're not, you should as always feel perfectly free to write |
d92eb7b0 GS |
535 | for your own system's idiosyncrasies (sometimes called "features"). |
536 | Slavish adherence to portability concerns shouldn't get in the way of | |
537 | your getting your job done.) | |
68dc0745 | 538 | |
c997c2e0 | 539 | For more information on file locking, see also |
13a2d996 | 540 | L<perlopentut/"File Locking"> if you have it (new for 5.6). |
65acb1b1 | 541 | |
68dc0745 | 542 | =back |
543 | ||
338501c1 | 544 | =head2 Why can't I just open(FH, "E<gt>file.lock")? |
68dc0745 | 545 | |
546 | A common bit of code B<NOT TO USE> is this: | |
547 | ||
548 | sleep(3) while -e "file.lock"; # PLEASE DO NOT USE | |
549 | open(LCK, "> file.lock"); # THIS BROKEN CODE | |
550 | ||
551 | This is a classic race condition: you take two steps to do something | |
552 | which must be done in one. That's why computer hardware provides an | |
553 | atomic test-and-set instruction. In theory, this "ought" to work: | |
554 | ||
5a964f20 | 555 | sysopen(FH, "file.lock", O_WRONLY|O_EXCL|O_CREAT) |
dc904a75 | 556 | or die "can't open file.lock: $!"; |
68dc0745 | 557 | |
558 | except that lamentably, file creation (and deletion) is not atomic | |
559 | over NFS, so this won't work (at least, not every time) over the net. | |
65acb1b1 | 560 | Various schemes involving link() have been suggested, but |
46fc3d4c | 561 | these tend to involve busy-wait, which is also subdesirable. |
68dc0745 | 562 | |
fc36a67e | 563 | =head2 I still don't get locking. I just want to increment the number in the file. How can I do this? |
68dc0745 | 564 | |
46fc3d4c | 565 | Didn't anyone ever tell you web-page hit counters were useless? |
5a964f20 | 566 | They don't count number of hits, they're a waste of time, and they serve |
a6dd486b JB |
567 | only to stroke the writer's vanity. It's better to pick a random number; |
568 | they're more realistic. | |
68dc0745 | 569 | |
5a964f20 | 570 | Anyway, this is what you can do if you can't help yourself. |
68dc0745 | 571 | |
e2c57c3e | 572 | use Fcntl qw(:DEFAULT :flock); |
5a964f20 | 573 | sysopen(FH, "numfile", O_RDWR|O_CREAT) or die "can't open numfile: $!"; |
65acb1b1 | 574 | flock(FH, LOCK_EX) or die "can't flock numfile: $!"; |
68dc0745 | 575 | $num = <FH> || 0; |
576 | seek(FH, 0, 0) or die "can't rewind numfile: $!"; | |
577 | truncate(FH, 0) or die "can't truncate numfile: $!"; | |
578 | (print FH $num+1, "\n") or die "can't write numfile: $!"; | |
68dc0745 | 579 | close FH or die "can't close numfile: $!"; |
580 | ||
46fc3d4c | 581 | Here's a much better web-page hit counter: |
68dc0745 | 582 | |
583 | $hits = int( (time() - 850_000_000) / rand(1_000) ); | |
584 | ||
585 | If the count doesn't impress your friends, then the code might. :-) | |
586 | ||
f52f3be2 | 587 | =head2 All I want to do is append a small amount of text to the end of a file. Do I still have to use locking? |
05caf3a7 GJ |
588 | |
589 | If you are on a system that correctly implements flock() and you use the | |
590 | example appending code from "perldoc -f flock" everything will be OK | |
591 | even if the OS you are on doesn't implement append mode correctly (if | |
592 | such a system exists.) So if you are happy to restrict yourself to OSs | |
593 | that implement flock() (and that's not really much of a restriction) | |
594 | then that is what you should do. | |
595 | ||
596 | If you know you are only going to use a system that does correctly | |
597 | implement appending (i.e. not Win32) then you can omit the seek() from | |
598 | the above code. | |
599 | ||
600 | If you know you are only writing code to run on an OS and filesystem that | |
601 | does implement append mode correctly (a local filesystem on a modern | |
602 | Unix for example), and you keep the file in block-buffered mode and you | |
603 | write less than one buffer-full of output between each manual flushing | |
8305e449 | 604 | of the buffer then each bufferload is almost guaranteed to be written to |
05caf3a7 GJ |
605 | the end of the file in one chunk without getting intermingled with |
606 | anyone else's output. You can also use the syswrite() function which is | |
607 | simply a wrapper around your systems write(2) system call. | |
608 | ||
609 | There is still a small theoretical chance that a signal will interrupt | |
610 | the system level write() operation before completion. There is also a | |
611 | possibility that some STDIO implementations may call multiple system | |
612 | level write()s even if the buffer was empty to start. There may be some | |
613 | systems where this probability is reduced to zero. | |
614 | ||
68dc0745 | 615 | =head2 How do I randomly update a binary file? |
616 | ||
617 | If you're just trying to patch a binary, in many cases something as | |
618 | simple as this works: | |
619 | ||
620 | perl -i -pe 's{window manager}{window mangler}g' /usr/bin/emacs | |
621 | ||
622 | However, if you have fixed sized records, then you might do something more | |
623 | like this: | |
624 | ||
625 | $RECSIZE = 220; # size of record, in bytes | |
626 | $recno = 37; # which record to update | |
627 | open(FH, "+<somewhere") || die "can't update somewhere: $!"; | |
628 | seek(FH, $recno * $RECSIZE, 0); | |
629 | read(FH, $record, $RECSIZE) == $RECSIZE || die "can't read record $recno: $!"; | |
630 | # munge the record | |
65acb1b1 | 631 | seek(FH, -$RECSIZE, 1); |
68dc0745 | 632 | print FH $record; |
633 | close FH; | |
634 | ||
635 | Locking and error checking are left as an exercise for the reader. | |
a6dd486b | 636 | Don't forget them or you'll be quite sorry. |
68dc0745 | 637 | |
68dc0745 | 638 | =head2 How do I get a file's timestamp in perl? |
639 | ||
881bdbd4 JH |
640 | If you want to retrieve the time at which the file was last |
641 | read, written, or had its meta-data (owner, etc) changed, | |
642 | you use the B<-M>, B<-A>, or B<-C> file test operations as | |
643 | documented in L<perlfunc>. These retrieve the age of the | |
644 | file (measured against the start-time of your program) in | |
645 | days as a floating point number. Some platforms may not have | |
646 | all of these times. See L<perlport> for details. To | |
647 | retrieve the "raw" time in seconds since the epoch, you | |
648 | would call the stat function, then use localtime(), | |
649 | gmtime(), or POSIX::strftime() to convert this into | |
650 | human-readable form. | |
68dc0745 | 651 | |
652 | Here's an example: | |
653 | ||
654 | $write_secs = (stat($file))[9]; | |
c8db1d39 TC |
655 | printf "file %s updated at %s\n", $file, |
656 | scalar localtime($write_secs); | |
68dc0745 | 657 | |
658 | If you prefer something more legible, use the File::stat module | |
659 | (part of the standard distribution in version 5.004 and later): | |
660 | ||
65acb1b1 | 661 | # error checking left as an exercise for reader. |
68dc0745 | 662 | use File::stat; |
663 | use Time::localtime; | |
664 | $date_string = ctime(stat($file)->mtime); | |
665 | print "file $file updated at $date_string\n"; | |
666 | ||
65acb1b1 TC |
667 | The POSIX::strftime() approach has the benefit of being, |
668 | in theory, independent of the current locale. See L<perllocale> | |
669 | for details. | |
68dc0745 | 670 | |
671 | =head2 How do I set a file's timestamp in perl? | |
672 | ||
673 | You use the utime() function documented in L<perlfunc/utime>. | |
674 | By way of example, here's a little program that copies the | |
675 | read and write times from its first argument to all the rest | |
676 | of them. | |
677 | ||
678 | if (@ARGV < 2) { | |
679 | die "usage: cptimes timestamp_file other_files ...\n"; | |
680 | } | |
681 | $timestamp = shift; | |
682 | ($atime, $mtime) = (stat($timestamp))[8,9]; | |
683 | utime $atime, $mtime, @ARGV; | |
684 | ||
65acb1b1 | 685 | Error checking is, as usual, left as an exercise for the reader. |
68dc0745 | 686 | |
687 | Note that utime() currently doesn't work correctly with Win95/NT | |
688 | ports. A bug has been reported. Check it carefully before using | |
a6dd486b | 689 | utime() on those platforms. |
68dc0745 | 690 | |
691 | =head2 How do I print to more than one file at once? | |
692 | ||
49d635f9 RGS |
693 | To connect one filehandle to several output filehandles, |
694 | you can use the IO::Tee or Tie::FileHandle::Multiplex modules. | |
68dc0745 | 695 | |
49d635f9 RGS |
696 | If you only have to do this once, you can print individually |
697 | to each filehandle. | |
68dc0745 | 698 | |
49d635f9 | 699 | for $fh (FH1, FH2, FH3) { print $fh "whatever\n" } |
5a964f20 | 700 | |
49d635f9 | 701 | =head2 How can I read in an entire file all at once? |
68dc0745 | 702 | |
49d635f9 | 703 | You can use the File::Slurp module to do it in one step. |
68dc0745 | 704 | |
49d635f9 | 705 | use File::Slurp; |
c997c2e0 | 706 | |
49d635f9 RGS |
707 | $all_of_it = read_file($filename); # entire file in scalar |
708 | @all_lines = read_file($filename); # one line perl element | |
d92eb7b0 GS |
709 | |
710 | The customary Perl approach for processing all the lines in a file is to | |
711 | do so one line at a time: | |
712 | ||
713 | open (INPUT, $file) || die "can't open $file: $!"; | |
714 | while (<INPUT>) { | |
715 | chomp; | |
716 | # do something with $_ | |
c997c2e0 | 717 | } |
d92eb7b0 GS |
718 | close(INPUT) || die "can't close $file: $!"; |
719 | ||
720 | This is tremendously more efficient than reading the entire file into | |
721 | memory as an array of lines and then processing it one element at a time, | |
a6dd486b | 722 | which is often--if not almost always--the wrong approach. Whenever |
d92eb7b0 GS |
723 | you see someone do this: |
724 | ||
725 | @lines = <INPUT>; | |
726 | ||
30852c57 JH |
727 | you should think long and hard about why you need everything loaded at |
728 | once. It's just not a scalable solution. You might also find it more | |
729 | fun to use the standard Tie::File module, or the DB_File module's | |
730 | $DB_RECNO bindings, which allow you to tie an array to a file so that | |
731 | accessing an element the array actually accesses the corresponding | |
732 | line in the file. | |
d92eb7b0 | 733 | |
f05bbc40 | 734 | You can read the entire filehandle contents into a scalar. |
d92eb7b0 GS |
735 | |
736 | { | |
737 | local(*INPUT, $/); | |
738 | open (INPUT, $file) || die "can't open $file: $!"; | |
739 | $var = <INPUT>; | |
740 | } | |
741 | ||
c997c2e0 | 742 | That temporarily undefs your record separator, and will automatically |
d92eb7b0 GS |
743 | close the file at block exit. If the file is already open, just use this: |
744 | ||
745 | $var = do { local $/; <INPUT> }; | |
746 | ||
f05bbc40 JH |
747 | For ordinary files you can also use the read function. |
748 | ||
749 | read( INPUT, $var, -s INPUT ); | |
750 | ||
751 | The third argument tests the byte size of the data on the INPUT filehandle | |
752 | and reads that many bytes into the buffer $var. | |
753 | ||
68dc0745 | 754 | =head2 How can I read in a file by paragraphs? |
755 | ||
65acb1b1 | 756 | Use the C<$/> variable (see L<perlvar> for details). You can either |
68dc0745 | 757 | set it to C<""> to eliminate empty paragraphs (C<"abc\n\n\n\ndef">, |
758 | for instance, gets treated as two paragraphs and not three), or | |
759 | C<"\n\n"> to accept empty paragraphs. | |
760 | ||
c997c2e0 | 761 | Note that a blank line must have no blanks in it. Thus |
c4db748a | 762 | S<C<"fred\n \nstuff\n\n">> is one paragraph, but C<"fred\n\nstuff\n\n"> is two. |
65acb1b1 | 763 | |
68dc0745 | 764 | =head2 How can I read a single character from a file? From the keyboard? |
765 | ||
766 | You can use the builtin C<getc()> function for most filehandles, but | |
767 | it won't (easily) work on a terminal device. For STDIN, either use | |
a6dd486b | 768 | the Term::ReadKey module from CPAN or use the sample code in |
68dc0745 | 769 | L<perlfunc/getc>. |
770 | ||
65acb1b1 TC |
771 | If your system supports the portable operating system programming |
772 | interface (POSIX), you can use the following code, which you'll note | |
773 | turns off echo processing as well. | |
68dc0745 | 774 | |
775 | #!/usr/bin/perl -w | |
776 | use strict; | |
777 | $| = 1; | |
778 | for (1..4) { | |
779 | my $got; | |
780 | print "gimme: "; | |
781 | $got = getone(); | |
782 | print "--> $got\n"; | |
783 | } | |
784 | exit; | |
785 | ||
786 | BEGIN { | |
787 | use POSIX qw(:termios_h); | |
788 | ||
789 | my ($term, $oterm, $echo, $noecho, $fd_stdin); | |
790 | ||
791 | $fd_stdin = fileno(STDIN); | |
792 | ||
793 | $term = POSIX::Termios->new(); | |
794 | $term->getattr($fd_stdin); | |
795 | $oterm = $term->getlflag(); | |
796 | ||
797 | $echo = ECHO | ECHOK | ICANON; | |
798 | $noecho = $oterm & ~$echo; | |
799 | ||
800 | sub cbreak { | |
801 | $term->setlflag($noecho); | |
802 | $term->setcc(VTIME, 1); | |
803 | $term->setattr($fd_stdin, TCSANOW); | |
804 | } | |
805 | ||
806 | sub cooked { | |
807 | $term->setlflag($oterm); | |
808 | $term->setcc(VTIME, 0); | |
809 | $term->setattr($fd_stdin, TCSANOW); | |
810 | } | |
811 | ||
812 | sub getone { | |
813 | my $key = ''; | |
814 | cbreak(); | |
815 | sysread(STDIN, $key, 1); | |
816 | cooked(); | |
817 | return $key; | |
818 | } | |
819 | ||
820 | } | |
821 | ||
822 | END { cooked() } | |
823 | ||
a6dd486b | 824 | The Term::ReadKey module from CPAN may be easier to use. Recent versions |
65acb1b1 | 825 | include also support for non-portable systems as well. |
68dc0745 | 826 | |
827 | use Term::ReadKey; | |
828 | open(TTY, "</dev/tty"); | |
829 | print "Gimme a char: "; | |
830 | ReadMode "raw"; | |
831 | $key = ReadKey 0, *TTY; | |
832 | ReadMode "normal"; | |
833 | printf "\nYou said %s, char number %03d\n", | |
834 | $key, ord $key; | |
835 | ||
65acb1b1 | 836 | =head2 How can I tell whether there's a character waiting on a filehandle? |
68dc0745 | 837 | |
5a964f20 | 838 | The very first thing you should do is look into getting the Term::ReadKey |
65acb1b1 TC |
839 | extension from CPAN. As we mentioned earlier, it now even has limited |
840 | support for non-portable (read: not open systems, closed, proprietary, | |
841 | not POSIX, not Unix, etc) systems. | |
5a964f20 TC |
842 | |
843 | You should also check out the Frequently Asked Questions list in | |
68dc0745 | 844 | comp.unix.* for things like this: the answer is essentially the same. |
845 | It's very system dependent. Here's one solution that works on BSD | |
846 | systems: | |
847 | ||
848 | sub key_ready { | |
849 | my($rin, $nfd); | |
850 | vec($rin, fileno(STDIN), 1) = 1; | |
851 | return $nfd = select($rin,undef,undef,0); | |
852 | } | |
853 | ||
65acb1b1 TC |
854 | If you want to find out how many characters are waiting, there's |
855 | also the FIONREAD ioctl call to be looked at. The I<h2ph> tool that | |
856 | comes with Perl tries to convert C include files to Perl code, which | |
857 | can be C<require>d. FIONREAD ends up defined as a function in the | |
858 | I<sys/ioctl.ph> file: | |
68dc0745 | 859 | |
5a964f20 | 860 | require 'sys/ioctl.ph'; |
68dc0745 | 861 | |
5a964f20 TC |
862 | $size = pack("L", 0); |
863 | ioctl(FH, FIONREAD(), $size) or die "Couldn't call ioctl: $!\n"; | |
864 | $size = unpack("L", $size); | |
68dc0745 | 865 | |
5a964f20 TC |
866 | If I<h2ph> wasn't installed or doesn't work for you, you can |
867 | I<grep> the include files by hand: | |
68dc0745 | 868 | |
5a964f20 TC |
869 | % grep FIONREAD /usr/include/*/* |
870 | /usr/include/asm/ioctls.h:#define FIONREAD 0x541B | |
68dc0745 | 871 | |
5a964f20 | 872 | Or write a small C program using the editor of champions: |
68dc0745 | 873 | |
5a964f20 TC |
874 | % cat > fionread.c |
875 | #include <sys/ioctl.h> | |
876 | main() { | |
877 | printf("%#08x\n", FIONREAD); | |
878 | } | |
879 | ^D | |
65acb1b1 | 880 | % cc -o fionread fionread.c |
5a964f20 TC |
881 | % ./fionread |
882 | 0x4004667f | |
883 | ||
8305e449 | 884 | And then hard code it, leaving porting as an exercise to your successor. |
5a964f20 TC |
885 | |
886 | $FIONREAD = 0x4004667f; # XXX: opsys dependent | |
887 | ||
888 | $size = pack("L", 0); | |
889 | ioctl(FH, $FIONREAD, $size) or die "Couldn't call ioctl: $!\n"; | |
890 | $size = unpack("L", $size); | |
891 | ||
a6dd486b | 892 | FIONREAD requires a filehandle connected to a stream, meaning that sockets, |
5a964f20 | 893 | pipes, and tty devices work, but I<not> files. |
68dc0745 | 894 | |
895 | =head2 How do I do a C<tail -f> in perl? | |
896 | ||
897 | First try | |
898 | ||
899 | seek(GWFILE, 0, 1); | |
900 | ||
901 | The statement C<seek(GWFILE, 0, 1)> doesn't change the current position, | |
902 | but it does clear the end-of-file condition on the handle, so that the | |
903 | next <GWFILE> makes Perl try again to read something. | |
904 | ||
905 | If that doesn't work (it relies on features of your stdio implementation), | |
906 | then you need something more like this: | |
907 | ||
908 | for (;;) { | |
909 | for ($curpos = tell(GWFILE); <GWFILE>; $curpos = tell(GWFILE)) { | |
910 | # search for some stuff and put it into files | |
911 | } | |
912 | # sleep for a while | |
913 | seek(GWFILE, $curpos, 0); # seek to where we had been | |
914 | } | |
915 | ||
916 | If this still doesn't work, look into the POSIX module. POSIX defines | |
917 | the clearerr() method, which can remove the end of file condition on a | |
918 | filehandle. The method: read until end of file, clearerr(), read some | |
919 | more. Lather, rinse, repeat. | |
920 | ||
65acb1b1 TC |
921 | There's also a File::Tail module from CPAN. |
922 | ||
68dc0745 | 923 | =head2 How do I dup() a filehandle in Perl? |
924 | ||
925 | If you check L<perlfunc/open>, you'll see that several of the ways | |
926 | to call open() should do the trick. For example: | |
927 | ||
11af7da0 | 928 | open(LOG, ">>/foo/logfile"); |
68dc0745 | 929 | open(STDERR, ">&LOG"); |
930 | ||
931 | Or even with a literal numeric descriptor: | |
932 | ||
933 | $fd = $ENV{MHCONTEXTFD}; | |
934 | open(MHCONTEXT, "<&=$fd"); # like fdopen(3S) | |
935 | ||
c47ff5f1 | 936 | Note that "<&STDIN" makes a copy, but "<&=STDIN" make |
5a964f20 | 937 | an alias. That means if you close an aliased handle, all |
c997c2e0 | 938 | aliases become inaccessible. This is not true with |
5a964f20 TC |
939 | a copied one. |
940 | ||
941 | Error checking, as always, has been left as an exercise for the reader. | |
68dc0745 | 942 | |
943 | =head2 How do I close a file descriptor by number? | |
944 | ||
945 | This should rarely be necessary, as the Perl close() function is to be | |
946 | used for things that Perl opened itself, even if it was a dup of a | |
a6dd486b | 947 | numeric descriptor as with MHCONTEXT above. But if you really have |
68dc0745 | 948 | to, you may be able to do this: |
949 | ||
950 | require 'sys/syscall.ph'; | |
951 | $rc = syscall(&SYS_close, $fd + 0); # must force numeric | |
952 | die "can't sysclose $fd: $!" unless $rc == -1; | |
953 | ||
a6dd486b | 954 | Or, just use the fdopen(3S) feature of open(): |
d92eb7b0 | 955 | |
c997c2e0 JH |
956 | { |
957 | local *F; | |
d92eb7b0 GS |
958 | open F, "<&=$fd" or die "Cannot reopen fd=$fd: $!"; |
959 | close F; | |
960 | } | |
961 | ||
883f1635 | 962 | =head2 Why can't I use "C:\temp\foo" in DOS paths? Why doesn't `C:\temp\foo.exe` work? |
68dc0745 | 963 | |
964 | Whoops! You just put a tab and a formfeed into that filename! | |
965 | Remember that within double quoted strings ("like\this"), the | |
966 | backslash is an escape character. The full list of these is in | |
967 | L<perlop/Quote and Quote-like Operators>. Unsurprisingly, you don't | |
968 | have a file called "c:(tab)emp(formfeed)oo" or | |
65acb1b1 | 969 | "c:(tab)emp(formfeed)oo.exe" on your legacy DOS filesystem. |
68dc0745 | 970 | |
971 | Either single-quote your strings, or (preferably) use forward slashes. | |
46fc3d4c | 972 | Since all DOS and Windows versions since something like MS-DOS 2.0 or so |
68dc0745 | 973 | have treated C</> and C<\> the same in a path, you might as well use the |
a6dd486b | 974 | one that doesn't clash with Perl--or the POSIX shell, ANSI C and C++, |
65acb1b1 TC |
975 | awk, Tcl, Java, or Python, just to mention a few. POSIX paths |
976 | are more portable, too. | |
68dc0745 | 977 | |
978 | =head2 Why doesn't glob("*.*") get all the files? | |
979 | ||
980 | Because even on non-Unix ports, Perl's glob function follows standard | |
46fc3d4c | 981 | Unix globbing semantics. You'll need C<glob("*")> to get all (non-hidden) |
65acb1b1 TC |
982 | files. This makes glob() portable even to legacy systems. Your |
983 | port may include proprietary globbing functions as well. Check its | |
984 | documentation for details. | |
68dc0745 | 985 | |
986 | =head2 Why does Perl let me delete read-only files? Why does C<-i> clobber protected files? Isn't this a bug in Perl? | |
987 | ||
06a5f41f JH |
988 | This is elaborately and painstakingly described in the |
989 | F<file-dir-perms> article in the "Far More Than You Ever Wanted To | |
49d635f9 | 990 | Know" collection in http://www.cpan.org/misc/olddoc/FMTEYEWTK.tgz . |
68dc0745 | 991 | |
992 | The executive summary: learn how your filesystem works. The | |
993 | permissions on a file say what can happen to the data in that file. | |
994 | The permissions on a directory say what can happen to the list of | |
995 | files in that directory. If you delete a file, you're removing its | |
996 | name from the directory (so the operation depends on the permissions | |
997 | of the directory, not of the file). If you try to write to the file, | |
998 | the permissions of the file govern whether you're allowed to. | |
999 | ||
1000 | =head2 How do I select a random line from a file? | |
1001 | ||
1002 | Here's an algorithm from the Camel Book: | |
1003 | ||
1004 | srand; | |
1005 | rand($.) < 1 && ($line = $_) while <>; | |
1006 | ||
49d635f9 RGS |
1007 | This has a significant advantage in space over reading the whole file |
1008 | in. You can find a proof of this method in I<The Art of Computer | |
1009 | Programming>, Volume 2, Section 3.4.2, by Donald E. Knuth. | |
1010 | ||
1011 | You can use the File::Random module which provides a function | |
1012 | for that algorithm: | |
1013 | ||
1014 | use File::Random qw/random_line/; | |
1015 | my $line = random_line($filename); | |
1016 | ||
1017 | Another way is to use the Tie::File module, which treats the entire | |
1018 | file as an array. Simply access a random array element. | |
68dc0745 | 1019 | |
65acb1b1 TC |
1020 | =head2 Why do I get weird spaces when I print an array of lines? |
1021 | ||
1022 | Saying | |
1023 | ||
1024 | print "@lines\n"; | |
1025 | ||
1026 | joins together the elements of C<@lines> with a space between them. | |
1027 | If C<@lines> were C<("little", "fluffy", "clouds")> then the above | |
a6dd486b | 1028 | statement would print |
65acb1b1 TC |
1029 | |
1030 | little fluffy clouds | |
1031 | ||
1032 | but if each element of C<@lines> was a line of text, ending a newline | |
1033 | character C<("little\n", "fluffy\n", "clouds\n")> then it would print: | |
1034 | ||
1035 | little | |
1036 | fluffy | |
1037 | clouds | |
1038 | ||
1039 | If your array contains lines, just print them: | |
1040 | ||
1041 | print @lines; | |
1042 | ||
68dc0745 | 1043 | =head1 AUTHOR AND COPYRIGHT |
1044 | ||
0bc0ad85 | 1045 | Copyright (c) 1997-2002 Tom Christiansen and Nathan Torkington. |
5a964f20 TC |
1046 | All rights reserved. |
1047 | ||
5a7beb56 JH |
1048 | This documentation is free; you can redistribute it and/or modify it |
1049 | under the same terms as Perl itself. | |
c8db1d39 | 1050 | |
87275199 | 1051 | Irrespective of its distribution, all code examples here are in the public |
c8db1d39 TC |
1052 | domain. You are permitted and encouraged to use this code and any |
1053 | derivatives thereof in your own programs for fun or for profit as you | |
1054 | see fit. A simple comment in the code giving credit to the FAQ would | |
1055 | be courteous but is not required. |