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