Commit | Line | Data |
---|---|---|
a0d0e21e LW |
1 | =head1 NAME |
2 | ||
3 | perlfunc - Perl builtin functions | |
4 | ||
5 | =head1 DESCRIPTION | |
6 | ||
7 | The functions in this section can serve as terms in an expression. | |
8 | They fall into two major categories: list operators and named unary | |
9 | operators. These differ in their precedence relationship with a | |
10 | following comma. (See the precedence table in L<perlop>.) List | |
11 | operators take more than one argument, while unary operators can never | |
12 | take more than one argument. Thus, a comma terminates the argument of | |
13 | a unary operator, but merely separates the arguments of a list | |
14 | operator. A unary operator generally provides a scalar context to its | |
2b5ab1e7 | 15 | argument, while a list operator may provide either scalar or list |
a0d0e21e | 16 | contexts for its arguments. If it does both, the scalar arguments will |
5f05dabc | 17 | be first, and the list argument will follow. (Note that there can ever |
0f31cffe | 18 | be only one such list argument.) For instance, splice() has three scalar |
2b5ab1e7 TC |
19 | arguments followed by a list, whereas gethostbyname() has four scalar |
20 | arguments. | |
a0d0e21e LW |
21 | |
22 | In the syntax descriptions that follow, list operators that expect a | |
23 | list (and provide list context for the elements of the list) are shown | |
24 | with LIST as an argument. Such a list may consist of any combination | |
25 | of scalar arguments or list values; the list values will be included | |
26 | in the list as if each individual element were interpolated at that | |
27 | point in the list, forming a longer single-dimensional list value. | |
28 | Elements of the LIST should be separated by commas. | |
29 | ||
30 | Any function in the list below may be used either with or without | |
31 | parentheses around its arguments. (The syntax descriptions omit the | |
5f05dabc | 32 | parentheses.) If you use the parentheses, the simple (but occasionally |
19799a22 | 33 | surprising) rule is this: It I<looks> like a function, therefore it I<is> a |
a0d0e21e LW |
34 | function, and precedence doesn't matter. Otherwise it's a list |
35 | operator or unary operator, and precedence does matter. And whitespace | |
36 | between the function and left parenthesis doesn't count--so you need to | |
37 | be careful sometimes: | |
38 | ||
68dc0745 | 39 | print 1+2+4; # Prints 7. |
40 | print(1+2) + 4; # Prints 3. | |
41 | print (1+2)+4; # Also prints 3! | |
42 | print +(1+2)+4; # Prints 7. | |
43 | print ((1+2)+4); # Prints 7. | |
a0d0e21e LW |
44 | |
45 | If you run Perl with the B<-w> switch it can warn you about this. For | |
46 | example, the third line above produces: | |
47 | ||
48 | print (...) interpreted as function at - line 1. | |
49 | Useless use of integer addition in void context at - line 1. | |
50 | ||
2b5ab1e7 TC |
51 | A few functions take no arguments at all, and therefore work as neither |
52 | unary nor list operators. These include such functions as C<time> | |
53 | and C<endpwent>. For example, C<time+86_400> always means | |
54 | C<time() + 86_400>. | |
55 | ||
a0d0e21e | 56 | For functions that can be used in either a scalar or list context, |
54310121 | 57 | nonabortive failure is generally indicated in a scalar context by |
a0d0e21e LW |
58 | returning the undefined value, and in a list context by returning the |
59 | null list. | |
60 | ||
5a964f20 TC |
61 | Remember the following important rule: There is B<no rule> that relates |
62 | the behavior of an expression in list context to its behavior in scalar | |
63 | context, or vice versa. It might do two totally different things. | |
a0d0e21e | 64 | Each operator and function decides which sort of value it would be most |
2b5ab1e7 | 65 | appropriate to return in scalar context. Some operators return the |
5a964f20 | 66 | length of the list that would have been returned in list context. Some |
a0d0e21e LW |
67 | operators return the first value in the list. Some operators return the |
68 | last value in the list. Some operators return a count of successful | |
69 | operations. In general, they do what you want, unless you want | |
70 | consistency. | |
71 | ||
5a964f20 TC |
72 | An named array in scalar context is quite different from what would at |
73 | first glance appear to be a list in scalar context. You can't get a list | |
74 | like C<(1,2,3)> into being in scalar context, because the compiler knows | |
75 | the context at compile time. It would generate the scalar comma operator | |
76 | there, not the list construction version of the comma. That means it | |
77 | was never a list to start with. | |
78 | ||
79 | In general, functions in Perl that serve as wrappers for system calls | |
f86cebdf | 80 | of the same name (like chown(2), fork(2), closedir(2), etc.) all return |
5a964f20 TC |
81 | true when they succeed and C<undef> otherwise, as is usually mentioned |
82 | in the descriptions below. This is different from the C interfaces, | |
19799a22 GS |
83 | which return C<-1> on failure. Exceptions to this rule are C<wait>, |
84 | C<waitpid>, and C<syscall>. System calls also set the special C<$!> | |
5a964f20 TC |
85 | variable on failure. Other functions do not, except accidentally. |
86 | ||
cb1a09d0 AD |
87 | =head2 Perl Functions by Category |
88 | ||
89 | Here are Perl's functions (including things that look like | |
5a964f20 | 90 | functions, like some keywords and named operators) |
cb1a09d0 AD |
91 | arranged by category. Some functions appear in more |
92 | than one place. | |
93 | ||
94 | =over | |
95 | ||
96 | =item Functions for SCALARs or strings | |
97 | ||
22fae026 | 98 | C<chomp>, C<chop>, C<chr>, C<crypt>, C<hex>, C<index>, C<lc>, C<lcfirst>, |
ab4f32c2 A |
99 | C<length>, C<oct>, C<ord>, C<pack>, C<q/STRING/>, C<qq/STRING/>, C<reverse>, |
100 | C<rindex>, C<sprintf>, C<substr>, C<tr///>, C<uc>, C<ucfirst>, C<y///> | |
cb1a09d0 AD |
101 | |
102 | =item Regular expressions and pattern matching | |
103 | ||
ab4f32c2 | 104 | C<m//>, C<pos>, C<quotemeta>, C<s///>, C<split>, C<study>, C<qr//> |
cb1a09d0 AD |
105 | |
106 | =item Numeric functions | |
107 | ||
22fae026 TM |
108 | C<abs>, C<atan2>, C<cos>, C<exp>, C<hex>, C<int>, C<log>, C<oct>, C<rand>, |
109 | C<sin>, C<sqrt>, C<srand> | |
cb1a09d0 AD |
110 | |
111 | =item Functions for real @ARRAYs | |
112 | ||
22fae026 | 113 | C<pop>, C<push>, C<shift>, C<splice>, C<unshift> |
cb1a09d0 AD |
114 | |
115 | =item Functions for list data | |
116 | ||
ab4f32c2 | 117 | C<grep>, C<join>, C<map>, C<qw/STRING/>, C<reverse>, C<sort>, C<unpack> |
cb1a09d0 AD |
118 | |
119 | =item Functions for real %HASHes | |
120 | ||
22fae026 | 121 | C<delete>, C<each>, C<exists>, C<keys>, C<values> |
cb1a09d0 AD |
122 | |
123 | =item Input and output functions | |
124 | ||
22fae026 TM |
125 | C<binmode>, C<close>, C<closedir>, C<dbmclose>, C<dbmopen>, C<die>, C<eof>, |
126 | C<fileno>, C<flock>, C<format>, C<getc>, C<print>, C<printf>, C<read>, | |
127 | C<readdir>, C<rewinddir>, C<seek>, C<seekdir>, C<select>, C<syscall>, | |
128 | C<sysread>, C<sysseek>, C<syswrite>, C<tell>, C<telldir>, C<truncate>, | |
129 | C<warn>, C<write> | |
cb1a09d0 AD |
130 | |
131 | =item Functions for fixed length data or records | |
132 | ||
22fae026 | 133 | C<pack>, C<read>, C<syscall>, C<sysread>, C<syswrite>, C<unpack>, C<vec> |
cb1a09d0 AD |
134 | |
135 | =item Functions for filehandles, files, or directories | |
136 | ||
22fae026 | 137 | C<-I<X>>, C<chdir>, C<chmod>, C<chown>, C<chroot>, C<fcntl>, C<glob>, |
5ff3f7a4 GS |
138 | C<ioctl>, C<link>, C<lstat>, C<mkdir>, C<open>, C<opendir>, |
139 | C<readlink>, C<rename>, C<rmdir>, C<stat>, C<symlink>, C<umask>, | |
140 | C<unlink>, C<utime> | |
cb1a09d0 AD |
141 | |
142 | =item Keywords related to the control flow of your perl program | |
143 | ||
98293880 JH |
144 | C<caller>, C<continue>, C<die>, C<do>, C<dump>, C<eval>, C<exit>, |
145 | C<goto>, C<last>, C<next>, C<redo>, C<return>, C<sub>, C<wantarray> | |
cb1a09d0 | 146 | |
54310121 | 147 | =item Keywords related to scoping |
cb1a09d0 | 148 | |
4375e838 | 149 | C<caller>, C<import>, C<local>, C<my>, C<our>, C<package>, C<use> |
cb1a09d0 AD |
150 | |
151 | =item Miscellaneous functions | |
152 | ||
4375e838 | 153 | C<defined>, C<dump>, C<eval>, C<formline>, C<local>, C<my>, C<our>, C<reset>, |
22fae026 | 154 | C<scalar>, C<undef>, C<wantarray> |
cb1a09d0 AD |
155 | |
156 | =item Functions for processes and process groups | |
157 | ||
22fae026 | 158 | C<alarm>, C<exec>, C<fork>, C<getpgrp>, C<getppid>, C<getpriority>, C<kill>, |
ab4f32c2 | 159 | C<pipe>, C<qx/STRING/>, C<setpgrp>, C<setpriority>, C<sleep>, C<system>, |
22fae026 | 160 | C<times>, C<wait>, C<waitpid> |
cb1a09d0 AD |
161 | |
162 | =item Keywords related to perl modules | |
163 | ||
22fae026 | 164 | C<do>, C<import>, C<no>, C<package>, C<require>, C<use> |
cb1a09d0 AD |
165 | |
166 | =item Keywords related to classes and object-orientedness | |
167 | ||
22fae026 TM |
168 | C<bless>, C<dbmclose>, C<dbmopen>, C<package>, C<ref>, C<tie>, C<tied>, |
169 | C<untie>, C<use> | |
cb1a09d0 AD |
170 | |
171 | =item Low-level socket functions | |
172 | ||
22fae026 TM |
173 | C<accept>, C<bind>, C<connect>, C<getpeername>, C<getsockname>, |
174 | C<getsockopt>, C<listen>, C<recv>, C<send>, C<setsockopt>, C<shutdown>, | |
175 | C<socket>, C<socketpair> | |
cb1a09d0 AD |
176 | |
177 | =item System V interprocess communication functions | |
178 | ||
22fae026 TM |
179 | C<msgctl>, C<msgget>, C<msgrcv>, C<msgsnd>, C<semctl>, C<semget>, C<semop>, |
180 | C<shmctl>, C<shmget>, C<shmread>, C<shmwrite> | |
cb1a09d0 AD |
181 | |
182 | =item Fetching user and group info | |
183 | ||
22fae026 TM |
184 | C<endgrent>, C<endhostent>, C<endnetent>, C<endpwent>, C<getgrent>, |
185 | C<getgrgid>, C<getgrnam>, C<getlogin>, C<getpwent>, C<getpwnam>, | |
186 | C<getpwuid>, C<setgrent>, C<setpwent> | |
cb1a09d0 AD |
187 | |
188 | =item Fetching network info | |
189 | ||
22fae026 TM |
190 | C<endprotoent>, C<endservent>, C<gethostbyaddr>, C<gethostbyname>, |
191 | C<gethostent>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>, | |
192 | C<getprotobyname>, C<getprotobynumber>, C<getprotoent>, | |
193 | C<getservbyname>, C<getservbyport>, C<getservent>, C<sethostent>, | |
194 | C<setnetent>, C<setprotoent>, C<setservent> | |
cb1a09d0 AD |
195 | |
196 | =item Time-related functions | |
197 | ||
22fae026 | 198 | C<gmtime>, C<localtime>, C<time>, C<times> |
cb1a09d0 | 199 | |
37798a01 | 200 | =item Functions new in perl5 |
201 | ||
22fae026 | 202 | C<abs>, C<bless>, C<chomp>, C<chr>, C<exists>, C<formline>, C<glob>, |
4375e838 GS |
203 | C<import>, C<lc>, C<lcfirst>, C<map>, C<my>, C<no>, C<our>, C<prototype>, |
204 | C<qx>, C<qw>, C<readline>, C<readpipe>, C<ref>, C<sub*>, C<sysopen>, C<tie>, | |
22fae026 | 205 | C<tied>, C<uc>, C<ucfirst>, C<untie>, C<use> |
37798a01 | 206 | |
207 | * - C<sub> was a keyword in perl4, but in perl5 it is an | |
5a964f20 | 208 | operator, which can be used in expressions. |
37798a01 | 209 | |
210 | =item Functions obsoleted in perl5 | |
211 | ||
22fae026 | 212 | C<dbmclose>, C<dbmopen> |
37798a01 | 213 | |
cb1a09d0 AD |
214 | =back |
215 | ||
60f9f73c JH |
216 | =head2 Portability |
217 | ||
2b5ab1e7 TC |
218 | Perl was born in Unix and can therefore access all common Unix |
219 | system calls. In non-Unix environments, the functionality of some | |
220 | Unix system calls may not be available, or details of the available | |
221 | functionality may differ slightly. The Perl functions affected | |
60f9f73c JH |
222 | by this are: |
223 | ||
224 | C<-X>, C<binmode>, C<chmod>, C<chown>, C<chroot>, C<crypt>, | |
225 | C<dbmclose>, C<dbmopen>, C<dump>, C<endgrent>, C<endhostent>, | |
226 | C<endnetent>, C<endprotoent>, C<endpwent>, C<endservent>, C<exec>, | |
227 | C<fcntl>, C<flock>, C<fork>, C<getgrent>, C<getgrgid>, C<gethostent>, | |
228 | C<getlogin>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>, | |
229 | C<getppid>, C<getprgp>, C<getpriority>, C<getprotobynumber>, | |
230 | C<getprotoent>, C<getpwent>, C<getpwnam>, C<getpwuid>, | |
231 | C<getservbyport>, C<getservent>, C<getsockopt>, C<glob>, C<ioctl>, | |
232 | C<kill>, C<link>, C<lstat>, C<msgctl>, C<msgget>, C<msgrcv>, | |
2b5ab1e7 | 233 | C<msgsnd>, C<open>, C<pipe>, C<readlink>, C<rename>, C<select>, C<semctl>, |
60f9f73c JH |
234 | C<semget>, C<semop>, C<setgrent>, C<sethostent>, C<setnetent>, |
235 | C<setpgrp>, C<setpriority>, C<setprotoent>, C<setpwent>, | |
236 | C<setservent>, C<setsockopt>, C<shmctl>, C<shmget>, C<shmread>, | |
2b5ab1e7 TC |
237 | C<shmwrite>, C<socket>, C<socketpair>, C<stat>, C<symlink>, C<syscall>, |
238 | C<sysopen>, C<system>, C<times>, C<truncate>, C<umask>, C<unlink>, | |
239 | C<utime>, C<wait>, C<waitpid> | |
60f9f73c JH |
240 | |
241 | For more information about the portability of these functions, see | |
242 | L<perlport> and other available platform-specific documentation. | |
243 | ||
cb1a09d0 AD |
244 | =head2 Alphabetical Listing of Perl Functions |
245 | ||
a0d0e21e LW |
246 | =over 8 |
247 | ||
22fae026 | 248 | =item I<-X> FILEHANDLE |
a0d0e21e | 249 | |
22fae026 | 250 | =item I<-X> EXPR |
a0d0e21e | 251 | |
22fae026 | 252 | =item I<-X> |
a0d0e21e LW |
253 | |
254 | A file test, where X is one of the letters listed below. This unary | |
255 | operator takes one argument, either a filename or a filehandle, and | |
256 | tests the associated file to see if something is true about it. If the | |
7660c0ab | 257 | argument is omitted, tests C<$_>, except for C<-t>, which tests STDIN. |
19799a22 | 258 | Unless otherwise documented, it returns C<1> for true and C<''> for false, or |
a0d0e21e LW |
259 | the undefined value if the file doesn't exist. Despite the funny |
260 | names, precedence is the same as any other named unary operator, and | |
261 | the argument may be parenthesized like any other unary operator. The | |
262 | operator may be any of: | |
7e778d91 IZ |
263 | X<-r>X<-w>X<-x>X<-o>X<-R>X<-W>X<-X>X<-O>X<-e>X<-z>X<-s>X<-f>X<-d>X<-l>X<-p> |
264 | X<-S>X<-b>X<-c>X<-t>X<-u>X<-g>X<-k>X<-T>X<-B>X<-M>X<-A>X<-C> | |
a0d0e21e LW |
265 | |
266 | -r File is readable by effective uid/gid. | |
267 | -w File is writable by effective uid/gid. | |
268 | -x File is executable by effective uid/gid. | |
269 | -o File is owned by effective uid. | |
270 | ||
271 | -R File is readable by real uid/gid. | |
272 | -W File is writable by real uid/gid. | |
273 | -X File is executable by real uid/gid. | |
274 | -O File is owned by real uid. | |
275 | ||
276 | -e File exists. | |
277 | -z File has zero size. | |
54310121 | 278 | -s File has nonzero size (returns size). |
a0d0e21e LW |
279 | |
280 | -f File is a plain file. | |
281 | -d File is a directory. | |
282 | -l File is a symbolic link. | |
9c4d0f16 | 283 | -p File is a named pipe (FIFO), or Filehandle is a pipe. |
a0d0e21e LW |
284 | -S File is a socket. |
285 | -b File is a block special file. | |
286 | -c File is a character special file. | |
287 | -t Filehandle is opened to a tty. | |
288 | ||
289 | -u File has setuid bit set. | |
290 | -g File has setgid bit set. | |
291 | -k File has sticky bit set. | |
292 | ||
2cdbc966 JD |
293 | -T File is an ASCII text file. |
294 | -B File is a "binary" file (opposite of -T). | |
a0d0e21e LW |
295 | |
296 | -M Age of file in days when script started. | |
297 | -A Same for access time. | |
298 | -C Same for inode change time. | |
299 | ||
a0d0e21e LW |
300 | Example: |
301 | ||
302 | while (<>) { | |
303 | chop; | |
304 | next unless -f $_; # ignore specials | |
5a964f20 | 305 | #... |
a0d0e21e LW |
306 | } |
307 | ||
5ff3f7a4 GS |
308 | The interpretation of the file permission operators C<-r>, C<-R>, |
309 | C<-w>, C<-W>, C<-x>, and C<-X> is by default based solely on the mode | |
310 | of the file and the uids and gids of the user. There may be other | |
311 | reasons you can't actually read, write, or execute the file. Such | |
312 | reasons may be for example network filesystem access controls, ACLs | |
313 | (access control lists), read-only filesystems, and unrecognized | |
314 | executable formats. | |
315 | ||
2b5ab1e7 TC |
316 | Also note that, for the superuser on the local filesystems, the C<-r>, |
317 | C<-R>, C<-w>, and C<-W> tests always return 1, and C<-x> and C<-X> return 1 | |
5ff3f7a4 GS |
318 | if any execute bit is set in the mode. Scripts run by the superuser |
319 | may thus need to do a stat() to determine the actual mode of the file, | |
2b5ab1e7 | 320 | or temporarily set their effective uid to something else. |
5ff3f7a4 GS |
321 | |
322 | If you are using ACLs, there is a pragma called C<filetest> that may | |
323 | produce more accurate results than the bare stat() mode bits. | |
5ff3f7a4 GS |
324 | When under the C<use filetest 'access'> the above-mentioned filetests |
325 | will test whether the permission can (not) be granted using the | |
468541a8 | 326 | access() family of system calls. Also note that the C<-x> and C<-X> may |
5ff3f7a4 GS |
327 | under this pragma return true even if there are no execute permission |
328 | bits set (nor any extra execute permission ACLs). This strangeness is | |
329 | due to the underlying system calls' definitions. Read the | |
330 | documentation for the C<filetest> pragma for more information. | |
331 | ||
a0d0e21e LW |
332 | Note that C<-s/a/b/> does not do a negated substitution. Saying |
333 | C<-exp($foo)> still works as expected, however--only single letters | |
334 | following a minus are interpreted as file tests. | |
335 | ||
336 | The C<-T> and C<-B> switches work as follows. The first block or so of the | |
337 | file is examined for odd characters such as strange control codes or | |
61eff3bc | 338 | characters with the high bit set. If too many strange characters (>30%) |
a0d0e21e LW |
339 | are found, it's a C<-B> file, otherwise it's a C<-T> file. Also, any file |
340 | containing null in the first block is considered a binary file. If C<-T> | |
341 | or C<-B> is used on a filehandle, the current stdio buffer is examined | |
19799a22 | 342 | rather than the first block. Both C<-T> and C<-B> return true on a null |
54310121 | 343 | file, or a file at EOF when testing a filehandle. Because you have to |
4633a7c4 LW |
344 | read a file to do the C<-T> test, on most occasions you want to use a C<-f> |
345 | against the file first, as in C<next unless -f $file && -T $file>. | |
a0d0e21e | 346 | |
19799a22 | 347 | If any of the file tests (or either the C<stat> or C<lstat> operators) are given |
28757baa | 348 | the special filehandle consisting of a solitary underline, then the stat |
a0d0e21e LW |
349 | structure of the previous file test (or stat operator) is used, saving |
350 | a system call. (This doesn't work with C<-t>, and you need to remember | |
351 | that lstat() and C<-l> will leave values in the stat structure for the | |
352 | symbolic link, not the real file.) Example: | |
353 | ||
354 | print "Can do.\n" if -r $a || -w _ || -x _; | |
355 | ||
356 | stat($filename); | |
357 | print "Readable\n" if -r _; | |
358 | print "Writable\n" if -w _; | |
359 | print "Executable\n" if -x _; | |
360 | print "Setuid\n" if -u _; | |
361 | print "Setgid\n" if -g _; | |
362 | print "Sticky\n" if -k _; | |
363 | print "Text\n" if -T _; | |
364 | print "Binary\n" if -B _; | |
365 | ||
366 | =item abs VALUE | |
367 | ||
54310121 | 368 | =item abs |
bbce6d69 | 369 | |
a0d0e21e | 370 | Returns the absolute value of its argument. |
7660c0ab | 371 | If VALUE is omitted, uses C<$_>. |
a0d0e21e LW |
372 | |
373 | =item accept NEWSOCKET,GENERICSOCKET | |
374 | ||
f86cebdf | 375 | Accepts an incoming socket connect, just as the accept(2) system call |
19799a22 | 376 | does. Returns the packed address if it succeeded, false otherwise. |
2b5ab1e7 | 377 | See the example in L<perlipc/"Sockets: Client/Server Communication">. |
a0d0e21e | 378 | |
8d2a6795 GS |
379 | On systems that support a close-on-exec flag on files, the flag will |
380 | be set for the newly opened file descriptor, as determined by the | |
381 | value of $^F. See L<perlvar/$^F>. | |
382 | ||
a0d0e21e LW |
383 | =item alarm SECONDS |
384 | ||
54310121 | 385 | =item alarm |
bbce6d69 | 386 | |
a0d0e21e | 387 | Arranges to have a SIGALRM delivered to this process after the |
bbce6d69 | 388 | specified number of seconds have elapsed. If SECONDS is not specified, |
7660c0ab | 389 | the value stored in C<$_> is used. (On some machines, |
a0d0e21e LW |
390 | unfortunately, the elapsed time may be up to one second less than you |
391 | specified because of how seconds are counted.) Only one timer may be | |
392 | counting at once. Each call disables the previous timer, and an | |
7660c0ab | 393 | argument of C<0> may be supplied to cancel the previous timer without |
a0d0e21e LW |
394 | starting a new one. The returned value is the amount of time remaining |
395 | on the previous timer. | |
396 | ||
4633a7c4 | 397 | For delays of finer granularity than one second, you may use Perl's |
19799a22 GS |
398 | four-argument version of select() leaving the first three arguments |
399 | undefined, or you might be able to use the C<syscall> interface to | |
2b5ab1e7 TC |
400 | access setitimer(2) if your system supports it. The Time::HiRes module |
401 | from CPAN may also prove useful. | |
402 | ||
68f8bed4 JH |
403 | It is usually a mistake to intermix C<alarm> and C<sleep> calls. |
404 | (C<sleep> may be internally implemented in your system with C<alarm>) | |
a0d0e21e | 405 | |
19799a22 GS |
406 | If you want to use C<alarm> to time out a system call you need to use an |
407 | C<eval>/C<die> pair. You can't rely on the alarm causing the system call to | |
f86cebdf | 408 | fail with C<$!> set to C<EINTR> because Perl sets up signal handlers to |
19799a22 | 409 | restart system calls on some systems. Using C<eval>/C<die> always works, |
5a964f20 | 410 | modulo the caveats given in L<perlipc/"Signals">. |
ff68c719 | 411 | |
412 | eval { | |
f86cebdf | 413 | local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required |
36477c24 | 414 | alarm $timeout; |
ff68c719 | 415 | $nread = sysread SOCKET, $buffer, $size; |
36477c24 | 416 | alarm 0; |
ff68c719 | 417 | }; |
ff68c719 | 418 | if ($@) { |
f86cebdf | 419 | die unless $@ eq "alarm\n"; # propagate unexpected errors |
ff68c719 | 420 | # timed out |
421 | } | |
422 | else { | |
423 | # didn't | |
424 | } | |
425 | ||
a0d0e21e LW |
426 | =item atan2 Y,X |
427 | ||
428 | Returns the arctangent of Y/X in the range -PI to PI. | |
429 | ||
ca6e1c26 | 430 | For the tangent operation, you may use the C<Math::Trig::tan> |
28757baa | 431 | function, or use the familiar relation: |
432 | ||
433 | sub tan { sin($_[0]) / cos($_[0]) } | |
434 | ||
a0d0e21e LW |
435 | =item bind SOCKET,NAME |
436 | ||
437 | Binds a network address to a socket, just as the bind system call | |
19799a22 | 438 | does. Returns true if it succeeded, false otherwise. NAME should be a |
4633a7c4 LW |
439 | packed address of the appropriate type for the socket. See the examples in |
440 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 441 | |
1c1fc3ea GS |
442 | =item binmode FILEHANDLE, DISCIPLINE |
443 | ||
a0d0e21e LW |
444 | =item binmode FILEHANDLE |
445 | ||
16fe6d59 GS |
446 | Arranges for FILEHANDLE to be read or written in "binary" or "text" mode |
447 | on systems where the run-time libraries distinguish between binary and | |
30168b04 | 448 | text files. If FILEHANDLE is an expression, the value is taken as the |
16fe6d59 GS |
449 | name of the filehandle. DISCIPLINE can be either of C<":raw"> for |
450 | binary mode or C<":crlf"> for "text" mode. If the DISCIPLINE is | |
451 | omitted, it defaults to C<":raw">. | |
30168b04 | 452 | |
16fe6d59 GS |
453 | binmode() should be called after open() but before any I/O is done on |
454 | the filehandle. | |
455 | ||
456 | On many systems binmode() currently has no effect, but in future, it | |
457 | will be extended to support user-defined input and output disciplines. | |
458 | On some systems binmode() is necessary when you're not working with a | |
459 | text file. For the sake of portability it is a good idea to always use | |
460 | it when appropriate, and to never use it when it isn't appropriate. | |
30168b04 GS |
461 | |
462 | In other words: Regardless of platform, use binmode() on binary | |
463 | files, and do not use binmode() on text files. | |
19799a22 | 464 | |
16fe6d59 GS |
465 | The C<open> pragma can be used to establish default disciplines. |
466 | See L<open>. | |
467 | ||
19799a22 | 468 | The operating system, device drivers, C libraries, and Perl run-time |
30168b04 GS |
469 | system all work together to let the programmer treat a single |
470 | character (C<\n>) as the line terminator, irrespective of the external | |
471 | representation. On many operating systems, the native text file | |
472 | representation matches the internal representation, but on some | |
473 | platforms the external representation of C<\n> is made up of more than | |
474 | one character. | |
475 | ||
476 | Mac OS and all variants of Unix use a single character to end each line | |
477 | in the external representation of text (even though that single | |
478 | character is not necessarily the same across these platforms). | |
479 | Consequently binmode() has no effect on these operating systems. In | |
480 | other systems like VMS, MS-DOS and the various flavors of MS-Windows | |
481 | your program sees a C<\n> as a simple C<\cJ>, but what's stored in text | |
482 | files are the two characters C<\cM\cJ>. That means that, if you don't | |
483 | use binmode() on these systems, C<\cM\cJ> sequences on disk will be | |
484 | converted to C<\n> on input, and any C<\n> in your program will be | |
485 | converted back to C<\cM\cJ> on output. This is what you want for text | |
486 | files, but it can be disastrous for binary files. | |
487 | ||
488 | Another consequence of using binmode() (on some systems) is that | |
489 | special end-of-file markers will be seen as part of the data stream. | |
490 | For systems from the Microsoft family this means that if your binary | |
4375e838 | 491 | data contains C<\cZ>, the I/O subsystem will regard it as the end of |
30168b04 GS |
492 | the file, unless you use binmode(). |
493 | ||
494 | binmode() is not only important for readline() and print() operations, | |
495 | but also when using read(), seek(), sysread(), syswrite() and tell() | |
496 | (see L<perlport> for more details). See the C<$/> and C<$\> variables | |
497 | in L<perlvar> for how to manually set your input and output | |
498 | line-termination sequences. | |
a0d0e21e | 499 | |
4633a7c4 | 500 | =item bless REF,CLASSNAME |
a0d0e21e LW |
501 | |
502 | =item bless REF | |
503 | ||
2b5ab1e7 TC |
504 | This function tells the thingy referenced by REF that it is now an object |
505 | in the CLASSNAME package. If CLASSNAME is omitted, the current package | |
19799a22 | 506 | is used. Because a C<bless> is often the last thing in a constructor, |
2b5ab1e7 TC |
507 | it returns the reference for convenience. Always use the two-argument |
508 | version if the function doing the blessing might be inherited by a | |
509 | derived class. See L<perltoot> and L<perlobj> for more about the blessing | |
510 | (and blessings) of objects. | |
a0d0e21e | 511 | |
57668c4d | 512 | Consider always blessing objects in CLASSNAMEs that are mixed case. |
2b5ab1e7 TC |
513 | Namespaces with all lowercase names are considered reserved for |
514 | Perl pragmata. Builtin types have all uppercase names, so to prevent | |
515 | confusion, you may wish to avoid such package names as well. Make sure | |
516 | that CLASSNAME is a true value. | |
60ad88b8 GS |
517 | |
518 | See L<perlmod/"Perl Modules">. | |
519 | ||
a0d0e21e LW |
520 | =item caller EXPR |
521 | ||
522 | =item caller | |
523 | ||
5a964f20 | 524 | Returns the context of the current subroutine call. In scalar context, |
28757baa | 525 | returns the caller's package name if there is a caller, that is, if |
19799a22 | 526 | we're in a subroutine or C<eval> or C<require>, and the undefined value |
5a964f20 | 527 | otherwise. In list context, returns |
a0d0e21e | 528 | |
748a9306 | 529 | ($package, $filename, $line) = caller; |
a0d0e21e LW |
530 | |
531 | With EXPR, it returns some extra information that the debugger uses to | |
532 | print a stack trace. The value of EXPR indicates how many call frames | |
533 | to go back before the current one. | |
534 | ||
f3aa04c2 | 535 | ($package, $filename, $line, $subroutine, $hasargs, |
e476b1b5 | 536 | $wantarray, $evaltext, $is_require, $hints, $bitmask) = caller($i); |
e7ea3e70 | 537 | |
951ba7fe | 538 | Here $subroutine may be C<(eval)> if the frame is not a subroutine |
19799a22 | 539 | call, but an C<eval>. In such a case additional elements $evaltext and |
7660c0ab | 540 | C<$is_require> are set: C<$is_require> is true if the frame is created by a |
19799a22 | 541 | C<require> or C<use> statement, $evaltext contains the text of the |
277ddfaf | 542 | C<eval EXPR> statement. In particular, for an C<eval BLOCK> statement, |
951ba7fe | 543 | $filename is C<(eval)>, but $evaltext is undefined. (Note also that |
dc848c6f | 544 | each C<use> statement creates a C<require> frame inside an C<eval EXPR>) |
277ddfaf | 545 | frame. C<$hasargs> is true if a new instance of C<@_> was set up for the |
e476b1b5 GS |
546 | frame. C<$hints> and C<$bitmask> contain pragmatic hints that the caller |
547 | was compiled with. The C<$hints> and C<$bitmask> values are subject to | |
548 | change between versions of Perl, and are not meant for external use. | |
748a9306 LW |
549 | |
550 | Furthermore, when called from within the DB package, caller returns more | |
7660c0ab | 551 | detailed information: it sets the list variable C<@DB::args> to be the |
54310121 | 552 | arguments with which the subroutine was invoked. |
748a9306 | 553 | |
7660c0ab | 554 | Be aware that the optimizer might have optimized call frames away before |
19799a22 | 555 | C<caller> had a chance to get the information. That means that C<caller(N)> |
7660c0ab | 556 | might not return information about the call frame you expect it do, for |
61eff3bc | 557 | C<< N > 1 >>. In particular, C<@DB::args> might have information from the |
19799a22 | 558 | previous time C<caller> was called. |
7660c0ab | 559 | |
a0d0e21e LW |
560 | =item chdir EXPR |
561 | ||
2b5ab1e7 | 562 | Changes the working directory to EXPR, if possible. If EXPR is omitted, |
0bfc1ec4 GS |
563 | changes to the directory specified by C<$ENV{HOME}>, if set; if not, |
564 | changes to the directory specified by C<$ENV{LOGDIR}>. If neither is | |
565 | set, C<chdir> does nothing. It returns true upon success, false | |
566 | otherwise. See the example under C<die>. | |
a0d0e21e LW |
567 | |
568 | =item chmod LIST | |
569 | ||
570 | Changes the permissions of a list of files. The first element of the | |
4633a7c4 | 571 | list must be the numerical mode, which should probably be an octal |
2f9daede TP |
572 | number, and which definitely should I<not> a string of octal digits: |
573 | C<0644> is okay, C<'0644'> is not. Returns the number of files | |
dc848c6f | 574 | successfully changed. See also L</oct>, if all you have is a string. |
a0d0e21e LW |
575 | |
576 | $cnt = chmod 0755, 'foo', 'bar'; | |
577 | chmod 0755, @executables; | |
f86cebdf GS |
578 | $mode = '0644'; chmod $mode, 'foo'; # !!! sets mode to |
579 | # --w----r-T | |
2f9daede TP |
580 | $mode = '0644'; chmod oct($mode), 'foo'; # this is better |
581 | $mode = 0644; chmod $mode, 'foo'; # this is best | |
a0d0e21e | 582 | |
ca6e1c26 JH |
583 | You can also import the symbolic C<S_I*> constants from the Fcntl |
584 | module: | |
585 | ||
586 | use Fcntl ':mode'; | |
587 | ||
588 | chmod S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH, @executables; | |
589 | # This is identical to the chmod 0755 of the above example. | |
590 | ||
a0d0e21e LW |
591 | =item chomp VARIABLE |
592 | ||
593 | =item chomp LIST | |
594 | ||
595 | =item chomp | |
596 | ||
2b5ab1e7 TC |
597 | This safer version of L</chop> removes any trailing string |
598 | that corresponds to the current value of C<$/> (also known as | |
28757baa | 599 | $INPUT_RECORD_SEPARATOR in the C<English> module). It returns the total |
600 | number of characters removed from all its arguments. It's often used to | |
601 | remove the newline from the end of an input record when you're worried | |
2b5ab1e7 TC |
602 | that the final record may be missing its newline. When in paragraph |
603 | mode (C<$/ = "">), it removes all trailing newlines from the string. | |
4c5a6083 GS |
604 | When in slurp mode (C<$/ = undef>) or fixed-length record mode (C<$/> is |
605 | a reference to an integer or the like, see L<perlvar>) chomp() won't | |
19799a22 GS |
606 | remove anything. |
607 | If VARIABLE is omitted, it chomps C<$_>. Example: | |
a0d0e21e LW |
608 | |
609 | while (<>) { | |
610 | chomp; # avoid \n on last field | |
611 | @array = split(/:/); | |
5a964f20 | 612 | # ... |
a0d0e21e LW |
613 | } |
614 | ||
615 | You can actually chomp anything that's an lvalue, including an assignment: | |
616 | ||
617 | chomp($cwd = `pwd`); | |
618 | chomp($answer = <STDIN>); | |
619 | ||
620 | If you chomp a list, each element is chomped, and the total number of | |
621 | characters removed is returned. | |
622 | ||
623 | =item chop VARIABLE | |
624 | ||
625 | =item chop LIST | |
626 | ||
627 | =item chop | |
628 | ||
629 | Chops off the last character of a string and returns the character | |
630 | chopped. It's used primarily to remove the newline from the end of an | |
631 | input record, but is much more efficient than C<s/\n//> because it neither | |
7660c0ab | 632 | scans nor copies the string. If VARIABLE is omitted, chops C<$_>. |
a0d0e21e LW |
633 | Example: |
634 | ||
635 | while (<>) { | |
636 | chop; # avoid \n on last field | |
637 | @array = split(/:/); | |
5a964f20 | 638 | #... |
a0d0e21e LW |
639 | } |
640 | ||
641 | You can actually chop anything that's an lvalue, including an assignment: | |
642 | ||
643 | chop($cwd = `pwd`); | |
644 | chop($answer = <STDIN>); | |
645 | ||
646 | If you chop a list, each element is chopped. Only the value of the | |
19799a22 | 647 | last C<chop> is returned. |
a0d0e21e | 648 | |
19799a22 | 649 | Note that C<chop> returns the last character. To return all but the last |
748a9306 LW |
650 | character, use C<substr($string, 0, -1)>. |
651 | ||
a0d0e21e LW |
652 | =item chown LIST |
653 | ||
654 | Changes the owner (and group) of a list of files. The first two | |
19799a22 GS |
655 | elements of the list must be the I<numeric> uid and gid, in that |
656 | order. A value of -1 in either position is interpreted by most | |
657 | systems to leave that value unchanged. Returns the number of files | |
658 | successfully changed. | |
a0d0e21e LW |
659 | |
660 | $cnt = chown $uid, $gid, 'foo', 'bar'; | |
661 | chown $uid, $gid, @filenames; | |
662 | ||
54310121 | 663 | Here's an example that looks up nonnumeric uids in the passwd file: |
a0d0e21e LW |
664 | |
665 | print "User: "; | |
19799a22 | 666 | chomp($user = <STDIN>); |
5a964f20 | 667 | print "Files: "; |
19799a22 | 668 | chomp($pattern = <STDIN>); |
a0d0e21e LW |
669 | |
670 | ($login,$pass,$uid,$gid) = getpwnam($user) | |
671 | or die "$user not in passwd file"; | |
672 | ||
5a964f20 | 673 | @ary = glob($pattern); # expand filenames |
a0d0e21e LW |
674 | chown $uid, $gid, @ary; |
675 | ||
54310121 | 676 | On most systems, you are not allowed to change the ownership of the |
4633a7c4 LW |
677 | file unless you're the superuser, although you should be able to change |
678 | the group to any of your secondary groups. On insecure systems, these | |
679 | restrictions may be relaxed, but this is not a portable assumption. | |
19799a22 GS |
680 | On POSIX systems, you can detect this condition this way: |
681 | ||
682 | use POSIX qw(sysconf _PC_CHOWN_RESTRICTED); | |
683 | $can_chown_giveaway = not sysconf(_PC_CHOWN_RESTRICTED); | |
4633a7c4 | 684 | |
a0d0e21e LW |
685 | =item chr NUMBER |
686 | ||
54310121 | 687 | =item chr |
bbce6d69 | 688 | |
a0d0e21e | 689 | Returns the character represented by that NUMBER in the character set. |
a0ed51b3 | 690 | For example, C<chr(65)> is C<"A"> in either ASCII or Unicode, and |
2b5ab1e7 TC |
691 | chr(0x263a) is a Unicode smiley face (but only within the scope of |
692 | a C<use utf8>). For the reverse, use L</ord>. | |
693 | See L<utf8> for more about Unicode. | |
a0d0e21e | 694 | |
7660c0ab | 695 | If NUMBER is omitted, uses C<$_>. |
bbce6d69 | 696 | |
a0d0e21e LW |
697 | =item chroot FILENAME |
698 | ||
54310121 | 699 | =item chroot |
bbce6d69 | 700 | |
5a964f20 | 701 | This function works like the system call by the same name: it makes the |
4633a7c4 | 702 | named directory the new root directory for all further pathnames that |
951ba7fe | 703 | begin with a C</> by your process and all its children. (It doesn't |
28757baa | 704 | change your current working directory, which is unaffected.) For security |
4633a7c4 | 705 | reasons, this call is restricted to the superuser. If FILENAME is |
19799a22 | 706 | omitted, does a C<chroot> to C<$_>. |
a0d0e21e LW |
707 | |
708 | =item close FILEHANDLE | |
709 | ||
6a518fbc TP |
710 | =item close |
711 | ||
19799a22 | 712 | Closes the file or pipe associated with the file handle, returning true |
a0d0e21e | 713 | only if stdio successfully flushes buffers and closes the system file |
19799a22 | 714 | descriptor. Closes the currently selected filehandle if the argument |
6a518fbc | 715 | is omitted. |
fb73857a | 716 | |
717 | You don't have to close FILEHANDLE if you are immediately going to do | |
19799a22 GS |
718 | another C<open> on it, because C<open> will close it for you. (See |
719 | C<open>.) However, an explicit C<close> on an input file resets the line | |
720 | counter (C<$.>), while the implicit close done by C<open> does not. | |
fb73857a | 721 | |
19799a22 GS |
722 | If the file handle came from a piped open C<close> will additionally |
723 | return false if one of the other system calls involved fails or if the | |
fb73857a | 724 | program exits with non-zero status. (If the only problem was that the |
2b5ab1e7 TC |
725 | program exited non-zero C<$!> will be set to C<0>.) Closing a pipe |
726 | also waits for the process executing on the pipe to complete, in case you | |
727 | want to look at the output of the pipe afterwards, and | |
728 | implicitly puts the exit status value of that command into C<$?>. | |
5a964f20 | 729 | |
73689b13 GS |
730 | Prematurely closing the read end of a pipe (i.e. before the process |
731 | writing to it at the other end has closed it) will result in a | |
732 | SIGPIPE being delivered to the writer. If the other end can't | |
733 | handle that, be sure to read all the data before closing the pipe. | |
734 | ||
fb73857a | 735 | Example: |
a0d0e21e | 736 | |
fb73857a | 737 | open(OUTPUT, '|sort >foo') # pipe to sort |
738 | or die "Can't start sort: $!"; | |
5a964f20 | 739 | #... # print stuff to output |
fb73857a | 740 | close OUTPUT # wait for sort to finish |
741 | or warn $! ? "Error closing sort pipe: $!" | |
742 | : "Exit status $? from sort"; | |
743 | open(INPUT, 'foo') # get sort's results | |
744 | or die "Can't open 'foo' for input: $!"; | |
a0d0e21e | 745 | |
5a964f20 TC |
746 | FILEHANDLE may be an expression whose value can be used as an indirect |
747 | filehandle, usually the real filehandle name. | |
a0d0e21e LW |
748 | |
749 | =item closedir DIRHANDLE | |
750 | ||
19799a22 | 751 | Closes a directory opened by C<opendir> and returns the success of that |
5a964f20 TC |
752 | system call. |
753 | ||
754 | DIRHANDLE may be an expression whose value can be used as an indirect | |
755 | dirhandle, usually the real dirhandle name. | |
a0d0e21e LW |
756 | |
757 | =item connect SOCKET,NAME | |
758 | ||
759 | Attempts to connect to a remote socket, just as the connect system call | |
19799a22 | 760 | does. Returns true if it succeeded, false otherwise. NAME should be a |
4633a7c4 LW |
761 | packed address of the appropriate type for the socket. See the examples in |
762 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 763 | |
cb1a09d0 AD |
764 | =item continue BLOCK |
765 | ||
766 | Actually a flow control statement rather than a function. If there is a | |
98293880 JH |
767 | C<continue> BLOCK attached to a BLOCK (typically in a C<while> or |
768 | C<foreach>), it is always executed just before the conditional is about to | |
769 | be evaluated again, just like the third part of a C<for> loop in C. Thus | |
cb1a09d0 AD |
770 | it can be used to increment a loop variable, even when the loop has been |
771 | continued via the C<next> statement (which is similar to the C C<continue> | |
772 | statement). | |
773 | ||
98293880 | 774 | C<last>, C<next>, or C<redo> may appear within a C<continue> |
19799a22 GS |
775 | block. C<last> and C<redo> will behave as if they had been executed within |
776 | the main block. So will C<next>, but since it will execute a C<continue> | |
1d2dff63 GS |
777 | block, it may be more entertaining. |
778 | ||
779 | while (EXPR) { | |
780 | ### redo always comes here | |
781 | do_something; | |
782 | } continue { | |
783 | ### next always comes here | |
784 | do_something_else; | |
785 | # then back the top to re-check EXPR | |
786 | } | |
787 | ### last always comes here | |
788 | ||
789 | Omitting the C<continue> section is semantically equivalent to using an | |
19799a22 | 790 | empty one, logically enough. In that case, C<next> goes directly back |
1d2dff63 GS |
791 | to check the condition at the top of the loop. |
792 | ||
a0d0e21e LW |
793 | =item cos EXPR |
794 | ||
5a964f20 | 795 | Returns the cosine of EXPR (expressed in radians). If EXPR is omitted, |
7660c0ab | 796 | takes cosine of C<$_>. |
a0d0e21e | 797 | |
ca6e1c26 | 798 | For the inverse cosine operation, you may use the C<Math::Trig::acos()> |
28757baa | 799 | function, or use this relation: |
800 | ||
801 | sub acos { atan2( sqrt(1 - $_[0] * $_[0]), $_[0] ) } | |
802 | ||
a0d0e21e LW |
803 | =item crypt PLAINTEXT,SALT |
804 | ||
f86cebdf | 805 | Encrypts a string exactly like the crypt(3) function in the C library |
4633a7c4 LW |
806 | (assuming that you actually have a version there that has not been |
807 | extirpated as a potential munition). This can prove useful for checking | |
808 | the password file for lousy passwords, amongst other things. Only the | |
809 | guys wearing white hats should do this. | |
a0d0e21e | 810 | |
19799a22 | 811 | Note that C<crypt> is intended to be a one-way function, much like breaking |
11155c91 CS |
812 | eggs to make an omelette. There is no (known) corresponding decrypt |
813 | function. As a result, this function isn't all that useful for | |
814 | cryptography. (For that, see your nearby CPAN mirror.) | |
2f9daede | 815 | |
e71965be RS |
816 | When verifying an existing encrypted string you should use the encrypted |
817 | text as the salt (like C<crypt($plain, $crypted) eq $crypted>). This | |
19799a22 | 818 | allows your code to work with the standard C<crypt> and with more |
e71965be RS |
819 | exotic implementations. When choosing a new salt create a random two |
820 | character string whose characters come from the set C<[./0-9A-Za-z]> | |
821 | (like C<join '', ('.', '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64]>). | |
822 | ||
a0d0e21e LW |
823 | Here's an example that makes sure that whoever runs this program knows |
824 | their own password: | |
825 | ||
826 | $pwd = (getpwuid($<))[1]; | |
a0d0e21e LW |
827 | |
828 | system "stty -echo"; | |
829 | print "Password: "; | |
e71965be | 830 | chomp($word = <STDIN>); |
a0d0e21e LW |
831 | print "\n"; |
832 | system "stty echo"; | |
833 | ||
e71965be | 834 | if (crypt($word, $pwd) ne $pwd) { |
a0d0e21e LW |
835 | die "Sorry...\n"; |
836 | } else { | |
837 | print "ok\n"; | |
54310121 | 838 | } |
a0d0e21e | 839 | |
9f8f0c9d | 840 | Of course, typing in your own password to whoever asks you |
748a9306 | 841 | for it is unwise. |
a0d0e21e | 842 | |
19799a22 GS |
843 | The L<crypt> function is unsuitable for encrypting large quantities |
844 | of data, not least of all because you can't get the information | |
845 | back. Look at the F<by-module/Crypt> and F<by-module/PGP> directories | |
846 | on your favorite CPAN mirror for a slew of potentially useful | |
847 | modules. | |
848 | ||
aa689395 | 849 | =item dbmclose HASH |
a0d0e21e | 850 | |
19799a22 | 851 | [This function has been largely superseded by the C<untie> function.] |
a0d0e21e | 852 | |
aa689395 | 853 | Breaks the binding between a DBM file and a hash. |
a0d0e21e | 854 | |
19799a22 | 855 | =item dbmopen HASH,DBNAME,MASK |
a0d0e21e | 856 | |
19799a22 | 857 | [This function has been largely superseded by the C<tie> function.] |
a0d0e21e | 858 | |
7b8d334a | 859 | This binds a dbm(3), ndbm(3), sdbm(3), gdbm(3), or Berkeley DB file to a |
19799a22 GS |
860 | hash. HASH is the name of the hash. (Unlike normal C<open>, the first |
861 | argument is I<not> a filehandle, even though it looks like one). DBNAME | |
aa689395 | 862 | is the name of the database (without the F<.dir> or F<.pag> extension if |
863 | any). If the database does not exist, it is created with protection | |
19799a22 GS |
864 | specified by MASK (as modified by the C<umask>). If your system supports |
865 | only the older DBM functions, you may perform only one C<dbmopen> in your | |
aa689395 | 866 | program. In older versions of Perl, if your system had neither DBM nor |
19799a22 | 867 | ndbm, calling C<dbmopen> produced a fatal error; it now falls back to |
aa689395 | 868 | sdbm(3). |
869 | ||
870 | If you don't have write access to the DBM file, you can only read hash | |
871 | variables, not set them. If you want to test whether you can write, | |
19799a22 | 872 | either use file tests or try setting a dummy hash entry inside an C<eval>, |
aa689395 | 873 | which will trap the error. |
a0d0e21e | 874 | |
19799a22 GS |
875 | Note that functions such as C<keys> and C<values> may return huge lists |
876 | when used on large DBM files. You may prefer to use the C<each> | |
a0d0e21e LW |
877 | function to iterate over large DBM files. Example: |
878 | ||
879 | # print out history file offsets | |
880 | dbmopen(%HIST,'/usr/lib/news/history',0666); | |
881 | while (($key,$val) = each %HIST) { | |
882 | print $key, ' = ', unpack('L',$val), "\n"; | |
883 | } | |
884 | dbmclose(%HIST); | |
885 | ||
cb1a09d0 | 886 | See also L<AnyDBM_File> for a more general description of the pros and |
184e9718 | 887 | cons of the various dbm approaches, as well as L<DB_File> for a particularly |
cb1a09d0 | 888 | rich implementation. |
4633a7c4 | 889 | |
2b5ab1e7 TC |
890 | You can control which DBM library you use by loading that library |
891 | before you call dbmopen(): | |
892 | ||
893 | use DB_File; | |
894 | dbmopen(%NS_Hist, "$ENV{HOME}/.netscape/history.db") | |
895 | or die "Can't open netscape history file: $!"; | |
896 | ||
a0d0e21e LW |
897 | =item defined EXPR |
898 | ||
54310121 | 899 | =item defined |
bbce6d69 | 900 | |
2f9daede TP |
901 | Returns a Boolean value telling whether EXPR has a value other than |
902 | the undefined value C<undef>. If EXPR is not present, C<$_> will be | |
903 | checked. | |
904 | ||
905 | Many operations return C<undef> to indicate failure, end of file, | |
906 | system error, uninitialized variable, and other exceptional | |
907 | conditions. This function allows you to distinguish C<undef> from | |
908 | other values. (A simple Boolean test will not distinguish among | |
7660c0ab | 909 | C<undef>, zero, the empty string, and C<"0">, which are all equally |
2f9daede | 910 | false.) Note that since C<undef> is a valid scalar, its presence |
19799a22 | 911 | doesn't I<necessarily> indicate an exceptional condition: C<pop> |
2f9daede TP |
912 | returns C<undef> when its argument is an empty array, I<or> when the |
913 | element to return happens to be C<undef>. | |
914 | ||
f10b0346 GS |
915 | You may also use C<defined(&func)> to check whether subroutine C<&func> |
916 | has ever been defined. The return value is unaffected by any forward | |
917 | declarations of C<&foo>. | |
918 | ||
919 | Use of C<defined> on aggregates (hashes and arrays) is deprecated. It | |
920 | used to report whether memory for that aggregate has ever been | |
921 | allocated. This behavior may disappear in future versions of Perl. | |
922 | You should instead use a simple test for size: | |
923 | ||
924 | if (@an_array) { print "has array elements\n" } | |
925 | if (%a_hash) { print "has hash members\n" } | |
2f9daede TP |
926 | |
927 | When used on a hash element, it tells you whether the value is defined, | |
dc848c6f | 928 | not whether the key exists in the hash. Use L</exists> for the latter |
2f9daede | 929 | purpose. |
a0d0e21e LW |
930 | |
931 | Examples: | |
932 | ||
933 | print if defined $switch{'D'}; | |
934 | print "$val\n" while defined($val = pop(@ary)); | |
935 | die "Can't readlink $sym: $!" | |
936 | unless defined($value = readlink $sym); | |
a0d0e21e | 937 | sub foo { defined &$bar ? &$bar(@_) : die "No bar"; } |
2f9daede | 938 | $debugging = 0 unless defined $debugging; |
a0d0e21e | 939 | |
19799a22 | 940 | Note: Many folks tend to overuse C<defined>, and then are surprised to |
7660c0ab | 941 | discover that the number C<0> and C<""> (the zero-length string) are, in fact, |
2f9daede | 942 | defined values. For example, if you say |
a5f75d66 AD |
943 | |
944 | "ab" =~ /a(.*)b/; | |
945 | ||
7660c0ab | 946 | The pattern match succeeds, and C<$1> is defined, despite the fact that it |
a5f75d66 | 947 | matched "nothing". But it didn't really match nothing--rather, it |
2b5ab1e7 | 948 | matched something that happened to be zero characters long. This is all |
a5f75d66 | 949 | very above-board and honest. When a function returns an undefined value, |
2f9daede | 950 | it's an admission that it couldn't give you an honest answer. So you |
19799a22 | 951 | should use C<defined> only when you're questioning the integrity of what |
7660c0ab | 952 | you're trying to do. At other times, a simple comparison to C<0> or C<""> is |
2f9daede TP |
953 | what you want. |
954 | ||
dc848c6f | 955 | See also L</undef>, L</exists>, L</ref>. |
2f9daede | 956 | |
a0d0e21e LW |
957 | =item delete EXPR |
958 | ||
01020589 GS |
959 | Given an expression that specifies a hash element, array element, hash slice, |
960 | or array slice, deletes the specified element(s) from the hash or array. | |
8216c1fd GS |
961 | In the case of an array, if the array elements happen to be at the end, |
962 | the size of the array will shrink to the highest element that tests | |
963 | true for exists() (or 0 if no such element exists). | |
a0d0e21e | 964 | |
01020589 GS |
965 | Returns each element so deleted or the undefined value if there was no such |
966 | element. Deleting from C<$ENV{}> modifies the environment. Deleting from | |
967 | a hash tied to a DBM file deletes the entry from the DBM file. Deleting | |
968 | from a C<tie>d hash or array may not necessarily return anything. | |
969 | ||
8ea97a1e GS |
970 | Deleting an array element effectively returns that position of the array |
971 | to its initial, uninitialized state. Subsequently testing for the same | |
8216c1fd GS |
972 | element with exists() will return false. Note that deleting array |
973 | elements in the middle of an array will not shift the index of the ones | |
974 | after them down--use splice() for that. See L</exists>. | |
8ea97a1e | 975 | |
01020589 | 976 | The following (inefficiently) deletes all the values of %HASH and @ARRAY: |
a0d0e21e | 977 | |
5f05dabc | 978 | foreach $key (keys %HASH) { |
979 | delete $HASH{$key}; | |
a0d0e21e LW |
980 | } |
981 | ||
01020589 GS |
982 | foreach $index (0 .. $#ARRAY) { |
983 | delete $ARRAY[$index]; | |
984 | } | |
985 | ||
986 | And so do these: | |
5f05dabc | 987 | |
01020589 GS |
988 | delete @HASH{keys %HASH}; |
989 | ||
9740c838 | 990 | delete @ARRAY[0 .. $#ARRAY]; |
5f05dabc | 991 | |
2b5ab1e7 | 992 | But both of these are slower than just assigning the empty list |
01020589 GS |
993 | or undefining %HASH or @ARRAY: |
994 | ||
995 | %HASH = (); # completely empty %HASH | |
996 | undef %HASH; # forget %HASH ever existed | |
2b5ab1e7 | 997 | |
01020589 GS |
998 | @ARRAY = (); # completely empty @ARRAY |
999 | undef @ARRAY; # forget @ARRAY ever existed | |
2b5ab1e7 TC |
1000 | |
1001 | Note that the EXPR can be arbitrarily complicated as long as the final | |
01020589 GS |
1002 | operation is a hash element, array element, hash slice, or array slice |
1003 | lookup: | |
a0d0e21e LW |
1004 | |
1005 | delete $ref->[$x][$y]{$key}; | |
5f05dabc | 1006 | delete @{$ref->[$x][$y]}{$key1, $key2, @morekeys}; |
a0d0e21e | 1007 | |
01020589 GS |
1008 | delete $ref->[$x][$y][$index]; |
1009 | delete @{$ref->[$x][$y]}[$index1, $index2, @moreindices]; | |
1010 | ||
a0d0e21e LW |
1011 | =item die LIST |
1012 | ||
19799a22 GS |
1013 | Outside an C<eval>, prints the value of LIST to C<STDERR> and |
1014 | exits with the current value of C<$!> (errno). If C<$!> is C<0>, | |
61eff3bc JH |
1015 | exits with the value of C<<< ($? >> 8) >>> (backtick `command` |
1016 | status). If C<<< ($? >> 8) >>> is C<0>, exits with C<255>. Inside | |
19799a22 GS |
1017 | an C<eval(),> the error message is stuffed into C<$@> and the |
1018 | C<eval> is terminated with the undefined value. This makes | |
1019 | C<die> the way to raise an exception. | |
a0d0e21e LW |
1020 | |
1021 | Equivalent examples: | |
1022 | ||
1023 | die "Can't cd to spool: $!\n" unless chdir '/usr/spool/news'; | |
54310121 | 1024 | chdir '/usr/spool/news' or die "Can't cd to spool: $!\n" |
a0d0e21e LW |
1025 | |
1026 | If the value of EXPR does not end in a newline, the current script line | |
1027 | number and input line number (if any) are also printed, and a newline | |
883faa13 GS |
1028 | is supplied. Note that the "input line number" (also known as "chunk") |
1029 | is subject to whatever notion of "line" happens to be currently in | |
1030 | effect, and is also available as the special variable C<$.>. | |
1031 | See L<perlvar/"$/"> and L<perlvar/"$.">. | |
1032 | ||
1033 | Hint: sometimes appending C<", stopped"> to your message | |
7660c0ab | 1034 | will cause it to make better sense when the string C<"at foo line 123"> is |
a0d0e21e LW |
1035 | appended. Suppose you are running script "canasta". |
1036 | ||
1037 | die "/etc/games is no good"; | |
1038 | die "/etc/games is no good, stopped"; | |
1039 | ||
1040 | produce, respectively | |
1041 | ||
1042 | /etc/games is no good at canasta line 123. | |
1043 | /etc/games is no good, stopped at canasta line 123. | |
1044 | ||
2b5ab1e7 | 1045 | See also exit(), warn(), and the Carp module. |
a0d0e21e | 1046 | |
7660c0ab A |
1047 | If LIST is empty and C<$@> already contains a value (typically from a |
1048 | previous eval) that value is reused after appending C<"\t...propagated">. | |
fb73857a | 1049 | This is useful for propagating exceptions: |
1050 | ||
1051 | eval { ... }; | |
1052 | die unless $@ =~ /Expected exception/; | |
1053 | ||
7660c0ab | 1054 | If C<$@> is empty then the string C<"Died"> is used. |
fb73857a | 1055 | |
52531d10 GS |
1056 | die() can also be called with a reference argument. If this happens to be |
1057 | trapped within an eval(), $@ contains the reference. This behavior permits | |
1058 | a more elaborate exception handling implementation using objects that | |
4375e838 | 1059 | maintain arbitrary state about the nature of the exception. Such a scheme |
52531d10 GS |
1060 | is sometimes preferable to matching particular string values of $@ using |
1061 | regular expressions. Here's an example: | |
1062 | ||
1063 | eval { ... ; die Some::Module::Exception->new( FOO => "bar" ) }; | |
1064 | if ($@) { | |
1065 | if (ref($@) && UNIVERSAL::isa($@,"Some::Module::Exception")) { | |
1066 | # handle Some::Module::Exception | |
1067 | } | |
1068 | else { | |
1069 | # handle all other possible exceptions | |
1070 | } | |
1071 | } | |
1072 | ||
19799a22 | 1073 | Because perl will stringify uncaught exception messages before displaying |
52531d10 GS |
1074 | them, you may want to overload stringification operations on such custom |
1075 | exception objects. See L<overload> for details about that. | |
1076 | ||
19799a22 GS |
1077 | You can arrange for a callback to be run just before the C<die> |
1078 | does its deed, by setting the C<$SIG{__DIE__}> hook. The associated | |
1079 | handler will be called with the error text and can change the error | |
1080 | message, if it sees fit, by calling C<die> again. See | |
1081 | L<perlvar/$SIG{expr}> for details on setting C<%SIG> entries, and | |
1082 | L<"eval BLOCK"> for some examples. Although this feature was meant | |
1083 | to be run only right before your program was to exit, this is not | |
1084 | currently the case--the C<$SIG{__DIE__}> hook is currently called | |
1085 | even inside eval()ed blocks/strings! If one wants the hook to do | |
1086 | nothing in such situations, put | |
fb73857a | 1087 | |
1088 | die @_ if $^S; | |
1089 | ||
19799a22 GS |
1090 | as the first line of the handler (see L<perlvar/$^S>). Because |
1091 | this promotes strange action at a distance, this counterintuitive | |
1092 | behavior may be fixed in a future release. | |
774d564b | 1093 | |
a0d0e21e LW |
1094 | =item do BLOCK |
1095 | ||
1096 | Not really a function. Returns the value of the last command in the | |
1097 | sequence of commands indicated by BLOCK. When modified by a loop | |
98293880 JH |
1098 | modifier, executes the BLOCK once before testing the loop condition. |
1099 | (On other statements the loop modifiers test the conditional first.) | |
a0d0e21e | 1100 | |
4968c1e4 | 1101 | C<do BLOCK> does I<not> count as a loop, so the loop control statements |
2b5ab1e7 TC |
1102 | C<next>, C<last>, or C<redo> cannot be used to leave or restart the block. |
1103 | See L<perlsyn> for alternative strategies. | |
4968c1e4 | 1104 | |
a0d0e21e LW |
1105 | =item do SUBROUTINE(LIST) |
1106 | ||
1107 | A deprecated form of subroutine call. See L<perlsub>. | |
1108 | ||
1109 | =item do EXPR | |
1110 | ||
1111 | Uses the value of EXPR as a filename and executes the contents of the | |
1112 | file as a Perl script. Its primary use is to include subroutines | |
1113 | from a Perl subroutine library. | |
1114 | ||
1115 | do 'stat.pl'; | |
1116 | ||
1117 | is just like | |
1118 | ||
fb73857a | 1119 | scalar eval `cat stat.pl`; |
a0d0e21e | 1120 | |
2b5ab1e7 TC |
1121 | except that it's more efficient and concise, keeps track of the current |
1122 | filename for error messages, searches the @INC libraries, and updates | |
1123 | C<%INC> if the file is found. See L<perlvar/Predefined Names> for these | |
1124 | variables. It also differs in that code evaluated with C<do FILENAME> | |
1125 | cannot see lexicals in the enclosing scope; C<eval STRING> does. It's the | |
1126 | same, however, in that it does reparse the file every time you call it, | |
1127 | so you probably don't want to do this inside a loop. | |
a0d0e21e | 1128 | |
8e30cc93 | 1129 | If C<do> cannot read the file, it returns undef and sets C<$!> to the |
2b5ab1e7 | 1130 | error. If C<do> can read the file but cannot compile it, it |
8e30cc93 MG |
1131 | returns undef and sets an error message in C<$@>. If the file is |
1132 | successfully compiled, C<do> returns the value of the last expression | |
1133 | evaluated. | |
1134 | ||
a0d0e21e | 1135 | Note that inclusion of library modules is better done with the |
19799a22 | 1136 | C<use> and C<require> operators, which also do automatic error checking |
4633a7c4 | 1137 | and raise an exception if there's a problem. |
a0d0e21e | 1138 | |
5a964f20 TC |
1139 | You might like to use C<do> to read in a program configuration |
1140 | file. Manual error checking can be done this way: | |
1141 | ||
1142 | # read in config files: system first, then user | |
f86cebdf | 1143 | for $file ("/share/prog/defaults.rc", |
2b5ab1e7 TC |
1144 | "$ENV{HOME}/.someprogrc") |
1145 | { | |
5a964f20 | 1146 | unless ($return = do $file) { |
f86cebdf GS |
1147 | warn "couldn't parse $file: $@" if $@; |
1148 | warn "couldn't do $file: $!" unless defined $return; | |
1149 | warn "couldn't run $file" unless $return; | |
5a964f20 TC |
1150 | } |
1151 | } | |
1152 | ||
a0d0e21e LW |
1153 | =item dump LABEL |
1154 | ||
1614b0e3 JD |
1155 | =item dump |
1156 | ||
19799a22 GS |
1157 | This function causes an immediate core dump. See also the B<-u> |
1158 | command-line switch in L<perlrun>, which does the same thing. | |
1159 | Primarily this is so that you can use the B<undump> program (not | |
1160 | supplied) to turn your core dump into an executable binary after | |
1161 | having initialized all your variables at the beginning of the | |
1162 | program. When the new binary is executed it will begin by executing | |
1163 | a C<goto LABEL> (with all the restrictions that C<goto> suffers). | |
1164 | Think of it as a goto with an intervening core dump and reincarnation. | |
1165 | If C<LABEL> is omitted, restarts the program from the top. | |
1166 | ||
1167 | B<WARNING>: Any files opened at the time of the dump will I<not> | |
1168 | be open any more when the program is reincarnated, with possible | |
1169 | resulting confusion on the part of Perl. | |
1170 | ||
1171 | This function is now largely obsolete, partly because it's very | |
1172 | hard to convert a core file into an executable, and because the | |
1173 | real compiler backends for generating portable bytecode and compilable | |
1174 | C code have superseded it. | |
1175 | ||
1176 | If you're looking to use L<dump> to speed up your program, consider | |
1177 | generating bytecode or native C code as described in L<perlcc>. If | |
1178 | you're just trying to accelerate a CGI script, consider using the | |
1179 | C<mod_perl> extension to B<Apache>, or the CPAN module, Fast::CGI. | |
1180 | You might also consider autoloading or selfloading, which at least | |
1181 | make your program I<appear> to run faster. | |
5a964f20 | 1182 | |
aa689395 | 1183 | =item each HASH |
1184 | ||
5a964f20 | 1185 | When called in list context, returns a 2-element list consisting of the |
aa689395 | 1186 | key and value for the next element of a hash, so that you can iterate over |
5a964f20 | 1187 | it. When called in scalar context, returns the key for only the "next" |
e902a979 | 1188 | element in the hash. |
2f9daede | 1189 | |
ab192400 GS |
1190 | Entries are returned in an apparently random order. The actual random |
1191 | order is subject to change in future versions of perl, but it is guaranteed | |
19799a22 | 1192 | to be in the same order as either the C<keys> or C<values> function |
ab192400 GS |
1193 | would produce on the same (unmodified) hash. |
1194 | ||
1195 | When the hash is entirely read, a null array is returned in list context | |
19799a22 GS |
1196 | (which when assigned produces a false (C<0>) value), and C<undef> in |
1197 | scalar context. The next call to C<each> after that will start iterating | |
1198 | again. There is a single iterator for each hash, shared by all C<each>, | |
1199 | C<keys>, and C<values> function calls in the program; it can be reset by | |
2f9daede TP |
1200 | reading all the elements from the hash, or by evaluating C<keys HASH> or |
1201 | C<values HASH>. If you add or delete elements of a hash while you're | |
1202 | iterating over it, you may get entries skipped or duplicated, so don't. | |
aa689395 | 1203 | |
f86cebdf | 1204 | The following prints out your environment like the printenv(1) program, |
aa689395 | 1205 | only in a different order: |
a0d0e21e LW |
1206 | |
1207 | while (($key,$value) = each %ENV) { | |
1208 | print "$key=$value\n"; | |
1209 | } | |
1210 | ||
19799a22 | 1211 | See also C<keys>, C<values> and C<sort>. |
a0d0e21e LW |
1212 | |
1213 | =item eof FILEHANDLE | |
1214 | ||
4633a7c4 LW |
1215 | =item eof () |
1216 | ||
a0d0e21e LW |
1217 | =item eof |
1218 | ||
1219 | Returns 1 if the next read on FILEHANDLE will return end of file, or if | |
1220 | FILEHANDLE is not open. FILEHANDLE may be an expression whose value | |
5a964f20 | 1221 | gives the real filehandle. (Note that this function actually |
19799a22 | 1222 | reads a character and then C<ungetc>s it, so isn't very useful in an |
748a9306 | 1223 | interactive context.) Do not read from a terminal file (or call |
19799a22 | 1224 | C<eof(FILEHANDLE)> on it) after end-of-file is reached. File types such |
748a9306 LW |
1225 | as terminals may lose the end-of-file condition if you do. |
1226 | ||
820475bd GS |
1227 | An C<eof> without an argument uses the last file read. Using C<eof()> |
1228 | with empty parentheses is very different. It refers to the pseudo file | |
1229 | formed from the files listed on the command line and accessed via the | |
61eff3bc JH |
1230 | C<< <> >> operator. Since C<< <> >> isn't explicitly opened, |
1231 | as a normal filehandle is, an C<eof()> before C<< <> >> has been | |
820475bd GS |
1232 | used will cause C<@ARGV> to be examined to determine if input is |
1233 | available. | |
1234 | ||
61eff3bc | 1235 | In a C<< while (<>) >> loop, C<eof> or C<eof(ARGV)> can be used to |
820475bd GS |
1236 | detect the end of each file, C<eof()> will only detect the end of the |
1237 | last file. Examples: | |
a0d0e21e | 1238 | |
748a9306 LW |
1239 | # reset line numbering on each input file |
1240 | while (<>) { | |
5a964f20 | 1241 | next if /^\s*#/; # skip comments |
748a9306 | 1242 | print "$.\t$_"; |
5a964f20 TC |
1243 | } continue { |
1244 | close ARGV if eof; # Not eof()! | |
748a9306 LW |
1245 | } |
1246 | ||
a0d0e21e LW |
1247 | # insert dashes just before last line of last file |
1248 | while (<>) { | |
5a964f20 | 1249 | if (eof()) { # check for end of current file |
a0d0e21e | 1250 | print "--------------\n"; |
2b5ab1e7 | 1251 | close(ARGV); # close or last; is needed if we |
748a9306 | 1252 | # are reading from the terminal |
a0d0e21e LW |
1253 | } |
1254 | print; | |
1255 | } | |
1256 | ||
a0d0e21e | 1257 | Practical hint: you almost never need to use C<eof> in Perl, because the |
3ce0d271 GS |
1258 | input operators typically return C<undef> when they run out of data, or if |
1259 | there was an error. | |
a0d0e21e LW |
1260 | |
1261 | =item eval EXPR | |
1262 | ||
1263 | =item eval BLOCK | |
1264 | ||
c7cc6f1c GS |
1265 | In the first form, the return value of EXPR is parsed and executed as if it |
1266 | were a little Perl program. The value of the expression (which is itself | |
5a964f20 | 1267 | determined within scalar context) is first parsed, and if there weren't any |
c7cc6f1c | 1268 | errors, executed in the context of the current Perl program, so that any |
5f05dabc | 1269 | variable settings or subroutine and format definitions remain afterwards. |
c7cc6f1c GS |
1270 | Note that the value is parsed every time the eval executes. If EXPR is |
1271 | omitted, evaluates C<$_>. This form is typically used to delay parsing | |
1272 | and subsequent execution of the text of EXPR until run time. | |
1273 | ||
1274 | In the second form, the code within the BLOCK is parsed only once--at the | |
1275 | same time the code surrounding the eval itself was parsed--and executed | |
1276 | within the context of the current Perl program. This form is typically | |
1277 | used to trap exceptions more efficiently than the first (see below), while | |
1278 | also providing the benefit of checking the code within BLOCK at compile | |
1279 | time. | |
1280 | ||
1281 | The final semicolon, if any, may be omitted from the value of EXPR or within | |
1282 | the BLOCK. | |
1283 | ||
1284 | In both forms, the value returned is the value of the last expression | |
5a964f20 | 1285 | evaluated inside the mini-program; a return statement may be also used, just |
c7cc6f1c | 1286 | as with subroutines. The expression providing the return value is evaluated |
5a964f20 | 1287 | in void, scalar, or list context, depending on the context of the eval itself. |
c7cc6f1c | 1288 | See L</wantarray> for more on how the evaluation context can be determined. |
a0d0e21e | 1289 | |
19799a22 GS |
1290 | If there is a syntax error or runtime error, or a C<die> statement is |
1291 | executed, an undefined value is returned by C<eval>, and C<$@> is set to the | |
a0d0e21e | 1292 | error message. If there was no error, C<$@> is guaranteed to be a null |
19799a22 | 1293 | string. Beware that using C<eval> neither silences perl from printing |
c7cc6f1c GS |
1294 | warnings to STDERR, nor does it stuff the text of warning messages into C<$@>. |
1295 | To do either of those, you have to use the C<$SIG{__WARN__}> facility. See | |
1296 | L</warn> and L<perlvar>. | |
a0d0e21e | 1297 | |
19799a22 GS |
1298 | Note that, because C<eval> traps otherwise-fatal errors, it is useful for |
1299 | determining whether a particular feature (such as C<socket> or C<symlink>) | |
a0d0e21e LW |
1300 | is implemented. It is also Perl's exception trapping mechanism, where |
1301 | the die operator is used to raise exceptions. | |
1302 | ||
1303 | If the code to be executed doesn't vary, you may use the eval-BLOCK | |
1304 | form to trap run-time errors without incurring the penalty of | |
1305 | recompiling each time. The error, if any, is still returned in C<$@>. | |
1306 | Examples: | |
1307 | ||
54310121 | 1308 | # make divide-by-zero nonfatal |
a0d0e21e LW |
1309 | eval { $answer = $a / $b; }; warn $@ if $@; |
1310 | ||
1311 | # same thing, but less efficient | |
1312 | eval '$answer = $a / $b'; warn $@ if $@; | |
1313 | ||
1314 | # a compile-time error | |
5a964f20 | 1315 | eval { $answer = }; # WRONG |
a0d0e21e LW |
1316 | |
1317 | # a run-time error | |
1318 | eval '$answer ='; # sets $@ | |
1319 | ||
2b5ab1e7 TC |
1320 | Due to the current arguably broken state of C<__DIE__> hooks, when using |
1321 | the C<eval{}> form as an exception trap in libraries, you may wish not | |
1322 | to trigger any C<__DIE__> hooks that user code may have installed. | |
1323 | You can use the C<local $SIG{__DIE__}> construct for this purpose, | |
1324 | as shown in this example: | |
774d564b | 1325 | |
1326 | # a very private exception trap for divide-by-zero | |
f86cebdf GS |
1327 | eval { local $SIG{'__DIE__'}; $answer = $a / $b; }; |
1328 | warn $@ if $@; | |
774d564b | 1329 | |
1330 | This is especially significant, given that C<__DIE__> hooks can call | |
19799a22 | 1331 | C<die> again, which has the effect of changing their error messages: |
774d564b | 1332 | |
1333 | # __DIE__ hooks may modify error messages | |
1334 | { | |
f86cebdf GS |
1335 | local $SIG{'__DIE__'} = |
1336 | sub { (my $x = $_[0]) =~ s/foo/bar/g; die $x }; | |
c7cc6f1c GS |
1337 | eval { die "foo lives here" }; |
1338 | print $@ if $@; # prints "bar lives here" | |
774d564b | 1339 | } |
1340 | ||
19799a22 | 1341 | Because this promotes action at a distance, this counterintuitive behavior |
2b5ab1e7 TC |
1342 | may be fixed in a future release. |
1343 | ||
19799a22 | 1344 | With an C<eval>, you should be especially careful to remember what's |
a0d0e21e LW |
1345 | being looked at when: |
1346 | ||
1347 | eval $x; # CASE 1 | |
1348 | eval "$x"; # CASE 2 | |
1349 | ||
1350 | eval '$x'; # CASE 3 | |
1351 | eval { $x }; # CASE 4 | |
1352 | ||
5a964f20 | 1353 | eval "\$$x++"; # CASE 5 |
a0d0e21e LW |
1354 | $$x++; # CASE 6 |
1355 | ||
2f9daede | 1356 | Cases 1 and 2 above behave identically: they run the code contained in |
19799a22 | 1357 | the variable $x. (Although case 2 has misleading double quotes making |
2f9daede | 1358 | the reader wonder what else might be happening (nothing is).) Cases 3 |
7660c0ab | 1359 | and 4 likewise behave in the same way: they run the code C<'$x'>, which |
19799a22 | 1360 | does nothing but return the value of $x. (Case 4 is preferred for |
2f9daede TP |
1361 | purely visual reasons, but it also has the advantage of compiling at |
1362 | compile-time instead of at run-time.) Case 5 is a place where | |
19799a22 | 1363 | normally you I<would> like to use double quotes, except that in this |
2f9daede TP |
1364 | particular situation, you can just use symbolic references instead, as |
1365 | in case 6. | |
a0d0e21e | 1366 | |
4968c1e4 | 1367 | C<eval BLOCK> does I<not> count as a loop, so the loop control statements |
2b5ab1e7 | 1368 | C<next>, C<last>, or C<redo> cannot be used to leave or restart the block. |
4968c1e4 | 1369 | |
a0d0e21e LW |
1370 | =item exec LIST |
1371 | ||
8bf3b016 GS |
1372 | =item exec PROGRAM LIST |
1373 | ||
19799a22 GS |
1374 | The C<exec> function executes a system command I<and never returns>-- |
1375 | use C<system> instead of C<exec> if you want it to return. It fails and | |
1376 | returns false only if the command does not exist I<and> it is executed | |
fb73857a | 1377 | directly instead of via your system's command shell (see below). |
a0d0e21e | 1378 | |
19799a22 GS |
1379 | Since it's a common mistake to use C<exec> instead of C<system>, Perl |
1380 | warns you if there is a following statement which isn't C<die>, C<warn>, | |
1381 | or C<exit> (if C<-w> is set - but you always do that). If you | |
1382 | I<really> want to follow an C<exec> with some other statement, you | |
55d729e4 GS |
1383 | can use one of these styles to avoid the warning: |
1384 | ||
5a964f20 TC |
1385 | exec ('foo') or print STDERR "couldn't exec foo: $!"; |
1386 | { exec ('foo') }; print STDERR "couldn't exec foo: $!"; | |
55d729e4 | 1387 | |
5a964f20 | 1388 | If there is more than one argument in LIST, or if LIST is an array |
f86cebdf | 1389 | with more than one value, calls execvp(3) with the arguments in LIST. |
5a964f20 TC |
1390 | If there is only one scalar argument or an array with one element in it, |
1391 | the argument is checked for shell metacharacters, and if there are any, | |
1392 | the entire argument is passed to the system's command shell for parsing | |
1393 | (this is C</bin/sh -c> on Unix platforms, but varies on other platforms). | |
1394 | If there are no shell metacharacters in the argument, it is split into | |
19799a22 GS |
1395 | words and passed directly to C<execvp>, which is more efficient. |
1396 | Examples: | |
a0d0e21e | 1397 | |
19799a22 GS |
1398 | exec '/bin/echo', 'Your arguments are: ', @ARGV; |
1399 | exec "sort $outfile | uniq"; | |
a0d0e21e LW |
1400 | |
1401 | If you don't really want to execute the first argument, but want to lie | |
1402 | to the program you are executing about its own name, you can specify | |
1403 | the program you actually want to run as an "indirect object" (without a | |
1404 | comma) in front of the LIST. (This always forces interpretation of the | |
54310121 | 1405 | LIST as a multivalued list, even if there is only a single scalar in |
a0d0e21e LW |
1406 | the list.) Example: |
1407 | ||
1408 | $shell = '/bin/csh'; | |
1409 | exec $shell '-sh'; # pretend it's a login shell | |
1410 | ||
1411 | or, more directly, | |
1412 | ||
1413 | exec {'/bin/csh'} '-sh'; # pretend it's a login shell | |
1414 | ||
bb32b41a GS |
1415 | When the arguments get executed via the system shell, results will |
1416 | be subject to its quirks and capabilities. See L<perlop/"`STRING`"> | |
1417 | for details. | |
1418 | ||
19799a22 GS |
1419 | Using an indirect object with C<exec> or C<system> is also more |
1420 | secure. This usage (which also works fine with system()) forces | |
1421 | interpretation of the arguments as a multivalued list, even if the | |
1422 | list had just one argument. That way you're safe from the shell | |
1423 | expanding wildcards or splitting up words with whitespace in them. | |
5a964f20 TC |
1424 | |
1425 | @args = ( "echo surprise" ); | |
1426 | ||
2b5ab1e7 | 1427 | exec @args; # subject to shell escapes |
f86cebdf | 1428 | # if @args == 1 |
2b5ab1e7 | 1429 | exec { $args[0] } @args; # safe even with one-arg list |
5a964f20 TC |
1430 | |
1431 | The first version, the one without the indirect object, ran the I<echo> | |
1432 | program, passing it C<"surprise"> an argument. The second version | |
1433 | didn't--it tried to run a program literally called I<"echo surprise">, | |
1434 | didn't find it, and set C<$?> to a non-zero value indicating failure. | |
1435 | ||
0f897271 GS |
1436 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
1437 | output before the exec, but this may not be supported on some platforms | |
1438 | (see L<perlport>). To be safe, you may need to set C<$|> ($AUTOFLUSH | |
1439 | in English) or call the C<autoflush()> method of C<IO::Handle> on any | |
1440 | open handles in order to avoid lost output. | |
1441 | ||
19799a22 | 1442 | Note that C<exec> will not call your C<END> blocks, nor will it call |
7660c0ab A |
1443 | any C<DESTROY> methods in your objects. |
1444 | ||
a0d0e21e LW |
1445 | =item exists EXPR |
1446 | ||
01020589 | 1447 | Given an expression that specifies a hash element or array element, |
8ea97a1e GS |
1448 | returns true if the specified element in the hash or array has ever |
1449 | been initialized, even if the corresponding value is undefined. The | |
1450 | element is not autovivified if it doesn't exist. | |
a0d0e21e | 1451 | |
01020589 GS |
1452 | print "Exists\n" if exists $hash{$key}; |
1453 | print "Defined\n" if defined $hash{$key}; | |
1454 | print "True\n" if $hash{$key}; | |
1455 | ||
1456 | print "Exists\n" if exists $array[$index]; | |
1457 | print "Defined\n" if defined $array[$index]; | |
1458 | print "True\n" if $array[$index]; | |
a0d0e21e | 1459 | |
8ea97a1e | 1460 | A hash or array element can be true only if it's defined, and defined if |
a0d0e21e LW |
1461 | it exists, but the reverse doesn't necessarily hold true. |
1462 | ||
afebc493 GS |
1463 | Given an expression that specifies the name of a subroutine, |
1464 | returns true if the specified subroutine has ever been declared, even | |
1465 | if it is undefined. Mentioning a subroutine name for exists or defined | |
1466 | does not count as declaring it. | |
1467 | ||
1468 | print "Exists\n" if exists &subroutine; | |
1469 | print "Defined\n" if defined &subroutine; | |
1470 | ||
a0d0e21e | 1471 | Note that the EXPR can be arbitrarily complicated as long as the final |
afebc493 | 1472 | operation is a hash or array key lookup or subroutine name: |
a0d0e21e | 1473 | |
2b5ab1e7 TC |
1474 | if (exists $ref->{A}->{B}->{$key}) { } |
1475 | if (exists $hash{A}{B}{$key}) { } | |
1476 | ||
01020589 GS |
1477 | if (exists $ref->{A}->{B}->[$ix]) { } |
1478 | if (exists $hash{A}{B}[$ix]) { } | |
1479 | ||
afebc493 GS |
1480 | if (exists &{$ref->{A}{B}{$key}}) { } |
1481 | ||
01020589 GS |
1482 | Although the deepest nested array or hash will not spring into existence |
1483 | just because its existence was tested, any intervening ones will. | |
61eff3bc | 1484 | Thus C<< $ref->{"A"} >> and C<< $ref->{"A"}->{"B"} >> will spring |
01020589 GS |
1485 | into existence due to the existence test for the $key element above. |
1486 | This happens anywhere the arrow operator is used, including even: | |
5a964f20 | 1487 | |
2b5ab1e7 TC |
1488 | undef $ref; |
1489 | if (exists $ref->{"Some key"}) { } | |
1490 | print $ref; # prints HASH(0x80d3d5c) | |
1491 | ||
1492 | This surprising autovivification in what does not at first--or even | |
1493 | second--glance appear to be an lvalue context may be fixed in a future | |
5a964f20 | 1494 | release. |
a0d0e21e | 1495 | |
479ba383 GS |
1496 | See L<perlref/"Pseudo-hashes: Using an array as a hash"> for specifics |
1497 | on how exists() acts when used on a pseudo-hash. | |
e0478e5a | 1498 | |
afebc493 GS |
1499 | Use of a subroutine call, rather than a subroutine name, as an argument |
1500 | to exists() is an error. | |
1501 | ||
1502 | exists ⊂ # OK | |
1503 | exists &sub(); # Error | |
1504 | ||
a0d0e21e LW |
1505 | =item exit EXPR |
1506 | ||
2b5ab1e7 | 1507 | Evaluates EXPR and exits immediately with that value. Example: |
a0d0e21e LW |
1508 | |
1509 | $ans = <STDIN>; | |
1510 | exit 0 if $ans =~ /^[Xx]/; | |
1511 | ||
19799a22 | 1512 | See also C<die>. If EXPR is omitted, exits with C<0> status. The only |
2b5ab1e7 TC |
1513 | universally recognized values for EXPR are C<0> for success and C<1> |
1514 | for error; other values are subject to interpretation depending on the | |
1515 | environment in which the Perl program is running. For example, exiting | |
1516 | 69 (EX_UNAVAILABLE) from a I<sendmail> incoming-mail filter will cause | |
1517 | the mailer to return the item undelivered, but that's not true everywhere. | |
a0d0e21e | 1518 | |
19799a22 GS |
1519 | Don't use C<exit> to abort a subroutine if there's any chance that |
1520 | someone might want to trap whatever error happened. Use C<die> instead, | |
1521 | which can be trapped by an C<eval>. | |
28757baa | 1522 | |
19799a22 | 1523 | The exit() function does not always exit immediately. It calls any |
2b5ab1e7 | 1524 | defined C<END> routines first, but these C<END> routines may not |
19799a22 | 1525 | themselves abort the exit. Likewise any object destructors that need to |
2b5ab1e7 TC |
1526 | be called are called before the real exit. If this is a problem, you |
1527 | can call C<POSIX:_exit($status)> to avoid END and destructor processing. | |
87275199 | 1528 | See L<perlmod> for details. |
5a964f20 | 1529 | |
a0d0e21e LW |
1530 | =item exp EXPR |
1531 | ||
54310121 | 1532 | =item exp |
bbce6d69 | 1533 | |
2b5ab1e7 | 1534 | Returns I<e> (the natural logarithm base) to the power of EXPR. |
a0d0e21e LW |
1535 | If EXPR is omitted, gives C<exp($_)>. |
1536 | ||
1537 | =item fcntl FILEHANDLE,FUNCTION,SCALAR | |
1538 | ||
f86cebdf | 1539 | Implements the fcntl(2) function. You'll probably have to say |
a0d0e21e LW |
1540 | |
1541 | use Fcntl; | |
1542 | ||
0ade1984 | 1543 | first to get the correct constant definitions. Argument processing and |
19799a22 | 1544 | value return works just like C<ioctl> below. |
a0d0e21e LW |
1545 | For example: |
1546 | ||
1547 | use Fcntl; | |
5a964f20 TC |
1548 | fcntl($filehandle, F_GETFL, $packed_return_buffer) |
1549 | or die "can't fcntl F_GETFL: $!"; | |
1550 | ||
19799a22 | 1551 | You don't have to check for C<defined> on the return from C<fnctl>. |
951ba7fe GS |
1552 | Like C<ioctl>, it maps a C<0> return from the system call into |
1553 | C<"0 but true"> in Perl. This string is true in boolean context and C<0> | |
2b5ab1e7 TC |
1554 | in numeric context. It is also exempt from the normal B<-w> warnings |
1555 | on improper numeric conversions. | |
5a964f20 | 1556 | |
19799a22 | 1557 | Note that C<fcntl> will produce a fatal error if used on a machine that |
2b5ab1e7 TC |
1558 | doesn't implement fcntl(2). See the Fcntl module or your fcntl(2) |
1559 | manpage to learn what functions are available on your system. | |
a0d0e21e LW |
1560 | |
1561 | =item fileno FILEHANDLE | |
1562 | ||
2b5ab1e7 TC |
1563 | Returns the file descriptor for a filehandle, or undefined if the |
1564 | filehandle is not open. This is mainly useful for constructing | |
19799a22 | 1565 | bitmaps for C<select> and low-level POSIX tty-handling operations. |
2b5ab1e7 TC |
1566 | If FILEHANDLE is an expression, the value is taken as an indirect |
1567 | filehandle, generally its name. | |
5a964f20 TC |
1568 | |
1569 | You can use this to find out whether two handles refer to the | |
1570 | same underlying descriptor: | |
1571 | ||
1572 | if (fileno(THIS) == fileno(THAT)) { | |
1573 | print "THIS and THAT are dups\n"; | |
1574 | } | |
a0d0e21e LW |
1575 | |
1576 | =item flock FILEHANDLE,OPERATION | |
1577 | ||
19799a22 GS |
1578 | Calls flock(2), or an emulation of it, on FILEHANDLE. Returns true |
1579 | for success, false on failure. Produces a fatal error if used on a | |
2b5ab1e7 | 1580 | machine that doesn't implement flock(2), fcntl(2) locking, or lockf(3). |
19799a22 | 1581 | C<flock> is Perl's portable file locking interface, although it locks |
2b5ab1e7 TC |
1582 | only entire files, not records. |
1583 | ||
1584 | Two potentially non-obvious but traditional C<flock> semantics are | |
1585 | that it waits indefinitely until the lock is granted, and that its locks | |
1586 | B<merely advisory>. Such discretionary locks are more flexible, but offer | |
19799a22 GS |
1587 | fewer guarantees. This means that files locked with C<flock> may be |
1588 | modified by programs that do not also use C<flock>. See L<perlport>, | |
2b5ab1e7 TC |
1589 | your port's specific documentation, or your system-specific local manpages |
1590 | for details. It's best to assume traditional behavior if you're writing | |
1591 | portable programs. (But if you're not, you should as always feel perfectly | |
1592 | free to write for your own system's idiosyncrasies (sometimes called | |
1593 | "features"). Slavish adherence to portability concerns shouldn't get | |
1594 | in the way of your getting your job done.) | |
a3cb178b | 1595 | |
8ebc5c01 | 1596 | OPERATION is one of LOCK_SH, LOCK_EX, or LOCK_UN, possibly combined with |
1597 | LOCK_NB. These constants are traditionally valued 1, 2, 8 and 4, but | |
ea3105be | 1598 | you can use the symbolic names if you import them from the Fcntl module, |
68dc0745 | 1599 | either individually, or as a group using the ':flock' tag. LOCK_SH |
1600 | requests a shared lock, LOCK_EX requests an exclusive lock, and LOCK_UN | |
ea3105be GS |
1601 | releases a previously requested lock. If LOCK_NB is bitwise-or'ed with |
1602 | LOCK_SH or LOCK_EX then C<flock> will return immediately rather than blocking | |
68dc0745 | 1603 | waiting for the lock (check the return status to see if you got it). |
1604 | ||
2b5ab1e7 TC |
1605 | To avoid the possibility of miscoordination, Perl now flushes FILEHANDLE |
1606 | before locking or unlocking it. | |
8ebc5c01 | 1607 | |
f86cebdf | 1608 | Note that the emulation built with lockf(3) doesn't provide shared |
8ebc5c01 | 1609 | locks, and it requires that FILEHANDLE be open with write intent. These |
2b5ab1e7 | 1610 | are the semantics that lockf(3) implements. Most if not all systems |
f86cebdf | 1611 | implement lockf(3) in terms of fcntl(2) locking, though, so the |
8ebc5c01 | 1612 | differing semantics shouldn't bite too many people. |
1613 | ||
19799a22 GS |
1614 | Note also that some versions of C<flock> cannot lock things over the |
1615 | network; you would need to use the more system-specific C<fcntl> for | |
f86cebdf GS |
1616 | that. If you like you can force Perl to ignore your system's flock(2) |
1617 | function, and so provide its own fcntl(2)-based emulation, by passing | |
8ebc5c01 | 1618 | the switch C<-Ud_flock> to the F<Configure> program when you configure |
1619 | perl. | |
4633a7c4 LW |
1620 | |
1621 | Here's a mailbox appender for BSD systems. | |
a0d0e21e | 1622 | |
7e1af8bc | 1623 | use Fcntl ':flock'; # import LOCK_* constants |
a0d0e21e LW |
1624 | |
1625 | sub lock { | |
7e1af8bc | 1626 | flock(MBOX,LOCK_EX); |
a0d0e21e LW |
1627 | # and, in case someone appended |
1628 | # while we were waiting... | |
1629 | seek(MBOX, 0, 2); | |
1630 | } | |
1631 | ||
1632 | sub unlock { | |
7e1af8bc | 1633 | flock(MBOX,LOCK_UN); |
a0d0e21e LW |
1634 | } |
1635 | ||
1636 | open(MBOX, ">>/usr/spool/mail/$ENV{'USER'}") | |
1637 | or die "Can't open mailbox: $!"; | |
1638 | ||
1639 | lock(); | |
1640 | print MBOX $msg,"\n\n"; | |
1641 | unlock(); | |
1642 | ||
2b5ab1e7 TC |
1643 | On systems that support a real flock(), locks are inherited across fork() |
1644 | calls, whereas those that must resort to the more capricious fcntl() | |
1645 | function lose the locks, making it harder to write servers. | |
1646 | ||
cb1a09d0 | 1647 | See also L<DB_File> for other flock() examples. |
a0d0e21e LW |
1648 | |
1649 | =item fork | |
1650 | ||
2b5ab1e7 TC |
1651 | Does a fork(2) system call to create a new process running the |
1652 | same program at the same point. It returns the child pid to the | |
1653 | parent process, C<0> to the child process, or C<undef> if the fork is | |
1654 | unsuccessful. File descriptors (and sometimes locks on those descriptors) | |
1655 | are shared, while everything else is copied. On most systems supporting | |
1656 | fork(), great care has gone into making it extremely efficient (for | |
1657 | example, using copy-on-write technology on data pages), making it the | |
1658 | dominant paradigm for multitasking over the last few decades. | |
5a964f20 | 1659 | |
0f897271 GS |
1660 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
1661 | output before forking the child process, but this may not be supported | |
1662 | on some platforms (see L<perlport>). To be safe, you may need to set | |
1663 | C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method of | |
1664 | C<IO::Handle> on any open handles in order to avoid duplicate output. | |
a0d0e21e | 1665 | |
19799a22 | 1666 | If you C<fork> without ever waiting on your children, you will |
2b5ab1e7 TC |
1667 | accumulate zombies. On some systems, you can avoid this by setting |
1668 | C<$SIG{CHLD}> to C<"IGNORE">. See also L<perlipc> for more examples of | |
1669 | forking and reaping moribund children. | |
cb1a09d0 | 1670 | |
28757baa | 1671 | Note that if your forked child inherits system file descriptors like |
1672 | STDIN and STDOUT that are actually connected by a pipe or socket, even | |
2b5ab1e7 | 1673 | if you exit, then the remote server (such as, say, a CGI script or a |
19799a22 | 1674 | backgrounded job launched from a remote shell) won't think you're done. |
2b5ab1e7 | 1675 | You should reopen those to F</dev/null> if it's any issue. |
28757baa | 1676 | |
cb1a09d0 AD |
1677 | =item format |
1678 | ||
19799a22 | 1679 | Declare a picture format for use by the C<write> function. For |
cb1a09d0 AD |
1680 | example: |
1681 | ||
54310121 | 1682 | format Something = |
cb1a09d0 AD |
1683 | Test: @<<<<<<<< @||||| @>>>>> |
1684 | $str, $%, '$' . int($num) | |
1685 | . | |
1686 | ||
1687 | $str = "widget"; | |
184e9718 | 1688 | $num = $cost/$quantity; |
cb1a09d0 AD |
1689 | $~ = 'Something'; |
1690 | write; | |
1691 | ||
1692 | See L<perlform> for many details and examples. | |
1693 | ||
8903cb82 | 1694 | =item formline PICTURE,LIST |
a0d0e21e | 1695 | |
5a964f20 | 1696 | This is an internal function used by C<format>s, though you may call it, |
a0d0e21e LW |
1697 | too. It formats (see L<perlform>) a list of values according to the |
1698 | contents of PICTURE, placing the output into the format output | |
7660c0ab | 1699 | accumulator, C<$^A> (or C<$ACCUMULATOR> in English). |
19799a22 | 1700 | Eventually, when a C<write> is done, the contents of |
a0d0e21e | 1701 | C<$^A> are written to some filehandle, but you could also read C<$^A> |
7660c0ab | 1702 | yourself and then set C<$^A> back to C<"">. Note that a format typically |
19799a22 | 1703 | does one C<formline> per line of form, but the C<formline> function itself |
748a9306 | 1704 | doesn't care how many newlines are embedded in the PICTURE. This means |
4633a7c4 | 1705 | that the C<~> and C<~~> tokens will treat the entire PICTURE as a single line. |
748a9306 LW |
1706 | You may therefore need to use multiple formlines to implement a single |
1707 | record format, just like the format compiler. | |
1708 | ||
19799a22 | 1709 | Be careful if you put double quotes around the picture, because an C<@> |
748a9306 | 1710 | character may be taken to mean the beginning of an array name. |
19799a22 | 1711 | C<formline> always returns true. See L<perlform> for other examples. |
a0d0e21e LW |
1712 | |
1713 | =item getc FILEHANDLE | |
1714 | ||
1715 | =item getc | |
1716 | ||
1717 | Returns the next character from the input file attached to FILEHANDLE, | |
2b5ab1e7 TC |
1718 | or the undefined value at end of file, or if there was an error. |
1719 | If FILEHANDLE is omitted, reads from STDIN. This is not particularly | |
1720 | efficient. However, it cannot be used by itself to fetch single | |
1721 | characters without waiting for the user to hit enter. For that, try | |
1722 | something more like: | |
4633a7c4 LW |
1723 | |
1724 | if ($BSD_STYLE) { | |
1725 | system "stty cbreak </dev/tty >/dev/tty 2>&1"; | |
1726 | } | |
1727 | else { | |
54310121 | 1728 | system "stty", '-icanon', 'eol', "\001"; |
4633a7c4 LW |
1729 | } |
1730 | ||
1731 | $key = getc(STDIN); | |
1732 | ||
1733 | if ($BSD_STYLE) { | |
1734 | system "stty -cbreak </dev/tty >/dev/tty 2>&1"; | |
1735 | } | |
1736 | else { | |
5f05dabc | 1737 | system "stty", 'icanon', 'eol', '^@'; # ASCII null |
4633a7c4 LW |
1738 | } |
1739 | print "\n"; | |
1740 | ||
54310121 | 1741 | Determination of whether $BSD_STYLE should be set |
1742 | is left as an exercise to the reader. | |
cb1a09d0 | 1743 | |
19799a22 | 1744 | The C<POSIX::getattr> function can do this more portably on |
2b5ab1e7 TC |
1745 | systems purporting POSIX compliance. See also the C<Term::ReadKey> |
1746 | module from your nearest CPAN site; details on CPAN can be found on | |
1747 | L<perlmodlib/CPAN>. | |
a0d0e21e LW |
1748 | |
1749 | =item getlogin | |
1750 | ||
5a964f20 TC |
1751 | Implements the C library function of the same name, which on most |
1752 | systems returns the current login from F</etc/utmp>, if any. If null, | |
19799a22 | 1753 | use C<getpwuid>. |
a0d0e21e | 1754 | |
f86702cc | 1755 | $login = getlogin || getpwuid($<) || "Kilroy"; |
a0d0e21e | 1756 | |
19799a22 GS |
1757 | Do not consider C<getlogin> for authentication: it is not as |
1758 | secure as C<getpwuid>. | |
4633a7c4 | 1759 | |
a0d0e21e LW |
1760 | =item getpeername SOCKET |
1761 | ||
1762 | Returns the packed sockaddr address of other end of the SOCKET connection. | |
1763 | ||
4633a7c4 LW |
1764 | use Socket; |
1765 | $hersockaddr = getpeername(SOCK); | |
19799a22 | 1766 | ($port, $iaddr) = sockaddr_in($hersockaddr); |
4633a7c4 LW |
1767 | $herhostname = gethostbyaddr($iaddr, AF_INET); |
1768 | $herstraddr = inet_ntoa($iaddr); | |
a0d0e21e LW |
1769 | |
1770 | =item getpgrp PID | |
1771 | ||
47e29363 | 1772 | Returns the current process group for the specified PID. Use |
7660c0ab | 1773 | a PID of C<0> to get the current process group for the |
4633a7c4 | 1774 | current process. Will raise an exception if used on a machine that |
f86cebdf | 1775 | doesn't implement getpgrp(2). If PID is omitted, returns process |
19799a22 | 1776 | group of current process. Note that the POSIX version of C<getpgrp> |
7660c0ab | 1777 | does not accept a PID argument, so only C<PID==0> is truly portable. |
a0d0e21e LW |
1778 | |
1779 | =item getppid | |
1780 | ||
1781 | Returns the process id of the parent process. | |
1782 | ||
1783 | =item getpriority WHICH,WHO | |
1784 | ||
4633a7c4 LW |
1785 | Returns the current priority for a process, a process group, or a user. |
1786 | (See L<getpriority(2)>.) Will raise a fatal exception if used on a | |
f86cebdf | 1787 | machine that doesn't implement getpriority(2). |
a0d0e21e LW |
1788 | |
1789 | =item getpwnam NAME | |
1790 | ||
1791 | =item getgrnam NAME | |
1792 | ||
1793 | =item gethostbyname NAME | |
1794 | ||
1795 | =item getnetbyname NAME | |
1796 | ||
1797 | =item getprotobyname NAME | |
1798 | ||
1799 | =item getpwuid UID | |
1800 | ||
1801 | =item getgrgid GID | |
1802 | ||
1803 | =item getservbyname NAME,PROTO | |
1804 | ||
1805 | =item gethostbyaddr ADDR,ADDRTYPE | |
1806 | ||
1807 | =item getnetbyaddr ADDR,ADDRTYPE | |
1808 | ||
1809 | =item getprotobynumber NUMBER | |
1810 | ||
1811 | =item getservbyport PORT,PROTO | |
1812 | ||
1813 | =item getpwent | |
1814 | ||
1815 | =item getgrent | |
1816 | ||
1817 | =item gethostent | |
1818 | ||
1819 | =item getnetent | |
1820 | ||
1821 | =item getprotoent | |
1822 | ||
1823 | =item getservent | |
1824 | ||
1825 | =item setpwent | |
1826 | ||
1827 | =item setgrent | |
1828 | ||
1829 | =item sethostent STAYOPEN | |
1830 | ||
1831 | =item setnetent STAYOPEN | |
1832 | ||
1833 | =item setprotoent STAYOPEN | |
1834 | ||
1835 | =item setservent STAYOPEN | |
1836 | ||
1837 | =item endpwent | |
1838 | ||
1839 | =item endgrent | |
1840 | ||
1841 | =item endhostent | |
1842 | ||
1843 | =item endnetent | |
1844 | ||
1845 | =item endprotoent | |
1846 | ||
1847 | =item endservent | |
1848 | ||
1849 | These routines perform the same functions as their counterparts in the | |
5a964f20 | 1850 | system library. In list context, the return values from the |
a0d0e21e LW |
1851 | various get routines are as follows: |
1852 | ||
1853 | ($name,$passwd,$uid,$gid, | |
6ee623d5 | 1854 | $quota,$comment,$gcos,$dir,$shell,$expire) = getpw* |
a0d0e21e LW |
1855 | ($name,$passwd,$gid,$members) = getgr* |
1856 | ($name,$aliases,$addrtype,$length,@addrs) = gethost* | |
1857 | ($name,$aliases,$addrtype,$net) = getnet* | |
1858 | ($name,$aliases,$proto) = getproto* | |
1859 | ($name,$aliases,$port,$proto) = getserv* | |
1860 | ||
1861 | (If the entry doesn't exist you get a null list.) | |
1862 | ||
4602f195 JH |
1863 | The exact meaning of the $gcos field varies but it usually contains |
1864 | the real name of the user (as opposed to the login name) and other | |
1865 | information pertaining to the user. Beware, however, that in many | |
1866 | system users are able to change this information and therefore it | |
106325ad | 1867 | cannot be trusted and therefore the $gcos is tainted (see |
2959b6e3 JH |
1868 | L<perlsec>). The $passwd and $shell, user's encrypted password and |
1869 | login shell, are also tainted, because of the same reason. | |
4602f195 | 1870 | |
5a964f20 | 1871 | In scalar context, you get the name, unless the function was a |
a0d0e21e LW |
1872 | lookup by name, in which case you get the other thing, whatever it is. |
1873 | (If the entry doesn't exist you get the undefined value.) For example: | |
1874 | ||
5a964f20 TC |
1875 | $uid = getpwnam($name); |
1876 | $name = getpwuid($num); | |
1877 | $name = getpwent(); | |
1878 | $gid = getgrnam($name); | |
1879 | $name = getgrgid($num; | |
1880 | $name = getgrent(); | |
1881 | #etc. | |
a0d0e21e | 1882 | |
4602f195 JH |
1883 | In I<getpw*()> the fields $quota, $comment, and $expire are special |
1884 | cases in the sense that in many systems they are unsupported. If the | |
1885 | $quota is unsupported, it is an empty scalar. If it is supported, it | |
1886 | usually encodes the disk quota. If the $comment field is unsupported, | |
1887 | it is an empty scalar. If it is supported it usually encodes some | |
1888 | administrative comment about the user. In some systems the $quota | |
1889 | field may be $change or $age, fields that have to do with password | |
1890 | aging. In some systems the $comment field may be $class. The $expire | |
1891 | field, if present, encodes the expiration period of the account or the | |
1892 | password. For the availability and the exact meaning of these fields | |
1893 | in your system, please consult your getpwnam(3) documentation and your | |
1894 | F<pwd.h> file. You can also find out from within Perl what your | |
1895 | $quota and $comment fields mean and whether you have the $expire field | |
1896 | by using the C<Config> module and the values C<d_pwquota>, C<d_pwage>, | |
1897 | C<d_pwchange>, C<d_pwcomment>, and C<d_pwexpire>. Shadow password | |
1898 | files are only supported if your vendor has implemented them in the | |
1899 | intuitive fashion that calling the regular C library routines gets the | |
5d3a0a3b GS |
1900 | shadow versions if you're running under privilege or if there exists |
1901 | the shadow(3) functions as found in System V ( this includes Solaris | |
1902 | and Linux.) Those systems which implement a proprietary shadow password | |
1903 | facility are unlikely to be supported. | |
6ee623d5 | 1904 | |
19799a22 | 1905 | The $members value returned by I<getgr*()> is a space separated list of |
a0d0e21e LW |
1906 | the login names of the members of the group. |
1907 | ||
1908 | For the I<gethost*()> functions, if the C<h_errno> variable is supported in | |
1909 | C, it will be returned to you via C<$?> if the function call fails. The | |
7660c0ab | 1910 | C<@addrs> value returned by a successful call is a list of the raw |
a0d0e21e LW |
1911 | addresses returned by the corresponding system library call. In the |
1912 | Internet domain, each address is four bytes long and you can unpack it | |
1913 | by saying something like: | |
1914 | ||
1915 | ($a,$b,$c,$d) = unpack('C4',$addr[0]); | |
1916 | ||
2b5ab1e7 TC |
1917 | The Socket library makes this slightly easier: |
1918 | ||
1919 | use Socket; | |
1920 | $iaddr = inet_aton("127.1"); # or whatever address | |
1921 | $name = gethostbyaddr($iaddr, AF_INET); | |
1922 | ||
1923 | # or going the other way | |
19799a22 | 1924 | $straddr = inet_ntoa($iaddr); |
2b5ab1e7 | 1925 | |
19799a22 GS |
1926 | If you get tired of remembering which element of the return list |
1927 | contains which return value, by-name interfaces are provided | |
1928 | in standard modules: C<File::stat>, C<Net::hostent>, C<Net::netent>, | |
1929 | C<Net::protoent>, C<Net::servent>, C<Time::gmtime>, C<Time::localtime>, | |
1930 | and C<User::grent>. These override the normal built-ins, supplying | |
1931 | versions that return objects with the appropriate names | |
1932 | for each field. For example: | |
5a964f20 TC |
1933 | |
1934 | use File::stat; | |
1935 | use User::pwent; | |
1936 | $is_his = (stat($filename)->uid == pwent($whoever)->uid); | |
1937 | ||
1938 | Even though it looks like they're the same method calls (uid), | |
19799a22 GS |
1939 | they aren't, because a C<File::stat> object is different from |
1940 | a C<User::pwent> object. | |
5a964f20 | 1941 | |
a0d0e21e LW |
1942 | =item getsockname SOCKET |
1943 | ||
19799a22 GS |
1944 | Returns the packed sockaddr address of this end of the SOCKET connection, |
1945 | in case you don't know the address because you have several different | |
1946 | IPs that the connection might have come in on. | |
a0d0e21e | 1947 | |
4633a7c4 LW |
1948 | use Socket; |
1949 | $mysockaddr = getsockname(SOCK); | |
19799a22 GS |
1950 | ($port, $myaddr) = sockaddr_in($mysockaddr); |
1951 | printf "Connect to %s [%s]\n", | |
1952 | scalar gethostbyaddr($myaddr, AF_INET), | |
1953 | inet_ntoa($myaddr); | |
a0d0e21e LW |
1954 | |
1955 | =item getsockopt SOCKET,LEVEL,OPTNAME | |
1956 | ||
5a964f20 | 1957 | Returns the socket option requested, or undef if there is an error. |
a0d0e21e LW |
1958 | |
1959 | =item glob EXPR | |
1960 | ||
0a753a76 | 1961 | =item glob |
1962 | ||
2b5ab1e7 TC |
1963 | Returns the value of EXPR with filename expansions such as the |
1964 | standard Unix shell F</bin/csh> would do. This is the internal function | |
61eff3bc JH |
1965 | implementing the C<< <*.c> >> operator, but you can use it directly. |
1966 | If EXPR is omitted, C<$_> is used. The C<< <*.c> >> operator is | |
2b5ab1e7 | 1967 | discussed in more detail in L<perlop/"I/O Operators">. |
a0d0e21e | 1968 | |
3a4b19e4 GS |
1969 | Beginning with v5.6.0, this operator is implemented using the standard |
1970 | C<File::Glob> extension. See L<File::Glob> for details. | |
1971 | ||
a0d0e21e LW |
1972 | =item gmtime EXPR |
1973 | ||
48a26b3a | 1974 | Converts a time as returned by the time function to a 8-element list |
54310121 | 1975 | with the time localized for the standard Greenwich time zone. |
4633a7c4 | 1976 | Typically used as follows: |
a0d0e21e | 1977 | |
48a26b3a GS |
1978 | # 0 1 2 3 4 5 6 7 |
1979 | ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday) = | |
a0d0e21e LW |
1980 | gmtime(time); |
1981 | ||
48a26b3a GS |
1982 | All list elements are numeric, and come straight out of the C `struct |
1983 | tm'. $sec, $min, and $hour are the seconds, minutes, and hours of the | |
1984 | specified time. $mday is the day of the month, and $mon is the month | |
1985 | itself, in the range C<0..11> with 0 indicating January and 11 | |
1986 | indicating December. $year is the number of years since 1900. That | |
1987 | is, $year is C<123> in year 2023. $wday is the day of the week, with | |
1988 | 0 indicating Sunday and 3 indicating Wednesday. $yday is the day of | |
874b1813 | 1989 | the year, in the range C<0..364> (or C<0..365> in leap years.) |
48a26b3a GS |
1990 | |
1991 | Note that the $year element is I<not> simply the last two digits of | |
1992 | the year. If you assume it is, then you create non-Y2K-compliant | |
1993 | programs--and you wouldn't want to do that, would you? | |
2f9daede | 1994 | |
abd75f24 GS |
1995 | The proper way to get a complete 4-digit year is simply: |
1996 | ||
1997 | $year += 1900; | |
1998 | ||
1999 | And to get the last two digits of the year (e.g., '01' in 2001) do: | |
2000 | ||
2001 | $year = sprintf("%02d", $year % 100); | |
2002 | ||
48a26b3a | 2003 | If EXPR is omitted, C<gmtime()> uses the current time (C<gmtime(time)>). |
a0d0e21e | 2004 | |
48a26b3a | 2005 | In scalar context, C<gmtime()> returns the ctime(3) value: |
0a753a76 | 2006 | |
2007 | $now_string = gmtime; # e.g., "Thu Oct 13 04:54:34 1994" | |
2008 | ||
19799a22 | 2009 | Also see the C<timegm> function provided by the C<Time::Local> module, |
f86cebdf | 2010 | and the strftime(3) function available via the POSIX module. |
7660c0ab | 2011 | |
2b5ab1e7 TC |
2012 | This scalar value is B<not> locale dependent (see L<perllocale>), but |
2013 | is instead a Perl builtin. Also see the C<Time::Local> module, and the | |
2014 | strftime(3) and mktime(3) functions available via the POSIX module. To | |
7660c0ab A |
2015 | get somewhat similar but locale dependent date strings, set up your |
2016 | locale environment variables appropriately (please see L<perllocale>) | |
2017 | and try for example: | |
2018 | ||
2019 | use POSIX qw(strftime); | |
2b5ab1e7 | 2020 | $now_string = strftime "%a %b %e %H:%M:%S %Y", gmtime; |
7660c0ab | 2021 | |
2b5ab1e7 TC |
2022 | Note that the C<%a> and C<%b> escapes, which represent the short forms |
2023 | of the day of the week and the month of the year, may not necessarily | |
2024 | be three characters wide in all locales. | |
0a753a76 | 2025 | |
a0d0e21e LW |
2026 | =item goto LABEL |
2027 | ||
748a9306 LW |
2028 | =item goto EXPR |
2029 | ||
a0d0e21e LW |
2030 | =item goto &NAME |
2031 | ||
7660c0ab | 2032 | The C<goto-LABEL> form finds the statement labeled with LABEL and resumes |
a0d0e21e | 2033 | execution there. It may not be used to go into any construct that |
7660c0ab | 2034 | requires initialization, such as a subroutine or a C<foreach> loop. It |
0a753a76 | 2035 | also can't be used to go into a construct that is optimized away, |
19799a22 | 2036 | or to get out of a block or subroutine given to C<sort>. |
0a753a76 | 2037 | It can be used to go almost anywhere else within the dynamic scope, |
a0d0e21e | 2038 | including out of subroutines, but it's usually better to use some other |
19799a22 | 2039 | construct such as C<last> or C<die>. The author of Perl has never felt the |
7660c0ab | 2040 | need to use this form of C<goto> (in Perl, that is--C is another matter). |
a0d0e21e | 2041 | |
7660c0ab A |
2042 | The C<goto-EXPR> form expects a label name, whose scope will be resolved |
2043 | dynamically. This allows for computed C<goto>s per FORTRAN, but isn't | |
748a9306 LW |
2044 | necessarily recommended if you're optimizing for maintainability: |
2045 | ||
2046 | goto ("FOO", "BAR", "GLARCH")[$i]; | |
2047 | ||
6cb9131c GS |
2048 | The C<goto-&NAME> form is quite different from the other forms of C<goto>. |
2049 | In fact, it isn't a goto in the normal sense at all, and doesn't have | |
2050 | the stigma associated with other gotos. Instead, it | |
2051 | substitutes a call to the named subroutine for the currently running | |
2052 | subroutine. This is used by C<AUTOLOAD> subroutines that wish to load | |
2053 | another subroutine and then pretend that the other subroutine had been | |
2054 | called in the first place (except that any modifications to C<@_> | |
2055 | in the current subroutine are propagated to the other subroutine.) | |
2056 | After the C<goto>, not even C<caller> will be able to tell that this | |
2057 | routine was called first. | |
2058 | ||
2059 | NAME needn't be the name of a subroutine; it can be a scalar variable | |
2060 | containing a code reference, or a block which evaluates to a code | |
2061 | reference. | |
a0d0e21e LW |
2062 | |
2063 | =item grep BLOCK LIST | |
2064 | ||
2065 | =item grep EXPR,LIST | |
2066 | ||
2b5ab1e7 TC |
2067 | This is similar in spirit to, but not the same as, grep(1) and its |
2068 | relatives. In particular, it is not limited to using regular expressions. | |
2f9daede | 2069 | |
a0d0e21e | 2070 | Evaluates the BLOCK or EXPR for each element of LIST (locally setting |
7660c0ab | 2071 | C<$_> to each element) and returns the list value consisting of those |
19799a22 GS |
2072 | elements for which the expression evaluated to true. In scalar |
2073 | context, returns the number of times the expression was true. | |
a0d0e21e LW |
2074 | |
2075 | @foo = grep(!/^#/, @bar); # weed out comments | |
2076 | ||
2077 | or equivalently, | |
2078 | ||
2079 | @foo = grep {!/^#/} @bar; # weed out comments | |
2080 | ||
2b5ab1e7 TC |
2081 | Note that, because C<$_> is a reference into the list value, it can |
2082 | be used to modify the elements of the array. While this is useful and | |
2083 | supported, it can cause bizarre results if the LIST is not a named array. | |
2084 | Similarly, grep returns aliases into the original list, much as a for | |
2085 | loop's index variable aliases the list elements. That is, modifying an | |
19799a22 GS |
2086 | element of a list returned by grep (for example, in a C<foreach>, C<map> |
2087 | or another C<grep>) actually modifies the element in the original list. | |
2b5ab1e7 | 2088 | This is usually something to be avoided when writing clear code. |
a0d0e21e | 2089 | |
19799a22 | 2090 | See also L</map> for a list composed of the results of the BLOCK or EXPR. |
38325410 | 2091 | |
a0d0e21e LW |
2092 | =item hex EXPR |
2093 | ||
54310121 | 2094 | =item hex |
bbce6d69 | 2095 | |
2b5ab1e7 TC |
2096 | Interprets EXPR as a hex string and returns the corresponding value. |
2097 | (To convert strings that might start with either 0, 0x, or 0b, see | |
2098 | L</oct>.) If EXPR is omitted, uses C<$_>. | |
2f9daede TP |
2099 | |
2100 | print hex '0xAf'; # prints '175' | |
2101 | print hex 'aF'; # same | |
a0d0e21e | 2102 | |
19799a22 | 2103 | Hex strings may only represent integers. Strings that would cause |
c6edd1b7 | 2104 | integer overflow trigger a warning. |
19799a22 | 2105 | |
a0d0e21e LW |
2106 | =item import |
2107 | ||
19799a22 | 2108 | There is no builtin C<import> function. It is just an ordinary |
4633a7c4 | 2109 | method (subroutine) defined (or inherited) by modules that wish to export |
19799a22 | 2110 | names to another module. The C<use> function calls the C<import> method |
54310121 | 2111 | for the package used. See also L</use()>, L<perlmod>, and L<Exporter>. |
a0d0e21e LW |
2112 | |
2113 | =item index STR,SUBSTR,POSITION | |
2114 | ||
2115 | =item index STR,SUBSTR | |
2116 | ||
2b5ab1e7 TC |
2117 | The index function searches for one string within another, but without |
2118 | the wildcard-like behavior of a full regular-expression pattern match. | |
2119 | It returns the position of the first occurrence of SUBSTR in STR at | |
2120 | or after POSITION. If POSITION is omitted, starts searching from the | |
2121 | beginning of the string. The return value is based at C<0> (or whatever | |
2122 | you've set the C<$[> variable to--but don't do that). If the substring | |
2123 | is not found, returns one less than the base, ordinarily C<-1>. | |
a0d0e21e LW |
2124 | |
2125 | =item int EXPR | |
2126 | ||
54310121 | 2127 | =item int |
bbce6d69 | 2128 | |
7660c0ab | 2129 | Returns the integer portion of EXPR. If EXPR is omitted, uses C<$_>. |
2b5ab1e7 TC |
2130 | You should not use this function for rounding: one because it truncates |
2131 | towards C<0>, and two because machine representations of floating point | |
2132 | numbers can sometimes produce counterintuitive results. For example, | |
2133 | C<int(-6.725/0.025)> produces -268 rather than the correct -269; that's | |
2134 | because it's really more like -268.99999999999994315658 instead. Usually, | |
19799a22 | 2135 | the C<sprintf>, C<printf>, or the C<POSIX::floor> and C<POSIX::ceil> |
2b5ab1e7 | 2136 | functions will serve you better than will int(). |
a0d0e21e LW |
2137 | |
2138 | =item ioctl FILEHANDLE,FUNCTION,SCALAR | |
2139 | ||
2b5ab1e7 | 2140 | Implements the ioctl(2) function. You'll probably first have to say |
a0d0e21e | 2141 | |
4633a7c4 | 2142 | require "ioctl.ph"; # probably in /usr/local/lib/perl/ioctl.ph |
a0d0e21e | 2143 | |
2b5ab1e7 | 2144 | to get the correct function definitions. If F<ioctl.ph> doesn't |
a0d0e21e | 2145 | exist or doesn't have the correct definitions you'll have to roll your |
61eff3bc | 2146 | own, based on your C header files such as F<< <sys/ioctl.h> >>. |
5a964f20 | 2147 | (There is a Perl script called B<h2ph> that comes with the Perl kit that |
54310121 | 2148 | may help you in this, but it's nontrivial.) SCALAR will be read and/or |
4633a7c4 | 2149 | written depending on the FUNCTION--a pointer to the string value of SCALAR |
19799a22 | 2150 | will be passed as the third argument of the actual C<ioctl> call. (If SCALAR |
4633a7c4 LW |
2151 | has no string value but does have a numeric value, that value will be |
2152 | passed rather than a pointer to the string value. To guarantee this to be | |
19799a22 GS |
2153 | true, add a C<0> to the scalar before using it.) The C<pack> and C<unpack> |
2154 | functions may be needed to manipulate the values of structures used by | |
2155 | C<ioctl>. | |
a0d0e21e | 2156 | |
19799a22 | 2157 | The return value of C<ioctl> (and C<fcntl>) is as follows: |
a0d0e21e LW |
2158 | |
2159 | if OS returns: then Perl returns: | |
2160 | -1 undefined value | |
2161 | 0 string "0 but true" | |
2162 | anything else that number | |
2163 | ||
19799a22 | 2164 | Thus Perl returns true on success and false on failure, yet you can |
a0d0e21e LW |
2165 | still easily determine the actual value returned by the operating |
2166 | system: | |
2167 | ||
2b5ab1e7 | 2168 | $retval = ioctl(...) || -1; |
a0d0e21e LW |
2169 | printf "System returned %d\n", $retval; |
2170 | ||
c2611fb3 | 2171 | The special string "C<0> but true" is exempt from B<-w> complaints |
5a964f20 TC |
2172 | about improper numeric conversions. |
2173 | ||
19799a22 GS |
2174 | Here's an example of setting a filehandle named C<REMOTE> to be |
2175 | non-blocking at the system level. You'll have to negotiate C<$|> | |
2176 | on your own, though. | |
2177 | ||
2178 | use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK); | |
2179 | ||
2180 | $flags = fcntl(REMOTE, F_GETFL, 0) | |
2181 | or die "Can't get flags for the socket: $!\n"; | |
2182 | ||
2183 | $flags = fcntl(REMOTE, F_SETFL, $flags | O_NONBLOCK) | |
2184 | or die "Can't set flags for the socket: $!\n"; | |
2185 | ||
a0d0e21e LW |
2186 | =item join EXPR,LIST |
2187 | ||
2b5ab1e7 TC |
2188 | Joins the separate strings of LIST into a single string with fields |
2189 | separated by the value of EXPR, and returns that new string. Example: | |
a0d0e21e | 2190 | |
2b5ab1e7 | 2191 | $rec = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell); |
a0d0e21e | 2192 | |
eb6e2d6f GS |
2193 | Beware that unlike C<split>, C<join> doesn't take a pattern as its |
2194 | first argument. Compare L</split>. | |
a0d0e21e | 2195 | |
aa689395 | 2196 | =item keys HASH |
2197 | ||
19799a22 | 2198 | Returns a list consisting of all the keys of the named hash. (In |
1d2dff63 | 2199 | scalar context, returns the number of keys.) The keys are returned in |
ab192400 GS |
2200 | an apparently random order. The actual random order is subject to |
2201 | change in future versions of perl, but it is guaranteed to be the same | |
19799a22 | 2202 | order as either the C<values> or C<each> function produces (given |
ab192400 GS |
2203 | that the hash has not been modified). As a side effect, it resets |
2204 | HASH's iterator. | |
a0d0e21e | 2205 | |
aa689395 | 2206 | Here is yet another way to print your environment: |
a0d0e21e LW |
2207 | |
2208 | @keys = keys %ENV; | |
2209 | @values = values %ENV; | |
19799a22 | 2210 | while (@keys) { |
a0d0e21e LW |
2211 | print pop(@keys), '=', pop(@values), "\n"; |
2212 | } | |
2213 | ||
2214 | or how about sorted by key: | |
2215 | ||
2216 | foreach $key (sort(keys %ENV)) { | |
2217 | print $key, '=', $ENV{$key}, "\n"; | |
2218 | } | |
2219 | ||
8ea1e5d4 GS |
2220 | The returned values are copies of the original keys in the hash, so |
2221 | modifying them will not affect the original hash. Compare L</values>. | |
2222 | ||
19799a22 | 2223 | To sort a hash by value, you'll need to use a C<sort> function. |
aa689395 | 2224 | Here's a descending numeric sort of a hash by its values: |
4633a7c4 | 2225 | |
5a964f20 | 2226 | foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash) { |
4633a7c4 LW |
2227 | printf "%4d %s\n", $hash{$key}, $key; |
2228 | } | |
2229 | ||
19799a22 | 2230 | As an lvalue C<keys> allows you to increase the number of hash buckets |
aa689395 | 2231 | allocated for the given hash. This can gain you a measure of efficiency if |
2232 | you know the hash is going to get big. (This is similar to pre-extending | |
2233 | an array by assigning a larger number to $#array.) If you say | |
55497cff | 2234 | |
2235 | keys %hash = 200; | |
2236 | ||
ab192400 GS |
2237 | then C<%hash> will have at least 200 buckets allocated for it--256 of them, |
2238 | in fact, since it rounds up to the next power of two. These | |
55497cff | 2239 | buckets will be retained even if you do C<%hash = ()>, use C<undef |
2240 | %hash> if you want to free the storage while C<%hash> is still in scope. | |
2241 | You can't shrink the number of buckets allocated for the hash using | |
19799a22 | 2242 | C<keys> in this way (but you needn't worry about doing this by accident, |
55497cff | 2243 | as trying has no effect). |
2244 | ||
19799a22 | 2245 | See also C<each>, C<values> and C<sort>. |
ab192400 | 2246 | |
b350dd2f | 2247 | =item kill SIGNAL, LIST |
a0d0e21e | 2248 | |
b350dd2f | 2249 | Sends a signal to a list of processes. Returns the number of |
517db077 GS |
2250 | processes successfully signaled (which is not necessarily the |
2251 | same as the number actually killed). | |
a0d0e21e LW |
2252 | |
2253 | $cnt = kill 1, $child1, $child2; | |
2254 | kill 9, @goners; | |
2255 | ||
b350dd2f GS |
2256 | If SIGNAL is zero, no signal is sent to the process. This is a |
2257 | useful way to check that the process is alive and hasn't changed | |
2258 | its UID. See L<perlport> for notes on the portability of this | |
2259 | construct. | |
2260 | ||
2261 | Unlike in the shell, if SIGNAL is negative, it kills | |
4633a7c4 LW |
2262 | process groups instead of processes. (On System V, a negative I<PROCESS> |
2263 | number will also kill process groups, but that's not portable.) That | |
2264 | means you usually want to use positive not negative signals. You may also | |
da0045b7 | 2265 | use a signal name in quotes. See L<perlipc/"Signals"> for details. |
a0d0e21e LW |
2266 | |
2267 | =item last LABEL | |
2268 | ||
2269 | =item last | |
2270 | ||
2271 | The C<last> command is like the C<break> statement in C (as used in | |
2272 | loops); it immediately exits the loop in question. If the LABEL is | |
2273 | omitted, the command refers to the innermost enclosing loop. The | |
2274 | C<continue> block, if any, is not executed: | |
2275 | ||
4633a7c4 LW |
2276 | LINE: while (<STDIN>) { |
2277 | last LINE if /^$/; # exit when done with header | |
5a964f20 | 2278 | #... |
a0d0e21e LW |
2279 | } |
2280 | ||
4968c1e4 | 2281 | C<last> cannot be used to exit a block which returns a value such as |
2b5ab1e7 TC |
2282 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
2283 | a grep() or map() operation. | |
4968c1e4 | 2284 | |
6c1372ed GS |
2285 | Note that a block by itself is semantically identical to a loop |
2286 | that executes once. Thus C<last> can be used to effect an early | |
2287 | exit out of such a block. | |
2288 | ||
98293880 JH |
2289 | See also L</continue> for an illustration of how C<last>, C<next>, and |
2290 | C<redo> work. | |
1d2dff63 | 2291 | |
a0d0e21e LW |
2292 | =item lc EXPR |
2293 | ||
54310121 | 2294 | =item lc |
bbce6d69 | 2295 | |
a0d0e21e | 2296 | Returns an lowercased version of EXPR. This is the internal function |
7660c0ab | 2297 | implementing the C<\L> escape in double-quoted strings. |
19799a22 GS |
2298 | Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale> |
2299 | and L<utf8>. | |
a0d0e21e | 2300 | |
7660c0ab | 2301 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 2302 | |
a0d0e21e LW |
2303 | =item lcfirst EXPR |
2304 | ||
54310121 | 2305 | =item lcfirst |
bbce6d69 | 2306 | |
a0d0e21e | 2307 | Returns the value of EXPR with the first character lowercased. This is |
7660c0ab | 2308 | the internal function implementing the C<\l> escape in double-quoted strings. |
a0ed51b3 | 2309 | Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>. |
a0d0e21e | 2310 | |
7660c0ab | 2311 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 2312 | |
a0d0e21e LW |
2313 | =item length EXPR |
2314 | ||
54310121 | 2315 | =item length |
bbce6d69 | 2316 | |
a0ed51b3 | 2317 | Returns the length in characters of the value of EXPR. If EXPR is |
2b5ab1e7 TC |
2318 | omitted, returns length of C<$_>. Note that this cannot be used on |
2319 | an entire array or hash to find out how many elements these have. | |
2320 | For that, use C<scalar @array> and C<scalar keys %hash> respectively. | |
a0d0e21e LW |
2321 | |
2322 | =item link OLDFILE,NEWFILE | |
2323 | ||
19799a22 GS |
2324 | Creates a new filename linked to the old filename. Returns true for |
2325 | success, false otherwise. | |
a0d0e21e LW |
2326 | |
2327 | =item listen SOCKET,QUEUESIZE | |
2328 | ||
19799a22 GS |
2329 | Does the same thing that the listen system call does. Returns true if |
2330 | it succeeded, false otherwise. See the example in L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e LW |
2331 | |
2332 | =item local EXPR | |
2333 | ||
19799a22 | 2334 | You really probably want to be using C<my> instead, because C<local> isn't |
2b5ab1e7 TC |
2335 | what most people think of as "local". See L<perlsub/"Private Variables |
2336 | via my()"> for details. | |
2337 | ||
5a964f20 TC |
2338 | A local modifies the listed variables to be local to the enclosing |
2339 | block, file, or eval. If more than one value is listed, the list must | |
2340 | be placed in parentheses. See L<perlsub/"Temporary Values via local()"> | |
2341 | for details, including issues with tied arrays and hashes. | |
a0d0e21e | 2342 | |
a0d0e21e LW |
2343 | =item localtime EXPR |
2344 | ||
19799a22 | 2345 | Converts a time as returned by the time function to a 9-element list |
5f05dabc | 2346 | with the time analyzed for the local time zone. Typically used as |
a0d0e21e LW |
2347 | follows: |
2348 | ||
54310121 | 2349 | # 0 1 2 3 4 5 6 7 8 |
a0d0e21e LW |
2350 | ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = |
2351 | localtime(time); | |
2352 | ||
48a26b3a GS |
2353 | All list elements are numeric, and come straight out of the C `struct |
2354 | tm'. $sec, $min, and $hour are the seconds, minutes, and hours of the | |
2355 | specified time. $mday is the day of the month, and $mon is the month | |
2356 | itself, in the range C<0..11> with 0 indicating January and 11 | |
2357 | indicating December. $year is the number of years since 1900. That | |
2358 | is, $year is C<123> in year 2023. $wday is the day of the week, with | |
2359 | 0 indicating Sunday and 3 indicating Wednesday. $yday is the day of | |
874b1813 | 2360 | the year, in the range C<0..364> (or C<0..365> in leap years.) $isdst |
48a26b3a GS |
2361 | is true if the specified time occurs during daylight savings time, |
2362 | false otherwise. | |
2363 | ||
2364 | Note that the $year element is I<not> simply the last two digits of | |
2365 | the year. If you assume it is, then you create non-Y2K-compliant | |
2366 | programs--and you wouldn't want to do that, would you? | |
54310121 | 2367 | |
abd75f24 GS |
2368 | The proper way to get a complete 4-digit year is simply: |
2369 | ||
2370 | $year += 1900; | |
2371 | ||
2372 | And to get the last two digits of the year (e.g., '01' in 2001) do: | |
2373 | ||
2374 | $year = sprintf("%02d", $year % 100); | |
2375 | ||
48a26b3a | 2376 | If EXPR is omitted, C<localtime()> uses the current time (C<localtime(time)>). |
a0d0e21e | 2377 | |
48a26b3a | 2378 | In scalar context, C<localtime()> returns the ctime(3) value: |
a0d0e21e | 2379 | |
5f05dabc | 2380 | $now_string = localtime; # e.g., "Thu Oct 13 04:54:34 1994" |
a0d0e21e | 2381 | |
a3cb178b | 2382 | This scalar value is B<not> locale dependent, see L<perllocale>, but |
68f8bed4 JH |
2383 | instead a Perl builtin. Also see the C<Time::Local> module |
2384 | (to convert the second, minutes, hours, ... back to seconds since the | |
2385 | stroke of midnight the 1st of January 1970, the value returned by | |
ca6e1c26 | 2386 | time()), and the strftime(3) and mktime(3) functions available via the |
68f8bed4 JH |
2387 | POSIX module. To get somewhat similar but locale dependent date |
2388 | strings, set up your locale environment variables appropriately | |
2389 | (please see L<perllocale>) and try for example: | |
a3cb178b | 2390 | |
5a964f20 | 2391 | use POSIX qw(strftime); |
2b5ab1e7 | 2392 | $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime; |
a3cb178b GS |
2393 | |
2394 | Note that the C<%a> and C<%b>, the short forms of the day of the week | |
2395 | and the month of the year, may not necessarily be three characters wide. | |
a0d0e21e | 2396 | |
19799a22 GS |
2397 | =item lock |
2398 | ||
2399 | lock I<THING> | |
2400 | ||
2401 | This function places an advisory lock on a variable, subroutine, | |
2402 | or referenced object contained in I<THING> until the lock goes out | |
2403 | of scope. This is a built-in function only if your version of Perl | |
2404 | was built with threading enabled, and if you've said C<use Threads>. | |
2405 | Otherwise a user-defined function by this name will be called. See | |
2406 | L<Thread>. | |
2407 | ||
a0d0e21e LW |
2408 | =item log EXPR |
2409 | ||
54310121 | 2410 | =item log |
bbce6d69 | 2411 | |
2b5ab1e7 TC |
2412 | Returns the natural logarithm (base I<e>) of EXPR. If EXPR is omitted, |
2413 | returns log of C<$_>. To get the log of another base, use basic algebra: | |
19799a22 | 2414 | The base-N log of a number is equal to the natural log of that number |
2b5ab1e7 TC |
2415 | divided by the natural log of N. For example: |
2416 | ||
2417 | sub log10 { | |
2418 | my $n = shift; | |
2419 | return log($n)/log(10); | |
2420 | } | |
2421 | ||
2422 | See also L</exp> for the inverse operation. | |
a0d0e21e LW |
2423 | |
2424 | =item lstat FILEHANDLE | |
2425 | ||
2426 | =item lstat EXPR | |
2427 | ||
54310121 | 2428 | =item lstat |
bbce6d69 | 2429 | |
19799a22 | 2430 | Does the same thing as the C<stat> function (including setting the |
5a964f20 TC |
2431 | special C<_> filehandle) but stats a symbolic link instead of the file |
2432 | the symbolic link points to. If symbolic links are unimplemented on | |
19799a22 | 2433 | your system, a normal C<stat> is done. |
a0d0e21e | 2434 | |
7660c0ab | 2435 | If EXPR is omitted, stats C<$_>. |
bbce6d69 | 2436 | |
a0d0e21e LW |
2437 | =item m// |
2438 | ||
2439 | The match operator. See L<perlop>. | |
2440 | ||
2441 | =item map BLOCK LIST | |
2442 | ||
2443 | =item map EXPR,LIST | |
2444 | ||
19799a22 GS |
2445 | Evaluates the BLOCK or EXPR for each element of LIST (locally setting |
2446 | C<$_> to each element) and returns the list value composed of the | |
2447 | results of each such evaluation. In scalar context, returns the | |
2448 | total number of elements so generated. Evaluates BLOCK or EXPR in | |
2449 | list context, so each element of LIST may produce zero, one, or | |
2450 | more elements in the returned value. | |
dd99ebda | 2451 | |
a0d0e21e LW |
2452 | @chars = map(chr, @nums); |
2453 | ||
2454 | translates a list of numbers to the corresponding characters. And | |
2455 | ||
4633a7c4 | 2456 | %hash = map { getkey($_) => $_ } @array; |
a0d0e21e LW |
2457 | |
2458 | is just a funny way to write | |
2459 | ||
2460 | %hash = (); | |
2461 | foreach $_ (@array) { | |
4633a7c4 | 2462 | $hash{getkey($_)} = $_; |
a0d0e21e LW |
2463 | } |
2464 | ||
2b5ab1e7 TC |
2465 | Note that, because C<$_> is a reference into the list value, it can |
2466 | be used to modify the elements of the array. While this is useful and | |
2467 | supported, it can cause bizarre results if the LIST is not a named array. | |
2468 | Using a regular C<foreach> loop for this purpose would be clearer in | |
2469 | most cases. See also L</grep> for an array composed of those items of | |
2470 | the original list for which the BLOCK or EXPR evaluates to true. | |
fb73857a | 2471 | |
19799a22 | 2472 | =item mkdir FILENAME,MASK |
a0d0e21e | 2473 | |
5a211162 GS |
2474 | =item mkdir FILENAME |
2475 | ||
0591cd52 | 2476 | Creates the directory specified by FILENAME, with permissions |
19799a22 GS |
2477 | specified by MASK (as modified by C<umask>). If it succeeds it |
2478 | returns true, otherwise it returns false and sets C<$!> (errno). | |
5a211162 | 2479 | If omitted, MASK defaults to 0777. |
0591cd52 | 2480 | |
19799a22 | 2481 | In general, it is better to create directories with permissive MASK, |
0591cd52 | 2482 | and let the user modify that with their C<umask>, than it is to supply |
19799a22 | 2483 | a restrictive MASK and give the user no way to be more permissive. |
0591cd52 NT |
2484 | The exceptions to this rule are when the file or directory should be |
2485 | kept private (mail files, for instance). The perlfunc(1) entry on | |
19799a22 | 2486 | C<umask> discusses the choice of MASK in more detail. |
a0d0e21e LW |
2487 | |
2488 | =item msgctl ID,CMD,ARG | |
2489 | ||
f86cebdf | 2490 | Calls the System V IPC function msgctl(2). You'll probably have to say |
0ade1984 JH |
2491 | |
2492 | use IPC::SysV; | |
2493 | ||
7660c0ab A |
2494 | first to get the correct constant definitions. If CMD is C<IPC_STAT>, |
2495 | then ARG must be a variable which will hold the returned C<msqid_ds> | |
951ba7fe GS |
2496 | structure. Returns like C<ioctl>: the undefined value for error, |
2497 | C<"0 but true"> for zero, or the actual return value otherwise. See also | |
19799a22 | 2498 | C<IPC::SysV> and C<IPC::Semaphore> documentation. |
a0d0e21e LW |
2499 | |
2500 | =item msgget KEY,FLAGS | |
2501 | ||
f86cebdf | 2502 | Calls the System V IPC function msgget(2). Returns the message queue |
7660c0ab | 2503 | id, or the undefined value if there is an error. See also C<IPC::SysV> |
19799a22 | 2504 | and C<IPC::Msg> documentation. |
a0d0e21e | 2505 | |
a0d0e21e LW |
2506 | =item msgrcv ID,VAR,SIZE,TYPE,FLAGS |
2507 | ||
2508 | Calls the System V IPC function msgrcv to receive a message from | |
2509 | message queue ID into variable VAR with a maximum message size of | |
41d6edb2 JH |
2510 | SIZE. Note that when a message is received, the message type as a |
2511 | native long integer will be the first thing in VAR, followed by the | |
2512 | actual message. This packing may be opened with C<unpack("l! a*")>. | |
2513 | Taints the variable. Returns true if successful, or false if there is | |
2514 | an error. See also C<IPC::SysV> and C<IPC::SysV::Msg> documentation. | |
2515 | ||
2516 | =item msgsnd ID,MSG,FLAGS | |
2517 | ||
2518 | Calls the System V IPC function msgsnd to send the message MSG to the | |
2519 | message queue ID. MSG must begin with the native long integer message | |
2520 | type, and be followed by the length of the actual message, and finally | |
2521 | the message itself. This kind of packing can be achieved with | |
2522 | C<pack("l! a*", $type, $message)>. Returns true if successful, | |
2523 | or false if there is an error. See also C<IPC::SysV> | |
2524 | and C<IPC::SysV::Msg> documentation. | |
a0d0e21e LW |
2525 | |
2526 | =item my EXPR | |
2527 | ||
09bef843 SB |
2528 | =item my EXPR : ATTRIBUTES |
2529 | ||
19799a22 GS |
2530 | A C<my> declares the listed variables to be local (lexically) to the |
2531 | enclosing block, file, or C<eval>. If | |
5f05dabc | 2532 | more than one value is listed, the list must be placed in parentheses. See |
cb1a09d0 | 2533 | L<perlsub/"Private Variables via my()"> for details. |
4633a7c4 | 2534 | |
a0d0e21e LW |
2535 | =item next LABEL |
2536 | ||
2537 | =item next | |
2538 | ||
2539 | The C<next> command is like the C<continue> statement in C; it starts | |
2540 | the next iteration of the loop: | |
2541 | ||
4633a7c4 LW |
2542 | LINE: while (<STDIN>) { |
2543 | next LINE if /^#/; # discard comments | |
5a964f20 | 2544 | #... |
a0d0e21e LW |
2545 | } |
2546 | ||
2547 | Note that if there were a C<continue> block on the above, it would get | |
2548 | executed even on discarded lines. If the LABEL is omitted, the command | |
2549 | refers to the innermost enclosing loop. | |
2550 | ||
4968c1e4 | 2551 | C<next> cannot be used to exit a block which returns a value such as |
2b5ab1e7 TC |
2552 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
2553 | a grep() or map() operation. | |
4968c1e4 | 2554 | |
6c1372ed GS |
2555 | Note that a block by itself is semantically identical to a loop |
2556 | that executes once. Thus C<next> will exit such a block early. | |
2557 | ||
98293880 JH |
2558 | See also L</continue> for an illustration of how C<last>, C<next>, and |
2559 | C<redo> work. | |
1d2dff63 | 2560 | |
a0d0e21e LW |
2561 | =item no Module LIST |
2562 | ||
7660c0ab | 2563 | See the L</use> function, which C<no> is the opposite of. |
a0d0e21e LW |
2564 | |
2565 | =item oct EXPR | |
2566 | ||
54310121 | 2567 | =item oct |
bbce6d69 | 2568 | |
4633a7c4 | 2569 | Interprets EXPR as an octal string and returns the corresponding |
4f19785b WSI |
2570 | value. (If EXPR happens to start off with C<0x>, interprets it as a |
2571 | hex string. If EXPR starts off with C<0b>, it is interpreted as a | |
2572 | binary string.) The following will handle decimal, binary, octal, and | |
4633a7c4 | 2573 | hex in the standard Perl or C notation: |
a0d0e21e LW |
2574 | |
2575 | $val = oct($val) if $val =~ /^0/; | |
2576 | ||
19799a22 GS |
2577 | If EXPR is omitted, uses C<$_>. To go the other way (produce a number |
2578 | in octal), use sprintf() or printf(): | |
2579 | ||
2580 | $perms = (stat("filename"))[2] & 07777; | |
2581 | $oct_perms = sprintf "%lo", $perms; | |
2582 | ||
2583 | The oct() function is commonly used when a string such as C<644> needs | |
2584 | to be converted into a file mode, for example. (Although perl will | |
2585 | automatically convert strings into numbers as needed, this automatic | |
2586 | conversion assumes base 10.) | |
a0d0e21e | 2587 | |
1c1fc3ea | 2588 | =item open FILEHANDLE,MODE,LIST |
6170680b | 2589 | |
a0d0e21e LW |
2590 | =item open FILEHANDLE,EXPR |
2591 | ||
2592 | =item open FILEHANDLE | |
2593 | ||
2594 | Opens the file whose filename is given by EXPR, and associates it with | |
5f05dabc | 2595 | FILEHANDLE. If FILEHANDLE is an expression, its value is used as the |
d6fd2b02 GS |
2596 | name of the real filehandle wanted. (This is considered a symbolic |
2597 | reference, so C<use strict 'refs'> should I<not> be in effect.) | |
2598 | ||
2599 | If EXPR is omitted, the scalar | |
5f05dabc | 2600 | variable of the same name as the FILEHANDLE contains the filename. |
19799a22 GS |
2601 | (Note that lexical variables--those declared with C<my>--will not work |
2602 | for this purpose; so if you're using C<my>, specify EXPR in your call | |
2b5ab1e7 TC |
2603 | to open.) See L<perlopentut> for a kinder, gentler explanation of opening |
2604 | files. | |
5f05dabc | 2605 | |
61eff3bc JH |
2606 | If MODE is C<< '<' >> or nothing, the file is opened for input. |
2607 | If MODE is C<< '>' >>, the file is truncated and opened for | |
2608 | output, being created if necessary. If MODE is C<<< '>>' >>>, | |
fbb426e4 | 2609 | the file is opened for appending, again being created if necessary. |
61eff3bc JH |
2610 | You can put a C<'+'> in front of the C<< '>' >> or C<< '<' >> to indicate that |
2611 | you want both read and write access to the file; thus C<< '+<' >> is almost | |
2612 | always preferred for read/write updates--the C<< '+>' >> mode would clobber the | |
5a964f20 TC |
2613 | file first. You can't usually use either read-write mode for updating |
2614 | textfiles, since they have variable length records. See the B<-i> | |
0591cd52 NT |
2615 | switch in L<perlrun> for a better approach. The file is created with |
2616 | permissions of C<0666> modified by the process' C<umask> value. | |
5a964f20 | 2617 | |
61eff3bc JH |
2618 | These various prefixes correspond to the fopen(3) modes of C<'r'>, C<'r+'>, |
2619 | C<'w'>, C<'w+'>, C<'a'>, and C<'a+'>. | |
5f05dabc | 2620 | |
6170680b IZ |
2621 | In the 2-arguments (and 1-argument) form of the call the mode and |
2622 | filename should be concatenated (in this order), possibly separated by | |
61eff3bc | 2623 | spaces. It is possible to omit the mode if the mode is C<< '<' >>. |
6170680b | 2624 | |
7660c0ab | 2625 | If the filename begins with C<'|'>, the filename is interpreted as a |
5a964f20 | 2626 | command to which output is to be piped, and if the filename ends with a |
f244e06d GS |
2627 | C<'|'>, the filename is interpreted as a command which pipes output to |
2628 | us. See L<perlipc/"Using open() for IPC"> | |
19799a22 | 2629 | for more examples of this. (You are not allowed to C<open> to a command |
5a964f20 | 2630 | that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>, |
4a4eefd0 GS |
2631 | and L<perlipc/"Bidirectional Communication with Another Process"> |
2632 | for alternatives.) | |
cb1a09d0 | 2633 | |
6170680b IZ |
2634 | If MODE is C<'|-'>, the filename is interpreted as a |
2635 | command to which output is to be piped, and if MODE is | |
2636 | C<'-|'>, the filename is interpreted as a command which pipes output to | |
2637 | us. In the 2-arguments (and 1-argument) form one should replace dash | |
2638 | (C<'-'>) with the command. See L<perlipc/"Using open() for IPC"> | |
2639 | for more examples of this. (You are not allowed to C<open> to a command | |
2640 | that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>, | |
2641 | and L<perlipc/"Bidirectional Communication"> for alternatives.) | |
2642 | ||
2643 | In the 2-arguments (and 1-argument) form opening C<'-'> opens STDIN | |
61eff3bc | 2644 | and opening C<< '>-' >> opens STDOUT. |
6170680b IZ |
2645 | |
2646 | Open returns | |
19799a22 | 2647 | nonzero upon success, the undefined value otherwise. If the C<open> |
4633a7c4 | 2648 | involved a pipe, the return value happens to be the pid of the |
54310121 | 2649 | subprocess. |
cb1a09d0 AD |
2650 | |
2651 | If you're unfortunate enough to be running Perl on a system that | |
2652 | distinguishes between text files and binary files (modern operating | |
2653 | systems don't care), then you should check out L</binmode> for tips for | |
19799a22 | 2654 | dealing with this. The key distinction between systems that need C<binmode> |
5a964f20 TC |
2655 | and those that don't is their text file formats. Systems like Unix, MacOS, and |
2656 | Plan9, which delimit lines with a single character, and which encode that | |
19799a22 | 2657 | character in C as C<"\n">, do not need C<binmode>. The rest need it. |
cb1a09d0 | 2658 | |
fb73857a | 2659 | When opening a file, it's usually a bad idea to continue normal execution |
19799a22 GS |
2660 | if the request failed, so C<open> is frequently used in connection with |
2661 | C<die>. Even if C<die> won't do what you want (say, in a CGI script, | |
fb73857a | 2662 | where you want to make a nicely formatted error message (but there are |
5a964f20 | 2663 | modules that can help with that problem)) you should always check |
19799a22 | 2664 | the return value from opening a file. The infrequent exception is when |
fb73857a | 2665 | working with an unopened filehandle is actually what you want to do. |
2666 | ||
cb1a09d0 | 2667 | Examples: |
a0d0e21e LW |
2668 | |
2669 | $ARTICLE = 100; | |
2670 | open ARTICLE or die "Can't find article $ARTICLE: $!\n"; | |
2671 | while (<ARTICLE>) {... | |
2672 | ||
6170680b | 2673 | open(LOG, '>>/usr/spool/news/twitlog'); # (log is reserved) |
fb73857a | 2674 | # if the open fails, output is discarded |
a0d0e21e | 2675 | |
6170680b | 2676 | open(DBASE, '+<', 'dbase.mine') # open for update |
fb73857a | 2677 | or die "Can't open 'dbase.mine' for update: $!"; |
cb1a09d0 | 2678 | |
6170680b IZ |
2679 | open(DBASE, '+<dbase.mine') # ditto |
2680 | or die "Can't open 'dbase.mine' for update: $!"; | |
2681 | ||
2682 | open(ARTICLE, '-|', "caesar <$article") # decrypt article | |
fb73857a | 2683 | or die "Can't start caesar: $!"; |
a0d0e21e | 2684 | |
6170680b IZ |
2685 | open(ARTICLE, "caesar <$article |") # ditto |
2686 | or die "Can't start caesar: $!"; | |
2687 | ||
2688 | open(EXTRACT, "|sort >/tmp/Tmp$$") # $$ is our process id | |
fb73857a | 2689 | or die "Can't start sort: $!"; |
a0d0e21e LW |
2690 | |
2691 | # process argument list of files along with any includes | |
2692 | ||
2693 | foreach $file (@ARGV) { | |
2694 | process($file, 'fh00'); | |
2695 | } | |
2696 | ||
2697 | sub process { | |
5a964f20 | 2698 | my($filename, $input) = @_; |
a0d0e21e LW |
2699 | $input++; # this is a string increment |
2700 | unless (open($input, $filename)) { | |
2701 | print STDERR "Can't open $filename: $!\n"; | |
2702 | return; | |
2703 | } | |
2704 | ||
5a964f20 | 2705 | local $_; |
a0d0e21e LW |
2706 | while (<$input>) { # note use of indirection |
2707 | if (/^#include "(.*)"/) { | |
2708 | process($1, $input); | |
2709 | next; | |
2710 | } | |
5a964f20 | 2711 | #... # whatever |
a0d0e21e LW |
2712 | } |
2713 | } | |
2714 | ||
2715 | You may also, in the Bourne shell tradition, specify an EXPR beginning | |
61eff3bc | 2716 | with C<< '>&' >>, in which case the rest of the string is interpreted as the |
5a964f20 | 2717 | name of a filehandle (or file descriptor, if numeric) to be |
61eff3bc JH |
2718 | duped and opened. You may use C<&> after C<< > >>, C<<< >> >>>, |
2719 | C<< < >>, C<< +> >>, C<<< +>> >>>, and C<< +< >>. The | |
a0d0e21e | 2720 | mode you specify should match the mode of the original filehandle. |
184e9718 | 2721 | (Duping a filehandle does not take into account any existing contents of |
6170680b IZ |
2722 | stdio buffers.) Duping file handles is not yet supported for 3-argument |
2723 | open(). | |
2724 | ||
a0d0e21e LW |
2725 | Here is a script that saves, redirects, and restores STDOUT and |
2726 | STDERR: | |
2727 | ||
2728 | #!/usr/bin/perl | |
5a964f20 TC |
2729 | open(OLDOUT, ">&STDOUT"); |
2730 | open(OLDERR, ">&STDERR"); | |
a0d0e21e | 2731 | |
6170680b IZ |
2732 | open(STDOUT, '>', "foo.out") || die "Can't redirect stdout"; |
2733 | open(STDERR, ">&STDOUT") || die "Can't dup stdout"; | |
a0d0e21e LW |
2734 | |
2735 | select(STDERR); $| = 1; # make unbuffered | |
2736 | select(STDOUT); $| = 1; # make unbuffered | |
2737 | ||
2738 | print STDOUT "stdout 1\n"; # this works for | |
2739 | print STDERR "stderr 1\n"; # subprocesses too | |
2740 | ||
2741 | close(STDOUT); | |
2742 | close(STDERR); | |
2743 | ||
5a964f20 TC |
2744 | open(STDOUT, ">&OLDOUT"); |
2745 | open(STDERR, ">&OLDERR"); | |
a0d0e21e LW |
2746 | |
2747 | print STDOUT "stdout 2\n"; | |
2748 | print STDERR "stderr 2\n"; | |
2749 | ||
61eff3bc | 2750 | If you specify C<< '<&=N' >>, where C<N> is a number, then Perl will do an |
19799a22 | 2751 | equivalent of C's C<fdopen> of that file descriptor; this is more |
4633a7c4 | 2752 | parsimonious of file descriptors. For example: |
a0d0e21e LW |
2753 | |
2754 | open(FILEHANDLE, "<&=$fd") | |
2755 | ||
4af147f6 CS |
2756 | Note that this feature depends on the fdopen() C library function. |
2757 | On many UNIX systems, fdopen() is known to fail when file descriptors | |
2758 | exceed a certain value, typically 255. If you need more file | |
2759 | descriptors than that, consider rebuilding Perl to use the C<sfio> | |
2760 | library. | |
2761 | ||
6170680b IZ |
2762 | If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'> |
2763 | with 2-arguments (or 1-argument) form of open(), then | |
a0d0e21e | 2764 | there is an implicit fork done, and the return value of open is the pid |
7660c0ab | 2765 | of the child within the parent process, and C<0> within the child |
184e9718 | 2766 | process. (Use C<defined($pid)> to determine whether the open was successful.) |
a0d0e21e LW |
2767 | The filehandle behaves normally for the parent, but i/o to that |
2768 | filehandle is piped from/to the STDOUT/STDIN of the child process. | |
2769 | In the child process the filehandle isn't opened--i/o happens from/to | |
2770 | the new STDOUT or STDIN. Typically this is used like the normal | |
2771 | piped open when you want to exercise more control over just how the | |
2772 | pipe command gets executed, such as when you are running setuid, and | |
54310121 | 2773 | don't want to have to scan shell commands for metacharacters. |
6170680b | 2774 | The following triples are more or less equivalent: |
a0d0e21e LW |
2775 | |
2776 | open(FOO, "|tr '[a-z]' '[A-Z]'"); | |
6170680b IZ |
2777 | open(FOO, '|-', "tr '[a-z]' '[A-Z]'"); |
2778 | open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]'; | |
a0d0e21e LW |
2779 | |
2780 | open(FOO, "cat -n '$file'|"); | |
6170680b IZ |
2781 | open(FOO, '-|', "cat -n '$file'"); |
2782 | open(FOO, '-|') || exec 'cat', '-n', $file; | |
a0d0e21e | 2783 | |
4633a7c4 LW |
2784 | See L<perlipc/"Safe Pipe Opens"> for more examples of this. |
2785 | ||
0f897271 GS |
2786 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
2787 | output before any operation that may do a fork, but this may not be | |
2788 | supported on some platforms (see L<perlport>). To be safe, you may need | |
2789 | to set C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method | |
2790 | of C<IO::Handle> on any open handles. | |
2791 | ||
2792 | On systems that support a | |
45bc9206 GS |
2793 | close-on-exec flag on files, the flag will be set for the newly opened |
2794 | file descriptor as determined by the value of $^F. See L<perlvar/$^F>. | |
a0d0e21e | 2795 | |
0dccf244 CS |
2796 | Closing any piped filehandle causes the parent process to wait for the |
2797 | child to finish, and returns the status value in C<$?>. | |
2798 | ||
6170680b IZ |
2799 | The filename passed to 2-argument (or 1-argument) form of open() |
2800 | will have leading and trailing | |
f86cebdf | 2801 | whitespace deleted, and the normal redirection characters |
5a964f20 TC |
2802 | honored. This property, known as "magic open", |
2803 | can often be used to good effect. A user could specify a filename of | |
7660c0ab | 2804 | F<"rsh cat file |">, or you could change certain filenames as needed: |
5a964f20 TC |
2805 | |
2806 | $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/; | |
2807 | open(FH, $filename) or die "Can't open $filename: $!"; | |
2808 | ||
6170680b IZ |
2809 | Use 3-argument form to open a file with arbitrary weird characters in it, |
2810 | ||
2811 | open(FOO, '<', $file); | |
2812 | ||
2813 | otherwise it's necessary to protect any leading and trailing whitespace: | |
5a964f20 TC |
2814 | |
2815 | $file =~ s#^(\s)#./$1#; | |
2816 | open(FOO, "< $file\0"); | |
2817 | ||
6170680b | 2818 | (this may not work on some bizzare filesystems). One should |
106325ad | 2819 | conscientiously choose between the I<magic> and 3-arguments form |
6170680b IZ |
2820 | of open(): |
2821 | ||
2822 | open IN, $ARGV[0]; | |
2823 | ||
2824 | will allow the user to specify an argument of the form C<"rsh cat file |">, | |
2825 | but will not work on a filename which happens to have a trailing space, while | |
2826 | ||
2827 | open IN, '<', $ARGV[0]; | |
2828 | ||
2829 | will have exactly the opposite restrictions. | |
2830 | ||
19799a22 | 2831 | If you want a "real" C C<open> (see L<open(2)> on your system), then you |
6170680b IZ |
2832 | should use the C<sysopen> function, which involves no such magic (but |
2833 | may use subtly different filemodes than Perl open(), which is mapped | |
2834 | to C fopen()). This is | |
5a964f20 TC |
2835 | another way to protect your filenames from interpretation. For example: |
2836 | ||
2837 | use IO::Handle; | |
2838 | sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL) | |
2839 | or die "sysopen $path: $!"; | |
2840 | $oldfh = select(HANDLE); $| = 1; select($oldfh); | |
2841 | print HANDLE "stuff $$\n"); | |
2842 | seek(HANDLE, 0, 0); | |
2843 | print "File contains: ", <HANDLE>; | |
2844 | ||
7660c0ab A |
2845 | Using the constructor from the C<IO::Handle> package (or one of its |
2846 | subclasses, such as C<IO::File> or C<IO::Socket>), you can generate anonymous | |
5a964f20 TC |
2847 | filehandles that have the scope of whatever variables hold references to |
2848 | them, and automatically close whenever and however you leave that scope: | |
c07a80fd | 2849 | |
5f05dabc | 2850 | use IO::File; |
5a964f20 | 2851 | #... |
c07a80fd | 2852 | sub read_myfile_munged { |
2853 | my $ALL = shift; | |
5f05dabc | 2854 | my $handle = new IO::File; |
c07a80fd | 2855 | open($handle, "myfile") or die "myfile: $!"; |
2856 | $first = <$handle> | |
2857 | or return (); # Automatically closed here. | |
2858 | mung $first or die "mung failed"; # Or here. | |
2859 | return $first, <$handle> if $ALL; # Or here. | |
2860 | $first; # Or here. | |
2861 | } | |
2862 | ||
b687b08b | 2863 | See L</seek> for some details about mixing reading and writing. |
a0d0e21e LW |
2864 | |
2865 | =item opendir DIRHANDLE,EXPR | |
2866 | ||
19799a22 GS |
2867 | Opens a directory named EXPR for processing by C<readdir>, C<telldir>, |
2868 | C<seekdir>, C<rewinddir>, and C<closedir>. Returns true if successful. | |
a0d0e21e LW |
2869 | DIRHANDLEs have their own namespace separate from FILEHANDLEs. |
2870 | ||
2871 | =item ord EXPR | |
2872 | ||
54310121 | 2873 | =item ord |
bbce6d69 | 2874 | |
a0ed51b3 | 2875 | Returns the numeric (ASCII or Unicode) value of the first character of EXPR. If |
7660c0ab | 2876 | EXPR is omitted, uses C<$_>. For the reverse, see L</chr>. |
2b5ab1e7 | 2877 | See L<utf8> for more about Unicode. |
a0d0e21e | 2878 | |
77ca0c92 LW |
2879 | =item our EXPR |
2880 | ||
2881 | An C<our> declares the listed variables to be valid globals within | |
2882 | the enclosing block, file, or C<eval>. That is, it has the same | |
2883 | scoping rules as a "my" declaration, but does not create a local | |
2884 | variable. If more than one value is listed, the list must be placed | |
2885 | in parentheses. The C<our> declaration has no semantic effect unless | |
2886 | "use strict vars" is in effect, in which case it lets you use the | |
2887 | declared global variable without qualifying it with a package name. | |
2888 | (But only within the lexical scope of the C<our> declaration. In this | |
2889 | it differs from "use vars", which is package scoped.) | |
2890 | ||
f472eb5c GS |
2891 | An C<our> declaration declares a global variable that will be visible |
2892 | across its entire lexical scope, even across package boundaries. The | |
2893 | package in which the variable is entered is determined at the point | |
2894 | of the declaration, not at the point of use. This means the following | |
2895 | behavior holds: | |
2896 | ||
2897 | package Foo; | |
2898 | our $bar; # declares $Foo::bar for rest of lexical scope | |
2899 | $bar = 20; | |
2900 | ||
2901 | package Bar; | |
2902 | print $bar; # prints 20 | |
2903 | ||
2904 | Multiple C<our> declarations in the same lexical scope are allowed | |
2905 | if they are in different packages. If they happened to be in the same | |
2906 | package, Perl will emit warnings if you have asked for them. | |
2907 | ||
2908 | use warnings; | |
2909 | package Foo; | |
2910 | our $bar; # declares $Foo::bar for rest of lexical scope | |
2911 | $bar = 20; | |
2912 | ||
2913 | package Bar; | |
2914 | our $bar = 30; # declares $Bar::bar for rest of lexical scope | |
2915 | print $bar; # prints 30 | |
2916 | ||
2917 | our $bar; # emits warning | |
2918 | ||
a0d0e21e LW |
2919 | =item pack TEMPLATE,LIST |
2920 | ||
2b6c5635 GS |
2921 | Takes a LIST of values and converts it into a string using the rules |
2922 | given by the TEMPLATE. The resulting string is the concatenation of | |
2923 | the converted values. Typically, each converted value looks | |
2924 | like its machine-level representation. For example, on 32-bit machines | |
2925 | a converted integer may be represented by a sequence of 4 bytes. | |
2926 | ||
2927 | The TEMPLATE is a | |
a0d0e21e LW |
2928 | sequence of characters that give the order and type of values, as |
2929 | follows: | |
2930 | ||
5a929a98 | 2931 | a A string with arbitrary binary data, will be null padded. |
4375e838 | 2932 | A An ASCII string, will be space padded. |
5a929a98 VU |
2933 | Z A null terminated (asciz) string, will be null padded. |
2934 | ||
2b6c5635 GS |
2935 | b A bit string (ascending bit order inside each byte, like vec()). |
2936 | B A bit string (descending bit order inside each byte). | |
a0d0e21e LW |
2937 | h A hex string (low nybble first). |
2938 | H A hex string (high nybble first). | |
2939 | ||
2940 | c A signed char value. | |
a0ed51b3 | 2941 | C An unsigned char value. Only does bytes. See U for Unicode. |
96e4d5b1 | 2942 | |
a0d0e21e LW |
2943 | s A signed short value. |
2944 | S An unsigned short value. | |
96e4d5b1 | 2945 | (This 'short' is _exactly_ 16 bits, which may differ from |
851646ae JH |
2946 | what a local C compiler calls 'short'. If you want |
2947 | native-length shorts, use the '!' suffix.) | |
96e4d5b1 | 2948 | |
a0d0e21e LW |
2949 | i A signed integer value. |
2950 | I An unsigned integer value. | |
19799a22 | 2951 | (This 'integer' is _at_least_ 32 bits wide. Its exact |
f86cebdf GS |
2952 | size depends on what a local C compiler calls 'int', |
2953 | and may even be larger than the 'long' described in | |
2954 | the next item.) | |
96e4d5b1 | 2955 | |
a0d0e21e LW |
2956 | l A signed long value. |
2957 | L An unsigned long value. | |
96e4d5b1 | 2958 | (This 'long' is _exactly_ 32 bits, which may differ from |
851646ae JH |
2959 | what a local C compiler calls 'long'. If you want |
2960 | native-length longs, use the '!' suffix.) | |
a0d0e21e | 2961 | |
5d11dd56 MG |
2962 | n An unsigned short in "network" (big-endian) order. |
2963 | N An unsigned long in "network" (big-endian) order. | |
2964 | v An unsigned short in "VAX" (little-endian) order. | |
2965 | V An unsigned long in "VAX" (little-endian) order. | |
96e4d5b1 | 2966 | (These 'shorts' and 'longs' are _exactly_ 16 bits and |
2967 | _exactly_ 32 bits, respectively.) | |
a0d0e21e | 2968 | |
dae0da7a JH |
2969 | q A signed quad (64-bit) value. |
2970 | Q An unsigned quad value. | |
851646ae JH |
2971 | (Quads are available only if your system supports 64-bit |
2972 | integer values _and_ if Perl has been compiled to support those. | |
dae0da7a JH |
2973 | Causes a fatal error otherwise.) |
2974 | ||
a0d0e21e LW |
2975 | f A single-precision float in the native format. |
2976 | d A double-precision float in the native format. | |
2977 | ||
2978 | p A pointer to a null-terminated string. | |
2979 | P A pointer to a structure (fixed-length string). | |
2980 | ||
2981 | u A uuencoded string. | |
a0ed51b3 LW |
2982 | U A Unicode character number. Encodes to UTF-8 internally. |
2983 | Works even if C<use utf8> is not in effect. | |
a0d0e21e | 2984 | |
96e4d5b1 | 2985 | w A BER compressed integer. Its bytes represent an unsigned |
f86cebdf GS |
2986 | integer in base 128, most significant digit first, with as |
2987 | few digits as possible. Bit eight (the high bit) is set | |
2988 | on each byte except the last. | |
def98dd4 | 2989 | |
a0d0e21e LW |
2990 | x A null byte. |
2991 | X Back up a byte. | |
2992 | @ Null fill to absolute position. | |
2993 | ||
5a929a98 VU |
2994 | The following rules apply: |
2995 | ||
2996 | =over 8 | |
2997 | ||
2998 | =item * | |
2999 | ||
5a964f20 | 3000 | Each letter may optionally be followed by a number giving a repeat |
951ba7fe GS |
3001 | count. With all types except C<a>, C<A>, C<Z>, C<b>, C<B>, C<h>, |
3002 | C<H>, and C<P> the pack function will gobble up that many values from | |
5a929a98 | 3003 | the LIST. A C<*> for the repeat count means to use however many items are |
951ba7fe GS |
3004 | left, except for C<@>, C<x>, C<X>, where it is equivalent |
3005 | to C<0>, and C<u>, where it is equivalent to 1 (or 45, what is the | |
2b6c5635 GS |
3006 | same). |
3007 | ||
951ba7fe | 3008 | When used with C<Z>, C<*> results in the addition of a trailing null |
2b6c5635 GS |
3009 | byte (so the packed result will be one longer than the byte C<length> |
3010 | of the item). | |
3011 | ||
951ba7fe | 3012 | The repeat count for C<u> is interpreted as the maximal number of bytes |
2b6c5635 | 3013 | to encode per line of output, with 0 and 1 replaced by 45. |
5a929a98 VU |
3014 | |
3015 | =item * | |
3016 | ||
951ba7fe | 3017 | The C<a>, C<A>, and C<Z> types gobble just one value, but pack it as a |
5a929a98 | 3018 | string of length count, padding with nulls or spaces as necessary. When |
951ba7fe GS |
3019 | unpacking, C<A> strips trailing spaces and nulls, C<Z> strips everything |
3020 | after the first null, and C<a> returns data verbatim. When packing, | |
3021 | C<a>, and C<Z> are equivalent. | |
2b6c5635 GS |
3022 | |
3023 | If the value-to-pack is too long, it is truncated. If too long and an | |
951ba7fe GS |
3024 | explicit count is provided, C<Z> packs only C<$count-1> bytes, followed |
3025 | by a null byte. Thus C<Z> always packs a trailing null byte under | |
2b6c5635 | 3026 | all circumstances. |
5a929a98 VU |
3027 | |
3028 | =item * | |
3029 | ||
951ba7fe | 3030 | Likewise, the C<b> and C<B> fields pack a string that many bits long. |
c73032f5 IZ |
3031 | Each byte of the input field of pack() generates 1 bit of the result. |
3032 | Each result bit is based on the least-significant bit of the corresponding | |
3033 | input byte, i.e., on C<ord($byte)%2>. In particular, bytes C<"0"> and | |
3034 | C<"1"> generate bits 0 and 1, as do bytes C<"\0"> and C<"\1">. | |
3035 | ||
3036 | Starting from the beginning of the input string of pack(), each 8-tuple | |
951ba7fe | 3037 | of bytes is converted to 1 byte of output. With format C<b> |
c73032f5 | 3038 | the first byte of the 8-tuple determines the least-significant bit of a |
951ba7fe | 3039 | byte, and with format C<B> it determines the most-significant bit of |
c73032f5 IZ |
3040 | a byte. |
3041 | ||
3042 | If the length of the input string is not exactly divisible by 8, the | |
3043 | remainder is packed as if the input string were padded by null bytes | |
3044 | at the end. Similarly, during unpack()ing the "extra" bits are ignored. | |
3045 | ||
3046 | If the input string of pack() is longer than needed, extra bytes are ignored. | |
2b6c5635 GS |
3047 | A C<*> for the repeat count of pack() means to use all the bytes of |
3048 | the input field. On unpack()ing the bits are converted to a string | |
3049 | of C<"0">s and C<"1">s. | |
5a929a98 VU |
3050 | |
3051 | =item * | |
3052 | ||
951ba7fe | 3053 | The C<h> and C<H> fields pack a string that many nybbles (4-bit groups, |
851646ae | 3054 | representable as hexadecimal digits, 0-9a-f) long. |
5a929a98 | 3055 | |
c73032f5 IZ |
3056 | Each byte of the input field of pack() generates 4 bits of the result. |
3057 | For non-alphabetical bytes the result is based on the 4 least-significant | |
3058 | bits of the input byte, i.e., on C<ord($byte)%16>. In particular, | |
3059 | bytes C<"0"> and C<"1"> generate nybbles 0 and 1, as do bytes | |
3060 | C<"\0"> and C<"\1">. For bytes C<"a".."f"> and C<"A".."F"> the result | |
3061 | is compatible with the usual hexadecimal digits, so that C<"a"> and | |
3062 | C<"A"> both generate the nybble C<0xa==10>. The result for bytes | |
3063 | C<"g".."z"> and C<"G".."Z"> is not well-defined. | |
3064 | ||
3065 | Starting from the beginning of the input string of pack(), each pair | |
951ba7fe | 3066 | of bytes is converted to 1 byte of output. With format C<h> the |
c73032f5 | 3067 | first byte of the pair determines the least-significant nybble of the |
951ba7fe | 3068 | output byte, and with format C<H> it determines the most-significant |
c73032f5 IZ |
3069 | nybble. |
3070 | ||
3071 | If the length of the input string is not even, it behaves as if padded | |
3072 | by a null byte at the end. Similarly, during unpack()ing the "extra" | |
3073 | nybbles are ignored. | |
3074 | ||
3075 | If the input string of pack() is longer than needed, extra bytes are ignored. | |
3076 | A C<*> for the repeat count of pack() means to use all the bytes of | |
3077 | the input field. On unpack()ing the bits are converted to a string | |
3078 | of hexadecimal digits. | |
3079 | ||
5a929a98 VU |
3080 | =item * |
3081 | ||
951ba7fe | 3082 | The C<p> type packs a pointer to a null-terminated string. You are |
5a929a98 VU |
3083 | responsible for ensuring the string is not a temporary value (which can |
3084 | potentially get deallocated before you get around to using the packed result). | |
951ba7fe GS |
3085 | The C<P> type packs a pointer to a structure of the size indicated by the |
3086 | length. A NULL pointer is created if the corresponding value for C<p> or | |
3087 | C<P> is C<undef>, similarly for unpack(). | |
5a929a98 VU |
3088 | |
3089 | =item * | |
3090 | ||
951ba7fe GS |
3091 | The C</> template character allows packing and unpacking of strings where |
3092 | the packed structure contains a byte count followed by the string itself. | |
17f4a12d | 3093 | You write I<length-item>C</>I<string-item>. |
43192e07 IP |
3094 | |
3095 | The I<length-item> can be any C<pack> template letter, | |
3096 | and describes how the length value is packed. | |
3097 | The ones likely to be of most use are integer-packing ones like | |
951ba7fe GS |
3098 | C<n> (for Java strings), C<w> (for ASN.1 or SNMP) |
3099 | and C<N> (for Sun XDR). | |
43192e07 IP |
3100 | |
3101 | The I<string-item> must, at present, be C<"A*">, C<"a*"> or C<"Z*">. | |
3102 | For C<unpack> the length of the string is obtained from the I<length-item>, | |
3103 | but if you put in the '*' it will be ignored. | |
3104 | ||
17f4a12d IZ |
3105 | unpack 'C/a', "\04Gurusamy"; gives 'Guru' |
3106 | unpack 'a3/A* A*', '007 Bond J '; gives (' Bond','J') | |
3107 | pack 'n/a* w/a*','hello,','world'; gives "\000\006hello,\005world" | |
43192e07 IP |
3108 | |
3109 | The I<length-item> is not returned explicitly from C<unpack>. | |
3110 | ||
951ba7fe GS |
3111 | Adding a count to the I<length-item> letter is unlikely to do anything |
3112 | useful, unless that letter is C<A>, C<a> or C<Z>. Packing with a | |
3113 | I<length-item> of C<a> or C<Z> may introduce C<"\000"> characters, | |
43192e07 IP |
3114 | which Perl does not regard as legal in numeric strings. |
3115 | ||
3116 | =item * | |
3117 | ||
951ba7fe GS |
3118 | The integer types C<s>, C<S>, C<l>, and C<L> may be |
3119 | immediately followed by a C<!> suffix to signify native shorts or | |
3120 | longs--as you can see from above for example a bare C<l> does mean | |
851646ae JH |
3121 | exactly 32 bits, the native C<long> (as seen by the local C compiler) |
3122 | may be larger. This is an issue mainly in 64-bit platforms. You can | |
951ba7fe | 3123 | see whether using C<!> makes any difference by |
726ea183 | 3124 | |
4d0c1c44 GS |
3125 | print length(pack("s")), " ", length(pack("s!")), "\n"; |
3126 | print length(pack("l")), " ", length(pack("l!")), "\n"; | |
ef54e1a4 | 3127 | |
951ba7fe GS |
3128 | C<i!> and C<I!> also work but only because of completeness; |
3129 | they are identical to C<i> and C<I>. | |
ef54e1a4 | 3130 | |
19799a22 GS |
3131 | The actual sizes (in bytes) of native shorts, ints, longs, and long |
3132 | longs on the platform where Perl was built are also available via | |
3133 | L<Config>: | |
3134 | ||
3135 | use Config; | |
3136 | print $Config{shortsize}, "\n"; | |
3137 | print $Config{intsize}, "\n"; | |
3138 | print $Config{longsize}, "\n"; | |
3139 | print $Config{longlongsize}, "\n"; | |
ef54e1a4 | 3140 | |
5074e145 | 3141 | (The C<$Config{longlongsize}> will be undefine if your system does |
851646ae JH |
3142 | not support long longs.) |
3143 | ||
ef54e1a4 JH |
3144 | =item * |
3145 | ||
951ba7fe | 3146 | The integer formats C<s>, C<S>, C<i>, C<I>, C<l>, and C<L> |
ef54e1a4 JH |
3147 | are inherently non-portable between processors and operating systems |
3148 | because they obey the native byteorder and endianness. For example a | |
140cb37e | 3149 | 4-byte integer 0x12345678 (305419896 decimal) be ordered natively |
ef54e1a4 | 3150 | (arranged in and handled by the CPU registers) into bytes as |
61eff3bc | 3151 | |
719a3cf5 JH |
3152 | 0x12 0x34 0x56 0x78 # little-endian |
3153 | 0x78 0x56 0x34 0x12 # big-endian | |
61eff3bc | 3154 | |
5d11dd56 | 3155 | Basically, the Intel, Alpha, and VAX CPUs are little-endian, while |
719a3cf5 JH |
3156 | everybody else, for example Motorola m68k/88k, PPC, Sparc, HP PA, |
3157 | Power, and Cray are big-endian. MIPS can be either: Digital used it | |
19799a22 | 3158 | in little-endian mode; SGI uses it in big-endian mode. |
719a3cf5 | 3159 | |
19799a22 | 3160 | The names `big-endian' and `little-endian' are comic references to |
ef54e1a4 JH |
3161 | the classic "Gulliver's Travels" (via the paper "On Holy Wars and a |
3162 | Plea for Peace" by Danny Cohen, USC/ISI IEN 137, April 1, 1980) and | |
19799a22 | 3163 | the egg-eating habits of the Lilliputians. |
61eff3bc | 3164 | |
140cb37e | 3165 | Some systems may have even weirder byte orders such as |
61eff3bc | 3166 | |
ef54e1a4 JH |
3167 | 0x56 0x78 0x12 0x34 |
3168 | 0x34 0x12 0x78 0x56 | |
61eff3bc | 3169 | |
ef54e1a4 JH |
3170 | You can see your system's preference with |
3171 | ||
3172 | print join(" ", map { sprintf "%#02x", $_ } | |
3173 | unpack("C*",pack("L",0x12345678))), "\n"; | |
3174 | ||
d99ad34e | 3175 | The byteorder on the platform where Perl was built is also available |
726ea183 | 3176 | via L<Config>: |
ef54e1a4 JH |
3177 | |
3178 | use Config; | |
3179 | print $Config{byteorder}, "\n"; | |
3180 | ||
d99ad34e JH |
3181 | Byteorders C<'1234'> and C<'12345678'> are little-endian, C<'4321'> |
3182 | and C<'87654321'> are big-endian. | |
719a3cf5 | 3183 | |
951ba7fe GS |
3184 | If you want portable packed integers use the formats C<n>, C<N>, |
3185 | C<v>, and C<V>, their byte endianness and size is known. | |
851646ae | 3186 | See also L<perlport>. |
ef54e1a4 JH |
3187 | |
3188 | =item * | |
3189 | ||
5a929a98 VU |
3190 | Real numbers (floats and doubles) are in the native machine format only; |
3191 | due to the multiplicity of floating formats around, and the lack of a | |
3192 | standard "network" representation, no facility for interchange has been | |
3193 | made. This means that packed floating point data written on one machine | |
3194 | may not be readable on another - even if both use IEEE floating point | |
3195 | arithmetic (as the endian-ness of the memory representation is not part | |
851646ae | 3196 | of the IEEE spec). See also L<perlport>. |
5a929a98 VU |
3197 | |
3198 | Note that Perl uses doubles internally for all numeric calculation, and | |
3199 | converting from double into float and thence back to double again will | |
3200 | lose precision (i.e., C<unpack("f", pack("f", $foo)>) will not in general | |
19799a22 | 3201 | equal $foo). |
5a929a98 | 3202 | |
851646ae JH |
3203 | =item * |
3204 | ||
3205 | You must yourself do any alignment or padding by inserting for example | |
9ccd05c0 JH |
3206 | enough C<'x'>es while packing. There is no way to pack() and unpack() |
3207 | could know where the bytes are going to or coming from. Therefore | |
3208 | C<pack> (and C<unpack>) handle their output and input as flat | |
3209 | sequences of bytes. | |
851646ae | 3210 | |
17f4a12d IZ |
3211 | =item * |
3212 | ||
3213 | A comment in a TEMPLATE starts with C<#> and goes to the end of line. | |
3214 | ||
2b6c5635 GS |
3215 | =item * |
3216 | ||
3217 | If TEMPLATE requires more arguments to pack() than actually given, pack() | |
3218 | assumes additional C<""> arguments. If TEMPLATE requires less arguments | |
3219 | to pack() than actually given, extra arguments are ignored. | |
3220 | ||
5a929a98 | 3221 | =back |
a0d0e21e LW |
3222 | |
3223 | Examples: | |
3224 | ||
a0ed51b3 | 3225 | $foo = pack("CCCC",65,66,67,68); |
a0d0e21e | 3226 | # foo eq "ABCD" |
a0ed51b3 | 3227 | $foo = pack("C4",65,66,67,68); |
a0d0e21e | 3228 | # same thing |
a0ed51b3 LW |
3229 | $foo = pack("U4",0x24b6,0x24b7,0x24b8,0x24b9); |
3230 | # same thing with Unicode circled letters | |
a0d0e21e LW |
3231 | |
3232 | $foo = pack("ccxxcc",65,66,67,68); | |
3233 | # foo eq "AB\0\0CD" | |
3234 | ||
9ccd05c0 JH |
3235 | # note: the above examples featuring "C" and "c" are true |
3236 | # only on ASCII and ASCII-derived systems such as ISO Latin 1 | |
3237 | # and UTF-8. In EBCDIC the first example would be | |
3238 | # $foo = pack("CCCC",193,194,195,196); | |
3239 | ||
a0d0e21e LW |
3240 | $foo = pack("s2",1,2); |
3241 | # "\1\0\2\0" on little-endian | |
3242 | # "\0\1\0\2" on big-endian | |
3243 | ||
3244 | $foo = pack("a4","abcd","x","y","z"); | |
3245 | # "abcd" | |
3246 | ||
3247 | $foo = pack("aaaa","abcd","x","y","z"); | |
3248 | # "axyz" | |
3249 | ||
3250 | $foo = pack("a14","abcdefg"); | |
3251 | # "abcdefg\0\0\0\0\0\0\0" | |
3252 | ||
3253 | $foo = pack("i9pl", gmtime); | |
3254 | # a real struct tm (on my system anyway) | |
3255 | ||
5a929a98 VU |
3256 | $utmp_template = "Z8 Z8 Z16 L"; |
3257 | $utmp = pack($utmp_template, @utmp1); | |
3258 | # a struct utmp (BSDish) | |
3259 | ||
3260 | @utmp2 = unpack($utmp_template, $utmp); | |
3261 | # "@utmp1" eq "@utmp2" | |
3262 | ||
a0d0e21e LW |
3263 | sub bintodec { |
3264 | unpack("N", pack("B32", substr("0" x 32 . shift, -32))); | |
3265 | } | |
3266 | ||
851646ae JH |
3267 | $foo = pack('sx2l', 12, 34); |
3268 | # short 12, two zero bytes padding, long 34 | |
3269 | $bar = pack('s@4l', 12, 34); | |
3270 | # short 12, zero fill to position 4, long 34 | |
3271 | # $foo eq $bar | |
3272 | ||
5a929a98 | 3273 | The same template may generally also be used in unpack(). |
a0d0e21e | 3274 | |
5a964f20 TC |
3275 | =item package |
3276 | ||
cb1a09d0 AD |
3277 | =item package NAMESPACE |
3278 | ||
3279 | Declares the compilation unit as being in the given namespace. The scope | |
2b5ab1e7 | 3280 | of the package declaration is from the declaration itself through the end |
19799a22 | 3281 | of the enclosing block, file, or eval (the same as the C<my> operator). |
2b5ab1e7 TC |
3282 | All further unqualified dynamic identifiers will be in this namespace. |
3283 | A package statement affects only dynamic variables--including those | |
19799a22 GS |
3284 | you've used C<local> on--but I<not> lexical variables, which are created |
3285 | with C<my>. Typically it would be the first declaration in a file to | |
2b5ab1e7 TC |
3286 | be included by the C<require> or C<use> operator. You can switch into a |
3287 | package in more than one place; it merely influences which symbol table | |
3288 | is used by the compiler for the rest of that block. You can refer to | |
3289 | variables and filehandles in other packages by prefixing the identifier | |
3290 | with the package name and a double colon: C<$Package::Variable>. | |
3291 | If the package name is null, the C<main> package as assumed. That is, | |
3292 | C<$::sail> is equivalent to C<$main::sail> (as well as to C<$main'sail>, | |
3293 | still seen in older code). | |
cb1a09d0 | 3294 | |
5a964f20 TC |
3295 | If NAMESPACE is omitted, then there is no current package, and all |
3296 | identifiers must be fully qualified or lexicals. This is stricter | |
3297 | than C<use strict>, since it also extends to function names. | |
3298 | ||
cb1a09d0 AD |
3299 | See L<perlmod/"Packages"> for more information about packages, modules, |
3300 | and classes. See L<perlsub> for other scoping issues. | |
3301 | ||
a0d0e21e LW |
3302 | =item pipe READHANDLE,WRITEHANDLE |
3303 | ||
3304 | Opens a pair of connected pipes like the corresponding system call. | |
3305 | Note that if you set up a loop of piped processes, deadlock can occur | |
3306 | unless you are very careful. In addition, note that Perl's pipes use | |
184e9718 | 3307 | stdio buffering, so you may need to set C<$|> to flush your WRITEHANDLE |
a0d0e21e LW |
3308 | after each command, depending on the application. |
3309 | ||
7e1af8bc | 3310 | See L<IPC::Open2>, L<IPC::Open3>, and L<perlipc/"Bidirectional Communication"> |
4633a7c4 LW |
3311 | for examples of such things. |
3312 | ||
4771b018 GS |
3313 | On systems that support a close-on-exec flag on files, the flag will be set |
3314 | for the newly opened file descriptors as determined by the value of $^F. | |
3315 | See L<perlvar/$^F>. | |
3316 | ||
a0d0e21e LW |
3317 | =item pop ARRAY |
3318 | ||
54310121 | 3319 | =item pop |
28757baa | 3320 | |
a0d0e21e | 3321 | Pops and returns the last value of the array, shortening the array by |
19799a22 | 3322 | one element. Has an effect similar to |
a0d0e21e | 3323 | |
19799a22 | 3324 | $ARRAY[$#ARRAY--] |
a0d0e21e | 3325 | |
19799a22 GS |
3326 | If there are no elements in the array, returns the undefined value |
3327 | (although this may happen at other times as well). If ARRAY is | |
3328 | omitted, pops the C<@ARGV> array in the main program, and the C<@_> | |
3329 | array in subroutines, just like C<shift>. | |
a0d0e21e LW |
3330 | |
3331 | =item pos SCALAR | |
3332 | ||
54310121 | 3333 | =item pos |
bbce6d69 | 3334 | |
4633a7c4 | 3335 | Returns the offset of where the last C<m//g> search left off for the variable |
7660c0ab | 3336 | is in question (C<$_> is used when the variable is not specified). May be |
44a8e56a | 3337 | modified to change that offset. Such modification will also influence |
3338 | the C<\G> zero-width assertion in regular expressions. See L<perlre> and | |
3339 | L<perlop>. | |
a0d0e21e LW |
3340 | |
3341 | =item print FILEHANDLE LIST | |
3342 | ||
3343 | =item print LIST | |
3344 | ||
3345 | =item print | |
3346 | ||
19799a22 GS |
3347 | Prints a string or a list of strings. Returns true if successful. |
3348 | FILEHANDLE may be a scalar variable name, in which case the variable | |
3349 | contains the name of or a reference to the filehandle, thus introducing | |
3350 | one level of indirection. (NOTE: If FILEHANDLE is a variable and | |
3351 | the next token is a term, it may be misinterpreted as an operator | |
2b5ab1e7 | 3352 | unless you interpose a C<+> or put parentheses around the arguments.) |
19799a22 GS |
3353 | If FILEHANDLE is omitted, prints by default to standard output (or |
3354 | to the last selected output channel--see L</select>). If LIST is | |
3355 | also omitted, prints C<$_> to the currently selected output channel. | |
3356 | To set the default output channel to something other than STDOUT | |
3357 | use the select operation. The current value of C<$,> (if any) is | |
3358 | printed between each LIST item. The current value of C<$\> (if | |
3359 | any) is printed after the entire LIST has been printed. Because | |
3360 | print takes a LIST, anything in the LIST is evaluated in list | |
3361 | context, and any subroutine that you call will have one or more of | |
3362 | its expressions evaluated in list context. Also be careful not to | |
3363 | follow the print keyword with a left parenthesis unless you want | |
3364 | the corresponding right parenthesis to terminate the arguments to | |
3365 | the print--interpose a C<+> or put parentheses around all the | |
3366 | arguments. | |
a0d0e21e | 3367 | |
4633a7c4 | 3368 | Note that if you're storing FILEHANDLES in an array or other expression, |
da0045b7 | 3369 | you will have to use a block returning its value instead: |
4633a7c4 LW |
3370 | |
3371 | print { $files[$i] } "stuff\n"; | |
3372 | print { $OK ? STDOUT : STDERR } "stuff\n"; | |
3373 | ||
5f05dabc | 3374 | =item printf FILEHANDLE FORMAT, LIST |
a0d0e21e | 3375 | |
5f05dabc | 3376 | =item printf FORMAT, LIST |
a0d0e21e | 3377 | |
7660c0ab | 3378 | Equivalent to C<print FILEHANDLE sprintf(FORMAT, LIST)>, except that C<$\> |
a3cb178b | 3379 | (the output record separator) is not appended. The first argument |
19799a22 | 3380 | of the list will be interpreted as the C<printf> format. If C<use locale> is |
a034a98d DD |
3381 | in effect, the character used for the decimal point in formatted real numbers |
3382 | is affected by the LC_NUMERIC locale. See L<perllocale>. | |
a0d0e21e | 3383 | |
19799a22 GS |
3384 | Don't fall into the trap of using a C<printf> when a simple |
3385 | C<print> would do. The C<print> is more efficient and less | |
28757baa | 3386 | error prone. |
3387 | ||
da0045b7 | 3388 | =item prototype FUNCTION |
3389 | ||
3390 | Returns the prototype of a function as a string (or C<undef> if the | |
5f05dabc | 3391 | function has no prototype). FUNCTION is a reference to, or the name of, |
3392 | the function whose prototype you want to retrieve. | |
da0045b7 | 3393 | |
2b5ab1e7 TC |
3394 | If FUNCTION is a string starting with C<CORE::>, the rest is taken as a |
3395 | name for Perl builtin. If the builtin is not I<overridable> (such as | |
ab4f32c2 | 3396 | C<qw//>) or its arguments cannot be expressed by a prototype (such as |
19799a22 | 3397 | C<system>) returns C<undef> because the builtin does not really behave |
2b5ab1e7 TC |
3398 | like a Perl function. Otherwise, the string describing the equivalent |
3399 | prototype is returned. | |
b6c543e3 | 3400 | |
a0d0e21e LW |
3401 | =item push ARRAY,LIST |
3402 | ||
3403 | Treats ARRAY as a stack, and pushes the values of LIST | |
3404 | onto the end of ARRAY. The length of ARRAY increases by the length of | |
3405 | LIST. Has the same effect as | |
3406 | ||
3407 | for $value (LIST) { | |
3408 | $ARRAY[++$#ARRAY] = $value; | |
3409 | } | |
3410 | ||
3411 | but is more efficient. Returns the new number of elements in the array. | |
3412 | ||
3413 | =item q/STRING/ | |
3414 | ||
3415 | =item qq/STRING/ | |
3416 | ||
8782bef2 GB |
3417 | =item qr/STRING/ |
3418 | ||
a0d0e21e LW |
3419 | =item qx/STRING/ |
3420 | ||
3421 | =item qw/STRING/ | |
3422 | ||
4b6a7270 | 3423 | Generalized quotes. See L<perlop/"Regexp Quote-Like Operators">. |
a0d0e21e LW |
3424 | |
3425 | =item quotemeta EXPR | |
3426 | ||
54310121 | 3427 | =item quotemeta |
bbce6d69 | 3428 | |
36bbe248 | 3429 | Returns the value of EXPR with all non-"word" |
a034a98d DD |
3430 | characters backslashed. (That is, all characters not matching |
3431 | C</[A-Za-z_0-9]/> will be preceded by a backslash in the | |
3432 | returned string, regardless of any locale settings.) | |
3433 | This is the internal function implementing | |
7660c0ab | 3434 | the C<\Q> escape in double-quoted strings. |
a0d0e21e | 3435 | |
7660c0ab | 3436 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 3437 | |
a0d0e21e LW |
3438 | =item rand EXPR |
3439 | ||
3440 | =item rand | |
3441 | ||
7660c0ab | 3442 | Returns a random fractional number greater than or equal to C<0> and less |
3e3baf6d | 3443 | than the value of EXPR. (EXPR should be positive.) If EXPR is |
19799a22 GS |
3444 | omitted, the value C<1> is used. Automatically calls C<srand> unless |
3445 | C<srand> has already been called. See also C<srand>. | |
a0d0e21e | 3446 | |
2f9daede | 3447 | (Note: If your rand function consistently returns numbers that are too |
a0d0e21e | 3448 | large or too small, then your version of Perl was probably compiled |
2f9daede | 3449 | with the wrong number of RANDBITS.) |
a0d0e21e LW |
3450 | |
3451 | =item read FILEHANDLE,SCALAR,LENGTH,OFFSET | |
3452 | ||
3453 | =item read FILEHANDLE,SCALAR,LENGTH | |
3454 | ||
3455 | Attempts to read LENGTH bytes of data into variable SCALAR from the | |
3b02c43c GS |
3456 | specified FILEHANDLE. Returns the number of bytes actually read, |
3457 | C<0> at end of file, or undef if there was an error. SCALAR will be grown | |
3458 | or shrunk to the length actually read. An OFFSET may be specified to | |
3459 | place the read data at some other place than the beginning of the | |
f86cebdf | 3460 | string. This call is actually implemented in terms of stdio's fread(3) |
19799a22 | 3461 | call. To get a true read(2) system call, see C<sysread>. |
a0d0e21e LW |
3462 | |
3463 | =item readdir DIRHANDLE | |
3464 | ||
19799a22 | 3465 | Returns the next directory entry for a directory opened by C<opendir>. |
5a964f20 | 3466 | If used in list context, returns all the rest of the entries in the |
a0d0e21e | 3467 | directory. If there are no more entries, returns an undefined value in |
5a964f20 | 3468 | scalar context or a null list in list context. |
a0d0e21e | 3469 | |
19799a22 | 3470 | If you're planning to filetest the return values out of a C<readdir>, you'd |
5f05dabc | 3471 | better prepend the directory in question. Otherwise, because we didn't |
19799a22 | 3472 | C<chdir> there, it would have been testing the wrong file. |
cb1a09d0 AD |
3473 | |
3474 | opendir(DIR, $some_dir) || die "can't opendir $some_dir: $!"; | |
3475 | @dots = grep { /^\./ && -f "$some_dir/$_" } readdir(DIR); | |
3476 | closedir DIR; | |
3477 | ||
84902520 TB |
3478 | =item readline EXPR |
3479 | ||
fbad3eb5 GS |
3480 | Reads from the filehandle whose typeglob is contained in EXPR. In scalar |
3481 | context, each call reads and returns the next line, until end-of-file is | |
3482 | reached, whereupon the subsequent call returns undef. In list context, | |
3483 | reads until end-of-file is reached and returns a list of lines. Note that | |
3484 | the notion of "line" used here is however you may have defined it | |
3485 | with C<$/> or C<$INPUT_RECORD_SEPARATOR>). See L<perlvar/"$/">. | |
3486 | ||
2b5ab1e7 | 3487 | When C<$/> is set to C<undef>, when readline() is in scalar |
449bc448 GS |
3488 | context (i.e. file slurp mode), and when an empty file is read, it |
3489 | returns C<''> the first time, followed by C<undef> subsequently. | |
fbad3eb5 | 3490 | |
61eff3bc JH |
3491 | This is the internal function implementing the C<< <EXPR> >> |
3492 | operator, but you can use it directly. The C<< <EXPR> >> | |
84902520 TB |
3493 | operator is discussed in more detail in L<perlop/"I/O Operators">. |
3494 | ||
5a964f20 TC |
3495 | $line = <STDIN>; |
3496 | $line = readline(*STDIN); # same thing | |
3497 | ||
a0d0e21e LW |
3498 | =item readlink EXPR |
3499 | ||
54310121 | 3500 | =item readlink |
bbce6d69 | 3501 | |
a0d0e21e LW |
3502 | Returns the value of a symbolic link, if symbolic links are |
3503 | implemented. If not, gives a fatal error. If there is some system | |
184e9718 | 3504 | error, returns the undefined value and sets C<$!> (errno). If EXPR is |
7660c0ab | 3505 | omitted, uses C<$_>. |
a0d0e21e | 3506 | |
84902520 TB |
3507 | =item readpipe EXPR |
3508 | ||
5a964f20 | 3509 | EXPR is executed as a system command. |
84902520 TB |
3510 | The collected standard output of the command is returned. |
3511 | In scalar context, it comes back as a single (potentially | |
3512 | multi-line) string. In list context, returns a list of lines | |
7660c0ab | 3513 | (however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>). |
84902520 TB |
3514 | This is the internal function implementing the C<qx/EXPR/> |
3515 | operator, but you can use it directly. The C<qx/EXPR/> | |
3516 | operator is discussed in more detail in L<perlop/"I/O Operators">. | |
3517 | ||
399388f4 | 3518 | =item recv SOCKET,SCALAR,LENGTH,FLAGS |
a0d0e21e LW |
3519 | |
3520 | Receives a message on a socket. Attempts to receive LENGTH bytes of | |
478234b4 GS |
3521 | data into variable SCALAR from the specified SOCKET filehandle. SCALAR |
3522 | will be grown or shrunk to the length actually read. Takes the same | |
3523 | flags as the system call of the same name. Returns the address of the | |
3524 | sender if SOCKET's protocol supports this; returns an empty string | |
3525 | otherwise. If there's an error, returns the undefined value. This call | |
3526 | is actually implemented in terms of recvfrom(2) system call. See | |
3527 | L<perlipc/"UDP: Message Passing"> for examples. | |
a0d0e21e LW |
3528 | |
3529 | =item redo LABEL | |
3530 | ||
3531 | =item redo | |
3532 | ||
3533 | The C<redo> command restarts the loop block without evaluating the | |
98293880 | 3534 | conditional again. The C<continue> block, if any, is not executed. If |
a0d0e21e LW |
3535 | the LABEL is omitted, the command refers to the innermost enclosing |
3536 | loop. This command is normally used by programs that want to lie to | |
3537 | themselves about what was just input: | |
3538 | ||
3539 | # a simpleminded Pascal comment stripper | |
3540 | # (warning: assumes no { or } in strings) | |
4633a7c4 | 3541 | LINE: while (<STDIN>) { |
a0d0e21e LW |
3542 | while (s|({.*}.*){.*}|$1 |) {} |
3543 | s|{.*}| |; | |
3544 | if (s|{.*| |) { | |
3545 | $front = $_; | |
3546 | while (<STDIN>) { | |
3547 | if (/}/) { # end of comment? | |
5a964f20 | 3548 | s|^|$front\{|; |
4633a7c4 | 3549 | redo LINE; |
a0d0e21e LW |
3550 | } |
3551 | } | |
3552 | } | |
3553 | print; | |
3554 | } | |
3555 | ||
4968c1e4 | 3556 | C<redo> cannot be used to retry a block which returns a value such as |
2b5ab1e7 TC |
3557 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
3558 | a grep() or map() operation. | |
4968c1e4 | 3559 | |
6c1372ed GS |
3560 | Note that a block by itself is semantically identical to a loop |
3561 | that executes once. Thus C<redo> inside such a block will effectively | |
3562 | turn it into a looping construct. | |
3563 | ||
98293880 | 3564 | See also L</continue> for an illustration of how C<last>, C<next>, and |
1d2dff63 GS |
3565 | C<redo> work. |
3566 | ||
a0d0e21e LW |
3567 | =item ref EXPR |
3568 | ||
54310121 | 3569 | =item ref |
bbce6d69 | 3570 | |
19799a22 | 3571 | Returns a true value if EXPR is a reference, false otherwise. If EXPR |
7660c0ab | 3572 | is not specified, C<$_> will be used. The value returned depends on the |
bbce6d69 | 3573 | type of thing the reference is a reference to. |
a0d0e21e LW |
3574 | Builtin types include: |
3575 | ||
a0d0e21e LW |
3576 | SCALAR |
3577 | ARRAY | |
3578 | HASH | |
3579 | CODE | |
19799a22 | 3580 | REF |
a0d0e21e | 3581 | GLOB |
19799a22 | 3582 | LVALUE |
a0d0e21e | 3583 | |
54310121 | 3584 | If the referenced object has been blessed into a package, then that package |
19799a22 | 3585 | name is returned instead. You can think of C<ref> as a C<typeof> operator. |
a0d0e21e LW |
3586 | |
3587 | if (ref($r) eq "HASH") { | |
aa689395 | 3588 | print "r is a reference to a hash.\n"; |
54310121 | 3589 | } |
2b5ab1e7 | 3590 | unless (ref($r)) { |
a0d0e21e | 3591 | print "r is not a reference at all.\n"; |
54310121 | 3592 | } |
2b5ab1e7 TC |
3593 | if (UNIVERSAL::isa($r, "HASH")) { # for subclassing |
3594 | print "r is a reference to something that isa hash.\n"; | |
3595 | } | |
a0d0e21e LW |
3596 | |
3597 | See also L<perlref>. | |
3598 | ||
3599 | =item rename OLDNAME,NEWNAME | |
3600 | ||
19799a22 GS |
3601 | Changes the name of a file; an existing file NEWNAME will be |
3602 | clobbered. Returns true for success, false otherwise. | |
3603 | ||
2b5ab1e7 TC |
3604 | Behavior of this function varies wildly depending on your system |
3605 | implementation. For example, it will usually not work across file system | |
3606 | boundaries, even though the system I<mv> command sometimes compensates | |
3607 | for this. Other restrictions include whether it works on directories, | |
3608 | open files, or pre-existing files. Check L<perlport> and either the | |
3609 | rename(2) manpage or equivalent system documentation for details. | |
a0d0e21e | 3610 | |
16070b82 GS |
3611 | =item require VERSION |
3612 | ||
a0d0e21e LW |
3613 | =item require EXPR |
3614 | ||
3615 | =item require | |
3616 | ||
7660c0ab | 3617 | Demands some semantics specified by EXPR, or by C<$_> if EXPR is not |
44dcb63b GS |
3618 | supplied. |
3619 | ||
dd629d5b | 3620 | If a VERSION is specified as a literal of the form v5.6.1, |
44dcb63b GS |
3621 | demands that the current version of Perl (C<$^V> or $PERL_VERSION) be |
3622 | at least as recent as that version, at run time. (For compatibility | |
3623 | with older versions of Perl, a numeric argument will also be interpreted | |
3624 | as VERSION.) Compare with L</use>, which can do a similar check at | |
3625 | compile time. | |
3626 | ||
dd629d5b GS |
3627 | require v5.6.1; # run time version check |
3628 | require 5.6.1; # ditto | |
3629 | require 5.005_03; # float version allowed for compatibility | |
a0d0e21e LW |
3630 | |
3631 | Otherwise, demands that a library file be included if it hasn't already | |
3632 | been included. The file is included via the do-FILE mechanism, which is | |
19799a22 | 3633 | essentially just a variety of C<eval>. Has semantics similar to the following |
a0d0e21e LW |
3634 | subroutine: |
3635 | ||
3636 | sub require { | |
5a964f20 | 3637 | my($filename) = @_; |
a0d0e21e | 3638 | return 1 if $INC{$filename}; |
5a964f20 | 3639 | my($realfilename,$result); |
a0d0e21e LW |
3640 | ITER: { |
3641 | foreach $prefix (@INC) { | |
3642 | $realfilename = "$prefix/$filename"; | |
3643 | if (-f $realfilename) { | |
f784dfa3 | 3644 | $INC{$filename} = $realfilename; |
a0d0e21e LW |
3645 | $result = do $realfilename; |
3646 | last ITER; | |
3647 | } | |
3648 | } | |
3649 | die "Can't find $filename in \@INC"; | |
3650 | } | |
f784dfa3 | 3651 | delete $INC{$filename} if $@ || !$result; |
a0d0e21e LW |
3652 | die $@ if $@; |
3653 | die "$filename did not return true value" unless $result; | |
5a964f20 | 3654 | return $result; |
a0d0e21e LW |
3655 | } |
3656 | ||
3657 | Note that the file will not be included twice under the same specified | |
19799a22 | 3658 | name. The file must return true as the last statement to indicate |
a0d0e21e | 3659 | successful execution of any initialization code, so it's customary to |
19799a22 GS |
3660 | end such a file with C<1;> unless you're sure it'll return true |
3661 | otherwise. But it's better just to put the C<1;>, in case you add more | |
a0d0e21e LW |
3662 | statements. |
3663 | ||
54310121 | 3664 | If EXPR is a bareword, the require assumes a "F<.pm>" extension and |
da0045b7 | 3665 | replaces "F<::>" with "F</>" in the filename for you, |
54310121 | 3666 | to make it easy to load standard modules. This form of loading of |
a0d0e21e LW |
3667 | modules does not risk altering your namespace. |
3668 | ||
ee580363 GS |
3669 | In other words, if you try this: |
3670 | ||
f86cebdf | 3671 | require Foo::Bar; # a splendid bareword |
ee580363 | 3672 | |
7660c0ab A |
3673 | The require function will actually look for the "F<Foo/Bar.pm>" file in the |
3674 | directories specified in the C<@INC> array. | |
ee580363 | 3675 | |
5a964f20 | 3676 | But if you try this: |
ee580363 GS |
3677 | |
3678 | $class = 'Foo::Bar'; | |
f86cebdf | 3679 | require $class; # $class is not a bareword |
5a964f20 | 3680 | #or |
f86cebdf | 3681 | require "Foo::Bar"; # not a bareword because of the "" |
ee580363 | 3682 | |
7660c0ab | 3683 | The require function will look for the "F<Foo::Bar>" file in the @INC array and |
19799a22 | 3684 | will complain about not finding "F<Foo::Bar>" there. In this case you can do: |
ee580363 GS |
3685 | |
3686 | eval "require $class"; | |
3687 | ||
3688 | For a yet-more-powerful import facility, see L</use> and L<perlmod>. | |
a0d0e21e LW |
3689 | |
3690 | =item reset EXPR | |
3691 | ||
3692 | =item reset | |
3693 | ||
3694 | Generally used in a C<continue> block at the end of a loop to clear | |
7660c0ab | 3695 | variables and reset C<??> searches so that they work again. The |
a0d0e21e LW |
3696 | expression is interpreted as a list of single characters (hyphens |
3697 | allowed for ranges). All variables and arrays beginning with one of | |
3698 | those letters are reset to their pristine state. If the expression is | |
7660c0ab | 3699 | omitted, one-match searches (C<?pattern?>) are reset to match again. Resets |
5f05dabc | 3700 | only variables or searches in the current package. Always returns |
a0d0e21e LW |
3701 | 1. Examples: |
3702 | ||
3703 | reset 'X'; # reset all X variables | |
3704 | reset 'a-z'; # reset lower case variables | |
2b5ab1e7 | 3705 | reset; # just reset ?one-time? searches |
a0d0e21e | 3706 | |
7660c0ab | 3707 | Resetting C<"A-Z"> is not recommended because you'll wipe out your |
2b5ab1e7 TC |
3708 | C<@ARGV> and C<@INC> arrays and your C<%ENV> hash. Resets only package |
3709 | variables--lexical variables are unaffected, but they clean themselves | |
3710 | up on scope exit anyway, so you'll probably want to use them instead. | |
3711 | See L</my>. | |
a0d0e21e | 3712 | |
54310121 | 3713 | =item return EXPR |
3714 | ||
3715 | =item return | |
3716 | ||
19799a22 | 3717 | Returns from a subroutine, C<eval>, or C<do FILE> with the value |
5a964f20 | 3718 | given in EXPR. Evaluation of EXPR may be in list, scalar, or void |
54310121 | 3719 | context, depending on how the return value will be used, and the context |
19799a22 | 3720 | may vary from one execution to the next (see C<wantarray>). If no EXPR |
2b5ab1e7 TC |
3721 | is given, returns an empty list in list context, the undefined value in |
3722 | scalar context, and (of course) nothing at all in a void context. | |
a0d0e21e | 3723 | |
2b5ab1e7 TC |
3724 | (Note that in the absence of a explicit C<return>, a subroutine, eval, |
3725 | or do FILE will automatically return the value of the last expression | |
3726 | evaluated.) | |
a0d0e21e LW |
3727 | |
3728 | =item reverse LIST | |
3729 | ||
5a964f20 TC |
3730 | In list context, returns a list value consisting of the elements |
3731 | of LIST in the opposite order. In scalar context, concatenates the | |
2b5ab1e7 | 3732 | elements of LIST and returns a string value with all characters |
a0ed51b3 | 3733 | in the opposite order. |
4633a7c4 | 3734 | |
2f9daede | 3735 | print reverse <>; # line tac, last line first |
4633a7c4 | 3736 | |
2f9daede | 3737 | undef $/; # for efficiency of <> |
a0ed51b3 | 3738 | print scalar reverse <>; # character tac, last line tsrif |
2f9daede TP |
3739 | |
3740 | This operator is also handy for inverting a hash, although there are some | |
3741 | caveats. If a value is duplicated in the original hash, only one of those | |
3742 | can be represented as a key in the inverted hash. Also, this has to | |
3743 | unwind one hash and build a whole new one, which may take some time | |
2b5ab1e7 | 3744 | on a large hash, such as from a DBM file. |
2f9daede TP |
3745 | |
3746 | %by_name = reverse %by_address; # Invert the hash | |
a0d0e21e LW |
3747 | |
3748 | =item rewinddir DIRHANDLE | |
3749 | ||
3750 | Sets the current position to the beginning of the directory for the | |
19799a22 | 3751 | C<readdir> routine on DIRHANDLE. |
a0d0e21e LW |
3752 | |
3753 | =item rindex STR,SUBSTR,POSITION | |
3754 | ||
3755 | =item rindex STR,SUBSTR | |
3756 | ||
2b5ab1e7 | 3757 | Works just like index() except that it returns the position of the LAST |
a0d0e21e LW |
3758 | occurrence of SUBSTR in STR. If POSITION is specified, returns the |
3759 | last occurrence at or before that position. | |
3760 | ||
3761 | =item rmdir FILENAME | |
3762 | ||
54310121 | 3763 | =item rmdir |
bbce6d69 | 3764 | |
5a964f20 | 3765 | Deletes the directory specified by FILENAME if that directory is empty. If it |
19799a22 | 3766 | succeeds it returns true, otherwise it returns false and sets C<$!> (errno). If |
7660c0ab | 3767 | FILENAME is omitted, uses C<$_>. |
a0d0e21e LW |
3768 | |
3769 | =item s/// | |
3770 | ||
3771 | The substitution operator. See L<perlop>. | |
3772 | ||
3773 | =item scalar EXPR | |
3774 | ||
5a964f20 | 3775 | Forces EXPR to be interpreted in scalar context and returns the value |
54310121 | 3776 | of EXPR. |
cb1a09d0 AD |
3777 | |
3778 | @counts = ( scalar @a, scalar @b, scalar @c ); | |
3779 | ||
54310121 | 3780 | There is no equivalent operator to force an expression to |
2b5ab1e7 | 3781 | be interpolated in list context because in practice, this is never |
cb1a09d0 AD |
3782 | needed. If you really wanted to do so, however, you could use |
3783 | the construction C<@{[ (some expression) ]}>, but usually a simple | |
3784 | C<(some expression)> suffices. | |
a0d0e21e | 3785 | |
19799a22 | 3786 | Because C<scalar> is unary operator, if you accidentally use for EXPR a |
2b5ab1e7 TC |
3787 | parenthesized list, this behaves as a scalar comma expression, evaluating |
3788 | all but the last element in void context and returning the final element | |
3789 | evaluated in scalar context. This is seldom what you want. | |
62c18ce2 GS |
3790 | |
3791 | The following single statement: | |
3792 | ||
3793 | print uc(scalar(&foo,$bar)),$baz; | |
3794 | ||
3795 | is the moral equivalent of these two: | |
3796 | ||
3797 | &foo; | |
3798 | print(uc($bar),$baz); | |
3799 | ||
3800 | See L<perlop> for more details on unary operators and the comma operator. | |
3801 | ||
a0d0e21e LW |
3802 | =item seek FILEHANDLE,POSITION,WHENCE |
3803 | ||
19799a22 | 3804 | Sets FILEHANDLE's position, just like the C<fseek> call of C<stdio>. |
8903cb82 | 3805 | FILEHANDLE may be an expression whose value gives the name of the |
7660c0ab | 3806 | filehandle. The values for WHENCE are C<0> to set the new position to |
ac88732c JH |
3807 | POSITION, C<1> to set it to the current position plus POSITION, and |
3808 | C<2> to set it to EOF plus POSITION (typically negative). For WHENCE | |
3809 | you may use the constants C<SEEK_SET>, C<SEEK_CUR>, and C<SEEK_END> | |
ca6e1c26 JH |
3810 | (start of the file, current position, end of the file) from the Fcntl |
3811 | module. Returns C<1> upon success, C<0> otherwise. | |
8903cb82 | 3812 | |
19799a22 GS |
3813 | If you want to position file for C<sysread> or C<syswrite>, don't use |
3814 | C<seek>--buffering makes its effect on the file's system position | |
3815 | unpredictable and non-portable. Use C<sysseek> instead. | |
a0d0e21e | 3816 | |
2b5ab1e7 TC |
3817 | Due to the rules and rigors of ANSI C, on some systems you have to do a |
3818 | seek whenever you switch between reading and writing. Amongst other | |
3819 | things, this may have the effect of calling stdio's clearerr(3). | |
3820 | A WHENCE of C<1> (C<SEEK_CUR>) is useful for not moving the file position: | |
cb1a09d0 AD |
3821 | |
3822 | seek(TEST,0,1); | |
3823 | ||
3824 | This is also useful for applications emulating C<tail -f>. Once you hit | |
3825 | EOF on your read, and then sleep for a while, you might have to stick in a | |
19799a22 | 3826 | seek() to reset things. The C<seek> doesn't change the current position, |
8903cb82 | 3827 | but it I<does> clear the end-of-file condition on the handle, so that the |
61eff3bc | 3828 | next C<< <FILE> >> makes Perl try again to read something. We hope. |
cb1a09d0 AD |
3829 | |
3830 | If that doesn't work (some stdios are particularly cantankerous), then | |
3831 | you may need something more like this: | |
3832 | ||
3833 | for (;;) { | |
f86cebdf GS |
3834 | for ($curpos = tell(FILE); $_ = <FILE>; |
3835 | $curpos = tell(FILE)) { | |
cb1a09d0 AD |
3836 | # search for some stuff and put it into files |
3837 | } | |
3838 | sleep($for_a_while); | |
3839 | seek(FILE, $curpos, 0); | |
3840 | } | |
3841 | ||
a0d0e21e LW |
3842 | =item seekdir DIRHANDLE,POS |
3843 | ||
19799a22 GS |
3844 | Sets the current position for the C<readdir> routine on DIRHANDLE. POS |
3845 | must be a value returned by C<telldir>. Has the same caveats about | |
a0d0e21e LW |
3846 | possible directory compaction as the corresponding system library |
3847 | routine. | |
3848 | ||
3849 | =item select FILEHANDLE | |
3850 | ||
3851 | =item select | |
3852 | ||
3853 | Returns the currently selected filehandle. Sets the current default | |
3854 | filehandle for output, if FILEHANDLE is supplied. This has two | |
19799a22 | 3855 | effects: first, a C<write> or a C<print> without a filehandle will |
a0d0e21e LW |
3856 | default to this FILEHANDLE. Second, references to variables related to |
3857 | output will refer to this output channel. For example, if you have to | |
3858 | set the top of form format for more than one output channel, you might | |
3859 | do the following: | |
3860 | ||
3861 | select(REPORT1); | |
3862 | $^ = 'report1_top'; | |
3863 | select(REPORT2); | |
3864 | $^ = 'report2_top'; | |
3865 | ||
3866 | FILEHANDLE may be an expression whose value gives the name of the | |
3867 | actual filehandle. Thus: | |
3868 | ||
3869 | $oldfh = select(STDERR); $| = 1; select($oldfh); | |
3870 | ||
4633a7c4 LW |
3871 | Some programmers may prefer to think of filehandles as objects with |
3872 | methods, preferring to write the last example as: | |
a0d0e21e | 3873 | |
28757baa | 3874 | use IO::Handle; |
a0d0e21e LW |
3875 | STDERR->autoflush(1); |
3876 | ||
3877 | =item select RBITS,WBITS,EBITS,TIMEOUT | |
3878 | ||
f86cebdf | 3879 | This calls the select(2) system call with the bit masks specified, which |
19799a22 | 3880 | can be constructed using C<fileno> and C<vec>, along these lines: |
a0d0e21e LW |
3881 | |
3882 | $rin = $win = $ein = ''; | |
3883 | vec($rin,fileno(STDIN),1) = 1; | |
3884 | vec($win,fileno(STDOUT),1) = 1; | |
3885 | $ein = $rin | $win; | |
3886 | ||
3887 | If you want to select on many filehandles you might wish to write a | |
3888 | subroutine: | |
3889 | ||
3890 | sub fhbits { | |
5a964f20 TC |
3891 | my(@fhlist) = split(' ',$_[0]); |
3892 | my($bits); | |
a0d0e21e LW |
3893 | for (@fhlist) { |
3894 | vec($bits,fileno($_),1) = 1; | |
3895 | } | |
3896 | $bits; | |
3897 | } | |
4633a7c4 | 3898 | $rin = fhbits('STDIN TTY SOCK'); |
a0d0e21e LW |
3899 | |
3900 | The usual idiom is: | |
3901 | ||
3902 | ($nfound,$timeleft) = | |
3903 | select($rout=$rin, $wout=$win, $eout=$ein, $timeout); | |
3904 | ||
54310121 | 3905 | or to block until something becomes ready just do this |
a0d0e21e LW |
3906 | |
3907 | $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef); | |
3908 | ||
19799a22 GS |
3909 | Most systems do not bother to return anything useful in $timeleft, so |
3910 | calling select() in scalar context just returns $nfound. | |
c07a80fd | 3911 | |
5f05dabc | 3912 | Any of the bit masks can also be undef. The timeout, if specified, is |
a0d0e21e | 3913 | in seconds, which may be fractional. Note: not all implementations are |
19799a22 GS |
3914 | capable of returning the$timeleft. If not, they always return |
3915 | $timeleft equal to the supplied $timeout. | |
a0d0e21e | 3916 | |
ff68c719 | 3917 | You can effect a sleep of 250 milliseconds this way: |
a0d0e21e LW |
3918 | |
3919 | select(undef, undef, undef, 0.25); | |
3920 | ||
19799a22 | 3921 | B<WARNING>: One should not attempt to mix buffered I/O (like C<read> |
61eff3bc | 3922 | or <FH>) with C<select>, except as permitted by POSIX, and even |
19799a22 | 3923 | then only on POSIX systems. You have to use C<sysread> instead. |
a0d0e21e LW |
3924 | |
3925 | =item semctl ID,SEMNUM,CMD,ARG | |
3926 | ||
19799a22 | 3927 | Calls the System V IPC function C<semctl>. You'll probably have to say |
0ade1984 JH |
3928 | |
3929 | use IPC::SysV; | |
3930 | ||
3931 | first to get the correct constant definitions. If CMD is IPC_STAT or | |
3932 | GETALL, then ARG must be a variable which will hold the returned | |
e4038a1f MS |
3933 | semid_ds structure or semaphore value array. Returns like C<ioctl>: |
3934 | the undefined value for error, "C<0 but true>" for zero, or the actual | |
3935 | return value otherwise. The ARG must consist of a vector of native | |
106325ad | 3936 | short integers, which may be created with C<pack("s!",(0)x$nsem)>. |
e4038a1f | 3937 | See also C<IPC::SysV> and C<IPC::Semaphore> documentation. |
a0d0e21e LW |
3938 | |
3939 | =item semget KEY,NSEMS,FLAGS | |
3940 | ||
3941 | Calls the System V IPC function semget. Returns the semaphore id, or | |
7660c0ab A |
3942 | the undefined value if there is an error. See also C<IPC::SysV> and |
3943 | C<IPC::SysV::Semaphore> documentation. | |
a0d0e21e LW |
3944 | |
3945 | =item semop KEY,OPSTRING | |
3946 | ||
3947 | Calls the System V IPC function semop to perform semaphore operations | |
3948 | such as signaling and waiting. OPSTRING must be a packed array of | |
3949 | semop structures. Each semop structure can be generated with | |
3950 | C<pack("sss", $semnum, $semop, $semflag)>. The number of semaphore | |
19799a22 GS |
3951 | operations is implied by the length of OPSTRING. Returns true if |
3952 | successful, or false if there is an error. As an example, the | |
3953 | following code waits on semaphore $semnum of semaphore id $semid: | |
a0d0e21e LW |
3954 | |
3955 | $semop = pack("sss", $semnum, -1, 0); | |
3956 | die "Semaphore trouble: $!\n" unless semop($semid, $semop); | |
3957 | ||
7660c0ab A |
3958 | To signal the semaphore, replace C<-1> with C<1>. See also C<IPC::SysV> |
3959 | and C<IPC::SysV::Semaphore> documentation. | |
a0d0e21e LW |
3960 | |
3961 | =item send SOCKET,MSG,FLAGS,TO | |
3962 | ||
3963 | =item send SOCKET,MSG,FLAGS | |
3964 | ||
3965 | Sends a message on a socket. Takes the same flags as the system call | |
3966 | of the same name. On unconnected sockets you must specify a | |
19799a22 | 3967 | destination to send TO, in which case it does a C C<sendto>. Returns |
a0d0e21e | 3968 | the number of characters sent, or the undefined value if there is an |
2b5ab1e7 | 3969 | error. The C system call sendmsg(2) is currently unimplemented. |
4633a7c4 | 3970 | See L<perlipc/"UDP: Message Passing"> for examples. |
a0d0e21e LW |
3971 | |
3972 | =item setpgrp PID,PGRP | |
3973 | ||
7660c0ab | 3974 | Sets the current process group for the specified PID, C<0> for the current |
a0d0e21e | 3975 | process. Will produce a fatal error if used on a machine that doesn't |
81777298 GS |
3976 | implement POSIX setpgid(2) or BSD setpgrp(2). If the arguments are omitted, |
3977 | it defaults to C<0,0>. Note that the BSD 4.2 version of C<setpgrp> does not | |
3978 | accept any arguments, so only C<setpgrp(0,0)> is portable. See also | |
3979 | C<POSIX::setsid()>. | |
a0d0e21e LW |
3980 | |
3981 | =item setpriority WHICH,WHO,PRIORITY | |
3982 | ||
3983 | Sets the current priority for a process, a process group, or a user. | |
f86cebdf GS |
3984 | (See setpriority(2).) Will produce a fatal error if used on a machine |
3985 | that doesn't implement setpriority(2). | |
a0d0e21e LW |
3986 | |
3987 | =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL | |
3988 | ||
3989 | Sets the socket option requested. Returns undefined if there is an | |
7660c0ab | 3990 | error. OPTVAL may be specified as C<undef> if you don't want to pass an |
a0d0e21e LW |
3991 | argument. |
3992 | ||
3993 | =item shift ARRAY | |
3994 | ||
3995 | =item shift | |
3996 | ||
3997 | Shifts the first value of the array off and returns it, shortening the | |
3998 | array by 1 and moving everything down. If there are no elements in the | |
3999 | array, returns the undefined value. If ARRAY is omitted, shifts the | |
7660c0ab A |
4000 | C<@_> array within the lexical scope of subroutines and formats, and the |
4001 | C<@ARGV> array at file scopes or within the lexical scopes established by | |
7d30b5c4 | 4002 | the C<eval ''>, C<BEGIN {}>, C<INIT {}>, C<CHECK {}>, and C<END {}> |
4f25aa18 GS |
4003 | constructs. |
4004 | ||
4375e838 | 4005 | See also C<unshift>, C<push>, and C<pop>. C<shift()> and C<unshift> do the |
19799a22 | 4006 | same thing to the left end of an array that C<pop> and C<push> do to the |
977336f5 | 4007 | right end. |
a0d0e21e LW |
4008 | |
4009 | =item shmctl ID,CMD,ARG | |
4010 | ||
0ade1984 JH |
4011 | Calls the System V IPC function shmctl. You'll probably have to say |
4012 | ||
4013 | use IPC::SysV; | |
4014 | ||
7660c0ab A |
4015 | first to get the correct constant definitions. If CMD is C<IPC_STAT>, |
4016 | then ARG must be a variable which will hold the returned C<shmid_ds> | |
4017 | structure. Returns like ioctl: the undefined value for error, "C<0> but | |
0ade1984 | 4018 | true" for zero, or the actual return value otherwise. |
7660c0ab | 4019 | See also C<IPC::SysV> documentation. |
a0d0e21e LW |
4020 | |
4021 | =item shmget KEY,SIZE,FLAGS | |
4022 | ||
4023 | Calls the System V IPC function shmget. Returns the shared memory | |
4024 | segment id, or the undefined value if there is an error. | |
7660c0ab | 4025 | See also C<IPC::SysV> documentation. |
a0d0e21e LW |
4026 | |
4027 | =item shmread ID,VAR,POS,SIZE | |
4028 | ||
4029 | =item shmwrite ID,STRING,POS,SIZE | |
4030 | ||
4031 | Reads or writes the System V shared memory segment ID starting at | |
4032 | position POS for size SIZE by attaching to it, copying in/out, and | |
5a964f20 | 4033 | detaching from it. When reading, VAR must be a variable that will |
a0d0e21e LW |
4034 | hold the data read. When writing, if STRING is too long, only SIZE |
4035 | bytes are used; if STRING is too short, nulls are written to fill out | |
19799a22 | 4036 | SIZE bytes. Return true if successful, or false if there is an error. |
d929ce6f JH |
4037 | shmread() taints the variable. See also C<IPC::SysV> documentation and |
4038 | the C<IPC::Shareable> module from CPAN. | |
a0d0e21e LW |
4039 | |
4040 | =item shutdown SOCKET,HOW | |
4041 | ||
4042 | Shuts down a socket connection in the manner indicated by HOW, which | |
4043 | has the same interpretation as in the system call of the same name. | |
4044 | ||
f86cebdf GS |
4045 | shutdown(SOCKET, 0); # I/we have stopped reading data |
4046 | shutdown(SOCKET, 1); # I/we have stopped writing data | |
4047 | shutdown(SOCKET, 2); # I/we have stopped using this socket | |
5a964f20 TC |
4048 | |
4049 | This is useful with sockets when you want to tell the other | |
4050 | side you're done writing but not done reading, or vice versa. | |
4051 | It's also a more insistent form of close because it also | |
19799a22 | 4052 | disables the file descriptor in any forked copies in other |
5a964f20 TC |
4053 | processes. |
4054 | ||
a0d0e21e LW |
4055 | =item sin EXPR |
4056 | ||
54310121 | 4057 | =item sin |
bbce6d69 | 4058 | |
a0d0e21e | 4059 | Returns the sine of EXPR (expressed in radians). If EXPR is omitted, |
7660c0ab | 4060 | returns sine of C<$_>. |
a0d0e21e | 4061 | |
ca6e1c26 | 4062 | For the inverse sine operation, you may use the C<Math::Trig::asin> |
28757baa | 4063 | function, or use this relation: |
4064 | ||
4065 | sub asin { atan2($_[0], sqrt(1 - $_[0] * $_[0])) } | |
4066 | ||
a0d0e21e LW |
4067 | =item sleep EXPR |
4068 | ||
4069 | =item sleep | |
4070 | ||
4071 | Causes the script to sleep for EXPR seconds, or forever if no EXPR. | |
7660c0ab | 4072 | May be interrupted if the process receives a signal such as C<SIGALRM>. |
1d3434b8 | 4073 | Returns the number of seconds actually slept. You probably cannot |
19799a22 GS |
4074 | mix C<alarm> and C<sleep> calls, because C<sleep> is often implemented |
4075 | using C<alarm>. | |
a0d0e21e LW |
4076 | |
4077 | On some older systems, it may sleep up to a full second less than what | |
4078 | you requested, depending on how it counts seconds. Most modern systems | |
5a964f20 TC |
4079 | always sleep the full amount. They may appear to sleep longer than that, |
4080 | however, because your process might not be scheduled right away in a | |
4081 | busy multitasking system. | |
a0d0e21e | 4082 | |
cb1a09d0 | 4083 | For delays of finer granularity than one second, you may use Perl's |
68f8bed4 JH |
4084 | C<syscall> interface to access setitimer(2) if your system supports |
4085 | it, or else see L</select> above. The Time::HiRes module from CPAN | |
4086 | may also help. | |
cb1a09d0 | 4087 | |
19799a22 | 4088 | See also the POSIX module's C<sigpause> function. |
5f05dabc | 4089 | |
a0d0e21e LW |
4090 | =item socket SOCKET,DOMAIN,TYPE,PROTOCOL |
4091 | ||
4092 | Opens a socket of the specified kind and attaches it to filehandle | |
19799a22 GS |
4093 | SOCKET. DOMAIN, TYPE, and PROTOCOL are specified the same as for |
4094 | the system call of the same name. You should C<use Socket> first | |
4095 | to get the proper definitions imported. See the examples in | |
4096 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 4097 | |
8d2a6795 GS |
4098 | On systems that support a close-on-exec flag on files, the flag will |
4099 | be set for the newly opened file descriptor, as determined by the | |
4100 | value of $^F. See L<perlvar/$^F>. | |
4101 | ||
a0d0e21e LW |
4102 | =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL |
4103 | ||
4104 | Creates an unnamed pair of sockets in the specified domain, of the | |
5f05dabc | 4105 | specified type. DOMAIN, TYPE, and PROTOCOL are specified the same as |
a0d0e21e | 4106 | for the system call of the same name. If unimplemented, yields a fatal |
19799a22 | 4107 | error. Returns true if successful. |
a0d0e21e | 4108 | |
8d2a6795 GS |
4109 | On systems that support a close-on-exec flag on files, the flag will |
4110 | be set for the newly opened file descriptors, as determined by the value | |
4111 | of $^F. See L<perlvar/$^F>. | |
4112 | ||
19799a22 | 4113 | Some systems defined C<pipe> in terms of C<socketpair>, in which a call |
5a964f20 TC |
4114 | to C<pipe(Rdr, Wtr)> is essentially: |
4115 | ||
4116 | use Socket; | |
4117 | socketpair(Rdr, Wtr, AF_UNIX, SOCK_STREAM, PF_UNSPEC); | |
4118 | shutdown(Rdr, 1); # no more writing for reader | |
4119 | shutdown(Wtr, 0); # no more reading for writer | |
4120 | ||
4121 | See L<perlipc> for an example of socketpair use. | |
4122 | ||
a0d0e21e LW |
4123 | =item sort SUBNAME LIST |
4124 | ||
4125 | =item sort BLOCK LIST | |
4126 | ||
4127 | =item sort LIST | |
4128 | ||
2f9daede | 4129 | Sorts the LIST and returns the sorted list value. If SUBNAME or BLOCK |
19799a22 | 4130 | is omitted, C<sort>s in standard string comparison order. If SUBNAME is |
2f9daede | 4131 | specified, it gives the name of a subroutine that returns an integer |
7660c0ab | 4132 | less than, equal to, or greater than C<0>, depending on how the elements |
61eff3bc | 4133 | of the list are to be ordered. (The C<< <=> >> and C<cmp> |
2f9daede | 4134 | operators are extremely useful in such routines.) SUBNAME may be a |
1d3434b8 GS |
4135 | scalar variable name (unsubscripted), in which case the value provides |
4136 | the name of (or a reference to) the actual subroutine to use. In place | |
4137 | of a SUBNAME, you can provide a BLOCK as an anonymous, in-line sort | |
4138 | subroutine. | |
a0d0e21e | 4139 | |
43481408 | 4140 | If the subroutine's prototype is C<($$)>, the elements to be compared |
f9a36357 GS |
4141 | are passed by reference in C<@_>, as for a normal subroutine. This is |
4142 | slower than unprototyped subroutines, where the elements to be | |
4143 | compared are passed into the subroutine | |
43481408 GS |
4144 | as the package global variables $a and $b (see example below). Note that |
4145 | in the latter case, it is usually counter-productive to declare $a and | |
4146 | $b as lexicals. | |
4147 | ||
4148 | In either case, the subroutine may not be recursive. The values to be | |
4149 | compared are always passed by reference, so don't modify them. | |
a0d0e21e | 4150 | |
0a753a76 | 4151 | You also cannot exit out of the sort block or subroutine using any of the |
19799a22 | 4152 | loop control operators described in L<perlsyn> or with C<goto>. |
0a753a76 | 4153 | |
a034a98d DD |
4154 | When C<use locale> is in effect, C<sort LIST> sorts LIST according to the |
4155 | current collation locale. See L<perllocale>. | |
4156 | ||
a0d0e21e LW |
4157 | Examples: |
4158 | ||
4159 | # sort lexically | |
4160 | @articles = sort @files; | |
4161 | ||
4162 | # same thing, but with explicit sort routine | |
4163 | @articles = sort {$a cmp $b} @files; | |
4164 | ||
cb1a09d0 | 4165 | # now case-insensitively |
54310121 | 4166 | @articles = sort {uc($a) cmp uc($b)} @files; |
cb1a09d0 | 4167 | |
a0d0e21e LW |
4168 | # same thing in reversed order |
4169 | @articles = sort {$b cmp $a} @files; | |
4170 | ||
4171 | # sort numerically ascending | |
4172 | @articles = sort {$a <=> $b} @files; | |
4173 | ||
4174 | # sort numerically descending | |
4175 | @articles = sort {$b <=> $a} @files; | |
4176 | ||
19799a22 GS |
4177 | # this sorts the %age hash by value instead of key |
4178 | # using an in-line function | |
4179 | @eldest = sort { $age{$b} <=> $age{$a} } keys %age; | |
4180 | ||
a0d0e21e LW |
4181 | # sort using explicit subroutine name |
4182 | sub byage { | |
2f9daede | 4183 | $age{$a} <=> $age{$b}; # presuming numeric |
a0d0e21e LW |
4184 | } |
4185 | @sortedclass = sort byage @class; | |
4186 | ||
19799a22 GS |
4187 | sub backwards { $b cmp $a } |
4188 | @harry = qw(dog cat x Cain Abel); | |
4189 | @george = qw(gone chased yz Punished Axed); | |
a0d0e21e LW |
4190 | print sort @harry; |
4191 | # prints AbelCaincatdogx | |
4192 | print sort backwards @harry; | |
4193 | # prints xdogcatCainAbel | |
4194 | print sort @george, 'to', @harry; | |
4195 | # prints AbelAxedCainPunishedcatchaseddoggonetoxyz | |
4196 | ||
54310121 | 4197 | # inefficiently sort by descending numeric compare using |
4198 | # the first integer after the first = sign, or the | |
cb1a09d0 AD |
4199 | # whole record case-insensitively otherwise |
4200 | ||
4201 | @new = sort { | |
4202 | ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0] | |
4203 | || | |
4204 | uc($a) cmp uc($b) | |
4205 | } @old; | |
4206 | ||
4207 | # same thing, but much more efficiently; | |
4208 | # we'll build auxiliary indices instead | |
4209 | # for speed | |
4210 | @nums = @caps = (); | |
54310121 | 4211 | for (@old) { |
cb1a09d0 AD |
4212 | push @nums, /=(\d+)/; |
4213 | push @caps, uc($_); | |
54310121 | 4214 | } |
cb1a09d0 AD |
4215 | |
4216 | @new = @old[ sort { | |
4217 | $nums[$b] <=> $nums[$a] | |
4218 | || | |
4219 | $caps[$a] cmp $caps[$b] | |
4220 | } 0..$#old | |
4221 | ]; | |
4222 | ||
19799a22 | 4223 | # same thing, but without any temps |
cb1a09d0 | 4224 | @new = map { $_->[0] } |
19799a22 GS |
4225 | sort { $b->[1] <=> $a->[1] |
4226 | || | |
4227 | $a->[2] cmp $b->[2] | |
4228 | } map { [$_, /=(\d+)/, uc($_)] } @old; | |
61eff3bc | 4229 | |
43481408 GS |
4230 | # using a prototype allows you to use any comparison subroutine |
4231 | # as a sort subroutine (including other package's subroutines) | |
4232 | package other; | |
4233 | sub backwards ($$) { $_[1] cmp $_[0]; } # $a and $b are not set here | |
4234 | ||
4235 | package main; | |
4236 | @new = sort other::backwards @old; | |
cb1a09d0 | 4237 | |
19799a22 GS |
4238 | If you're using strict, you I<must not> declare $a |
4239 | and $b as lexicals. They are package globals. That means | |
cb1a09d0 AD |
4240 | if you're in the C<main> package, it's |
4241 | ||
4242 | @articles = sort {$main::b <=> $main::a} @files; | |
4243 | ||
4244 | or just | |
4245 | ||
4246 | @articles = sort {$::b <=> $::a} @files; | |
4247 | ||
4248 | but if you're in the C<FooPack> package, it's | |
4249 | ||
4250 | @articles = sort {$FooPack::b <=> $FooPack::a} @files; | |
4251 | ||
55497cff | 4252 | The comparison function is required to behave. If it returns |
7660c0ab A |
4253 | inconsistent results (sometimes saying C<$x[1]> is less than C<$x[2]> and |
4254 | sometimes saying the opposite, for example) the results are not | |
4255 | well-defined. | |
55497cff | 4256 | |
a0d0e21e LW |
4257 | =item splice ARRAY,OFFSET,LENGTH,LIST |
4258 | ||
4259 | =item splice ARRAY,OFFSET,LENGTH | |
4260 | ||
4261 | =item splice ARRAY,OFFSET | |
4262 | ||
453f9044 GS |
4263 | =item splice ARRAY |
4264 | ||
a0d0e21e | 4265 | Removes the elements designated by OFFSET and LENGTH from an array, and |
5a964f20 TC |
4266 | replaces them with the elements of LIST, if any. In list context, |
4267 | returns the elements removed from the array. In scalar context, | |
43051805 | 4268 | returns the last element removed, or C<undef> if no elements are |
48cdf507 | 4269 | removed. The array grows or shrinks as necessary. |
19799a22 | 4270 | If OFFSET is negative then it starts that far from the end of the array. |
48cdf507 | 4271 | If LENGTH is omitted, removes everything from OFFSET onward. |
453f9044 GS |
4272 | If LENGTH is negative, leaves that many elements off the end of the array. |
4273 | If both OFFSET and LENGTH are omitted, removes everything. | |
4274 | ||
48cdf507 | 4275 | The following equivalences hold (assuming C<$[ == 0>): |
a0d0e21e | 4276 | |
48cdf507 | 4277 | push(@a,$x,$y) splice(@a,@a,0,$x,$y) |
a0d0e21e LW |
4278 | pop(@a) splice(@a,-1) |
4279 | shift(@a) splice(@a,0,1) | |
4280 | unshift(@a,$x,$y) splice(@a,0,0,$x,$y) | |
5a964f20 | 4281 | $a[$x] = $y splice(@a,$x,1,$y) |
a0d0e21e LW |
4282 | |
4283 | Example, assuming array lengths are passed before arrays: | |
4284 | ||
4285 | sub aeq { # compare two list values | |
5a964f20 TC |
4286 | my(@a) = splice(@_,0,shift); |
4287 | my(@b) = splice(@_,0,shift); | |
a0d0e21e LW |
4288 | return 0 unless @a == @b; # same len? |
4289 | while (@a) { | |
4290 | return 0 if pop(@a) ne pop(@b); | |
4291 | } | |
4292 | return 1; | |
4293 | } | |
4294 | if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... } | |
4295 | ||
4296 | =item split /PATTERN/,EXPR,LIMIT | |
4297 | ||
4298 | =item split /PATTERN/,EXPR | |
4299 | ||
4300 | =item split /PATTERN/ | |
4301 | ||
4302 | =item split | |
4303 | ||
19799a22 | 4304 | Splits a string into a list of strings and returns that list. By default, |
5a964f20 | 4305 | empty leading fields are preserved, and empty trailing ones are deleted. |
a0d0e21e | 4306 | |
5a964f20 | 4307 | If not in list context, returns the number of fields found and splits into |
7660c0ab | 4308 | the C<@_> array. (In list context, you can force the split into C<@_> by |
1d2dff63 | 4309 | using C<??> as the pattern delimiters, but it still returns the list |
7660c0ab | 4310 | value.) The use of implicit split to C<@_> is deprecated, however, because |
5a964f20 | 4311 | it clobbers your subroutine arguments. |
a0d0e21e | 4312 | |
7660c0ab | 4313 | If EXPR is omitted, splits the C<$_> string. If PATTERN is also omitted, |
4633a7c4 LW |
4314 | splits on whitespace (after skipping any leading whitespace). Anything |
4315 | matching PATTERN is taken to be a delimiter separating the fields. (Note | |
fb73857a | 4316 | that the delimiter may be longer than one character.) |
4317 | ||
5a964f20 | 4318 | If LIMIT is specified and positive, splits into no more than that |
7b8d334a GS |
4319 | many fields (though it may split into fewer). If LIMIT is unspecified |
4320 | or zero, trailing null fields are stripped (which potential users | |
19799a22 | 4321 | of C<pop> would do well to remember). If LIMIT is negative, it is |
fb73857a | 4322 | treated as if an arbitrarily large LIMIT had been specified. |
a0d0e21e LW |
4323 | |
4324 | A pattern matching the null string (not to be confused with | |
748a9306 | 4325 | a null pattern C<//>, which is just one member of the set of patterns |
a0d0e21e LW |
4326 | matching a null string) will split the value of EXPR into separate |
4327 | characters at each point it matches that way. For example: | |
4328 | ||
4329 | print join(':', split(/ */, 'hi there')); | |
4330 | ||
4331 | produces the output 'h:i:t:h:e:r:e'. | |
4332 | ||
5f05dabc | 4333 | The LIMIT parameter can be used to split a line partially |
a0d0e21e LW |
4334 | |
4335 | ($login, $passwd, $remainder) = split(/:/, $_, 3); | |
4336 | ||
4337 | When assigning to a list, if LIMIT is omitted, Perl supplies a LIMIT | |
4338 | one larger than the number of variables in the list, to avoid | |
4339 | unnecessary work. For the list above LIMIT would have been 4 by | |
4340 | default. In time critical applications it behooves you not to split | |
4341 | into more fields than you really need. | |
4342 | ||
19799a22 | 4343 | If the PATTERN contains parentheses, additional list elements are |
a0d0e21e LW |
4344 | created from each matching substring in the delimiter. |
4345 | ||
da0045b7 | 4346 | split(/([,-])/, "1-10,20", 3); |
a0d0e21e LW |
4347 | |
4348 | produces the list value | |
4349 | ||
4350 | (1, '-', 10, ',', 20) | |
4351 | ||
19799a22 | 4352 | If you had the entire header of a normal Unix email message in $header, |
4633a7c4 LW |
4353 | you could split it up into fields and their values this way: |
4354 | ||
4355 | $header =~ s/\n\s+/ /g; # fix continuation lines | |
fb73857a | 4356 | %hdrs = (UNIX_FROM => split /^(\S*?):\s*/m, $header); |
4633a7c4 | 4357 | |
a0d0e21e LW |
4358 | The pattern C</PATTERN/> may be replaced with an expression to specify |
4359 | patterns that vary at runtime. (To do runtime compilation only once, | |
748a9306 LW |
4360 | use C</$variable/o>.) |
4361 | ||
4362 | As a special case, specifying a PATTERN of space (C<' '>) will split on | |
19799a22 | 4363 | white space just as C<split> with no arguments does. Thus, C<split(' ')> can |
748a9306 LW |
4364 | be used to emulate B<awk>'s default behavior, whereas C<split(/ /)> |
4365 | will give you as many null initial fields as there are leading spaces. | |
19799a22 GS |
4366 | A C<split> on C</\s+/> is like a C<split(' ')> except that any leading |
4367 | whitespace produces a null first field. A C<split> with no arguments | |
748a9306 | 4368 | really does a C<split(' ', $_)> internally. |
a0d0e21e LW |
4369 | |
4370 | Example: | |
4371 | ||
5a964f20 TC |
4372 | open(PASSWD, '/etc/passwd'); |
4373 | while (<PASSWD>) { | |
f86cebdf GS |
4374 | ($login, $passwd, $uid, $gid, |
4375 | $gcos, $home, $shell) = split(/:/); | |
5a964f20 | 4376 | #... |
a0d0e21e LW |
4377 | } |
4378 | ||
19799a22 | 4379 | (Note that $shell above will still have a newline on it. See L</chop>, |
a0d0e21e LW |
4380 | L</chomp>, and L</join>.) |
4381 | ||
5f05dabc | 4382 | =item sprintf FORMAT, LIST |
a0d0e21e | 4383 | |
19799a22 GS |
4384 | Returns a string formatted by the usual C<printf> conventions of the |
4385 | C library function C<sprintf>. See L<sprintf(3)> or L<printf(3)> | |
74a77017 CS |
4386 | on your system for an explanation of the general principles. |
4387 | ||
19799a22 GS |
4388 | Perl does its own C<sprintf> formatting--it emulates the C |
4389 | function C<sprintf>, but it doesn't use it (except for floating-point | |
74a77017 | 4390 | numbers, and even then only the standard modifiers are allowed). As a |
19799a22 | 4391 | result, any non-standard extensions in your local C<sprintf> are not |
74a77017 CS |
4392 | available from Perl. |
4393 | ||
19799a22 | 4394 | Perl's C<sprintf> permits the following universally-known conversions: |
74a77017 CS |
4395 | |
4396 | %% a percent sign | |
4397 | %c a character with the given number | |
4398 | %s a string | |
4399 | %d a signed integer, in decimal | |
4400 | %u an unsigned integer, in decimal | |
4401 | %o an unsigned integer, in octal | |
4402 | %x an unsigned integer, in hexadecimal | |
4403 | %e a floating-point number, in scientific notation | |
4404 | %f a floating-point number, in fixed decimal notation | |
4405 | %g a floating-point number, in %e or %f notation | |
4406 | ||
1b3f7d21 | 4407 | In addition, Perl permits the following widely-supported conversions: |
74a77017 | 4408 | |
74a77017 CS |
4409 | %X like %x, but using upper-case letters |
4410 | %E like %e, but using an upper-case "E" | |
4411 | %G like %g, but with an upper-case "E" (if applicable) | |
4f19785b | 4412 | %b an unsigned integer, in binary |
74a77017 | 4413 | %p a pointer (outputs the Perl value's address in hexadecimal) |
1b3f7d21 CS |
4414 | %n special: *stores* the number of characters output so far |
4415 | into the next variable in the parameter list | |
74a77017 | 4416 | |
1b3f7d21 CS |
4417 | Finally, for backward (and we do mean "backward") compatibility, Perl |
4418 | permits these unnecessary but widely-supported conversions: | |
74a77017 | 4419 | |
1b3f7d21 | 4420 | %i a synonym for %d |
74a77017 CS |
4421 | %D a synonym for %ld |
4422 | %U a synonym for %lu | |
4423 | %O a synonym for %lo | |
4424 | %F a synonym for %f | |
4425 | ||
4426 | Perl permits the following universally-known flags between the C<%> | |
4427 | and the conversion letter: | |
4428 | ||
4429 | space prefix positive number with a space | |
4430 | + prefix positive number with a plus sign | |
4431 | - left-justify within the field | |
4432 | 0 use zeros, not spaces, to right-justify | |
a3cb178b | 4433 | # prefix non-zero octal with "0", non-zero hex with "0x" |
74a77017 | 4434 | number minimum field width |
f86cebdf GS |
4435 | .number "precision": digits after decimal point for |
4436 | floating-point, max length for string, minimum length | |
4437 | for integer | |
74a77017 | 4438 | l interpret integer as C type "long" or "unsigned long" |
74a77017 | 4439 | h interpret integer as C type "short" or "unsigned short" |
661cc6a6 | 4440 | If no flags, interpret integer as C type "int" or "unsigned" |
74a77017 | 4441 | |
4628e4f8 | 4442 | There are also two Perl-specific flags: |
74a77017 CS |
4443 | |
4444 | V interpret integer as Perl's standard integer type | |
b22c7a20 GS |
4445 | v interpret string as a vector of integers, output as |
4446 | numbers separated either by dots, or by an arbitrary | |
4447 | string received from the argument list when the flag | |
4448 | is preceded by C<*> | |
74a77017 | 4449 | |
19799a22 | 4450 | Where a number would appear in the flags, an asterisk (C<*>) may be |
74a77017 CS |
4451 | used instead, in which case Perl uses the next item in the parameter |
4452 | list as the given number (that is, as the field width or precision). | |
19799a22 GS |
4453 | If a field width obtained through C<*> is negative, it has the same |
4454 | effect as the C<-> flag: left-justification. | |
74a77017 | 4455 | |
b22c7a20 GS |
4456 | The C<v> flag is useful for displaying ordinal values of characters |
4457 | in arbitrary strings: | |
4458 | ||
4459 | printf "version is v%vd\n", $^V; # Perl's version | |
4460 | printf "address is %*vX\n", ":", $addr; # IPv6 address | |
dd629d5b | 4461 | printf "bits are %*vb\n", " ", $bits; # random bitstring |
b22c7a20 | 4462 | |
74a77017 CS |
4463 | If C<use locale> is in effect, the character used for the decimal |
4464 | point in formatted real numbers is affected by the LC_NUMERIC locale. | |
4465 | See L<perllocale>. | |
a0d0e21e | 4466 | |
07158430 | 4467 | If Perl understands "quads" (64-bit integers) (this requires |
a8764340 GS |
4468 | either that the platform natively support quads or that Perl |
4469 | be specifically compiled to support quads), the characters | |
07158430 JH |
4470 | |
4471 | d u o x X b i D U O | |
4472 | ||
4473 | print quads, and they may optionally be preceded by | |
4474 | ||
4475 | ll L q | |
4476 | ||
4477 | For example | |
4478 | ||
4479 | %lld %16LX %qo | |
4480 | ||
46465067 | 4481 | You can find out whether your Perl supports quads via L<Config>: |
07158430 JH |
4482 | |
4483 | use Config; | |
10cc9d2a | 4484 | ($Config{use64bitint} eq 'define' || $Config{longsize} == 8) && |
46465067 | 4485 | print "quads\n"; |
07158430 JH |
4486 | |
4487 | If Perl understands "long doubles" (this requires that the platform | |
a8764340 | 4488 | support long doubles), the flags |
07158430 JH |
4489 | |
4490 | e f g E F G | |
4491 | ||
4492 | may optionally be preceded by | |
4493 | ||
4494 | ll L | |
4495 | ||
4496 | For example | |
4497 | ||
4498 | %llf %Lg | |
4499 | ||
4500 | You can find out whether your Perl supports long doubles via L<Config>: | |
4501 | ||
4502 | use Config; | |
46465067 | 4503 | $Config{d_longdbl} eq 'define' && print "long doubles\n"; |
07158430 | 4504 | |
a0d0e21e LW |
4505 | =item sqrt EXPR |
4506 | ||
54310121 | 4507 | =item sqrt |
bbce6d69 | 4508 | |
a0d0e21e | 4509 | Return the square root of EXPR. If EXPR is omitted, returns square |
2b5ab1e7 TC |
4510 | root of C<$_>. Only works on non-negative operands, unless you've |
4511 | loaded the standard Math::Complex module. | |
4512 | ||
4513 | use Math::Complex; | |
4514 | print sqrt(-2); # prints 1.4142135623731i | |
a0d0e21e LW |
4515 | |
4516 | =item srand EXPR | |
4517 | ||
93dc8474 CS |
4518 | =item srand |
4519 | ||
19799a22 | 4520 | Sets the random number seed for the C<rand> operator. If EXPR is |
73c60299 RS |
4521 | omitted, uses a semi-random value supplied by the kernel (if it supports |
4522 | the F</dev/urandom> device) or based on the current time and process | |
93dc8474 | 4523 | ID, among other things. In versions of Perl prior to 5.004 the default |
19799a22 | 4524 | seed was just the current C<time>. This isn't a particularly good seed, |
93dc8474 | 4525 | so many old programs supply their own seed value (often C<time ^ $$> or |
61eff3bc | 4526 | C<time ^ ($$ + ($$ << 15))>), but that isn't necessary any more. |
93dc8474 | 4527 | |
19799a22 | 4528 | In fact, it's usually not necessary to call C<srand> at all, because if |
93dc8474 | 4529 | it is not called explicitly, it is called implicitly at the first use of |
19799a22 | 4530 | the C<rand> operator. However, this was not the case in version of Perl |
2f9daede | 4531 | before 5.004, so if your script will run under older Perl versions, it |
19799a22 | 4532 | should call C<srand>. |
93dc8474 | 4533 | |
2f9daede TP |
4534 | Note that you need something much more random than the default seed for |
4535 | cryptographic purposes. Checksumming the compressed output of one or more | |
4536 | rapidly changing operating system status programs is the usual method. For | |
4537 | example: | |
28757baa | 4538 | |
4539 | srand (time ^ $$ ^ unpack "%L*", `ps axww | gzip`); | |
4540 | ||
7660c0ab | 4541 | If you're particularly concerned with this, see the C<Math::TrulyRandom> |
0078ec44 RS |
4542 | module in CPAN. |
4543 | ||
19799a22 | 4544 | Do I<not> call C<srand> multiple times in your program unless you know |
28757baa | 4545 | exactly what you're doing and why you're doing it. The point of the |
19799a22 | 4546 | function is to "seed" the C<rand> function so that C<rand> can produce |
28757baa | 4547 | a different sequence each time you run your program. Just do it once at the |
19799a22 | 4548 | top of your program, or you I<won't> get random numbers out of C<rand>! |
28757baa | 4549 | |
54310121 | 4550 | Frequently called programs (like CGI scripts) that simply use |
28757baa | 4551 | |
4552 | time ^ $$ | |
4553 | ||
54310121 | 4554 | for a seed can fall prey to the mathematical property that |
28757baa | 4555 | |
4556 | a^b == (a+1)^(b+1) | |
4557 | ||
0078ec44 | 4558 | one-third of the time. So don't do that. |
f86702cc | 4559 | |
a0d0e21e LW |
4560 | =item stat FILEHANDLE |
4561 | ||
4562 | =item stat EXPR | |
4563 | ||
54310121 | 4564 | =item stat |
bbce6d69 | 4565 | |
1d2dff63 GS |
4566 | Returns a 13-element list giving the status info for a file, either |
4567 | the file opened via FILEHANDLE, or named by EXPR. If EXPR is omitted, | |
7660c0ab | 4568 | it stats C<$_>. Returns a null list if the stat fails. Typically used |
1d2dff63 | 4569 | as follows: |
a0d0e21e LW |
4570 | |
4571 | ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size, | |
4572 | $atime,$mtime,$ctime,$blksize,$blocks) | |
4573 | = stat($filename); | |
4574 | ||
54310121 | 4575 | Not all fields are supported on all filesystem types. Here are the |
c07a80fd | 4576 | meaning of the fields: |
4577 | ||
54310121 | 4578 | 0 dev device number of filesystem |
4579 | 1 ino inode number | |
4580 | 2 mode file mode (type and permissions) | |
4581 | 3 nlink number of (hard) links to the file | |
4582 | 4 uid numeric user ID of file's owner | |
4583 | 5 gid numeric group ID of file's owner | |
4584 | 6 rdev the device identifier (special files only) | |
4585 | 7 size total size of file, in bytes | |
1c74f1bd GS |
4586 | 8 atime last access time in seconds since the epoch |
4587 | 9 mtime last modify time in seconds since the epoch | |
4588 | 10 ctime inode change time (NOT creation time!) in seconds since the epoch | |
54310121 | 4589 | 11 blksize preferred block size for file system I/O |
4590 | 12 blocks actual number of blocks allocated | |
c07a80fd | 4591 | |
4592 | (The epoch was at 00:00 January 1, 1970 GMT.) | |
4593 | ||
a0d0e21e LW |
4594 | If stat is passed the special filehandle consisting of an underline, no |
4595 | stat is done, but the current contents of the stat structure from the | |
4596 | last stat or filetest are returned. Example: | |
4597 | ||
4598 | if (-x $file && (($d) = stat(_)) && $d < 0) { | |
4599 | print "$file is executable NFS file\n"; | |
4600 | } | |
4601 | ||
ca6e1c26 JH |
4602 | (This works on machines only for which the device number is negative |
4603 | under NFS.) | |
a0d0e21e | 4604 | |
2b5ab1e7 TC |
4605 | Because the mode contains both the file type and its permissions, you |
4606 | should mask off the file type portion and (s)printf using a C<"%o"> | |
4607 | if you want to see the real permissions. | |
4608 | ||
4609 | $mode = (stat($filename))[2]; | |
4610 | printf "Permissions are %04o\n", $mode & 07777; | |
4611 | ||
19799a22 | 4612 | In scalar context, C<stat> returns a boolean value indicating success |
1d2dff63 GS |
4613 | or failure, and, if successful, sets the information associated with |
4614 | the special filehandle C<_>. | |
4615 | ||
2b5ab1e7 TC |
4616 | The File::stat module provides a convenient, by-name access mechanism: |
4617 | ||
4618 | use File::stat; | |
4619 | $sb = stat($filename); | |
4620 | printf "File is %s, size is %s, perm %04o, mtime %s\n", | |
4621 | $filename, $sb->size, $sb->mode & 07777, | |
4622 | scalar localtime $sb->mtime; | |
4623 | ||
ca6e1c26 JH |
4624 | You can import symbolic mode constants (C<S_IF*>) and functions |
4625 | (C<S_IS*>) from the Fcntl module: | |
4626 | ||
4627 | use Fcntl ':mode'; | |
4628 | ||
4629 | $mode = (stat($filename))[2]; | |
4630 | ||
4631 | $user_rwx = ($mode & S_IRWXU) >> 6; | |
4632 | $group_read = ($mode & S_IRGRP) >> 3; | |
4633 | $other_execute = $mode & S_IXOTH; | |
4634 | ||
4635 | printf "Permissions are %04o\n", S_ISMODE($mode), "\n"; | |
4636 | ||
4637 | $is_setuid = $mode & S_ISUID; | |
4638 | $is_setgid = S_ISDIR($mode); | |
4639 | ||
4640 | You could write the last two using the C<-u> and C<-d> operators. | |
4641 | The commonly available S_IF* constants are | |
4642 | ||
4643 | # Permissions: read, write, execute, for user, group, others. | |
4644 | ||
4645 | S_IRWXU S_IRUSR S_IWUSR S_IXUSR | |
4646 | S_IRWXG S_IRGRP S_IWGRP S_IXGRP | |
4647 | S_IRWXO S_IROTH S_IWOTH S_IXOTH | |
61eff3bc | 4648 | |
ca6e1c26 JH |
4649 | # Setuid/Setgid/Stickiness. |
4650 | ||
4651 | S_ISUID S_ISGID S_ISVTX S_ISTXT | |
4652 | ||
4653 | # File types. Not necessarily all are available on your system. | |
4654 | ||
4655 | S_IFREG S_IFDIR S_IFLNK S_IFBLK S_ISCHR S_IFIFO S_IFSOCK S_IFWHT S_ENFMT | |
4656 | ||
4657 | # The following are compatibility aliases for S_IRUSR, S_IWUSR, S_IXUSR. | |
4658 | ||
4659 | S_IREAD S_IWRITE S_IEXEC | |
4660 | ||
4661 | and the S_IF* functions are | |
4662 | ||
4375e838 | 4663 | S_IFMODE($mode) the part of $mode containing the permission bits |
ca6e1c26 JH |
4664 | and the setuid/setgid/sticky bits |
4665 | ||
4666 | S_IFMT($mode) the part of $mode containing the file type | |
4667 | which can be bit-anded with e.g. S_IFREG | |
4668 | or with the following functions | |
4669 | ||
4670 | # The operators -f, -d, -l, -b, -c, -p, and -s. | |
4671 | ||
4672 | S_ISREG($mode) S_ISDIR($mode) S_ISLNK($mode) | |
4673 | S_ISBLK($mode) S_ISCHR($mode) S_ISFIFO($mode) S_ISSOCK($mode) | |
4674 | ||
4675 | # No direct -X operator counterpart, but for the first one | |
4676 | # the -g operator is often equivalent. The ENFMT stands for | |
4677 | # record flocking enforcement, a platform-dependent feature. | |
4678 | ||
4679 | S_ISENFMT($mode) S_ISWHT($mode) | |
4680 | ||
4681 | See your native chmod(2) and stat(2) documentation for more details | |
4682 | about the S_* constants. | |
4683 | ||
a0d0e21e LW |
4684 | =item study SCALAR |
4685 | ||
4686 | =item study | |
4687 | ||
184e9718 | 4688 | Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of |
a0d0e21e LW |
4689 | doing many pattern matches on the string before it is next modified. |
4690 | This may or may not save time, depending on the nature and number of | |
4691 | patterns you are searching on, and on the distribution of character | |
19799a22 | 4692 | frequencies in the string to be searched--you probably want to compare |
5f05dabc | 4693 | run times with and without it to see which runs faster. Those loops |
a0d0e21e LW |
4694 | which scan for many short constant strings (including the constant |
4695 | parts of more complex patterns) will benefit most. You may have only | |
19799a22 GS |
4696 | one C<study> active at a time--if you study a different scalar the first |
4697 | is "unstudied". (The way C<study> works is this: a linked list of every | |
a0d0e21e | 4698 | character in the string to be searched is made, so we know, for |
7660c0ab | 4699 | example, where all the C<'k'> characters are. From each search string, |
a0d0e21e LW |
4700 | the rarest character is selected, based on some static frequency tables |
4701 | constructed from some C programs and English text. Only those places | |
4702 | that contain this "rarest" character are examined.) | |
4703 | ||
5a964f20 | 4704 | For example, here is a loop that inserts index producing entries |
a0d0e21e LW |
4705 | before any line containing a certain pattern: |
4706 | ||
4707 | while (<>) { | |
4708 | study; | |
2b5ab1e7 TC |
4709 | print ".IX foo\n" if /\bfoo\b/; |
4710 | print ".IX bar\n" if /\bbar\b/; | |
4711 | print ".IX blurfl\n" if /\bblurfl\b/; | |
5a964f20 | 4712 | # ... |
a0d0e21e LW |
4713 | print; |
4714 | } | |
4715 | ||
951ba7fe GS |
4716 | In searching for C</\bfoo\b/>, only those locations in C<$_> that contain C<f> |
4717 | will be looked at, because C<f> is rarer than C<o>. In general, this is | |
a0d0e21e LW |
4718 | a big win except in pathological cases. The only question is whether |
4719 | it saves you more time than it took to build the linked list in the | |
4720 | first place. | |
4721 | ||
4722 | Note that if you have to look for strings that you don't know till | |
19799a22 | 4723 | runtime, you can build an entire loop as a string and C<eval> that to |
a0d0e21e | 4724 | avoid recompiling all your patterns all the time. Together with |
7660c0ab | 4725 | undefining C<$/> to input entire files as one record, this can be very |
f86cebdf | 4726 | fast, often faster than specialized programs like fgrep(1). The following |
184e9718 | 4727 | scans a list of files (C<@files>) for a list of words (C<@words>), and prints |
a0d0e21e LW |
4728 | out the names of those files that contain a match: |
4729 | ||
4730 | $search = 'while (<>) { study;'; | |
4731 | foreach $word (@words) { | |
4732 | $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n"; | |
4733 | } | |
4734 | $search .= "}"; | |
4735 | @ARGV = @files; | |
4736 | undef $/; | |
4737 | eval $search; # this screams | |
5f05dabc | 4738 | $/ = "\n"; # put back to normal input delimiter |
a0d0e21e LW |
4739 | foreach $file (sort keys(%seen)) { |
4740 | print $file, "\n"; | |
4741 | } | |
4742 | ||
cb1a09d0 AD |
4743 | =item sub BLOCK |
4744 | ||
4745 | =item sub NAME | |
4746 | ||
4747 | =item sub NAME BLOCK | |
4748 | ||
4749 | This is subroutine definition, not a real function I<per se>. With just a | |
09bef843 SB |
4750 | NAME (and possibly prototypes or attributes), it's just a forward declaration. |
4751 | Without a NAME, it's an anonymous function declaration, and does actually | |
4752 | return a value: the CODE ref of the closure you just created. See L<perlsub> | |
4753 | and L<perlref> for details. | |
cb1a09d0 | 4754 | |
87275199 | 4755 | =item substr EXPR,OFFSET,LENGTH,REPLACEMENT |
7b8d334a | 4756 | |
87275199 | 4757 | =item substr EXPR,OFFSET,LENGTH |
a0d0e21e LW |
4758 | |
4759 | =item substr EXPR,OFFSET | |
4760 | ||
4761 | Extracts a substring out of EXPR and returns it. First character is at | |
7660c0ab | 4762 | offset C<0>, or whatever you've set C<$[> to (but don't do that). |
84902520 | 4763 | If OFFSET is negative (or more precisely, less than C<$[>), starts |
87275199 GS |
4764 | that far from the end of the string. If LENGTH is omitted, returns |
4765 | everything to the end of the string. If LENGTH is negative, leaves that | |
748a9306 LW |
4766 | many characters off the end of the string. |
4767 | ||
2b5ab1e7 | 4768 | You can use the substr() function as an lvalue, in which case EXPR |
87275199 GS |
4769 | must itself be an lvalue. If you assign something shorter than LENGTH, |
4770 | the string will shrink, and if you assign something longer than LENGTH, | |
2b5ab1e7 | 4771 | the string will grow to accommodate it. To keep the string the same |
19799a22 | 4772 | length you may need to pad or chop your value using C<sprintf>. |
a0d0e21e | 4773 | |
87275199 GS |
4774 | If OFFSET and LENGTH specify a substring that is partly outside the |
4775 | string, only the part within the string is returned. If the substring | |
4776 | is beyond either end of the string, substr() returns the undefined | |
4777 | value and produces a warning. When used as an lvalue, specifying a | |
4778 | substring that is entirely outside the string is a fatal error. | |
4779 | Here's an example showing the behavior for boundary cases: | |
4780 | ||
4781 | my $name = 'fred'; | |
4782 | substr($name, 4) = 'dy'; # $name is now 'freddy' | |
4783 | my $null = substr $name, 6, 2; # returns '' (no warning) | |
4784 | my $oops = substr $name, 7; # returns undef, with warning | |
4785 | substr($name, 7) = 'gap'; # fatal error | |
4786 | ||
2b5ab1e7 | 4787 | An alternative to using substr() as an lvalue is to specify the |
7b8d334a | 4788 | replacement string as the 4th argument. This allows you to replace |
2b5ab1e7 TC |
4789 | parts of the EXPR and return what was there before in one operation, |
4790 | just as you can with splice(). | |
7b8d334a | 4791 | |
a0d0e21e LW |
4792 | =item symlink OLDFILE,NEWFILE |
4793 | ||
4794 | Creates a new filename symbolically linked to the old filename. | |
7660c0ab | 4795 | Returns C<1> for success, C<0> otherwise. On systems that don't support |
a0d0e21e LW |
4796 | symbolic links, produces a fatal error at run time. To check for that, |
4797 | use eval: | |
4798 | ||
2b5ab1e7 | 4799 | $symlink_exists = eval { symlink("",""); 1 }; |
a0d0e21e LW |
4800 | |
4801 | =item syscall LIST | |
4802 | ||
4803 | Calls the system call specified as the first element of the list, | |
4804 | passing the remaining elements as arguments to the system call. If | |
4805 | unimplemented, produces a fatal error. The arguments are interpreted | |
4806 | as follows: if a given argument is numeric, the argument is passed as | |
4807 | an int. If not, the pointer to the string value is passed. You are | |
4808 | responsible to make sure a string is pre-extended long enough to | |
a3cb178b | 4809 | receive any result that might be written into a string. You can't use a |
19799a22 | 4810 | string literal (or other read-only string) as an argument to C<syscall> |
a3cb178b GS |
4811 | because Perl has to assume that any string pointer might be written |
4812 | through. If your | |
a0d0e21e | 4813 | integer arguments are not literals and have never been interpreted in a |
7660c0ab | 4814 | numeric context, you may need to add C<0> to them to force them to look |
19799a22 | 4815 | like numbers. This emulates the C<syswrite> function (or vice versa): |
a0d0e21e LW |
4816 | |
4817 | require 'syscall.ph'; # may need to run h2ph | |
a3cb178b GS |
4818 | $s = "hi there\n"; |
4819 | syscall(&SYS_write, fileno(STDOUT), $s, length $s); | |
a0d0e21e | 4820 | |
5f05dabc | 4821 | Note that Perl supports passing of up to only 14 arguments to your system call, |
a0d0e21e LW |
4822 | which in practice should usually suffice. |
4823 | ||
fb73857a | 4824 | Syscall returns whatever value returned by the system call it calls. |
19799a22 | 4825 | If the system call fails, C<syscall> returns C<-1> and sets C<$!> (errno). |
7660c0ab | 4826 | Note that some system calls can legitimately return C<-1>. The proper |
fb73857a | 4827 | way to handle such calls is to assign C<$!=0;> before the call and |
7660c0ab | 4828 | check the value of C<$!> if syscall returns C<-1>. |
fb73857a | 4829 | |
4830 | There's a problem with C<syscall(&SYS_pipe)>: it returns the file | |
4831 | number of the read end of the pipe it creates. There is no way | |
4832 | to retrieve the file number of the other end. You can avoid this | |
19799a22 | 4833 | problem by using C<pipe> instead. |
fb73857a | 4834 | |
c07a80fd | 4835 | =item sysopen FILEHANDLE,FILENAME,MODE |
4836 | ||
4837 | =item sysopen FILEHANDLE,FILENAME,MODE,PERMS | |
4838 | ||
4839 | Opens the file whose filename is given by FILENAME, and associates it | |
4840 | with FILEHANDLE. If FILEHANDLE is an expression, its value is used as | |
4841 | the name of the real filehandle wanted. This function calls the | |
19799a22 | 4842 | underlying operating system's C<open> function with the parameters |
c07a80fd | 4843 | FILENAME, MODE, PERMS. |
4844 | ||
4845 | The possible values and flag bits of the MODE parameter are | |
4846 | system-dependent; they are available via the standard module C<Fcntl>. | |
ea2b5ef6 JH |
4847 | See the documentation of your operating system's C<open> to see which |
4848 | values and flag bits are available. You may combine several flags | |
4849 | using the C<|>-operator. | |
4850 | ||
4851 | Some of the most common values are C<O_RDONLY> for opening the file in | |
4852 | read-only mode, C<O_WRONLY> for opening the file in write-only mode, | |
4853 | and C<O_RDWR> for opening the file in read-write mode, and. | |
4854 | ||
adf5897a DF |
4855 | For historical reasons, some values work on almost every system |
4856 | supported by perl: zero means read-only, one means write-only, and two | |
4857 | means read/write. We know that these values do I<not> work under | |
7c5ffed3 | 4858 | OS/390 & VM/ESA Unix and on the Macintosh; you probably don't want to |
4af147f6 | 4859 | use them in new code. |
c07a80fd | 4860 | |
19799a22 | 4861 | If the file named by FILENAME does not exist and the C<open> call creates |
7660c0ab | 4862 | it (typically because MODE includes the C<O_CREAT> flag), then the value of |
5a964f20 | 4863 | PERMS specifies the permissions of the newly created file. If you omit |
19799a22 | 4864 | the PERMS argument to C<sysopen>, Perl uses the octal value C<0666>. |
5a964f20 | 4865 | These permission values need to be in octal, and are modified by your |
0591cd52 NT |
4866 | process's current C<umask>. |
4867 | ||
ea2b5ef6 JH |
4868 | In many systems the C<O_EXCL> flag is available for opening files in |
4869 | exclusive mode. This is B<not> locking: exclusiveness means here that | |
4870 | if the file already exists, sysopen() fails. The C<O_EXCL> wins | |
4871 | C<O_TRUNC>. | |
4872 | ||
4873 | Sometimes you may want to truncate an already-existing file: C<O_TRUNC>. | |
4874 | ||
19799a22 | 4875 | You should seldom if ever use C<0644> as argument to C<sysopen>, because |
2b5ab1e7 TC |
4876 | that takes away the user's option to have a more permissive umask. |
4877 | Better to omit it. See the perlfunc(1) entry on C<umask> for more | |
4878 | on this. | |
c07a80fd | 4879 | |
4af147f6 CS |
4880 | Note that C<sysopen> depends on the fdopen() C library function. |
4881 | On many UNIX systems, fdopen() is known to fail when file descriptors | |
4882 | exceed a certain value, typically 255. If you need more file | |
4883 | descriptors than that, consider rebuilding Perl to use the C<sfio> | |
4884 | library, or perhaps using the POSIX::open() function. | |
4885 | ||
2b5ab1e7 | 4886 | See L<perlopentut> for a kinder, gentler explanation of opening files. |
28757baa | 4887 | |
a0d0e21e LW |
4888 | =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET |
4889 | ||
4890 | =item sysread FILEHANDLE,SCALAR,LENGTH | |
4891 | ||
4892 | Attempts to read LENGTH bytes of data into variable SCALAR from the | |
b43ceaf2 | 4893 | specified FILEHANDLE, using the system call read(2). It bypasses stdio, |
19799a22 GS |
4894 | so mixing this with other kinds of reads, C<print>, C<write>, |
4895 | C<seek>, C<tell>, or C<eof> can cause confusion because stdio | |
b43ceaf2 AB |
4896 | usually buffers data. Returns the number of bytes actually read, C<0> |
4897 | at end of file, or undef if there was an error. SCALAR will be grown or | |
4898 | shrunk so that the last byte actually read is the last byte of the | |
4899 | scalar after the read. | |
ff68c719 | 4900 | |
4901 | An OFFSET may be specified to place the read data at some place in the | |
4902 | string other than the beginning. A negative OFFSET specifies | |
4903 | placement at that many bytes counting backwards from the end of the | |
4904 | string. A positive OFFSET greater than the length of SCALAR results | |
7660c0ab | 4905 | in the string being padded to the required size with C<"\0"> bytes before |
ff68c719 | 4906 | the result of the read is appended. |
a0d0e21e | 4907 | |
2b5ab1e7 TC |
4908 | There is no syseof() function, which is ok, since eof() doesn't work |
4909 | very well on device files (like ttys) anyway. Use sysread() and check | |
19799a22 | 4910 | for a return value for 0 to decide whether you're done. |
2b5ab1e7 | 4911 | |
137443ea | 4912 | =item sysseek FILEHANDLE,POSITION,WHENCE |
4913 | ||
f86cebdf | 4914 | Sets FILEHANDLE's system position using the system call lseek(2). It |
19799a22 | 4915 | bypasses stdio, so mixing this with reads (other than C<sysread>), |
ac88732c JH |
4916 | C<print>, C<write>, C<seek>, C<tell>, or C<eof> may cause confusion. |
4917 | FILEHANDLE may be an expression whose value gives the name of the | |
4918 | filehandle. The values for WHENCE are C<0> to set the new position to | |
4919 | POSITION, C<1> to set the it to the current position plus POSITION, | |
4920 | and C<2> to set it to EOF plus POSITION (typically negative). For | |
4921 | WHENCE, you may also use the constants C<SEEK_SET>, C<SEEK_CUR>, and | |
4922 | C<SEEK_END> (start of the file, current position, end of the file) | |
ca6e1c26 | 4923 | from the Fcntl module. |
8903cb82 | 4924 | |
4925 | Returns the new position, or the undefined value on failure. A position | |
19799a22 GS |
4926 | of zero is returned as the string C<"0 but true">; thus C<sysseek> returns |
4927 | true on success and false on failure, yet you can still easily determine | |
8903cb82 | 4928 | the new position. |
137443ea | 4929 | |
a0d0e21e LW |
4930 | =item system LIST |
4931 | ||
8bf3b016 GS |
4932 | =item system PROGRAM LIST |
4933 | ||
19799a22 GS |
4934 | Does exactly the same thing as C<exec LIST>, except that a fork is |
4935 | done first, and the parent process waits for the child process to | |
4936 | complete. Note that argument processing varies depending on the | |
4937 | number of arguments. If there is more than one argument in LIST, | |
4938 | or if LIST is an array with more than one value, starts the program | |
4939 | given by the first element of the list with arguments given by the | |
4940 | rest of the list. If there is only one scalar argument, the argument | |
4941 | is checked for shell metacharacters, and if there are any, the | |
4942 | entire argument is passed to the system's command shell for parsing | |
4943 | (this is C</bin/sh -c> on Unix platforms, but varies on other | |
4944 | platforms). If there are no shell metacharacters in the argument, | |
4945 | it is split into words and passed directly to C<execvp>, which is | |
4946 | more efficient. | |
4947 | ||
0f897271 GS |
4948 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
4949 | output before any operation that may do a fork, but this may not be | |
4950 | supported on some platforms (see L<perlport>). To be safe, you may need | |
4951 | to set C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method | |
4952 | of C<IO::Handle> on any open handles. | |
a2008d6d GS |
4953 | |
4954 | The return value is the exit status of the program as | |
19799a22 GS |
4955 | returned by the C<wait> call. To get the actual exit value divide by |
4956 | 256. See also L</exec>. This is I<not> what you want to use to capture | |
54310121 | 4957 | the output from a command, for that you should use merely backticks or |
d5a9bfb0 IZ |
4958 | C<qx//>, as described in L<perlop/"`STRING`">. Return value of -1 |
4959 | indicates a failure to start the program (inspect $! for the reason). | |
a0d0e21e | 4960 | |
19799a22 GS |
4961 | Like C<exec>, C<system> allows you to lie to a program about its name if |
4962 | you use the C<system PROGRAM LIST> syntax. Again, see L</exec>. | |
8bf3b016 | 4963 | |
19799a22 | 4964 | Because C<system> and backticks block C<SIGINT> and C<SIGQUIT>, killing the |
28757baa | 4965 | program they're running doesn't actually interrupt your program. |
4966 | ||
4967 | @args = ("command", "arg1", "arg2"); | |
54310121 | 4968 | system(@args) == 0 |
4969 | or die "system @args failed: $?" | |
28757baa | 4970 | |
5a964f20 TC |
4971 | You can check all the failure possibilities by inspecting |
4972 | C<$?> like this: | |
28757baa | 4973 | |
5a964f20 TC |
4974 | $exit_value = $? >> 8; |
4975 | $signal_num = $? & 127; | |
4976 | $dumped_core = $? & 128; | |
f86702cc | 4977 | |
c8db1d39 TC |
4978 | When the arguments get executed via the system shell, results |
4979 | and return codes will be subject to its quirks and capabilities. | |
4980 | See L<perlop/"`STRING`"> and L</exec> for details. | |
bb32b41a | 4981 | |
a0d0e21e LW |
4982 | =item syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET |
4983 | ||
4984 | =item syswrite FILEHANDLE,SCALAR,LENGTH | |
4985 | ||
145d37e2 GA |
4986 | =item syswrite FILEHANDLE,SCALAR |
4987 | ||
a0d0e21e | 4988 | Attempts to write LENGTH bytes of data from variable SCALAR to the |
19799a22 GS |
4989 | specified FILEHANDLE, using the system call write(2). If LENGTH |
4990 | is not specified, writes whole SCALAR. It bypasses stdio, so mixing | |
4991 | this with reads (other than C<sysread())>, C<print>, C<write>, | |
4992 | C<seek>, C<tell>, or C<eof> may cause confusion because stdio | |
4993 | usually buffers data. Returns the number of bytes actually written, | |
4994 | or C<undef> if there was an error. If the LENGTH is greater than | |
4995 | the available data in the SCALAR after the OFFSET, only as much | |
4996 | data as is available will be written. | |
ff68c719 | 4997 | |
4998 | An OFFSET may be specified to write the data from some part of the | |
4999 | string other than the beginning. A negative OFFSET specifies writing | |
fb73857a | 5000 | that many bytes counting backwards from the end of the string. In the |
5001 | case the SCALAR is empty you can use OFFSET but only zero offset. | |
a0d0e21e LW |
5002 | |
5003 | =item tell FILEHANDLE | |
5004 | ||
5005 | =item tell | |
5006 | ||
8903cb82 | 5007 | Returns the current position for FILEHANDLE. FILEHANDLE may be an |
a0d0e21e | 5008 | expression whose value gives the name of the actual filehandle. If |
2b5ab1e7 TC |
5009 | FILEHANDLE is omitted, assumes the file last read. |
5010 | ||
19799a22 | 5011 | There is no C<systell> function. Use C<sysseek(FH, 0, 1)> for that. |
a0d0e21e LW |
5012 | |
5013 | =item telldir DIRHANDLE | |
5014 | ||
19799a22 GS |
5015 | Returns the current position of the C<readdir> routines on DIRHANDLE. |
5016 | Value may be given to C<seekdir> to access a particular location in a | |
a0d0e21e LW |
5017 | directory. Has the same caveats about possible directory compaction as |
5018 | the corresponding system library routine. | |
5019 | ||
4633a7c4 | 5020 | =item tie VARIABLE,CLASSNAME,LIST |
a0d0e21e | 5021 | |
4633a7c4 LW |
5022 | This function binds a variable to a package class that will provide the |
5023 | implementation for the variable. VARIABLE is the name of the variable | |
5024 | to be enchanted. CLASSNAME is the name of a class implementing objects | |
19799a22 | 5025 | of correct type. Any additional arguments are passed to the C<new> |
8a059744 GS |
5026 | method of the class (meaning C<TIESCALAR>, C<TIEHANDLE>, C<TIEARRAY>, |
5027 | or C<TIEHASH>). Typically these are arguments such as might be passed | |
19799a22 GS |
5028 | to the C<dbm_open()> function of C. The object returned by the C<new> |
5029 | method is also returned by the C<tie> function, which would be useful | |
8a059744 | 5030 | if you want to access other methods in CLASSNAME. |
a0d0e21e | 5031 | |
19799a22 | 5032 | Note that functions such as C<keys> and C<values> may return huge lists |
1d2dff63 | 5033 | when used on large objects, like DBM files. You may prefer to use the |
19799a22 | 5034 | C<each> function to iterate over such. Example: |
a0d0e21e LW |
5035 | |
5036 | # print out history file offsets | |
4633a7c4 | 5037 | use NDBM_File; |
da0045b7 | 5038 | tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0); |
a0d0e21e LW |
5039 | while (($key,$val) = each %HIST) { |
5040 | print $key, ' = ', unpack('L',$val), "\n"; | |
5041 | } | |
5042 | untie(%HIST); | |
5043 | ||
aa689395 | 5044 | A class implementing a hash should have the following methods: |
a0d0e21e | 5045 | |
4633a7c4 | 5046 | TIEHASH classname, LIST |
a0d0e21e LW |
5047 | FETCH this, key |
5048 | STORE this, key, value | |
5049 | DELETE this, key | |
8a059744 | 5050 | CLEAR this |
a0d0e21e LW |
5051 | EXISTS this, key |
5052 | FIRSTKEY this | |
5053 | NEXTKEY this, lastkey | |
8a059744 | 5054 | DESTROY this |
a0d0e21e | 5055 | |
4633a7c4 | 5056 | A class implementing an ordinary array should have the following methods: |
a0d0e21e | 5057 | |
4633a7c4 | 5058 | TIEARRAY classname, LIST |
a0d0e21e LW |
5059 | FETCH this, key |
5060 | STORE this, key, value | |
8a059744 GS |
5061 | FETCHSIZE this |
5062 | STORESIZE this, count | |
5063 | CLEAR this | |
5064 | PUSH this, LIST | |
5065 | POP this | |
5066 | SHIFT this | |
5067 | UNSHIFT this, LIST | |
5068 | SPLICE this, offset, length, LIST | |
5069 | EXTEND this, count | |
5070 | DESTROY this | |
5071 | ||
5072 | A class implementing a file handle should have the following methods: | |
5073 | ||
5074 | TIEHANDLE classname, LIST | |
5075 | READ this, scalar, length, offset | |
5076 | READLINE this | |
5077 | GETC this | |
5078 | WRITE this, scalar, length, offset | |
5079 | PRINT this, LIST | |
5080 | PRINTF this, format, LIST | |
5081 | CLOSE this | |
5082 | DESTROY this | |
a0d0e21e | 5083 | |
4633a7c4 | 5084 | A class implementing a scalar should have the following methods: |
a0d0e21e | 5085 | |
4633a7c4 | 5086 | TIESCALAR classname, LIST |
54310121 | 5087 | FETCH this, |
a0d0e21e | 5088 | STORE this, value |
8a059744 GS |
5089 | DESTROY this |
5090 | ||
5091 | Not all methods indicated above need be implemented. See L<perltie>, | |
2b5ab1e7 | 5092 | L<Tie::Hash>, L<Tie::Array>, L<Tie::Scalar>, and L<Tie::Handle>. |
a0d0e21e | 5093 | |
19799a22 | 5094 | Unlike C<dbmopen>, the C<tie> function will not use or require a module |
4633a7c4 | 5095 | for you--you need to do that explicitly yourself. See L<DB_File> |
19799a22 | 5096 | or the F<Config> module for interesting C<tie> implementations. |
4633a7c4 | 5097 | |
b687b08b | 5098 | For further details see L<perltie>, L<"tied VARIABLE">. |
cc6b7395 | 5099 | |
f3cbc334 RS |
5100 | =item tied VARIABLE |
5101 | ||
5102 | Returns a reference to the object underlying VARIABLE (the same value | |
19799a22 | 5103 | that was originally returned by the C<tie> call that bound the variable |
f3cbc334 RS |
5104 | to a package.) Returns the undefined value if VARIABLE isn't tied to a |
5105 | package. | |
5106 | ||
a0d0e21e LW |
5107 | =item time |
5108 | ||
da0045b7 | 5109 | Returns the number of non-leap seconds since whatever time the system |
5110 | considers to be the epoch (that's 00:00:00, January 1, 1904 for MacOS, | |
5111 | and 00:00:00 UTC, January 1, 1970 for most other systems). | |
19799a22 | 5112 | Suitable for feeding to C<gmtime> and C<localtime>. |
a0d0e21e | 5113 | |
68f8bed4 JH |
5114 | For measuring time in better granularity than one second, |
5115 | you may use either the Time::HiRes module from CPAN, or | |
5116 | if you have gettimeofday(2), you may be able to use the | |
5117 | C<syscall> interface of Perl, see L<perlfaq8> for details. | |
5118 | ||
a0d0e21e LW |
5119 | =item times |
5120 | ||
1d2dff63 | 5121 | Returns a four-element list giving the user and system times, in |
a0d0e21e LW |
5122 | seconds, for this process and the children of this process. |
5123 | ||
5124 | ($user,$system,$cuser,$csystem) = times; | |
5125 | ||
5126 | =item tr/// | |
5127 | ||
19799a22 | 5128 | The transliteration operator. Same as C<y///>. See L<perlop>. |
a0d0e21e LW |
5129 | |
5130 | =item truncate FILEHANDLE,LENGTH | |
5131 | ||
5132 | =item truncate EXPR,LENGTH | |
5133 | ||
5134 | Truncates the file opened on FILEHANDLE, or named by EXPR, to the | |
5135 | specified length. Produces a fatal error if truncate isn't implemented | |
19799a22 | 5136 | on your system. Returns true if successful, the undefined value |
a3cb178b | 5137 | otherwise. |
a0d0e21e LW |
5138 | |
5139 | =item uc EXPR | |
5140 | ||
54310121 | 5141 | =item uc |
bbce6d69 | 5142 | |
a0d0e21e | 5143 | Returns an uppercased version of EXPR. This is the internal function |
7660c0ab | 5144 | implementing the C<\U> escape in double-quoted strings. |
a034a98d | 5145 | Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale>. |
a0ed51b3 | 5146 | Under Unicode (C<use utf8>) it uses the standard Unicode uppercase mappings. (It |
19799a22 | 5147 | does not attempt to do titlecase mapping on initial letters. See C<ucfirst> for that.) |
a0d0e21e | 5148 | |
7660c0ab | 5149 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 5150 | |
a0d0e21e LW |
5151 | =item ucfirst EXPR |
5152 | ||
54310121 | 5153 | =item ucfirst |
bbce6d69 | 5154 | |
a0ed51b3 LW |
5155 | Returns the value of EXPR with the first character |
5156 | in uppercase (titlecase in Unicode). This is | |
7660c0ab | 5157 | the internal function implementing the C<\u> escape in double-quoted strings. |
2b5ab1e7 TC |
5158 | Respects current LC_CTYPE locale if C<use locale> in force. See L<perllocale> |
5159 | and L<utf8>. | |
a0d0e21e | 5160 | |
7660c0ab | 5161 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 5162 | |
a0d0e21e LW |
5163 | =item umask EXPR |
5164 | ||
5165 | =item umask | |
5166 | ||
2f9daede | 5167 | Sets the umask for the process to EXPR and returns the previous value. |
eec2d3df GS |
5168 | If EXPR is omitted, merely returns the current umask. |
5169 | ||
0591cd52 NT |
5170 | The Unix permission C<rwxr-x---> is represented as three sets of three |
5171 | bits, or three octal digits: C<0750> (the leading 0 indicates octal | |
b5a41e52 | 5172 | and isn't one of the digits). The C<umask> value is such a number |
0591cd52 NT |
5173 | representing disabled permissions bits. The permission (or "mode") |
5174 | values you pass C<mkdir> or C<sysopen> are modified by your umask, so | |
5175 | even if you tell C<sysopen> to create a file with permissions C<0777>, | |
5176 | if your umask is C<0022> then the file will actually be created with | |
5177 | permissions C<0755>. If your C<umask> were C<0027> (group can't | |
5178 | write; others can't read, write, or execute), then passing | |
19799a22 | 5179 | C<sysopen> C<0666> would create a file with mode C<0640> (C<0666 &~ |
0591cd52 NT |
5180 | 027> is C<0640>). |
5181 | ||
5182 | Here's some advice: supply a creation mode of C<0666> for regular | |
19799a22 GS |
5183 | files (in C<sysopen>) and one of C<0777> for directories (in |
5184 | C<mkdir>) and executable files. This gives users the freedom of | |
0591cd52 NT |
5185 | choice: if they want protected files, they might choose process umasks |
5186 | of C<022>, C<027>, or even the particularly antisocial mask of C<077>. | |
5187 | Programs should rarely if ever make policy decisions better left to | |
5188 | the user. The exception to this is when writing files that should be | |
5189 | kept private: mail files, web browser cookies, I<.rhosts> files, and | |
5190 | so on. | |
5191 | ||
f86cebdf | 5192 | If umask(2) is not implemented on your system and you are trying to |
eec2d3df | 5193 | restrict access for I<yourself> (i.e., (EXPR & 0700) > 0), produces a |
f86cebdf | 5194 | fatal error at run time. If umask(2) is not implemented and you are |
eec2d3df GS |
5195 | not trying to restrict access for yourself, returns C<undef>. |
5196 | ||
5197 | Remember that a umask is a number, usually given in octal; it is I<not> a | |
5198 | string of octal digits. See also L</oct>, if all you have is a string. | |
a0d0e21e LW |
5199 | |
5200 | =item undef EXPR | |
5201 | ||
5202 | =item undef | |
5203 | ||
54310121 | 5204 | Undefines the value of EXPR, which must be an lvalue. Use only on a |
19799a22 GS |
5205 | scalar value, an array (using C<@>), a hash (using C<%>), a subroutine |
5206 | (using C<&>), or a typeglob (using <*>). (Saying C<undef $hash{$key}> | |
20408e3c GS |
5207 | will probably not do what you expect on most predefined variables or |
5208 | DBM list values, so don't do that; see L<delete>.) Always returns the | |
5209 | undefined value. You can omit the EXPR, in which case nothing is | |
5210 | undefined, but you still get an undefined value that you could, for | |
5211 | instance, return from a subroutine, assign to a variable or pass as a | |
5212 | parameter. Examples: | |
a0d0e21e LW |
5213 | |
5214 | undef $foo; | |
f86cebdf | 5215 | undef $bar{'blurfl'}; # Compare to: delete $bar{'blurfl'}; |
a0d0e21e | 5216 | undef @ary; |
aa689395 | 5217 | undef %hash; |
a0d0e21e | 5218 | undef &mysub; |
20408e3c | 5219 | undef *xyz; # destroys $xyz, @xyz, %xyz, &xyz, etc. |
54310121 | 5220 | return (wantarray ? (undef, $errmsg) : undef) if $they_blew_it; |
2f9daede TP |
5221 | select undef, undef, undef, 0.25; |
5222 | ($a, $b, undef, $c) = &foo; # Ignore third value returned | |
a0d0e21e | 5223 | |
5a964f20 TC |
5224 | Note that this is a unary operator, not a list operator. |
5225 | ||
a0d0e21e LW |
5226 | =item unlink LIST |
5227 | ||
54310121 | 5228 | =item unlink |
bbce6d69 | 5229 | |
a0d0e21e LW |
5230 | Deletes a list of files. Returns the number of files successfully |
5231 | deleted. | |
5232 | ||
5233 | $cnt = unlink 'a', 'b', 'c'; | |
5234 | unlink @goners; | |
5235 | unlink <*.bak>; | |
5236 | ||
19799a22 | 5237 | Note: C<unlink> will not delete directories unless you are superuser and |
a0d0e21e LW |
5238 | the B<-U> flag is supplied to Perl. Even if these conditions are |
5239 | met, be warned that unlinking a directory can inflict damage on your | |
19799a22 | 5240 | filesystem. Use C<rmdir> instead. |
a0d0e21e | 5241 | |
7660c0ab | 5242 | If LIST is omitted, uses C<$_>. |
bbce6d69 | 5243 | |
a0d0e21e LW |
5244 | =item unpack TEMPLATE,EXPR |
5245 | ||
19799a22 | 5246 | C<unpack> does the reverse of C<pack>: it takes a string |
2b6c5635 | 5247 | and expands it out into a list of values. |
19799a22 | 5248 | (In scalar context, it returns merely the first value produced.) |
2b6c5635 GS |
5249 | |
5250 | The string is broken into chunks described by the TEMPLATE. Each chunk | |
5251 | is converted separately to a value. Typically, either the string is a result | |
5252 | of C<pack>, or the bytes of the string represent a C structure of some | |
5253 | kind. | |
5254 | ||
19799a22 | 5255 | The TEMPLATE has the same format as in the C<pack> function. |
a0d0e21e LW |
5256 | Here's a subroutine that does substring: |
5257 | ||
5258 | sub substr { | |
5a964f20 | 5259 | my($what,$where,$howmuch) = @_; |
a0d0e21e LW |
5260 | unpack("x$where a$howmuch", $what); |
5261 | } | |
5262 | ||
5263 | and then there's | |
5264 | ||
5265 | sub ordinal { unpack("c",$_[0]); } # same as ord() | |
5266 | ||
2b6c5635 | 5267 | In addition to fields allowed in pack(), you may prefix a field with |
61eff3bc JH |
5268 | a %<number> to indicate that |
5269 | you want a <number>-bit checksum of the items instead of the items | |
2b6c5635 GS |
5270 | themselves. Default is a 16-bit checksum. Checksum is calculated by |
5271 | summing numeric values of expanded values (for string fields the sum of | |
5272 | C<ord($char)> is taken, for bit fields the sum of zeroes and ones). | |
5273 | ||
5274 | For example, the following | |
a0d0e21e LW |
5275 | computes the same number as the System V sum program: |
5276 | ||
19799a22 GS |
5277 | $checksum = do { |
5278 | local $/; # slurp! | |
5279 | unpack("%32C*",<>) % 65535; | |
5280 | }; | |
a0d0e21e LW |
5281 | |
5282 | The following efficiently counts the number of set bits in a bit vector: | |
5283 | ||
5284 | $setbits = unpack("%32b*", $selectmask); | |
5285 | ||
951ba7fe | 5286 | The C<p> and C<P> formats should be used with care. Since Perl |
3160c391 GS |
5287 | has no way of checking whether the value passed to C<unpack()> |
5288 | corresponds to a valid memory location, passing a pointer value that's | |
5289 | not known to be valid is likely to have disastrous consequences. | |
5290 | ||
2b6c5635 GS |
5291 | If the repeat count of a field is larger than what the remainder of |
5292 | the input string allows, repeat count is decreased. If the input string | |
5293 | is longer than one described by the TEMPLATE, the rest is ignored. | |
5294 | ||
851646ae | 5295 | See L</pack> for more examples and notes. |
5a929a98 | 5296 | |
98293880 JH |
5297 | =item untie VARIABLE |
5298 | ||
19799a22 | 5299 | Breaks the binding between a variable and a package. (See C<tie>.) |
98293880 | 5300 | |
a0d0e21e LW |
5301 | =item unshift ARRAY,LIST |
5302 | ||
19799a22 | 5303 | Does the opposite of a C<shift>. Or the opposite of a C<push>, |
a0d0e21e LW |
5304 | depending on how you look at it. Prepends list to the front of the |
5305 | array, and returns the new number of elements in the array. | |
5306 | ||
5307 | unshift(ARGV, '-e') unless $ARGV[0] =~ /^-/; | |
5308 | ||
5309 | Note the LIST is prepended whole, not one element at a time, so the | |
19799a22 | 5310 | prepended elements stay in the same order. Use C<reverse> to do the |
a0d0e21e LW |
5311 | reverse. |
5312 | ||
f6c8478c GS |
5313 | =item use Module VERSION LIST |
5314 | ||
5315 | =item use Module VERSION | |
5316 | ||
a0d0e21e LW |
5317 | =item use Module LIST |
5318 | ||
5319 | =item use Module | |
5320 | ||
da0045b7 | 5321 | =item use VERSION |
5322 | ||
a0d0e21e LW |
5323 | Imports some semantics into the current package from the named module, |
5324 | generally by aliasing certain subroutine or variable names into your | |
5325 | package. It is exactly equivalent to | |
5326 | ||
5327 | BEGIN { require Module; import Module LIST; } | |
5328 | ||
54310121 | 5329 | except that Module I<must> be a bareword. |
da0045b7 | 5330 | |
dd629d5b | 5331 | VERSION, which can be specified as a literal of the form v5.6.1, demands |
44dcb63b GS |
5332 | that the current version of Perl (C<$^V> or $PERL_VERSION) be at least |
5333 | as recent as that version. (For compatibility with older versions of Perl, | |
5334 | a numeric literal will also be interpreted as VERSION.) If the version | |
5335 | of the running Perl interpreter is less than VERSION, then an error | |
5336 | message is printed and Perl exits immediately without attempting to | |
5337 | parse the rest of the file. Compare with L</require>, which can do a | |
5338 | similar check at run time. | |
16070b82 | 5339 | |
dd629d5b GS |
5340 | use v5.6.1; # compile time version check |
5341 | use 5.6.1; # ditto | |
5342 | use 5.005_03; # float version allowed for compatibility | |
16070b82 GS |
5343 | |
5344 | This is often useful if you need to check the current Perl version before | |
5345 | C<use>ing library modules that have changed in incompatible ways from | |
5346 | older versions of Perl. (We try not to do this more than we have to.) | |
da0045b7 | 5347 | |
19799a22 | 5348 | The C<BEGIN> forces the C<require> and C<import> to happen at compile time. The |
7660c0ab | 5349 | C<require> makes sure the module is loaded into memory if it hasn't been |
19799a22 GS |
5350 | yet. The C<import> is not a builtin--it's just an ordinary static method |
5351 | call into the C<Module> package to tell the module to import the list of | |
a0d0e21e | 5352 | features back into the current package. The module can implement its |
19799a22 GS |
5353 | C<import> method any way it likes, though most modules just choose to |
5354 | derive their C<import> method via inheritance from the C<Exporter> class that | |
5355 | is defined in the C<Exporter> module. See L<Exporter>. If no C<import> | |
10696ff6 | 5356 | method can be found then the call is skipped. |
cb1a09d0 AD |
5357 | |
5358 | If you don't want your namespace altered, explicitly supply an empty list: | |
5359 | ||
5360 | use Module (); | |
5361 | ||
5362 | That is exactly equivalent to | |
5363 | ||
5a964f20 | 5364 | BEGIN { require Module } |
a0d0e21e | 5365 | |
da0045b7 | 5366 | If the VERSION argument is present between Module and LIST, then the |
71be2cbc | 5367 | C<use> will call the VERSION method in class Module with the given |
5368 | version as an argument. The default VERSION method, inherited from | |
44dcb63b | 5369 | the UNIVERSAL class, croaks if the given version is larger than the |
f6c8478c GS |
5370 | value of the variable C<$Module::VERSION>. |
5371 | ||
5372 | Again, there is a distinction between omitting LIST (C<import> called | |
5373 | with no arguments) and an explicit empty LIST C<()> (C<import> not | |
5374 | called). Note that there is no comma after VERSION! | |
da0045b7 | 5375 | |
a0d0e21e LW |
5376 | Because this is a wide-open interface, pragmas (compiler directives) |
5377 | are also implemented this way. Currently implemented pragmas are: | |
5378 | ||
5379 | use integer; | |
4633a7c4 | 5380 | use diagnostics; |
4438c4b7 JH |
5381 | use sigtrap qw(SEGV BUS); |
5382 | use strict qw(subs vars refs); | |
5383 | use subs qw(afunc blurfl); | |
5384 | use warnings qw(all); | |
a0d0e21e | 5385 | |
19799a22 | 5386 | Some of these pseudo-modules import semantics into the current |
5a964f20 TC |
5387 | block scope (like C<strict> or C<integer>, unlike ordinary modules, |
5388 | which import symbols into the current package (which are effective | |
5389 | through the end of the file). | |
a0d0e21e | 5390 | |
19799a22 GS |
5391 | There's a corresponding C<no> command that unimports meanings imported |
5392 | by C<use>, i.e., it calls C<unimport Module LIST> instead of C<import>. | |
a0d0e21e LW |
5393 | |
5394 | no integer; | |
5395 | no strict 'refs'; | |
4438c4b7 | 5396 | no warnings; |
a0d0e21e | 5397 | |
19799a22 | 5398 | If no C<unimport> method can be found the call fails with a fatal error. |
55497cff | 5399 | |
a0d0e21e LW |
5400 | See L<perlmod> for a list of standard modules and pragmas. |
5401 | ||
5402 | =item utime LIST | |
5403 | ||
5404 | Changes the access and modification times on each file of a list of | |
5405 | files. The first two elements of the list must be the NUMERICAL access | |
5406 | and modification times, in that order. Returns the number of files | |
46cdf678 | 5407 | successfully changed. The inode change time of each file is set |
19799a22 | 5408 | to the current time. This code has the same effect as the C<touch> |
a3cb178b | 5409 | command if the files already exist: |
a0d0e21e LW |
5410 | |
5411 | #!/usr/bin/perl | |
5412 | $now = time; | |
5413 | utime $now, $now, @ARGV; | |
5414 | ||
aa689395 | 5415 | =item values HASH |
a0d0e21e | 5416 | |
1d2dff63 GS |
5417 | Returns a list consisting of all the values of the named hash. (In a |
5418 | scalar context, returns the number of values.) The values are | |
ab192400 GS |
5419 | returned in an apparently random order. The actual random order is |
5420 | subject to change in future versions of perl, but it is guaranteed to | |
19799a22 | 5421 | be the same order as either the C<keys> or C<each> function would |
ab192400 GS |
5422 | produce on the same (unmodified) hash. |
5423 | ||
8ea1e5d4 GS |
5424 | Note that the values are not copied, which means modifying them will |
5425 | modify the contents of the hash: | |
2b5ab1e7 | 5426 | |
8ea1e5d4 GS |
5427 | for (values %hash) { s/foo/bar/g } # modifies %hash values |
5428 | for (@hash{keys %hash}) { s/foo/bar/g } # same | |
2b5ab1e7 TC |
5429 | |
5430 | As a side effect, calling values() resets the HASH's internal iterator. | |
19799a22 | 5431 | See also C<keys>, C<each>, and C<sort>. |
a0d0e21e LW |
5432 | |
5433 | =item vec EXPR,OFFSET,BITS | |
5434 | ||
e69129f1 GS |
5435 | Treats the string in EXPR as a bit vector made up of elements of |
5436 | width BITS, and returns the value of the element specified by OFFSET | |
5437 | as an unsigned integer. BITS therefore specifies the number of bits | |
5438 | that are reserved for each element in the bit vector. This must | |
5439 | be a power of two from 1 to 32 (or 64, if your platform supports | |
5440 | that). | |
c5a0f51a | 5441 | |
c73032f5 IZ |
5442 | If BITS is 8, "elements" coincide with bytes of the input string. |
5443 | ||
5444 | If BITS is 16 or more, bytes of the input string are grouped into chunks | |
5445 | of size BITS/8, and each group is converted to a number as with | |
5446 | pack()/unpack() with big-endian formats C<n>/C<N> (and analoguously | |
5447 | for BITS==64). See L<"pack"> for details. | |
5448 | ||
5449 | If bits is 4 or less, the string is broken into bytes, then the bits | |
5450 | of each byte are broken into 8/BITS groups. Bits of a byte are | |
5451 | numbered in a little-endian-ish way, as in C<0x01>, C<0x02>, | |
5452 | C<0x04>, C<0x08>, C<0x10>, C<0x20>, C<0x40>, C<0x80>. For example, | |
5453 | breaking the single input byte C<chr(0x36)> into two groups gives a list | |
5454 | C<(0x6, 0x3)>; breaking it into 4 groups gives C<(0x2, 0x1, 0x3, 0x0)>. | |
5455 | ||
81e118e0 JH |
5456 | C<vec> may also be assigned to, in which case parentheses are needed |
5457 | to give the expression the correct precedence as in | |
22dc801b | 5458 | |
5459 | vec($image, $max_x * $x + $y, 8) = 3; | |
a0d0e21e | 5460 | |
fac70343 GS |
5461 | If the selected element is off the end of the string, the value 0 is |
5462 | returned. If an element off the end of the string is written to, | |
5463 | Perl will first extend the string with sufficiently many zero bytes. | |
5464 | ||
5465 | Strings created with C<vec> can also be manipulated with the logical | |
5466 | operators C<|>, C<&>, C<^>, and C<~>. These operators will assume a bit | |
5467 | vector operation is desired when both operands are strings. | |
c5a0f51a | 5468 | See L<perlop/"Bitwise String Operators">. |
a0d0e21e | 5469 | |
7660c0ab | 5470 | The following code will build up an ASCII string saying C<'PerlPerlPerl'>. |
19799a22 | 5471 | The comments show the string after each step. Note that this code works |
cca87523 GS |
5472 | in the same way on big-endian or little-endian machines. |
5473 | ||
5474 | my $foo = ''; | |
5475 | vec($foo, 0, 32) = 0x5065726C; # 'Perl' | |
e69129f1 GS |
5476 | |
5477 | # $foo eq "Perl" eq "\x50\x65\x72\x6C", 32 bits | |
5478 | print vec($foo, 0, 8); # prints 80 == 0x50 == ord('P') | |
5479 | ||
cca87523 GS |
5480 | vec($foo, 2, 16) = 0x5065; # 'PerlPe' |
5481 | vec($foo, 3, 16) = 0x726C; # 'PerlPerl' | |
5482 | vec($foo, 8, 8) = 0x50; # 'PerlPerlP' | |
5483 | vec($foo, 9, 8) = 0x65; # 'PerlPerlPe' | |
5484 | vec($foo, 20, 4) = 2; # 'PerlPerlPe' . "\x02" | |
f86cebdf GS |
5485 | vec($foo, 21, 4) = 7; # 'PerlPerlPer' |
5486 | # 'r' is "\x72" | |
cca87523 GS |
5487 | vec($foo, 45, 2) = 3; # 'PerlPerlPer' . "\x0c" |
5488 | vec($foo, 93, 1) = 1; # 'PerlPerlPer' . "\x2c" | |
f86cebdf GS |
5489 | vec($foo, 94, 1) = 1; # 'PerlPerlPerl' |
5490 | # 'l' is "\x6c" | |
cca87523 | 5491 | |
19799a22 | 5492 | To transform a bit vector into a string or list of 0's and 1's, use these: |
a0d0e21e LW |
5493 | |
5494 | $bits = unpack("b*", $vector); | |
5495 | @bits = split(//, unpack("b*", $vector)); | |
5496 | ||
7660c0ab | 5497 | If you know the exact length in bits, it can be used in place of the C<*>. |
a0d0e21e | 5498 | |
e69129f1 GS |
5499 | Here is an example to illustrate how the bits actually fall in place: |
5500 | ||
5501 | #!/usr/bin/perl -wl | |
5502 | ||
5503 | print <<'EOT'; | |
5504 | 0 1 2 3 | |
5505 | unpack("V",$_) 01234567890123456789012345678901 | |
5506 | ------------------------------------------------------------------ | |
5507 | EOT | |
5508 | ||
5509 | for $w (0..3) { | |
5510 | $width = 2**$w; | |
5511 | for ($shift=0; $shift < $width; ++$shift) { | |
5512 | for ($off=0; $off < 32/$width; ++$off) { | |
5513 | $str = pack("B*", "0"x32); | |
5514 | $bits = (1<<$shift); | |
5515 | vec($str, $off, $width) = $bits; | |
5516 | $res = unpack("b*",$str); | |
5517 | $val = unpack("V", $str); | |
5518 | write; | |
5519 | } | |
5520 | } | |
5521 | } | |
5522 | ||
5523 | format STDOUT = | |
5524 | vec($_,@#,@#) = @<< == @######### @>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> | |
5525 | $off, $width, $bits, $val, $res | |
5526 | . | |
5527 | __END__ | |
5528 | ||
5529 | Regardless of the machine architecture on which it is run, the above | |
5530 | example should print the following table: | |
5531 | ||
5532 | 0 1 2 3 | |
5533 | unpack("V",$_) 01234567890123456789012345678901 | |
5534 | ------------------------------------------------------------------ | |
5535 | vec($_, 0, 1) = 1 == 1 10000000000000000000000000000000 | |
5536 | vec($_, 1, 1) = 1 == 2 01000000000000000000000000000000 | |
5537 | vec($_, 2, 1) = 1 == 4 00100000000000000000000000000000 | |
5538 | vec($_, 3, 1) = 1 == 8 00010000000000000000000000000000 | |
5539 | vec($_, 4, 1) = 1 == 16 00001000000000000000000000000000 | |
5540 | vec($_, 5, 1) = 1 == 32 00000100000000000000000000000000 | |
5541 | vec($_, 6, 1) = 1 == 64 00000010000000000000000000000000 | |
5542 | vec($_, 7, 1) = 1 == 128 00000001000000000000000000000000 | |
5543 | vec($_, 8, 1) = 1 == 256 00000000100000000000000000000000 | |
5544 | vec($_, 9, 1) = 1 == 512 00000000010000000000000000000000 | |
5545 | vec($_,10, 1) = 1 == 1024 00000000001000000000000000000000 | |
5546 | vec($_,11, 1) = 1 == 2048 00000000000100000000000000000000 | |
5547 | vec($_,12, 1) = 1 == 4096 00000000000010000000000000000000 | |
5548 | vec($_,13, 1) = 1 == 8192 00000000000001000000000000000000 | |
5549 | vec($_,14, 1) = 1 == 16384 00000000000000100000000000000000 | |
5550 | vec($_,15, 1) = 1 == 32768 00000000000000010000000000000000 | |
5551 | vec($_,16, 1) = 1 == 65536 00000000000000001000000000000000 | |
5552 | vec($_,17, 1) = 1 == 131072 00000000000000000100000000000000 | |
5553 | vec($_,18, 1) = 1 == 262144 00000000000000000010000000000000 | |
5554 | vec($_,19, 1) = 1 == 524288 00000000000000000001000000000000 | |
5555 | vec($_,20, 1) = 1 == 1048576 00000000000000000000100000000000 | |
5556 | vec($_,21, 1) = 1 == 2097152 00000000000000000000010000000000 | |
5557 | vec($_,22, 1) = 1 == 4194304 00000000000000000000001000000000 | |
5558 | vec($_,23, 1) = 1 == 8388608 00000000000000000000000100000000 | |
5559 | vec($_,24, 1) = 1 == 16777216 00000000000000000000000010000000 | |
5560 | vec($_,25, 1) = 1 == 33554432 00000000000000000000000001000000 | |
5561 | vec($_,26, 1) = 1 == 67108864 00000000000000000000000000100000 | |
5562 | vec($_,27, 1) = 1 == 134217728 00000000000000000000000000010000 | |
5563 | vec($_,28, 1) = 1 == 268435456 00000000000000000000000000001000 | |
5564 | vec($_,29, 1) = 1 == 536870912 00000000000000000000000000000100 | |
5565 | vec($_,30, 1) = 1 == 1073741824 00000000000000000000000000000010 | |
5566 | vec($_,31, 1) = 1 == 2147483648 00000000000000000000000000000001 | |
5567 | vec($_, 0, 2) = 1 == 1 10000000000000000000000000000000 | |
5568 | vec($_, 1, 2) = 1 == 4 00100000000000000000000000000000 | |
5569 | vec($_, 2, 2) = 1 == 16 00001000000000000000000000000000 | |
5570 | vec($_, 3, 2) = 1 == 64 00000010000000000000000000000000 | |
5571 | vec($_, 4, 2) = 1 == 256 00000000100000000000000000000000 | |
5572 | vec($_, 5, 2) = 1 == 1024 00000000001000000000000000000000 | |
5573 | vec($_, 6, 2) = 1 == 4096 00000000000010000000000000000000 | |
5574 | vec($_, 7, 2) = 1 == 16384 00000000000000100000000000000000 | |
5575 | vec($_, 8, 2) = 1 == 65536 00000000000000001000000000000000 | |
5576 | vec($_, 9, 2) = 1 == 262144 00000000000000000010000000000000 | |
5577 | vec($_,10, 2) = 1 == 1048576 00000000000000000000100000000000 | |
5578 | vec($_,11, 2) = 1 == 4194304 00000000000000000000001000000000 | |
5579 | vec($_,12, 2) = 1 == 16777216 00000000000000000000000010000000 | |
5580 | vec($_,13, 2) = 1 == 67108864 00000000000000000000000000100000 | |
5581 | vec($_,14, 2) = 1 == 268435456 00000000000000000000000000001000 | |
5582 | vec($_,15, 2) = 1 == 1073741824 00000000000000000000000000000010 | |
5583 | vec($_, 0, 2) = 2 == 2 01000000000000000000000000000000 | |
5584 | vec($_, 1, 2) = 2 == 8 00010000000000000000000000000000 | |
5585 | vec($_, 2, 2) = 2 == 32 00000100000000000000000000000000 | |
5586 | vec($_, 3, 2) = 2 == 128 00000001000000000000000000000000 | |
5587 | vec($_, 4, 2) = 2 == 512 00000000010000000000000000000000 | |
5588 | vec($_, 5, 2) = 2 == 2048 00000000000100000000000000000000 | |
5589 | vec($_, 6, 2) = 2 == 8192 00000000000001000000000000000000 | |
5590 | vec($_, 7, 2) = 2 == 32768 00000000000000010000000000000000 | |
5591 | vec($_, 8, 2) = 2 == 131072 00000000000000000100000000000000 | |
5592 | vec($_, 9, 2) = 2 == 524288 00000000000000000001000000000000 | |
5593 | vec($_,10, 2) = 2 == 2097152 00000000000000000000010000000000 | |
5594 | vec($_,11, 2) = 2 == 8388608 00000000000000000000000100000000 | |
5595 | vec($_,12, 2) = 2 == 33554432 00000000000000000000000001000000 | |
5596 | vec($_,13, 2) = 2 == 134217728 00000000000000000000000000010000 | |
5597 | vec($_,14, 2) = 2 == 536870912 00000000000000000000000000000100 | |
5598 | vec($_,15, 2) = 2 == 2147483648 00000000000000000000000000000001 | |
5599 | vec($_, 0, 4) = 1 == 1 10000000000000000000000000000000 | |
5600 | vec($_, 1, 4) = 1 == 16 00001000000000000000000000000000 | |
5601 | vec($_, 2, 4) = 1 == 256 00000000100000000000000000000000 | |
5602 | vec($_, 3, 4) = 1 == 4096 00000000000010000000000000000000 | |
5603 | vec($_, 4, 4) = 1 == 65536 00000000000000001000000000000000 | |
5604 | vec($_, 5, 4) = 1 == 1048576 00000000000000000000100000000000 | |
5605 | vec($_, 6, 4) = 1 == 16777216 00000000000000000000000010000000 | |
5606 | vec($_, 7, 4) = 1 == 268435456 00000000000000000000000000001000 | |
5607 | vec($_, 0, 4) = 2 == 2 01000000000000000000000000000000 | |
5608 | vec($_, 1, 4) = 2 == 32 00000100000000000000000000000000 | |
5609 | vec($_, 2, 4) = 2 == 512 00000000010000000000000000000000 | |
5610 | vec($_, 3, 4) = 2 == 8192 00000000000001000000000000000000 | |
5611 | vec($_, 4, 4) = 2 == 131072 00000000000000000100000000000000 | |
5612 | vec($_, 5, 4) = 2 == 2097152 00000000000000000000010000000000 | |
5613 | vec($_, 6, 4) = 2 == 33554432 00000000000000000000000001000000 | |
5614 | vec($_, 7, 4) = 2 == 536870912 00000000000000000000000000000100 | |
5615 | vec($_, 0, 4) = 4 == 4 00100000000000000000000000000000 | |
5616 | vec($_, 1, 4) = 4 == 64 00000010000000000000000000000000 | |
5617 | vec($_, 2, 4) = 4 == 1024 00000000001000000000000000000000 | |
5618 | vec($_, 3, 4) = 4 == 16384 00000000000000100000000000000000 | |
5619 | vec($_, 4, 4) = 4 == 262144 00000000000000000010000000000000 | |
5620 | vec($_, 5, 4) = 4 == 4194304 00000000000000000000001000000000 | |
5621 | vec($_, 6, 4) = 4 == 67108864 00000000000000000000000000100000 | |
5622 | vec($_, 7, 4) = 4 == 1073741824 00000000000000000000000000000010 | |
5623 | vec($_, 0, 4) = 8 == 8 00010000000000000000000000000000 | |
5624 | vec($_, 1, 4) = 8 == 128 00000001000000000000000000000000 | |
5625 | vec($_, 2, 4) = 8 == 2048 00000000000100000000000000000000 | |
5626 | vec($_, 3, 4) = 8 == 32768 00000000000000010000000000000000 | |
5627 | vec($_, 4, 4) = 8 == 524288 00000000000000000001000000000000 | |
5628 | vec($_, 5, 4) = 8 == 8388608 00000000000000000000000100000000 | |
5629 | vec($_, 6, 4) = 8 == 134217728 00000000000000000000000000010000 | |
5630 | vec($_, 7, 4) = 8 == 2147483648 00000000000000000000000000000001 | |
5631 | vec($_, 0, 8) = 1 == 1 10000000000000000000000000000000 | |
5632 | vec($_, 1, 8) = 1 == 256 00000000100000000000000000000000 | |
5633 | vec($_, 2, 8) = 1 == 65536 00000000000000001000000000000000 | |
5634 | vec($_, 3, 8) = 1 == 16777216 00000000000000000000000010000000 | |
5635 | vec($_, 0, 8) = 2 == 2 01000000000000000000000000000000 | |
5636 | vec($_, 1, 8) = 2 == 512 00000000010000000000000000000000 | |
5637 | vec($_, 2, 8) = 2 == 131072 00000000000000000100000000000000 | |
5638 | vec($_, 3, 8) = 2 == 33554432 00000000000000000000000001000000 | |
5639 | vec($_, 0, 8) = 4 == 4 00100000000000000000000000000000 | |
5640 | vec($_, 1, 8) = 4 == 1024 00000000001000000000000000000000 | |
5641 | vec($_, 2, 8) = 4 == 262144 00000000000000000010000000000000 | |
5642 | vec($_, 3, 8) = 4 == 67108864 00000000000000000000000000100000 | |
5643 | vec($_, 0, 8) = 8 == 8 00010000000000000000000000000000 | |
5644 | vec($_, 1, 8) = 8 == 2048 00000000000100000000000000000000 | |
5645 | vec($_, 2, 8) = 8 == 524288 00000000000000000001000000000000 | |
5646 | vec($_, 3, 8) = 8 == 134217728 00000000000000000000000000010000 | |
5647 | vec($_, 0, 8) = 16 == 16 00001000000000000000000000000000 | |
5648 | vec($_, 1, 8) = 16 == 4096 00000000000010000000000000000000 | |
5649 | vec($_, 2, 8) = 16 == 1048576 00000000000000000000100000000000 | |
5650 | vec($_, 3, 8) = 16 == 268435456 00000000000000000000000000001000 | |
5651 | vec($_, 0, 8) = 32 == 32 00000100000000000000000000000000 | |
5652 | vec($_, 1, 8) = 32 == 8192 00000000000001000000000000000000 | |
5653 | vec($_, 2, 8) = 32 == 2097152 00000000000000000000010000000000 | |
5654 | vec($_, 3, 8) = 32 == 536870912 00000000000000000000000000000100 | |
5655 | vec($_, 0, 8) = 64 == 64 00000010000000000000000000000000 | |
5656 | vec($_, 1, 8) = 64 == 16384 00000000000000100000000000000000 | |
5657 | vec($_, 2, 8) = 64 == 4194304 00000000000000000000001000000000 | |
5658 | vec($_, 3, 8) = 64 == 1073741824 00000000000000000000000000000010 | |
5659 | vec($_, 0, 8) = 128 == 128 00000001000000000000000000000000 | |
5660 | vec($_, 1, 8) = 128 == 32768 00000000000000010000000000000000 | |
5661 | vec($_, 2, 8) = 128 == 8388608 00000000000000000000000100000000 | |
5662 | vec($_, 3, 8) = 128 == 2147483648 00000000000000000000000000000001 | |
5663 | ||
a0d0e21e LW |
5664 | =item wait |
5665 | ||
2b5ab1e7 TC |
5666 | Behaves like the wait(2) system call on your system: it waits for a child |
5667 | process to terminate and returns the pid of the deceased process, or | |
19799a22 | 5668 | C<-1> if there are no child processes. The status is returned in C<$?>. |
2b5ab1e7 TC |
5669 | Note that a return value of C<-1> could mean that child processes are |
5670 | being automatically reaped, as described in L<perlipc>. | |
a0d0e21e LW |
5671 | |
5672 | =item waitpid PID,FLAGS | |
5673 | ||
2b5ab1e7 TC |
5674 | Waits for a particular child process to terminate and returns the pid of |
5675 | the deceased process, or C<-1> if there is no such child process. On some | |
5676 | systems, a value of 0 indicates that there are processes still running. | |
5677 | The status is returned in C<$?>. If you say | |
a0d0e21e | 5678 | |
5f05dabc | 5679 | use POSIX ":sys_wait_h"; |
5a964f20 | 5680 | #... |
2b5ab1e7 TC |
5681 | do { |
5682 | $kid = waitpid(-1,&WNOHANG); | |
5683 | } until $kid == -1; | |
a0d0e21e | 5684 | |
2b5ab1e7 TC |
5685 | then you can do a non-blocking wait for all pending zombie processes. |
5686 | Non-blocking wait is available on machines supporting either the | |
5687 | waitpid(2) or wait4(2) system calls. However, waiting for a particular | |
5688 | pid with FLAGS of C<0> is implemented everywhere. (Perl emulates the | |
5689 | system call by remembering the status values of processes that have | |
5690 | exited but have not been harvested by the Perl script yet.) | |
a0d0e21e | 5691 | |
2b5ab1e7 TC |
5692 | Note that on some systems, a return value of C<-1> could mean that child |
5693 | processes are being automatically reaped. See L<perlipc> for details, | |
5694 | and for other examples. | |
5a964f20 | 5695 | |
a0d0e21e LW |
5696 | =item wantarray |
5697 | ||
19799a22 GS |
5698 | Returns true if the context of the currently executing subroutine is |
5699 | looking for a list value. Returns false if the context is looking | |
54310121 | 5700 | for a scalar. Returns the undefined value if the context is looking |
5701 | for no value (void context). | |
a0d0e21e | 5702 | |
54310121 | 5703 | return unless defined wantarray; # don't bother doing more |
5704 | my @a = complex_calculation(); | |
5705 | return wantarray ? @a : "@a"; | |
a0d0e21e | 5706 | |
19799a22 GS |
5707 | This function should have been named wantlist() instead. |
5708 | ||
a0d0e21e LW |
5709 | =item warn LIST |
5710 | ||
19799a22 | 5711 | Produces a message on STDERR just like C<die>, but doesn't exit or throw |
774d564b | 5712 | an exception. |
5713 | ||
7660c0ab A |
5714 | If LIST is empty and C<$@> already contains a value (typically from a |
5715 | previous eval) that value is used after appending C<"\t...caught"> | |
19799a22 GS |
5716 | to C<$@>. This is useful for staying almost, but not entirely similar to |
5717 | C<die>. | |
43051805 | 5718 | |
7660c0ab | 5719 | If C<$@> is empty then the string C<"Warning: Something's wrong"> is used. |
43051805 | 5720 | |
774d564b | 5721 | No message is printed if there is a C<$SIG{__WARN__}> handler |
5722 | installed. It is the handler's responsibility to deal with the message | |
19799a22 | 5723 | as it sees fit (like, for instance, converting it into a C<die>). Most |
774d564b | 5724 | handlers must therefore make arrangements to actually display the |
19799a22 | 5725 | warnings that they are not prepared to deal with, by calling C<warn> |
774d564b | 5726 | again in the handler. Note that this is quite safe and will not |
5727 | produce an endless loop, since C<__WARN__> hooks are not called from | |
5728 | inside one. | |
5729 | ||
5730 | You will find this behavior is slightly different from that of | |
5731 | C<$SIG{__DIE__}> handlers (which don't suppress the error text, but can | |
19799a22 | 5732 | instead call C<die> again to change it). |
774d564b | 5733 | |
5734 | Using a C<__WARN__> handler provides a powerful way to silence all | |
5735 | warnings (even the so-called mandatory ones). An example: | |
5736 | ||
5737 | # wipe out *all* compile-time warnings | |
5738 | BEGIN { $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN } } | |
5739 | my $foo = 10; | |
5740 | my $foo = 20; # no warning about duplicate my $foo, | |
5741 | # but hey, you asked for it! | |
5742 | # no compile-time or run-time warnings before here | |
5743 | $DOWARN = 1; | |
5744 | ||
5745 | # run-time warnings enabled after here | |
5746 | warn "\$foo is alive and $foo!"; # does show up | |
5747 | ||
5748 | See L<perlvar> for details on setting C<%SIG> entries, and for more | |
2b5ab1e7 TC |
5749 | examples. See the Carp module for other kinds of warnings using its |
5750 | carp() and cluck() functions. | |
a0d0e21e LW |
5751 | |
5752 | =item write FILEHANDLE | |
5753 | ||
5754 | =item write EXPR | |
5755 | ||
5756 | =item write | |
5757 | ||
5a964f20 | 5758 | Writes a formatted record (possibly multi-line) to the specified FILEHANDLE, |
a0d0e21e | 5759 | using the format associated with that file. By default the format for |
54310121 | 5760 | a file is the one having the same name as the filehandle, but the |
19799a22 | 5761 | format for the current output channel (see the C<select> function) may be set |
184e9718 | 5762 | explicitly by assigning the name of the format to the C<$~> variable. |
a0d0e21e LW |
5763 | |
5764 | Top of form processing is handled automatically: if there is | |
5765 | insufficient room on the current page for the formatted record, the | |
5766 | page is advanced by writing a form feed, a special top-of-page format | |
5767 | is used to format the new page header, and then the record is written. | |
5768 | By default the top-of-page format is the name of the filehandle with | |
5769 | "_TOP" appended, but it may be dynamically set to the format of your | |
184e9718 | 5770 | choice by assigning the name to the C<$^> variable while the filehandle is |
a0d0e21e | 5771 | selected. The number of lines remaining on the current page is in |
7660c0ab | 5772 | variable C<$->, which can be set to C<0> to force a new page. |
a0d0e21e LW |
5773 | |
5774 | If FILEHANDLE is unspecified, output goes to the current default output | |
5775 | channel, which starts out as STDOUT but may be changed by the | |
19799a22 | 5776 | C<select> operator. If the FILEHANDLE is an EXPR, then the expression |
a0d0e21e LW |
5777 | is evaluated and the resulting string is used to look up the name of |
5778 | the FILEHANDLE at run time. For more on formats, see L<perlform>. | |
5779 | ||
19799a22 | 5780 | Note that write is I<not> the opposite of C<read>. Unfortunately. |
a0d0e21e LW |
5781 | |
5782 | =item y/// | |
5783 | ||
7660c0ab | 5784 | The transliteration operator. Same as C<tr///>. See L<perlop>. |
a0d0e21e LW |
5785 | |
5786 | =back |