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