[inseparable changes from match from perl-5.003_97g to perl-5.003_97h]
[p5sagit/p5-mst-13.2.git] / pod / perlfaq5.pod
CommitLineData
68dc0745 1=head1 NAME
2
46fc3d4c 3perlfaq5 - Files and Formats ($Revision: 1.21 $, $Date: 1997/04/23 18:05:19 $)
68dc0745 4
5=head1 DESCRIPTION
6
7This section deals with I/O and the "f" issues: filehandles, flushing,
8formats, and footers.
9
10=head2 How do I flush/unbuffer a filehandle? Why must I do this?
11
12The C standard I/O library (stdio) normally buffers characters sent to
13devices. This is done for efficiency reasons, so that there isn't a
14system call for each byte. Any time you use print() or write() in
15Perl, you go though this buffering. syswrite() circumvents stdio and
16buffering.
17
18In most stdio implementations, the type of buffering and the size of
19the buffer varies according to the type of device. Disk files are block
20buffered, often with a buffer size of more than 2k. Pipes and sockets
21are often buffered with a buffer size between 1/2 and 2k. Serial devices
22(e.g. modems, terminals) are normally line-buffered, and stdio sends
23the entire line when it gets the newline.
24
25Perl does not support truly unbuffered output (except insofar as you can
26C<syswrite(OUT, $char, 1)>). What it does instead support is "command
27buffering", in which a physical write is performed after every output
28command. This isn't as hard on your system as unbuffering, but does
29get the output where you want it when you want it.
30
31If you expect characters to get to your device when you print them there,
32you'll want to autoflush its handle, as in the older:
33
34 use FileHandle;
35 open(DEV, "<+/dev/tty"); # ceci n'est pas une pipe
36 DEV->autoflush(1);
37
38or the newer IO::* modules:
39
40 use IO::Handle;
41 open(DEV, ">/dev/printer"); # but is this?
42 DEV->autoflush(1);
43
44or even this:
45
46 use IO::Socket; # this one is kinda a pipe?
47 $sock = IO::Socket::INET->new(PeerAddr => 'www.perl.com',
48 PeerPort => 'http(80)',
49 Proto => 'tcp');
50 die "$!" unless $sock;
51
52 $sock->autoflush();
53 $sock->print("GET /\015\012");
54 $document = join('', $sock->getlines());
55 print "DOC IS: $document\n";
56
57Note the hardcoded carriage return and newline in their octal
58equivalents. This is the ONLY way (currently) to assure a proper
59flush on all platforms, including Macintosh.
60
61You can use select() and the C<$|> variable to control autoflushing
62(see L<perlvar/$|> and L<perlfunc/select>):
63
64 $oldh = select(DEV);
65 $| = 1;
66 select($oldh);
67
68You'll also see code that does this without a temporary variable, as in
69
70 select((select(DEV), $| = 1)[0]);
71
72=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?
73
74Although humans have an easy time thinking of a text file as being a
75sequence of lines that operates much like a stack of playing cards --
76or punch cards -- computers usually see the text file as a sequence of
77bytes. In general, there's no direct way for Perl to seek to a
78particular line of a file, insert text into a file, or remove text
79from a file.
80
81(There are exceptions in special circumstances. Replacing a sequence
82of bytes with another sequence of the same length is one. Another is
83using the C<$DB_RECNO> array bindings as documented in L<DB_File>.
84Yet another is manipulating files with all lines the same length.)
85
86The general solution is to create a temporary copy of the text file with
87the changes you want, then copy that over the original.
88
89 $old = $file;
90 $new = "$file.tmp.$$";
91 $bak = "$file.bak";
92
93 open(OLD, "< $old") or die "can't open $old: $!";
94 open(NEW, "> $new") or die "can't open $new: $!";
95
96 # Correct typos, preserving case
97 while (<OLD>) {
98 s/\b(p)earl\b/${1}erl/i;
99 (print NEW $_) or die "can't write to $new: $!";
100 }
101
102 close(OLD) or die "can't close $old: $!";
103 close(NEW) or die "can't close $new: $!";
104
105 rename($old, $bak) or die "can't rename $old to $bak: $!";
106 rename($new, $old) or die "can't rename $new to $old: $!";
107
108Perl can do this sort of thing for you automatically with the C<-i>
46fc3d4c 109command-line switch or the closely-related C<$^I> variable (see
68dc0745 110L<perlrun> for more details). Note that
111C<-i> may require a suffix on some non-Unix systems; see the
112platform-specific documentation that came with your port.
113
114 # Renumber a series of tests from the command line
115 perl -pi -e 's/(^\s+test\s+)\d+/ $1 . ++$count /e' t/op/taint.t
116
117 # form a script
118 local($^I, @ARGV) = ('.bak', glob("*.c"));
119 while (<>) {
120 if ($. == 1) {
121 print "This line should appear at the top of each file\n";
122 }
123 s/\b(p)earl\b/${1}erl/i; # Correct typos, preserving case
124 print;
125 close ARGV if eof; # Reset $.
126 }
127
128If you need to seek to an arbitrary line of a file that changes
129infrequently, you could build up an index of byte positions of where
130the line ends are in the file. If the file is large, an index of
131every tenth or hundredth line end would allow you to seek and read
132fairly efficiently. If the file is sorted, try the look.pl library
133(part of the standard perl distribution).
134
135In the unique case of deleting lines at the end of a file, you
136can use tell() and truncate(). The following code snippet deletes
137the last line of a file without making a copy or reading the
138whole file into memory:
139
140 open (FH, "+< $file");
54310121 141 while ( <FH> ) { $addr = tell(FH) unless eof(FH) }
68dc0745 142 truncate(FH, $addr);
143
144Error checking is left as an exercise for the reader.
145
146=head2 How do I count the number of lines in a file?
147
148One fairly efficient way is to count newlines in the file. The
149following program uses a feature of tr///, as documented in L<perlop>.
150If your text file doesn't end with a newline, then it's not really a
151proper text file, so this may report one fewer line than you expect.
152
153 $lines = 0;
154 open(FILE, $filename) or die "Can't open `$filename': $!";
155 while (sysread FILE, $buffer, 4096) {
156 $lines += ($buffer =~ tr/\n//);
157 }
158 close FILE;
159
160=head2 How do I make a temporary file name?
161
162Use the process ID and/or the current time-value. If you need to have
163many temporary files in one process, use a counter:
164
165 BEGIN {
166 use IO::File;
167 use Fcntl;
168 my $temp_dir = -d '/tmp' ? '/tmp' : $ENV{TMP} || $ENV{TEMP};
169 my $base_name = sprintf("%s/%d-%d-0000", $temp_dir, $$, time());
170 sub temp_file {
171 my $fh = undef;
172 my $count = 0;
173 until (defined($fh) || $count > 100) {
174 $base_name =~ s/-(\d+)$/"-" . (1 + $1)/e;
175 $fh = IO::File->new($base_name, O_WRONLY|O_EXCL|O_CREAT, 0644)
176 }
177 if (defined($fh)) {
178 return ($fh, $base_name);
179 } else {
180 return ();
181 }
182 }
183 }
184
185Or you could simply use IO::Handle::new_tmpfile.
186
187=head2 How can I manipulate fixed-record-length files?
188
189The most efficient way is using pack() and unpack(). This is faster
190than using substr(). Here is a sample chunk of code to break up and
191put back together again some fixed-format input lines, in this case
192from the output of a normal, Berkeley-style ps:
193
194 # sample input line:
195 # 15158 p5 T 0:00 perl /home/tchrist/scripts/now-what
196 $PS_T = 'A6 A4 A7 A5 A*';
197 open(PS, "ps|");
198 $_ = <PS>; print;
199 while (<PS>) {
200 ($pid, $tt, $stat, $time, $command) = unpack($PS_T, $_);
201 for $var (qw!pid tt stat time command!) {
202 print "$var: <$$var>\n";
203 }
204 print 'line=', pack($PS_T, $pid, $tt, $stat, $time, $command),
205 "\n";
206 }
207
208=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?
209
210You may have some success with typeglobs, as we always had to use
211in days of old:
212
213 local(*FH);
214
215But while still supported, that isn't the best to go about getting
216local filehandles. Typeglobs have their drawbacks. You may well want
217to use the C<FileHandle> module, which creates new filehandles for you
218(see L<FileHandle>):
219
220 use FileHandle;
221 sub findme {
222 my $fh = FileHandle->new();
223 open($fh, "</etc/hosts") or die "no /etc/hosts: $!";
224 while (<$fh>) {
225 print if /\b127\.(0\.0\.)?1\b/;
226 }
227 # $fh automatically closes/disappears here
228 }
229
230Internally, Perl believes filehandles to be of class IO::Handle. You
231may use that module directly if you'd like (see L<IO::Handle>), or
232one of its more specific derived classes.
233
46fc3d4c 234Once you have IO::File or FileHandle objects, you can pass them
235between subroutines or store them in hashes as you would any other
236scalar values:
237
238 use FileHandle;
239
240 # Storing filehandles in a hash and array
241 foreach $filename (@names) {
242 my $fh = new FileHandle($filename) or die;
243 $file{$filename} = $fh;
244 push(@files, $fh);
245 }
246
247 # Using the filehandles in the array
248 foreach $file (@files) {
249 print $file "Testing\n";
250 }
251
252 # You have to do the { } ugliness when you're specifying the
253 # filehandle by anything other than a simple scalar variable.
254 print { $files[2] } "Testing\n";
255
256 # Passing filehandles to subroutines
257 sub debug {
258 my $filehandle = shift;
259 printf $filehandle "DEBUG: ", @_;
260 }
261
262 debug($fh, "Testing\n");
263
68dc0745 264=head2 How can I set up a footer format to be used with write()?
265
54310121 266There's no builtin way to do this, but L<perlform> has a couple of
68dc0745 267techniques to make it possible for the intrepid hacker.
268
269=head2 How can I write() into a string?
270
271See L<perlform> for an swrite() function.
272
273=head2 How can I output my numbers with commas added?
274
275This one will do it for you:
276
277 sub commify {
278 local $_ = shift;
279 1 while s/^(-?\d+)(\d{3})/$1,$2/;
280 return $_;
281 }
282
283 $n = 23659019423.2331;
284 print "GOT: ", commify($n), "\n";
285
286 GOT: 23,659,019,423.2331
287
288You can't just:
289
290 s/^(-?\d+)(\d{3})/$1,$2/g;
291
292because you have to put the comma in and then recalculate your
293position.
294
46fc3d4c 295Alternatively, this commifies all numbers in a line regardless of
296whether they have decimal portions, are preceded by + or -, or
297whatever:
298
299 # from Andrew Johnson <ajohnson@gpu.srv.ualberta.ca>
300 sub commify {
301 my $input = shift;
302 $input = reverse $input;
303 $input =~ s<(\d\d\d)(?=\d)(?!\d*\.)><$1,>g;
304 return reverse $input;
305 }
306
68dc0745 307=head2 How can I translate tildes (~) in a filename?
308
309Use the E<lt>E<gt> (glob()) operator, documented in L<perlfunc>. This
310requires that you have a shell installed that groks tildes, meaning
311csh or tcsh or (some versions of) ksh, and thus may have portability
312problems. The Glob::KGlob module (available from CPAN) gives more
313portable glob functionality.
314
315Within Perl, you may use this directly:
316
317 $filename =~ s{
318 ^ ~ # find a leading tilde
319 ( # save this in $1
320 [^/] # a non-slash character
321 * # repeated 0 or more times (0 means me)
322 )
323 }{
324 $1
325 ? (getpwnam($1))[7]
326 : ( $ENV{HOME} || $ENV{LOGDIR} )
327 }ex;
328
329=head2 How come when I open the file read-write it wipes it out?
330
331Because you're using something like this, which truncates the file and
332I<then> gives you read-write access:
333
334 open(FH, "+> /path/name"); # WRONG
335
336Whoops. You should instead use this, which will fail if the file
337doesn't exist.
338
339 open(FH, "+< /path/name"); # open for update
340
341If this is an issue, try:
342
343 sysopen(FH, "/path/name", O_RDWR|O_CREAT, 0644);
344
345Error checking is left as an exercise for the reader.
346
347=head2 Why do I sometimes get an "Argument list too long" when I use <*>?
348
349The C<E<lt>E<gt>> operator performs a globbing operation (see above).
350By default glob() forks csh(1) to do the actual glob expansion, but
351csh can't handle more than 127 items and so gives the error message
352C<Argument list too long>. People who installed tcsh as csh won't
353have this problem, but their users may be surprised by it.
354
355To get around this, either do the glob yourself with C<Dirhandle>s and
356patterns, or use a module like Glob::KGlob, one that doesn't use the
357shell to do globbing.
358
359=head2 Is there a leak/bug in glob()?
360
361Due to the current implementation on some operating systems, when you
362use the glob() function or its angle-bracket alias in a scalar
363context, you may cause a leak and/or unpredictable behavior. It's
364best therefore to use glob() only in list context.
365
366=head2 How can I open a file with a leading "E<gt>" or trailing blanks?
367
368Normally perl ignores trailing blanks in filenames, and interprets
369certain leading characters (or a trailing "|") to mean something
370special. To avoid this, you might want to use a routine like this.
371It makes incomplete pathnames into explicit relative ones, and tacks a
372trailing null byte on the name to make perl leave it alone:
373
374 sub safe_filename {
375 local $_ = shift;
376 return m#^/#
377 ? "$_\0"
378 : "./$_\0";
379 }
380
381 $fn = safe_filename("<<<something really wicked ");
382 open(FH, "> $fn") or "couldn't open $fn: $!";
383
384You could also use the sysopen() function (see L<perlfunc/sysopen>).
385
386=head2 How can I reliably rename a file?
387
388Well, usually you just use Perl's rename() function. But that may
389not work everywhere, in particular, renaming files across file systems.
390If your operating system supports a mv(1) program or its moral equivalent,
391this works:
392
393 rename($old, $new) or system("mv", $old, $new);
394
395It may be more compelling to use the File::Copy module instead. You
396just copy to the new file to the new name (checking return values),
397then delete the old one. This isn't really the same semantics as a
398real rename(), though, which preserves metainformation like
399permissions, timestamps, inode info, etc.
400
401=head2 How can I lock a file?
402
54310121 403Perl's builtin flock() function (see L<perlfunc> for details) will call
68dc0745 404flock(2) if that exists, fcntl(2) if it doesn't (on perl version 5.004 and
405later), and lockf(3) if neither of the two previous system calls exists.
406On some systems, it may even use a different form of native locking.
407Here are some gotchas with Perl's flock():
408
409=over 4
410
411=item 1
412
413Produces a fatal error if none of the three system calls (or their
414close equivalent) exists.
415
416=item 2
417
418lockf(3) does not provide shared locking, and requires that the
419filehandle be open for writing (or appending, or read/writing).
420
421=item 3
422
423Some versions of flock() can't lock files over a network (e.g. on NFS
424file systems), so you'd need to force the use of fcntl(2) when you
425build Perl. See the flock entry of L<perlfunc>, and the F<INSTALL>
426file in the source distribution for information on building Perl to do
427this.
428
429=back
430
431The CPAN module File::Lock offers similar functionality and (if you
432have dynamic loading) won't require you to rebuild perl if your
433flock() can't lock network files.
434
435=head2 What can't I just open(FH, ">file.lock")?
436
437A common bit of code B<NOT TO USE> is this:
438
439 sleep(3) while -e "file.lock"; # PLEASE DO NOT USE
440 open(LCK, "> file.lock"); # THIS BROKEN CODE
441
442This is a classic race condition: you take two steps to do something
443which must be done in one. That's why computer hardware provides an
444atomic test-and-set instruction. In theory, this "ought" to work:
445
446 sysopen(FH, "file.lock", O_WRONLY|O_EXCL|O_CREAT, 0644)
447 or die "can't open file.lock: $!":
448
449except that lamentably, file creation (and deletion) is not atomic
450over NFS, so this won't work (at least, not every time) over the net.
46fc3d4c 451Various schemes involving involving link() have been suggested, but
452these tend to involve busy-wait, which is also subdesirable.
68dc0745 453
54310121 454=head2 I still don't get locking. I just want to increment the number
68dc0745 455in the file. How can I do this?
456
46fc3d4c 457Didn't anyone ever tell you web-page hit counters were useless?
68dc0745 458
459Anyway, this is what to do:
460
461 use Fcntl;
462 sysopen(FH, "numfile", O_RDWR|O_CREAT, 0644) or die "can't open numfile: $!";
463 flock(FH, 2) or die "can't flock numfile: $!";
464 $num = <FH> || 0;
465 seek(FH, 0, 0) or die "can't rewind numfile: $!";
466 truncate(FH, 0) or die "can't truncate numfile: $!";
467 (print FH $num+1, "\n") or die "can't write numfile: $!";
468 # DO NOT UNLOCK THIS UNTIL YOU CLOSE
469 close FH or die "can't close numfile: $!";
470
46fc3d4c 471Here's a much better web-page hit counter:
68dc0745 472
473 $hits = int( (time() - 850_000_000) / rand(1_000) );
474
475If the count doesn't impress your friends, then the code might. :-)
476
477=head2 How do I randomly update a binary file?
478
479If you're just trying to patch a binary, in many cases something as
480simple as this works:
481
482 perl -i -pe 's{window manager}{window mangler}g' /usr/bin/emacs
483
484However, if you have fixed sized records, then you might do something more
485like this:
486
487 $RECSIZE = 220; # size of record, in bytes
488 $recno = 37; # which record to update
489 open(FH, "+<somewhere") || die "can't update somewhere: $!";
490 seek(FH, $recno * $RECSIZE, 0);
491 read(FH, $record, $RECSIZE) == $RECSIZE || die "can't read record $recno: $!";
492 # munge the record
493 seek(FH, $recno * $RECSIZE, 0);
494 print FH $record;
495 close FH;
496
497Locking and error checking are left as an exercise for the reader.
498Don't forget them, or you'll be quite sorry.
499
46fc3d4c 500Don't forget to set binmode() under DOS-like platforms when operating
68dc0745 501on files that have anything other than straight text in them. See the
502docs on open() and on binmode() for more details.
503
504=head2 How do I get a file's timestamp in perl?
505
506If you want to retrieve the time at which the file was last read,
46fc3d4c 507written, or had its meta-data (owner, etc) changed, you use the B<-M>,
68dc0745 508B<-A>, or B<-C> filetest operations as documented in L<perlfunc>. These
509retrieve the age of the file (measured against the start-time of your
510program) in days as a floating point number. To retrieve the "raw"
511time in seconds since the epoch, you would call the stat function,
512then use localtime(), gmtime(), or POSIX::strftime() to convert this
513into human-readable form.
514
515Here's an example:
516
517 $write_secs = (stat($file))[9];
518 print "file $file updated at ", scalar(localtime($file)), "\n";
519
520If you prefer something more legible, use the File::stat module
521(part of the standard distribution in version 5.004 and later):
522
523 use File::stat;
524 use Time::localtime;
525 $date_string = ctime(stat($file)->mtime);
526 print "file $file updated at $date_string\n";
527
528Error checking is left as an exercise for the reader.
529
530=head2 How do I set a file's timestamp in perl?
531
532You use the utime() function documented in L<perlfunc/utime>.
533By way of example, here's a little program that copies the
534read and write times from its first argument to all the rest
535of them.
536
537 if (@ARGV < 2) {
538 die "usage: cptimes timestamp_file other_files ...\n";
539 }
540 $timestamp = shift;
541 ($atime, $mtime) = (stat($timestamp))[8,9];
542 utime $atime, $mtime, @ARGV;
543
544Error checking is left as an exercise for the reader.
545
546Note that utime() currently doesn't work correctly with Win95/NT
547ports. A bug has been reported. Check it carefully before using
548it on those platforms.
549
550=head2 How do I print to more than one file at once?
551
552If you only have to do this once, you can do this:
553
554 for $fh (FH1, FH2, FH3) { print $fh "whatever\n" }
555
556To connect up to one filehandle to several output filehandles, it's
557easiest to use the tee(1) program if you have it, and let it take care
558of the multiplexing:
559
560 open (FH, "| tee file1 file2 file3");
561
562Otherwise you'll have to write your own multiplexing print function --
563or your own tee program -- or use Tom Christiansen's, at
564http://www.perl.com/CPAN/authors/id/TOMC/scripts/tct.gz, which is
565written in Perl.
566
567In theory a IO::Tee class could be written, but to date we haven't
568seen such.
569
570=head2 How can I read in a file by paragraphs?
571
572Use the C<$\> variable (see L<perlvar> for details). You can either
573set it to C<""> to eliminate empty paragraphs (C<"abc\n\n\n\ndef">,
574for instance, gets treated as two paragraphs and not three), or
575C<"\n\n"> to accept empty paragraphs.
576
577=head2 How can I read a single character from a file? From the keyboard?
578
579You can use the builtin C<getc()> function for most filehandles, but
580it won't (easily) work on a terminal device. For STDIN, either use
581the Term::ReadKey module from CPAN, or use the sample code in
582L<perlfunc/getc>.
583
584If your system supports POSIX, you can use the following code, which
585you'll note turns off echo processing as well.
586
587 #!/usr/bin/perl -w
588 use strict;
589 $| = 1;
590 for (1..4) {
591 my $got;
592 print "gimme: ";
593 $got = getone();
594 print "--> $got\n";
595 }
596 exit;
597
598 BEGIN {
599 use POSIX qw(:termios_h);
600
601 my ($term, $oterm, $echo, $noecho, $fd_stdin);
602
603 $fd_stdin = fileno(STDIN);
604
605 $term = POSIX::Termios->new();
606 $term->getattr($fd_stdin);
607 $oterm = $term->getlflag();
608
609 $echo = ECHO | ECHOK | ICANON;
610 $noecho = $oterm & ~$echo;
611
612 sub cbreak {
613 $term->setlflag($noecho);
614 $term->setcc(VTIME, 1);
615 $term->setattr($fd_stdin, TCSANOW);
616 }
617
618 sub cooked {
619 $term->setlflag($oterm);
620 $term->setcc(VTIME, 0);
621 $term->setattr($fd_stdin, TCSANOW);
622 }
623
624 sub getone {
625 my $key = '';
626 cbreak();
627 sysread(STDIN, $key, 1);
628 cooked();
629 return $key;
630 }
631
632 }
633
634 END { cooked() }
635
636The Term::ReadKey module from CPAN may be easier to use:
637
638 use Term::ReadKey;
639 open(TTY, "</dev/tty");
640 print "Gimme a char: ";
641 ReadMode "raw";
642 $key = ReadKey 0, *TTY;
643 ReadMode "normal";
644 printf "\nYou said %s, char number %03d\n",
645 $key, ord $key;
646
46fc3d4c 647For DOS systems, Dan Carson <dbc@tc.fluke.COM> reports the following:
68dc0745 648
649To put the PC in "raw" mode, use ioctl with some magic numbers gleaned
650from msdos.c (Perl source file) and Ralf Brown's interrupt list (comes
651across the net every so often):
652
653 $old_ioctl = ioctl(STDIN,0,0); # Gets device info
654 $old_ioctl &= 0xff;
655 ioctl(STDIN,1,$old_ioctl | 32); # Writes it back, setting bit 5
656
657Then to read a single character:
658
659 sysread(STDIN,$c,1); # Read a single character
660
661And to put the PC back to "cooked" mode:
662
663 ioctl(STDIN,1,$old_ioctl); # Sets it back to cooked mode.
664
665So now you have $c. If C<ord($c) == 0>, you have a two byte code, which
666means you hit a special key. Read another byte with C<sysread(STDIN,$c,1)>,
667and that value tells you what combination it was according to this
668table:
669
670 # PC 2-byte keycodes = ^@ + the following:
671
672 # HEX KEYS
673 # --- ----
674 # 0F SHF TAB
675 # 10-19 ALT QWERTYUIOP
676 # 1E-26 ALT ASDFGHJKL
677 # 2C-32 ALT ZXCVBNM
678 # 3B-44 F1-F10
679 # 47-49 HOME,UP,PgUp
680 # 4B LEFT
681 # 4D RIGHT
682 # 4F-53 END,DOWN,PgDn,Ins,Del
683 # 54-5D SHF F1-F10
684 # 5E-67 CTR F1-F10
685 # 68-71 ALT F1-F10
686 # 73-77 CTR LEFT,RIGHT,END,PgDn,HOME
687 # 78-83 ALT 1234567890-=
688 # 84 CTR PgUp
689
690This is all trial and error I did a long time ago, I hope I'm reading the
691file that worked.
692
693=head2 How can I tell if there's a character waiting on a filehandle?
694
695You should check out the Frequently Asked Questions list in
696comp.unix.* for things like this: the answer is essentially the same.
697It's very system dependent. Here's one solution that works on BSD
698systems:
699
700 sub key_ready {
701 my($rin, $nfd);
702 vec($rin, fileno(STDIN), 1) = 1;
703 return $nfd = select($rin,undef,undef,0);
704 }
705
706You should look into getting the Term::ReadKey extension from CPAN.
707
708=head2 How do I open a file without blocking?
709
710You need to use the O_NDELAY or O_NONBLOCK flag from the Fcntl module
711in conjunction with sysopen():
712
713 use Fcntl;
714 sysopen(FH, "/tmp/somefile", O_WRONLY|O_NDELAY|O_CREAT, 0644)
715 or die "can't open /tmp/somefile: $!":
716
717=head2 How do I create a file only if it doesn't exist?
718
719You need to use the O_CREAT and O_EXCL flags from the Fcntl module in
720conjunction with sysopen():
721
722 use Fcntl;
723 sysopen(FH, "/tmp/somefile", O_WRONLY|O_EXCL|O_CREAT, 0644)
724 or die "can't open /tmp/somefile: $!":
725
726Be warned that neither creation nor deletion of files is guaranteed to
727be an atomic operation over NFS. That is, two processes might both
728successful create or unlink the same file!
729
730=head2 How do I do a C<tail -f> in perl?
731
732First try
733
734 seek(GWFILE, 0, 1);
735
736The statement C<seek(GWFILE, 0, 1)> doesn't change the current position,
737but it does clear the end-of-file condition on the handle, so that the
738next <GWFILE> makes Perl try again to read something.
739
740If that doesn't work (it relies on features of your stdio implementation),
741then you need something more like this:
742
743 for (;;) {
744 for ($curpos = tell(GWFILE); <GWFILE>; $curpos = tell(GWFILE)) {
745 # search for some stuff and put it into files
746 }
747 # sleep for a while
748 seek(GWFILE, $curpos, 0); # seek to where we had been
749 }
750
751If this still doesn't work, look into the POSIX module. POSIX defines
752the clearerr() method, which can remove the end of file condition on a
753filehandle. The method: read until end of file, clearerr(), read some
754more. Lather, rinse, repeat.
755
756=head2 How do I dup() a filehandle in Perl?
757
758If you check L<perlfunc/open>, you'll see that several of the ways
759to call open() should do the trick. For example:
760
761 open(LOG, ">>/tmp/logfile");
762 open(STDERR, ">&LOG");
763
764Or even with a literal numeric descriptor:
765
766 $fd = $ENV{MHCONTEXTFD};
767 open(MHCONTEXT, "<&=$fd"); # like fdopen(3S)
768
769Error checking has been left as an exercise for the reader.
770
771=head2 How do I close a file descriptor by number?
772
773This should rarely be necessary, as the Perl close() function is to be
774used for things that Perl opened itself, even if it was a dup of a
775numeric descriptor, as with MHCONTEXT above. But if you really have
776to, you may be able to do this:
777
778 require 'sys/syscall.ph';
779 $rc = syscall(&SYS_close, $fd + 0); # must force numeric
780 die "can't sysclose $fd: $!" unless $rc == -1;
781
46fc3d4c 782=head2 Why can't I use "C:\temp\foo" in DOS paths? What doesn't `C:\temp\foo.exe` work?
68dc0745 783
784Whoops! You just put a tab and a formfeed into that filename!
785Remember that within double quoted strings ("like\this"), the
786backslash is an escape character. The full list of these is in
787L<perlop/Quote and Quote-like Operators>. Unsurprisingly, you don't
788have a file called "c:(tab)emp(formfeed)oo" or
46fc3d4c 789"c:(tab)emp(formfeed)oo.exe" on your DOS filesystem.
68dc0745 790
791Either single-quote your strings, or (preferably) use forward slashes.
46fc3d4c 792Since all DOS and Windows versions since something like MS-DOS 2.0 or so
68dc0745 793have treated C</> and C<\> the same in a path, you might as well use the
794one that doesn't clash with Perl -- or the POSIX shell, ANSI C and C++,
795awk, Tcl, Java, or Python, just to mention a few.
796
797=head2 Why doesn't glob("*.*") get all the files?
798
799Because even on non-Unix ports, Perl's glob function follows standard
46fc3d4c 800Unix globbing semantics. You'll need C<glob("*")> to get all (non-hidden)
68dc0745 801files.
802
803=head2 Why does Perl let me delete read-only files? Why does C<-i> clobber protected files? Isn't this a bug in Perl?
804
805This is elaborately and painstakingly described in the "Far More Than
806You Every Wanted To Know" in
807http://www.perl.com/CPAN/doc/FMTEYEWTK/file-dir-perms .
808
809The executive summary: learn how your filesystem works. The
810permissions on a file say what can happen to the data in that file.
811The permissions on a directory say what can happen to the list of
812files in that directory. If you delete a file, you're removing its
813name from the directory (so the operation depends on the permissions
814of the directory, not of the file). If you try to write to the file,
815the permissions of the file govern whether you're allowed to.
816
817=head2 How do I select a random line from a file?
818
819Here's an algorithm from the Camel Book:
820
821 srand;
822 rand($.) < 1 && ($line = $_) while <>;
823
824This has a significant advantage in space over reading the whole
825file in.
826
827=head1 AUTHOR AND COPYRIGHT
828
829Copyright (c) 1997 Tom Christiansen and Nathan Torkington.
830All rights reserved. See L<perlfaq> for distribution information.
46fc3d4c 831