Commit | Line | Data |
---|---|---|
a0d0e21e | 1 | =head1 NAME |
d74e8afc | 2 | X<function> |
a0d0e21e LW |
3 | |
4 | perlfunc - Perl builtin functions | |
5 | ||
6 | =head1 DESCRIPTION | |
7 | ||
8 | The functions in this section can serve as terms in an expression. | |
9 | They fall into two major categories: list operators and named unary | |
10 | operators. These differ in their precedence relationship with a | |
11 | following comma. (See the precedence table in L<perlop>.) List | |
12 | operators take more than one argument, while unary operators can never | |
13 | take more than one argument. Thus, a comma terminates the argument of | |
14 | a unary operator, but merely separates the arguments of a list | |
15 | operator. A unary operator generally provides a scalar context to its | |
2b5ab1e7 | 16 | argument, while a list operator may provide either scalar or list |
3b10bc60 | 17 | contexts for its arguments. If it does both, scalar arguments |
18 | come first and list argument follow, and there can only ever | |
19 | be one such list argument. For instance, splice() has three scalar | |
2b5ab1e7 TC |
20 | arguments followed by a list, whereas gethostbyname() has four scalar |
21 | arguments. | |
a0d0e21e LW |
22 | |
23 | In the syntax descriptions that follow, list operators that expect a | |
3b10bc60 | 24 | list (and provide list context for elements of the list) are shown |
a0d0e21e LW |
25 | with LIST as an argument. Such a list may consist of any combination |
26 | of scalar arguments or list values; the list values will be included | |
27 | in the list as if each individual element were interpolated at that | |
28 | point in the list, forming a longer single-dimensional list value. | |
8bdbc703 | 29 | Commas should separate literal elements of the LIST. |
a0d0e21e LW |
30 | |
31 | Any function in the list below may be used either with or without | |
32 | parentheses around its arguments. (The syntax descriptions omit the | |
3b10bc60 | 33 | parentheses.) If you use parentheses, the simple but occasionally |
34 | surprising rule is this: It I<looks> like a function, therefore it I<is> a | |
a0d0e21e | 35 | function, and precedence doesn't matter. Otherwise it's a list |
3b10bc60 | 36 | operator or unary operator, and precedence does matter. Whitespace |
37 | between the function and left parenthesis doesn't count, so sometimes | |
38 | you need to be careful: | |
a0d0e21e | 39 | |
5ed4f2ec | 40 | print 1+2+4; # Prints 7. |
41 | print(1+2) + 4; # Prints 3. | |
42 | print (1+2)+4; # Also prints 3! | |
43 | print +(1+2)+4; # Prints 7. | |
44 | print ((1+2)+4); # Prints 7. | |
a0d0e21e LW |
45 | |
46 | If you run Perl with the B<-w> switch it can warn you about this. For | |
47 | example, the third line above produces: | |
48 | ||
49 | print (...) interpreted as function at - line 1. | |
50 | Useless use of integer addition in void context at - line 1. | |
51 | ||
2b5ab1e7 TC |
52 | A few functions take no arguments at all, and therefore work as neither |
53 | unary nor list operators. These include such functions as C<time> | |
54 | and C<endpwent>. For example, C<time+86_400> always means | |
55 | C<time() + 86_400>. | |
56 | ||
a0d0e21e | 57 | For functions that can be used in either a scalar or list context, |
54310121 | 58 | nonabortive failure is generally indicated in a scalar context by |
a0d0e21e | 59 | returning the undefined value, and in a list context by returning the |
3b10bc60 | 60 | empty list. |
a0d0e21e | 61 | |
5a964f20 TC |
62 | Remember the following important rule: There is B<no rule> that relates |
63 | the behavior of an expression in list context to its behavior in scalar | |
64 | context, or vice versa. It might do two totally different things. | |
80d38338 | 65 | Each operator and function decides which sort of value would be most |
2b5ab1e7 | 66 | appropriate to return in scalar context. Some operators return the |
5a964f20 | 67 | length of the list that would have been returned in list context. Some |
a0d0e21e LW |
68 | operators return the first value in the list. Some operators return the |
69 | last value in the list. Some operators return a count of successful | |
70 | operations. In general, they do what you want, unless you want | |
71 | consistency. | |
d74e8afc | 72 | X<context> |
a0d0e21e | 73 | |
d1be9408 | 74 | A named array in scalar context is quite different from what would at |
5a964f20 TC |
75 | first glance appear to be a list in scalar context. You can't get a list |
76 | like C<(1,2,3)> into being in scalar context, because the compiler knows | |
77 | the context at compile time. It would generate the scalar comma operator | |
78 | there, not the list construction version of the comma. That means it | |
79 | was never a list to start with. | |
80 | ||
3b10bc60 | 81 | In general, functions in Perl that serve as wrappers for system calls ("syscalls") |
f86cebdf | 82 | of the same name (like chown(2), fork(2), closedir(2), etc.) all return |
5a964f20 TC |
83 | true when they succeed and C<undef> otherwise, as is usually mentioned |
84 | in the descriptions below. This is different from the C interfaces, | |
19799a22 GS |
85 | which return C<-1> on failure. Exceptions to this rule are C<wait>, |
86 | C<waitpid>, and C<syscall>. System calls also set the special C<$!> | |
5a964f20 TC |
87 | variable on failure. Other functions do not, except accidentally. |
88 | ||
88e1f1a2 JV |
89 | Extension modules can also hook into the Perl parser to define new |
90 | kinds of keyword-headed expression. These may look like functions, but | |
91 | may also look completely different. The syntax following the keyword | |
92 | is defined entirely by the extension. If you are an implementor, see | |
93 | L<perlapi/PL_keyword_plugin> for the mechanism. If you are using such | |
94 | a module, see the module's documentation for details of the syntax that | |
95 | it defines. | |
96 | ||
cb1a09d0 | 97 | =head2 Perl Functions by Category |
d74e8afc | 98 | X<function> |
cb1a09d0 AD |
99 | |
100 | Here are Perl's functions (including things that look like | |
5a964f20 | 101 | functions, like some keywords and named operators) |
cb1a09d0 AD |
102 | arranged by category. Some functions appear in more |
103 | than one place. | |
104 | ||
13a2d996 | 105 | =over 4 |
cb1a09d0 AD |
106 | |
107 | =item Functions for SCALARs or strings | |
d74e8afc | 108 | X<scalar> X<string> X<character> |
cb1a09d0 | 109 | |
22fae026 | 110 | C<chomp>, C<chop>, C<chr>, C<crypt>, C<hex>, C<index>, C<lc>, C<lcfirst>, |
1dc8ecb8 | 111 | C<length>, C<oct>, C<ord>, C<pack>, C<q//>, C<qq//>, C<reverse>, |
945c54fd | 112 | C<rindex>, C<sprintf>, C<substr>, C<tr///>, C<uc>, C<ucfirst>, C<y///> |
cb1a09d0 AD |
113 | |
114 | =item Regular expressions and pattern matching | |
d74e8afc | 115 | X<regular expression> X<regex> X<regexp> |
cb1a09d0 | 116 | |
ab4f32c2 | 117 | C<m//>, C<pos>, C<quotemeta>, C<s///>, C<split>, C<study>, C<qr//> |
cb1a09d0 AD |
118 | |
119 | =item Numeric functions | |
d74e8afc | 120 | X<numeric> X<number> X<trigonometric> X<trigonometry> |
cb1a09d0 | 121 | |
22fae026 TM |
122 | C<abs>, C<atan2>, C<cos>, C<exp>, C<hex>, C<int>, C<log>, C<oct>, C<rand>, |
123 | C<sin>, C<sqrt>, C<srand> | |
cb1a09d0 AD |
124 | |
125 | =item Functions for real @ARRAYs | |
d74e8afc | 126 | X<array> |
cb1a09d0 | 127 | |
22fae026 | 128 | C<pop>, C<push>, C<shift>, C<splice>, C<unshift> |
cb1a09d0 AD |
129 | |
130 | =item Functions for list data | |
d74e8afc | 131 | X<list> |
cb1a09d0 | 132 | |
1dc8ecb8 | 133 | C<grep>, C<join>, C<map>, C<qw//>, C<reverse>, C<sort>, C<unpack> |
cb1a09d0 AD |
134 | |
135 | =item Functions for real %HASHes | |
d74e8afc | 136 | X<hash> |
cb1a09d0 | 137 | |
22fae026 | 138 | C<delete>, C<each>, C<exists>, C<keys>, C<values> |
cb1a09d0 AD |
139 | |
140 | =item Input and output functions | |
d74e8afc | 141 | X<I/O> X<input> X<output> X<dbm> |
cb1a09d0 | 142 | |
22fae026 TM |
143 | C<binmode>, C<close>, C<closedir>, C<dbmclose>, C<dbmopen>, C<die>, C<eof>, |
144 | C<fileno>, C<flock>, C<format>, C<getc>, C<print>, C<printf>, C<read>, | |
0d863452 | 145 | C<readdir>, C<rewinddir>, C<say>, C<seek>, C<seekdir>, C<select>, C<syscall>, |
22fae026 TM |
146 | C<sysread>, C<sysseek>, C<syswrite>, C<tell>, C<telldir>, C<truncate>, |
147 | C<warn>, C<write> | |
cb1a09d0 AD |
148 | |
149 | =item Functions for fixed length data or records | |
150 | ||
22fae026 | 151 | C<pack>, C<read>, C<syscall>, C<sysread>, C<syswrite>, C<unpack>, C<vec> |
cb1a09d0 AD |
152 | |
153 | =item Functions for filehandles, files, or directories | |
d74e8afc | 154 | X<file> X<filehandle> X<directory> X<pipe> X<link> X<symlink> |
cb1a09d0 | 155 | |
22fae026 | 156 | C<-I<X>>, C<chdir>, C<chmod>, C<chown>, C<chroot>, C<fcntl>, C<glob>, |
5ff3f7a4 | 157 | C<ioctl>, C<link>, C<lstat>, C<mkdir>, C<open>, C<opendir>, |
1e278fd9 JH |
158 | C<readlink>, C<rename>, C<rmdir>, C<stat>, C<symlink>, C<sysopen>, |
159 | C<umask>, C<unlink>, C<utime> | |
cb1a09d0 | 160 | |
cf264981 | 161 | =item Keywords related to the control flow of your Perl program |
d74e8afc | 162 | X<control flow> |
cb1a09d0 | 163 | |
98293880 JH |
164 | C<caller>, C<continue>, C<die>, C<do>, C<dump>, C<eval>, C<exit>, |
165 | C<goto>, C<last>, C<next>, C<redo>, C<return>, C<sub>, C<wantarray> | |
cb1a09d0 | 166 | |
0d863452 RH |
167 | =item Keywords related to switch |
168 | ||
36fb85f3 | 169 | C<break>, C<continue>, C<given>, C<when>, C<default> |
0d863452 | 170 | |
3b10bc60 | 171 | (These are available only if you enable the C<"switch"> feature. |
0d863452 RH |
172 | See L<feature> and L<perlsyn/"Switch statements">.) |
173 | ||
54310121 | 174 | =item Keywords related to scoping |
cb1a09d0 | 175 | |
36fb85f3 RGS |
176 | C<caller>, C<import>, C<local>, C<my>, C<our>, C<state>, C<package>, |
177 | C<use> | |
178 | ||
3b10bc60 | 179 | (C<state> is available only if the C<"state"> feature is enabled. See |
36fb85f3 | 180 | L<feature>.) |
cb1a09d0 AD |
181 | |
182 | =item Miscellaneous functions | |
183 | ||
36fb85f3 | 184 | C<defined>, C<dump>, C<eval>, C<formline>, C<local>, C<my>, C<our>, |
834df1c5 | 185 | C<reset>, C<scalar>, C<state>, C<undef>, C<wantarray> |
cb1a09d0 AD |
186 | |
187 | =item Functions for processes and process groups | |
d74e8afc | 188 | X<process> X<pid> X<process id> |
cb1a09d0 | 189 | |
22fae026 | 190 | C<alarm>, C<exec>, C<fork>, C<getpgrp>, C<getppid>, C<getpriority>, C<kill>, |
1dc8ecb8 | 191 | C<pipe>, C<qx//>, C<setpgrp>, C<setpriority>, C<sleep>, C<system>, |
22fae026 | 192 | C<times>, C<wait>, C<waitpid> |
cb1a09d0 | 193 | |
3b10bc60 | 194 | =item Keywords related to Perl modules |
d74e8afc | 195 | X<module> |
cb1a09d0 | 196 | |
22fae026 | 197 | C<do>, C<import>, C<no>, C<package>, C<require>, C<use> |
cb1a09d0 | 198 | |
353c6505 | 199 | =item Keywords related to classes and object-orientation |
d74e8afc | 200 | X<object> X<class> X<package> |
cb1a09d0 | 201 | |
22fae026 TM |
202 | C<bless>, C<dbmclose>, C<dbmopen>, C<package>, C<ref>, C<tie>, C<tied>, |
203 | C<untie>, C<use> | |
cb1a09d0 AD |
204 | |
205 | =item Low-level socket functions | |
d74e8afc | 206 | X<socket> X<sock> |
cb1a09d0 | 207 | |
22fae026 TM |
208 | C<accept>, C<bind>, C<connect>, C<getpeername>, C<getsockname>, |
209 | C<getsockopt>, C<listen>, C<recv>, C<send>, C<setsockopt>, C<shutdown>, | |
737dd4b4 | 210 | C<socket>, C<socketpair> |
cb1a09d0 AD |
211 | |
212 | =item System V interprocess communication functions | |
d74e8afc | 213 | X<IPC> X<System V> X<semaphore> X<shared memory> X<memory> X<message> |
cb1a09d0 | 214 | |
22fae026 TM |
215 | C<msgctl>, C<msgget>, C<msgrcv>, C<msgsnd>, C<semctl>, C<semget>, C<semop>, |
216 | C<shmctl>, C<shmget>, C<shmread>, C<shmwrite> | |
cb1a09d0 AD |
217 | |
218 | =item Fetching user and group info | |
d74e8afc | 219 | X<user> X<group> X<password> X<uid> X<gid> X<passwd> X</etc/passwd> |
cb1a09d0 | 220 | |
22fae026 TM |
221 | C<endgrent>, C<endhostent>, C<endnetent>, C<endpwent>, C<getgrent>, |
222 | C<getgrgid>, C<getgrnam>, C<getlogin>, C<getpwent>, C<getpwnam>, | |
223 | C<getpwuid>, C<setgrent>, C<setpwent> | |
cb1a09d0 AD |
224 | |
225 | =item Fetching network info | |
d74e8afc | 226 | X<network> X<protocol> X<host> X<hostname> X<IP> X<address> X<service> |
cb1a09d0 | 227 | |
22fae026 TM |
228 | C<endprotoent>, C<endservent>, C<gethostbyaddr>, C<gethostbyname>, |
229 | C<gethostent>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>, | |
230 | C<getprotobyname>, C<getprotobynumber>, C<getprotoent>, | |
231 | C<getservbyname>, C<getservbyport>, C<getservent>, C<sethostent>, | |
232 | C<setnetent>, C<setprotoent>, C<setservent> | |
cb1a09d0 AD |
233 | |
234 | =item Time-related functions | |
d74e8afc | 235 | X<time> X<date> |
cb1a09d0 | 236 | |
22fae026 | 237 | C<gmtime>, C<localtime>, C<time>, C<times> |
cb1a09d0 | 238 | |
37798a01 | 239 | =item Functions new in perl5 |
d74e8afc | 240 | X<perl5> |
37798a01 | 241 | |
834df1c5 SP |
242 | C<abs>, C<bless>, C<break>, C<chomp>, C<chr>, C<continue>, C<default>, |
243 | C<exists>, C<formline>, C<given>, C<glob>, C<import>, C<lc>, C<lcfirst>, | |
1dc8ecb8 | 244 | C<lock>, C<map>, C<my>, C<no>, C<our>, C<prototype>, C<qr//>, C<qw//>, C<qx//>, |
834df1c5 SP |
245 | C<readline>, C<readpipe>, C<ref>, C<sub>*, C<sysopen>, C<tie>, C<tied>, C<uc>, |
246 | C<ucfirst>, C<untie>, C<use>, C<when> | |
37798a01 | 247 | |
3b10bc60 | 248 | * C<sub> was a keyword in Perl 4, but in Perl 5 it is an |
5a964f20 | 249 | operator, which can be used in expressions. |
37798a01 | 250 | |
251 | =item Functions obsoleted in perl5 | |
252 | ||
22fae026 | 253 | C<dbmclose>, C<dbmopen> |
37798a01 | 254 | |
cb1a09d0 AD |
255 | =back |
256 | ||
60f9f73c | 257 | =head2 Portability |
d74e8afc | 258 | X<portability> X<Unix> X<portable> |
60f9f73c | 259 | |
2b5ab1e7 TC |
260 | Perl was born in Unix and can therefore access all common Unix |
261 | system calls. In non-Unix environments, the functionality of some | |
262 | Unix system calls may not be available, or details of the available | |
263 | functionality may differ slightly. The Perl functions affected | |
60f9f73c JH |
264 | by this are: |
265 | ||
266 | C<-X>, C<binmode>, C<chmod>, C<chown>, C<chroot>, C<crypt>, | |
267 | C<dbmclose>, C<dbmopen>, C<dump>, C<endgrent>, C<endhostent>, | |
268 | C<endnetent>, C<endprotoent>, C<endpwent>, C<endservent>, C<exec>, | |
ef5a6dd7 JH |
269 | C<fcntl>, C<flock>, C<fork>, C<getgrent>, C<getgrgid>, C<gethostbyname>, |
270 | C<gethostent>, C<getlogin>, C<getnetbyaddr>, C<getnetbyname>, C<getnetent>, | |
54d7b083 | 271 | C<getppid>, C<getpgrp>, C<getpriority>, C<getprotobynumber>, |
60f9f73c JH |
272 | C<getprotoent>, C<getpwent>, C<getpwnam>, C<getpwuid>, |
273 | C<getservbyport>, C<getservent>, C<getsockopt>, C<glob>, C<ioctl>, | |
274 | C<kill>, C<link>, C<lstat>, C<msgctl>, C<msgget>, C<msgrcv>, | |
2b5ab1e7 | 275 | C<msgsnd>, C<open>, C<pipe>, C<readlink>, C<rename>, C<select>, C<semctl>, |
60f9f73c JH |
276 | C<semget>, C<semop>, C<setgrent>, C<sethostent>, C<setnetent>, |
277 | C<setpgrp>, C<setpriority>, C<setprotoent>, C<setpwent>, | |
278 | C<setservent>, C<setsockopt>, C<shmctl>, C<shmget>, C<shmread>, | |
737dd4b4 | 279 | C<shmwrite>, C<socket>, C<socketpair>, |
80cbd5ad JH |
280 | C<stat>, C<symlink>, C<syscall>, C<sysopen>, C<system>, |
281 | C<times>, C<truncate>, C<umask>, C<unlink>, | |
2b5ab1e7 | 282 | C<utime>, C<wait>, C<waitpid> |
60f9f73c JH |
283 | |
284 | For more information about the portability of these functions, see | |
285 | L<perlport> and other available platform-specific documentation. | |
286 | ||
cb1a09d0 AD |
287 | =head2 Alphabetical Listing of Perl Functions |
288 | ||
3b10bc60 | 289 | =over |
a0d0e21e | 290 | |
5b3c99c0 | 291 | =item -X FILEHANDLE |
d74e8afc ITB |
292 | 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> |
293 | 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 | 294 | |
5b3c99c0 | 295 | =item -X EXPR |
a0d0e21e | 296 | |
5228a96c SP |
297 | =item -X DIRHANDLE |
298 | ||
5b3c99c0 | 299 | =item -X |
a0d0e21e LW |
300 | |
301 | A file test, where X is one of the letters listed below. This unary | |
5228a96c SP |
302 | operator takes one argument, either a filename, a filehandle, or a dirhandle, |
303 | and tests the associated file to see if something is true about it. If the | |
7660c0ab | 304 | argument is omitted, tests C<$_>, except for C<-t>, which tests STDIN. |
19799a22 | 305 | Unless otherwise documented, it returns C<1> for true and C<''> for false, or |
a0d0e21e | 306 | the undefined value if the file doesn't exist. Despite the funny |
d0821a6a | 307 | names, precedence is the same as any other named unary operator. The |
a0d0e21e LW |
308 | operator may be any of: |
309 | ||
5ed4f2ec | 310 | -r File is readable by effective uid/gid. |
311 | -w File is writable by effective uid/gid. | |
312 | -x File is executable by effective uid/gid. | |
313 | -o File is owned by effective uid. | |
a0d0e21e | 314 | |
5ed4f2ec | 315 | -R File is readable by real uid/gid. |
316 | -W File is writable by real uid/gid. | |
317 | -X File is executable by real uid/gid. | |
318 | -O File is owned by real uid. | |
a0d0e21e | 319 | |
5ed4f2ec | 320 | -e File exists. |
321 | -z File has zero size (is empty). | |
322 | -s File has nonzero size (returns size in bytes). | |
a0d0e21e | 323 | |
5ed4f2ec | 324 | -f File is a plain file. |
325 | -d File is a directory. | |
326 | -l File is a symbolic link. | |
327 | -p File is a named pipe (FIFO), or Filehandle is a pipe. | |
328 | -S File is a socket. | |
329 | -b File is a block special file. | |
330 | -c File is a character special file. | |
331 | -t Filehandle is opened to a tty. | |
a0d0e21e | 332 | |
5ed4f2ec | 333 | -u File has setuid bit set. |
334 | -g File has setgid bit set. | |
335 | -k File has sticky bit set. | |
a0d0e21e | 336 | |
5ed4f2ec | 337 | -T File is an ASCII text file (heuristic guess). |
338 | -B File is a "binary" file (opposite of -T). | |
a0d0e21e | 339 | |
5ed4f2ec | 340 | -M Script start time minus file modification time, in days. |
341 | -A Same for access time. | |
342 | -C Same for inode change time (Unix, may differ for other platforms) | |
a0d0e21e | 343 | |
a0d0e21e LW |
344 | Example: |
345 | ||
346 | while (<>) { | |
a9a5a0dc VP |
347 | chomp; |
348 | next unless -f $_; # ignore specials | |
349 | #... | |
a0d0e21e LW |
350 | } |
351 | ||
5ff3f7a4 GS |
352 | The interpretation of the file permission operators C<-r>, C<-R>, |
353 | C<-w>, C<-W>, C<-x>, and C<-X> is by default based solely on the mode | |
354 | of the file and the uids and gids of the user. There may be other | |
ecae030f MO |
355 | reasons you can't actually read, write, or execute the file: for |
356 | example network filesystem access controls, ACLs (access control lists), | |
357 | read-only filesystems, and unrecognized executable formats. Note | |
358 | that the use of these six specific operators to verify if some operation | |
359 | is possible is usually a mistake, because it may be open to race | |
360 | conditions. | |
5ff3f7a4 | 361 | |
2b5ab1e7 TC |
362 | Also note that, for the superuser on the local filesystems, the C<-r>, |
363 | C<-R>, C<-w>, and C<-W> tests always return 1, and C<-x> and C<-X> return 1 | |
5ff3f7a4 GS |
364 | if any execute bit is set in the mode. Scripts run by the superuser |
365 | may thus need to do a stat() to determine the actual mode of the file, | |
2b5ab1e7 | 366 | or temporarily set their effective uid to something else. |
5ff3f7a4 GS |
367 | |
368 | If you are using ACLs, there is a pragma called C<filetest> that may | |
369 | produce more accurate results than the bare stat() mode bits. | |
5ff3f7a4 | 370 | When under the C<use filetest 'access'> the above-mentioned filetests |
3b10bc60 | 371 | test whether the permission can (not) be granted using the |
372 | access(2) family of system calls. Also note that the C<-x> and C<-X> may | |
5ff3f7a4 GS |
373 | under this pragma return true even if there are no execute permission |
374 | bits set (nor any extra execute permission ACLs). This strangeness is | |
ecae030f MO |
375 | due to the underlying system calls' definitions. Note also that, due to |
376 | the implementation of C<use filetest 'access'>, the C<_> special | |
377 | filehandle won't cache the results of the file tests when this pragma is | |
378 | in effect. Read the documentation for the C<filetest> pragma for more | |
379 | information. | |
5ff3f7a4 | 380 | |
a0d0e21e | 381 | Note that C<-s/a/b/> does not do a negated substitution. Saying |
3b10bc60 | 382 | C<-exp($foo)> still works as expected, however: only single letters |
a0d0e21e LW |
383 | following a minus are interpreted as file tests. |
384 | ||
385 | The C<-T> and C<-B> switches work as follows. The first block or so of the | |
386 | file is examined for odd characters such as strange control codes or | |
61eff3bc | 387 | characters with the high bit set. If too many strange characters (>30%) |
cf264981 | 388 | are found, it's a C<-B> file; otherwise it's a C<-T> file. Also, any file |
3b10bc60 | 389 | containing a zero byte in the first block is considered a binary file. If C<-T> |
9124316e | 390 | or C<-B> is used on a filehandle, the current IO buffer is examined |
3b10bc60 | 391 | rather than the first block. Both C<-T> and C<-B> return true on an empty |
54310121 | 392 | file, or a file at EOF when testing a filehandle. Because you have to |
4633a7c4 LW |
393 | read a file to do the C<-T> test, on most occasions you want to use a C<-f> |
394 | against the file first, as in C<next unless -f $file && -T $file>. | |
a0d0e21e | 395 | |
19799a22 | 396 | If any of the file tests (or either the C<stat> or C<lstat> operators) are given |
28757baa | 397 | the special filehandle consisting of a solitary underline, then the stat |
a0d0e21e LW |
398 | structure of the previous file test (or stat operator) is used, saving |
399 | a system call. (This doesn't work with C<-t>, and you need to remember | |
3b10bc60 | 400 | that lstat() and C<-l> leave values in the stat structure for the |
5c9aa243 | 401 | symbolic link, not the real file.) (Also, if the stat buffer was filled by |
cf264981 | 402 | an C<lstat> call, C<-T> and C<-B> will reset it with the results of C<stat _>). |
5c9aa243 | 403 | Example: |
a0d0e21e LW |
404 | |
405 | print "Can do.\n" if -r $a || -w _ || -x _; | |
406 | ||
407 | stat($filename); | |
408 | print "Readable\n" if -r _; | |
409 | print "Writable\n" if -w _; | |
410 | print "Executable\n" if -x _; | |
411 | print "Setuid\n" if -u _; | |
412 | print "Setgid\n" if -g _; | |
413 | print "Sticky\n" if -k _; | |
414 | print "Text\n" if -T _; | |
415 | print "Binary\n" if -B _; | |
416 | ||
fbb0b3b3 RGS |
417 | As of Perl 5.9.1, as a form of purely syntactic sugar, you can stack file |
418 | test operators, in a way that C<-f -w -x $file> is equivalent to | |
3b10bc60 | 419 | C<-x $file && -w _ && -f _>. (This is only fancy fancy: if you use |
fbb0b3b3 RGS |
420 | the return value of C<-f $file> as an argument to another filetest |
421 | operator, no special magic will happen.) | |
422 | ||
a0d0e21e | 423 | =item abs VALUE |
d74e8afc | 424 | X<abs> X<absolute> |
a0d0e21e | 425 | |
54310121 | 426 | =item abs |
bbce6d69 | 427 | |
a0d0e21e | 428 | Returns the absolute value of its argument. |
7660c0ab | 429 | If VALUE is omitted, uses C<$_>. |
a0d0e21e LW |
430 | |
431 | =item accept NEWSOCKET,GENERICSOCKET | |
d74e8afc | 432 | X<accept> |
a0d0e21e | 433 | |
3b10bc60 | 434 | Accepts an incoming socket connect, just as accept(2) |
19799a22 | 435 | does. Returns the packed address if it succeeded, false otherwise. |
2b5ab1e7 | 436 | See the example in L<perlipc/"Sockets: Client/Server Communication">. |
a0d0e21e | 437 | |
8d2a6795 GS |
438 | On systems that support a close-on-exec flag on files, the flag will |
439 | be set for the newly opened file descriptor, as determined by the | |
440 | value of $^F. See L<perlvar/$^F>. | |
441 | ||
a0d0e21e | 442 | =item alarm SECONDS |
d74e8afc ITB |
443 | X<alarm> |
444 | X<SIGALRM> | |
445 | X<timer> | |
a0d0e21e | 446 | |
54310121 | 447 | =item alarm |
bbce6d69 | 448 | |
a0d0e21e | 449 | Arranges to have a SIGALRM delivered to this process after the |
cf264981 | 450 | specified number of wallclock seconds has elapsed. If SECONDS is not |
d400eac8 JH |
451 | specified, the value stored in C<$_> is used. (On some machines, |
452 | unfortunately, the elapsed time may be up to one second less or more | |
453 | than you specified because of how seconds are counted, and process | |
454 | scheduling may delay the delivery of the signal even further.) | |
455 | ||
456 | Only one timer may be counting at once. Each call disables the | |
457 | previous timer, and an argument of C<0> may be supplied to cancel the | |
458 | previous timer without starting a new one. The returned value is the | |
459 | amount of time remaining on the previous timer. | |
a0d0e21e | 460 | |
2bc69794 BS |
461 | For delays of finer granularity than one second, the Time::HiRes module |
462 | (from CPAN, and starting from Perl 5.8 part of the standard | |
463 | distribution) provides ualarm(). You may also use Perl's four-argument | |
464 | version of select() leaving the first three arguments undefined, or you | |
465 | might be able to use the C<syscall> interface to access setitimer(2) if | |
466 | your system supports it. See L<perlfaq8> for details. | |
2b5ab1e7 | 467 | |
80d38338 TC |
468 | It is usually a mistake to intermix C<alarm> and C<sleep> calls, because |
469 | C<sleep> may be internally implemented on your system with C<alarm>. | |
a0d0e21e | 470 | |
19799a22 GS |
471 | If you want to use C<alarm> to time out a system call you need to use an |
472 | C<eval>/C<die> pair. You can't rely on the alarm causing the system call to | |
f86cebdf | 473 | fail with C<$!> set to C<EINTR> because Perl sets up signal handlers to |
19799a22 | 474 | restart system calls on some systems. Using C<eval>/C<die> always works, |
5a964f20 | 475 | modulo the caveats given in L<perlipc/"Signals">. |
ff68c719 | 476 | |
477 | eval { | |
a9a5a0dc VP |
478 | local $SIG{ALRM} = sub { die "alarm\n" }; # NB: \n required |
479 | alarm $timeout; | |
480 | $nread = sysread SOCKET, $buffer, $size; | |
481 | alarm 0; | |
ff68c719 | 482 | }; |
ff68c719 | 483 | if ($@) { |
a9a5a0dc | 484 | die unless $@ eq "alarm\n"; # propagate unexpected errors |
5ed4f2ec | 485 | # timed out |
ff68c719 | 486 | } |
487 | else { | |
5ed4f2ec | 488 | # didn't |
ff68c719 | 489 | } |
490 | ||
91d81acc JH |
491 | For more information see L<perlipc>. |
492 | ||
a0d0e21e | 493 | =item atan2 Y,X |
d74e8afc | 494 | X<atan2> X<arctangent> X<tan> X<tangent> |
a0d0e21e LW |
495 | |
496 | Returns the arctangent of Y/X in the range -PI to PI. | |
497 | ||
ca6e1c26 | 498 | For the tangent operation, you may use the C<Math::Trig::tan> |
28757baa | 499 | function, or use the familiar relation: |
500 | ||
501 | sub tan { sin($_[0]) / cos($_[0]) } | |
502 | ||
a1021d57 RGS |
503 | The return value for C<atan2(0,0)> is implementation-defined; consult |
504 | your atan2(3) manpage for more information. | |
bf5f1b4c | 505 | |
a0d0e21e | 506 | =item bind SOCKET,NAME |
d74e8afc | 507 | X<bind> |
a0d0e21e | 508 | |
3b10bc60 | 509 | Binds a network address to a socket, just as bind(2) |
19799a22 | 510 | does. Returns true if it succeeded, false otherwise. NAME should be a |
4633a7c4 LW |
511 | packed address of the appropriate type for the socket. See the examples in |
512 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 513 | |
fae2c0fb | 514 | =item binmode FILEHANDLE, LAYER |
d74e8afc | 515 | X<binmode> X<binary> X<text> X<DOS> X<Windows> |
1c1fc3ea | 516 | |
a0d0e21e LW |
517 | =item binmode FILEHANDLE |
518 | ||
1cbfc93d NIS |
519 | Arranges for FILEHANDLE to be read or written in "binary" or "text" |
520 | mode on systems where the run-time libraries distinguish between | |
521 | binary and text files. If FILEHANDLE is an expression, the value is | |
522 | taken as the name of the filehandle. Returns true on success, | |
b5fe5ca2 | 523 | otherwise it returns C<undef> and sets C<$!> (errno). |
1cbfc93d | 524 | |
d807c6f4 JH |
525 | On some systems (in general, DOS and Windows-based systems) binmode() |
526 | is necessary when you're not working with a text file. For the sake | |
527 | of portability it is a good idea to always use it when appropriate, | |
528 | and to never use it when it isn't appropriate. Also, people can | |
529 | set their I/O to be by default UTF-8 encoded Unicode, not bytes. | |
530 | ||
531 | In other words: regardless of platform, use binmode() on binary data, | |
532 | like for example images. | |
533 | ||
534 | If LAYER is present it is a single string, but may contain multiple | |
3b10bc60 | 535 | directives. The directives alter the behaviour of the filehandle. |
920f5fe1 | 536 | When LAYER is present using binmode on a text file makes sense. |
d807c6f4 | 537 | |
fae2c0fb | 538 | If LAYER is omitted or specified as C<:raw> the filehandle is made |
0226bbdb NIS |
539 | suitable for passing binary data. This includes turning off possible CRLF |
540 | translation and marking it as bytes (as opposed to Unicode characters). | |
749683d2 | 541 | Note that, despite what may be implied in I<"Programming Perl"> (the |
3b10bc60 | 542 | Camel, 3rd edition) or elsewhere, C<:raw> is I<not> simply the inverse of C<:crlf>. |
543 | Other layers that would affect the binary nature of the stream are | |
544 | I<also> disabled. See L<PerlIO>, L<perlrun>, and the discussion about the | |
0226bbdb | 545 | PERLIO environment variable. |
01e6739c | 546 | |
3b10bc60 | 547 | The C<:bytes>, C<:crlf>, C<:utf8>, and any other directives of the |
d807c6f4 JH |
548 | form C<:...>, are called I/O I<layers>. The C<open> pragma can be used to |
549 | establish default I/O layers. See L<open>. | |
550 | ||
fae2c0fb RGS |
551 | I<The LAYER parameter of the binmode() function is described as "DISCIPLINE" |
552 | in "Programming Perl, 3rd Edition". However, since the publishing of this | |
553 | book, by many known as "Camel III", the consensus of the naming of this | |
554 | functionality has moved from "discipline" to "layer". All documentation | |
555 | of this version of Perl therefore refers to "layers" rather than to | |
556 | "disciplines". Now back to the regularly scheduled documentation...> | |
557 | ||
6902c96a T |
558 | To mark FILEHANDLE as UTF-8, use C<:utf8> or C<:encoding(utf8)>. |
559 | C<:utf8> just marks the data as UTF-8 without further checking, | |
560 | while C<:encoding(utf8)> checks the data for actually being valid | |
561 | UTF-8. More details can be found in L<PerlIO::encoding>. | |
1cbfc93d | 562 | |
ed53a2bb | 563 | In general, binmode() should be called after open() but before any I/O |
3b10bc60 | 564 | is done on the filehandle. Calling binmode() normally flushes any |
01e6739c | 565 | pending buffered output data (and perhaps pending input data) on the |
fae2c0fb | 566 | handle. An exception to this is the C<:encoding> layer that |
01e6739c | 567 | changes the default character encoding of the handle, see L<open>. |
fae2c0fb | 568 | The C<:encoding> layer sometimes needs to be called in |
3874323d JH |
569 | mid-stream, and it doesn't flush the stream. The C<:encoding> |
570 | also implicitly pushes on top of itself the C<:utf8> layer because | |
3b10bc60 | 571 | internally Perl operates on UTF8-encoded Unicode characters. |
16fe6d59 | 572 | |
19799a22 | 573 | The operating system, device drivers, C libraries, and Perl run-time |
30168b04 GS |
574 | system all work together to let the programmer treat a single |
575 | character (C<\n>) as the line terminator, irrespective of the external | |
576 | representation. On many operating systems, the native text file | |
577 | representation matches the internal representation, but on some | |
578 | platforms the external representation of C<\n> is made up of more than | |
579 | one character. | |
580 | ||
68bd7414 NIS |
581 | Mac OS, all variants of Unix, and Stream_LF files on VMS use a single |
582 | character to end each line in the external representation of text (even | |
5e12dbfa | 583 | though that single character is CARRIAGE RETURN on Mac OS and LINE FEED |
01e6739c NIS |
584 | on Unix and most VMS files). In other systems like OS/2, DOS and the |
585 | various flavors of MS-Windows your program sees a C<\n> as a simple C<\cJ>, | |
586 | but what's stored in text files are the two characters C<\cM\cJ>. That | |
587 | means that, if you don't use binmode() on these systems, C<\cM\cJ> | |
588 | sequences on disk will be converted to C<\n> on input, and any C<\n> in | |
589 | your program will be converted back to C<\cM\cJ> on output. This is what | |
590 | you want for text files, but it can be disastrous for binary files. | |
30168b04 GS |
591 | |
592 | Another consequence of using binmode() (on some systems) is that | |
593 | special end-of-file markers will be seen as part of the data stream. | |
594 | For systems from the Microsoft family this means that if your binary | |
4375e838 | 595 | data contains C<\cZ>, the I/O subsystem will regard it as the end of |
30168b04 GS |
596 | the file, unless you use binmode(). |
597 | ||
3b10bc60 | 598 | binmode() is important not only for readline() and print() operations, |
30168b04 GS |
599 | but also when using read(), seek(), sysread(), syswrite() and tell() |
600 | (see L<perlport> for more details). See the C<$/> and C<$\> variables | |
601 | in L<perlvar> for how to manually set your input and output | |
602 | line-termination sequences. | |
a0d0e21e | 603 | |
4633a7c4 | 604 | =item bless REF,CLASSNAME |
d74e8afc | 605 | X<bless> |
a0d0e21e LW |
606 | |
607 | =item bless REF | |
608 | ||
2b5ab1e7 TC |
609 | This function tells the thingy referenced by REF that it is now an object |
610 | in the CLASSNAME package. If CLASSNAME is omitted, the current package | |
19799a22 | 611 | is used. Because a C<bless> is often the last thing in a constructor, |
2b5ab1e7 | 612 | it returns the reference for convenience. Always use the two-argument |
cf264981 SP |
613 | version if a derived class might inherit the function doing the blessing. |
614 | See L<perltoot> and L<perlobj> for more about the blessing (and blessings) | |
615 | of objects. | |
a0d0e21e | 616 | |
57668c4d | 617 | Consider always blessing objects in CLASSNAMEs that are mixed case. |
2b5ab1e7 | 618 | Namespaces with all lowercase names are considered reserved for |
cf264981 | 619 | Perl pragmata. Builtin types have all uppercase names. To prevent |
2b5ab1e7 TC |
620 | confusion, you may wish to avoid such package names as well. Make sure |
621 | that CLASSNAME is a true value. | |
60ad88b8 GS |
622 | |
623 | See L<perlmod/"Perl Modules">. | |
624 | ||
0d863452 RH |
625 | =item break |
626 | ||
627 | Break out of a C<given()> block. | |
628 | ||
3b10bc60 | 629 | This keyword is enabled by the C<"switch"> feature: see L<feature> |
0d863452 RH |
630 | for more information. |
631 | ||
a0d0e21e | 632 | =item caller EXPR |
d74e8afc | 633 | X<caller> X<call stack> X<stack> X<stack trace> |
a0d0e21e LW |
634 | |
635 | =item caller | |
636 | ||
5a964f20 | 637 | Returns the context of the current subroutine call. In scalar context, |
80d38338 TC |
638 | returns the caller's package name if there I<is> a caller (that is, if |
639 | we're in a subroutine or C<eval> or C<require>) and the undefined value | |
5a964f20 | 640 | otherwise. In list context, returns |
a0d0e21e | 641 | |
ee6b43cc | 642 | # 0 1 2 |
748a9306 | 643 | ($package, $filename, $line) = caller; |
a0d0e21e LW |
644 | |
645 | With EXPR, it returns some extra information that the debugger uses to | |
646 | print a stack trace. The value of EXPR indicates how many call frames | |
647 | to go back before the current one. | |
648 | ||
ee6b43cc | 649 | # 0 1 2 3 4 |
f3aa04c2 | 650 | ($package, $filename, $line, $subroutine, $hasargs, |
ee6b43cc | 651 | |
652 | # 5 6 7 8 9 10 | |
b3ca2e83 | 653 | $wantarray, $evaltext, $is_require, $hints, $bitmask, $hinthash) |
ee6b43cc | 654 | = caller($i); |
e7ea3e70 | 655 | |
951ba7fe | 656 | Here $subroutine may be C<(eval)> if the frame is not a subroutine |
19799a22 | 657 | call, but an C<eval>. In such a case additional elements $evaltext and |
7660c0ab | 658 | C<$is_require> are set: C<$is_require> is true if the frame is created by a |
19799a22 | 659 | C<require> or C<use> statement, $evaltext contains the text of the |
277ddfaf | 660 | C<eval EXPR> statement. In particular, for an C<eval BLOCK> statement, |
cc1c2e42 | 661 | $subroutine is C<(eval)>, but $evaltext is undefined. (Note also that |
0fc9dec4 RGS |
662 | each C<use> statement creates a C<require> frame inside an C<eval EXPR> |
663 | frame.) $subroutine may also be C<(unknown)> if this particular | |
664 | subroutine happens to have been deleted from the symbol table. | |
665 | C<$hasargs> is true if a new instance of C<@_> was set up for the frame. | |
666 | C<$hints> and C<$bitmask> contain pragmatic hints that the caller was | |
667 | compiled with. The C<$hints> and C<$bitmask> values are subject to change | |
668 | between versions of Perl, and are not meant for external use. | |
748a9306 | 669 | |
b3ca2e83 NC |
670 | C<$hinthash> is a reference to a hash containing the value of C<%^H> when the |
671 | caller was compiled, or C<undef> if C<%^H> was empty. Do not modify the values | |
672 | of this hash, as they are the actual values stored in the optree. | |
673 | ||
748a9306 | 674 | Furthermore, when called from within the DB package, caller returns more |
7660c0ab | 675 | detailed information: it sets the list variable C<@DB::args> to be the |
54310121 | 676 | arguments with which the subroutine was invoked. |
748a9306 | 677 | |
7660c0ab | 678 | Be aware that the optimizer might have optimized call frames away before |
19799a22 | 679 | C<caller> had a chance to get the information. That means that C<caller(N)> |
80d38338 | 680 | might not return information about the call frame you expect it to, for |
b76cc8ba | 681 | C<< N > 1 >>. In particular, C<@DB::args> might have information from the |
19799a22 | 682 | previous time C<caller> was called. |
7660c0ab | 683 | |
a0d0e21e | 684 | =item chdir EXPR |
d74e8afc ITB |
685 | X<chdir> |
686 | X<cd> | |
f723aae1 | 687 | X<directory, change> |
a0d0e21e | 688 | |
c4aca7d0 GA |
689 | =item chdir FILEHANDLE |
690 | ||
691 | =item chdir DIRHANDLE | |
692 | ||
ce2984c3 PF |
693 | =item chdir |
694 | ||
ffce7b87 | 695 | Changes the working directory to EXPR, if possible. If EXPR is omitted, |
0bfc1ec4 | 696 | changes to the directory specified by C<$ENV{HOME}>, if set; if not, |
ffce7b87 | 697 | changes to the directory specified by C<$ENV{LOGDIR}>. (Under VMS, the |
b4ad75f0 | 698 | variable C<$ENV{SYS$LOGIN}> is also checked, and used if it is set.) If |
80d38338 | 699 | neither is set, C<chdir> does nothing. It returns true on success, |
b4ad75f0 | 700 | false otherwise. See the example under C<die>. |
a0d0e21e | 701 | |
3b10bc60 | 702 | On systems that support fchdir(2), you may pass a filehandle or |
703 | directory handle as argument. On systems that don't support fchdir(2), | |
704 | passing handles raises an exception. | |
c4aca7d0 | 705 | |
a0d0e21e | 706 | =item chmod LIST |
d74e8afc | 707 | X<chmod> X<permission> X<mode> |
a0d0e21e LW |
708 | |
709 | Changes the permissions of a list of files. The first element of the | |
4633a7c4 | 710 | list must be the numerical mode, which should probably be an octal |
4ad40acf | 711 | number, and which definitely should I<not> be a string of octal digits: |
3b10bc60 | 712 | C<0644> is okay, but C<"0644"> is not. Returns the number of files |
dc848c6f | 713 | successfully changed. See also L</oct>, if all you have is a string. |
a0d0e21e | 714 | |
3b10bc60 | 715 | $cnt = chmod 0755, "foo", "bar"; |
a0d0e21e | 716 | chmod 0755, @executables; |
3b10bc60 | 717 | $mode = "0644"; chmod $mode, "foo"; # !!! sets mode to |
f86cebdf | 718 | # --w----r-T |
3b10bc60 | 719 | $mode = "0644"; chmod oct($mode), "foo"; # this is better |
720 | $mode = 0644; chmod $mode, "foo"; # this is best | |
a0d0e21e | 721 | |
3b10bc60 | 722 | On systems that support fchmod(2), you may pass filehandles among the |
723 | files. On systems that don't support fchmod(2), passing filehandles raises | |
724 | an exception. Filehandles must be passed as globs or glob references to be | |
725 | recognized; barewords are considered filenames. | |
c4aca7d0 GA |
726 | |
727 | open(my $fh, "<", "foo"); | |
728 | my $perm = (stat $fh)[2] & 07777; | |
729 | chmod($perm | 0600, $fh); | |
730 | ||
3b10bc60 | 731 | You can also import the symbolic C<S_I*> constants from the C<Fcntl> |
ca6e1c26 JH |
732 | module: |
733 | ||
3b10bc60 | 734 | use Fcntl qw( :mode ); |
ca6e1c26 | 735 | chmod S_IRWXU|S_IRGRP|S_IXGRP|S_IROTH|S_IXOTH, @executables; |
3b10bc60 | 736 | # Identical to the chmod 0755 of the example above. |
ca6e1c26 | 737 | |
a0d0e21e | 738 | =item chomp VARIABLE |
d74e8afc | 739 | X<chomp> X<INPUT_RECORD_SEPARATOR> X<$/> X<newline> X<eol> |
a0d0e21e | 740 | |
313c9f5c | 741 | =item chomp( LIST ) |
a0d0e21e LW |
742 | |
743 | =item chomp | |
744 | ||
2b5ab1e7 TC |
745 | This safer version of L</chop> removes any trailing string |
746 | that corresponds to the current value of C<$/> (also known as | |
28757baa | 747 | $INPUT_RECORD_SEPARATOR in the C<English> module). It returns the total |
748 | number of characters removed from all its arguments. It's often used to | |
749 | remove the newline from the end of an input record when you're worried | |
2b5ab1e7 TC |
750 | that the final record may be missing its newline. When in paragraph |
751 | mode (C<$/ = "">), it removes all trailing newlines from the string. | |
4c5a6083 GS |
752 | When in slurp mode (C<$/ = undef>) or fixed-length record mode (C<$/> is |
753 | a reference to an integer or the like, see L<perlvar>) chomp() won't | |
b76cc8ba | 754 | remove anything. |
19799a22 | 755 | If VARIABLE is omitted, it chomps C<$_>. Example: |
a0d0e21e LW |
756 | |
757 | while (<>) { | |
a9a5a0dc VP |
758 | chomp; # avoid \n on last field |
759 | @array = split(/:/); | |
760 | # ... | |
a0d0e21e LW |
761 | } |
762 | ||
4bf21a6d RD |
763 | If VARIABLE is a hash, it chomps the hash's values, but not its keys. |
764 | ||
a0d0e21e LW |
765 | You can actually chomp anything that's an lvalue, including an assignment: |
766 | ||
767 | chomp($cwd = `pwd`); | |
768 | chomp($answer = <STDIN>); | |
769 | ||
770 | If you chomp a list, each element is chomped, and the total number of | |
771 | characters removed is returned. | |
772 | ||
15e44fd8 RGS |
773 | Note that parentheses are necessary when you're chomping anything |
774 | that is not a simple variable. This is because C<chomp $cwd = `pwd`;> | |
775 | is interpreted as C<(chomp $cwd) = `pwd`;>, rather than as | |
776 | C<chomp( $cwd = `pwd` )> which you might expect. Similarly, | |
777 | C<chomp $a, $b> is interpreted as C<chomp($a), $b> rather than | |
778 | as C<chomp($a, $b)>. | |
779 | ||
a0d0e21e | 780 | =item chop VARIABLE |
d74e8afc | 781 | X<chop> |
a0d0e21e | 782 | |
313c9f5c | 783 | =item chop( LIST ) |
a0d0e21e LW |
784 | |
785 | =item chop | |
786 | ||
787 | Chops off the last character of a string and returns the character | |
5b3eff12 | 788 | chopped. It is much more efficient than C<s/.$//s> because it neither |
7660c0ab | 789 | scans nor copies the string. If VARIABLE is omitted, chops C<$_>. |
4bf21a6d RD |
790 | If VARIABLE is a hash, it chops the hash's values, but not its keys. |
791 | ||
5b3eff12 | 792 | You can actually chop anything that's an lvalue, including an assignment. |
a0d0e21e LW |
793 | |
794 | If you chop a list, each element is chopped. Only the value of the | |
19799a22 | 795 | last C<chop> is returned. |
a0d0e21e | 796 | |
19799a22 | 797 | Note that C<chop> returns the last character. To return all but the last |
748a9306 LW |
798 | character, use C<substr($string, 0, -1)>. |
799 | ||
15e44fd8 RGS |
800 | See also L</chomp>. |
801 | ||
a0d0e21e | 802 | =item chown LIST |
d74e8afc | 803 | X<chown> X<owner> X<user> X<group> |
a0d0e21e LW |
804 | |
805 | Changes the owner (and group) of a list of files. The first two | |
19799a22 GS |
806 | elements of the list must be the I<numeric> uid and gid, in that |
807 | order. A value of -1 in either position is interpreted by most | |
808 | systems to leave that value unchanged. Returns the number of files | |
809 | successfully changed. | |
a0d0e21e LW |
810 | |
811 | $cnt = chown $uid, $gid, 'foo', 'bar'; | |
812 | chown $uid, $gid, @filenames; | |
813 | ||
3b10bc60 | 814 | On systems that support fchown(2), you may pass filehandles among the |
815 | files. On systems that don't support fchown(2), passing filehandles raises | |
816 | an exception. Filehandles must be passed as globs or glob references to be | |
817 | recognized; barewords are considered filenames. | |
c4aca7d0 | 818 | |
54310121 | 819 | Here's an example that looks up nonnumeric uids in the passwd file: |
a0d0e21e LW |
820 | |
821 | print "User: "; | |
19799a22 | 822 | chomp($user = <STDIN>); |
5a964f20 | 823 | print "Files: "; |
19799a22 | 824 | chomp($pattern = <STDIN>); |
a0d0e21e LW |
825 | |
826 | ($login,$pass,$uid,$gid) = getpwnam($user) | |
a9a5a0dc | 827 | or die "$user not in passwd file"; |
a0d0e21e | 828 | |
5ed4f2ec | 829 | @ary = glob($pattern); # expand filenames |
a0d0e21e LW |
830 | chown $uid, $gid, @ary; |
831 | ||
54310121 | 832 | On most systems, you are not allowed to change the ownership of the |
4633a7c4 LW |
833 | file unless you're the superuser, although you should be able to change |
834 | the group to any of your secondary groups. On insecure systems, these | |
835 | restrictions may be relaxed, but this is not a portable assumption. | |
19799a22 GS |
836 | On POSIX systems, you can detect this condition this way: |
837 | ||
838 | use POSIX qw(sysconf _PC_CHOWN_RESTRICTED); | |
839 | $can_chown_giveaway = not sysconf(_PC_CHOWN_RESTRICTED); | |
4633a7c4 | 840 | |
a0d0e21e | 841 | =item chr NUMBER |
d74e8afc | 842 | X<chr> X<character> X<ASCII> X<Unicode> |
a0d0e21e | 843 | |
54310121 | 844 | =item chr |
bbce6d69 | 845 | |
a0d0e21e | 846 | Returns the character represented by that NUMBER in the character set. |
a0ed51b3 | 847 | For example, C<chr(65)> is C<"A"> in either ASCII or Unicode, and |
2575c402 | 848 | chr(0x263a) is a Unicode smiley face. |
aaa68c4a | 849 | |
8a064bd6 | 850 | Negative values give the Unicode replacement character (chr(0xfffd)), |
80d38338 | 851 | except under the L<bytes> pragma, where the low eight bits of the value |
8a064bd6 JH |
852 | (truncated to an integer) are used. |
853 | ||
974da8e5 JH |
854 | If NUMBER is omitted, uses C<$_>. |
855 | ||
b76cc8ba | 856 | For the reverse, use L</ord>. |
a0d0e21e | 857 | |
2575c402 JW |
858 | Note that characters from 128 to 255 (inclusive) are by default |
859 | internally not encoded as UTF-8 for backward compatibility reasons. | |
974da8e5 | 860 | |
2575c402 | 861 | See L<perlunicode> for more about Unicode. |
bbce6d69 | 862 | |
a0d0e21e | 863 | =item chroot FILENAME |
d74e8afc | 864 | X<chroot> X<root> |
a0d0e21e | 865 | |
54310121 | 866 | =item chroot |
bbce6d69 | 867 | |
5a964f20 | 868 | This function works like the system call by the same name: it makes the |
4633a7c4 | 869 | named directory the new root directory for all further pathnames that |
951ba7fe | 870 | begin with a C</> by your process and all its children. (It doesn't |
28757baa | 871 | change your current working directory, which is unaffected.) For security |
4633a7c4 | 872 | reasons, this call is restricted to the superuser. If FILENAME is |
19799a22 | 873 | omitted, does a C<chroot> to C<$_>. |
a0d0e21e LW |
874 | |
875 | =item close FILEHANDLE | |
d74e8afc | 876 | X<close> |
a0d0e21e | 877 | |
6a518fbc TP |
878 | =item close |
879 | ||
3b10bc60 | 880 | Closes the file or pipe associated with the filehandle, flushes the IO |
e0f13c26 RGS |
881 | buffers, and closes the system file descriptor. Returns true if those |
882 | operations have succeeded and if no error was reported by any PerlIO | |
883 | layer. Closes the currently selected filehandle if the argument is | |
884 | omitted. | |
fb73857a | 885 | |
886 | You don't have to close FILEHANDLE if you are immediately going to do | |
3b10bc60 | 887 | another C<open> on it, because C<open> closes it for you. (See |
19799a22 GS |
888 | C<open>.) However, an explicit C<close> on an input file resets the line |
889 | counter (C<$.>), while the implicit close done by C<open> does not. | |
fb73857a | 890 | |
3b10bc60 | 891 | If the filehandle came from a piped open, C<close> returns false if one of |
892 | the other syscalls involved fails or if its program exits with non-zero | |
893 | status. If the only problem was that the program exited non-zero, C<$!> | |
894 | will be set to C<0>. Closing a pipe also waits for the process executing | |
895 | on the pipe to exit--in case you wish to look at the output of the pipe | |
896 | afterwards--and implicitly puts the exit status value of that command into | |
897 | C<$?> and C<${^CHILD_ERROR_NATIVE}>. | |
5a964f20 | 898 | |
80d38338 TC |
899 | Closing the read end of a pipe before the process writing to it at the |
900 | other end is done writing results in the writer receiving a SIGPIPE. If | |
901 | the other end can't handle that, be sure to read all the data before | |
902 | closing the pipe. | |
73689b13 | 903 | |
fb73857a | 904 | Example: |
a0d0e21e | 905 | |
fb73857a | 906 | open(OUTPUT, '|sort >foo') # pipe to sort |
907 | or die "Can't start sort: $!"; | |
5ed4f2ec | 908 | #... # print stuff to output |
909 | close OUTPUT # wait for sort to finish | |
fb73857a | 910 | or warn $! ? "Error closing sort pipe: $!" |
911 | : "Exit status $? from sort"; | |
5ed4f2ec | 912 | open(INPUT, 'foo') # get sort's results |
fb73857a | 913 | or die "Can't open 'foo' for input: $!"; |
a0d0e21e | 914 | |
5a964f20 TC |
915 | FILEHANDLE may be an expression whose value can be used as an indirect |
916 | filehandle, usually the real filehandle name. | |
a0d0e21e LW |
917 | |
918 | =item closedir DIRHANDLE | |
d74e8afc | 919 | X<closedir> |
a0d0e21e | 920 | |
19799a22 | 921 | Closes a directory opened by C<opendir> and returns the success of that |
5a964f20 TC |
922 | system call. |
923 | ||
a0d0e21e | 924 | =item connect SOCKET,NAME |
d74e8afc | 925 | X<connect> |
a0d0e21e | 926 | |
80d38338 TC |
927 | Attempts to connect to a remote socket, just like connect(2). |
928 | Returns true if it succeeded, false otherwise. NAME should be a | |
4633a7c4 LW |
929 | packed address of the appropriate type for the socket. See the examples in |
930 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 931 | |
cb1a09d0 | 932 | =item continue BLOCK |
d74e8afc | 933 | X<continue> |
cb1a09d0 | 934 | |
0d863452 RH |
935 | =item continue |
936 | ||
cf264981 SP |
937 | C<continue> is actually a flow control statement rather than a function. If |
938 | there is a C<continue> BLOCK attached to a BLOCK (typically in a C<while> or | |
98293880 JH |
939 | C<foreach>), it is always executed just before the conditional is about to |
940 | be evaluated again, just like the third part of a C<for> loop in C. Thus | |
cb1a09d0 AD |
941 | it can be used to increment a loop variable, even when the loop has been |
942 | continued via the C<next> statement (which is similar to the C C<continue> | |
943 | statement). | |
944 | ||
98293880 | 945 | C<last>, C<next>, or C<redo> may appear within a C<continue> |
3b10bc60 | 946 | block; C<last> and C<redo> behave as if they had been executed within |
19799a22 | 947 | the main block. So will C<next>, but since it will execute a C<continue> |
1d2dff63 GS |
948 | block, it may be more entertaining. |
949 | ||
950 | while (EXPR) { | |
a9a5a0dc VP |
951 | ### redo always comes here |
952 | do_something; | |
1d2dff63 | 953 | } continue { |
a9a5a0dc VP |
954 | ### next always comes here |
955 | do_something_else; | |
956 | # then back the top to re-check EXPR | |
1d2dff63 GS |
957 | } |
958 | ### last always comes here | |
959 | ||
3b10bc60 | 960 | Omitting the C<continue> section is equivalent to using an |
961 | empty one, logically enough, so C<next> goes directly back | |
1d2dff63 GS |
962 | to check the condition at the top of the loop. |
963 | ||
3b10bc60 | 964 | If the C<"switch"> feature is enabled, C<continue> is also a |
965 | function that exits the current C<when> (or C<default>) block and | |
966 | falls through to the next one. See L<feature> and | |
0d863452 RH |
967 | L<perlsyn/"Switch statements"> for more information. |
968 | ||
969 | ||
a0d0e21e | 970 | =item cos EXPR |
d74e8afc | 971 | X<cos> X<cosine> X<acos> X<arccosine> |
a0d0e21e | 972 | |
d6217f1e GS |
973 | =item cos |
974 | ||
5a964f20 | 975 | Returns the cosine of EXPR (expressed in radians). If EXPR is omitted, |
7660c0ab | 976 | takes cosine of C<$_>. |
a0d0e21e | 977 | |
ca6e1c26 | 978 | For the inverse cosine operation, you may use the C<Math::Trig::acos()> |
28757baa | 979 | function, or use this relation: |
980 | ||
981 | sub acos { atan2( sqrt(1 - $_[0] * $_[0]), $_[0] ) } | |
982 | ||
a0d0e21e | 983 | =item crypt PLAINTEXT,SALT |
d74e8afc | 984 | X<crypt> X<digest> X<hash> X<salt> X<plaintext> X<password> |
f723aae1 | 985 | X<decrypt> X<cryptography> X<passwd> X<encrypt> |
a0d0e21e | 986 | |
ef2e6798 MS |
987 | Creates a digest string exactly like the crypt(3) function in the C |
988 | library (assuming that you actually have a version there that has not | |
bb23f8d1 | 989 | been extirpated as a potential munition). |
ef2e6798 MS |
990 | |
991 | crypt() is a one-way hash function. The PLAINTEXT and SALT is turned | |
992 | into a short string, called a digest, which is returned. The same | |
993 | PLAINTEXT and SALT will always return the same string, but there is no | |
994 | (known) way to get the original PLAINTEXT from the hash. Small | |
995 | changes in the PLAINTEXT or SALT will result in large changes in the | |
996 | digest. | |
997 | ||
998 | There is no decrypt function. This function isn't all that useful for | |
999 | cryptography (for that, look for F<Crypt> modules on your nearby CPAN | |
1000 | mirror) and the name "crypt" is a bit of a misnomer. Instead it is | |
1001 | primarily used to check if two pieces of text are the same without | |
1002 | having to transmit or store the text itself. An example is checking | |
1003 | if a correct password is given. The digest of the password is stored, | |
cf264981 | 1004 | not the password itself. The user types in a password that is |
ef2e6798 MS |
1005 | crypt()'d with the same salt as the stored digest. If the two digests |
1006 | match the password is correct. | |
1007 | ||
1008 | When verifying an existing digest string you should use the digest as | |
1009 | the salt (like C<crypt($plain, $digest) eq $digest>). The SALT used | |
cf264981 | 1010 | to create the digest is visible as part of the digest. This ensures |
ef2e6798 MS |
1011 | crypt() will hash the new string with the same salt as the digest. |
1012 | This allows your code to work with the standard L<crypt|/crypt> and | |
1013 | with more exotic implementations. In other words, do not assume | |
1014 | anything about the returned string itself, or how many bytes in the | |
1015 | digest matter. | |
85c16d83 JH |
1016 | |
1017 | Traditionally the result is a string of 13 bytes: two first bytes of | |
1018 | the salt, followed by 11 bytes from the set C<[./0-9A-Za-z]>, and only | |
bb23f8d1 | 1019 | the first eight bytes of PLAINTEXT mattered. But alternative |
ef2e6798 | 1020 | hashing schemes (like MD5), higher level security schemes (like C2), |
e1020413 | 1021 | and implementations on non-Unix platforms may produce different |
ef2e6798 | 1022 | strings. |
85c16d83 JH |
1023 | |
1024 | When choosing a new salt create a random two character string whose | |
1025 | characters come from the set C<[./0-9A-Za-z]> (like C<join '', ('.', | |
d3989d75 CW |
1026 | '/', 0..9, 'A'..'Z', 'a'..'z')[rand 64, rand 64]>). This set of |
1027 | characters is just a recommendation; the characters allowed in | |
1028 | the salt depend solely on your system's crypt library, and Perl can't | |
1029 | restrict what salts C<crypt()> accepts. | |
e71965be | 1030 | |
a0d0e21e | 1031 | Here's an example that makes sure that whoever runs this program knows |
cf264981 | 1032 | their password: |
a0d0e21e LW |
1033 | |
1034 | $pwd = (getpwuid($<))[1]; | |
a0d0e21e LW |
1035 | |
1036 | system "stty -echo"; | |
1037 | print "Password: "; | |
e71965be | 1038 | chomp($word = <STDIN>); |
a0d0e21e LW |
1039 | print "\n"; |
1040 | system "stty echo"; | |
1041 | ||
e71965be | 1042 | if (crypt($word, $pwd) ne $pwd) { |
a9a5a0dc | 1043 | die "Sorry...\n"; |
a0d0e21e | 1044 | } else { |
a9a5a0dc | 1045 | print "ok\n"; |
54310121 | 1046 | } |
a0d0e21e | 1047 | |
9f8f0c9d | 1048 | Of course, typing in your own password to whoever asks you |
748a9306 | 1049 | for it is unwise. |
a0d0e21e | 1050 | |
ef2e6798 | 1051 | The L<crypt|/crypt> function is unsuitable for hashing large quantities |
19799a22 | 1052 | of data, not least of all because you can't get the information |
ef2e6798 | 1053 | back. Look at the L<Digest> module for more robust algorithms. |
19799a22 | 1054 | |
f2791508 JH |
1055 | If using crypt() on a Unicode string (which I<potentially> has |
1056 | characters with codepoints above 255), Perl tries to make sense | |
1057 | of the situation by trying to downgrade (a copy of the string) | |
1058 | the string back to an eight-bit byte string before calling crypt() | |
1059 | (on that copy). If that works, good. If not, crypt() dies with | |
1060 | C<Wide character in crypt>. | |
85c16d83 | 1061 | |
aa689395 | 1062 | =item dbmclose HASH |
d74e8afc | 1063 | X<dbmclose> |
a0d0e21e | 1064 | |
19799a22 | 1065 | [This function has been largely superseded by the C<untie> function.] |
a0d0e21e | 1066 | |
aa689395 | 1067 | Breaks the binding between a DBM file and a hash. |
a0d0e21e | 1068 | |
19799a22 | 1069 | =item dbmopen HASH,DBNAME,MASK |
d74e8afc | 1070 | X<dbmopen> X<dbm> X<ndbm> X<sdbm> X<gdbm> |
a0d0e21e | 1071 | |
19799a22 | 1072 | [This function has been largely superseded by the C<tie> function.] |
a0d0e21e | 1073 | |
7b8d334a | 1074 | This binds a dbm(3), ndbm(3), sdbm(3), gdbm(3), or Berkeley DB file to a |
19799a22 GS |
1075 | hash. HASH is the name of the hash. (Unlike normal C<open>, the first |
1076 | argument is I<not> a filehandle, even though it looks like one). DBNAME | |
aa689395 | 1077 | is the name of the database (without the F<.dir> or F<.pag> extension if |
1078 | any). If the database does not exist, it is created with protection | |
19799a22 | 1079 | specified by MASK (as modified by the C<umask>). If your system supports |
80d38338 | 1080 | only the older DBM functions, you may make only one C<dbmopen> call in your |
aa689395 | 1081 | program. In older versions of Perl, if your system had neither DBM nor |
19799a22 | 1082 | ndbm, calling C<dbmopen> produced a fatal error; it now falls back to |
aa689395 | 1083 | sdbm(3). |
1084 | ||
1085 | If you don't have write access to the DBM file, you can only read hash | |
1086 | variables, not set them. If you want to test whether you can write, | |
3b10bc60 | 1087 | either use file tests or try setting a dummy hash entry inside an C<eval> |
1088 | to trap the error. | |
a0d0e21e | 1089 | |
19799a22 GS |
1090 | Note that functions such as C<keys> and C<values> may return huge lists |
1091 | when used on large DBM files. You may prefer to use the C<each> | |
a0d0e21e LW |
1092 | function to iterate over large DBM files. Example: |
1093 | ||
1094 | # print out history file offsets | |
1095 | dbmopen(%HIST,'/usr/lib/news/history',0666); | |
1096 | while (($key,$val) = each %HIST) { | |
a9a5a0dc | 1097 | print $key, ' = ', unpack('L',$val), "\n"; |
a0d0e21e LW |
1098 | } |
1099 | dbmclose(%HIST); | |
1100 | ||
cb1a09d0 | 1101 | See also L<AnyDBM_File> for a more general description of the pros and |
184e9718 | 1102 | cons of the various dbm approaches, as well as L<DB_File> for a particularly |
cb1a09d0 | 1103 | rich implementation. |
4633a7c4 | 1104 | |
2b5ab1e7 TC |
1105 | You can control which DBM library you use by loading that library |
1106 | before you call dbmopen(): | |
1107 | ||
1108 | use DB_File; | |
1109 | dbmopen(%NS_Hist, "$ENV{HOME}/.netscape/history.db") | |
a9a5a0dc | 1110 | or die "Can't open netscape history file: $!"; |
2b5ab1e7 | 1111 | |
a0d0e21e | 1112 | =item defined EXPR |
d74e8afc | 1113 | X<defined> X<undef> X<undefined> |
a0d0e21e | 1114 | |
54310121 | 1115 | =item defined |
bbce6d69 | 1116 | |
2f9daede | 1117 | Returns a Boolean value telling whether EXPR has a value other than |
3b10bc60 | 1118 | the undefined value C<undef>. If EXPR is not present, C<$_> is |
2f9daede TP |
1119 | checked. |
1120 | ||
1121 | Many operations return C<undef> to indicate failure, end of file, | |
1122 | system error, uninitialized variable, and other exceptional | |
1123 | conditions. This function allows you to distinguish C<undef> from | |
1124 | other values. (A simple Boolean test will not distinguish among | |
7660c0ab | 1125 | C<undef>, zero, the empty string, and C<"0">, which are all equally |
2f9daede | 1126 | false.) Note that since C<undef> is a valid scalar, its presence |
19799a22 | 1127 | doesn't I<necessarily> indicate an exceptional condition: C<pop> |
2f9daede TP |
1128 | returns C<undef> when its argument is an empty array, I<or> when the |
1129 | element to return happens to be C<undef>. | |
1130 | ||
f10b0346 GS |
1131 | You may also use C<defined(&func)> to check whether subroutine C<&func> |
1132 | has ever been defined. The return value is unaffected by any forward | |
80d38338 | 1133 | declarations of C<&func>. A subroutine that is not defined |
847c7ebe | 1134 | may still be callable: its package may have an C<AUTOLOAD> method that |
3b10bc60 | 1135 | makes it spring into existence the first time that it is called; see |
847c7ebe | 1136 | L<perlsub>. |
f10b0346 GS |
1137 | |
1138 | Use of C<defined> on aggregates (hashes and arrays) is deprecated. It | |
1139 | used to report whether memory for that aggregate has ever been | |
1140 | allocated. This behavior may disappear in future versions of Perl. | |
1141 | You should instead use a simple test for size: | |
1142 | ||
1143 | if (@an_array) { print "has array elements\n" } | |
1144 | if (%a_hash) { print "has hash members\n" } | |
2f9daede TP |
1145 | |
1146 | When used on a hash element, it tells you whether the value is defined, | |
dc848c6f | 1147 | not whether the key exists in the hash. Use L</exists> for the latter |
2f9daede | 1148 | purpose. |
a0d0e21e LW |
1149 | |
1150 | Examples: | |
1151 | ||
1152 | print if defined $switch{'D'}; | |
1153 | print "$val\n" while defined($val = pop(@ary)); | |
1154 | die "Can't readlink $sym: $!" | |
a9a5a0dc | 1155 | unless defined($value = readlink $sym); |
a0d0e21e | 1156 | sub foo { defined &$bar ? &$bar(@_) : die "No bar"; } |
2f9daede | 1157 | $debugging = 0 unless defined $debugging; |
a0d0e21e | 1158 | |
19799a22 | 1159 | Note: Many folks tend to overuse C<defined>, and then are surprised to |
7660c0ab | 1160 | discover that the number C<0> and C<""> (the zero-length string) are, in fact, |
2f9daede | 1161 | defined values. For example, if you say |
a5f75d66 AD |
1162 | |
1163 | "ab" =~ /a(.*)b/; | |
1164 | ||
80d38338 | 1165 | The pattern match succeeds and C<$1> is defined, although it |
cf264981 | 1166 | matched "nothing". It didn't really fail to match anything. Rather, it |
2b5ab1e7 | 1167 | matched something that happened to be zero characters long. This is all |
a5f75d66 | 1168 | very above-board and honest. When a function returns an undefined value, |
2f9daede | 1169 | it's an admission that it couldn't give you an honest answer. So you |
3b10bc60 | 1170 | should use C<defined> only when questioning the integrity of what |
7660c0ab | 1171 | you're trying to do. At other times, a simple comparison to C<0> or C<""> is |
2f9daede TP |
1172 | what you want. |
1173 | ||
dc848c6f | 1174 | See also L</undef>, L</exists>, L</ref>. |
2f9daede | 1175 | |
a0d0e21e | 1176 | =item delete EXPR |
d74e8afc | 1177 | X<delete> |
a0d0e21e | 1178 | |
80d38338 TC |
1179 | Given an expression that specifies an element or slice of an aggregate (a |
1180 | hash or an array), deletes the specified elements from that aggregate so | |
1181 | that exists() on that element no longer returns true. Setting an aggregate | |
1182 | element to the undefined value does not remove its key, but deleting it | |
1183 | does; see L</exists>. | |
1184 | ||
1185 | Returns the value or values deleted in list context, or the last such | |
1186 | element in scalar context. The return list's length always matches that of | |
1187 | the argument list: deleting non-existent elements returns the undefined | |
1188 | value in their corresponding positions. | |
1189 | ||
1190 | Deleting array elements never changes indices of existing values; use | |
1191 | shift() or splice() for that. However, if all deleted elements fall at | |
1192 | the end of an array, the array's size shrinks to the position of the | |
1193 | highest element that still tests true for exists(), or to 0 if none do. | |
1194 | ||
1195 | Deleting from C<%ENV> modifies the environment. Deleting from a hash tied to | |
1196 | a DBM file deletes the entry from the DBM file. Deleting from a C<tied> hash | |
1197 | or array may not necessarily return anything; it depends on the implementation | |
1198 | of the C<tied> package's DELETE method, which may do whatever it pleases. | |
a0d0e21e | 1199 | |
80d38338 TC |
1200 | The C<delete local EXPR> construct localizes the deletion to the current |
1201 | block at run time. Until the block exits, elements locally deleted | |
1202 | temporarily no longer exist. See L<perlsub/"Localized deletion of elements | |
1203 | of composite types">. | |
eba0920a EM |
1204 | |
1205 | %hash = (foo => 11, bar => 22, baz => 33); | |
1206 | $scalar = delete $hash{foo}; # $scalar is 11 | |
1207 | $scalar = delete @hash{qw(foo bar)}; # $scalar is 22 | |
1208 | @array = delete @hash{qw(foo bar baz)}; # @array is (undef,undef,33) | |
1209 | ||
01020589 | 1210 | The following (inefficiently) deletes all the values of %HASH and @ARRAY: |
a0d0e21e | 1211 | |
5f05dabc | 1212 | foreach $key (keys %HASH) { |
a9a5a0dc | 1213 | delete $HASH{$key}; |
a0d0e21e LW |
1214 | } |
1215 | ||
01020589 | 1216 | foreach $index (0 .. $#ARRAY) { |
a9a5a0dc | 1217 | delete $ARRAY[$index]; |
01020589 GS |
1218 | } |
1219 | ||
1220 | And so do these: | |
5f05dabc | 1221 | |
01020589 GS |
1222 | delete @HASH{keys %HASH}; |
1223 | ||
9740c838 | 1224 | delete @ARRAY[0 .. $#ARRAY]; |
5f05dabc | 1225 | |
80d38338 TC |
1226 | But both are slower than assigning the empty list |
1227 | or undefining %HASH or @ARRAY, which is the customary | |
1228 | way to empty out an aggregate: | |
01020589 | 1229 | |
5ed4f2ec | 1230 | %HASH = (); # completely empty %HASH |
1231 | undef %HASH; # forget %HASH ever existed | |
2b5ab1e7 | 1232 | |
5ed4f2ec | 1233 | @ARRAY = (); # completely empty @ARRAY |
1234 | undef @ARRAY; # forget @ARRAY ever existed | |
2b5ab1e7 | 1235 | |
80d38338 TC |
1236 | The EXPR can be arbitrarily complicated provided its |
1237 | final operation is an element or slice of an aggregate: | |
a0d0e21e LW |
1238 | |
1239 | delete $ref->[$x][$y]{$key}; | |
5f05dabc | 1240 | delete @{$ref->[$x][$y]}{$key1, $key2, @morekeys}; |
a0d0e21e | 1241 | |
01020589 GS |
1242 | delete $ref->[$x][$y][$index]; |
1243 | delete @{$ref->[$x][$y]}[$index1, $index2, @moreindices]; | |
1244 | ||
a0d0e21e | 1245 | =item die LIST |
d74e8afc | 1246 | X<die> X<throw> X<exception> X<raise> X<$@> X<abort> |
a0d0e21e | 1247 | |
19799a22 GS |
1248 | Outside an C<eval>, prints the value of LIST to C<STDERR> and |
1249 | exits with the current value of C<$!> (errno). If C<$!> is C<0>, | |
61eff3bc JH |
1250 | exits with the value of C<<< ($? >> 8) >>> (backtick `command` |
1251 | status). If C<<< ($? >> 8) >>> is C<0>, exits with C<255>. Inside | |
19799a22 GS |
1252 | an C<eval(),> the error message is stuffed into C<$@> and the |
1253 | C<eval> is terminated with the undefined value. This makes | |
1254 | C<die> the way to raise an exception. | |
a0d0e21e LW |
1255 | |
1256 | Equivalent examples: | |
1257 | ||
1258 | die "Can't cd to spool: $!\n" unless chdir '/usr/spool/news'; | |
54310121 | 1259 | chdir '/usr/spool/news' or die "Can't cd to spool: $!\n" |
a0d0e21e | 1260 | |
ccac6780 | 1261 | If the last element of LIST does not end in a newline, the current |
df37ec69 WW |
1262 | script line number and input line number (if any) are also printed, |
1263 | and a newline is supplied. Note that the "input line number" (also | |
1264 | known as "chunk") is subject to whatever notion of "line" happens to | |
1265 | be currently in effect, and is also available as the special variable | |
1266 | C<$.>. See L<perlvar/"$/"> and L<perlvar/"$.">. | |
1267 | ||
1268 | Hint: sometimes appending C<", stopped"> to your message will cause it | |
1269 | to make better sense when the string C<"at foo line 123"> is appended. | |
1270 | Suppose you are running script "canasta". | |
a0d0e21e LW |
1271 | |
1272 | die "/etc/games is no good"; | |
1273 | die "/etc/games is no good, stopped"; | |
1274 | ||
1275 | produce, respectively | |
1276 | ||
1277 | /etc/games is no good at canasta line 123. | |
1278 | /etc/games is no good, stopped at canasta line 123. | |
1279 | ||
2b5ab1e7 | 1280 | See also exit(), warn(), and the Carp module. |
a0d0e21e | 1281 | |
a96d0188 | 1282 | If the output is empty and C<$@> already contains a value (typically from a |
7660c0ab | 1283 | previous eval) that value is reused after appending C<"\t...propagated">. |
fb73857a | 1284 | This is useful for propagating exceptions: |
1285 | ||
1286 | eval { ... }; | |
1287 | die unless $@ =~ /Expected exception/; | |
1288 | ||
a96d0188 | 1289 | If the output is empty and C<$@> contains an object reference that has a |
ad216e65 JH |
1290 | C<PROPAGATE> method, that method will be called with additional file |
1291 | and line number parameters. The return value replaces the value in | |
80d38338 | 1292 | C<$@>. i.e., as if C<< $@ = eval { $@->PROPAGATE(__FILE__, __LINE__) }; >> |
ad216e65 JH |
1293 | were called. |
1294 | ||
7660c0ab | 1295 | If C<$@> is empty then the string C<"Died"> is used. |
fb73857a | 1296 | |
80d38338 TC |
1297 | You can also call C<die> with a reference argument, and if this is trapped |
1298 | within an C<eval>, C<$@> contains that reference. This permits more | |
1299 | elaborate exception handling using objects that maintain arbitrary state | |
1300 | about the exception. Such a scheme is sometimes preferable to matching | |
1301 | particular string values of C<$@> with regular expressions. Because C<$@> | |
1302 | is a global variable and C<eval> may be used within object implementations, | |
1303 | be careful that analyzing the error object doesn't replace the reference in | |
1304 | the global variable. It's easiest to make a local copy of the reference | |
1305 | before any manipulations. Here's an example: | |
52531d10 | 1306 | |
80d38338 | 1307 | use Scalar::Util "blessed"; |
da279afe | 1308 | |
52531d10 | 1309 | eval { ... ; die Some::Module::Exception->new( FOO => "bar" ) }; |
746d7dd7 GL |
1310 | if (my $ev_err = $@) { |
1311 | if (blessed($ev_err) && $ev_err->isa("Some::Module::Exception")) { | |
52531d10 GS |
1312 | # handle Some::Module::Exception |
1313 | } | |
1314 | else { | |
1315 | # handle all other possible exceptions | |
1316 | } | |
1317 | } | |
1318 | ||
3b10bc60 | 1319 | Because Perl stringifies uncaught exception messages before display, |
80d38338 | 1320 | you'll probably want to overload stringification operations on |
52531d10 GS |
1321 | exception objects. See L<overload> for details about that. |
1322 | ||
19799a22 GS |
1323 | You can arrange for a callback to be run just before the C<die> |
1324 | does its deed, by setting the C<$SIG{__DIE__}> hook. The associated | |
3b10bc60 | 1325 | handler is called with the error text and can change the error |
19799a22 GS |
1326 | message, if it sees fit, by calling C<die> again. See |
1327 | L<perlvar/$SIG{expr}> for details on setting C<%SIG> entries, and | |
cf264981 | 1328 | L<"eval BLOCK"> for some examples. Although this feature was |
19799a22 | 1329 | to be run only right before your program was to exit, this is not |
3b10bc60 | 1330 | currently so: the C<$SIG{__DIE__}> hook is currently called |
19799a22 GS |
1331 | even inside eval()ed blocks/strings! If one wants the hook to do |
1332 | nothing in such situations, put | |
fb73857a | 1333 | |
5ed4f2ec | 1334 | die @_ if $^S; |
fb73857a | 1335 | |
19799a22 GS |
1336 | as the first line of the handler (see L<perlvar/$^S>). Because |
1337 | this promotes strange action at a distance, this counterintuitive | |
b76cc8ba | 1338 | behavior may be fixed in a future release. |
774d564b | 1339 | |
a0d0e21e | 1340 | =item do BLOCK |
d74e8afc | 1341 | X<do> X<block> |
a0d0e21e LW |
1342 | |
1343 | Not really a function. Returns the value of the last command in the | |
6b275a1f RGS |
1344 | sequence of commands indicated by BLOCK. When modified by the C<while> or |
1345 | C<until> loop modifier, executes the BLOCK once before testing the loop | |
1346 | condition. (On other statements the loop modifiers test the conditional | |
1347 | first.) | |
a0d0e21e | 1348 | |
4968c1e4 | 1349 | C<do BLOCK> does I<not> count as a loop, so the loop control statements |
2b5ab1e7 TC |
1350 | C<next>, C<last>, or C<redo> cannot be used to leave or restart the block. |
1351 | See L<perlsyn> for alternative strategies. | |
4968c1e4 | 1352 | |
a0d0e21e | 1353 | =item do SUBROUTINE(LIST) |
d74e8afc | 1354 | X<do> |
a0d0e21e | 1355 | |
cf264981 | 1356 | This form of subroutine call is deprecated. See L<perlsub>. |
a0d0e21e LW |
1357 | |
1358 | =item do EXPR | |
d74e8afc | 1359 | X<do> |
a0d0e21e LW |
1360 | |
1361 | Uses the value of EXPR as a filename and executes the contents of the | |
ea63ef19 | 1362 | file as a Perl script. |
a0d0e21e LW |
1363 | |
1364 | do 'stat.pl'; | |
1365 | ||
1366 | is just like | |
1367 | ||
986b19de | 1368 | eval `cat stat.pl`; |
a0d0e21e | 1369 | |
2b5ab1e7 | 1370 | except that it's more efficient and concise, keeps track of the current |
ea63ef19 | 1371 | filename for error messages, searches the @INC directories, and updates |
2b5ab1e7 TC |
1372 | C<%INC> if the file is found. See L<perlvar/Predefined Names> for these |
1373 | variables. It also differs in that code evaluated with C<do FILENAME> | |
1374 | cannot see lexicals in the enclosing scope; C<eval STRING> does. It's the | |
1375 | same, however, in that it does reparse the file every time you call it, | |
1376 | so you probably don't want to do this inside a loop. | |
a0d0e21e | 1377 | |
8e30cc93 | 1378 | If C<do> cannot read the file, it returns undef and sets C<$!> to the |
2b5ab1e7 | 1379 | error. If C<do> can read the file but cannot compile it, it |
8e30cc93 MG |
1380 | returns undef and sets an error message in C<$@>. If the file is |
1381 | successfully compiled, C<do> returns the value of the last expression | |
1382 | evaluated. | |
1383 | ||
80d38338 | 1384 | Inclusion of library modules is better done with the |
19799a22 | 1385 | C<use> and C<require> operators, which also do automatic error checking |
4633a7c4 | 1386 | and raise an exception if there's a problem. |
a0d0e21e | 1387 | |
5a964f20 TC |
1388 | You might like to use C<do> to read in a program configuration |
1389 | file. Manual error checking can be done this way: | |
1390 | ||
b76cc8ba | 1391 | # read in config files: system first, then user |
f86cebdf | 1392 | for $file ("/share/prog/defaults.rc", |
b76cc8ba | 1393 | "$ENV{HOME}/.someprogrc") |
a9a5a0dc VP |
1394 | { |
1395 | unless ($return = do $file) { | |
1396 | warn "couldn't parse $file: $@" if $@; | |
1397 | warn "couldn't do $file: $!" unless defined $return; | |
1398 | warn "couldn't run $file" unless $return; | |
1399 | } | |
5a964f20 TC |
1400 | } |
1401 | ||
a0d0e21e | 1402 | =item dump LABEL |
d74e8afc | 1403 | X<dump> X<core> X<undump> |
a0d0e21e | 1404 | |
1614b0e3 JD |
1405 | =item dump |
1406 | ||
19799a22 GS |
1407 | This function causes an immediate core dump. See also the B<-u> |
1408 | command-line switch in L<perlrun>, which does the same thing. | |
1409 | Primarily this is so that you can use the B<undump> program (not | |
1410 | supplied) to turn your core dump into an executable binary after | |
1411 | having initialized all your variables at the beginning of the | |
1412 | program. When the new binary is executed it will begin by executing | |
1413 | a C<goto LABEL> (with all the restrictions that C<goto> suffers). | |
1414 | Think of it as a goto with an intervening core dump and reincarnation. | |
1415 | If C<LABEL> is omitted, restarts the program from the top. | |
1416 | ||
1417 | B<WARNING>: Any files opened at the time of the dump will I<not> | |
1418 | be open any more when the program is reincarnated, with possible | |
80d38338 | 1419 | resulting confusion by Perl. |
19799a22 | 1420 | |
59f521f4 RGS |
1421 | This function is now largely obsolete, mostly because it's very hard to |
1422 | convert a core file into an executable. That's why you should now invoke | |
1423 | it as C<CORE::dump()>, if you don't want to be warned against a possible | |
ac206dc8 | 1424 | typo. |
19799a22 | 1425 | |
aa689395 | 1426 | =item each HASH |
d74e8afc | 1427 | X<each> X<hash, iterator> |
aa689395 | 1428 | |
aeedbbed NC |
1429 | =item each ARRAY |
1430 | X<array, iterator> | |
1431 | ||
80d38338 TC |
1432 | When called in list context, returns a 2-element list consisting of the key |
1433 | and value for the next element of a hash, or the index and value for the | |
1434 | next element of an array, so that you can iterate over it. When called in | |
1435 | scalar context, returns only the key (not the value) in a hash, or the index | |
1436 | in an array. | |
2f9daede | 1437 | |
aeedbbed | 1438 | Hash entries are returned in an apparently random order. The actual random |
3b10bc60 | 1439 | order is subject to change in future versions of Perl, but it is |
504f80c1 | 1440 | guaranteed to be in the same order as either the C<keys> or C<values> |
4546b9e6 | 1441 | function would produce on the same (unmodified) hash. Since Perl |
22883ac5 | 1442 | 5.8.2 the ordering can be different even between different runs of Perl |
4546b9e6 | 1443 | for security reasons (see L<perlsec/"Algorithmic Complexity Attacks">). |
ab192400 | 1444 | |
80d38338 TC |
1445 | After C<each> has returned all entries from the hash or array, the next |
1446 | call to C<each> returns the empty list in list context and C<undef> in | |
1447 | scalar context. The next call following that one restarts iteration. Each | |
1448 | hash or array has its own internal iterator, accessed by C<each>, C<keys>, | |
1449 | and C<values>. The iterator is implicitly reset when C<each> has reached | |
1450 | the end as just described; it can be explicitly reset by calling C<keys> or | |
1451 | C<values> on the hash or array. If you add or delete a hash's elements | |
1452 | while iterating over it, entries may be skipped or duplicated--so don't do | |
1453 | that. Exception: It is always safe to delete the item most recently | |
3b10bc60 | 1454 | returned by C<each()>, so the following code works properly: |
74fc8b5f MJD |
1455 | |
1456 | while (($key, $value) = each %hash) { | |
1457 | print $key, "\n"; | |
1458 | delete $hash{$key}; # This is safe | |
1459 | } | |
aa689395 | 1460 | |
80d38338 | 1461 | This prints out your environment like the printenv(1) program, |
3b10bc60 | 1462 | but in a different order: |
a0d0e21e LW |
1463 | |
1464 | while (($key,$value) = each %ENV) { | |
a9a5a0dc | 1465 | print "$key=$value\n"; |
a0d0e21e LW |
1466 | } |
1467 | ||
19799a22 | 1468 | See also C<keys>, C<values> and C<sort>. |
a0d0e21e LW |
1469 | |
1470 | =item eof FILEHANDLE | |
d74e8afc ITB |
1471 | X<eof> |
1472 | X<end of file> | |
1473 | X<end-of-file> | |
a0d0e21e | 1474 | |
4633a7c4 LW |
1475 | =item eof () |
1476 | ||
a0d0e21e LW |
1477 | =item eof |
1478 | ||
1479 | Returns 1 if the next read on FILEHANDLE will return end of file, or if | |
1480 | FILEHANDLE is not open. FILEHANDLE may be an expression whose value | |
5a964f20 | 1481 | gives the real filehandle. (Note that this function actually |
80d38338 | 1482 | reads a character and then C<ungetc>s it, so isn't useful in an |
748a9306 | 1483 | interactive context.) Do not read from a terminal file (or call |
19799a22 | 1484 | C<eof(FILEHANDLE)> on it) after end-of-file is reached. File types such |
748a9306 LW |
1485 | as terminals may lose the end-of-file condition if you do. |
1486 | ||
820475bd | 1487 | An C<eof> without an argument uses the last file read. Using C<eof()> |
80d38338 | 1488 | with empty parentheses is different. It refers to the pseudo file |
820475bd | 1489 | formed from the files listed on the command line and accessed via the |
61eff3bc JH |
1490 | C<< <> >> operator. Since C<< <> >> isn't explicitly opened, |
1491 | as a normal filehandle is, an C<eof()> before C<< <> >> has been | |
820475bd | 1492 | used will cause C<@ARGV> to be examined to determine if input is |
67408cae | 1493 | available. Similarly, an C<eof()> after C<< <> >> has returned |
efdd0218 RB |
1494 | end-of-file will assume you are processing another C<@ARGV> list, |
1495 | and if you haven't set C<@ARGV>, will read input from C<STDIN>; | |
1496 | see L<perlop/"I/O Operators">. | |
820475bd | 1497 | |
61eff3bc | 1498 | In a C<< while (<>) >> loop, C<eof> or C<eof(ARGV)> can be used to |
3b10bc60 | 1499 | detect the end of each file, C<eof()> will detect the end of only the |
820475bd | 1500 | last file. Examples: |
a0d0e21e | 1501 | |
748a9306 LW |
1502 | # reset line numbering on each input file |
1503 | while (<>) { | |
a9a5a0dc VP |
1504 | next if /^\s*#/; # skip comments |
1505 | print "$.\t$_"; | |
5a964f20 | 1506 | } continue { |
a9a5a0dc | 1507 | close ARGV if eof; # Not eof()! |
748a9306 LW |
1508 | } |
1509 | ||
a0d0e21e LW |
1510 | # insert dashes just before last line of last file |
1511 | while (<>) { | |
a9a5a0dc VP |
1512 | if (eof()) { # check for end of last file |
1513 | print "--------------\n"; | |
1514 | } | |
1515 | print; | |
1516 | last if eof(); # needed if we're reading from a terminal | |
a0d0e21e LW |
1517 | } |
1518 | ||
a0d0e21e | 1519 | Practical hint: you almost never need to use C<eof> in Perl, because the |
3ce0d271 GS |
1520 | input operators typically return C<undef> when they run out of data, or if |
1521 | there was an error. | |
a0d0e21e LW |
1522 | |
1523 | =item eval EXPR | |
d74e8afc | 1524 | X<eval> X<try> X<catch> X<evaluate> X<parse> X<execute> |
f723aae1 | 1525 | X<error, handling> X<exception, handling> |
a0d0e21e LW |
1526 | |
1527 | =item eval BLOCK | |
1528 | ||
ce2984c3 PF |
1529 | =item eval |
1530 | ||
c7cc6f1c GS |
1531 | In the first form, the return value of EXPR is parsed and executed as if it |
1532 | were a little Perl program. The value of the expression (which is itself | |
5a964f20 | 1533 | determined within scalar context) is first parsed, and if there weren't any |
be3174d2 GS |
1534 | errors, executed in the lexical context of the current Perl program, so |
1535 | that any variable settings or subroutine and format definitions remain | |
cf264981 | 1536 | afterwards. Note that the value is parsed every time the C<eval> executes. |
be3174d2 GS |
1537 | If EXPR is omitted, evaluates C<$_>. This form is typically used to |
1538 | delay parsing and subsequent execution of the text of EXPR until run time. | |
c7cc6f1c GS |
1539 | |
1540 | In the second form, the code within the BLOCK is parsed only once--at the | |
cf264981 | 1541 | same time the code surrounding the C<eval> itself was parsed--and executed |
c7cc6f1c GS |
1542 | within the context of the current Perl program. This form is typically |
1543 | used to trap exceptions more efficiently than the first (see below), while | |
1544 | also providing the benefit of checking the code within BLOCK at compile | |
1545 | time. | |
1546 | ||
1547 | The final semicolon, if any, may be omitted from the value of EXPR or within | |
1548 | the BLOCK. | |
1549 | ||
1550 | In both forms, the value returned is the value of the last expression | |
5a964f20 | 1551 | evaluated inside the mini-program; a return statement may be also used, just |
c7cc6f1c | 1552 | as with subroutines. The expression providing the return value is evaluated |
cf264981 SP |
1553 | in void, scalar, or list context, depending on the context of the C<eval> |
1554 | itself. See L</wantarray> for more on how the evaluation context can be | |
1555 | determined. | |
a0d0e21e | 1556 | |
19799a22 | 1557 | If there is a syntax error or runtime error, or a C<die> statement is |
bbead3ca BL |
1558 | executed, C<eval> returns an undefined value in scalar context |
1559 | or an empty list in list context, and C<$@> is set to the | |
3b10bc60 | 1560 | error message. If there was no error, C<$@> is guaranteed to be the empty |
1561 | string. Beware that using C<eval> neither silences Perl from printing | |
c7cc6f1c | 1562 | warnings to STDERR, nor does it stuff the text of warning messages into C<$@>. |
d9984052 A |
1563 | To do either of those, you have to use the C<$SIG{__WARN__}> facility, or |
1564 | turn off warnings inside the BLOCK or EXPR using S<C<no warnings 'all'>>. | |
1565 | See L</warn>, L<perlvar>, L<warnings> and L<perllexwarn>. | |
a0d0e21e | 1566 | |
19799a22 GS |
1567 | Note that, because C<eval> traps otherwise-fatal errors, it is useful for |
1568 | determining whether a particular feature (such as C<socket> or C<symlink>) | |
a0d0e21e LW |
1569 | is implemented. It is also Perl's exception trapping mechanism, where |
1570 | the die operator is used to raise exceptions. | |
1571 | ||
5f1da31c NT |
1572 | If you want to trap errors when loading an XS module, some problems with |
1573 | the binary interface (such as Perl version skew) may be fatal even with | |
1574 | C<eval> unless C<$ENV{PERL_DL_NONLAZY}> is set. See L<perlrun>. | |
1575 | ||
a0d0e21e LW |
1576 | If the code to be executed doesn't vary, you may use the eval-BLOCK |
1577 | form to trap run-time errors without incurring the penalty of | |
1578 | recompiling each time. The error, if any, is still returned in C<$@>. | |
1579 | Examples: | |
1580 | ||
54310121 | 1581 | # make divide-by-zero nonfatal |
a0d0e21e LW |
1582 | eval { $answer = $a / $b; }; warn $@ if $@; |
1583 | ||
1584 | # same thing, but less efficient | |
1585 | eval '$answer = $a / $b'; warn $@ if $@; | |
1586 | ||
1587 | # a compile-time error | |
5ed4f2ec | 1588 | eval { $answer = }; # WRONG |
a0d0e21e LW |
1589 | |
1590 | # a run-time error | |
5ed4f2ec | 1591 | eval '$answer ='; # sets $@ |
a0d0e21e | 1592 | |
cf264981 SP |
1593 | Using the C<eval{}> form as an exception trap in libraries does have some |
1594 | issues. Due to the current arguably broken state of C<__DIE__> hooks, you | |
1595 | may wish not to trigger any C<__DIE__> hooks that user code may have installed. | |
2b5ab1e7 | 1596 | You can use the C<local $SIG{__DIE__}> construct for this purpose, |
80d38338 | 1597 | as this example shows: |
774d564b | 1598 | |
80d38338 | 1599 | # a private exception trap for divide-by-zero |
f86cebdf GS |
1600 | eval { local $SIG{'__DIE__'}; $answer = $a / $b; }; |
1601 | warn $@ if $@; | |
774d564b | 1602 | |
1603 | This is especially significant, given that C<__DIE__> hooks can call | |
19799a22 | 1604 | C<die> again, which has the effect of changing their error messages: |
774d564b | 1605 | |
1606 | # __DIE__ hooks may modify error messages | |
1607 | { | |
f86cebdf GS |
1608 | local $SIG{'__DIE__'} = |
1609 | sub { (my $x = $_[0]) =~ s/foo/bar/g; die $x }; | |
c7cc6f1c GS |
1610 | eval { die "foo lives here" }; |
1611 | print $@ if $@; # prints "bar lives here" | |
774d564b | 1612 | } |
1613 | ||
19799a22 | 1614 | Because this promotes action at a distance, this counterintuitive behavior |
2b5ab1e7 TC |
1615 | may be fixed in a future release. |
1616 | ||
19799a22 | 1617 | With an C<eval>, you should be especially careful to remember what's |
a0d0e21e LW |
1618 | being looked at when: |
1619 | ||
5ed4f2ec | 1620 | eval $x; # CASE 1 |
1621 | eval "$x"; # CASE 2 | |
a0d0e21e | 1622 | |
5ed4f2ec | 1623 | eval '$x'; # CASE 3 |
1624 | eval { $x }; # CASE 4 | |
a0d0e21e | 1625 | |
5ed4f2ec | 1626 | eval "\$$x++"; # CASE 5 |
1627 | $$x++; # CASE 6 | |
a0d0e21e | 1628 | |
2f9daede | 1629 | Cases 1 and 2 above behave identically: they run the code contained in |
19799a22 | 1630 | the variable $x. (Although case 2 has misleading double quotes making |
2f9daede | 1631 | the reader wonder what else might be happening (nothing is).) Cases 3 |
7660c0ab | 1632 | and 4 likewise behave in the same way: they run the code C<'$x'>, which |
19799a22 | 1633 | does nothing but return the value of $x. (Case 4 is preferred for |
2f9daede TP |
1634 | purely visual reasons, but it also has the advantage of compiling at |
1635 | compile-time instead of at run-time.) Case 5 is a place where | |
19799a22 | 1636 | normally you I<would> like to use double quotes, except that in this |
2f9daede TP |
1637 | particular situation, you can just use symbolic references instead, as |
1638 | in case 6. | |
a0d0e21e | 1639 | |
8a5a710d DN |
1640 | The assignment to C<$@> occurs before restoration of localised variables, |
1641 | which means a temporary is required if you want to mask some but not all | |
1642 | errors: | |
1643 | ||
1644 | # alter $@ on nefarious repugnancy only | |
1645 | { | |
1646 | my $e; | |
1647 | { | |
1648 | local $@; # protect existing $@ | |
1649 | eval { test_repugnancy() }; | |
1650 | # $@ =~ /nefarious/ and die $@; # DOES NOT WORK | |
1651 | $@ =~ /nefarious/ and $e = $@; | |
1652 | } | |
1653 | die $e if defined $e | |
1654 | } | |
1655 | ||
4968c1e4 | 1656 | C<eval BLOCK> does I<not> count as a loop, so the loop control statements |
2b5ab1e7 | 1657 | C<next>, C<last>, or C<redo> cannot be used to leave or restart the block. |
4968c1e4 | 1658 | |
3b10bc60 | 1659 | An C<eval ''> executed within the C<DB> package doesn't see the usual |
1660 | surrounding lexical scope, but rather the scope of the first non-DB piece | |
1661 | of code that called it. You don't normally need to worry about this unless | |
1662 | you are writing a Perl debugger. | |
d819b83a | 1663 | |
a0d0e21e | 1664 | =item exec LIST |
d74e8afc | 1665 | X<exec> X<execute> |
a0d0e21e | 1666 | |
8bf3b016 GS |
1667 | =item exec PROGRAM LIST |
1668 | ||
3b10bc60 | 1669 | The C<exec> function executes a system command I<and never returns>; |
19799a22 GS |
1670 | use C<system> instead of C<exec> if you want it to return. It fails and |
1671 | returns false only if the command does not exist I<and> it is executed | |
fb73857a | 1672 | directly instead of via your system's command shell (see below). |
a0d0e21e | 1673 | |
19799a22 | 1674 | Since it's a common mistake to use C<exec> instead of C<system>, Perl |
80d38338 | 1675 | warns you if there is a following statement that isn't C<die>, C<warn>, |
3b10bc60 | 1676 | or C<exit> (if C<-w> is set--but you always do that, right?). If you |
19799a22 | 1677 | I<really> want to follow an C<exec> with some other statement, you |
55d729e4 GS |
1678 | can use one of these styles to avoid the warning: |
1679 | ||
5a964f20 TC |
1680 | exec ('foo') or print STDERR "couldn't exec foo: $!"; |
1681 | { exec ('foo') }; print STDERR "couldn't exec foo: $!"; | |
55d729e4 | 1682 | |
5a964f20 | 1683 | If there is more than one argument in LIST, or if LIST is an array |
f86cebdf | 1684 | with more than one value, calls execvp(3) with the arguments in LIST. |
5a964f20 TC |
1685 | If there is only one scalar argument or an array with one element in it, |
1686 | the argument is checked for shell metacharacters, and if there are any, | |
1687 | the entire argument is passed to the system's command shell for parsing | |
1688 | (this is C</bin/sh -c> on Unix platforms, but varies on other platforms). | |
1689 | If there are no shell metacharacters in the argument, it is split into | |
b76cc8ba | 1690 | words and passed directly to C<execvp>, which is more efficient. |
19799a22 | 1691 | Examples: |
a0d0e21e | 1692 | |
19799a22 GS |
1693 | exec '/bin/echo', 'Your arguments are: ', @ARGV; |
1694 | exec "sort $outfile | uniq"; | |
a0d0e21e LW |
1695 | |
1696 | If you don't really want to execute the first argument, but want to lie | |
1697 | to the program you are executing about its own name, you can specify | |
1698 | the program you actually want to run as an "indirect object" (without a | |
1699 | comma) in front of the LIST. (This always forces interpretation of the | |
54310121 | 1700 | LIST as a multivalued list, even if there is only a single scalar in |
a0d0e21e LW |
1701 | the list.) Example: |
1702 | ||
1703 | $shell = '/bin/csh'; | |
5ed4f2ec | 1704 | exec $shell '-sh'; # pretend it's a login shell |
a0d0e21e LW |
1705 | |
1706 | or, more directly, | |
1707 | ||
5ed4f2ec | 1708 | exec {'/bin/csh'} '-sh'; # pretend it's a login shell |
a0d0e21e | 1709 | |
3b10bc60 | 1710 | When the arguments get executed via the system shell, results are |
1711 | subject to its quirks and capabilities. See L<perlop/"`STRING`"> | |
bb32b41a GS |
1712 | for details. |
1713 | ||
19799a22 GS |
1714 | Using an indirect object with C<exec> or C<system> is also more |
1715 | secure. This usage (which also works fine with system()) forces | |
1716 | interpretation of the arguments as a multivalued list, even if the | |
1717 | list had just one argument. That way you're safe from the shell | |
1718 | expanding wildcards or splitting up words with whitespace in them. | |
5a964f20 TC |
1719 | |
1720 | @args = ( "echo surprise" ); | |
1721 | ||
2b5ab1e7 | 1722 | exec @args; # subject to shell escapes |
f86cebdf | 1723 | # if @args == 1 |
2b5ab1e7 | 1724 | exec { $args[0] } @args; # safe even with one-arg list |
5a964f20 TC |
1725 | |
1726 | The first version, the one without the indirect object, ran the I<echo> | |
80d38338 TC |
1727 | program, passing it C<"surprise"> an argument. The second version didn't; |
1728 | it tried to run a program named I<"echo surprise">, didn't find it, and set | |
1729 | C<$?> to a non-zero value indicating failure. | |
5a964f20 | 1730 | |
80d38338 | 1731 | Beginning with v5.6.0, Perl attempts to flush all files opened for |
0f897271 GS |
1732 | output before the exec, but this may not be supported on some platforms |
1733 | (see L<perlport>). To be safe, you may need to set C<$|> ($AUTOFLUSH | |
1734 | in English) or call the C<autoflush()> method of C<IO::Handle> on any | |
80d38338 | 1735 | open handles to avoid lost output. |
0f897271 | 1736 | |
80d38338 TC |
1737 | Note that C<exec> will not call your C<END> blocks, nor will it invoke |
1738 | C<DESTROY> methods on your objects. | |
7660c0ab | 1739 | |
a0d0e21e | 1740 | =item exists EXPR |
d74e8afc | 1741 | X<exists> X<autovivification> |
a0d0e21e | 1742 | |
3b10bc60 | 1743 | Given an expression that specifies an element of a hash or array, |
1744 | returns true if the specified element in that aggregate has ever | |
95731d22 | 1745 | been initialized, even if the corresponding value is undefined. |
a0d0e21e | 1746 | |
5ed4f2ec | 1747 | print "Exists\n" if exists $hash{$key}; |
1748 | print "Defined\n" if defined $hash{$key}; | |
01020589 GS |
1749 | print "True\n" if $hash{$key}; |
1750 | ||
5ed4f2ec | 1751 | print "Exists\n" if exists $array[$index]; |
1752 | print "Defined\n" if defined $array[$index]; | |
01020589 | 1753 | print "True\n" if $array[$index]; |
a0d0e21e | 1754 | |
8ea97a1e | 1755 | A hash or array element can be true only if it's defined, and defined if |
a0d0e21e LW |
1756 | it exists, but the reverse doesn't necessarily hold true. |
1757 | ||
afebc493 GS |
1758 | Given an expression that specifies the name of a subroutine, |
1759 | returns true if the specified subroutine has ever been declared, even | |
1760 | if it is undefined. Mentioning a subroutine name for exists or defined | |
80d38338 | 1761 | does not count as declaring it. Note that a subroutine that does not |
847c7ebe DD |
1762 | exist may still be callable: its package may have an C<AUTOLOAD> |
1763 | method that makes it spring into existence the first time that it is | |
3b10bc60 | 1764 | called; see L<perlsub>. |
afebc493 | 1765 | |
5ed4f2ec | 1766 | print "Exists\n" if exists &subroutine; |
1767 | print "Defined\n" if defined &subroutine; | |
afebc493 | 1768 | |
a0d0e21e | 1769 | Note that the EXPR can be arbitrarily complicated as long as the final |
afebc493 | 1770 | operation is a hash or array key lookup or subroutine name: |
a0d0e21e | 1771 | |
5ed4f2ec | 1772 | if (exists $ref->{A}->{B}->{$key}) { } |
1773 | if (exists $hash{A}{B}{$key}) { } | |
2b5ab1e7 | 1774 | |
5ed4f2ec | 1775 | if (exists $ref->{A}->{B}->[$ix]) { } |
1776 | if (exists $hash{A}{B}[$ix]) { } | |
01020589 | 1777 | |
afebc493 GS |
1778 | if (exists &{$ref->{A}{B}{$key}}) { } |
1779 | ||
3b10bc60 | 1780 | Although the mostly deeply nested array or hash will not spring into |
1781 | existence just because its existence was tested, any intervening ones will. | |
61eff3bc | 1782 | Thus C<< $ref->{"A"} >> and C<< $ref->{"A"}->{"B"} >> will spring |
01020589 | 1783 | into existence due to the existence test for the $key element above. |
3b10bc60 | 1784 | This happens anywhere the arrow operator is used, including even here: |
5a964f20 | 1785 | |
2b5ab1e7 | 1786 | undef $ref; |
5ed4f2ec | 1787 | if (exists $ref->{"Some key"}) { } |
1788 | print $ref; # prints HASH(0x80d3d5c) | |
2b5ab1e7 TC |
1789 | |
1790 | This surprising autovivification in what does not at first--or even | |
1791 | second--glance appear to be an lvalue context may be fixed in a future | |
5a964f20 | 1792 | release. |
a0d0e21e | 1793 | |
afebc493 GS |
1794 | Use of a subroutine call, rather than a subroutine name, as an argument |
1795 | to exists() is an error. | |
1796 | ||
5ed4f2ec | 1797 | exists ⊂ # OK |
1798 | exists &sub(); # Error | |
afebc493 | 1799 | |
a0d0e21e | 1800 | =item exit EXPR |
d74e8afc | 1801 | X<exit> X<terminate> X<abort> |
a0d0e21e | 1802 | |
ce2984c3 PF |
1803 | =item exit |
1804 | ||
2b5ab1e7 | 1805 | Evaluates EXPR and exits immediately with that value. Example: |
a0d0e21e LW |
1806 | |
1807 | $ans = <STDIN>; | |
1808 | exit 0 if $ans =~ /^[Xx]/; | |
1809 | ||
19799a22 | 1810 | See also C<die>. If EXPR is omitted, exits with C<0> status. The only |
2b5ab1e7 TC |
1811 | universally recognized values for EXPR are C<0> for success and C<1> |
1812 | for error; other values are subject to interpretation depending on the | |
1813 | environment in which the Perl program is running. For example, exiting | |
1814 | 69 (EX_UNAVAILABLE) from a I<sendmail> incoming-mail filter will cause | |
1815 | the mailer to return the item undelivered, but that's not true everywhere. | |
a0d0e21e | 1816 | |
19799a22 GS |
1817 | Don't use C<exit> to abort a subroutine if there's any chance that |
1818 | someone might want to trap whatever error happened. Use C<die> instead, | |
1819 | which can be trapped by an C<eval>. | |
28757baa | 1820 | |
19799a22 | 1821 | The exit() function does not always exit immediately. It calls any |
2b5ab1e7 | 1822 | defined C<END> routines first, but these C<END> routines may not |
19799a22 | 1823 | themselves abort the exit. Likewise any object destructors that need to |
2b5ab1e7 TC |
1824 | be called are called before the real exit. If this is a problem, you |
1825 | can call C<POSIX:_exit($status)> to avoid END and destructor processing. | |
87275199 | 1826 | See L<perlmod> for details. |
5a964f20 | 1827 | |
a0d0e21e | 1828 | =item exp EXPR |
d74e8afc | 1829 | X<exp> X<exponential> X<antilog> X<antilogarithm> X<e> |
a0d0e21e | 1830 | |
54310121 | 1831 | =item exp |
bbce6d69 | 1832 | |
b76cc8ba | 1833 | Returns I<e> (the natural logarithm base) to the power of EXPR. |
a0d0e21e LW |
1834 | If EXPR is omitted, gives C<exp($_)>. |
1835 | ||
1836 | =item fcntl FILEHANDLE,FUNCTION,SCALAR | |
d74e8afc | 1837 | X<fcntl> |
a0d0e21e | 1838 | |
f86cebdf | 1839 | Implements the fcntl(2) function. You'll probably have to say |
a0d0e21e LW |
1840 | |
1841 | use Fcntl; | |
1842 | ||
0ade1984 | 1843 | first to get the correct constant definitions. Argument processing and |
3b10bc60 | 1844 | value returned work just like C<ioctl> below. |
a0d0e21e LW |
1845 | For example: |
1846 | ||
1847 | use Fcntl; | |
5a964f20 | 1848 | fcntl($filehandle, F_GETFL, $packed_return_buffer) |
a9a5a0dc | 1849 | or die "can't fcntl F_GETFL: $!"; |
5a964f20 | 1850 | |
554ad1fc | 1851 | You don't have to check for C<defined> on the return from C<fcntl>. |
951ba7fe GS |
1852 | Like C<ioctl>, it maps a C<0> return from the system call into |
1853 | C<"0 but true"> in Perl. This string is true in boolean context and C<0> | |
2b5ab1e7 TC |
1854 | in numeric context. It is also exempt from the normal B<-w> warnings |
1855 | on improper numeric conversions. | |
5a964f20 | 1856 | |
3b10bc60 | 1857 | Note that C<fcntl> raises an exception if used on a machine that |
2b5ab1e7 TC |
1858 | doesn't implement fcntl(2). See the Fcntl module or your fcntl(2) |
1859 | manpage to learn what functions are available on your system. | |
a0d0e21e | 1860 | |
be2f7487 TH |
1861 | Here's an example of setting a filehandle named C<REMOTE> to be |
1862 | non-blocking at the system level. You'll have to negotiate C<$|> | |
1863 | on your own, though. | |
1864 | ||
1865 | use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK); | |
1866 | ||
1867 | $flags = fcntl(REMOTE, F_GETFL, 0) | |
1868 | or die "Can't get flags for the socket: $!\n"; | |
1869 | ||
1870 | $flags = fcntl(REMOTE, F_SETFL, $flags | O_NONBLOCK) | |
1871 | or die "Can't set flags for the socket: $!\n"; | |
1872 | ||
a0d0e21e | 1873 | =item fileno FILEHANDLE |
d74e8afc | 1874 | X<fileno> |
a0d0e21e | 1875 | |
2b5ab1e7 TC |
1876 | Returns the file descriptor for a filehandle, or undefined if the |
1877 | filehandle is not open. This is mainly useful for constructing | |
19799a22 | 1878 | bitmaps for C<select> and low-level POSIX tty-handling operations. |
2b5ab1e7 TC |
1879 | If FILEHANDLE is an expression, the value is taken as an indirect |
1880 | filehandle, generally its name. | |
5a964f20 | 1881 | |
b76cc8ba | 1882 | You can use this to find out whether two handles refer to the |
5a964f20 TC |
1883 | same underlying descriptor: |
1884 | ||
1885 | if (fileno(THIS) == fileno(THAT)) { | |
a9a5a0dc | 1886 | print "THIS and THAT are dups\n"; |
b76cc8ba NIS |
1887 | } |
1888 | ||
1889 | (Filehandles connected to memory objects via new features of C<open> may | |
1890 | return undefined even though they are open.) | |
1891 | ||
a0d0e21e LW |
1892 | |
1893 | =item flock FILEHANDLE,OPERATION | |
d74e8afc | 1894 | X<flock> X<lock> X<locking> |
a0d0e21e | 1895 | |
19799a22 GS |
1896 | Calls flock(2), or an emulation of it, on FILEHANDLE. Returns true |
1897 | for success, false on failure. Produces a fatal error if used on a | |
2b5ab1e7 | 1898 | machine that doesn't implement flock(2), fcntl(2) locking, or lockf(3). |
19799a22 | 1899 | C<flock> is Perl's portable file locking interface, although it locks |
3b10bc60 | 1900 | entire files only, not records. |
2b5ab1e7 TC |
1901 | |
1902 | Two potentially non-obvious but traditional C<flock> semantics are | |
1903 | that it waits indefinitely until the lock is granted, and that its locks | |
1904 | B<merely advisory>. Such discretionary locks are more flexible, but offer | |
cf264981 SP |
1905 | fewer guarantees. This means that programs that do not also use C<flock> |
1906 | may modify files locked with C<flock>. See L<perlport>, | |
2b5ab1e7 TC |
1907 | your port's specific documentation, or your system-specific local manpages |
1908 | for details. It's best to assume traditional behavior if you're writing | |
1909 | portable programs. (But if you're not, you should as always feel perfectly | |
1910 | free to write for your own system's idiosyncrasies (sometimes called | |
1911 | "features"). Slavish adherence to portability concerns shouldn't get | |
1912 | in the way of your getting your job done.) | |
a3cb178b | 1913 | |
8ebc5c01 | 1914 | OPERATION is one of LOCK_SH, LOCK_EX, or LOCK_UN, possibly combined with |
1915 | LOCK_NB. These constants are traditionally valued 1, 2, 8 and 4, but | |
ea3105be | 1916 | you can use the symbolic names if you import them from the Fcntl module, |
68dc0745 | 1917 | either individually, or as a group using the ':flock' tag. LOCK_SH |
1918 | requests a shared lock, LOCK_EX requests an exclusive lock, and LOCK_UN | |
ea3105be | 1919 | releases a previously requested lock. If LOCK_NB is bitwise-or'ed with |
3b10bc60 | 1920 | LOCK_SH or LOCK_EX then C<flock> returns immediately rather than blocking |
1921 | waiting for the lock; check the return status to see if you got it. | |
68dc0745 | 1922 | |
2b5ab1e7 TC |
1923 | To avoid the possibility of miscoordination, Perl now flushes FILEHANDLE |
1924 | before locking or unlocking it. | |
8ebc5c01 | 1925 | |
f86cebdf | 1926 | Note that the emulation built with lockf(3) doesn't provide shared |
8ebc5c01 | 1927 | locks, and it requires that FILEHANDLE be open with write intent. These |
2b5ab1e7 | 1928 | are the semantics that lockf(3) implements. Most if not all systems |
f86cebdf | 1929 | implement lockf(3) in terms of fcntl(2) locking, though, so the |
8ebc5c01 | 1930 | differing semantics shouldn't bite too many people. |
1931 | ||
becacb53 TM |
1932 | Note that the fcntl(2) emulation of flock(3) requires that FILEHANDLE |
1933 | be open with read intent to use LOCK_SH and requires that it be open | |
1934 | with write intent to use LOCK_EX. | |
1935 | ||
19799a22 GS |
1936 | Note also that some versions of C<flock> cannot lock things over the |
1937 | network; you would need to use the more system-specific C<fcntl> for | |
f86cebdf GS |
1938 | that. If you like you can force Perl to ignore your system's flock(2) |
1939 | function, and so provide its own fcntl(2)-based emulation, by passing | |
8ebc5c01 | 1940 | the switch C<-Ud_flock> to the F<Configure> program when you configure |
3b10bc60 | 1941 | Perl. |
4633a7c4 LW |
1942 | |
1943 | Here's a mailbox appender for BSD systems. | |
a0d0e21e | 1944 | |
7ed5353d | 1945 | use Fcntl qw(:flock SEEK_END); # import LOCK_* and SEEK_END constants |
a0d0e21e LW |
1946 | |
1947 | sub lock { | |
a9a5a0dc VP |
1948 | my ($fh) = @_; |
1949 | flock($fh, LOCK_EX) or die "Cannot lock mailbox - $!\n"; | |
7ed5353d | 1950 | |
a9a5a0dc VP |
1951 | # and, in case someone appended while we were waiting... |
1952 | seek($fh, 0, SEEK_END) or die "Cannot seek - $!\n"; | |
a0d0e21e LW |
1953 | } |
1954 | ||
1955 | sub unlock { | |
a9a5a0dc VP |
1956 | my ($fh) = @_; |
1957 | flock($fh, LOCK_UN) or die "Cannot unlock mailbox - $!\n"; | |
a0d0e21e LW |
1958 | } |
1959 | ||
b0169937 | 1960 | open(my $mbox, ">>", "/usr/spool/mail/$ENV{'USER'}") |
5ed4f2ec | 1961 | or die "Can't open mailbox: $!"; |
a0d0e21e | 1962 | |
7ed5353d | 1963 | lock($mbox); |
b0169937 | 1964 | print $mbox $msg,"\n\n"; |
7ed5353d | 1965 | unlock($mbox); |
a0d0e21e | 1966 | |
3b10bc60 | 1967 | On systems that support a real flock(2), locks are inherited across fork() |
1968 | calls, whereas those that must resort to the more capricious fcntl(2) | |
1969 | function lose their locks, making it seriously harder to write servers. | |
2b5ab1e7 | 1970 | |
cb1a09d0 | 1971 | See also L<DB_File> for other flock() examples. |
a0d0e21e LW |
1972 | |
1973 | =item fork | |
d74e8afc | 1974 | X<fork> X<child> X<parent> |
a0d0e21e | 1975 | |
2b5ab1e7 TC |
1976 | Does a fork(2) system call to create a new process running the |
1977 | same program at the same point. It returns the child pid to the | |
1978 | parent process, C<0> to the child process, or C<undef> if the fork is | |
1979 | unsuccessful. File descriptors (and sometimes locks on those descriptors) | |
1980 | are shared, while everything else is copied. On most systems supporting | |
1981 | fork(), great care has gone into making it extremely efficient (for | |
1982 | example, using copy-on-write technology on data pages), making it the | |
1983 | dominant paradigm for multitasking over the last few decades. | |
5a964f20 | 1984 | |
80d38338 | 1985 | Beginning with v5.6.0, Perl attempts to flush all files opened for |
0f897271 GS |
1986 | output before forking the child process, but this may not be supported |
1987 | on some platforms (see L<perlport>). To be safe, you may need to set | |
1988 | C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method of | |
80d38338 | 1989 | C<IO::Handle> on any open handles to avoid duplicate output. |
a0d0e21e | 1990 | |
19799a22 | 1991 | If you C<fork> without ever waiting on your children, you will |
2b5ab1e7 TC |
1992 | accumulate zombies. On some systems, you can avoid this by setting |
1993 | C<$SIG{CHLD}> to C<"IGNORE">. See also L<perlipc> for more examples of | |
1994 | forking and reaping moribund children. | |
cb1a09d0 | 1995 | |
28757baa | 1996 | Note that if your forked child inherits system file descriptors like |
1997 | STDIN and STDOUT that are actually connected by a pipe or socket, even | |
2b5ab1e7 | 1998 | if you exit, then the remote server (such as, say, a CGI script or a |
19799a22 | 1999 | backgrounded job launched from a remote shell) won't think you're done. |
2b5ab1e7 | 2000 | You should reopen those to F</dev/null> if it's any issue. |
28757baa | 2001 | |
cb1a09d0 | 2002 | =item format |
d74e8afc | 2003 | X<format> |
cb1a09d0 | 2004 | |
19799a22 | 2005 | Declare a picture format for use by the C<write> function. For |
cb1a09d0 AD |
2006 | example: |
2007 | ||
54310121 | 2008 | format Something = |
a9a5a0dc VP |
2009 | Test: @<<<<<<<< @||||| @>>>>> |
2010 | $str, $%, '$' . int($num) | |
cb1a09d0 AD |
2011 | . |
2012 | ||
2013 | $str = "widget"; | |
184e9718 | 2014 | $num = $cost/$quantity; |
cb1a09d0 AD |
2015 | $~ = 'Something'; |
2016 | write; | |
2017 | ||
2018 | See L<perlform> for many details and examples. | |
2019 | ||
8903cb82 | 2020 | =item formline PICTURE,LIST |
d74e8afc | 2021 | X<formline> |
a0d0e21e | 2022 | |
5a964f20 | 2023 | This is an internal function used by C<format>s, though you may call it, |
a0d0e21e LW |
2024 | too. It formats (see L<perlform>) a list of values according to the |
2025 | contents of PICTURE, placing the output into the format output | |
7660c0ab | 2026 | accumulator, C<$^A> (or C<$ACCUMULATOR> in English). |
19799a22 | 2027 | Eventually, when a C<write> is done, the contents of |
cf264981 SP |
2028 | C<$^A> are written to some filehandle. You could also read C<$^A> |
2029 | and then set C<$^A> back to C<"">. Note that a format typically | |
19799a22 | 2030 | does one C<formline> per line of form, but the C<formline> function itself |
748a9306 | 2031 | doesn't care how many newlines are embedded in the PICTURE. This means |
3b10bc60 | 2032 | that the C<~> and C<~~> tokens treat the entire PICTURE as a single line. |
748a9306 | 2033 | You may therefore need to use multiple formlines to implement a single |
3b10bc60 | 2034 | record format, just like the C<format> compiler. |
748a9306 | 2035 | |
19799a22 | 2036 | Be careful if you put double quotes around the picture, because an C<@> |
748a9306 | 2037 | character may be taken to mean the beginning of an array name. |
19799a22 | 2038 | C<formline> always returns true. See L<perlform> for other examples. |
a0d0e21e LW |
2039 | |
2040 | =item getc FILEHANDLE | |
f723aae1 | 2041 | X<getc> X<getchar> X<character> X<file, read> |
a0d0e21e LW |
2042 | |
2043 | =item getc | |
2044 | ||
2045 | Returns the next character from the input file attached to FILEHANDLE, | |
3b10bc60 | 2046 | or the undefined value at end of file or if there was an error (in |
b5fe5ca2 SR |
2047 | the latter case C<$!> is set). If FILEHANDLE is omitted, reads from |
2048 | STDIN. This is not particularly efficient. However, it cannot be | |
2049 | used by itself to fetch single characters without waiting for the user | |
2050 | to hit enter. For that, try something more like: | |
4633a7c4 LW |
2051 | |
2052 | if ($BSD_STYLE) { | |
a9a5a0dc | 2053 | system "stty cbreak </dev/tty >/dev/tty 2>&1"; |
4633a7c4 LW |
2054 | } |
2055 | else { | |
a9a5a0dc | 2056 | system "stty", '-icanon', 'eol', "\001"; |
4633a7c4 LW |
2057 | } |
2058 | ||
2059 | $key = getc(STDIN); | |
2060 | ||
2061 | if ($BSD_STYLE) { | |
a9a5a0dc | 2062 | system "stty -cbreak </dev/tty >/dev/tty 2>&1"; |
4633a7c4 LW |
2063 | } |
2064 | else { | |
3b10bc60 | 2065 | system 'stty', 'icanon', 'eol', '^@'; # ASCII NUL |
4633a7c4 LW |
2066 | } |
2067 | print "\n"; | |
2068 | ||
54310121 | 2069 | Determination of whether $BSD_STYLE should be set |
2070 | is left as an exercise to the reader. | |
cb1a09d0 | 2071 | |
19799a22 | 2072 | The C<POSIX::getattr> function can do this more portably on |
2b5ab1e7 TC |
2073 | systems purporting POSIX compliance. See also the C<Term::ReadKey> |
2074 | module from your nearest CPAN site; details on CPAN can be found on | |
2075 | L<perlmodlib/CPAN>. | |
a0d0e21e LW |
2076 | |
2077 | =item getlogin | |
d74e8afc | 2078 | X<getlogin> X<login> |
a0d0e21e | 2079 | |
cf264981 | 2080 | This implements the C library function of the same name, which on most |
3b10bc60 | 2081 | systems returns the current login from F</etc/utmp>, if any. If it |
2082 | returns the empty string, use C<getpwuid>. | |
a0d0e21e | 2083 | |
f86702cc | 2084 | $login = getlogin || getpwuid($<) || "Kilroy"; |
a0d0e21e | 2085 | |
19799a22 GS |
2086 | Do not consider C<getlogin> for authentication: it is not as |
2087 | secure as C<getpwuid>. | |
4633a7c4 | 2088 | |
a0d0e21e | 2089 | =item getpeername SOCKET |
d74e8afc | 2090 | X<getpeername> X<peer> |
a0d0e21e LW |
2091 | |
2092 | Returns the packed sockaddr address of other end of the SOCKET connection. | |
2093 | ||
4633a7c4 LW |
2094 | use Socket; |
2095 | $hersockaddr = getpeername(SOCK); | |
19799a22 | 2096 | ($port, $iaddr) = sockaddr_in($hersockaddr); |
4633a7c4 LW |
2097 | $herhostname = gethostbyaddr($iaddr, AF_INET); |
2098 | $herstraddr = inet_ntoa($iaddr); | |
a0d0e21e LW |
2099 | |
2100 | =item getpgrp PID | |
d74e8afc | 2101 | X<getpgrp> X<group> |
a0d0e21e | 2102 | |
47e29363 | 2103 | Returns the current process group for the specified PID. Use |
7660c0ab | 2104 | a PID of C<0> to get the current process group for the |
4633a7c4 | 2105 | current process. Will raise an exception if used on a machine that |
f86cebdf | 2106 | doesn't implement getpgrp(2). If PID is omitted, returns process |
19799a22 | 2107 | group of current process. Note that the POSIX version of C<getpgrp> |
7660c0ab | 2108 | does not accept a PID argument, so only C<PID==0> is truly portable. |
a0d0e21e LW |
2109 | |
2110 | =item getppid | |
d74e8afc | 2111 | X<getppid> X<parent> X<pid> |
a0d0e21e LW |
2112 | |
2113 | Returns the process id of the parent process. | |
2114 | ||
4d76a344 RGS |
2115 | Note for Linux users: on Linux, the C functions C<getpid()> and |
2116 | C<getppid()> return different values from different threads. In order to | |
3b10bc60 | 2117 | be portable, this behavior is not reflected by the Perl-level function |
4d76a344 | 2118 | C<getppid()>, that returns a consistent value across threads. If you want |
e3256f86 RGS |
2119 | to call the underlying C<getppid()>, you may use the CPAN module |
2120 | C<Linux::Pid>. | |
4d76a344 | 2121 | |
a0d0e21e | 2122 | =item getpriority WHICH,WHO |
d74e8afc | 2123 | X<getpriority> X<priority> X<nice> |
a0d0e21e | 2124 | |
4633a7c4 | 2125 | Returns the current priority for a process, a process group, or a user. |
f4084e39 | 2126 | (See C<getpriority(2)>.) Will raise a fatal exception if used on a |
f86cebdf | 2127 | machine that doesn't implement getpriority(2). |
a0d0e21e LW |
2128 | |
2129 | =item getpwnam NAME | |
d74e8afc ITB |
2130 | X<getpwnam> X<getgrnam> X<gethostbyname> X<getnetbyname> X<getprotobyname> |
2131 | X<getpwuid> X<getgrgid> X<getservbyname> X<gethostbyaddr> X<getnetbyaddr> | |
2132 | X<getprotobynumber> X<getservbyport> X<getpwent> X<getgrent> X<gethostent> | |
2133 | X<getnetent> X<getprotoent> X<getservent> X<setpwent> X<setgrent> X<sethostent> | |
2134 | X<setnetent> X<setprotoent> X<setservent> X<endpwent> X<endgrent> X<endhostent> | |
2135 | X<endnetent> X<endprotoent> X<endservent> | |
a0d0e21e LW |
2136 | |
2137 | =item getgrnam NAME | |
2138 | ||
2139 | =item gethostbyname NAME | |
2140 | ||
2141 | =item getnetbyname NAME | |
2142 | ||
2143 | =item getprotobyname NAME | |
2144 | ||
2145 | =item getpwuid UID | |
2146 | ||
2147 | =item getgrgid GID | |
2148 | ||
2149 | =item getservbyname NAME,PROTO | |
2150 | ||
2151 | =item gethostbyaddr ADDR,ADDRTYPE | |
2152 | ||
2153 | =item getnetbyaddr ADDR,ADDRTYPE | |
2154 | ||
2155 | =item getprotobynumber NUMBER | |
2156 | ||
2157 | =item getservbyport PORT,PROTO | |
2158 | ||
2159 | =item getpwent | |
2160 | ||
2161 | =item getgrent | |
2162 | ||
2163 | =item gethostent | |
2164 | ||
2165 | =item getnetent | |
2166 | ||
2167 | =item getprotoent | |
2168 | ||
2169 | =item getservent | |
2170 | ||
2171 | =item setpwent | |
2172 | ||
2173 | =item setgrent | |
2174 | ||
2175 | =item sethostent STAYOPEN | |
2176 | ||
2177 | =item setnetent STAYOPEN | |
2178 | ||
2179 | =item setprotoent STAYOPEN | |
2180 | ||
2181 | =item setservent STAYOPEN | |
2182 | ||
2183 | =item endpwent | |
2184 | ||
2185 | =item endgrent | |
2186 | ||
2187 | =item endhostent | |
2188 | ||
2189 | =item endnetent | |
2190 | ||
2191 | =item endprotoent | |
2192 | ||
2193 | =item endservent | |
2194 | ||
80d38338 TC |
2195 | These routines are the same as their counterparts in the |
2196 | system C library. In list context, the return values from the | |
a0d0e21e LW |
2197 | various get routines are as follows: |
2198 | ||
2199 | ($name,$passwd,$uid,$gid, | |
6ee623d5 | 2200 | $quota,$comment,$gcos,$dir,$shell,$expire) = getpw* |
a0d0e21e LW |
2201 | ($name,$passwd,$gid,$members) = getgr* |
2202 | ($name,$aliases,$addrtype,$length,@addrs) = gethost* | |
2203 | ($name,$aliases,$addrtype,$net) = getnet* | |
2204 | ($name,$aliases,$proto) = getproto* | |
2205 | ($name,$aliases,$port,$proto) = getserv* | |
2206 | ||
3b10bc60 | 2207 | (If the entry doesn't exist you get an empty list.) |
a0d0e21e | 2208 | |
4602f195 JH |
2209 | The exact meaning of the $gcos field varies but it usually contains |
2210 | the real name of the user (as opposed to the login name) and other | |
2211 | information pertaining to the user. Beware, however, that in many | |
2212 | system users are able to change this information and therefore it | |
106325ad | 2213 | cannot be trusted and therefore the $gcos is tainted (see |
2959b6e3 JH |
2214 | L<perlsec>). The $passwd and $shell, user's encrypted password and |
2215 | login shell, are also tainted, because of the same reason. | |
4602f195 | 2216 | |
5a964f20 | 2217 | In scalar context, you get the name, unless the function was a |
a0d0e21e LW |
2218 | lookup by name, in which case you get the other thing, whatever it is. |
2219 | (If the entry doesn't exist you get the undefined value.) For example: | |
2220 | ||
5a964f20 TC |
2221 | $uid = getpwnam($name); |
2222 | $name = getpwuid($num); | |
2223 | $name = getpwent(); | |
2224 | $gid = getgrnam($name); | |
08a33e13 | 2225 | $name = getgrgid($num); |
5a964f20 TC |
2226 | $name = getgrent(); |
2227 | #etc. | |
a0d0e21e | 2228 | |
4602f195 | 2229 | In I<getpw*()> the fields $quota, $comment, and $expire are special |
80d38338 | 2230 | in that they are unsupported on many systems. If the |
4602f195 JH |
2231 | $quota is unsupported, it is an empty scalar. If it is supported, it |
2232 | usually encodes the disk quota. If the $comment field is unsupported, | |
2233 | it is an empty scalar. If it is supported it usually encodes some | |
2234 | administrative comment about the user. In some systems the $quota | |
2235 | field may be $change or $age, fields that have to do with password | |
2236 | aging. In some systems the $comment field may be $class. The $expire | |
2237 | field, if present, encodes the expiration period of the account or the | |
2238 | password. For the availability and the exact meaning of these fields | |
2239 | in your system, please consult your getpwnam(3) documentation and your | |
2240 | F<pwd.h> file. You can also find out from within Perl what your | |
2241 | $quota and $comment fields mean and whether you have the $expire field | |
2242 | by using the C<Config> module and the values C<d_pwquota>, C<d_pwage>, | |
2243 | C<d_pwchange>, C<d_pwcomment>, and C<d_pwexpire>. Shadow password | |
3b10bc60 | 2244 | files are supported only if your vendor has implemented them in the |
4602f195 | 2245 | intuitive fashion that calling the regular C library routines gets the |
5d3a0a3b | 2246 | shadow versions if you're running under privilege or if there exists |
cf264981 SP |
2247 | the shadow(3) functions as found in System V (this includes Solaris |
2248 | and Linux.) Those systems that implement a proprietary shadow password | |
5d3a0a3b | 2249 | facility are unlikely to be supported. |
6ee623d5 | 2250 | |
19799a22 | 2251 | The $members value returned by I<getgr*()> is a space separated list of |
a0d0e21e LW |
2252 | the login names of the members of the group. |
2253 | ||
2254 | For the I<gethost*()> functions, if the C<h_errno> variable is supported in | |
2255 | C, it will be returned to you via C<$?> if the function call fails. The | |
3b10bc60 | 2256 | C<@addrs> value returned by a successful call is a list of raw |
2257 | addresses returned by the corresponding library call. In the | |
2258 | Internet domain, each address is four bytes long; you can unpack it | |
a0d0e21e LW |
2259 | by saying something like: |
2260 | ||
f337b084 | 2261 | ($a,$b,$c,$d) = unpack('W4',$addr[0]); |
a0d0e21e | 2262 | |
2b5ab1e7 TC |
2263 | The Socket library makes this slightly easier: |
2264 | ||
2265 | use Socket; | |
2266 | $iaddr = inet_aton("127.1"); # or whatever address | |
2267 | $name = gethostbyaddr($iaddr, AF_INET); | |
2268 | ||
2269 | # or going the other way | |
19799a22 | 2270 | $straddr = inet_ntoa($iaddr); |
2b5ab1e7 | 2271 | |
d760c846 GS |
2272 | In the opposite way, to resolve a hostname to the IP address |
2273 | you can write this: | |
2274 | ||
2275 | use Socket; | |
2276 | $packed_ip = gethostbyname("www.perl.org"); | |
2277 | if (defined $packed_ip) { | |
2278 | $ip_address = inet_ntoa($packed_ip); | |
2279 | } | |
2280 | ||
2281 | Make sure <gethostbyname()> is called in SCALAR context and that | |
2282 | its return value is checked for definedness. | |
2283 | ||
19799a22 GS |
2284 | If you get tired of remembering which element of the return list |
2285 | contains which return value, by-name interfaces are provided | |
2286 | in standard modules: C<File::stat>, C<Net::hostent>, C<Net::netent>, | |
2287 | C<Net::protoent>, C<Net::servent>, C<Time::gmtime>, C<Time::localtime>, | |
2288 | and C<User::grent>. These override the normal built-ins, supplying | |
2289 | versions that return objects with the appropriate names | |
2290 | for each field. For example: | |
5a964f20 TC |
2291 | |
2292 | use File::stat; | |
2293 | use User::pwent; | |
2294 | $is_his = (stat($filename)->uid == pwent($whoever)->uid); | |
2295 | ||
b76cc8ba NIS |
2296 | Even though it looks like they're the same method calls (uid), |
2297 | they aren't, because a C<File::stat> object is different from | |
19799a22 | 2298 | a C<User::pwent> object. |
5a964f20 | 2299 | |
a0d0e21e | 2300 | =item getsockname SOCKET |
d74e8afc | 2301 | X<getsockname> |
a0d0e21e | 2302 | |
19799a22 GS |
2303 | Returns the packed sockaddr address of this end of the SOCKET connection, |
2304 | in case you don't know the address because you have several different | |
2305 | IPs that the connection might have come in on. | |
a0d0e21e | 2306 | |
4633a7c4 LW |
2307 | use Socket; |
2308 | $mysockaddr = getsockname(SOCK); | |
19799a22 | 2309 | ($port, $myaddr) = sockaddr_in($mysockaddr); |
b76cc8ba | 2310 | printf "Connect to %s [%s]\n", |
19799a22 GS |
2311 | scalar gethostbyaddr($myaddr, AF_INET), |
2312 | inet_ntoa($myaddr); | |
a0d0e21e LW |
2313 | |
2314 | =item getsockopt SOCKET,LEVEL,OPTNAME | |
d74e8afc | 2315 | X<getsockopt> |
a0d0e21e | 2316 | |
636e6b1f TH |
2317 | Queries the option named OPTNAME associated with SOCKET at a given LEVEL. |
2318 | Options may exist at multiple protocol levels depending on the socket | |
2319 | type, but at least the uppermost socket level SOL_SOCKET (defined in the | |
2320 | C<Socket> module) will exist. To query options at another level the | |
2321 | protocol number of the appropriate protocol controlling the option | |
2322 | should be supplied. For example, to indicate that an option is to be | |
2323 | interpreted by the TCP protocol, LEVEL should be set to the protocol | |
80d38338 | 2324 | number of TCP, which you can get using C<getprotobyname>. |
636e6b1f | 2325 | |
80d38338 | 2326 | The function returns a packed string representing the requested socket |
3b10bc60 | 2327 | option, or C<undef> on error, with the reason for the error placed in |
2328 | C<$!>). Just what is in the packed string depends on LEVEL and OPTNAME; | |
80d38338 TC |
2329 | consult getsockopt(2) for details. A common case is that the option is an |
2330 | integer, in which case the result is a packed integer, which you can decode | |
2331 | using C<unpack> with the C<i> (or C<I>) format. | |
636e6b1f | 2332 | |
80d38338 | 2333 | An example to test whether Nagle's algorithm is turned on on a socket: |
636e6b1f | 2334 | |
4852725b | 2335 | use Socket qw(:all); |
636e6b1f TH |
2336 | |
2337 | defined(my $tcp = getprotobyname("tcp")) | |
a9a5a0dc | 2338 | or die "Could not determine the protocol number for tcp"; |
4852725b DD |
2339 | # my $tcp = IPPROTO_TCP; # Alternative |
2340 | my $packed = getsockopt($socket, $tcp, TCP_NODELAY) | |
80d38338 | 2341 | or die "getsockopt TCP_NODELAY: $!"; |
636e6b1f TH |
2342 | my $nodelay = unpack("I", $packed); |
2343 | print "Nagle's algorithm is turned ", $nodelay ? "off\n" : "on\n"; | |
2344 | ||
a0d0e21e LW |
2345 | |
2346 | =item glob EXPR | |
d74e8afc | 2347 | X<glob> X<wildcard> X<filename, expansion> X<expand> |
a0d0e21e | 2348 | |
0a753a76 | 2349 | =item glob |
2350 | ||
d9a9d457 JL |
2351 | In list context, returns a (possibly empty) list of filename expansions on |
2352 | the value of EXPR such as the standard Unix shell F</bin/csh> would do. In | |
2353 | scalar context, glob iterates through such filename expansions, returning | |
2354 | undef when the list is exhausted. This is the internal function | |
2355 | implementing the C<< <*.c> >> operator, but you can use it directly. If | |
2356 | EXPR is omitted, C<$_> is used. The C<< <*.c> >> operator is discussed in | |
2357 | more detail in L<perlop/"I/O Operators">. | |
a0d0e21e | 2358 | |
80d38338 TC |
2359 | Note that C<glob> splits its arguments on whitespace and treats |
2360 | each segment as separate pattern. As such, C<glob("*.c *.h")> | |
2361 | matches all files with a F<.c> or F<.h> extension. The expression | |
2362 | C<glob(".* *")> matchs all files in the current working directory. | |
2363 | ||
2364 | If non-empty braces are the only wildcard characters used in the | |
2365 | C<glob>, no filenames are matched, but potentially many strings | |
2366 | are returned. For example, this produces nine strings, one for | |
2367 | each pairing of fruits and colors: | |
2368 | ||
2369 | @many = glob "{apple,tomato,cherry}={green,yellow,red}"; | |
5c0c9249 | 2370 | |
3a4b19e4 | 2371 | Beginning with v5.6.0, this operator is implemented using the standard |
5c0c9249 PF |
2372 | C<File::Glob> extension. See L<File::Glob> for details, including |
2373 | C<bsd_glob> which does not treat whitespace as a pattern separator. | |
3a4b19e4 | 2374 | |
a0d0e21e | 2375 | =item gmtime EXPR |
d74e8afc | 2376 | X<gmtime> X<UTC> X<Greenwich> |
a0d0e21e | 2377 | |
ce2984c3 PF |
2378 | =item gmtime |
2379 | ||
435fbc73 GS |
2380 | Works just like L<localtime> but the returned values are |
2381 | localized for the standard Greenwich time zone. | |
a0d0e21e | 2382 | |
435fbc73 GS |
2383 | Note: when called in list context, $isdst, the last value |
2384 | returned by gmtime is always C<0>. There is no | |
2385 | Daylight Saving Time in GMT. | |
0a753a76 | 2386 | |
62aa5637 MS |
2387 | See L<perlport/gmtime> for portability concerns. |
2388 | ||
a0d0e21e | 2389 | =item goto LABEL |
d74e8afc | 2390 | X<goto> X<jump> X<jmp> |
a0d0e21e | 2391 | |
748a9306 LW |
2392 | =item goto EXPR |
2393 | ||
a0d0e21e LW |
2394 | =item goto &NAME |
2395 | ||
b500e03b GG |
2396 | The C<goto-LABEL> form finds the statement labeled with LABEL and |
2397 | resumes execution there. It can't be used to get out of a block or | |
2398 | subroutine given to C<sort>. It can be used to go almost anywhere | |
2399 | else within the dynamic scope, including out of subroutines, but it's | |
2400 | usually better to use some other construct such as C<last> or C<die>. | |
2401 | The author of Perl has never felt the need to use this form of C<goto> | |
3b10bc60 | 2402 | (in Perl, that is; C is another matter). (The difference is that C |
b500e03b GG |
2403 | does not offer named loops combined with loop control. Perl does, and |
2404 | this replaces most structured uses of C<goto> in other languages.) | |
a0d0e21e | 2405 | |
7660c0ab A |
2406 | The C<goto-EXPR> form expects a label name, whose scope will be resolved |
2407 | dynamically. This allows for computed C<goto>s per FORTRAN, but isn't | |
748a9306 LW |
2408 | necessarily recommended if you're optimizing for maintainability: |
2409 | ||
2410 | goto ("FOO", "BAR", "GLARCH")[$i]; | |
2411 | ||
b500e03b | 2412 | Use of C<goto-LABEL> or C<goto-EXPR> to jump into a construct is |
0b98bec9 | 2413 | deprecated and will issue a warning. Even then, it may not be used to |
b500e03b GG |
2414 | go into any construct that requires initialization, such as a |
2415 | subroutine or a C<foreach> loop. It also can't be used to go into a | |
0b98bec9 | 2416 | construct that is optimized away. |
b500e03b | 2417 | |
1b6921cb BT |
2418 | The C<goto-&NAME> form is quite different from the other forms of |
2419 | C<goto>. In fact, it isn't a goto in the normal sense at all, and | |
2420 | doesn't have the stigma associated with other gotos. Instead, it | |
2421 | exits the current subroutine (losing any changes set by local()) and | |
2422 | immediately calls in its place the named subroutine using the current | |
2423 | value of @_. This is used by C<AUTOLOAD> subroutines that wish to | |
2424 | load another subroutine and then pretend that the other subroutine had | |
2425 | been called in the first place (except that any modifications to C<@_> | |
6cb9131c GS |
2426 | in the current subroutine are propagated to the other subroutine.) |
2427 | After the C<goto>, not even C<caller> will be able to tell that this | |
2428 | routine was called first. | |
2429 | ||
2430 | NAME needn't be the name of a subroutine; it can be a scalar variable | |
cf264981 | 2431 | containing a code reference, or a block that evaluates to a code |
6cb9131c | 2432 | reference. |
a0d0e21e LW |
2433 | |
2434 | =item grep BLOCK LIST | |
d74e8afc | 2435 | X<grep> |
a0d0e21e LW |
2436 | |
2437 | =item grep EXPR,LIST | |
2438 | ||
2b5ab1e7 TC |
2439 | This is similar in spirit to, but not the same as, grep(1) and its |
2440 | relatives. In particular, it is not limited to using regular expressions. | |
2f9daede | 2441 | |
a0d0e21e | 2442 | Evaluates the BLOCK or EXPR for each element of LIST (locally setting |
7660c0ab | 2443 | C<$_> to each element) and returns the list value consisting of those |
19799a22 GS |
2444 | elements for which the expression evaluated to true. In scalar |
2445 | context, returns the number of times the expression was true. | |
a0d0e21e LW |
2446 | |
2447 | @foo = grep(!/^#/, @bar); # weed out comments | |
2448 | ||
2449 | or equivalently, | |
2450 | ||
2451 | @foo = grep {!/^#/} @bar; # weed out comments | |
2452 | ||
be3174d2 GS |
2453 | Note that C<$_> is an alias to the list value, so it can be used to |
2454 | modify the elements of the LIST. While this is useful and supported, | |
2455 | it can cause bizarre results if the elements of LIST are not variables. | |
2b5ab1e7 TC |
2456 | Similarly, grep returns aliases into the original list, much as a for |
2457 | loop's index variable aliases the list elements. That is, modifying an | |
19799a22 GS |
2458 | element of a list returned by grep (for example, in a C<foreach>, C<map> |
2459 | or another C<grep>) actually modifies the element in the original list. | |
2b5ab1e7 | 2460 | This is usually something to be avoided when writing clear code. |
a0d0e21e | 2461 | |
a4fb8298 | 2462 | If C<$_> is lexical in the scope where the C<grep> appears (because it has |
cf264981 | 2463 | been declared with C<my $_>) then, in addition to being locally aliased to |
80d38338 | 2464 | the list elements, C<$_> keeps being lexical inside the block; i.e., it |
a4fb8298 RGS |
2465 | can't be seen from the outside, avoiding any potential side-effects. |
2466 | ||
19799a22 | 2467 | See also L</map> for a list composed of the results of the BLOCK or EXPR. |
38325410 | 2468 | |
a0d0e21e | 2469 | =item hex EXPR |
d74e8afc | 2470 | X<hex> X<hexadecimal> |
a0d0e21e | 2471 | |
54310121 | 2472 | =item hex |
bbce6d69 | 2473 | |
2b5ab1e7 | 2474 | Interprets EXPR as a hex string and returns the corresponding value. |
38366c11 | 2475 | (To convert strings that might start with either C<0>, C<0x>, or C<0b>, see |
2b5ab1e7 | 2476 | L</oct>.) If EXPR is omitted, uses C<$_>. |
2f9daede TP |
2477 | |
2478 | print hex '0xAf'; # prints '175' | |
2479 | print hex 'aF'; # same | |
a0d0e21e | 2480 | |
19799a22 | 2481 | Hex strings may only represent integers. Strings that would cause |
53305cf1 | 2482 | integer overflow trigger a warning. Leading whitespace is not stripped, |
38366c11 DN |
2483 | unlike oct(). To present something as hex, look into L</printf>, |
2484 | L</sprintf>, or L</unpack>. | |
19799a22 | 2485 | |
ce2984c3 | 2486 | =item import LIST |
d74e8afc | 2487 | X<import> |
a0d0e21e | 2488 | |
19799a22 | 2489 | There is no builtin C<import> function. It is just an ordinary |
4633a7c4 | 2490 | method (subroutine) defined (or inherited) by modules that wish to export |
19799a22 | 2491 | names to another module. The C<use> function calls the C<import> method |
cea6626f | 2492 | for the package used. See also L</use>, L<perlmod>, and L<Exporter>. |
a0d0e21e LW |
2493 | |
2494 | =item index STR,SUBSTR,POSITION | |
d74e8afc | 2495 | X<index> X<indexOf> X<InStr> |
a0d0e21e LW |
2496 | |
2497 | =item index STR,SUBSTR | |
2498 | ||
2b5ab1e7 TC |
2499 | The index function searches for one string within another, but without |
2500 | the wildcard-like behavior of a full regular-expression pattern match. | |
2501 | It returns the position of the first occurrence of SUBSTR in STR at | |
2502 | or after POSITION. If POSITION is omitted, starts searching from the | |
26f149de YST |
2503 | beginning of the string. POSITION before the beginning of the string |
2504 | or after its end is treated as if it were the beginning or the end, | |
2505 | respectively. POSITION and the return value are based at C<0> (or whatever | |
2b5ab1e7 | 2506 | you've set the C<$[> variable to--but don't do that). If the substring |
cf264981 | 2507 | is not found, C<index> returns one less than the base, ordinarily C<-1>. |
a0d0e21e LW |
2508 | |
2509 | =item int EXPR | |
f723aae1 | 2510 | X<int> X<integer> X<truncate> X<trunc> X<floor> |
a0d0e21e | 2511 | |
54310121 | 2512 | =item int |
bbce6d69 | 2513 | |
7660c0ab | 2514 | Returns the integer portion of EXPR. If EXPR is omitted, uses C<$_>. |
2b5ab1e7 | 2515 | You should not use this function for rounding: one because it truncates |
3b10bc60 | 2516 | towards C<0>, and two because machine representations of floating-point |
2b5ab1e7 TC |
2517 | numbers can sometimes produce counterintuitive results. For example, |
2518 | C<int(-6.725/0.025)> produces -268 rather than the correct -269; that's | |
2519 | because it's really more like -268.99999999999994315658 instead. Usually, | |
19799a22 | 2520 | the C<sprintf>, C<printf>, or the C<POSIX::floor> and C<POSIX::ceil> |
2b5ab1e7 | 2521 | functions will serve you better than will int(). |
a0d0e21e LW |
2522 | |
2523 | =item ioctl FILEHANDLE,FUNCTION,SCALAR | |
d74e8afc | 2524 | X<ioctl> |
a0d0e21e | 2525 | |
2b5ab1e7 | 2526 | Implements the ioctl(2) function. You'll probably first have to say |
a0d0e21e | 2527 | |
5ed4f2ec | 2528 | require "sys/ioctl.ph"; # probably in $Config{archlib}/sys/ioctl.ph |
a0d0e21e | 2529 | |
a11c483f | 2530 | to get the correct function definitions. If F<sys/ioctl.ph> doesn't |
a0d0e21e | 2531 | exist or doesn't have the correct definitions you'll have to roll your |
61eff3bc | 2532 | own, based on your C header files such as F<< <sys/ioctl.h> >>. |
5a964f20 | 2533 | (There is a Perl script called B<h2ph> that comes with the Perl kit that |
54310121 | 2534 | may help you in this, but it's nontrivial.) SCALAR will be read and/or |
3b10bc60 | 2535 | written depending on the FUNCTION; a C pointer to the string value of SCALAR |
19799a22 | 2536 | will be passed as the third argument of the actual C<ioctl> call. (If SCALAR |
4633a7c4 LW |
2537 | has no string value but does have a numeric value, that value will be |
2538 | passed rather than a pointer to the string value. To guarantee this to be | |
19799a22 GS |
2539 | true, add a C<0> to the scalar before using it.) The C<pack> and C<unpack> |
2540 | functions may be needed to manipulate the values of structures used by | |
b76cc8ba | 2541 | C<ioctl>. |
a0d0e21e | 2542 | |
19799a22 | 2543 | The return value of C<ioctl> (and C<fcntl>) is as follows: |
a0d0e21e | 2544 | |
5ed4f2ec | 2545 | if OS returns: then Perl returns: |
2546 | -1 undefined value | |
2547 | 0 string "0 but true" | |
2548 | anything else that number | |
a0d0e21e | 2549 | |
19799a22 | 2550 | Thus Perl returns true on success and false on failure, yet you can |
a0d0e21e LW |
2551 | still easily determine the actual value returned by the operating |
2552 | system: | |
2553 | ||
2b5ab1e7 | 2554 | $retval = ioctl(...) || -1; |
a0d0e21e LW |
2555 | printf "System returned %d\n", $retval; |
2556 | ||
be2f7487 | 2557 | The special string C<"0 but true"> is exempt from B<-w> complaints |
5a964f20 TC |
2558 | about improper numeric conversions. |
2559 | ||
a0d0e21e | 2560 | =item join EXPR,LIST |
d74e8afc | 2561 | X<join> |
a0d0e21e | 2562 | |
2b5ab1e7 TC |
2563 | Joins the separate strings of LIST into a single string with fields |
2564 | separated by the value of EXPR, and returns that new string. Example: | |
a0d0e21e | 2565 | |
2b5ab1e7 | 2566 | $rec = join(':', $login,$passwd,$uid,$gid,$gcos,$home,$shell); |
a0d0e21e | 2567 | |
eb6e2d6f GS |
2568 | Beware that unlike C<split>, C<join> doesn't take a pattern as its |
2569 | first argument. Compare L</split>. | |
a0d0e21e | 2570 | |
aa689395 | 2571 | =item keys HASH |
d74e8afc | 2572 | X<keys> X<key> |
aa689395 | 2573 | |
aeedbbed NC |
2574 | =item keys ARRAY |
2575 | ||
2576 | Returns a list consisting of all the keys of the named hash, or the indices | |
2577 | of an array. (In scalar context, returns the number of keys or indices.) | |
504f80c1 | 2578 | |
aeedbbed | 2579 | The keys of a hash are returned in an apparently random order. The actual |
3b10bc60 | 2580 | random order is subject to change in future versions of Perl, but it |
504f80c1 | 2581 | is guaranteed to be the same order as either the C<values> or C<each> |
4546b9e6 JH |
2582 | function produces (given that the hash has not been modified). Since |
2583 | Perl 5.8.1 the ordering is different even between different runs of | |
2584 | Perl for security reasons (see L<perlsec/"Algorithmic Complexity | |
d6df3700 | 2585 | Attacks">). |
504f80c1 | 2586 | |
aeedbbed | 2587 | As a side effect, calling keys() resets the HASH or ARRAY's internal iterator |
cf264981 SP |
2588 | (see L</each>). In particular, calling keys() in void context resets |
2589 | the iterator with no other overhead. | |
a0d0e21e | 2590 | |
aa689395 | 2591 | Here is yet another way to print your environment: |
a0d0e21e LW |
2592 | |
2593 | @keys = keys %ENV; | |
2594 | @values = values %ENV; | |
b76cc8ba | 2595 | while (@keys) { |
a9a5a0dc | 2596 | print pop(@keys), '=', pop(@values), "\n"; |
a0d0e21e LW |
2597 | } |
2598 | ||
2599 | or how about sorted by key: | |
2600 | ||
2601 | foreach $key (sort(keys %ENV)) { | |
a9a5a0dc | 2602 | print $key, '=', $ENV{$key}, "\n"; |
a0d0e21e LW |
2603 | } |
2604 | ||
8ea1e5d4 GS |
2605 | The returned values are copies of the original keys in the hash, so |
2606 | modifying them will not affect the original hash. Compare L</values>. | |
2607 | ||
19799a22 | 2608 | To sort a hash by value, you'll need to use a C<sort> function. |
aa689395 | 2609 | Here's a descending numeric sort of a hash by its values: |
4633a7c4 | 2610 | |
5a964f20 | 2611 | foreach $key (sort { $hash{$b} <=> $hash{$a} } keys %hash) { |
a9a5a0dc | 2612 | printf "%4d %s\n", $hash{$key}, $key; |
4633a7c4 LW |
2613 | } |
2614 | ||
3b10bc60 | 2615 | Used as an lvalue, C<keys> allows you to increase the number of hash buckets |
aa689395 | 2616 | allocated for the given hash. This can gain you a measure of efficiency if |
2617 | you know the hash is going to get big. (This is similar to pre-extending | |
2618 | an array by assigning a larger number to $#array.) If you say | |
55497cff | 2619 | |
2620 | keys %hash = 200; | |
2621 | ||
ab192400 GS |
2622 | then C<%hash> will have at least 200 buckets allocated for it--256 of them, |
2623 | in fact, since it rounds up to the next power of two. These | |
55497cff | 2624 | buckets will be retained even if you do C<%hash = ()>, use C<undef |
2625 | %hash> if you want to free the storage while C<%hash> is still in scope. | |
2626 | You can't shrink the number of buckets allocated for the hash using | |
19799a22 | 2627 | C<keys> in this way (but you needn't worry about doing this by accident, |
aeedbbed NC |
2628 | as trying has no effect). C<keys @array> in an lvalue context is a syntax |
2629 | error. | |
55497cff | 2630 | |
19799a22 | 2631 | See also C<each>, C<values> and C<sort>. |
ab192400 | 2632 | |
b350dd2f | 2633 | =item kill SIGNAL, LIST |
d74e8afc | 2634 | X<kill> X<signal> |
a0d0e21e | 2635 | |
b350dd2f | 2636 | Sends a signal to a list of processes. Returns the number of |
517db077 GS |
2637 | processes successfully signaled (which is not necessarily the |
2638 | same as the number actually killed). | |
a0d0e21e LW |
2639 | |
2640 | $cnt = kill 1, $child1, $child2; | |
2641 | kill 9, @goners; | |
2642 | ||
3b10bc60 | 2643 | If SIGNAL is zero, no signal is sent to the process, but C<kill> |
2644 | checks whether it's I<possible> to send a signal to it (that | |
70fb64f6 | 2645 | means, to be brief, that the process is owned by the same user, or we are |
3b10bc60 | 2646 | the super-user). This is useful to check that a child process is still |
81fd35db DN |
2647 | alive (even if only as a zombie) and hasn't changed its UID. See |
2648 | L<perlport> for notes on the portability of this construct. | |
b350dd2f | 2649 | |
e2c0f81f DG |
2650 | Unlike in the shell, if SIGNAL is negative, it kills process groups instead |
2651 | of processes. That means you usually want to use positive not negative signals. | |
2652 | You may also use a signal name in quotes. | |
2653 | ||
2654 | The behavior of kill when a I<PROCESS> number is zero or negative depends on | |
2655 | the operating system. For example, on POSIX-conforming systems, zero will | |
2656 | signal the current process group and -1 will signal all processes. | |
1e9c1022 JL |
2657 | |
2658 | See L<perlipc/"Signals"> for more details. | |
a0d0e21e LW |
2659 | |
2660 | =item last LABEL | |
d74e8afc | 2661 | X<last> X<break> |
a0d0e21e LW |
2662 | |
2663 | =item last | |
2664 | ||
2665 | The C<last> command is like the C<break> statement in C (as used in | |
2666 | loops); it immediately exits the loop in question. If the LABEL is | |
2667 | omitted, the command refers to the innermost enclosing loop. The | |
2668 | C<continue> block, if any, is not executed: | |
2669 | ||
4633a7c4 | 2670 | LINE: while (<STDIN>) { |
a9a5a0dc VP |
2671 | last LINE if /^$/; # exit when done with header |
2672 | #... | |
a0d0e21e LW |
2673 | } |
2674 | ||
80d38338 | 2675 | C<last> cannot be used to exit a block that returns a value such as |
2b5ab1e7 TC |
2676 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
2677 | a grep() or map() operation. | |
4968c1e4 | 2678 | |
6c1372ed GS |
2679 | Note that a block by itself is semantically identical to a loop |
2680 | that executes once. Thus C<last> can be used to effect an early | |
2681 | exit out of such a block. | |
2682 | ||
98293880 JH |
2683 | See also L</continue> for an illustration of how C<last>, C<next>, and |
2684 | C<redo> work. | |
1d2dff63 | 2685 | |
a0d0e21e | 2686 | =item lc EXPR |
d74e8afc | 2687 | X<lc> X<lowercase> |
a0d0e21e | 2688 | |
54310121 | 2689 | =item lc |
bbce6d69 | 2690 | |
d1be9408 | 2691 | Returns a lowercased version of EXPR. This is the internal function |
8bdbc703 | 2692 | implementing the C<\L> escape in double-quoted strings. Respects |
2693 | current LC_CTYPE locale if C<use locale> in force. See L<perllocale> | |
2694 | and L<perlunicode> for more details about locale and Unicode support. | |
a0d0e21e | 2695 | |
7660c0ab | 2696 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 2697 | |
a0d0e21e | 2698 | =item lcfirst EXPR |
d74e8afc | 2699 | X<lcfirst> X<lowercase> |
a0d0e21e | 2700 | |
54310121 | 2701 | =item lcfirst |
bbce6d69 | 2702 | |
ad0029c4 JH |
2703 | Returns the value of EXPR with the first character lowercased. This |
2704 | is the internal function implementing the C<\l> escape in | |
8bdbc703 | 2705 | double-quoted strings. Respects current LC_CTYPE locale if C<use |
2706 | locale> in force. See L<perllocale> and L<perlunicode> for more | |
2707 | details about locale and Unicode support. | |
a0d0e21e | 2708 | |
7660c0ab | 2709 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 2710 | |
a0d0e21e | 2711 | =item length EXPR |
d74e8afc | 2712 | X<length> X<size> |
a0d0e21e | 2713 | |
54310121 | 2714 | =item length |
bbce6d69 | 2715 | |
974da8e5 | 2716 | Returns the length in I<characters> of the value of EXPR. If EXPR is |
9f621bb0 | 2717 | omitted, returns length of C<$_>. If EXPR is undefined, returns C<undef>. |
3b10bc60 | 2718 | |
2719 | This function cannot be used on an entire array or hash to find out how | |
2720 | many elements these have. For that, use C<scalar @array> and C<scalar keys | |
2721 | %hash>, respectively. | |
2722 | ||
2723 | Like all Perl character operations, length() normally deals in logical | |
2724 | characters, not physical bytes. For how many bytes a string encoded as | |
2725 | UTF-8 would take up, use C<length(Encode::encode_utf8(EXPR))> (you'll have | |
2726 | to C<use Encode> first). See L<Encode> and L<perlunicode>. | |
974da8e5 | 2727 | |
a0d0e21e | 2728 | =item link OLDFILE,NEWFILE |
d74e8afc | 2729 | X<link> |
a0d0e21e | 2730 | |
19799a22 | 2731 | Creates a new filename linked to the old filename. Returns true for |
b76cc8ba | 2732 | success, false otherwise. |
a0d0e21e LW |
2733 | |
2734 | =item listen SOCKET,QUEUESIZE | |
d74e8afc | 2735 | X<listen> |
a0d0e21e | 2736 | |
3b10bc60 | 2737 | Does the same thing that the listen(2) system call does. Returns true if |
b76cc8ba | 2738 | it succeeded, false otherwise. See the example in |
cea6626f | 2739 | L<perlipc/"Sockets: Client/Server Communication">. |
a0d0e21e LW |
2740 | |
2741 | =item local EXPR | |
d74e8afc | 2742 | X<local> |
a0d0e21e | 2743 | |
19799a22 | 2744 | You really probably want to be using C<my> instead, because C<local> isn't |
b76cc8ba | 2745 | what most people think of as "local". See |
13a2d996 | 2746 | L<perlsub/"Private Variables via my()"> for details. |
2b5ab1e7 | 2747 | |
5a964f20 TC |
2748 | A local modifies the listed variables to be local to the enclosing |
2749 | block, file, or eval. If more than one value is listed, the list must | |
2750 | be placed in parentheses. See L<perlsub/"Temporary Values via local()"> | |
2751 | for details, including issues with tied arrays and hashes. | |
a0d0e21e | 2752 | |
d361fafa VP |
2753 | The C<delete local EXPR> construct can also be used to localize the deletion |
2754 | of array/hash elements to the current block. | |
2755 | See L<perlsub/"Localized deletion of elements of composite types">. | |
2756 | ||
a0d0e21e | 2757 | =item localtime EXPR |
435fbc73 | 2758 | X<localtime> X<ctime> |
a0d0e21e | 2759 | |
ba053783 AL |
2760 | =item localtime |
2761 | ||
19799a22 | 2762 | Converts a time as returned by the time function to a 9-element list |
5f05dabc | 2763 | with the time analyzed for the local time zone. Typically used as |
a0d0e21e LW |
2764 | follows: |
2765 | ||
54310121 | 2766 | # 0 1 2 3 4 5 6 7 8 |
a0d0e21e | 2767 | ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = |
ba053783 | 2768 | localtime(time); |
a0d0e21e | 2769 | |
48a26b3a | 2770 | All list elements are numeric, and come straight out of the C `struct |
ba053783 AL |
2771 | tm'. C<$sec>, C<$min>, and C<$hour> are the seconds, minutes, and hours |
2772 | of the specified time. | |
48a26b3a | 2773 | |
ba053783 AL |
2774 | C<$mday> is the day of the month, and C<$mon> is the month itself, in |
2775 | the range C<0..11> with 0 indicating January and 11 indicating December. | |
2776 | This makes it easy to get a month name from a list: | |
54310121 | 2777 | |
ba053783 AL |
2778 | my @abbr = qw( Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec ); |
2779 | print "$abbr[$mon] $mday"; | |
2780 | # $mon=9, $mday=18 gives "Oct 18" | |
abd75f24 | 2781 | |
ba053783 AL |
2782 | C<$year> is the number of years since 1900, not just the last two digits |
2783 | of the year. That is, C<$year> is C<123> in year 2023. The proper way | |
80d38338 | 2784 | to get a 4-digit year is simply: |
abd75f24 | 2785 | |
ba053783 | 2786 | $year += 1900; |
abd75f24 | 2787 | |
435fbc73 GS |
2788 | Otherwise you create non-Y2K-compliant programs--and you wouldn't want |
2789 | to do that, would you? | |
2790 | ||
ba053783 AL |
2791 | To get the last two digits of the year (e.g., '01' in 2001) do: |
2792 | ||
2793 | $year = sprintf("%02d", $year % 100); | |
2794 | ||
2795 | C<$wday> is the day of the week, with 0 indicating Sunday and 3 indicating | |
2796 | Wednesday. C<$yday> is the day of the year, in the range C<0..364> | |
2797 | (or C<0..365> in leap years.) | |
2798 | ||
2799 | C<$isdst> is true if the specified time occurs during Daylight Saving | |
2800 | Time, false otherwise. | |
abd75f24 | 2801 | |
e1998452 | 2802 | If EXPR is omitted, C<localtime()> uses the current time (as returned |
e3176d09 | 2803 | by time(3)). |
a0d0e21e | 2804 | |
48a26b3a | 2805 | In scalar context, C<localtime()> returns the ctime(3) value: |
a0d0e21e | 2806 | |
5f05dabc | 2807 | $now_string = localtime; # e.g., "Thu Oct 13 04:54:34 1994" |
a0d0e21e | 2808 | |
fe86afc2 NC |
2809 | This scalar value is B<not> locale dependent but is a Perl builtin. For GMT |
2810 | instead of local time use the L</gmtime> builtin. See also the | |
2811 | C<Time::Local> module (to convert the second, minutes, hours, ... back to | |
2812 | the integer value returned by time()), and the L<POSIX> module's strftime(3) | |
2813 | and mktime(3) functions. | |
2814 | ||
2815 | To get somewhat similar but locale dependent date strings, set up your | |
2816 | locale environment variables appropriately (please see L<perllocale>) and | |
2817 | try for example: | |
a3cb178b | 2818 | |
5a964f20 | 2819 | use POSIX qw(strftime); |
2b5ab1e7 | 2820 | $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime; |
fe86afc2 NC |
2821 | # or for GMT formatted appropriately for your locale: |
2822 | $now_string = strftime "%a %b %e %H:%M:%S %Y", gmtime; | |
a3cb178b GS |
2823 | |
2824 | Note that the C<%a> and C<%b>, the short forms of the day of the week | |
2825 | and the month of the year, may not necessarily be three characters wide. | |
a0d0e21e | 2826 | |
62aa5637 MS |
2827 | See L<perlport/localtime> for portability concerns. |
2828 | ||
435fbc73 GS |
2829 | The L<Time::gmtime> and L<Time::localtime> modules provides a convenient, |
2830 | by-name access mechanism to the gmtime() and localtime() functions, | |
2831 | respectively. | |
2832 | ||
2833 | For a comprehensive date and time representation look at the | |
2834 | L<DateTime> module on CPAN. | |
2835 | ||
07698885 | 2836 | =item lock THING |
d74e8afc | 2837 | X<lock> |
19799a22 | 2838 | |
01e6739c | 2839 | This function places an advisory lock on a shared variable, or referenced |
03730085 | 2840 | object contained in I<THING> until the lock goes out of scope. |
a6d5524e | 2841 | |
f3a23afb | 2842 | lock() is a "weak keyword" : this means that if you've defined a function |
67408cae | 2843 | by this name (before any calls to it), that function will be called |
03730085 AB |
2844 | instead. (However, if you've said C<use threads>, lock() is always a |
2845 | keyword.) See L<threads>. | |
19799a22 | 2846 | |
a0d0e21e | 2847 | =item log EXPR |
d74e8afc | 2848 | X<log> X<logarithm> X<e> X<ln> X<base> |
a0d0e21e | 2849 | |
54310121 | 2850 | =item log |
bbce6d69 | 2851 | |
2b5ab1e7 TC |
2852 | Returns the natural logarithm (base I<e>) of EXPR. If EXPR is omitted, |
2853 | returns log of C<$_>. To get the log of another base, use basic algebra: | |
19799a22 | 2854 | The base-N log of a number is equal to the natural log of that number |
2b5ab1e7 TC |
2855 | divided by the natural log of N. For example: |
2856 | ||
2857 | sub log10 { | |
a9a5a0dc VP |
2858 | my $n = shift; |
2859 | return log($n)/log(10); | |
b76cc8ba | 2860 | } |
2b5ab1e7 TC |
2861 | |
2862 | See also L</exp> for the inverse operation. | |
a0d0e21e | 2863 | |
a0d0e21e | 2864 | =item lstat EXPR |
d74e8afc | 2865 | X<lstat> |
a0d0e21e | 2866 | |
54310121 | 2867 | =item lstat |
bbce6d69 | 2868 | |
19799a22 | 2869 | Does the same thing as the C<stat> function (including setting the |
5a964f20 TC |
2870 | special C<_> filehandle) but stats a symbolic link instead of the file |
2871 | the symbolic link points to. If symbolic links are unimplemented on | |
c837d5b4 DP |
2872 | your system, a normal C<stat> is done. For much more detailed |
2873 | information, please see the documentation for C<stat>. | |
a0d0e21e | 2874 | |
7660c0ab | 2875 | If EXPR is omitted, stats C<$_>. |
bbce6d69 | 2876 | |
a0d0e21e LW |
2877 | =item m// |
2878 | ||
9f4b9cd0 | 2879 | The match operator. See L<perlop/"Regexp Quote-Like Operators">. |
a0d0e21e LW |
2880 | |
2881 | =item map BLOCK LIST | |
d74e8afc | 2882 | X<map> |
a0d0e21e LW |
2883 | |
2884 | =item map EXPR,LIST | |
2885 | ||
19799a22 GS |
2886 | Evaluates the BLOCK or EXPR for each element of LIST (locally setting |
2887 | C<$_> to each element) and returns the list value composed of the | |
2888 | results of each such evaluation. In scalar context, returns the | |
2889 | total number of elements so generated. Evaluates BLOCK or EXPR in | |
2890 | list context, so each element of LIST may produce zero, one, or | |
2891 | more elements in the returned value. | |
dd99ebda | 2892 | |
a0d0e21e LW |
2893 | @chars = map(chr, @nums); |
2894 | ||
2895 | translates a list of numbers to the corresponding characters. And | |
2896 | ||
d8216f19 | 2897 | %hash = map { get_a_key_for($_) => $_ } @array; |
a0d0e21e LW |
2898 | |
2899 | is just a funny way to write | |
2900 | ||
2901 | %hash = (); | |
d8216f19 | 2902 | foreach (@array) { |
a9a5a0dc | 2903 | $hash{get_a_key_for($_)} = $_; |
a0d0e21e LW |
2904 | } |
2905 | ||
be3174d2 GS |
2906 | Note that C<$_> is an alias to the list value, so it can be used to |
2907 | modify the elements of the LIST. While this is useful and supported, | |
2908 | it can cause bizarre results if the elements of LIST are not variables. | |
2b5ab1e7 TC |
2909 | Using a regular C<foreach> loop for this purpose would be clearer in |
2910 | most cases. See also L</grep> for an array composed of those items of | |
2911 | the original list for which the BLOCK or EXPR evaluates to true. | |
fb73857a | 2912 | |
a4fb8298 | 2913 | If C<$_> is lexical in the scope where the C<map> appears (because it has |
d8216f19 RGS |
2914 | been declared with C<my $_>), then, in addition to being locally aliased to |
2915 | the list elements, C<$_> keeps being lexical inside the block; that is, it | |
a4fb8298 RGS |
2916 | can't be seen from the outside, avoiding any potential side-effects. |
2917 | ||
205fdb4d | 2918 | C<{> starts both hash references and blocks, so C<map { ...> could be either |
3b10bc60 | 2919 | the start of map BLOCK LIST or map EXPR, LIST. Because Perl doesn't look |
80d38338 TC |
2920 | ahead for the closing C<}> it has to take a guess at which it's dealing with |
2921 | based on what it finds just after the C<{>. Usually it gets it right, but if it | |
205fdb4d NC |
2922 | doesn't it won't realize something is wrong until it gets to the C<}> and |
2923 | encounters the missing (or unexpected) comma. The syntax error will be | |
80d38338 | 2924 | reported close to the C<}>, but you'll need to change something near the C<{> |
3b10bc60 | 2925 | such as using a unary C<+> to give Perl some help: |
205fdb4d | 2926 | |
3b10bc60 | 2927 | %hash = map { "\L$_" => 1 } @array # perl guesses EXPR. wrong |
2928 | %hash = map { +"\L$_" => 1 } @array # perl guesses BLOCK. right | |
2929 | %hash = map { ("\L$_" => 1) } @array # this also works | |
2930 | %hash = map { lc($_) => 1 } @array # as does this. | |
2931 | %hash = map +( lc($_) => 1 ), @array # this is EXPR and works! | |
cea6626f | 2932 | |
3b10bc60 | 2933 | %hash = map ( lc($_), 1 ), @array # evaluates to (1, @array) |
205fdb4d | 2934 | |
d8216f19 | 2935 | or to force an anon hash constructor use C<+{>: |
205fdb4d | 2936 | |
3b10bc60 | 2937 | @hashes = map +{ lc($_) => 1 }, @array # EXPR, so needs comma at end |
205fdb4d | 2938 | |
3b10bc60 | 2939 | to get a list of anonymous hashes each with only one entry apiece. |
205fdb4d | 2940 | |
19799a22 | 2941 | =item mkdir FILENAME,MASK |
d74e8afc | 2942 | X<mkdir> X<md> X<directory, create> |
a0d0e21e | 2943 | |
5a211162 GS |
2944 | =item mkdir FILENAME |
2945 | ||
491873e5 RGS |
2946 | =item mkdir |
2947 | ||
0591cd52 | 2948 | Creates the directory specified by FILENAME, with permissions |
19799a22 GS |
2949 | specified by MASK (as modified by C<umask>). If it succeeds it |
2950 | returns true, otherwise it returns false and sets C<$!> (errno). | |
491873e5 RGS |
2951 | If omitted, MASK defaults to 0777. If omitted, FILENAME defaults |
2952 | to C<$_>. | |
0591cd52 | 2953 | |
19799a22 | 2954 | In general, it is better to create directories with permissive MASK, |
0591cd52 | 2955 | and let the user modify that with their C<umask>, than it is to supply |
19799a22 | 2956 | a restrictive MASK and give the user no way to be more permissive. |
0591cd52 NT |
2957 | The exceptions to this rule are when the file or directory should be |
2958 | kept private (mail files, for instance). The perlfunc(1) entry on | |
19799a22 | 2959 | C<umask> discusses the choice of MASK in more detail. |
a0d0e21e | 2960 | |
cc1852e8 JH |
2961 | Note that according to the POSIX 1003.1-1996 the FILENAME may have any |
2962 | number of trailing slashes. Some operating and filesystems do not get | |
2963 | this right, so Perl automatically removes all trailing slashes to keep | |
2964 | everyone happy. | |
2965 | ||
80d38338 | 2966 | To recursively create a directory structure, look at |
dd184578 RGS |
2967 | the C<mkpath> function of the L<File::Path> module. |
2968 | ||
a0d0e21e | 2969 | =item msgctl ID,CMD,ARG |
d74e8afc | 2970 | X<msgctl> |
a0d0e21e | 2971 | |
f86cebdf | 2972 | Calls the System V IPC function msgctl(2). You'll probably have to say |
0ade1984 JH |
2973 | |
2974 | use IPC::SysV; | |
2975 | ||
7660c0ab | 2976 | first to get the correct constant definitions. If CMD is C<IPC_STAT>, |
cf264981 | 2977 | then ARG must be a variable that will hold the returned C<msqid_ds> |
951ba7fe GS |
2978 | structure. Returns like C<ioctl>: the undefined value for error, |
2979 | C<"0 but true"> for zero, or the actual return value otherwise. See also | |
4755096e | 2980 | L<perlipc/"SysV IPC">, C<IPC::SysV>, and C<IPC::Semaphore> documentation. |
a0d0e21e LW |
2981 | |
2982 | =item msgget KEY,FLAGS | |
d74e8afc | 2983 | X<msgget> |
a0d0e21e | 2984 | |
f86cebdf | 2985 | Calls the System V IPC function msgget(2). Returns the message queue |
4755096e GS |
2986 | id, or the undefined value if there is an error. See also |
2987 | L<perlipc/"SysV IPC"> and C<IPC::SysV> and C<IPC::Msg> documentation. | |
a0d0e21e | 2988 | |
a0d0e21e | 2989 | =item msgrcv ID,VAR,SIZE,TYPE,FLAGS |
d74e8afc | 2990 | X<msgrcv> |
a0d0e21e LW |
2991 | |
2992 | Calls the System V IPC function msgrcv to receive a message from | |
2993 | message queue ID into variable VAR with a maximum message size of | |
41d6edb2 JH |
2994 | SIZE. Note that when a message is received, the message type as a |
2995 | native long integer will be the first thing in VAR, followed by the | |
2996 | actual message. This packing may be opened with C<unpack("l! a*")>. | |
2997 | Taints the variable. Returns true if successful, or false if there is | |
4755096e GS |
2998 | an error. See also L<perlipc/"SysV IPC">, C<IPC::SysV>, and |
2999 | C<IPC::SysV::Msg> documentation. | |
41d6edb2 JH |
3000 | |
3001 | =item msgsnd ID,MSG,FLAGS | |
d74e8afc | 3002 | X<msgsnd> |
41d6edb2 JH |
3003 | |
3004 | Calls the System V IPC function msgsnd to send the message MSG to the | |
3005 | message queue ID. MSG must begin with the native long integer message | |
3006 | type, and be followed by the length of the actual message, and finally | |
3007 | the message itself. This kind of packing can be achieved with | |
3008 | C<pack("l! a*", $type, $message)>. Returns true if successful, | |
3009 | or false if there is an error. See also C<IPC::SysV> | |
3010 | and C<IPC::SysV::Msg> documentation. | |
a0d0e21e LW |
3011 | |
3012 | =item my EXPR | |
d74e8afc | 3013 | X<my> |
a0d0e21e | 3014 | |
307ea6df JH |
3015 | =item my TYPE EXPR |
3016 | ||
1d2de774 | 3017 | =item my EXPR : ATTRS |
09bef843 | 3018 | |
1d2de774 | 3019 | =item my TYPE EXPR : ATTRS |
307ea6df | 3020 | |
19799a22 | 3021 | A C<my> declares the listed variables to be local (lexically) to the |
1d2de774 JH |
3022 | enclosing block, file, or C<eval>. If more than one value is listed, |
3023 | the list must be placed in parentheses. | |
307ea6df | 3024 | |
1d2de774 JH |
3025 | The exact semantics and interface of TYPE and ATTRS are still |
3026 | evolving. TYPE is currently bound to the use of C<fields> pragma, | |
307ea6df JH |
3027 | and attributes are handled using the C<attributes> pragma, or starting |
3028 | from Perl 5.8.0 also via the C<Attribute::Handlers> module. See | |
3029 | L<perlsub/"Private Variables via my()"> for details, and L<fields>, | |
3030 | L<attributes>, and L<Attribute::Handlers>. | |
4633a7c4 | 3031 | |
a0d0e21e | 3032 | =item next LABEL |
d74e8afc | 3033 | X<next> X<continue> |
a0d0e21e LW |
3034 | |
3035 | =item next | |
3036 | ||
3037 | The C<next> command is like the C<continue> statement in C; it starts | |
3038 | the next iteration of the loop: | |
3039 | ||
4633a7c4 | 3040 | LINE: while (<STDIN>) { |
a9a5a0dc VP |
3041 | next LINE if /^#/; # discard comments |
3042 | #... | |
a0d0e21e LW |
3043 | } |
3044 | ||
3045 | Note that if there were a C<continue> block on the above, it would get | |
3b10bc60 | 3046 | executed even on discarded lines. If LABEL is omitted, the command |
a0d0e21e LW |
3047 | refers to the innermost enclosing loop. |
3048 | ||
4968c1e4 | 3049 | C<next> cannot be used to exit a block which returns a value such as |
2b5ab1e7 TC |
3050 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
3051 | a grep() or map() operation. | |
4968c1e4 | 3052 | |
6c1372ed GS |
3053 | Note that a block by itself is semantically identical to a loop |
3054 | that executes once. Thus C<next> will exit such a block early. | |
3055 | ||
98293880 JH |
3056 | See also L</continue> for an illustration of how C<last>, C<next>, and |
3057 | C<redo> work. | |
1d2dff63 | 3058 | |
3b10bc60 | 3059 | =item no MODULE VERSION LIST |
3060 | X<no declarations> | |
3061 | X<unimporting> | |
4a66ea5a | 3062 | |
3b10bc60 | 3063 | =item no MODULE VERSION |
4a66ea5a | 3064 | |
3b10bc60 | 3065 | =item no MODULE LIST |
a0d0e21e | 3066 | |
3b10bc60 | 3067 | =item no MODULE |
4a66ea5a | 3068 | |
c986422f RGS |
3069 | =item no VERSION |
3070 | ||
593b9c14 | 3071 | See the C<use> function, of which C<no> is the opposite. |
a0d0e21e LW |
3072 | |
3073 | =item oct EXPR | |
d74e8afc | 3074 | X<oct> X<octal> X<hex> X<hexadecimal> X<binary> X<bin> |
a0d0e21e | 3075 | |
54310121 | 3076 | =item oct |
bbce6d69 | 3077 | |
4633a7c4 | 3078 | Interprets EXPR as an octal string and returns the corresponding |
4f19785b WSI |
3079 | value. (If EXPR happens to start off with C<0x>, interprets it as a |
3080 | hex string. If EXPR starts off with C<0b>, it is interpreted as a | |
53305cf1 | 3081 | binary string. Leading whitespace is ignored in all three cases.) |
3b10bc60 | 3082 | The following will handle decimal, binary, octal, and hex in standard |
3083 | Perl notation: | |
a0d0e21e LW |
3084 | |
3085 | $val = oct($val) if $val =~ /^0/; | |
3086 | ||
19799a22 GS |
3087 | If EXPR is omitted, uses C<$_>. To go the other way (produce a number |
3088 | in octal), use sprintf() or printf(): | |
3089 | ||
3b10bc60 | 3090 | $dec_perms = (stat("filename"))[2] & 07777; |
3091 | $oct_perm_str = sprintf "%o", $perms; | |
19799a22 GS |
3092 | |
3093 | The oct() function is commonly used when a string such as C<644> needs | |
3b10bc60 | 3094 | to be converted into a file mode, for example. Although Perl |
3095 | automatically converts strings into numbers as needed, this automatic | |
3096 | conversion assumes base 10. | |
3097 | ||
3098 | Leading white space is ignored without warning, as too are any trailing | |
3099 | non-digits, such as a decimal point (C<oct> only handles non-negative | |
3100 | integers, not negative integers or floating point). | |
a0d0e21e LW |
3101 | |
3102 | =item open FILEHANDLE,EXPR | |
d74e8afc | 3103 | X<open> X<pipe> X<file, open> X<fopen> |
a0d0e21e | 3104 | |
68bd7414 NIS |
3105 | =item open FILEHANDLE,MODE,EXPR |
3106 | ||
3107 | =item open FILEHANDLE,MODE,EXPR,LIST | |
3108 | ||
ba964c95 T |
3109 | =item open FILEHANDLE,MODE,REFERENCE |
3110 | ||
a0d0e21e LW |
3111 | =item open FILEHANDLE |
3112 | ||
3113 | Opens the file whose filename is given by EXPR, and associates it with | |
ed53a2bb JH |
3114 | FILEHANDLE. |
3115 | ||
460b70c2 GS |
3116 | Simple examples to open a file for reading: |
3117 | ||
3118 | open(my $fh, '<', "input.txt") or die $!; | |
3119 | ||
3120 | and for writing: | |
3121 | ||
3122 | open(my $fh, '>', "output.txt") or die $!; | |
3123 | ||
ed53a2bb JH |
3124 | (The following is a comprehensive reference to open(): for a gentler |
3125 | introduction you may consider L<perlopentut>.) | |
3126 | ||
a28cd5c9 NT |
3127 | If FILEHANDLE is an undefined scalar variable (or array or hash element) |
3128 | the variable is assigned a reference to a new anonymous filehandle, | |
3129 | otherwise if FILEHANDLE is an expression, its value is used as the name of | |
3130 | the real filehandle wanted. (This is considered a symbolic reference, so | |
3131 | C<use strict 'refs'> should I<not> be in effect.) | |
ed53a2bb JH |
3132 | |
3133 | If EXPR is omitted, the scalar variable of the same name as the | |
3134 | FILEHANDLE contains the filename. (Note that lexical variables--those | |
3135 | declared with C<my>--will not work for this purpose; so if you're | |
67408cae | 3136 | using C<my>, specify EXPR in your call to open.) |
ed53a2bb JH |
3137 | |
3138 | If three or more arguments are specified then the mode of opening and | |
3b10bc60 | 3139 | the filename are separate. If MODE is C<< '<' >> or nothing, the file |
ed53a2bb JH |
3140 | is opened for input. If MODE is C<< '>' >>, the file is truncated and |
3141 | opened for output, being created if necessary. If MODE is C<<< '>>' >>>, | |
b76cc8ba | 3142 | the file is opened for appending, again being created if necessary. |
5a964f20 | 3143 | |
ed53a2bb JH |
3144 | You can put a C<'+'> in front of the C<< '>' >> or C<< '<' >> to |
3145 | indicate that you want both read and write access to the file; thus | |
3b10bc60 | 3146 | C<< '+<' >> is almost always preferred for read/write updates--the |
3147 | C<< '+>' >> mode would clobber the file first. You can't usually use | |
ed53a2bb JH |
3148 | either read-write mode for updating textfiles, since they have |
3149 | variable length records. See the B<-i> switch in L<perlrun> for a | |
3150 | better approach. The file is created with permissions of C<0666> | |
e1020413 | 3151 | modified by the process's C<umask> value. |
ed53a2bb JH |
3152 | |
3153 | These various prefixes correspond to the fopen(3) modes of C<'r'>, | |
3154 | C<'r+'>, C<'w'>, C<'w+'>, C<'a'>, and C<'a+'>. | |
5f05dabc | 3155 | |
3b10bc60 | 3156 | In the two-argument (and one-argument) form of the call, the mode and |
3157 | filename should be concatenated (in that order), possibly separated by | |
3158 | spaces. You may omit the mode in these forms when that mode is | |
68bd7414 | 3159 | C<< '<' >>. |
6170680b | 3160 | |
7660c0ab | 3161 | If the filename begins with C<'|'>, the filename is interpreted as a |
5a964f20 | 3162 | command to which output is to be piped, and if the filename ends with a |
80d38338 | 3163 | C<'|'>, the filename is interpreted as a command that pipes output to |
f244e06d | 3164 | us. See L<perlipc/"Using open() for IPC"> |
19799a22 | 3165 | for more examples of this. (You are not allowed to C<open> to a command |
5a964f20 | 3166 | that pipes both in I<and> out, but see L<IPC::Open2>, L<IPC::Open3>, |
4a4eefd0 GS |
3167 | and L<perlipc/"Bidirectional Communication with Another Process"> |
3168 | for alternatives.) | |
cb1a09d0 | 3169 | |
ed53a2bb JH |
3170 | For three or more arguments if MODE is C<'|-'>, the filename is |
3171 | interpreted as a command to which output is to be piped, and if MODE | |
80d38338 | 3172 | is C<'-|'>, the filename is interpreted as a command that pipes |
3b10bc60 | 3173 | output to us. In the two-argument (and one-argument) form, one should |
ed53a2bb JH |
3174 | replace dash (C<'-'>) with the command. |
3175 | See L<perlipc/"Using open() for IPC"> for more examples of this. | |
3176 | (You are not allowed to C<open> to a command that pipes both in I<and> | |
3177 | out, but see L<IPC::Open2>, L<IPC::Open3>, and | |
3178 | L<perlipc/"Bidirectional Communication"> for alternatives.) | |
3179 | ||
3b10bc60 | 3180 | In the form of pipe opens taking three or more arguments, if LIST is specified |
ed53a2bb JH |
3181 | (extra arguments after the command name) then LIST becomes arguments |
3182 | to the command invoked if the platform supports it. The meaning of | |
3183 | C<open> with more than three arguments for non-pipe modes is not yet | |
3b10bc60 | 3184 | defined, but experimental "layers" may give extra LIST arguments |
ed53a2bb | 3185 | meaning. |
6170680b | 3186 | |
3b10bc60 | 3187 | In the two-argument (and one-argument) form, opening C<< '<-' >> |
3188 | or C<'-'> opens STDIN and opening C<< '>-' >> opens STDOUT. | |
6170680b | 3189 | |
3b10bc60 | 3190 | You may use the three-argument form of open to specify I/O layers |
3191 | (sometimes referred to as "disciplines") to apply to the handle | |
fae2c0fb | 3192 | that affect how the input and output are processed (see L<open> and |
3b10bc60 | 3193 | L<PerlIO> for more details). For example: |
7207e29d | 3194 | |
3b10bc60 | 3195 | open(my $fh, "<:encoding(UTF-8)", "filename") |
3196 | || die "can't open UTF-8 encoded filename: $!"; | |
9124316e | 3197 | |
3b10bc60 | 3198 | opens the UTF-8 encoded file containing Unicode characters; |
6d5e88a0 | 3199 | see L<perluniintro>. Note that if layers are specified in the |
3b10bc60 | 3200 | three-argument form, then default layers stored in ${^OPEN} (see L<perlvar>; |
6d5e88a0 | 3201 | usually set by the B<open> pragma or the switch B<-CioD>) are ignored. |
ed53a2bb | 3202 | |
80d38338 | 3203 | Open returns nonzero on success, the undefined value otherwise. If |
ed53a2bb JH |
3204 | the C<open> involved a pipe, the return value happens to be the pid of |
3205 | the subprocess. | |
cb1a09d0 | 3206 | |
ed53a2bb JH |
3207 | If you're running Perl on a system that distinguishes between text |
3208 | files and binary files, then you should check out L</binmode> for tips | |
3209 | for dealing with this. The key distinction between systems that need | |
3210 | C<binmode> and those that don't is their text file formats. Systems | |
80d38338 TC |
3211 | like Unix, Mac OS, and Plan 9, that end lines with a single |
3212 | character and encode that character in C as C<"\n"> do not | |
ed53a2bb | 3213 | need C<binmode>. The rest need it. |
cb1a09d0 | 3214 | |
80d38338 TC |
3215 | When opening a file, it's seldom a good idea to continue |
3216 | if the request failed, so C<open> is frequently used with | |
19799a22 | 3217 | C<die>. Even if C<die> won't do what you want (say, in a CGI script, |
80d38338 TC |
3218 | where you want to format a suitable error message (but there are |
3219 | modules that can help with that problem)) always check | |
3220 | the return value from opening a file. | |
fb73857a | 3221 | |
cf264981 | 3222 | As a special case the 3-arg form with a read/write mode and the third |
ed53a2bb | 3223 | argument being C<undef>: |
b76cc8ba | 3224 | |
460b70c2 | 3225 | open(my $tmp, "+>", undef) or die ... |
b76cc8ba | 3226 | |
f253e835 JH |
3227 | opens a filehandle to an anonymous temporary file. Also using "+<" |
3228 | works for symmetry, but you really should consider writing something | |
3229 | to the temporary file first. You will need to seek() to do the | |
3230 | reading. | |
b76cc8ba | 3231 | |
3b10bc60 | 3232 | Since v5.8.0, Perl has built using PerlIO by default. Unless you've |
3233 | changed this (i.e., Configure -Uuseperlio), you can open filehandles | |
3234 | directly to Perl scalars via: | |
ba964c95 | 3235 | |
b996200f SB |
3236 | open($fh, '>', \$variable) || .. |
3237 | ||
3b10bc60 | 3238 | To (re)open C<STDOUT> or C<STDERR> as an in-memory file, close it first: |
b996200f SB |
3239 | |
3240 | close STDOUT; | |
3241 | open STDOUT, '>', \$variable or die "Can't open STDOUT: $!"; | |
ba964c95 | 3242 | |
3b10bc60 | 3243 | General examples: |
a0d0e21e LW |
3244 | |
3245 | $ARTICLE = 100; | |
3246 | open ARTICLE or die "Can't find article $ARTICLE: $!\n"; | |
3247 | while (<ARTICLE>) {... | |
3248 | ||
5ed4f2ec | 3249 | open(LOG, '>>/usr/spool/news/twitlog'); # (log is reserved) |
fb73857a | 3250 | # if the open fails, output is discarded |
a0d0e21e | 3251 | |
5ed4f2ec | 3252 | open(my $dbase, '+<', 'dbase.mine') # open for update |
a9a5a0dc | 3253 | or die "Can't open 'dbase.mine' for update: $!"; |
cb1a09d0 | 3254 | |
5ed4f2ec | 3255 | open(my $dbase, '+<dbase.mine') # ditto |
a9a5a0dc | 3256 | or die "Can't open 'dbase.mine' for update: $!"; |
6170680b | 3257 | |
5ed4f2ec | 3258 | open(ARTICLE, '-|', "caesar <$article") # decrypt article |
a9a5a0dc | 3259 | or die "Can't start caesar: $!"; |
a0d0e21e | 3260 | |
5ed4f2ec | 3261 | open(ARTICLE, "caesar <$article |") # ditto |
a9a5a0dc | 3262 | or die "Can't start caesar: $!"; |
6170680b | 3263 | |
5ed4f2ec | 3264 | open(EXTRACT, "|sort >Tmp$$") # $$ is our process id |
a9a5a0dc | 3265 | or die "Can't start sort: $!"; |
a0d0e21e | 3266 | |
3b10bc60 | 3267 | # in-memory files |
ba964c95 | 3268 | open(MEMORY,'>', \$var) |
a9a5a0dc | 3269 | or die "Can't open memory file: $!"; |
80d38338 | 3270 | print MEMORY "foo!\n"; # output will appear in $var |
ba964c95 | 3271 | |
a0d0e21e LW |
3272 | # process argument list of files along with any includes |
3273 | ||
3274 | foreach $file (@ARGV) { | |
a9a5a0dc | 3275 | process($file, 'fh00'); |
a0d0e21e LW |
3276 | } |
3277 | ||
3278 | sub process { | |
a9a5a0dc VP |
3279 | my($filename, $input) = @_; |
3280 | $input++; # this is a string increment | |
3281 | unless (open($input, $filename)) { | |
3282 | print STDERR "Can't open $filename: $!\n"; | |
3283 | return; | |
3284 | } | |
5ed4f2ec | 3285 | |
a9a5a0dc VP |
3286 | local $_; |
3287 | while (<$input>) { # note use of indirection | |
3288 | if (/^#include "(.*)"/) { | |
3289 | process($1, $input); | |
3290 | next; | |
3291 | } | |
3292 | #... # whatever | |
5ed4f2ec | 3293 | } |
a0d0e21e LW |
3294 | } |
3295 | ||
ae4c5402 | 3296 | See L<perliol> for detailed info on PerlIO. |
2ce64696 | 3297 | |
a0d0e21e | 3298 | You may also, in the Bourne shell tradition, specify an EXPR beginning |
00cafafa JH |
3299 | with C<< '>&' >>, in which case the rest of the string is interpreted |
3300 | as the name of a filehandle (or file descriptor, if numeric) to be | |
f4084e39 | 3301 | duped (as C<dup(2)>) and opened. You may use C<&> after C<< > >>, |
00cafafa JH |
3302 | C<<< >> >>>, C<< < >>, C<< +> >>, C<<< +>> >>>, and C<< +< >>. |
3303 | The mode you specify should match the mode of the original filehandle. | |
3304 | (Duping a filehandle does not take into account any existing contents | |
cf264981 | 3305 | of IO buffers.) If you use the 3-arg form then you can pass either a |
00cafafa | 3306 | number, the name of a filehandle or the normal "reference to a glob". |
6170680b | 3307 | |
eae1b76b SB |
3308 | Here is a script that saves, redirects, and restores C<STDOUT> and |
3309 | C<STDERR> using various methods: | |
a0d0e21e LW |
3310 | |
3311 | #!/usr/bin/perl | |
eae1b76b SB |
3312 | open my $oldout, ">&STDOUT" or die "Can't dup STDOUT: $!"; |
3313 | open OLDERR, ">&", \*STDERR or die "Can't dup STDERR: $!"; | |
818c4caa | 3314 | |
eae1b76b SB |
3315 | open STDOUT, '>', "foo.out" or die "Can't redirect STDOUT: $!"; |
3316 | open STDERR, ">&STDOUT" or die "Can't dup STDOUT: $!"; | |
a0d0e21e | 3317 | |
5ed4f2ec | 3318 | select STDERR; $| = 1; # make unbuffered |
3319 | select STDOUT; $| = 1; # make unbuffered | |
a0d0e21e | 3320 | |
5ed4f2ec | 3321 | print STDOUT "stdout 1\n"; # this works for |
3322 | print STDERR "stderr 1\n"; # subprocesses too | |
a0d0e21e | 3323 | |
eae1b76b SB |
3324 | open STDOUT, ">&", $oldout or die "Can't dup \$oldout: $!"; |
3325 | open STDERR, ">&OLDERR" or die "Can't dup OLDERR: $!"; | |
a0d0e21e LW |
3326 | |
3327 | print STDOUT "stdout 2\n"; | |
3328 | print STDERR "stderr 2\n"; | |
3329 | ||
ef8b303f JH |
3330 | If you specify C<< '<&=X' >>, where C<X> is a file descriptor number |
3331 | or a filehandle, then Perl will do an equivalent of C's C<fdopen> of | |
f4084e39 | 3332 | that file descriptor (and not call C<dup(2)>); this is more |
ef8b303f | 3333 | parsimonious of file descriptors. For example: |
a0d0e21e | 3334 | |
00cafafa | 3335 | # open for input, reusing the fileno of $fd |
a0d0e21e | 3336 | open(FILEHANDLE, "<&=$fd") |
df632fdf | 3337 | |
b76cc8ba | 3338 | or |
df632fdf | 3339 | |
b76cc8ba | 3340 | open(FILEHANDLE, "<&=", $fd) |
a0d0e21e | 3341 | |
00cafafa JH |
3342 | or |
3343 | ||
3344 | # open for append, using the fileno of OLDFH | |
3345 | open(FH, ">>&=", OLDFH) | |
3346 | ||
3347 | or | |
3348 | ||
3349 | open(FH, ">>&=OLDFH") | |
3350 | ||
ef8b303f JH |
3351 | Being parsimonious on filehandles is also useful (besides being |
3352 | parsimonious) for example when something is dependent on file | |
3353 | descriptors, like for example locking using flock(). If you do just | |
3354 | C<< open(A, '>>&B') >>, the filehandle A will not have the same file | |
3355 | descriptor as B, and therefore flock(A) will not flock(B), and vice | |
3356 | versa. But with C<< open(A, '>>&=B') >> the filehandles will share | |
3357 | the same file descriptor. | |
3358 | ||
3359 | Note that if you are using Perls older than 5.8.0, Perl will be using | |
3360 | the standard C libraries' fdopen() to implement the "=" functionality. | |
e1020413 | 3361 | On many Unix systems fdopen() fails when file descriptors exceed a |
ef8b303f JH |
3362 | certain value, typically 255. For Perls 5.8.0 and later, PerlIO is |
3363 | most often the default. | |
4af147f6 | 3364 | |
df632fdf JH |
3365 | You can see whether Perl has been compiled with PerlIO or not by |
3366 | running C<perl -V> and looking for C<useperlio=> line. If C<useperlio> | |
3367 | is C<define>, you have PerlIO, otherwise you don't. | |
3368 | ||
6170680b IZ |
3369 | If you open a pipe on the command C<'-'>, i.e., either C<'|-'> or C<'-|'> |
3370 | with 2-arguments (or 1-argument) form of open(), then | |
a0d0e21e | 3371 | there is an implicit fork done, and the return value of open is the pid |
7660c0ab | 3372 | of the child within the parent process, and C<0> within the child |
184e9718 | 3373 | process. (Use C<defined($pid)> to determine whether the open was successful.) |
3b10bc60 | 3374 | The filehandle behaves normally for the parent, but I/O to that |
a0d0e21e | 3375 | filehandle is piped from/to the STDOUT/STDIN of the child process. |
3b10bc60 | 3376 | In the child process, the filehandle isn't opened--I/O happens from/to |
3377 | the new STDOUT/STDIN. Typically this is used like the normal | |
a0d0e21e | 3378 | piped open when you want to exercise more control over just how the |
3b10bc60 | 3379 | pipe command gets executed, such as when running setuid and |
3380 | you don't want to have to scan shell commands for metacharacters. | |
3381 | ||
6170680b | 3382 | The following triples are more or less equivalent: |
a0d0e21e LW |
3383 | |
3384 | open(FOO, "|tr '[a-z]' '[A-Z]'"); | |
6170680b IZ |
3385 | open(FOO, '|-', "tr '[a-z]' '[A-Z]'"); |
3386 | open(FOO, '|-') || exec 'tr', '[a-z]', '[A-Z]'; | |
b76cc8ba | 3387 | open(FOO, '|-', "tr", '[a-z]', '[A-Z]'); |
a0d0e21e LW |
3388 | |
3389 | open(FOO, "cat -n '$file'|"); | |
6170680b IZ |
3390 | open(FOO, '-|', "cat -n '$file'"); |
3391 | open(FOO, '-|') || exec 'cat', '-n', $file; | |
b76cc8ba NIS |
3392 | open(FOO, '-|', "cat", '-n', $file); |
3393 | ||
3394 | The last example in each block shows the pipe as "list form", which is | |
64da03b2 JH |
3395 | not yet supported on all platforms. A good rule of thumb is that if |
3396 | your platform has true C<fork()> (in other words, if your platform is | |
e1020413 | 3397 | Unix) you can use the list form. |
a0d0e21e | 3398 | |
4633a7c4 LW |
3399 | See L<perlipc/"Safe Pipe Opens"> for more examples of this. |
3400 | ||
0f897271 GS |
3401 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
3402 | output before any operation that may do a fork, but this may not be | |
3403 | supported on some platforms (see L<perlport>). To be safe, you may need | |
3404 | to set C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method | |
3405 | of C<IO::Handle> on any open handles. | |
3406 | ||
ed53a2bb JH |
3407 | On systems that support a close-on-exec flag on files, the flag will |
3408 | be set for the newly opened file descriptor as determined by the value | |
3409 | of $^F. See L<perlvar/$^F>. | |
a0d0e21e | 3410 | |
0dccf244 | 3411 | Closing any piped filehandle causes the parent process to wait for the |
e5218da5 GA |
3412 | child to finish, and returns the status value in C<$?> and |
3413 | C<${^CHILD_ERROR_NATIVE}>. | |
0dccf244 | 3414 | |
ed53a2bb JH |
3415 | The filename passed to 2-argument (or 1-argument) form of open() will |
3416 | have leading and trailing whitespace deleted, and the normal | |
3417 | redirection characters honored. This property, known as "magic open", | |
5a964f20 | 3418 | can often be used to good effect. A user could specify a filename of |
7660c0ab | 3419 | F<"rsh cat file |">, or you could change certain filenames as needed: |
5a964f20 TC |
3420 | |
3421 | $filename =~ s/(.*\.gz)\s*$/gzip -dc < $1|/; | |
3422 | open(FH, $filename) or die "Can't open $filename: $!"; | |
3423 | ||
6170680b IZ |
3424 | Use 3-argument form to open a file with arbitrary weird characters in it, |
3425 | ||
3426 | open(FOO, '<', $file); | |
3427 | ||
3428 | otherwise it's necessary to protect any leading and trailing whitespace: | |
5a964f20 TC |
3429 | |
3430 | $file =~ s#^(\s)#./$1#; | |
3431 | open(FOO, "< $file\0"); | |
3432 | ||
a31a806a | 3433 | (this may not work on some bizarre filesystems). One should |
106325ad | 3434 | conscientiously choose between the I<magic> and 3-arguments form |
6170680b IZ |
3435 | of open(): |
3436 | ||
3437 | open IN, $ARGV[0]; | |
3438 | ||
3439 | will allow the user to specify an argument of the form C<"rsh cat file |">, | |
80d38338 | 3440 | but will not work on a filename that happens to have a trailing space, while |
6170680b IZ |
3441 | |
3442 | open IN, '<', $ARGV[0]; | |
3443 | ||
3444 | will have exactly the opposite restrictions. | |
3445 | ||
f4084e39 | 3446 | If you want a "real" C C<open> (see C<open(2)> on your system), then you |
6170680b IZ |
3447 | should use the C<sysopen> function, which involves no such magic (but |
3448 | may use subtly different filemodes than Perl open(), which is mapped | |
3449 | to C fopen()). This is | |
5a964f20 TC |
3450 | another way to protect your filenames from interpretation. For example: |
3451 | ||
3452 | use IO::Handle; | |
3453 | sysopen(HANDLE, $path, O_RDWR|O_CREAT|O_EXCL) | |
a9a5a0dc | 3454 | or die "sysopen $path: $!"; |
5a964f20 | 3455 | $oldfh = select(HANDLE); $| = 1; select($oldfh); |
38762f02 | 3456 | print HANDLE "stuff $$\n"; |
5a964f20 TC |
3457 | seek(HANDLE, 0, 0); |
3458 | print "File contains: ", <HANDLE>; | |
3459 | ||
7660c0ab A |
3460 | Using the constructor from the C<IO::Handle> package (or one of its |
3461 | subclasses, such as C<IO::File> or C<IO::Socket>), you can generate anonymous | |
5a964f20 TC |
3462 | filehandles that have the scope of whatever variables hold references to |
3463 | them, and automatically close whenever and however you leave that scope: | |
c07a80fd | 3464 | |
5f05dabc | 3465 | use IO::File; |
5a964f20 | 3466 | #... |
c07a80fd | 3467 | sub read_myfile_munged { |
a9a5a0dc VP |
3468 | my $ALL = shift; |
3469 | my $handle = IO::File->new; | |
3470 | open($handle, "myfile") or die "myfile: $!"; | |
3471 | $first = <$handle> | |
3472 | or return (); # Automatically closed here. | |
3473 | mung $first or die "mung failed"; # Or here. | |
3474 | return $first, <$handle> if $ALL; # Or here. | |
3475 | $first; # Or here. | |
c07a80fd | 3476 | } |
3477 | ||
b687b08b | 3478 | See L</seek> for some details about mixing reading and writing. |
a0d0e21e LW |
3479 | |
3480 | =item opendir DIRHANDLE,EXPR | |
d74e8afc | 3481 | X<opendir> |
a0d0e21e | 3482 | |
19799a22 GS |
3483 | Opens a directory named EXPR for processing by C<readdir>, C<telldir>, |
3484 | C<seekdir>, C<rewinddir>, and C<closedir>. Returns true if successful. | |
a28cd5c9 NT |
3485 | DIRHANDLE may be an expression whose value can be used as an indirect |
3486 | dirhandle, usually the real dirhandle name. If DIRHANDLE is an undefined | |
3487 | scalar variable (or array or hash element), the variable is assigned a | |
3488 | reference to a new anonymous dirhandle. | |
a0d0e21e LW |
3489 | DIRHANDLEs have their own namespace separate from FILEHANDLEs. |
3490 | ||
b0169937 GS |
3491 | See example at C<readdir>. |
3492 | ||
a0d0e21e | 3493 | =item ord EXPR |
d74e8afc | 3494 | X<ord> X<encoding> |
a0d0e21e | 3495 | |
54310121 | 3496 | =item ord |
bbce6d69 | 3497 | |
121910a4 JH |
3498 | Returns the numeric (the native 8-bit encoding, like ASCII or EBCDIC, |
3499 | or Unicode) value of the first character of EXPR. If EXPR is omitted, | |
3500 | uses C<$_>. | |
3501 | ||
3502 | For the reverse, see L</chr>. | |
2575c402 | 3503 | See L<perlunicode> for more about Unicode. |
a0d0e21e | 3504 | |
77ca0c92 | 3505 | =item our EXPR |
d74e8afc | 3506 | X<our> X<global> |
77ca0c92 | 3507 | |
36fb85f3 | 3508 | =item our TYPE EXPR |
307ea6df | 3509 | |
1d2de774 | 3510 | =item our EXPR : ATTRS |
9969eac4 | 3511 | |
1d2de774 | 3512 | =item our TYPE EXPR : ATTRS |
307ea6df | 3513 | |
85d8b7d5 | 3514 | C<our> associates a simple name with a package variable in the current |
65c680eb MS |
3515 | package for use within the current scope. When C<use strict 'vars'> is in |
3516 | effect, C<our> lets you use declared global variables without qualifying | |
3517 | them with package names, within the lexical scope of the C<our> declaration. | |
3518 | In this way C<our> differs from C<use vars>, which is package scoped. | |
3519 | ||
cf264981 | 3520 | Unlike C<my>, which both allocates storage for a variable and associates |
65c680eb MS |
3521 | a simple name with that storage for use within the current scope, C<our> |
3522 | associates a simple name with a package variable in the current package, | |
3523 | for use within the current scope. In other words, C<our> has the same | |
3524 | scoping rules as C<my>, but does not necessarily create a | |
3525 | variable. | |
3526 | ||
3527 | If more than one value is listed, the list must be placed | |
3528 | in parentheses. | |
85d8b7d5 MS |
3529 | |
3530 | our $foo; | |
3531 | our($bar, $baz); | |
77ca0c92 | 3532 | |
f472eb5c GS |
3533 | An C<our> declaration declares a global variable that will be visible |
3534 | across its entire lexical scope, even across package boundaries. The | |
3535 | package in which the variable is entered is determined at the point | |
3536 | of the declaration, not at the point of use. This means the following | |
3537 | behavior holds: | |
3538 | ||
3539 | package Foo; | |
5ed4f2ec | 3540 | our $bar; # declares $Foo::bar for rest of lexical scope |
f472eb5c GS |
3541 | $bar = 20; |
3542 | ||
3543 | package Bar; | |
5ed4f2ec | 3544 | print $bar; # prints 20, as it refers to $Foo::bar |
f472eb5c | 3545 | |
65c680eb MS |
3546 | Multiple C<our> declarations with the same name in the same lexical |
3547 | scope are allowed if they are in different packages. If they happen | |
3548 | to be in the same package, Perl will emit warnings if you have asked | |
3549 | for them, just like multiple C<my> declarations. Unlike a second | |
3550 | C<my> declaration, which will bind the name to a fresh variable, a | |
3551 | second C<our> declaration in the same package, in the same scope, is | |
3552 | merely redundant. | |
f472eb5c GS |
3553 | |
3554 | use warnings; | |
3555 | package Foo; | |
5ed4f2ec | 3556 | our $bar; # declares $Foo::bar for rest of lexical scope |
f472eb5c GS |
3557 | $bar = 20; |
3558 | ||
3559 | package Bar; | |
5ed4f2ec | 3560 | our $bar = 30; # declares $Bar::bar for rest of lexical scope |
3561 | print $bar; # prints 30 | |
f472eb5c | 3562 | |
5ed4f2ec | 3563 | our $bar; # emits warning but has no other effect |
3564 | print $bar; # still prints 30 | |
f472eb5c | 3565 | |
9969eac4 | 3566 | An C<our> declaration may also have a list of attributes associated |
307ea6df JH |
3567 | with it. |
3568 | ||
1d2de774 JH |
3569 | The exact semantics and interface of TYPE and ATTRS are still |
3570 | evolving. TYPE is currently bound to the use of C<fields> pragma, | |
307ea6df JH |
3571 | and attributes are handled using the C<attributes> pragma, or starting |
3572 | from Perl 5.8.0 also via the C<Attribute::Handlers> module. See | |
3573 | L<perlsub/"Private Variables via my()"> for details, and L<fields>, | |
3574 | L<attributes>, and L<Attribute::Handlers>. | |
3575 | ||
a0d0e21e | 3576 | =item pack TEMPLATE,LIST |
d74e8afc | 3577 | X<pack> |
a0d0e21e | 3578 | |
2b6c5635 GS |
3579 | Takes a LIST of values and converts it into a string using the rules |
3580 | given by the TEMPLATE. The resulting string is the concatenation of | |
3581 | the converted values. Typically, each converted value looks | |
3582 | like its machine-level representation. For example, on 32-bit machines | |
8bdbc703 | 3583 | an integer may be represented by a sequence of 4 bytes, which will in |
3584 | Perl be presented as a string that's 4 characters long. | |
e1b711da | 3585 | |
18529408 IZ |
3586 | The TEMPLATE is a sequence of characters that give the order and type |
3587 | of values, as follows: | |
a0d0e21e | 3588 | |
5ed4f2ec | 3589 | a A string with arbitrary binary data, will be null padded. |
3590 | A A text (ASCII) string, will be space padded. | |
3b10bc60 | 3591 | Z A null-terminated (ASCIZ) string, will be null padded. |
5a929a98 | 3592 | |
5ed4f2ec | 3593 | b A bit string (ascending bit order inside each byte, like vec()). |
3594 | B A bit string (descending bit order inside each byte). | |
3595 | h A hex string (low nybble first). | |
3596 | H A hex string (high nybble first). | |
a0d0e21e | 3597 | |
5ed4f2ec | 3598 | c A signed char (8-bit) value. |
3599 | C An unsigned char (octet) value. | |
3b10bc60 | 3600 | W An unsigned char value (can be greater than 255). |
96e4d5b1 | 3601 | |
5ed4f2ec | 3602 | s A signed short (16-bit) value. |
3603 | S An unsigned short value. | |
96e4d5b1 | 3604 | |
5ed4f2ec | 3605 | l A signed long (32-bit) value. |
3606 | L An unsigned long value. | |
a0d0e21e | 3607 | |
5ed4f2ec | 3608 | q A signed quad (64-bit) value. |
3609 | Q An unsigned quad value. | |
3610 | (Quads are available only if your system supports 64-bit | |
3611 | integer values _and_ if Perl has been compiled to support those. | |
3b10bc60 | 3612 | Raises an exception otherwise.) |
dae0da7a | 3613 | |
5ed4f2ec | 3614 | i A signed integer value. |
3615 | I A unsigned integer value. | |
3616 | (This 'integer' is _at_least_ 32 bits wide. Its exact | |
1109a392 | 3617 | size depends on what a local C compiler calls 'int'.) |
2b191d53 | 3618 | |
5ed4f2ec | 3619 | n An unsigned short (16-bit) in "network" (big-endian) order. |
3620 | N An unsigned long (32-bit) in "network" (big-endian) order. | |
3621 | v An unsigned short (16-bit) in "VAX" (little-endian) order. | |
3622 | V An unsigned long (32-bit) in "VAX" (little-endian) order. | |
1109a392 MHM |
3623 | |
3624 | j A Perl internal signed integer value (IV). | |
3625 | J A Perl internal unsigned integer value (UV). | |
92d41999 | 3626 | |
3b10bc60 | 3627 | f A single-precision float in native format. |
3628 | d A double-precision float in native format. | |
a0d0e21e | 3629 | |
3b10bc60 | 3630 | F A Perl internal floating-point value (NV) in native format |
3631 | D A float of long-double precision in native format. | |
5ed4f2ec | 3632 | (Long doubles are available only if your system supports long |
3633 | double values _and_ if Perl has been compiled to support those. | |
3b10bc60 | 3634 | Raises an exception otherwise.) |
92d41999 | 3635 | |
5ed4f2ec | 3636 | p A pointer to a null-terminated string. |
3637 | P A pointer to a structure (fixed-length string). | |
a0d0e21e | 3638 | |
5ed4f2ec | 3639 | u A uuencoded string. |
3640 | U A Unicode character number. Encodes to a character in character mode | |
1651fc44 | 3641 | and UTF-8 (or UTF-EBCDIC in EBCDIC platforms) in byte mode. |
a0d0e21e | 3642 | |
5ed4f2ec | 3643 | w A BER compressed integer (not an ASN.1 BER, see perlpacktut for |
3b10bc60 | 3644 | details). Its bytes represent an unsigned integer in base 128, |
3645 | most significant digit first, with as few digits as possible. Bit | |
3646 | eight (the high bit) is set on each byte except the last. | |
def98dd4 | 3647 | |
3b10bc60 | 3648 | x A null byte (a.k.a ASCII NUL, "\000", chr(0)) |
5ed4f2ec | 3649 | X Back up a byte. |
3b10bc60 | 3650 | @ Null-fill or truncate to absolute position, counted from the |
3651 | start of the innermost ()-group. | |
3652 | . Null-fill or truncate to absolute position specified by the value. | |
5ed4f2ec | 3653 | ( Start of a ()-group. |
a0d0e21e | 3654 | |
3b10bc60 | 3655 | One or more modifiers below may optionally follow certain letters in the |
3656 | TEMPLATE (the second column lists letters for which the modifier is valid): | |
1109a392 MHM |
3657 | |
3658 | ! sSlLiI Forces native (short, long, int) sizes instead | |
3659 | of fixed (16-/32-bit) sizes. | |
3660 | ||
3661 | xX Make x and X act as alignment commands. | |
3662 | ||
3663 | nNvV Treat integers as signed instead of unsigned. | |
3664 | ||
28be1210 TH |
3665 | @. Specify position as byte offset in the internal |
3666 | representation of the packed string. Efficient but | |
3667 | dangerous. | |
3668 | ||
1109a392 MHM |
3669 | > sSiIlLqQ Force big-endian byte-order on the type. |
3670 | jJfFdDpP (The "big end" touches the construct.) | |
3671 | ||
3672 | < sSiIlLqQ Force little-endian byte-order on the type. | |
3673 | jJfFdDpP (The "little end" touches the construct.) | |
3674 | ||
3b10bc60 | 3675 | The C<< > >> and C<< < >> modifiers can also be used on C<()> groups |
3676 | to force a particular byte-order on all components in that group, | |
3677 | including all its subgroups. | |
66c611c5 | 3678 | |
5a929a98 VU |
3679 | The following rules apply: |
3680 | ||
3b10bc60 | 3681 | =over |
5a929a98 VU |
3682 | |
3683 | =item * | |
3684 | ||
3b10bc60 | 3685 | Each letter may optionally be followed by a number indicating the repeat |
3686 | count. A numeric repeat count may optionally be enclosed in brackets, as | |
3687 | in C<pack("C[80]", @arr)>. The repeat count gobbles that many values from | |
3688 | the LIST when used with all format types other than C<a>, C<A>, C<Z>, C<b>, | |
3689 | C<B>, C<h>, C<H>, C<@>, C<.>, C<x>, C<X>, and C<P>, where it means | |
3690 | something else, dscribed below. Supplying a C<*> for the repeat count | |
3691 | instead of a number means to use however many items are left, except for: | |
3692 | ||
3693 | =over | |
3694 | ||
3695 | =item * | |
3696 | ||
3697 | C<@>, C<x>, and C<X>, where it is equivalent to C<0>. | |
3698 | ||
3699 | =item * | |
3700 | ||
3701 | <.>, where it means relative to the start of the string. | |
3702 | ||
3703 | =item * | |
3704 | ||
3705 | C<u>, where it is equivalent to 1 (or 45, which here is equivalent). | |
3706 | ||
3707 | =back | |
3708 | ||
3709 | One can replace a numeric repeat count with a template letter enclosed in | |
3710 | brackets to use the packed byte length of the bracketed template for the | |
3711 | repeat count. | |
3712 | ||
3713 | For example, the template C<x[L]> skips as many bytes as in a packed long, | |
3714 | and the template C<"$t X[$t] $t"> unpacks twice whatever $t (when | |
3715 | variable-expanded) unpacks. If the template in brackets contains alignment | |
3716 | commands (such as C<x![d]>), its packed length is calculated as if the | |
3717 | start of the template had the maximal possible alignment. | |
3718 | ||
3719 | When used with C<Z>, a C<*> as the repeat count is guaranteed to add a | |
3720 | trailing null byte, so the resulting string is always one byte longer than | |
3721 | the byte length of the item itself. | |
2b6c5635 | 3722 | |
28be1210 | 3723 | When used with C<@>, the repeat count represents an offset from the start |
3b10bc60 | 3724 | of the innermost C<()> group. |
3725 | ||
3726 | When used with C<.>, the repeat count determines the starting position to | |
3727 | calculate the value offset as follows: | |
3728 | ||
3729 | =over | |
3730 | ||
3731 | =item * | |
3732 | ||
3733 | If the repeat count is C<0>, it's relative to the current position. | |
28be1210 | 3734 | |
3b10bc60 | 3735 | =item * |
3736 | ||
3737 | If the repeat count is C<*>, the offset is relative to the start of the | |
3738 | packed string. | |
3739 | ||
3740 | =item * | |
3741 | ||
3742 | And if it's an integer I<n>, the offset is relative to the start of the | |
3743 | I<n>th innermost C<()> group, or to the start of the string if I<n> is | |
3744 | bigger then the group level. | |
3745 | ||
3746 | =back | |
28be1210 | 3747 | |
951ba7fe | 3748 | The repeat count for C<u> is interpreted as the maximal number of bytes |
f337b084 TH |
3749 | to encode per line of output, with 0, 1 and 2 replaced by 45. The repeat |
3750 | count should not be more than 65. | |
5a929a98 VU |
3751 | |
3752 | =item * | |
3753 | ||
951ba7fe | 3754 | The C<a>, C<A>, and C<Z> types gobble just one value, but pack it as a |
3b10bc60 | 3755 | string of length count, padding with nulls or spaces as needed. When |
18bdf90a | 3756 | unpacking, C<A> strips trailing whitespace and nulls, C<Z> strips everything |
3b10bc60 | 3757 | after the first null, and C<a> returns data without any sort of trimming. |
2b6c5635 | 3758 | |
3b10bc60 | 3759 | If the value to pack is too long, the result is truncated. If it's too |
3760 | long and an explicit count is provided, C<Z> packs only C<$count-1> bytes, | |
3761 | followed by a null byte. Thus C<Z> always packs a trailing null, except | |
3762 | for when the count is 0. | |
5a929a98 VU |
3763 | |
3764 | =item * | |
3765 | ||
3b10bc60 | 3766 | Likewise, the C<b> and C<B> formats pack a string that's that many bits long. |
3767 | Each such format generates 1 bit of the result. | |
3768 | ||
c73032f5 | 3769 | Each result bit is based on the least-significant bit of the corresponding |
f337b084 | 3770 | input character, i.e., on C<ord($char)%2>. In particular, characters C<"0"> |
3b10bc60 | 3771 | and C<"1"> generate bits 0 and 1, as do characters C<"\000"> and C<"\001">. |
c73032f5 | 3772 | |
3b10bc60 | 3773 | Starting from the beginning of the input string, each 8-tuple |
3774 | of characters is converted to 1 character of output. With format C<b>, | |
f337b084 | 3775 | the first character of the 8-tuple determines the least-significant bit of a |
3b10bc60 | 3776 | character; with format C<B>, it determines the most-significant bit of |
f337b084 | 3777 | a character. |
c73032f5 | 3778 | |
3b10bc60 | 3779 | If the length of the input string is not evenly divisible by 8, the |
f337b084 | 3780 | remainder is packed as if the input string were padded by null characters |
3b10bc60 | 3781 | at the end. Similarly during unpacking, "extra" bits are ignored. |
c73032f5 | 3782 | |
3b10bc60 | 3783 | If the input string is longer than needed, remaining characters are ignored. |
3784 | ||
3785 | A C<*> for the repeat count uses all characters of the input field. | |
3786 | On unpacking, bits are converted to a string of C<"0">s and C<"1">s. | |
5a929a98 VU |
3787 | |
3788 | =item * | |
3789 | ||
3b10bc60 | 3790 | The C<h> and C<H> formats pack a string that many nybbles (4-bit groups, |
3791 | representable as hexadecimal digits, C<"0".."9"> C<"a".."f">) long. | |
5a929a98 | 3792 | |
3b10bc60 | 3793 | For each such format, pack() generates 4 bits of the result. |
3794 | With non-alphabetical characters, the result is based on the 4 least-significant | |
f337b084 TH |
3795 | bits of the input character, i.e., on C<ord($char)%16>. In particular, |
3796 | characters C<"0"> and C<"1"> generate nybbles 0 and 1, as do bytes | |
3b10bc60 | 3797 | C<"\0"> and C<"\1">. For characters C<"a".."f"> and C<"A".."F">, the result |
c73032f5 | 3798 | is compatible with the usual hexadecimal digits, so that C<"a"> and |
3b10bc60 | 3799 | C<"A"> both generate the nybble C<0xa==10>. Do not use any characters |
3800 | but these with this format. | |
c73032f5 | 3801 | |
3b10bc60 | 3802 | Starting from the beginning of the template to pack(), each pair |
3803 | of characters is converted to 1 character of output. With format C<h>, the | |
f337b084 | 3804 | first character of the pair determines the least-significant nybble of the |
3b10bc60 | 3805 | output character; with format C<H>, it determines the most-significant |
c73032f5 IZ |
3806 | nybble. |
3807 | ||
3b10bc60 | 3808 | If the length of the input string is not even, it behaves as if padded by |
3809 | a null character at the end. Similarly, "extra" nybbles are ignored during | |
3810 | unpacking. | |
3811 | ||
3812 | If the input string is longer than needed, extra characters are ignored. | |
c73032f5 | 3813 | |
3b10bc60 | 3814 | A C<*> for the repeat count uses all characters of the input field. For |
3815 | unpack(), nybbles are converted to a string of hexadecimal digits. | |
c73032f5 | 3816 | |
5a929a98 VU |
3817 | =item * |
3818 | ||
3b10bc60 | 3819 | The C<p> format packs a pointer to a null-terminated string. You are |
3820 | responsible for ensuring that the string is not a temporary value, as that | |
3821 | could potentially get deallocated before you got around to using the packed | |
3822 | result. The C<P> format packs a pointer to a structure of the size indicated | |
3823 | by the length. A null pointer is created if the corresponding value for | |
3824 | C<p> or C<P> is C<undef>; similarly with unpack(), where a null pointer | |
3825 | unpacks into C<undef>. | |
5a929a98 | 3826 | |
3b10bc60 | 3827 | If your system has a strange pointer size--meaning a pointer is neither as |
3828 | big as an int nor as big as a long--it may not be possible to pack or | |
1109a392 | 3829 | unpack pointers in big- or little-endian byte order. Attempting to do |
3b10bc60 | 3830 | so raises an exception. |
1109a392 | 3831 | |
5a929a98 VU |
3832 | =item * |
3833 | ||
246f24af | 3834 | The C</> template character allows packing and unpacking of a sequence of |
3b10bc60 | 3835 | items where the packed structure contains a packed item count followed by |
3836 | the packed items themselves. This is useful when the structure you're | |
3837 | unpacking has encoded the sizes or repeat counts for some of its fields | |
3838 | within the structure itself as separate fields. | |
3839 | ||
3840 | For C<pack>, you write I<length-item>C</>I<sequence-item>, and the | |
3841 | I<length-item> describes how the length value is packed. Formats likely | |
3842 | to be of most use are integer-packing ones like C<n> for Java strings, | |
3843 | C<w> for ASN.1 or SNMP, and C<N> for Sun XDR. | |
3844 | ||
3845 | For C<pack>, I<sequence-item> may have a repeat count, in which case | |
3846 | the minimum of that and the number of available items is used as the argument | |
3847 | for I<length-item>. If it has no repeat count or uses a '*', the number | |
54f961c9 PD |
3848 | of available items is used. |
3849 | ||
3b10bc60 | 3850 | For C<unpack>, an internal stack of integer arguments unpacked so far is |
54f961c9 PD |
3851 | used. You write C</>I<sequence-item> and the repeat count is obtained by |
3852 | popping off the last element from the stack. The I<sequence-item> must not | |
3853 | have a repeat count. | |
246f24af | 3854 | |
3b10bc60 | 3855 | If I<sequence-item> refers to a string type (C<"A">, C<"a">, or C<"Z">), |
3856 | the I<length-item> is the string length, not the number of strings. With | |
3857 | an explicit repeat count for pack, the packed string is adjusted to that | |
3858 | length. For example: | |
246f24af | 3859 | |
3b10bc60 | 3860 | unpack("W/a", "\04Gurusamy") gives ("Guru") |
3861 | unpack("a3/A A*", "007 Bond J ") gives (" Bond", "J") | |
3862 | unpack("a3 x2 /A A*", "007: Bond, J.") gives ("Bond, J", ".") | |
3863 | ||
3864 | pack("n/a* w/a","hello,","world") gives "\000\006hello,\005world" | |
3865 | pack("a/W2", ord("a") .. ord("z")) gives "2ab" | |
43192e07 IP |
3866 | |
3867 | The I<length-item> is not returned explicitly from C<unpack>. | |
3868 | ||
3b10bc60 | 3869 | Supplying a count to the I<length-item> format letter is only useful with |
3870 | C<A>, C<a>, or C<Z>. Packing with a I<length-item> of C<a> or C<Z> may | |
3871 | introduce C<"\000"> characters, which Perl does not regard as legal in | |
3872 | numeric strings. | |
43192e07 IP |
3873 | |
3874 | =item * | |
3875 | ||
951ba7fe | 3876 | The integer types C<s>, C<S>, C<l>, and C<L> may be |
3b10bc60 | 3877 | followed by a C<!> modifier to specify native shorts or |
3878 | longs. As shown in the example above, a bare C<l> means | |
3879 | exactly 32 bits, although the native C<long> as seen by the local C compiler | |
3880 | may be larger. This is mainly an issue on 64-bit platforms. You can | |
3881 | see whether using C<!> makes any difference this way: | |
3882 | ||
3883 | printf "format s is %d, s! is %d\n", | |
3884 | length pack("s"), length pack("s!"); | |
726ea183 | 3885 | |
3b10bc60 | 3886 | printf "format l is %d, l! is %d\n", |
3887 | length pack("l"), length pack("l!"); | |
ef54e1a4 | 3888 | |
3b10bc60 | 3889 | |
3890 | C<i!> and C<I!> are also allowed, but only for completeness' sake: | |
951ba7fe | 3891 | they are identical to C<i> and C<I>. |
ef54e1a4 | 3892 | |
19799a22 | 3893 | The actual sizes (in bytes) of native shorts, ints, longs, and long |
3b10bc60 | 3894 | longs on the platform where Perl was built are also available from |
3895 | the command line: | |
3896 | ||
3897 | $ perl -V:{short,int,long{,long}}size | |
3898 | shortsize='2'; | |
3899 | intsize='4'; | |
3900 | longsize='4'; | |
3901 | longlongsize='8'; | |
3902 | ||
3903 | or programmatically via the C<Config> module: | |
19799a22 GS |
3904 | |
3905 | use Config; | |
3906 | print $Config{shortsize}, "\n"; | |
3907 | print $Config{intsize}, "\n"; | |
3908 | print $Config{longsize}, "\n"; | |
3909 | print $Config{longlongsize}, "\n"; | |
ef54e1a4 | 3910 | |
3b10bc60 | 3911 | C<$Config{longlongsize}> is undefined on systems without |
3912 | long long support. | |
851646ae | 3913 | |
ef54e1a4 JH |
3914 | =item * |
3915 | ||
3b10bc60 | 3916 | The integer formats C<s>, C<S>, C<i>, C<I>, C<l>, C<L>, C<j>, and C<J> are |
3917 | inherently non-portable between processors and operating systems because | |
3918 | they obey native byteorder and endianness. For example, a 4-byte integer | |
3919 | 0x12345678 (305419896 decimal) would be ordered natively (arranged in and | |
3920 | handled by the CPU registers) into bytes as | |
61eff3bc | 3921 | |
5ed4f2ec | 3922 | 0x12 0x34 0x56 0x78 # big-endian |
3923 | 0x78 0x56 0x34 0x12 # little-endian | |
61eff3bc | 3924 | |
3b10bc60 | 3925 | Basically, Intel and VAX CPUs are little-endian, while everybody else, |
3926 | including Motorola m68k/88k, PPC, Sparc, HP PA, Power, and Cray, are | |
3927 | big-endian. Alpha and MIPS can be either: Digital/Compaq used/uses them in | |
3928 | little-endian mode, but SGI/Cray uses them in big-endian mode. | |
719a3cf5 | 3929 | |
3b10bc60 | 3930 | The names I<big-endian> and I<little-endian> are comic references to the |
3931 | egg-eating habits of the little-endian Lilliputians and the big-endian | |
3932 | Blefuscudians from the classic Jonathan Swift satire, I<Gulliver's Travels>. | |
3933 | This entered computer lingo via the paper "On Holy Wars and a Plea for | |
3934 | Peace" by Danny Cohen, USC/ISI IEN 137, April 1, 1980. | |
61eff3bc | 3935 | |
140cb37e | 3936 | Some systems may have even weirder byte orders such as |
61eff3bc | 3937 | |
5ed4f2ec | 3938 | 0x56 0x78 0x12 0x34 |
3939 | 0x34 0x12 0x78 0x56 | |
61eff3bc | 3940 | |
3b10bc60 | 3941 | You can determine your system endianness with this incantation: |
ef54e1a4 | 3942 | |
3b10bc60 | 3943 | printf("%#02x ", $_) for unpack("W*", pack L=>0x12345678); |
ef54e1a4 | 3944 | |
d99ad34e | 3945 | The byteorder on the platform where Perl was built is also available |
726ea183 | 3946 | via L<Config>: |
ef54e1a4 | 3947 | |
5ed4f2ec | 3948 | use Config; |
3b10bc60 | 3949 | print "$Config{byteorder}\n"; |
3950 | ||
3951 | or from the command line: | |
ef54e1a4 | 3952 | |
3b10bc60 | 3953 | $ perl -V:byteorder |
719a3cf5 | 3954 | |
3b10bc60 | 3955 | Byteorders C<"1234"> and C<"12345678"> are little-endian; C<"4321"> |
3956 | and C<"87654321"> are big-endian. | |
3957 | ||
3958 | For portably packed integers, either use the formats C<n>, C<N>, C<v>, | |
3959 | and C<V> or else use the C<< > >> and C<< < >> modifiers described | |
3960 | immediately below. See also L<perlport>. | |
ef54e1a4 JH |
3961 | |
3962 | =item * | |
3963 | ||
3b10bc60 | 3964 | Starting with Perl 5.9.2, integer and floating-point formats, along with |
3965 | the C<p> and C<P> formats and C<()> groups, may all be followed by the | |
3966 | C<< > >> or C<< < >> endianness modifiers to respectively enforce big- | |
3967 | or little-endian byte-order. These modifiers are especially useful | |
3968 | given how C<n>, C<N>, C<v> and C<V> don't cover signed integers, | |
3969 | 64-bit integers, or floating-point values. | |
3970 | ||
3971 | Here are some concerns to keep in mind when using endianness modifier: | |
3972 | ||
3973 | =over | |
3974 | ||
3975 | =item * | |
3976 | ||
3977 | Exchanging signed integers between different platforms works only | |
3978 | when all platforms store them in the same format. Most platforms store | |
3979 | signed integers in two's-complement notation, so usually this is not an issue. | |
1109a392 | 3980 | |
3b10bc60 | 3981 | =item * |
1109a392 | 3982 | |
3b10bc60 | 3983 | The C<< > >> or C<< < >> modifiers can only be used on floating-point |
1109a392 | 3984 | formats on big- or little-endian machines. Otherwise, attempting to |
3b10bc60 | 3985 | use them raises an exception. |
1109a392 | 3986 | |
3b10bc60 | 3987 | =item * |
3988 | ||
3989 | Forcing big- or little-endian byte-order on floating-point values for | |
3990 | data exchange can work only if all platforms use the same | |
3991 | binary representation such as IEEE floating-point. Even if all | |
3992 | platforms are using IEEE, there may still be subtle differences. Being able | |
3993 | to use C<< > >> or C<< < >> on floating-point values can be useful, | |
80d38338 | 3994 | but also dangerous if you don't know exactly what you're doing. |
3b10bc60 | 3995 | It is not a general way to portably store floating-point values. |
3996 | ||
3997 | =item * | |
1109a392 | 3998 | |
3b10bc60 | 3999 | When using C<< > >> or C<< < >> on a C<()> group, this affects |
4000 | all types inside the group that accept byte-order modifiers, | |
4001 | including all subgroups. It is silently ignored for all other | |
66c611c5 MHM |
4002 | types. You are not allowed to override the byte-order within a group |
4003 | that already has a byte-order modifier suffix. | |
4004 | ||
3b10bc60 | 4005 | =back |
4006 | ||
1109a392 MHM |
4007 | =item * |
4008 | ||
3b10bc60 | 4009 | Real numbers (floats and doubles) are in native machine format only. |
4010 | Due to the multiplicity of floating-point formats and the lack of a | |
4011 | standard "network" representation for them, no facility for interchange has been | |
4012 | made. This means that packed floating-point data written on one machine | |
4013 | may not be readable on another, even if both use IEEE floating-point | |
4014 | arithmetic (because the endianness of the memory representation is not part | |
851646ae | 4015 | of the IEEE spec). See also L<perlport>. |
5a929a98 | 4016 | |
3b10bc60 | 4017 | If you know I<exactly> what you're doing, you can use the C<< > >> or C<< < >> |
4018 | modifiers to force big- or little-endian byte-order on floating-point values. | |
1109a392 | 4019 | |
3b10bc60 | 4020 | Because Perl uses doubles (or long doubles, if configured) internally for |
4021 | all numeric calculation, converting from double into float and thence | |
4022 | to double again loses precision, so C<unpack("f", pack("f", $foo)>) | |
4023 | will not in general equal $foo. | |
5a929a98 | 4024 | |
851646ae JH |
4025 | =item * |
4026 | ||
3b10bc60 | 4027 | Pack and unpack can operate in two modes: character mode (C<C0> mode) where |
4028 | the packed string is processed per character, and UTF-8 mode (C<U0> mode) | |
f337b084 | 4029 | where the packed string is processed in its UTF-8-encoded Unicode form on |
3b10bc60 | 4030 | a byte-by-byte basis. Character mode is the default unless the format string |
4031 | starts with C<U>. You can always switch mode mid-format with an explicit | |
4032 | C<C0> or C<U0> in the format. This mode remains in effect until the next | |
4033 | mode change, or until the end of the C<()> group it (directly) applies to. | |
036b4402 GS |
4034 | |
4035 | =item * | |
4036 | ||
3b10bc60 | 4037 | You must yourself do any alignment or padding by inserting, for example, |
4038 | enough C<"x">es while packing. There is no way for pack() and unpack() | |
4039 | to know where characters are going to or coming from, so they | |
4040 | handle their output and input as flat sequences of characters. | |
851646ae | 4041 | |
17f4a12d IZ |
4042 | =item * |
4043 | ||
3b10bc60 | 4044 | A C<()> group is a sub-TEMPLATE enclosed in parentheses. A group may |
4045 | take a repeat count either as postfix, or for unpack(), also via the C</> | |
4046 | template character. Within each repetition of a group, positioning with | |
4047 | C<@> starts over at 0. Therefore, the result of | |
49704364 | 4048 | |
3b10bc60 | 4049 | pack("@1A((@2A)@3A)", qw[X Y Z]) |
49704364 | 4050 | |
3b10bc60 | 4051 | is the string C<"\0X\0\0YZ">. |
49704364 | 4052 | |
18529408 IZ |
4053 | =item * |
4054 | ||
3b10bc60 | 4055 | C<x> and C<X> accept the C<!> modifier to act as alignment commands: they |
4056 | jump forward or back to the closest position aligned at a multiple of C<count> | |
4057 | characters. For example, to pack() or unpack() a C structure like | |
666f95b9 | 4058 | |
3b10bc60 | 4059 | struct { |
4060 | char c; /* one signed, 8-bit character */ | |
4061 | double d; | |
4062 | char cc[2]; | |
4063 | } | |
4064 | ||
4065 | one may need to use the template C<c x![d] d c[2]>. This assumes that | |
4066 | doubles must be aligned to the size of double. | |
4067 | ||
4068 | For alignment commands, a C<count> of 0 is equivalent to a C<count> of 1; | |
4069 | both are no-ops. | |
666f95b9 | 4070 | |
62f95557 IZ |
4071 | =item * |
4072 | ||
3b10bc60 | 4073 | C<n>, C<N>, C<v> and C<V> accept the C<!> modifier to |
4074 | represent signed 16-/32-bit integers in big-/little-endian order. | |
4075 | This is portable only when all platforms sharing packed data use the | |
4076 | same binary representation for signed integers; for example, when all | |
4077 | platforms use two's-complement representation. | |
068bd2e7 MHM |
4078 | |
4079 | =item * | |
4080 | ||
3b10bc60 | 4081 | Comments can be embedded in a TEMPLATE using C<#> through the end of line. |
4082 | White space can separate pack codes from each other, but modifiers and | |
4083 | repeat counts must follow immediately. Breaking complex templates into | |
4084 | individual line-by-line components, suitably annotated, can do as much to | |
4085 | improve legibility and maintainability of pack/unpack formats as C</x> can | |
4086 | for complicated pattern matches. | |
17f4a12d | 4087 | |
2b6c5635 GS |
4088 | =item * |
4089 | ||
3b10bc60 | 4090 | If TEMPLATE requires more arguments that pack() is given, pack() |
cf264981 | 4091 | assumes additional C<""> arguments. If TEMPLATE requires fewer arguments |
3b10bc60 | 4092 | than given, extra arguments are ignored. |
2b6c5635 | 4093 | |
5a929a98 | 4094 | =back |
a0d0e21e LW |
4095 | |
4096 | Examples: | |
4097 | ||
f337b084 | 4098 | $foo = pack("WWWW",65,66,67,68); |
a0d0e21e | 4099 | # foo eq "ABCD" |
f337b084 | 4100 | $foo = pack("W4",65,66,67,68); |
a0d0e21e | 4101 | # same thing |
f337b084 TH |
4102 | $foo = pack("W4",0x24b6,0x24b7,0x24b8,0x24b9); |
4103 | # same thing with Unicode circled letters. | |
a0ed51b3 | 4104 | $foo = pack("U4",0x24b6,0x24b7,0x24b8,0x24b9); |
f337b084 TH |
4105 | # same thing with Unicode circled letters. You don't get the UTF-8 |
4106 | # bytes because the U at the start of the format caused a switch to | |
4107 | # U0-mode, so the UTF-8 bytes get joined into characters | |
4108 | $foo = pack("C0U4",0x24b6,0x24b7,0x24b8,0x24b9); | |
4109 | # foo eq "\xe2\x92\xb6\xe2\x92\xb7\xe2\x92\xb8\xe2\x92\xb9" | |
4110 | # This is the UTF-8 encoding of the string in the previous example | |
a0d0e21e LW |
4111 | |
4112 | $foo = pack("ccxxcc",65,66,67,68); | |
4113 | # foo eq "AB\0\0CD" | |
4114 | ||
3b10bc60 | 4115 | # NOTE: The examples above featuring "W" and "c" are true |
9ccd05c0 | 4116 | # only on ASCII and ASCII-derived systems such as ISO Latin 1 |
3b10bc60 | 4117 | # and UTF-8. On EBCDIC systems, the first example would be |
4118 | # $foo = pack("WWWW",193,194,195,196); | |
9ccd05c0 | 4119 | |
a0d0e21e LW |
4120 | $foo = pack("s2",1,2); |
4121 | # "\1\0\2\0" on little-endian | |
4122 | # "\0\1\0\2" on big-endian | |
4123 | ||
4124 | $foo = pack("a4","abcd","x","y","z"); | |
4125 | # "abcd" | |
4126 | ||
4127 | $foo = pack("aaaa","abcd","x","y","z"); | |
4128 | # "axyz" | |
4129 | ||
4130 | $foo = pack("a14","abcdefg"); | |
4131 | # "abcdefg\0\0\0\0\0\0\0" | |
4132 | ||
4133 | $foo = pack("i9pl", gmtime); | |
4134 | # a real struct tm (on my system anyway) | |
4135 | ||
5a929a98 VU |
4136 | $utmp_template = "Z8 Z8 Z16 L"; |
4137 | $utmp = pack($utmp_template, @utmp1); | |
4138 | # a struct utmp (BSDish) | |
4139 | ||
4140 | @utmp2 = unpack($utmp_template, $utmp); | |
4141 | # "@utmp1" eq "@utmp2" | |
4142 | ||
a0d0e21e | 4143 | sub bintodec { |
a9a5a0dc | 4144 | unpack("N", pack("B32", substr("0" x 32 . shift, -32))); |
a0d0e21e LW |
4145 | } |
4146 | ||
851646ae JH |
4147 | $foo = pack('sx2l', 12, 34); |
4148 | # short 12, two zero bytes padding, long 34 | |
4149 | $bar = pack('s@4l', 12, 34); | |
4150 | # short 12, zero fill to position 4, long 34 | |
4151 | # $foo eq $bar | |
28be1210 TH |
4152 | $baz = pack('s.l', 12, 4, 34); |
4153 | # short 12, zero fill to position 4, long 34 | |
851646ae | 4154 | |
1109a392 MHM |
4155 | $foo = pack('nN', 42, 4711); |
4156 | # pack big-endian 16- and 32-bit unsigned integers | |
4157 | $foo = pack('S>L>', 42, 4711); | |
4158 | # exactly the same | |
4159 | $foo = pack('s<l<', -42, 4711); | |
4160 | # pack little-endian 16- and 32-bit signed integers | |
66c611c5 MHM |
4161 | $foo = pack('(sl)<', -42, 4711); |
4162 | # exactly the same | |
1109a392 | 4163 | |
5a929a98 | 4164 | The same template may generally also be used in unpack(). |
a0d0e21e | 4165 | |
6fa4d285 DG |
4166 | =item package NAMESPACE VERSION |
4167 | X<package> X<module> X<namespace> X<version> | |
4168 | ||
cb1a09d0 AD |
4169 | =item package NAMESPACE |
4170 | ||
4171 | Declares the compilation unit as being in the given namespace. The scope | |
2b5ab1e7 | 4172 | of the package declaration is from the declaration itself through the end |
19799a22 | 4173 | of the enclosing block, file, or eval (the same as the C<my> operator). |
2b5ab1e7 | 4174 | All further unqualified dynamic identifiers will be in this namespace. |
3b10bc60 | 4175 | A package statement affects dynamic variables only, including those |
4176 | you've used C<local> on, but I<not> lexical variables, which are created | |
4177 | with C<my> (or C<our> (or C<state>)). Typically it would be the first | |
4178 | declaration in a file included by C<require> or C<use>. You can switch into a | |
4179 | package in more than one place, since this only determines which default | |
4180 | symbol table the compiler uses for the rest of that block. You can refer to | |
4181 | identifiers in other packages than the current one by prefixing the identifier | |
4182 | with the package name and a double colon, as in C<$SomePack::var> | |
4183 | or C<ThatPack::INPUT_HANDLE>. If package name is omitted, the C<main> | |
4184 | package as assumed. That is, C<$::sail> is equivalent to | |
4185 | C<$main::sail> (as well as to C<$main'sail>, still seen in ancient | |
4186 | code, mostly from Perl 4). | |
4187 | ||
bd12309b DG |
4188 | If VERSION is provided, C<package> sets the C<$VERSION> variable in the given |
4189 | namespace. VERSION must be a "strict" style version number as defined by the | |
4190 | L<version> module: a positive decimal number (integer or decimal-fraction) | |
4191 | without exponentiation or else a dotted-decimal v-string with a leading 'v' | |
4192 | character and at least three components. You should set C<$VERSION> only once | |
4193 | per package. | |
6fa4d285 | 4194 | |
cb1a09d0 AD |
4195 | See L<perlmod/"Packages"> for more information about packages, modules, |
4196 | and classes. See L<perlsub> for other scoping issues. | |
4197 | ||
a0d0e21e | 4198 | =item pipe READHANDLE,WRITEHANDLE |
d74e8afc | 4199 | X<pipe> |
a0d0e21e LW |
4200 | |
4201 | Opens a pair of connected pipes like the corresponding system call. | |
4202 | Note that if you set up a loop of piped processes, deadlock can occur | |
4203 | unless you are very careful. In addition, note that Perl's pipes use | |
9124316e | 4204 | IO buffering, so you may need to set C<$|> to flush your WRITEHANDLE |
a0d0e21e LW |
4205 | after each command, depending on the application. |
4206 | ||
7e1af8bc | 4207 | See L<IPC::Open2>, L<IPC::Open3>, and L<perlipc/"Bidirectional Communication"> |
4633a7c4 LW |
4208 | for examples of such things. |
4209 | ||
3b10bc60 | 4210 | On systems that support a close-on-exec flag on files, that flag is set |
4211 | on all newly opened file descriptors whose C<fileno>s are I<higher> than | |
4212 | the current value of $^F (by default 2 for C<STDERR>). See L<perlvar/$^F>. | |
4771b018 | 4213 | |
a0d0e21e | 4214 | =item pop ARRAY |
d74e8afc | 4215 | X<pop> X<stack> |
a0d0e21e | 4216 | |
54310121 | 4217 | =item pop |
28757baa | 4218 | |
a0d0e21e | 4219 | Pops and returns the last value of the array, shortening the array by |
cd7f9af7 | 4220 | one element. |
a0d0e21e | 4221 | |
3b10bc60 | 4222 | Returns the undefined value if the array is empty, although this may also |
4223 | happen at other times. If ARRAY is omitted, pops the C<@ARGV> array in the | |
4224 | main program, but the C<@_> array in subroutines, just like C<shift>. | |
a0d0e21e LW |
4225 | |
4226 | =item pos SCALAR | |
d74e8afc | 4227 | X<pos> X<match, position> |
a0d0e21e | 4228 | |
54310121 | 4229 | =item pos |
bbce6d69 | 4230 | |
4633a7c4 | 4231 | Returns the offset of where the last C<m//g> search left off for the variable |
b17c04f3 | 4232 | in question (C<$_> is used when the variable is not specified). Note that |
cf264981 | 4233 | 0 is a valid match offset. C<undef> indicates that the search position |
b17c04f3 | 4234 | is reset (usually due to match failure, but can also be because no match has |
80d38338 | 4235 | yet been run on the scalar). C<pos> directly accesses the location used |
b17c04f3 NC |
4236 | by the regexp engine to store the offset, so assigning to C<pos> will change |
4237 | that offset, and so will also influence the C<\G> zero-width assertion in | |
4238 | regular expressions. Because a failed C<m//gc> match doesn't reset the offset, | |
4239 | the return from C<pos> won't change either in this case. See L<perlre> and | |
44a8e56a | 4240 | L<perlop>. |
a0d0e21e LW |
4241 | |
4242 | =item print FILEHANDLE LIST | |
d74e8afc | 4243 | X<print> |
a0d0e21e LW |
4244 | |
4245 | =item print LIST | |
4246 | ||
4247 | =item print | |
4248 | ||
19799a22 | 4249 | Prints a string or a list of strings. Returns true if successful. |
3b10bc60 | 4250 | FILEHANDLE may be a scalar variable containing |
4251 | the name of or a reference to the filehandle, thus introducing | |
19799a22 GS |
4252 | one level of indirection. (NOTE: If FILEHANDLE is a variable and |
4253 | the next token is a term, it may be misinterpreted as an operator | |
2b5ab1e7 | 4254 | unless you interpose a C<+> or put parentheses around the arguments.) |
3b10bc60 | 4255 | If FILEHANDLE is omitted, prints to standard output by default, or |
4256 | to the last selected output channel; see L</select>. If LIST is | |
4257 | also omitted, prints C<$_> to the currently selected output handle. | |
4258 | To set the default output handle to something other than STDOUT | |
19799a22 GS |
4259 | use the select operation. The current value of C<$,> (if any) is |
4260 | printed between each LIST item. The current value of C<$\> (if | |
4261 | any) is printed after the entire LIST has been printed. Because | |
4262 | print takes a LIST, anything in the LIST is evaluated in list | |
4263 | context, and any subroutine that you call will have one or more of | |
4264 | its expressions evaluated in list context. Also be careful not to | |
4265 | follow the print keyword with a left parenthesis unless you want | |
4266 | the corresponding right parenthesis to terminate the arguments to | |
3b10bc60 | 4267 | the print; put parentheses around all the arguments |
4268 | (or interpose a C<+>, but that doesn't look as good). | |
a0d0e21e | 4269 | |
39c9c9cd RGS |
4270 | Note that if you're storing FILEHANDLEs in an array, or if you're using |
4271 | any other expression more complex than a scalar variable to retrieve it, | |
4272 | you will have to use a block returning the filehandle value instead: | |
4633a7c4 LW |
4273 | |
4274 | print { $files[$i] } "stuff\n"; | |
4275 | print { $OK ? STDOUT : STDERR } "stuff\n"; | |
4276 | ||
785fd561 DG |
4277 | Printing to a closed pipe or socket will generate a SIGPIPE signal. See |
4278 | L<perlipc> for more on signal handling. | |
4279 | ||
5f05dabc | 4280 | =item printf FILEHANDLE FORMAT, LIST |
d74e8afc | 4281 | X<printf> |
a0d0e21e | 4282 | |
5f05dabc | 4283 | =item printf FORMAT, LIST |
a0d0e21e | 4284 | |
7660c0ab | 4285 | Equivalent to C<print FILEHANDLE sprintf(FORMAT, LIST)>, except that C<$\> |
a3cb178b | 4286 | (the output record separator) is not appended. The first argument |
f39758bf | 4287 | of the list will be interpreted as the C<printf> format. See C<sprintf> |
7e4353e9 RGS |
4288 | for an explanation of the format argument. If C<use locale> is in effect, |
4289 | and POSIX::setlocale() has been called, the character used for the decimal | |
3b10bc60 | 4290 | separator in formatted floating-point numbers is affected by the LC_NUMERIC |
7e4353e9 | 4291 | locale. See L<perllocale> and L<POSIX>. |
a0d0e21e | 4292 | |
19799a22 GS |
4293 | Don't fall into the trap of using a C<printf> when a simple |
4294 | C<print> would do. The C<print> is more efficient and less | |
28757baa | 4295 | error prone. |
4296 | ||
da0045b7 | 4297 | =item prototype FUNCTION |
d74e8afc | 4298 | X<prototype> |
da0045b7 | 4299 | |
4300 | Returns the prototype of a function as a string (or C<undef> if the | |
5f05dabc | 4301 | function has no prototype). FUNCTION is a reference to, or the name of, |
4302 | the function whose prototype you want to retrieve. | |
da0045b7 | 4303 | |
2b5ab1e7 | 4304 | If FUNCTION is a string starting with C<CORE::>, the rest is taken as a |
e1020413 | 4305 | name for a Perl builtin. If the builtin is not I<overridable> (such as |
0a2ca743 RGS |
4306 | C<qw//>) or if its arguments cannot be adequately expressed by a prototype |
4307 | (such as C<system>), prototype() returns C<undef>, because the builtin | |
4308 | does not really behave like a Perl function. Otherwise, the string | |
4309 | describing the equivalent prototype is returned. | |
b6c543e3 | 4310 | |
a0d0e21e | 4311 | =item push ARRAY,LIST |
1dc8ecb8 | 4312 | X<push> X<stack> |
a0d0e21e LW |
4313 | |
4314 | Treats ARRAY as a stack, and pushes the values of LIST | |
4315 | onto the end of ARRAY. The length of ARRAY increases by the length of | |
4316 | LIST. Has the same effect as | |
4317 | ||
4318 | for $value (LIST) { | |
a9a5a0dc | 4319 | $ARRAY[++$#ARRAY] = $value; |
a0d0e21e LW |
4320 | } |
4321 | ||
cde9c211 SP |
4322 | but is more efficient. Returns the number of elements in the array following |
4323 | the completed C<push>. | |
a0d0e21e LW |
4324 | |
4325 | =item q/STRING/ | |
4326 | ||
4327 | =item qq/STRING/ | |
4328 | ||
945c54fd | 4329 | =item qx/STRING/ |
a0d0e21e LW |
4330 | |
4331 | =item qw/STRING/ | |
4332 | ||
1d888ee3 MK |
4333 | Generalized quotes. See L<perlop/"Quote-Like Operators">. |
4334 | ||
4335 | =item qr/STRING/ | |
4336 | ||
4337 | Regexp-like quote. See L<perlop/"Regexp Quote-Like Operators">. | |
a0d0e21e LW |
4338 | |
4339 | =item quotemeta EXPR | |
d74e8afc | 4340 | X<quotemeta> X<metacharacter> |
a0d0e21e | 4341 | |
54310121 | 4342 | =item quotemeta |
bbce6d69 | 4343 | |
36bbe248 | 4344 | Returns the value of EXPR with all non-"word" |
a034a98d DD |
4345 | characters backslashed. (That is, all characters not matching |
4346 | C</[A-Za-z_0-9]/> will be preceded by a backslash in the | |
4347 | returned string, regardless of any locale settings.) | |
4348 | This is the internal function implementing | |
7660c0ab | 4349 | the C<\Q> escape in double-quoted strings. |
a0d0e21e | 4350 | |
7660c0ab | 4351 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 4352 | |
a0d0e21e | 4353 | =item rand EXPR |
d74e8afc | 4354 | X<rand> X<random> |
a0d0e21e LW |
4355 | |
4356 | =item rand | |
4357 | ||
7660c0ab | 4358 | Returns a random fractional number greater than or equal to C<0> and less |
3e3baf6d | 4359 | than the value of EXPR. (EXPR should be positive.) If EXPR is |
351f3254 | 4360 | omitted, the value C<1> is used. Currently EXPR with the value C<0> is |
3b10bc60 | 4361 | also special-cased as C<1> (this was undocumented before Perl 5.8.0 |
4362 | and is subject to change in future versions of Perl). Automatically calls | |
351f3254 | 4363 | C<srand> unless C<srand> has already been called. See also C<srand>. |
a0d0e21e | 4364 | |
6063ba18 WM |
4365 | Apply C<int()> to the value returned by C<rand()> if you want random |
4366 | integers instead of random fractional numbers. For example, | |
4367 | ||
4368 | int(rand(10)) | |
4369 | ||
4370 | returns a random integer between C<0> and C<9>, inclusive. | |
4371 | ||
2f9daede | 4372 | (Note: If your rand function consistently returns numbers that are too |
a0d0e21e | 4373 | large or too small, then your version of Perl was probably compiled |
2f9daede | 4374 | with the wrong number of RANDBITS.) |
a0d0e21e LW |
4375 | |
4376 | =item read FILEHANDLE,SCALAR,LENGTH,OFFSET | |
f723aae1 | 4377 | X<read> X<file, read> |
a0d0e21e LW |
4378 | |
4379 | =item read FILEHANDLE,SCALAR,LENGTH | |
4380 | ||
9124316e JH |
4381 | Attempts to read LENGTH I<characters> of data into variable SCALAR |
4382 | from the specified FILEHANDLE. Returns the number of characters | |
b5fe5ca2 | 4383 | actually read, C<0> at end of file, or undef if there was an error (in |
b49f3be6 SG |
4384 | the latter case C<$!> is also set). SCALAR will be grown or shrunk |
4385 | so that the last character actually read is the last character of the | |
4386 | scalar after the read. | |
4387 | ||
4388 | An OFFSET may be specified to place the read data at some place in the | |
4389 | string other than the beginning. A negative OFFSET specifies | |
4390 | placement at that many characters counting backwards from the end of | |
4391 | the string. A positive OFFSET greater than the length of SCALAR | |
4392 | results in the string being padded to the required size with C<"\0"> | |
4393 | bytes before the result of the read is appended. | |
4394 | ||
80d38338 TC |
4395 | The call is implemented in terms of either Perl's or your system's native |
4396 | fread(3) library function. To get a true read(2) system call, see C<sysread>. | |
9124316e JH |
4397 | |
4398 | Note the I<characters>: depending on the status of the filehandle, | |
4399 | either (8-bit) bytes or characters are read. By default all | |
4400 | filehandles operate on bytes, but for example if the filehandle has | |
fae2c0fb | 4401 | been opened with the C<:utf8> I/O layer (see L</open>, and the C<open> |
1d714267 JH |
4402 | pragma, L<open>), the I/O will operate on UTF-8 encoded Unicode |
4403 | characters, not bytes. Similarly for the C<:encoding> pragma: | |
4404 | in that case pretty much any characters can be read. | |
a0d0e21e LW |
4405 | |
4406 | =item readdir DIRHANDLE | |
d74e8afc | 4407 | X<readdir> |
a0d0e21e | 4408 | |
19799a22 | 4409 | Returns the next directory entry for a directory opened by C<opendir>. |
5a964f20 | 4410 | If used in list context, returns all the rest of the entries in the |
3b10bc60 | 4411 | directory. If there are no more entries, returns the undefined value in |
4412 | scalar context and the empty list in list context. | |
a0d0e21e | 4413 | |
19799a22 | 4414 | If you're planning to filetest the return values out of a C<readdir>, you'd |
5f05dabc | 4415 | better prepend the directory in question. Otherwise, because we didn't |
19799a22 | 4416 | C<chdir> there, it would have been testing the wrong file. |
cb1a09d0 | 4417 | |
b0169937 GS |
4418 | opendir(my $dh, $some_dir) || die "can't opendir $some_dir: $!"; |
4419 | @dots = grep { /^\./ && -f "$some_dir/$_" } readdir($dh); | |
4420 | closedir $dh; | |
cb1a09d0 | 4421 | |
114c60ec BG |
4422 | As of Perl 5.11.2 you can use a bare C<readdir> in a C<while> loop, |
4423 | which will set C<$_> on every iteration. | |
4424 | ||
4425 | opendir(my $dh, $some_dir) || die; | |
4426 | while(readdir $dh) { | |
4427 | print "$some_dir/$_\n"; | |
4428 | } | |
4429 | closedir $dh; | |
4430 | ||
84902520 | 4431 | =item readline EXPR |
e4b7ebf3 RGS |
4432 | |
4433 | =item readline | |
d74e8afc | 4434 | X<readline> X<gets> X<fgets> |
84902520 | 4435 | |
e4b7ebf3 RGS |
4436 | Reads from the filehandle whose typeglob is contained in EXPR (or from |
4437 | *ARGV if EXPR is not provided). In scalar context, each call reads and | |
80d38338 | 4438 | returns the next line until end-of-file is reached, whereupon the |
0f03d336 | 4439 | subsequent call returns C<undef>. In list context, reads until end-of-file |
e4b7ebf3 | 4440 | is reached and returns a list of lines. Note that the notion of "line" |
80d38338 | 4441 | used here is whatever you may have defined with C<$/> or |
e4b7ebf3 | 4442 | C<$INPUT_RECORD_SEPARATOR>). See L<perlvar/"$/">. |
fbad3eb5 | 4443 | |
0f03d336 | 4444 | When C<$/> is set to C<undef>, when C<readline> is in scalar |
80d38338 | 4445 | context (i.e., file slurp mode), and when an empty file is read, it |
449bc448 | 4446 | returns C<''> the first time, followed by C<undef> subsequently. |
fbad3eb5 | 4447 | |
61eff3bc JH |
4448 | This is the internal function implementing the C<< <EXPR> >> |
4449 | operator, but you can use it directly. The C<< <EXPR> >> | |
84902520 TB |
4450 | operator is discussed in more detail in L<perlop/"I/O Operators">. |
4451 | ||
5a964f20 | 4452 | $line = <STDIN>; |
5ed4f2ec | 4453 | $line = readline(*STDIN); # same thing |
5a964f20 | 4454 | |
0f03d336 | 4455 | If C<readline> encounters an operating system error, C<$!> will be set |
4456 | with the corresponding error message. It can be helpful to check | |
4457 | C<$!> when you are reading from filehandles you don't trust, such as a | |
4458 | tty or a socket. The following example uses the operator form of | |
4459 | C<readline> and dies if the result is not defined. | |
4460 | ||
5ed4f2ec | 4461 | while ( ! eof($fh) ) { |
4462 | defined( $_ = <$fh> ) or die "readline failed: $!"; | |
4463 | ... | |
4464 | } | |
0f03d336 | 4465 | |
4466 | Note that you have can't handle C<readline> errors that way with the | |
4467 | C<ARGV> filehandle. In that case, you have to open each element of | |
4468 | C<@ARGV> yourself since C<eof> handles C<ARGV> differently. | |
4469 | ||
4470 | foreach my $arg (@ARGV) { | |
4471 | open(my $fh, $arg) or warn "Can't open $arg: $!"; | |
4472 | ||
4473 | while ( ! eof($fh) ) { | |
4474 | defined( $_ = <$fh> ) | |
4475 | or die "readline failed for $arg: $!"; | |
4476 | ... | |
00cb5da1 | 4477 | } |
00cb5da1 | 4478 | } |
e00e4ce9 | 4479 | |
a0d0e21e | 4480 | =item readlink EXPR |
d74e8afc | 4481 | X<readlink> |
a0d0e21e | 4482 | |
54310121 | 4483 | =item readlink |
bbce6d69 | 4484 | |
a0d0e21e | 4485 | Returns the value of a symbolic link, if symbolic links are |
3b10bc60 | 4486 | implemented. If not, raises an exception. If there is a system |
184e9718 | 4487 | error, returns the undefined value and sets C<$!> (errno). If EXPR is |
7660c0ab | 4488 | omitted, uses C<$_>. |
a0d0e21e | 4489 | |
84902520 | 4490 | =item readpipe EXPR |
8d7403e6 RGS |
4491 | |
4492 | =item readpipe | |
d74e8afc | 4493 | X<readpipe> |
84902520 | 4494 | |
5a964f20 | 4495 | EXPR is executed as a system command. |
84902520 TB |
4496 | The collected standard output of the command is returned. |
4497 | In scalar context, it comes back as a single (potentially | |
4498 | multi-line) string. In list context, returns a list of lines | |
7660c0ab | 4499 | (however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>). |
84902520 TB |
4500 | This is the internal function implementing the C<qx/EXPR/> |
4501 | operator, but you can use it directly. The C<qx/EXPR/> | |
4502 | operator is discussed in more detail in L<perlop/"I/O Operators">. | |
8d7403e6 | 4503 | If EXPR is omitted, uses C<$_>. |
84902520 | 4504 | |
399388f4 | 4505 | =item recv SOCKET,SCALAR,LENGTH,FLAGS |
d74e8afc | 4506 | X<recv> |
a0d0e21e | 4507 | |
9124316e JH |
4508 | Receives a message on a socket. Attempts to receive LENGTH characters |
4509 | of data into variable SCALAR from the specified SOCKET filehandle. | |
4510 | SCALAR will be grown or shrunk to the length actually read. Takes the | |
4511 | same flags as the system call of the same name. Returns the address | |
4512 | of the sender if SOCKET's protocol supports this; returns an empty | |
4513 | string otherwise. If there's an error, returns the undefined value. | |
4514 | This call is actually implemented in terms of recvfrom(2) system call. | |
4515 | See L<perlipc/"UDP: Message Passing"> for examples. | |
4516 | ||
4517 | Note the I<characters>: depending on the status of the socket, either | |
4518 | (8-bit) bytes or characters are received. By default all sockets | |
4519 | operate on bytes, but for example if the socket has been changed using | |
740d4bb2 JW |
4520 | binmode() to operate with the C<:encoding(utf8)> I/O layer (see the |
4521 | C<open> pragma, L<open>), the I/O will operate on UTF-8 encoded Unicode | |
4522 | characters, not bytes. Similarly for the C<:encoding> pragma: in that | |
4523 | case pretty much any characters can be read. | |
a0d0e21e LW |
4524 | |
4525 | =item redo LABEL | |
d74e8afc | 4526 | X<redo> |
a0d0e21e LW |
4527 | |
4528 | =item redo | |
4529 | ||
4530 | The C<redo> command restarts the loop block without evaluating the | |
98293880 | 4531 | conditional again. The C<continue> block, if any, is not executed. If |
a0d0e21e | 4532 | the LABEL is omitted, the command refers to the innermost enclosing |
cf264981 SP |
4533 | loop. Programs that want to lie to themselves about what was just input |
4534 | normally use this command: | |
a0d0e21e LW |
4535 | |
4536 | # a simpleminded Pascal comment stripper | |
4537 | # (warning: assumes no { or } in strings) | |
4633a7c4 | 4538 | LINE: while (<STDIN>) { |
a9a5a0dc VP |
4539 | while (s|({.*}.*){.*}|$1 |) {} |
4540 | s|{.*}| |; | |
4541 | if (s|{.*| |) { | |
4542 | $front = $_; | |
4543 | while (<STDIN>) { | |
4544 | if (/}/) { # end of comment? | |
4545 | s|^|$front\{|; | |
4546 | redo LINE; | |
4547 | } | |
4548 | } | |
5ed4f2ec | 4549 | } |
a9a5a0dc | 4550 | print; |
a0d0e21e LW |
4551 | } |
4552 | ||
80d38338 | 4553 | C<redo> cannot be used to retry a block that returns a value such as |
2b5ab1e7 TC |
4554 | C<eval {}>, C<sub {}> or C<do {}>, and should not be used to exit |
4555 | a grep() or map() operation. | |
4968c1e4 | 4556 | |
6c1372ed GS |
4557 | Note that a block by itself is semantically identical to a loop |
4558 | that executes once. Thus C<redo> inside such a block will effectively | |
4559 | turn it into a looping construct. | |
4560 | ||
98293880 | 4561 | See also L</continue> for an illustration of how C<last>, C<next>, and |
1d2dff63 GS |
4562 | C<redo> work. |
4563 | ||
a0d0e21e | 4564 | =item ref EXPR |
d74e8afc | 4565 | X<ref> X<reference> |
a0d0e21e | 4566 | |
54310121 | 4567 | =item ref |
bbce6d69 | 4568 | |
8a2e0804 A |
4569 | Returns a non-empty string if EXPR is a reference, the empty |
4570 | string otherwise. If EXPR | |
7660c0ab | 4571 | is not specified, C<$_> will be used. The value returned depends on the |
bbce6d69 | 4572 | type of thing the reference is a reference to. |
a0d0e21e LW |
4573 | Builtin types include: |
4574 | ||
a0d0e21e LW |
4575 | SCALAR |
4576 | ARRAY | |
4577 | HASH | |
4578 | CODE | |
19799a22 | 4579 | REF |
a0d0e21e | 4580 | GLOB |
19799a22 | 4581 | LVALUE |
cc10766d RGS |
4582 | FORMAT |
4583 | IO | |
4584 | VSTRING | |
4585 | Regexp | |
a0d0e21e | 4586 | |
54310121 | 4587 | If the referenced object has been blessed into a package, then that package |
19799a22 | 4588 | name is returned instead. You can think of C<ref> as a C<typeof> operator. |
a0d0e21e LW |
4589 | |
4590 | if (ref($r) eq "HASH") { | |
a9a5a0dc | 4591 | print "r is a reference to a hash.\n"; |
54310121 | 4592 | } |
2b5ab1e7 | 4593 | unless (ref($r)) { |
a9a5a0dc | 4594 | print "r is not a reference at all.\n"; |
54310121 | 4595 | } |
a0d0e21e | 4596 | |
85dd5c8b WL |
4597 | The return value C<LVALUE> indicates a reference to an lvalue that is not |
4598 | a variable. You get this from taking the reference of function calls like | |
4599 | C<pos()> or C<substr()>. C<VSTRING> is returned if the reference points | |
603c58be | 4600 | to a L<version string|perldata/"Version Strings">. |
85dd5c8b WL |
4601 | |
4602 | The result C<Regexp> indicates that the argument is a regular expression | |
4603 | resulting from C<qr//>. | |
4604 | ||
a0d0e21e LW |
4605 | See also L<perlref>. |
4606 | ||
4607 | =item rename OLDNAME,NEWNAME | |
d74e8afc | 4608 | X<rename> X<move> X<mv> X<ren> |
a0d0e21e | 4609 | |
19799a22 GS |
4610 | Changes the name of a file; an existing file NEWNAME will be |
4611 | clobbered. Returns true for success, false otherwise. | |
4612 | ||
2b5ab1e7 TC |
4613 | Behavior of this function varies wildly depending on your system |
4614 | implementation. For example, it will usually not work across file system | |
4615 | boundaries, even though the system I<mv> command sometimes compensates | |
4616 | for this. Other restrictions include whether it works on directories, | |
4617 | open files, or pre-existing files. Check L<perlport> and either the | |
4618 | rename(2) manpage or equivalent system documentation for details. | |
a0d0e21e | 4619 | |
dd184578 RGS |
4620 | For a platform independent C<move> function look at the L<File::Copy> |
4621 | module. | |
4622 | ||
16070b82 | 4623 | =item require VERSION |
d74e8afc | 4624 | X<require> |
16070b82 | 4625 | |
a0d0e21e LW |
4626 | =item require EXPR |
4627 | ||
4628 | =item require | |
4629 | ||
3b825e41 RK |
4630 | Demands a version of Perl specified by VERSION, or demands some semantics |
4631 | specified by EXPR or by C<$_> if EXPR is not supplied. | |
44dcb63b | 4632 | |
3b825e41 RK |
4633 | VERSION may be either a numeric argument such as 5.006, which will be |
4634 | compared to C<$]>, or a literal of the form v5.6.1, which will be compared | |
3b10bc60 | 4635 | to C<$^V> (aka $PERL_VERSION). An exception is raised if |
3b825e41 RK |
4636 | VERSION is greater than the version of the current Perl interpreter. |
4637 | Compare with L</use>, which can do a similar check at compile time. | |
4638 | ||
4639 | Specifying VERSION as a literal of the form v5.6.1 should generally be | |
4640 | avoided, because it leads to misleading error messages under earlier | |
cf264981 | 4641 | versions of Perl that do not support this syntax. The equivalent numeric |
3b825e41 | 4642 | version should be used instead. |
44dcb63b | 4643 | |
5ed4f2ec | 4644 | require v5.6.1; # run time version check |
4645 | require 5.6.1; # ditto | |
4646 | require 5.006_001; # ditto; preferred for backwards compatibility | |
a0d0e21e | 4647 | |
362eead3 RGS |
4648 | Otherwise, C<require> demands that a library file be included if it |
4649 | hasn't already been included. The file is included via the do-FILE | |
73c71df6 CW |
4650 | mechanism, which is essentially just a variety of C<eval> with the |
4651 | caveat that lexical variables in the invoking script will be invisible | |
4652 | to the included code. Has semantics similar to the following subroutine: | |
a0d0e21e LW |
4653 | |
4654 | sub require { | |
20907158 AMS |
4655 | my ($filename) = @_; |
4656 | if (exists $INC{$filename}) { | |
4657 | return 1 if $INC{$filename}; | |
4658 | die "Compilation failed in require"; | |
4659 | } | |
4660 | my ($realfilename,$result); | |
4661 | ITER: { | |
4662 | foreach $prefix (@INC) { | |
4663 | $realfilename = "$prefix/$filename"; | |
4664 | if (-f $realfilename) { | |
4665 | $INC{$filename} = $realfilename; | |
4666 | $result = do $realfilename; | |
4667 | last ITER; | |
4668 | } | |
4669 | } | |
4670 | die "Can't find $filename in \@INC"; | |
4671 | } | |
4672 | if ($@) { | |
4673 | $INC{$filename} = undef; | |
4674 | die $@; | |
4675 | } elsif (!$result) { | |
4676 | delete $INC{$filename}; | |
4677 | die "$filename did not return true value"; | |
4678 | } else { | |
4679 | return $result; | |
4680 | } | |
a0d0e21e LW |
4681 | } |
4682 | ||
4683 | Note that the file will not be included twice under the same specified | |
a12755f0 SB |
4684 | name. |
4685 | ||
4686 | The file must return true as the last statement to indicate | |
a0d0e21e | 4687 | successful execution of any initialization code, so it's customary to |
19799a22 GS |
4688 | end such a file with C<1;> unless you're sure it'll return true |
4689 | otherwise. But it's better just to put the C<1;>, in case you add more | |
a0d0e21e LW |
4690 | statements. |
4691 | ||
54310121 | 4692 | If EXPR is a bareword, the require assumes a "F<.pm>" extension and |
da0045b7 | 4693 | replaces "F<::>" with "F</>" in the filename for you, |
54310121 | 4694 | to make it easy to load standard modules. This form of loading of |
a0d0e21e LW |
4695 | modules does not risk altering your namespace. |
4696 | ||
ee580363 GS |
4697 | In other words, if you try this: |
4698 | ||
5ed4f2ec | 4699 | require Foo::Bar; # a splendid bareword |
ee580363 | 4700 | |
b76cc8ba | 4701 | The require function will actually look for the "F<Foo/Bar.pm>" file in the |
7660c0ab | 4702 | directories specified in the C<@INC> array. |
ee580363 | 4703 | |
5a964f20 | 4704 | But if you try this: |
ee580363 GS |
4705 | |
4706 | $class = 'Foo::Bar'; | |
5ed4f2ec | 4707 | require $class; # $class is not a bareword |
5a964f20 | 4708 | #or |
5ed4f2ec | 4709 | require "Foo::Bar"; # not a bareword because of the "" |
ee580363 | 4710 | |
b76cc8ba | 4711 | The require function will look for the "F<Foo::Bar>" file in the @INC array and |
19799a22 | 4712 | will complain about not finding "F<Foo::Bar>" there. In this case you can do: |
ee580363 GS |
4713 | |
4714 | eval "require $class"; | |
4715 | ||
3b10bc60 | 4716 | Now that you understand how C<require> looks for files with a |
a91233bf RGS |
4717 | bareword argument, there is a little extra functionality going on behind |
4718 | the scenes. Before C<require> looks for a "F<.pm>" extension, it will | |
4719 | first look for a similar filename with a "F<.pmc>" extension. If this file | |
4720 | is found, it will be loaded in place of any file ending in a "F<.pm>" | |
4721 | extension. | |
662cc546 | 4722 | |
d54b56d5 RGS |
4723 | You can also insert hooks into the import facility, by putting directly |
4724 | Perl code into the @INC array. There are three forms of hooks: subroutine | |
4725 | references, array references and blessed objects. | |
4726 | ||
4727 | Subroutine references are the simplest case. When the inclusion system | |
4728 | walks through @INC and encounters a subroutine, this subroutine gets | |
3b10bc60 | 4729 | called with two parameters, the first a reference to itself, and the |
4730 | second the name of the file to be included (e.g., "F<Foo/Bar.pm>"). The | |
4731 | subroutine should return either nothing or else a list of up to three | |
4732 | values in the following order: | |
1f0bdf18 NC |
4733 | |
4734 | =over | |
4735 | ||
4736 | =item 1 | |
4737 | ||
1f0bdf18 NC |
4738 | A filehandle, from which the file will be read. |
4739 | ||
cec0e1a7 | 4740 | =item 2 |
1f0bdf18 | 4741 | |
60d352b3 RGS |
4742 | A reference to a subroutine. If there is no filehandle (previous item), |
4743 | then this subroutine is expected to generate one line of source code per | |
4744 | call, writing the line into C<$_> and returning 1, then returning 0 at | |
3b10bc60 | 4745 | end of file. If there is a filehandle, then the subroutine will be |
b8921b3e | 4746 | called to act as a simple source filter, with the line as read in C<$_>. |
60d352b3 RGS |
4747 | Again, return 1 for each valid line, and 0 after all lines have been |
4748 | returned. | |
1f0bdf18 | 4749 | |
cec0e1a7 | 4750 | =item 3 |
1f0bdf18 NC |
4751 | |
4752 | Optional state for the subroutine. The state is passed in as C<$_[1]>. A | |
4753 | reference to the subroutine itself is passed in as C<$_[0]>. | |
4754 | ||
4755 | =back | |
4756 | ||
4757 | If an empty list, C<undef>, or nothing that matches the first 3 values above | |
3b10bc60 | 4758 | is returned, then C<require> looks at the remaining elements of @INC. |
4759 | Note that this filehandle must be a real filehandle (strictly a typeglob | |
4760 | or reference to a typeglob, blessed or unblessed); tied filehandles will be | |
1f0bdf18 | 4761 | ignored and return value processing will stop there. |
d54b56d5 RGS |
4762 | |
4763 | If the hook is an array reference, its first element must be a subroutine | |
4764 | reference. This subroutine is called as above, but the first parameter is | |
3b10bc60 | 4765 | the array reference. This lets you indirectly pass arguments to |
d54b56d5 RGS |
4766 | the subroutine. |
4767 | ||
4768 | In other words, you can write: | |
4769 | ||
4770 | push @INC, \&my_sub; | |
4771 | sub my_sub { | |
a9a5a0dc VP |
4772 | my ($coderef, $filename) = @_; # $coderef is \&my_sub |
4773 | ... | |
d54b56d5 RGS |
4774 | } |
4775 | ||
4776 | or: | |
4777 | ||
4778 | push @INC, [ \&my_sub, $x, $y, ... ]; | |
4779 | sub my_sub { | |
a9a5a0dc VP |
4780 | my ($arrayref, $filename) = @_; |
4781 | # Retrieve $x, $y, ... | |
4782 | my @parameters = @$arrayref[1..$#$arrayref]; | |
4783 | ... | |
d54b56d5 RGS |
4784 | } |
4785 | ||
cf264981 | 4786 | If the hook is an object, it must provide an INC method that will be |
d54b56d5 | 4787 | called as above, the first parameter being the object itself. (Note that |
92c6daad NC |
4788 | you must fully qualify the sub's name, as unqualified C<INC> is always forced |
4789 | into package C<main>.) Here is a typical code layout: | |
d54b56d5 RGS |
4790 | |
4791 | # In Foo.pm | |
4792 | package Foo; | |
4793 | sub new { ... } | |
4794 | sub Foo::INC { | |
a9a5a0dc VP |
4795 | my ($self, $filename) = @_; |
4796 | ... | |
d54b56d5 RGS |
4797 | } |
4798 | ||
4799 | # In the main program | |
797f796a | 4800 | push @INC, Foo->new(...); |
d54b56d5 | 4801 | |
3b10bc60 | 4802 | These hooks are also permitted to set the %INC entry |
9ae8cd5b RGS |
4803 | corresponding to the files they have loaded. See L<perlvar/%INC>. |
4804 | ||
ee580363 | 4805 | For a yet-more-powerful import facility, see L</use> and L<perlmod>. |
a0d0e21e LW |
4806 | |
4807 | =item reset EXPR | |
d74e8afc | 4808 | X<reset> |
a0d0e21e LW |
4809 | |
4810 | =item reset | |
4811 | ||
4812 | Generally used in a C<continue> block at the end of a loop to clear | |
7660c0ab | 4813 | variables and reset C<??> searches so that they work again. The |
a0d0e21e LW |
4814 | expression is interpreted as a list of single characters (hyphens |
4815 | allowed for ranges). All variables and arrays beginning with one of | |
4816 | those letters are reset to their pristine state. If the expression is | |
3b10bc60 | 4817 | omitted, one-match searches (C<?pattern?>) are reset to match again. |
4818 | Only resets variables or searches in the current package. Always returns | |
4819 | 1. Examples: | |
a0d0e21e | 4820 | |
5ed4f2ec | 4821 | reset 'X'; # reset all X variables |
4822 | reset 'a-z'; # reset lower case variables | |
4823 | reset; # just reset ?one-time? searches | |
a0d0e21e | 4824 | |
7660c0ab | 4825 | Resetting C<"A-Z"> is not recommended because you'll wipe out your |
2b5ab1e7 | 4826 | C<@ARGV> and C<@INC> arrays and your C<%ENV> hash. Resets only package |
3b10bc60 | 4827 | variables; lexical variables are unaffected, but they clean themselves |
2b5ab1e7 TC |
4828 | up on scope exit anyway, so you'll probably want to use them instead. |
4829 | See L</my>. | |
a0d0e21e | 4830 | |
54310121 | 4831 | =item return EXPR |
d74e8afc | 4832 | X<return> |
54310121 | 4833 | |
4834 | =item return | |
4835 | ||
b76cc8ba | 4836 | Returns from a subroutine, C<eval>, or C<do FILE> with the value |
5a964f20 | 4837 | given in EXPR. Evaluation of EXPR may be in list, scalar, or void |
54310121 | 4838 | context, depending on how the return value will be used, and the context |
19799a22 | 4839 | may vary from one execution to the next (see C<wantarray>). If no EXPR |
2b5ab1e7 | 4840 | is given, returns an empty list in list context, the undefined value in |
3b10bc60 | 4841 | scalar context, and (of course) nothing at all in void context. |
a0d0e21e | 4842 | |
3b10bc60 | 4843 | (In the absence of an explicit C<return>, a subroutine, eval, |
4844 | or do FILE automatically returns the value of the last expression | |
2b5ab1e7 | 4845 | evaluated.) |
a0d0e21e LW |
4846 | |
4847 | =item reverse LIST | |
d74e8afc | 4848 | X<reverse> X<rev> X<invert> |
a0d0e21e | 4849 | |
5a964f20 TC |
4850 | In list context, returns a list value consisting of the elements |
4851 | of LIST in the opposite order. In scalar context, concatenates the | |
2b5ab1e7 | 4852 | elements of LIST and returns a string value with all characters |
a0ed51b3 | 4853 | in the opposite order. |
4633a7c4 | 4854 | |
9649ed94 | 4855 | print join(", ", reverse "world", "Hello"); # Hello, world |
4633a7c4 | 4856 | |
9649ed94 | 4857 | print scalar reverse "dlrow ,", "olleH"; # Hello, world |
2f9daede | 4858 | |
2d713cbd RGS |
4859 | Used without arguments in scalar context, reverse() reverses C<$_>. |
4860 | ||
9649ed94 B |
4861 | $_ = "dlrow ,olleH"; |
4862 | print reverse; # No output, list context | |
4863 | print scalar reverse; # Hello, world | |
4864 | ||
437d4214 | 4865 | Note that reversing an array to itself (as in C<@a = reverse @a>) will |
80d38338 | 4866 | preserve non-existent elements whenever possible, i.e., for non magical |
437d4214 VP |
4867 | arrays or tied arrays with C<EXISTS> and C<DELETE> methods. |
4868 | ||
2f9daede TP |
4869 | This operator is also handy for inverting a hash, although there are some |
4870 | caveats. If a value is duplicated in the original hash, only one of those | |
4871 | can be represented as a key in the inverted hash. Also, this has to | |
4872 | unwind one hash and build a whole new one, which may take some time | |
2b5ab1e7 | 4873 | on a large hash, such as from a DBM file. |
2f9daede | 4874 | |
5ed4f2ec | 4875 | %by_name = reverse %by_address; # Invert the hash |
a0d0e21e LW |
4876 | |
4877 | =item rewinddir DIRHANDLE | |
d74e8afc | 4878 | X<rewinddir> |
a0d0e21e LW |
4879 | |
4880 | Sets the current position to the beginning of the directory for the | |
19799a22 | 4881 | C<readdir> routine on DIRHANDLE. |
a0d0e21e LW |
4882 | |
4883 | =item rindex STR,SUBSTR,POSITION | |
d74e8afc | 4884 | X<rindex> |
a0d0e21e LW |
4885 | |
4886 | =item rindex STR,SUBSTR | |
4887 | ||
ff551661 | 4888 | Works just like index() except that it returns the position of the I<last> |
a0d0e21e | 4889 | occurrence of SUBSTR in STR. If POSITION is specified, returns the |
ff551661 | 4890 | last occurrence beginning at or before that position. |
a0d0e21e LW |
4891 | |
4892 | =item rmdir FILENAME | |
d74e8afc | 4893 | X<rmdir> X<rd> X<directory, remove> |
a0d0e21e | 4894 | |
54310121 | 4895 | =item rmdir |
bbce6d69 | 4896 | |
974da8e5 JH |
4897 | Deletes the directory specified by FILENAME if that directory is |
4898 | empty. If it succeeds it returns true, otherwise it returns false and | |
4899 | sets C<$!> (errno). If FILENAME is omitted, uses C<$_>. | |
a0d0e21e | 4900 | |
e1020413 | 4901 | To remove a directory tree recursively (C<rm -rf> on Unix) look at |
dd184578 RGS |
4902 | the C<rmtree> function of the L<File::Path> module. |
4903 | ||
a0d0e21e LW |
4904 | =item s/// |
4905 | ||
9f4b9cd0 | 4906 | The substitution operator. See L<perlop/"Regexp Quote-Like Operators">. |
a0d0e21e | 4907 | |
0d863452 RH |
4908 | =item say FILEHANDLE LIST |
4909 | X<say> | |
4910 | ||
4911 | =item say LIST | |
4912 | ||
4913 | =item say | |
4914 | ||
4915 | Just like C<print>, but implicitly appends a newline. | |
187a5aa6 | 4916 | C<say LIST> is simply an abbreviation for C<{ local $\ = "\n"; print |
cfc4a7da | 4917 | LIST }>. |
f406c1e8 | 4918 | |
3b10bc60 | 4919 | This keyword is available only when the "say" feature is |
0d863452 RH |
4920 | enabled: see L<feature>. |
4921 | ||
a0d0e21e | 4922 | =item scalar EXPR |
d74e8afc | 4923 | X<scalar> X<context> |
a0d0e21e | 4924 | |
5a964f20 | 4925 | Forces EXPR to be interpreted in scalar context and returns the value |
54310121 | 4926 | of EXPR. |
cb1a09d0 AD |
4927 | |
4928 | @counts = ( scalar @a, scalar @b, scalar @c ); | |
4929 | ||
54310121 | 4930 | There is no equivalent operator to force an expression to |
2b5ab1e7 | 4931 | be interpolated in list context because in practice, this is never |
cb1a09d0 AD |
4932 | needed. If you really wanted to do so, however, you could use |
4933 | the construction C<@{[ (some expression) ]}>, but usually a simple | |
4934 | C<(some expression)> suffices. | |
a0d0e21e | 4935 | |
3b10bc60 | 4936 | Because C<scalar> is a unary operator, if you accidentally use for EXPR a |
2b5ab1e7 TC |
4937 | parenthesized list, this behaves as a scalar comma expression, evaluating |
4938 | all but the last element in void context and returning the final element | |
4939 | evaluated in scalar context. This is seldom what you want. | |
62c18ce2 GS |
4940 | |
4941 | The following single statement: | |
4942 | ||
5ed4f2ec | 4943 | print uc(scalar(&foo,$bar)),$baz; |
62c18ce2 GS |
4944 | |
4945 | is the moral equivalent of these two: | |
4946 | ||
5ed4f2ec | 4947 | &foo; |
4948 | print(uc($bar),$baz); | |
62c18ce2 GS |
4949 | |
4950 | See L<perlop> for more details on unary operators and the comma operator. | |
4951 | ||
a0d0e21e | 4952 | =item seek FILEHANDLE,POSITION,WHENCE |
d74e8afc | 4953 | X<seek> X<fseek> X<filehandle, position> |
a0d0e21e | 4954 | |
19799a22 | 4955 | Sets FILEHANDLE's position, just like the C<fseek> call of C<stdio>. |
8903cb82 | 4956 | FILEHANDLE may be an expression whose value gives the name of the |
9124316e JH |
4957 | filehandle. The values for WHENCE are C<0> to set the new position |
4958 | I<in bytes> to POSITION, C<1> to set it to the current position plus | |
4959 | POSITION, and C<2> to set it to EOF plus POSITION (typically | |
4960 | negative). For WHENCE you may use the constants C<SEEK_SET>, | |
4961 | C<SEEK_CUR>, and C<SEEK_END> (start of the file, current position, end | |
80d38338 | 4962 | of the file) from the Fcntl module. Returns C<1> on success, C<0> |
9124316e JH |
4963 | otherwise. |
4964 | ||
4965 | Note the I<in bytes>: even if the filehandle has been set to | |
740d4bb2 | 4966 | operate on characters (for example by using the C<:encoding(utf8)> open |
fae2c0fb | 4967 | layer), tell() will return byte offsets, not character offsets |
9124316e | 4968 | (because implementing that would render seek() and tell() rather slow). |
8903cb82 | 4969 | |
3b10bc60 | 4970 | If you want to position the file for C<sysread> or C<syswrite>, don't use |
4971 | C<seek>, because buffering makes its effect on the file's read-write position | |
19799a22 | 4972 | unpredictable and non-portable. Use C<sysseek> instead. |
a0d0e21e | 4973 | |
2b5ab1e7 TC |
4974 | Due to the rules and rigors of ANSI C, on some systems you have to do a |
4975 | seek whenever you switch between reading and writing. Amongst other | |
4976 | things, this may have the effect of calling stdio's clearerr(3). | |
4977 | A WHENCE of C<1> (C<SEEK_CUR>) is useful for not moving the file position: | |
cb1a09d0 AD |
4978 | |
4979 | seek(TEST,0,1); | |
4980 | ||
4981 | This is also useful for applications emulating C<tail -f>. Once you hit | |
3b10bc60 | 4982 | EOF on your read and then sleep for a while, you (probably) have to stick in a |
4983 | dummy seek() to reset things. The C<seek> doesn't change the position, | |
8903cb82 | 4984 | but it I<does> clear the end-of-file condition on the handle, so that the |
3b10bc60 | 4985 | next C<< <FILE> >> makes Perl try again to read something. (We hope.) |
cb1a09d0 | 4986 | |
3b10bc60 | 4987 | If that doesn't work (some I/O implementations are particularly |
4988 | cantankerous), you might need something like this: | |
cb1a09d0 AD |
4989 | |
4990 | for (;;) { | |
a9a5a0dc | 4991 | for ($curpos = tell(FILE); $_ = <FILE>; |
f86cebdf | 4992 | $curpos = tell(FILE)) { |
a9a5a0dc VP |
4993 | # search for some stuff and put it into files |
4994 | } | |
4995 | sleep($for_a_while); | |
4996 | seek(FILE, $curpos, 0); | |
cb1a09d0 AD |
4997 | } |
4998 | ||
a0d0e21e | 4999 | =item seekdir DIRHANDLE,POS |
d74e8afc | 5000 | X<seekdir> |
a0d0e21e | 5001 | |
19799a22 | 5002 | Sets the current position for the C<readdir> routine on DIRHANDLE. POS |
cf264981 SP |
5003 | must be a value returned by C<telldir>. C<seekdir> also has the same caveats |
5004 | about possible directory compaction as the corresponding system library | |
a0d0e21e LW |
5005 | routine. |
5006 | ||
5007 | =item select FILEHANDLE | |
d74e8afc | 5008 | X<select> X<filehandle, default> |
a0d0e21e LW |
5009 | |
5010 | =item select | |
5011 | ||
b5dffda6 RGS |
5012 | Returns the currently selected filehandle. If FILEHANDLE is supplied, |
5013 | sets the new current default filehandle for output. This has two | |
19799a22 | 5014 | effects: first, a C<write> or a C<print> without a filehandle will |
a0d0e21e LW |
5015 | default to this FILEHANDLE. Second, references to variables related to |
5016 | output will refer to this output channel. For example, if you have to | |
5017 | set the top of form format for more than one output channel, you might | |
5018 | do the following: | |
5019 | ||
5020 | select(REPORT1); | |
5021 | $^ = 'report1_top'; | |
5022 | select(REPORT2); | |
5023 | $^ = 'report2_top'; | |
5024 | ||
5025 | FILEHANDLE may be an expression whose value gives the name of the | |
5026 | actual filehandle. Thus: | |
5027 | ||
5028 | $oldfh = select(STDERR); $| = 1; select($oldfh); | |
5029 | ||
4633a7c4 LW |
5030 | Some programmers may prefer to think of filehandles as objects with |
5031 | methods, preferring to write the last example as: | |
a0d0e21e | 5032 | |
28757baa | 5033 | use IO::Handle; |
a0d0e21e LW |
5034 | STDERR->autoflush(1); |
5035 | ||
5036 | =item select RBITS,WBITS,EBITS,TIMEOUT | |
d74e8afc | 5037 | X<select> |
a0d0e21e | 5038 | |
3b10bc60 | 5039 | This calls the select(2) syscall with the bit masks specified, which |
19799a22 | 5040 | can be constructed using C<fileno> and C<vec>, along these lines: |
a0d0e21e LW |
5041 | |
5042 | $rin = $win = $ein = ''; | |
5043 | vec($rin,fileno(STDIN),1) = 1; | |
5044 | vec($win,fileno(STDOUT),1) = 1; | |
5045 | $ein = $rin | $win; | |
5046 | ||
3b10bc60 | 5047 | If you want to select on many filehandles, you may wish to write a |
5048 | subroutine like this: | |
a0d0e21e LW |
5049 | |
5050 | sub fhbits { | |
a9a5a0dc VP |
5051 | my(@fhlist) = split(' ',$_[0]); |
5052 | my($bits); | |
5053 | for (@fhlist) { | |
5054 | vec($bits,fileno($_),1) = 1; | |
5055 | } | |
5056 | $bits; | |
a0d0e21e | 5057 | } |
4633a7c4 | 5058 | $rin = fhbits('STDIN TTY SOCK'); |
a0d0e21e LW |
5059 | |
5060 | The usual idiom is: | |
5061 | ||
5062 | ($nfound,$timeleft) = | |
5063 | select($rout=$rin, $wout=$win, $eout=$ein, $timeout); | |
5064 | ||
54310121 | 5065 | or to block until something becomes ready just do this |
a0d0e21e LW |
5066 | |
5067 | $nfound = select($rout=$rin, $wout=$win, $eout=$ein, undef); | |
5068 | ||
19799a22 GS |
5069 | Most systems do not bother to return anything useful in $timeleft, so |
5070 | calling select() in scalar context just returns $nfound. | |
c07a80fd | 5071 | |
5f05dabc | 5072 | Any of the bit masks can also be undef. The timeout, if specified, is |
a0d0e21e | 5073 | in seconds, which may be fractional. Note: not all implementations are |
be119125 | 5074 | capable of returning the $timeleft. If not, they always return |
19799a22 | 5075 | $timeleft equal to the supplied $timeout. |
a0d0e21e | 5076 | |
ff68c719 | 5077 | You can effect a sleep of 250 milliseconds this way: |
a0d0e21e LW |
5078 | |
5079 | select(undef, undef, undef, 0.25); | |
5080 | ||
b09fc1d8 | 5081 | Note that whether C<select> gets restarted after signals (say, SIGALRM) |
8b0ac1d7 MHM |
5082 | is implementation-dependent. See also L<perlport> for notes on the |
5083 | portability of C<select>. | |
40454f26 | 5084 | |
3b10bc60 | 5085 | On error, C<select> behaves like select(2): it returns |
4189264e | 5086 | -1 and sets C<$!>. |
353e5636 | 5087 | |
3b10bc60 | 5088 | On some Unixes, select(2) may report a socket file |
5089 | descriptor as "ready for reading" when no data is available, and | |
5090 | thus a subsequent read blocks. This can be avoided if you always use | |
5091 | O_NONBLOCK on the socket. See select(2) and fcntl(2) for further | |
ec8ce15a HPM |
5092 | details. |
5093 | ||
19799a22 | 5094 | B<WARNING>: One should not attempt to mix buffered I/O (like C<read> |
61eff3bc | 5095 | or <FH>) with C<select>, except as permitted by POSIX, and even |
19799a22 | 5096 | then only on POSIX systems. You have to use C<sysread> instead. |
a0d0e21e LW |
5097 | |
5098 | =item semctl ID,SEMNUM,CMD,ARG | |
d74e8afc | 5099 | X<semctl> |
a0d0e21e | 5100 | |
3b10bc60 | 5101 | Calls the System V IPC function semctl(2). You'll probably have to say |
0ade1984 JH |
5102 | |
5103 | use IPC::SysV; | |
5104 | ||
5105 | first to get the correct constant definitions. If CMD is IPC_STAT or | |
cf264981 | 5106 | GETALL, then ARG must be a variable that will hold the returned |
e4038a1f MS |
5107 | semid_ds structure or semaphore value array. Returns like C<ioctl>: |
5108 | the undefined value for error, "C<0 but true>" for zero, or the actual | |
5109 | return value otherwise. The ARG must consist of a vector of native | |
106325ad | 5110 | short integers, which may be created with C<pack("s!",(0)x$nsem)>. |
4755096e GS |
5111 | See also L<perlipc/"SysV IPC">, C<IPC::SysV>, C<IPC::Semaphore> |
5112 | documentation. | |
a0d0e21e LW |
5113 | |
5114 | =item semget KEY,NSEMS,FLAGS | |
d74e8afc | 5115 | X<semget> |
a0d0e21e | 5116 | |
3b10bc60 | 5117 | Calls the System V IPC function semget(2). Returns the semaphore id, or |
4755096e GS |
5118 | the undefined value if there is an error. See also |
5119 | L<perlipc/"SysV IPC">, C<IPC::SysV>, C<IPC::SysV::Semaphore> | |
5120 | documentation. | |
a0d0e21e LW |
5121 | |
5122 | =item semop KEY,OPSTRING | |
d74e8afc | 5123 | X<semop> |
a0d0e21e | 5124 | |
80d38338 | 5125 | Calls the System V IPC function semop(2) for semaphore operations |
5354997a | 5126 | such as signalling and waiting. OPSTRING must be a packed array of |
a0d0e21e | 5127 | semop structures. Each semop structure can be generated with |
cf264981 SP |
5128 | C<pack("s!3", $semnum, $semop, $semflag)>. The length of OPSTRING |
5129 | implies the number of semaphore operations. Returns true if | |
19799a22 GS |
5130 | successful, or false if there is an error. As an example, the |
5131 | following code waits on semaphore $semnum of semaphore id $semid: | |
a0d0e21e | 5132 | |
f878ba33 | 5133 | $semop = pack("s!3", $semnum, -1, 0); |
a0d0e21e LW |
5134 | die "Semaphore trouble: $!\n" unless semop($semid, $semop); |
5135 | ||
4755096e GS |
5136 | To signal the semaphore, replace C<-1> with C<1>. See also |
5137 | L<perlipc/"SysV IPC">, C<IPC::SysV>, and C<IPC::SysV::Semaphore> | |
5138 | documentation. | |
a0d0e21e LW |
5139 | |
5140 | =item send SOCKET,MSG,FLAGS,TO | |
d74e8afc | 5141 | X<send> |
a0d0e21e LW |
5142 | |
5143 | =item send SOCKET,MSG,FLAGS | |
5144 | ||
3b10bc60 | 5145 | Sends a message on a socket. Attempts to send the scalar MSG to the SOCKET |
5146 | filehandle. Takes the same flags as the system call of the same name. On | |
5147 | unconnected sockets, you must specify a destination to I<send to>, in which | |
5148 | case it does a sendto(2) syscall. Returns the number of characters sent, | |
5149 | or the undefined value on error. The sendmsg(2) syscall is currently | |
5150 | unimplemented. See L<perlipc/"UDP: Message Passing"> for examples. | |
9124316e JH |
5151 | |
5152 | Note the I<characters>: depending on the status of the socket, either | |
5153 | (8-bit) bytes or characters are sent. By default all sockets operate | |
5154 | on bytes, but for example if the socket has been changed using | |
740d4bb2 JW |
5155 | binmode() to operate with the C<:encoding(utf8)> I/O layer (see |
5156 | L</open>, or the C<open> pragma, L<open>), the I/O will operate on UTF-8 | |
5157 | encoded Unicode characters, not bytes. Similarly for the C<:encoding> | |
5158 | pragma: in that case pretty much any characters can be sent. | |
a0d0e21e LW |
5159 | |
5160 | =item setpgrp PID,PGRP | |
d74e8afc | 5161 | X<setpgrp> X<group> |
a0d0e21e | 5162 | |
7660c0ab | 5163 | Sets the current process group for the specified PID, C<0> for the current |
3b10bc60 | 5164 | process. Raises an exception when used on a machine that doesn't |
81777298 GS |
5165 | implement POSIX setpgid(2) or BSD setpgrp(2). If the arguments are omitted, |
5166 | it defaults to C<0,0>. Note that the BSD 4.2 version of C<setpgrp> does not | |
5167 | accept any arguments, so only C<setpgrp(0,0)> is portable. See also | |
5168 | C<POSIX::setsid()>. | |
a0d0e21e LW |
5169 | |
5170 | =item setpriority WHICH,WHO,PRIORITY | |
d74e8afc | 5171 | X<setpriority> X<priority> X<nice> X<renice> |
a0d0e21e LW |
5172 | |
5173 | Sets the current priority for a process, a process group, or a user. | |
3b10bc60 | 5174 | (See setpriority(2).) Raises an exception when used on a machine |
f86cebdf | 5175 | that doesn't implement setpriority(2). |
a0d0e21e LW |
5176 | |
5177 | =item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL | |
d74e8afc | 5178 | X<setsockopt> |
a0d0e21e LW |
5179 | |
5180 | Sets the socket option requested. Returns undefined if there is an | |
23d0437f GA |
5181 | error. Use integer constants provided by the C<Socket> module for |
5182 | LEVEL and OPNAME. Values for LEVEL can also be obtained from | |
5183 | getprotobyname. OPTVAL might either be a packed string or an integer. | |
5184 | An integer OPTVAL is shorthand for pack("i", OPTVAL). | |
5185 | ||
3b10bc60 | 5186 | An example disabling Nagle's algorithm on a socket: |
23d0437f GA |
5187 | |
5188 | use Socket qw(IPPROTO_TCP TCP_NODELAY); | |
5189 | setsockopt($socket, IPPROTO_TCP, TCP_NODELAY, 1); | |
a0d0e21e LW |
5190 | |
5191 | =item shift ARRAY | |
d74e8afc | 5192 | X<shift> |
a0d0e21e LW |
5193 | |
5194 | =item shift | |
5195 | ||
5196 | Shifts the first value of the array off and returns it, shortening the | |
5197 | array by 1 and moving everything down. If there are no elements in the | |
5198 | array, returns the undefined value. If ARRAY is omitted, shifts the | |
7660c0ab | 5199 | C<@_> array within the lexical scope of subroutines and formats, and the |
80d38338 | 5200 | C<@ARGV> array outside a subroutine and also within the lexical scopes |
3c10abe3 AG |
5201 | established by the C<eval STRING>, C<BEGIN {}>, C<INIT {}>, C<CHECK {}>, |
5202 | C<UNITCHECK {}> and C<END {}> constructs. | |
4f25aa18 | 5203 | |
a1b2c429 | 5204 | See also C<unshift>, C<push>, and C<pop>. C<shift> and C<unshift> do the |
19799a22 | 5205 | same thing to the left end of an array that C<pop> and C<push> do to the |
977336f5 | 5206 | right end. |
a0d0e21e LW |
5207 | |
5208 | =item shmctl ID,CMD,ARG | |
d74e8afc | 5209 | X<shmctl> |
a0d0e21e | 5210 | |
0ade1984 JH |
5211 | Calls the System V IPC function shmctl. You'll probably have to say |
5212 | ||
5213 | use IPC::SysV; | |
5214 | ||
7660c0ab | 5215 | first to get the correct constant definitions. If CMD is C<IPC_STAT>, |
cf264981 | 5216 | then ARG must be a variable that will hold the returned C<shmid_ds> |
7660c0ab | 5217 | structure. Returns like ioctl: the undefined value for error, "C<0> but |
0ade1984 | 5218 | true" for zero, or the actual return value otherwise. |
4755096e | 5219 | See also L<perlipc/"SysV IPC"> and C<IPC::SysV> documentation. |
a0d0e21e LW |
5220 | |
5221 | =item shmget KEY,SIZE,FLAGS | |
d74e8afc | 5222 | X<shmget> |
a0d0e21e LW |
5223 | |
5224 | Calls the System V IPC function shmget. Returns the shared memory | |
5225 | segment id, or the undefined value if there is an error. | |
4755096e | 5226 | See also L<perlipc/"SysV IPC"> and C<IPC::SysV> documentation. |
a0d0e21e LW |
5227 | |
5228 | =item shmread ID,VAR,POS,SIZE | |
d74e8afc ITB |
5229 | X<shmread> |
5230 | X<shmwrite> | |
a0d0e21e LW |
5231 | |
5232 | =item shmwrite ID,STRING,POS,SIZE | |
5233 | ||
5234 | Reads or writes the System V shared memory segment ID starting at | |
5235 | position POS for size SIZE by attaching to it, copying in/out, and | |
5a964f20 | 5236 | detaching from it. When reading, VAR must be a variable that will |
a0d0e21e LW |
5237 | hold the data read. When writing, if STRING is too long, only SIZE |
5238 | bytes are used; if STRING is too short, nulls are written to fill out | |
19799a22 | 5239 | SIZE bytes. Return true if successful, or false if there is an error. |
4755096e GS |
5240 | shmread() taints the variable. See also L<perlipc/"SysV IPC">, |
5241 | C<IPC::SysV> documentation, and the C<IPC::Shareable> module from CPAN. | |
a0d0e21e LW |
5242 | |
5243 | =item shutdown SOCKET,HOW | |
d74e8afc | 5244 | X<shutdown> |
a0d0e21e LW |
5245 | |
5246 | Shuts down a socket connection in the manner indicated by HOW, which | |
3b10bc60 | 5247 | has the same interpretation as in the syscall of the same name. |
a0d0e21e | 5248 | |
f86cebdf GS |
5249 | shutdown(SOCKET, 0); # I/we have stopped reading data |
5250 | shutdown(SOCKET, 1); # I/we have stopped writing data | |
5251 | shutdown(SOCKET, 2); # I/we have stopped using this socket | |
5a964f20 TC |
5252 | |
5253 | This is useful with sockets when you want to tell the other | |
5254 | side you're done writing but not done reading, or vice versa. | |
b76cc8ba | 5255 | It's also a more insistent form of close because it also |
19799a22 | 5256 | disables the file descriptor in any forked copies in other |
5a964f20 TC |
5257 | processes. |
5258 | ||
3b10bc60 | 5259 | Returns C<1> for success; on error, returns C<undef> if |
f126b98b PF |
5260 | the first argument is not a valid filehandle, or returns C<0> and sets |
5261 | C<$!> for any other failure. | |
5262 | ||
a0d0e21e | 5263 | =item sin EXPR |
d74e8afc | 5264 | X<sin> X<sine> X<asin> X<arcsine> |
a0d0e21e | 5265 | |
54310121 | 5266 | =item sin |
bbce6d69 | 5267 | |
a0d0e21e | 5268 | Returns the sine of EXPR (expressed in radians). If EXPR is omitted, |
7660c0ab | 5269 | returns sine of C<$_>. |
a0d0e21e | 5270 | |
ca6e1c26 | 5271 | For the inverse sine operation, you may use the C<Math::Trig::asin> |
28757baa | 5272 | function, or use this relation: |
5273 | ||
5274 | sub asin { atan2($_[0], sqrt(1 - $_[0] * $_[0])) } | |
5275 | ||
a0d0e21e | 5276 | =item sleep EXPR |
d74e8afc | 5277 | X<sleep> X<pause> |
a0d0e21e LW |
5278 | |
5279 | =item sleep | |
5280 | ||
80d38338 TC |
5281 | Causes the script to sleep for (integer) EXPR seconds, or forever if no |
5282 | argument is given. Returns the integer number of seconds actually slept. | |
b48653af | 5283 | |
7660c0ab | 5284 | May be interrupted if the process receives a signal such as C<SIGALRM>. |
b48653af MS |
5285 | |
5286 | eval { | |
5287 | local $SIG{ALARM} = sub { die "Alarm!\n" }; | |
5288 | sleep; | |
5289 | }; | |
5290 | die $@ unless $@ eq "Alarm!\n"; | |
5291 | ||
5292 | You probably cannot mix C<alarm> and C<sleep> calls, because C<sleep> | |
5293 | is often implemented using C<alarm>. | |
a0d0e21e LW |
5294 | |
5295 | On some older systems, it may sleep up to a full second less than what | |
5296 | you requested, depending on how it counts seconds. Most modern systems | |
5a964f20 TC |
5297 | always sleep the full amount. They may appear to sleep longer than that, |
5298 | however, because your process might not be scheduled right away in a | |
5299 | busy multitasking system. | |
a0d0e21e | 5300 | |
2bc69794 BS |
5301 | For delays of finer granularity than one second, the Time::HiRes module |
5302 | (from CPAN, and starting from Perl 5.8 part of the standard | |
5303 | distribution) provides usleep(). You may also use Perl's four-argument | |
5304 | version of select() leaving the first three arguments undefined, or you | |
5305 | might be able to use the C<syscall> interface to access setitimer(2) if | |
5306 | your system supports it. See L<perlfaq8> for details. | |
cb1a09d0 | 5307 | |
b6e2112e | 5308 | See also the POSIX module's C<pause> function. |
5f05dabc | 5309 | |
a0d0e21e | 5310 | =item socket SOCKET,DOMAIN,TYPE,PROTOCOL |
d74e8afc | 5311 | X<socket> |
a0d0e21e LW |
5312 | |
5313 | Opens a socket of the specified kind and attaches it to filehandle | |
19799a22 | 5314 | SOCKET. DOMAIN, TYPE, and PROTOCOL are specified the same as for |
3b10bc60 | 5315 | the syscall of the same name. You should C<use Socket> first |
19799a22 GS |
5316 | to get the proper definitions imported. See the examples in |
5317 | L<perlipc/"Sockets: Client/Server Communication">. | |
a0d0e21e | 5318 | |
8d2a6795 GS |
5319 | On systems that support a close-on-exec flag on files, the flag will |
5320 | be set for the newly opened file descriptor, as determined by the | |
5321 | value of $^F. See L<perlvar/$^F>. | |
5322 | ||
a0d0e21e | 5323 | =item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL |
d74e8afc | 5324 | X<socketpair> |
a0d0e21e LW |
5325 | |
5326 | Creates an unnamed pair of sockets in the specified domain, of the | |
5f05dabc | 5327 | specified type. DOMAIN, TYPE, and PROTOCOL are specified the same as |
3b10bc60 | 5328 | for the syscall of the same name. If unimplemented, raises an exception. |
5329 | Returns true if successful. | |
a0d0e21e | 5330 | |
8d2a6795 GS |
5331 | On systems that support a close-on-exec flag on files, the flag will |
5332 | be set for the newly opened file descriptors, as determined by the value | |
5333 | of $^F. See L<perlvar/$^F>. | |
5334 | ||
19799a22 | 5335 | Some systems defined C<pipe> in terms of C<socketpair>, in which a call |
5a964f20 TC |
5336 | to C<pipe(Rdr, Wtr)> is essentially: |
5337 | ||
5338 | use Socket; | |
5339 | socketpair(Rdr, Wtr, AF_UNIX, SOCK_STREAM, PF_UNSPEC); | |
5340 | shutdown(Rdr, 1); # no more writing for reader | |
5341 | shutdown(Wtr, 0); # no more reading for writer | |
5342 | ||
02fc2eee NC |
5343 | See L<perlipc> for an example of socketpair use. Perl 5.8 and later will |
5344 | emulate socketpair using IP sockets to localhost if your system implements | |
5345 | sockets but not socketpair. | |
5a964f20 | 5346 | |
a0d0e21e | 5347 | =item sort SUBNAME LIST |
d74e8afc | 5348 | X<sort> X<qsort> X<quicksort> X<mergesort> |
a0d0e21e LW |
5349 | |
5350 | =item sort BLOCK LIST | |
5351 | ||
5352 | =item sort LIST | |
5353 | ||
41d39f30 | 5354 | In list context, this sorts the LIST and returns the sorted list value. |
9fdc1d08 | 5355 | In scalar context, the behaviour of C<sort()> is undefined. |
41d39f30 A |
5356 | |
5357 | If SUBNAME or BLOCK is omitted, C<sort>s in standard string comparison | |
5358 | order. If SUBNAME is specified, it gives the name of a subroutine | |
5359 | that returns an integer less than, equal to, or greater than C<0>, | |
3b10bc60 | 5360 | depending on how the elements of the list are to be ordered. (The |
5361 | C<< <=> >> and C<cmp> operators are extremely useful in such routines.) | |
41d39f30 A |
5362 | SUBNAME may be a scalar variable name (unsubscripted), in which case |
5363 | the value provides the name of (or a reference to) the actual | |
5364 | subroutine to use. In place of a SUBNAME, you can provide a BLOCK as | |
5365 | an anonymous, in-line sort subroutine. | |
a0d0e21e | 5366 | |
43481408 | 5367 | If the subroutine's prototype is C<($$)>, the elements to be compared |
f9a36357 GS |
5368 | are passed by reference in C<@_>, as for a normal subroutine. This is |
5369 | slower than unprototyped subroutines, where the elements to be | |
5370 | compared are passed into the subroutine | |
43481408 GS |
5371 | as the package global variables $a and $b (see example below). Note that |
5372 | in the latter case, it is usually counter-productive to declare $a and | |
5373 | $b as lexicals. | |
5374 | ||
c106e8bb RH |
5375 | The values to be compared are always passed by reference and should not |
5376 | be modified. | |
a0d0e21e | 5377 | |
0a753a76 | 5378 | You also cannot exit out of the sort block or subroutine using any of the |
19799a22 | 5379 | loop control operators described in L<perlsyn> or with C<goto>. |
0a753a76 | 5380 | |
a034a98d DD |
5381 | When C<use locale> is in effect, C<sort LIST> sorts LIST according to the |
5382 | current collation locale. See L<perllocale>. | |
5383 | ||
db5021a3 MS |
5384 | sort() returns aliases into the original list, much as a for loop's index |
5385 | variable aliases the list elements. That is, modifying an element of a | |
5386 | list returned by sort() (for example, in a C<foreach>, C<map> or C<grep>) | |
5387 | actually modifies the element in the original list. This is usually | |
5388 | something to be avoided when writing clear code. | |
5389 | ||
58c7fc7c JH |
5390 | Perl 5.6 and earlier used a quicksort algorithm to implement sort. |
5391 | That algorithm was not stable, and I<could> go quadratic. (A I<stable> sort | |
5392 | preserves the input order of elements that compare equal. Although | |
5393 | quicksort's run time is O(NlogN) when averaged over all arrays of | |
5394 | length N, the time can be O(N**2), I<quadratic> behavior, for some | |
5395 | inputs.) In 5.7, the quicksort implementation was replaced with | |
cf264981 | 5396 | a stable mergesort algorithm whose worst-case behavior is O(NlogN). |
58c7fc7c JH |
5397 | But benchmarks indicated that for some inputs, on some platforms, |
5398 | the original quicksort was faster. 5.8 has a sort pragma for | |
5399 | limited control of the sort. Its rather blunt control of the | |
cf264981 | 5400 | underlying algorithm may not persist into future Perls, but the |
58c7fc7c | 5401 | ability to characterize the input or output in implementation |
c25fe68d | 5402 | independent ways quite probably will. See L<the sort pragma|sort>. |
c16425f1 | 5403 | |
a0d0e21e LW |
5404 | Examples: |
5405 | ||
5406 | # sort lexically | |
5407 | @articles = sort @files; | |
e1d16ab7 | 5408 | |
a0d0e21e LW |
5409 | # same thing, but with explicit sort routine |
5410 | @articles = sort {$a cmp $b} @files; | |
e1d16ab7 | 5411 | |
cb1a09d0 | 5412 | # now case-insensitively |
54310121 | 5413 | @articles = sort {uc($a) cmp uc($b)} @files; |
e1d16ab7 | 5414 | |
a0d0e21e LW |
5415 | # same thing in reversed order |
5416 | @articles = sort {$b cmp $a} @files; | |
e1d16ab7 | 5417 | |
a0d0e21e LW |
5418 | # sort numerically ascending |
5419 | @articles = sort {$a <=> $b} @files; | |
e1d16ab7 | 5420 | |
a0d0e21e LW |
5421 | # sort numerically descending |
5422 | @articles = sort {$b <=> $a} @files; | |
e1d16ab7 | 5423 | |
19799a22 GS |
5424 | # this sorts the %age hash by value instead of key |
5425 | # using an in-line function | |
5426 | @eldest = sort { $age{$b} <=> $age{$a} } keys %age; | |
e1d16ab7 | 5427 | |
a0d0e21e LW |
5428 | # sort using explicit subroutine name |
5429 | sub byage { | |
5ed4f2ec | 5430 | $age{$a} <=> $age{$b}; # presuming numeric |
a0d0e21e LW |
5431 | } |
5432 | @sortedclass = sort byage @class; | |
e1d16ab7 | 5433 | |
19799a22 GS |
5434 | sub backwards { $b cmp $a } |
5435 | @harry = qw(dog cat x Cain Abel); | |
5436 | @george = qw(gone chased yz Punished Axed); | |
a0d0e21e | 5437 | print sort @harry; |
e1d16ab7 | 5438 | # prints AbelCaincatdogx |
a0d0e21e | 5439 | print sort backwards @harry; |
e1d16ab7 | 5440 | # prints xdogcatCainAbel |
a0d0e21e | 5441 | print sort @george, 'to', @harry; |
e1d16ab7 | 5442 | # prints AbelAxedCainPunishedcatchaseddoggonetoxyz |
a0d0e21e | 5443 | |
54310121 | 5444 | # inefficiently sort by descending numeric compare using |
5445 | # the first integer after the first = sign, or the | |
cb1a09d0 AD |
5446 | # whole record case-insensitively otherwise |
5447 | ||
e1d16ab7 | 5448 | my @new = sort { |
5449 | ($b =~ /=(\d+)/)[0] <=> ($a =~ /=(\d+)/)[0] | |
5450 | || | |
5451 | uc($a) cmp uc($b) | |
cb1a09d0 AD |
5452 | } @old; |
5453 | ||
5454 | # same thing, but much more efficiently; | |
5455 | # we'll build auxiliary indices instead | |
5456 | # for speed | |
e1d16ab7 | 5457 | my @nums = @caps = (); |
54310121 | 5458 | for (@old) { |
e1d16ab7 | 5459 | push @nums, ( /=(\d+)/ ? $1 : undef ); |
5460 | push @caps, uc($_); | |
54310121 | 5461 | } |
cb1a09d0 | 5462 | |
e1d16ab7 | 5463 | my @new = @old[ sort { |
5464 | $nums[$b] <=> $nums[$a] | |
5465 | || | |
5466 | $caps[$a] cmp $caps[$b] | |
5467 | } 0..$#old | |
5468 | ]; | |
cb1a09d0 | 5469 | |
19799a22 | 5470 | # same thing, but without any temps |
cb1a09d0 | 5471 | @new = map { $_->[0] } |
19799a22 | 5472 | sort { $b->[1] <=> $a->[1] |
e1d16ab7 | 5473 | || |
5474 | $a->[2] cmp $b->[2] | |
5475 | } map { [$_, /=(\d+)/, uc($_)] } @old; | |
61eff3bc | 5476 | |
43481408 GS |
5477 | # using a prototype allows you to use any comparison subroutine |
5478 | # as a sort subroutine (including other package's subroutines) | |
5479 | package other; | |
5ed4f2ec | 5480 | sub backwards ($$) { $_[1] cmp $_[0]; } # $a and $b are not set here |
e1d16ab7 | 5481 | |
43481408 GS |
5482 | package main; |
5483 | @new = sort other::backwards @old; | |
e1d16ab7 | 5484 | |
58c7fc7c JH |
5485 | # guarantee stability, regardless of algorithm |
5486 | use sort 'stable'; | |
5487 | @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old; | |
e1d16ab7 | 5488 | |
268e9d79 JL |
5489 | # force use of mergesort (not portable outside Perl 5.8) |
5490 | use sort '_mergesort'; # note discouraging _ | |
58c7fc7c | 5491 | @new = sort { substr($a, 3, 5) cmp substr($b, 3, 5) } @old; |
58c7fc7c | 5492 | |
1cb246e8 RGS |
5493 | Warning: syntactical care is required when sorting the list returned from |
5494 | a function. If you want to sort the list returned by the function call | |
5495 | C<find_records(@key)>, you can use: | |
a9320c62 | 5496 | |
a9320c62 B |
5497 | @contact = sort { $a cmp $b } find_records @key; |
5498 | @contact = sort +find_records(@key); | |
5499 | @contact = sort &find_records(@key); | |
5500 | @contact = sort(find_records(@key)); | |
5501 | ||
5502 | If instead you want to sort the array @key with the comparison routine | |
1cb246e8 RGS |
5503 | C<find_records()> then you can use: |
5504 | ||
a9320c62 B |
5505 | @contact = sort { find_records() } @key; |
5506 | @contact = sort find_records(@key); | |
5507 | @contact = sort(find_records @key); | |
5508 | @contact = sort(find_records (@key)); | |
5509 | ||
19799a22 GS |
5510 | If you're using strict, you I<must not> declare $a |
5511 | and $b as lexicals. They are package globals. That means | |
1cb246e8 | 5512 | that if you're in the C<main> package and type |
13a2d996 | 5513 | |
47223a36 | 5514 | @articles = sort {$b <=> $a} @files; |
13a2d996 | 5515 | |
47223a36 JH |
5516 | then C<$a> and C<$b> are C<$main::a> and C<$main::b> (or C<$::a> and C<$::b>), |
5517 | but if you're in the C<FooPack> package, it's the same as typing | |
cb1a09d0 AD |
5518 | |
5519 | @articles = sort {$FooPack::b <=> $FooPack::a} @files; | |
5520 | ||
55497cff | 5521 | The comparison function is required to behave. If it returns |
7660c0ab A |
5522 | inconsistent results (sometimes saying C<$x[1]> is less than C<$x[2]> and |
5523 | sometimes saying the opposite, for example) the results are not | |
5524 | well-defined. | |
55497cff | 5525 | |
03190201 | 5526 | Because C<< <=> >> returns C<undef> when either operand is C<NaN> |
3b10bc60 | 5527 | (not-a-number), and because C<sort> raises an exception unless the |
03190201 JL |
5528 | result of a comparison is defined, when sorting with a comparison function |
5529 | like C<< $a <=> $b >>, be careful about lists that might contain a C<NaN>. | |
80d38338 | 5530 | The following example takes advantage that C<NaN != NaN> to |
3b10bc60 | 5531 | eliminate any C<NaN>s from the input list. |
03190201 JL |
5532 | |
5533 | @result = sort { $a <=> $b } grep { $_ == $_ } @input; | |
5534 | ||
a0d0e21e | 5535 | =item splice ARRAY,OFFSET,LENGTH,LIST |
d74e8afc | 5536 | X<splice> |
a0d0e21e LW |
5537 | |
5538 | =item splice ARRAY,OFFSET,LENGTH | |
5539 | ||
5540 | =item splice ARRAY,OFFSET | |
5541 | ||
453f9044 GS |
5542 | =item splice ARRAY |
5543 | ||
a0d0e21e | 5544 | Removes the elements designated by OFFSET and LENGTH from an array, and |
5a964f20 TC |
5545 | replaces them with the elements of LIST, if any. In list context, |
5546 | returns the elements removed from the array. In scalar context, | |
43051805 | 5547 | returns the last element removed, or C<undef> if no elements are |
48cdf507 | 5548 | removed. The array grows or shrinks as necessary. |
19799a22 | 5549 | If OFFSET is negative then it starts that far from the end of the array. |
48cdf507 | 5550 | If LENGTH is omitted, removes everything from OFFSET onward. |
d0920e03 MJD |
5551 | If LENGTH is negative, removes the elements from OFFSET onward |
5552 | except for -LENGTH elements at the end of the array. | |
8cbc2e3b | 5553 | If both OFFSET and LENGTH are omitted, removes everything. If OFFSET is |
3b10bc60 | 5554 | past the end of the array, Perl issues a warning, and splices at the |
8cbc2e3b | 5555 | end of the array. |
453f9044 | 5556 | |
3272a53d | 5557 | The following equivalences hold (assuming C<< $[ == 0 and $#a >= $i >> ) |
a0d0e21e | 5558 | |
5ed4f2ec | 5559 | push(@a,$x,$y) splice(@a,@a,0,$x,$y) |
5560 | pop(@a) splice(@a,-1) | |
5561 | shift(@a) splice(@a,0,1) | |
5562 | unshift(@a,$x,$y) splice(@a,0,0,$x,$y) | |
5563 | $a[$i] = $y splice(@a,$i,1,$y) | |
a0d0e21e LW |
5564 | |
5565 | Example, assuming array lengths are passed before arrays: | |
5566 | ||
5ed4f2ec | 5567 | sub aeq { # compare two list values |
a9a5a0dc VP |
5568 | my(@a) = splice(@_,0,shift); |
5569 | my(@b) = splice(@_,0,shift); | |
5570 | return 0 unless @a == @b; # same len? | |
5571 | while (@a) { | |
5572 | return 0 if pop(@a) ne pop(@b); | |
5573 | } | |
5574 | return 1; | |
a0d0e21e LW |
5575 | } |
5576 | if (&aeq($len,@foo[1..$len],0+@bar,@bar)) { ... } | |
5577 | ||
5578 | =item split /PATTERN/,EXPR,LIMIT | |
d74e8afc | 5579 | X<split> |
a0d0e21e LW |
5580 | |
5581 | =item split /PATTERN/,EXPR | |
5582 | ||
5583 | =item split /PATTERN/ | |
5584 | ||
5585 | =item split | |
5586 | ||
b2e26e6e DJ |
5587 | Splits the string EXPR into a list of strings and returns that list. By |
5588 | default, empty leading fields are preserved, and empty trailing ones are | |
ab7ee80f | 5589 | deleted. (If all fields are empty, they are considered to be trailing.) |
a0d0e21e | 5590 | |
a6d8037e | 5591 | In scalar context, returns the number of fields found. |
a0d0e21e | 5592 | |
7660c0ab | 5593 | If EXPR is omitted, splits the C<$_> string. If PATTERN is also omitted, |
4633a7c4 LW |
5594 | splits on whitespace (after skipping any leading whitespace). Anything |
5595 | matching PATTERN is taken to be a delimiter separating the fields. (Note | |
fb73857a | 5596 | that the delimiter may be longer than one character.) |
5597 | ||
836e0ee7 | 5598 | If LIMIT is specified and positive, it represents the maximum number |
e833de1e BS |
5599 | of fields the EXPR will be split into, though the actual number of |
5600 | fields returned depends on the number of times PATTERN matches within | |
5601 | EXPR. If LIMIT is unspecified or zero, trailing null fields are | |
5602 | stripped (which potential users of C<pop> would do well to remember). | |
5603 | If LIMIT is negative, it is treated as if an arbitrarily large LIMIT | |
5604 | had been specified. Note that splitting an EXPR that evaluates to the | |
5605 | empty string always returns the empty list, regardless of the LIMIT | |
5606 | specified. | |
a0d0e21e | 5607 | |
3b10bc60 | 5608 | A pattern matching the empty string (not to be confused with |
5609 | an empty pattern C<//>, which is just one member of the set of patterns | |
5610 | matching the epmty string), splits EXPR into individual | |
5611 | characters. For example: | |
a0d0e21e | 5612 | |
8241c1c0 | 5613 | print join(':', split(/ */, 'hi there')), "\n"; |
a0d0e21e LW |
5614 | |
5615 | produces the output 'h:i:t:h:e:r:e'. | |
5616 | ||
3b10bc60 | 5617 | As a special case for C<split>, the empty pattern C<//> specifically |
5618 | matches the empty string; this is not be confused with the normal use | |
5619 | of an empty pattern to mean the last successful match. So to split | |
5620 | a string into individual characters, the following: | |
6de67870 | 5621 | |
8241c1c0 | 5622 | print join(':', split(//, 'hi there')), "\n"; |
52ea55c9 | 5623 | |
de5763b0 | 5624 | produces the output 'h:i: :t:h:e:r:e'. |
52ea55c9 | 5625 | |
12977212 FC |
5626 | Empty leading fields are produced when there are positive-width matches at |
5627 | the beginning of the string; a zero-width match at the beginning of | |
5628 | the string does not produce an empty field. For example: | |
0156e0fd RB |
5629 | |
5630 | print join(':', split(/(?=\w)/, 'hi there!')); | |
5631 | ||
12977212 FC |
5632 | produces the output 'h:i :t:h:e:r:e!'. Empty trailing fields, on the other |
5633 | hand, are produced when there is a match at the end of the string (and | |
5634 | when LIMIT is given and is not 0), regardless of the length of the match. | |
5635 | For example: | |
5636 | ||
8241c1c0 B |
5637 | print join(':', split(//, 'hi there!', -1)), "\n"; |
5638 | print join(':', split(/\W/, 'hi there!', -1)), "\n"; | |
12977212 FC |
5639 | |
5640 | produce the output 'h:i: :t:h:e:r:e:!:' and 'hi:there:', respectively, | |
5641 | both with an empty trailing field. | |
0156e0fd | 5642 | |
5f05dabc | 5643 | The LIMIT parameter can be used to split a line partially |
a0d0e21e LW |
5644 | |
5645 | ($login, $passwd, $remainder) = split(/:/, $_, 3); | |
5646 | ||
b5da07fd TB |
5647 | When assigning to a list, if LIMIT is omitted, or zero, Perl supplies |
5648 | a LIMIT one larger than the number of variables in the list, to avoid | |
a0d0e21e LW |
5649 | unnecessary work. For the list above LIMIT would have been 4 by |
5650 | default. In time critical applications it behooves you not to split | |
5651 | into more fields than you really need. | |
5652 | ||
19799a22 | 5653 | If the PATTERN contains parentheses, additional list elements are |
a0d0e21e LW |
5654 | created from each matching substring in the delimiter. |
5655 | ||
da0045b7 | 5656 | split(/([,-])/, "1-10,20", 3); |
a0d0e21e LW |
5657 | |
5658 | produces the list value | |
5659 | ||
5660 | (1, '-', 10, ',', 20) | |
5661 | ||
19799a22 | 5662 | If you had the entire header of a normal Unix email message in $header, |
4633a7c4 LW |
5663 | you could split it up into fields and their values this way: |
5664 | ||
9f4b9cd0 | 5665 | $header =~ s/\n(?=\s)//g; # fix continuation lines |
fb73857a | 5666 | %hdrs = (UNIX_FROM => split /^(\S*?):\s*/m, $header); |
4633a7c4 | 5667 | |
a0d0e21e LW |
5668 | The pattern C</PATTERN/> may be replaced with an expression to specify |
5669 | patterns that vary at runtime. (To do runtime compilation only once, | |
748a9306 LW |
5670 | use C</$variable/o>.) |
5671 | ||
5da728e2 A |
5672 | As a special case, specifying a PATTERN of space (S<C<' '>>) will split on |
5673 | white space just as C<split> with no arguments does. Thus, S<C<split(' ')>> can | |
5674 | be used to emulate B<awk>'s default behavior, whereas S<C<split(/ /)>> | |
3b10bc60 | 5675 | will give you as many initial null fields (empty string) as there are leading spaces. |
5da728e2 | 5676 | A C<split> on C</\s+/> is like a S<C<split(' ')>> except that any leading |
19799a22 | 5677 | whitespace produces a null first field. A C<split> with no arguments |
5da728e2 | 5678 | really does a S<C<split(' ', $_)>> internally. |
a0d0e21e | 5679 | |
cc50a203 | 5680 | A PATTERN of C</^/> is treated as if it were C</^/m>, since it isn't |
1ec94568 MG |
5681 | much use otherwise. |
5682 | ||
a0d0e21e LW |
5683 | Example: |
5684 | ||
5a964f20 TC |
5685 | open(PASSWD, '/etc/passwd'); |
5686 | while (<PASSWD>) { | |
5b3eff12 MS |
5687 | chomp; |
5688 | ($login, $passwd, $uid, $gid, | |
f86cebdf | 5689 | $gcos, $home, $shell) = split(/:/); |
a9a5a0dc | 5690 | #... |
a0d0e21e LW |
5691 | } |
5692 | ||
6de67870 JP |
5693 | As with regular pattern matching, any capturing parentheses that are not |
5694 | matched in a C<split()> will be set to C<undef> when returned: | |
5695 | ||
5696 | @fields = split /(A)|B/, "1A2B3"; | |
5697 | # @fields is (1, 'A', 2, undef, 3) | |
a0d0e21e | 5698 | |
5f05dabc | 5699 | =item sprintf FORMAT, LIST |
d74e8afc | 5700 | X<sprintf> |
a0d0e21e | 5701 | |
6662521e GS |
5702 | Returns a string formatted by the usual C<printf> conventions of the C |
5703 | library function C<sprintf>. See below for more details | |
f4084e39 | 5704 | and see C<sprintf(3)> or C<printf(3)> on your system for an explanation of |
6662521e GS |
5705 | the general principles. |
5706 | ||
5707 | For example: | |
5708 | ||
5709 | # Format number with up to 8 leading zeroes | |
5710 | $result = sprintf("%08d", $number); | |
5711 | ||
5712 | # Round number to 3 digits after decimal point | |
5713 | $rounded = sprintf("%.3f", $number); | |
74a77017 | 5714 | |
3b10bc60 | 5715 | Perl does its own C<sprintf> formatting: it emulates the C |
5716 | function sprintf(3), but doesn't use it except for floating-point | |
5717 | numbers, and even then only standard modifiers are allowed. | |
5718 | Non-standard extensions in your local sprintf(3) are | |
5719 | therefore unavailable from Perl. | |
74a77017 | 5720 | |
194e7b38 DC |
5721 | Unlike C<printf>, C<sprintf> does not do what you probably mean when you |
5722 | pass it an array as your first argument. The array is given scalar context, | |
5723 | and instead of using the 0th element of the array as the format, Perl will | |
5724 | use the count of elements in the array as the format, which is almost never | |
5725 | useful. | |
5726 | ||
19799a22 | 5727 | Perl's C<sprintf> permits the following universally-known conversions: |
74a77017 | 5728 | |
5ed4f2ec | 5729 | %% a percent sign |
5730 | %c a character with the given number | |
5731 | %s a string | |
5732 | %d a signed integer, in decimal | |
5733 | %u an unsigned integer, in decimal | |
5734 | %o an unsigned integer, in octal | |
5735 | %x an unsigned integer, in hexadecimal | |
5736 | %e a floating-point number, in scientific notation | |
5737 | %f a floating-point number, in fixed decimal notation | |
5738 | %g a floating-point number, in %e or %f notation | |
74a77017 | 5739 | |
1b3f7d21 | 5740 | In addition, Perl permits the following widely-supported conversions: |
74a77017 | 5741 | |
5ed4f2ec | 5742 | %X like %x, but using upper-case letters |
5743 | %E like %e, but using an upper-case "E" | |
5744 | %G like %g, but with an upper-case "E" (if applicable) | |
5745 | %b an unsigned integer, in binary | |
5746 | %B like %b, but using an upper-case "B" with the # flag | |
5747 | %p a pointer (outputs the Perl value's address in hexadecimal) | |
5748 | %n special: *stores* the number of characters output so far | |
b76cc8ba | 5749 | into the next variable in the parameter list |
74a77017 | 5750 | |
1b3f7d21 CS |
5751 | Finally, for backward (and we do mean "backward") compatibility, Perl |
5752 | permits these unnecessary but widely-supported conversions: | |
74a77017 | 5753 | |
5ed4f2ec | 5754 | %i a synonym for %d |
5755 | %D a synonym for %ld | |
5756 | %U a synonym for %lu | |
5757 | %O a synonym for %lo | |
5758 | %F a synonym for %f | |
74a77017 | 5759 | |
7b8dd722 HS |
5760 | Note that the number of exponent digits in the scientific notation produced |
5761 | by C<%e>, C<%E>, C<%g> and C<%G> for numbers with the modulus of the | |
b73fd64e JH |
5762 | exponent less than 100 is system-dependent: it may be three or less |
5763 | (zero-padded as necessary). In other words, 1.23 times ten to the | |
5764 | 99th may be either "1.23e99" or "1.23e099". | |
d764f01a | 5765 | |
80d38338 | 5766 | Between the C<%> and the format letter, you may specify several |
7b8dd722 HS |
5767 | additional attributes controlling the interpretation of the format. |
5768 | In order, these are: | |
74a77017 | 5769 | |
7b8dd722 HS |
5770 | =over 4 |
5771 | ||
5772 | =item format parameter index | |
5773 | ||
5774 | An explicit format parameter index, such as C<2$>. By default sprintf | |
5775 | will format the next unused argument in the list, but this allows you | |
3b10bc60 | 5776 | to take the arguments out of order: |
7b8dd722 HS |
5777 | |
5778 | printf '%2$d %1$d', 12, 34; # prints "34 12" | |
5779 | printf '%3$d %d %1$d', 1, 2, 3; # prints "3 1 1" | |
5780 | ||
5781 | =item flags | |
5782 | ||
5783 | one or more of: | |
e6bb52fd | 5784 | |
7a81c58e A |
5785 | space prefix non-negative number with a space |
5786 | + prefix non-negative number with a plus sign | |
74a77017 CS |
5787 | - left-justify within the field |
5788 | 0 use zeros, not spaces, to right-justify | |
e6bb52fd TS |
5789 | # ensure the leading "0" for any octal, |
5790 | prefix non-zero hexadecimal with "0x" or "0X", | |
5791 | prefix non-zero binary with "0b" or "0B" | |
7b8dd722 HS |
5792 | |
5793 | For example: | |
5794 | ||
e6bb52fd TS |
5795 | printf '<% d>', 12; # prints "< 12>" |
5796 | printf '<%+d>', 12; # prints "<+12>" | |
5797 | printf '<%6s>', 12; # prints "< 12>" | |
5798 | printf '<%-6s>', 12; # prints "<12 >" | |
5799 | printf '<%06s>', 12; # prints "<000012>" | |
5800 | printf '<%#o>', 12; # prints "<014>" | |
5801 | printf '<%#x>', 12; # prints "<0xc>" | |
5802 | printf '<%#X>', 12; # prints "<0XC>" | |
5803 | printf '<%#b>', 12; # prints "<0b1100>" | |
5804 | printf '<%#B>', 12; # prints "<0B1100>" | |
7b8dd722 | 5805 | |
9911cee9 TS |
5806 | When a space and a plus sign are given as the flags at once, |
5807 | a plus sign is used to prefix a positive number. | |
5808 | ||
5809 | printf '<%+ d>', 12; # prints "<+12>" | |
5810 | printf '<% +d>', 12; # prints "<+12>" | |
5811 | ||
e6bb52fd TS |
5812 | When the # flag and a precision are given in the %o conversion, |
5813 | the precision is incremented if it's necessary for the leading "0". | |
5814 | ||
5815 | printf '<%#.5o>', 012; # prints "<00012>" | |
5816 | printf '<%#.5o>', 012345; # prints "<012345>" | |
5817 | printf '<%#.0o>', 0; # prints "<0>" | |
5818 | ||
7b8dd722 HS |
5819 | =item vector flag |
5820 | ||
3b10bc60 | 5821 | This flag tells Perl to interpret the supplied string as a vector of |
920f3fa9 DM |
5822 | integers, one for each character in the string. Perl applies the format to |
5823 | each integer in turn, then joins the resulting strings with a separator (a | |
5824 | dot C<.> by default). This can be useful for displaying ordinal values of | |
5825 | characters in arbitrary strings: | |
7b8dd722 | 5826 | |
920f3fa9 | 5827 | printf "%vd", "AB\x{100}"; # prints "65.66.256" |
7b8dd722 HS |
5828 | printf "version is v%vd\n", $^V; # Perl's version |
5829 | ||
5830 | Put an asterisk C<*> before the C<v> to override the string to | |
5831 | use to separate the numbers: | |
5832 | ||
5833 | printf "address is %*vX\n", ":", $addr; # IPv6 address | |
5834 | printf "bits are %0*v8b\n", " ", $bits; # random bitstring | |
5835 | ||
5836 | You can also explicitly specify the argument number to use for | |
3b10bc60 | 5837 | the join string using something like C<*2$v>; for example: |
7b8dd722 HS |
5838 | |
5839 | printf '%*4$vX %*4$vX %*4$vX', @addr[1..3], ":"; # 3 IPv6 addresses | |
5840 | ||
5841 | =item (minimum) width | |
5842 | ||
5843 | Arguments are usually formatted to be only as wide as required to | |
5844 | display the given value. You can override the width by putting | |
5845 | a number here, or get the width from the next argument (with C<*>) | |
3b10bc60 | 5846 | or from a specified argument (e.g., with C<*2$>): |
7b8dd722 HS |
5847 | |
5848 | printf '<%s>', "a"; # prints "<a>" | |
5849 | printf '<%6s>', "a"; # prints "< a>" | |
5850 | printf '<%*s>', 6, "a"; # prints "< a>" | |
5851 | printf '<%*2$s>', "a", 6; # prints "< a>" | |
5852 | printf '<%2s>', "long"; # prints "<long>" (does not truncate) | |
5853 | ||
19799a22 GS |
5854 | If a field width obtained through C<*> is negative, it has the same |
5855 | effect as the C<-> flag: left-justification. | |
74a77017 | 5856 | |
7b8dd722 | 5857 | =item precision, or maximum width |
d74e8afc | 5858 | X<precision> |
7b8dd722 | 5859 | |
6c8c9a8e | 5860 | You can specify a precision (for numeric conversions) or a maximum |
7b8dd722 | 5861 | width (for string conversions) by specifying a C<.> followed by a number. |
3b10bc60 | 5862 | For floating-point formats except 'g' and 'G', this specifies |
5863 | how many places right of the decimal point to show (the default being 6). | |
5864 | For example: | |
7b8dd722 HS |
5865 | |
5866 | # these examples are subject to system-specific variation | |
5867 | printf '<%f>', 1; # prints "<1.000000>" | |
5868 | printf '<%.1f>', 1; # prints "<1.0>" | |
5869 | printf '<%.0f>', 1; # prints "<1>" | |
5870 | printf '<%e>', 10; # prints "<1.000000e+01>" | |
5871 | printf '<%.1e>', 10; # prints "<1.0e+01>" | |
5872 | ||
3b10bc60 | 5873 | For "g" and "G", this specifies the maximum number of digits to show, |
5874 | including thoe prior to the decimal point and those after it; for | |
5875 | example: | |
1ff2d182 | 5876 | |
3b10bc60 | 5877 | # These examples are subject to system-specific variation. |
1ff2d182 AS |
5878 | printf '<%g>', 1; # prints "<1>" |
5879 | printf '<%.10g>', 1; # prints "<1>" | |
5880 | printf '<%g>', 100; # prints "<100>" | |
5881 | printf '<%.1g>', 100; # prints "<1e+02>" | |
5882 | printf '<%.2g>', 100.01; # prints "<1e+02>" | |
5883 | printf '<%.5g>', 100.01; # prints "<100.01>" | |
5884 | printf '<%.4g>', 100.01; # prints "<100>" | |
5885 | ||
7b8dd722 | 5886 | For integer conversions, specifying a precision implies that the |
9911cee9 TS |
5887 | output of the number itself should be zero-padded to this width, |
5888 | where the 0 flag is ignored: | |
5889 | ||
5890 | printf '<%.6d>', 1; # prints "<000001>" | |
5891 | printf '<%+.6d>', 1; # prints "<+000001>" | |
5892 | printf '<%-10.6d>', 1; # prints "<000001 >" | |
5893 | printf '<%10.6d>', 1; # prints "< 000001>" | |
5894 | printf '<%010.6d>', 1; # prints "< 000001>" | |
5895 | printf '<%+10.6d>', 1; # prints "< +000001>" | |
7b8dd722 HS |
5896 | |
5897 | printf '<%.6x>', 1; # prints "<000001>" | |
5898 | printf '<%#.6x>', 1; # prints "<0x000001>" | |
5899 | printf '<%-10.6x>', 1; # prints "<000001 >" | |
9911cee9 TS |
5900 | printf '<%10.6x>', 1; # prints "< 000001>" |
5901 | printf '<%010.6x>', 1; # prints "< 000001>" | |
5902 | printf '<%#10.6x>', 1; # prints "< 0x000001>" | |
7b8dd722 HS |
5903 | |
5904 | For string conversions, specifying a precision truncates the string | |
3b10bc60 | 5905 | to fit the specified width: |
7b8dd722 HS |
5906 | |
5907 | printf '<%.5s>', "truncated"; # prints "<trunc>" | |
5908 | printf '<%10.5s>', "truncated"; # prints "< trunc>" | |
5909 | ||
5910 | You can also get the precision from the next argument using C<.*>: | |
b22c7a20 | 5911 | |
7b8dd722 HS |
5912 | printf '<%.6x>', 1; # prints "<000001>" |
5913 | printf '<%.*x>', 6, 1; # prints "<000001>" | |
5914 | ||
3b10bc60 | 5915 | If a precision obtained through C<*> is negative, it counts |
5916 | as having no precision at all. | |
9911cee9 TS |
5917 | |
5918 | printf '<%.*s>', 7, "string"; # prints "<string>" | |
5919 | printf '<%.*s>', 3, "string"; # prints "<str>" | |
5920 | printf '<%.*s>', 0, "string"; # prints "<>" | |
5921 | printf '<%.*s>', -1, "string"; # prints "<string>" | |
5922 | ||
5923 | printf '<%.*d>', 1, 0; # prints "<0>" | |
5924 | printf '<%.*d>', 0, 0; # prints "<>" | |
5925 | printf '<%.*d>', -1, 0; # prints "<0>" | |
5926 | ||
7b8dd722 | 5927 | You cannot currently get the precision from a specified number, |
3b10bc60 | 5928 | but it is intended that this will be possible in the future, for |
5929 | example using C<.*2$>: | |
7b8dd722 | 5930 | |
3b10bc60 | 5931 | printf "<%.*2$x>", 1, 6; # INVALID, but in future will print "<000001>" |
7b8dd722 HS |
5932 | |
5933 | =item size | |
5934 | ||
5935 | For numeric conversions, you can specify the size to interpret the | |
1ff2d182 AS |
5936 | number as using C<l>, C<h>, C<V>, C<q>, C<L>, or C<ll>. For integer |
5937 | conversions (C<d u o x X b i D U O>), numbers are usually assumed to be | |
5938 | whatever the default integer size is on your platform (usually 32 or 64 | |
5939 | bits), but you can override this to use instead one of the standard C types, | |
5940 | as supported by the compiler used to build Perl: | |
7b8dd722 HS |
5941 | |
5942 | l interpret integer as C type "long" or "unsigned long" | |
5943 | h interpret integer as C type "short" or "unsigned short" | |
1ff2d182 AS |
5944 | q, L or ll interpret integer as C type "long long", "unsigned long long". |
5945 | or "quads" (typically 64-bit integers) | |
7b8dd722 | 5946 | |
3b10bc60 | 5947 | The last will raise an exception if Perl does not understand "quads" in your |
5948 | installation. (This requires either that the platform natively support quads, | |
5949 | or that Perl were specifically compiled to support quads.) You can find out | |
1ff2d182 | 5950 | whether your Perl supports quads via L<Config>: |
7b8dd722 | 5951 | |
5ed4f2ec | 5952 | use Config; |
3b10bc60 | 5953 | if ($Config{use64bitint} eq "define" || $Config{longsize} >= 8) { |
5954 | print "Nice quads!\n"; | |
5955 | } | |
1ff2d182 | 5956 | |
3b10bc60 | 5957 | For floating-point conversions (C<e f g E F G>), numbers are usually assumed |
5958 | to be the default floating-point size on your platform (double or long double), | |
5959 | but you can force "long double" with C<q>, C<L>, or C<ll> if your | |
1ff2d182 AS |
5960 | platform supports them. You can find out whether your Perl supports long |
5961 | doubles via L<Config>: | |
5962 | ||
5ed4f2ec | 5963 | use Config; |
3b10bc60 | 5964 | print "long doubles\n" if $Config{d_longdbl} eq "define"; |
1ff2d182 | 5965 | |
3b10bc60 | 5966 | You can find out whether Perl considers "long double" to be the default |
5967 | floating-point size to use on your platform via L<Config>: | |
1ff2d182 | 5968 | |
3b10bc60 | 5969 | use Config; |
5970 | if ($Config{uselongdouble} eq "define") { | |
5971 | print "long doubles by default\n"; | |
5972 | } | |
1ff2d182 | 5973 | |
3b10bc60 | 5974 | It can also be that long doubles and doubles are the same thing: |
1ff2d182 AS |
5975 | |
5976 | use Config; | |
5977 | ($Config{doublesize} == $Config{longdblsize}) && | |
5978 | print "doubles are long doubles\n"; | |
5979 | ||
3b10bc60 | 5980 | The size specifier C<V> has no effect for Perl code, but is supported for |
5981 | compatibility with XS code. It means "use the standard size for a Perl | |
5982 | integer or floating-point number", which is the default. | |
7b8dd722 | 5983 | |
a472f209 HS |
5984 | =item order of arguments |
5985 | ||
3b10bc60 | 5986 | Normally, sprintf() takes the next unused argument as the value to |
a472f209 HS |
5987 | format for each format specification. If the format specification |
5988 | uses C<*> to require additional arguments, these are consumed from | |
3b10bc60 | 5989 | the argument list in the order they appear in the format |
5990 | specification I<before> the value to format. Where an argument is | |
5991 | specified by an explicit index, this does not affect the normal | |
5992 | order for the arguments, even when the explicitly specified index | |
5993 | would have been the next argument. | |
a472f209 HS |
5994 | |
5995 | So: | |
5996 | ||
3b10bc60 | 5997 | printf "<%*.*s>", $a, $b, $c; |
a472f209 | 5998 | |
3b10bc60 | 5999 | uses C<$a> for the width, C<$b> for the precision, and C<$c> |
6000 | as the value to format; while: | |
a472f209 | 6001 | |
3b10bc60 | 6002 | printf "<%*1$.*s>", $a, $b; |
a472f209 | 6003 | |
3b10bc60 | 6004 | would use C<$a> for the width and precision, and C<$b> as the |
a472f209 HS |
6005 | value to format. |
6006 | ||
3b10bc60 | 6007 | Here are some more examples; be aware that when using an explicit |
6008 | index, the C<$> may need escaping: | |
a472f209 | 6009 | |
5ed4f2ec | 6010 | printf "%2\$d %d\n", 12, 34; # will print "34 12\n" |
6011 | printf "%2\$d %d %d\n", 12, 34; # will print "34 12 34\n" | |
6012 | printf "%3\$d %d %d\n", 12, 34, 56; # will print "56 12 34\n" | |
6013 | printf "%2\$*3\$d %d\n", 12, 34, 3; # will print " 34 12\n" | |
a472f209 | 6014 | |
7b8dd722 | 6015 | =back |
b22c7a20 | 6016 | |
3b10bc60 | 6017 | If C<use locale> is in effect and POSIX::setlocale() has been called, |
6018 | the character used for the decimal separator in formatted floating-point | |
6019 | numbers is affected by the LC_NUMERIC locale. See L<perllocale> | |
7e4353e9 | 6020 | and L<POSIX>. |
a0d0e21e LW |
6021 | |
6022 | =item sqrt EXPR | |
d74e8afc | 6023 | X<sqrt> X<root> X<square root> |
a0d0e21e | 6024 | |
54310121 | 6025 | =item sqrt |
bbce6d69 | 6026 | |
3b10bc60 | 6027 | Return the positive square root of EXPR. If EXPR is omitted, uses |
6028 | C<$_>. Works only for non-negative operands unless you've | |
6029 | loaded the C<Math::Complex> module. | |
2b5ab1e7 TC |
6030 | |
6031 | use Math::Complex; | |
3b10bc60 | 6032 | print sqrt(-4); # prints 2i |
a0d0e21e LW |
6033 | |
6034 | =item srand EXPR | |
d74e8afc | 6035 | X<srand> X<seed> X<randseed> |
a0d0e21e | 6036 | |
93dc8474 CS |
6037 | =item srand |
6038 | ||
0686c0b8 JH |
6039 | Sets the random number seed for the C<rand> operator. |
6040 | ||
0686c0b8 JH |
6041 | The point of the function is to "seed" the C<rand> function so that |
6042 | C<rand> can produce a different sequence each time you run your | |
e0b236fe | 6043 | program. |
0686c0b8 | 6044 | |
e0b236fe | 6045 | If srand() is not called explicitly, it is called implicitly at the |
3b10bc60 | 6046 | first use of the C<rand> operator. However, this was not true of |
e0b236fe JH |
6047 | versions of Perl before 5.004, so if your script will run under older |
6048 | Perl versions, it should call C<srand>. | |
93dc8474 | 6049 | |
e0b236fe JH |
6050 | Most programs won't even call srand() at all, except those that |
6051 | need a cryptographically-strong starting point rather than the | |
6052 | generally acceptable default, which is based on time of day, | |
3b10bc60 | 6053 | process ID, and memory allocation, or the F</dev/urandom> device |
67408cae | 6054 | if available. |
9be67dbc | 6055 | |
e0b236fe JH |
6056 | You can call srand($seed) with the same $seed to reproduce the |
6057 | I<same> sequence from rand(), but this is usually reserved for | |
6058 | generating predictable results for testing or debugging. | |
6059 | Otherwise, don't call srand() more than once in your program. | |
0686c0b8 | 6060 | |
80d38338 | 6061 | Do B<not> call srand() (i.e., without an argument) more than once in |
3a3e71eb | 6062 | a script. The internal state of the random number generator should |
0686c0b8 | 6063 | contain more entropy than can be provided by any seed, so calling |
e0b236fe | 6064 | srand() again actually I<loses> randomness. |
0686c0b8 | 6065 | |
e0b236fe JH |
6066 | Most implementations of C<srand> take an integer and will silently |
6067 | truncate decimal numbers. This means C<srand(42)> will usually | |
6068 | produce the same results as C<srand(42.1)>. To be safe, always pass | |
6069 | C<srand> an integer. | |
0686c0b8 JH |
6070 | |
6071 | In versions of Perl prior to 5.004 the default seed was just the | |
6072 | current C<time>. This isn't a particularly good seed, so many old | |
6073 | programs supply their own seed value (often C<time ^ $$> or C<time ^ | |
6074 | ($$ + ($$ << 15))>), but that isn't necessary any more. | |
93dc8474 | 6075 | |
cf264981 SP |
6076 | For cryptographic purposes, however, you need something much more random |
6077 | than the default seed. Checksumming the compressed output of one or more | |
2f9daede TP |
6078 | rapidly changing operating system status programs is the usual method. For |
6079 | example: | |
28757baa | 6080 | |
784d6566 | 6081 | srand (time ^ $$ ^ unpack "%L*", `ps axww | gzip -f`); |
28757baa | 6082 | |
7660c0ab | 6083 | If you're particularly concerned with this, see the C<Math::TrulyRandom> |
0078ec44 RS |
6084 | module in CPAN. |
6085 | ||
54310121 | 6086 | Frequently called programs (like CGI scripts) that simply use |
28757baa | 6087 | |
6088 | time ^ $$ | |
6089 | ||
54310121 | 6090 | for a seed can fall prey to the mathematical property that |
28757baa | 6091 | |
6092 | a^b == (a+1)^(b+1) | |
6093 | ||
0078ec44 | 6094 | one-third of the time. So don't do that. |
f86702cc | 6095 | |
a0d0e21e | 6096 | =item stat FILEHANDLE |
435fbc73 | 6097 | X<stat> X<file, status> X<ctime> |
a0d0e21e LW |
6098 | |
6099 | =item stat EXPR | |
6100 | ||
5228a96c SP |
6101 | =item stat DIRHANDLE |
6102 | ||
54310121 | 6103 | =item stat |
bbce6d69 | 6104 | |
1d2dff63 | 6105 | Returns a 13-element list giving the status info for a file, either |
5228a96c | 6106 | the file opened via FILEHANDLE or DIRHANDLE, or named by EXPR. If EXPR is |
3b10bc60 | 6107 | omitted, it stats C<$_>. Returns the empty list if C<stat> fails. Typically |
5228a96c | 6108 | used as follows: |
a0d0e21e LW |
6109 | |
6110 | ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size, | |
6111 | $atime,$mtime,$ctime,$blksize,$blocks) | |
6112 | = stat($filename); | |
6113 | ||
54310121 | 6114 | Not all fields are supported on all filesystem types. Here are the |
61967be2 | 6115 | meanings of the fields: |
c07a80fd | 6116 | |
54310121 | 6117 | 0 dev device number of filesystem |
6118 | 1 ino inode number | |
6119 | 2 mode file mode (type and permissions) | |
6120 | 3 nlink number of (hard) links to the file | |
6121 | 4 uid numeric user ID of file's owner | |
6122 | 5 gid numeric group ID of file's owner | |
6123 | 6 rdev the device identifier (special files only) | |
6124 | 7 size total size of file, in bytes | |
1c74f1bd GS |
6125 | 8 atime last access time in seconds since the epoch |
6126 | 9 mtime last modify time in seconds since the epoch | |
df2a7e48 | 6127 | 10 ctime inode change time in seconds since the epoch (*) |
54310121 | 6128 | 11 blksize preferred block size for file system I/O |
6129 | 12 blocks actual number of blocks allocated | |
c07a80fd | 6130 | |
6131 | (The epoch was at 00:00 January 1, 1970 GMT.) | |
6132 | ||
3e2557b2 RGS |
6133 | (*) Not all fields are supported on all filesystem types. Notably, the |
6134 | ctime field is non-portable. In particular, you cannot expect it to be a | |
6135 | "creation time", see L<perlport/"Files and Filesystems"> for details. | |
df2a7e48 | 6136 | |
61967be2 | 6137 | If C<stat> is passed the special filehandle consisting of an underline, no |
a0d0e21e | 6138 | stat is done, but the current contents of the stat structure from the |
61967be2 | 6139 | last C<stat>, C<lstat>, or filetest are returned. Example: |
a0d0e21e LW |
6140 | |
6141 | if (-x $file && (($d) = stat(_)) && $d < 0) { | |
a9a5a0dc | 6142 | print "$file is executable NFS file\n"; |
a0d0e21e LW |
6143 | } |
6144 | ||
ca6e1c26 JH |
6145 | (This works on machines only for which the device number is negative |
6146 | under NFS.) | |
a0d0e21e | 6147 | |
2b5ab1e7 | 6148 | Because the mode contains both the file type and its permissions, you |
b76cc8ba | 6149 | should mask off the file type portion and (s)printf using a C<"%o"> |
2b5ab1e7 TC |
6150 | if you want to see the real permissions. |
6151 | ||
6152 | $mode = (stat($filename))[2]; | |
6153 | printf "Permissions are %04o\n", $mode & 07777; | |
6154 | ||
19799a22 | 6155 | In scalar context, C<stat> returns a boolean value indicating success |
1d2dff63 GS |
6156 | or failure, and, if successful, sets the information associated with |
6157 | the special filehandle C<_>. | |
6158 | ||
dd184578 | 6159 | The L<File::stat> module provides a convenient, by-name access mechanism: |
2b5ab1e7 TC |
6160 | |
6161 | use File::stat; | |
6162 | $sb = stat($filename); | |
b76cc8ba | 6163 | printf "File is %s, size is %s, perm %04o, mtime %s\n", |
a9a5a0dc VP |
6164 | $filename, $sb->size, $sb->mode & 07777, |
6165 | scalar localtime $sb->mtime; | |
2b5ab1e7 | 6166 | |
ca6e1c26 JH |
6167 | You can import symbolic mode constants (C<S_IF*>) and functions |
6168 | (C<S_IS*>) from the Fcntl module: | |
6169 | ||
6170 | use Fcntl ':mode'; | |
6171 | ||
6172 | $mode = (stat($filename))[2]; | |
6173 | ||
6174 | $user_rwx = ($mode & S_IRWXU) >> 6; | |
6175 | $group_read = ($mode & S_IRGRP) >> 3; | |
6176 | $other_execute = $mode & S_IXOTH; | |
6177 | ||
3155e0b0 | 6178 | printf "Permissions are %04o\n", S_IMODE($mode), "\n"; |
ca6e1c26 JH |
6179 | |
6180 | $is_setuid = $mode & S_ISUID; | |
ad605d16 | 6181 | $is_directory = S_ISDIR($mode); |
ca6e1c26 JH |
6182 | |
6183 | You could write the last two using the C<-u> and C<-d> operators. | |
3b10bc60 | 6184 | Commonly available C<S_IF*> constants are: |
ca6e1c26 JH |
6185 | |
6186 | # Permissions: read, write, execute, for user, group, others. | |
6187 | ||
6188 | S_IRWXU S_IRUSR S_IWUSR S_IXUSR | |
6189 | S_IRWXG S_IRGRP S_IWGRP S_IXGRP | |
6190 | S_IRWXO S_IROTH S_IWOTH S_IXOTH | |
61eff3bc | 6191 | |
3cee8101 RGS |
6192 | # Setuid/Setgid/Stickiness/SaveText. |
6193 | # Note that the exact meaning of these is system dependent. | |
ca6e1c26 JH |
6194 | |
6195 | S_ISUID S_ISGID S_ISVTX S_ISTXT | |
6196 | ||
6197 | # File types. Not necessarily all are available on your system. | |
6198 | ||
135ed46b | 6199 | S_IFREG S_IFDIR S_IFLNK S_IFBLK S_IFCHR S_IFIFO S_IFSOCK S_IFWHT S_ENFMT |
ca6e1c26 JH |
6200 | |
6201 | # The following are compatibility aliases for S_IRUSR, S_IWUSR, S_IXUSR. | |
6202 | ||
6203 | S_IREAD S_IWRITE S_IEXEC | |
6204 | ||
61967be2 | 6205 | and the C<S_IF*> functions are |
ca6e1c26 | 6206 | |
5ed4f2ec | 6207 | S_IMODE($mode) the part of $mode containing the permission bits |
6208 | and the setuid/setgid/sticky bits | |
ca6e1c26 | 6209 | |
5ed4f2ec | 6210 | S_IFMT($mode) the part of $mode containing the file type |
3b10bc60 | 6211 | which can be bit-anded with (for example) S_IFREG |
ca6e1c26 JH |
6212 | or with the following functions |
6213 | ||
61967be2 | 6214 | # The operators -f, -d, -l, -b, -c, -p, and -S. |
ca6e1c26 JH |
6215 | |
6216 | S_ISREG($mode) S_ISDIR($mode) S_ISLNK($mode) | |
6217 | S_ISBLK($mode) S_ISCHR($mode) S_ISFIFO($mode) S_ISSOCK($mode) | |
6218 | ||
6219 | # No direct -X operator counterpart, but for the first one | |
6220 | # the -g operator is often equivalent. The ENFMT stands for | |
6221 | # record flocking enforcement, a platform-dependent feature. | |
6222 | ||
6223 | S_ISENFMT($mode) S_ISWHT($mode) | |
6224 | ||
6225 | See your native chmod(2) and stat(2) documentation for more details | |
61967be2 | 6226 | about the C<S_*> constants. To get status info for a symbolic link |
c837d5b4 | 6227 | instead of the target file behind the link, use the C<lstat> function. |
ca6e1c26 | 6228 | |
36fb85f3 RGS |
6229 | =item state EXPR |
6230 | X<state> | |
6231 | ||
6232 | =item state TYPE EXPR | |
6233 | ||
6234 | =item state EXPR : ATTRS | |
6235 | ||
6236 | =item state TYPE EXPR : ATTRS | |
6237 | ||
6238 | C<state> declares a lexically scoped variable, just like C<my> does. | |
b708784e | 6239 | However, those variables will never be reinitialized, contrary to |
36fb85f3 RGS |
6240 | lexical variables that are reinitialized each time their enclosing block |
6241 | is entered. | |
6242 | ||
3b10bc60 | 6243 | C<state> variables are enabled only when the C<use feature "state"> pragma |
6244 | is in effect. See L<feature>. | |
36fb85f3 | 6245 | |
a0d0e21e | 6246 | =item study SCALAR |
d74e8afc | 6247 | X<study> |
a0d0e21e LW |
6248 | |
6249 | =item study | |
6250 | ||
184e9718 | 6251 | Takes extra time to study SCALAR (C<$_> if unspecified) in anticipation of |
a0d0e21e LW |
6252 | doing many pattern matches on the string before it is next modified. |
6253 | This may or may not save time, depending on the nature and number of | |
6254 | patterns you are searching on, and on the distribution of character | |
3b10bc60 | 6255 | frequencies in the string to be searched; you probably want to compare |
5f05dabc | 6256 | run times with and without it to see which runs faster. Those loops |
cf264981 | 6257 | that scan for many short constant strings (including the constant |
a0d0e21e | 6258 | parts of more complex patterns) will benefit most. You may have only |
3b10bc60 | 6259 | one C<study> active at a time: if you study a different scalar the first |
19799a22 | 6260 | is "unstudied". (The way C<study> works is this: a linked list of every |
a0d0e21e | 6261 | character in the string to be searched is made, so we know, for |
7660c0ab | 6262 | example, where all the C<'k'> characters are. From each search string, |
a0d0e21e LW |
6263 | the rarest character is selected, based on some static frequency tables |
6264 | constructed from some C programs and English text. Only those places | |
6265 | that contain this "rarest" character are examined.) | |
6266 | ||
5a964f20 | 6267 | For example, here is a loop that inserts index producing entries |
a0d0e21e LW |
6268 | before any line containing a certain pattern: |
6269 | ||
6270 | while (<>) { | |
a9a5a0dc VP |
6271 | study; |
6272 | print ".IX foo\n" if /\bfoo\b/; | |
6273 | print ".IX bar\n" if /\bbar\b/; | |
6274 | print ".IX blurfl\n" if /\bblurfl\b/; | |
6275 | # ... | |
6276 | print; | |
a0d0e21e LW |
6277 | } |
6278 | ||
3b10bc60 | 6279 | In searching for C</\bfoo\b/>, only locations in C<$_> that contain C<f> |
951ba7fe | 6280 | will be looked at, because C<f> is rarer than C<o>. In general, this is |
a0d0e21e LW |
6281 | a big win except in pathological cases. The only question is whether |
6282 | it saves you more time than it took to build the linked list in the | |
6283 | first place. | |
6284 | ||
6285 | Note that if you have to look for strings that you don't know till | |
19799a22 | 6286 | runtime, you can build an entire loop as a string and C<eval> that to |
a0d0e21e | 6287 | avoid recompiling all your patterns all the time. Together with |
80d38338 | 6288 | undefining C<$/> to input entire files as one record, this can be quite |
f86cebdf | 6289 | fast, often faster than specialized programs like fgrep(1). The following |
184e9718 | 6290 | scans a list of files (C<@files>) for a list of words (C<@words>), and prints |
a0d0e21e LW |
6291 | out the names of those files that contain a match: |
6292 | ||
6293 | $search = 'while (<>) { study;'; | |
6294 | foreach $word (@words) { | |
a9a5a0dc | 6295 | $search .= "++\$seen{\$ARGV} if /\\b$word\\b/;\n"; |
a0d0e21e LW |
6296 | } |
6297 | $search .= "}"; | |
6298 | @ARGV = @files; | |
6299 | undef $/; | |
5ed4f2ec | 6300 | eval $search; # this screams |
6301 | $/ = "\n"; # put back to normal input delimiter | |
a0d0e21e | 6302 | foreach $file (sort keys(%seen)) { |
a9a5a0dc | 6303 | print $file, "\n"; |
a0d0e21e LW |
6304 | } |
6305 | ||
1d2de774 | 6306 | =item sub NAME BLOCK |
d74e8afc | 6307 | X<sub> |
cb1a09d0 | 6308 | |
1d2de774 | 6309 | =item sub NAME (PROTO) BLOCK |
cb1a09d0 | 6310 | |
1d2de774 JH |
6311 | =item sub NAME : ATTRS BLOCK |
6312 | ||
6313 | =item sub NAME (PROTO) : ATTRS BLOCK | |
6314 | ||
6315 | This is subroutine definition, not a real function I<per se>. | |
6316 | Without a BLOCK it's just a forward declaration. Without a NAME, | |
6317 | it's an anonymous function declaration, and does actually return | |
6318 | a value: the CODE ref of the closure you just created. | |
cb1a09d0 | 6319 | |
1d2de774 | 6320 | See L<perlsub> and L<perlref> for details about subroutines and |
0795dc2b | 6321 | references, and L<attributes> and L<Attribute::Handlers> for more |
1d2de774 | 6322 | information about attributes. |
cb1a09d0 | 6323 | |
87275199 | 6324 | =item substr EXPR,OFFSET,LENGTH,REPLACEMENT |
d74e8afc | 6325 | X<substr> X<substring> X<mid> X<left> X<right> |
7b8d334a | 6326 | |
87275199 | 6327 | =item substr EXPR,OFFSET,LENGTH |
a0d0e21e LW |
6328 | |
6329 | =item substr EXPR,OFFSET | |
6330 | ||
6331 | Extracts a substring out of EXPR and returns it. First character is at | |
7660c0ab | 6332 | offset C<0>, or whatever you've set C<$[> to (but don't do that). |
84902520 | 6333 | If OFFSET is negative (or more precisely, less than C<$[>), starts |
87275199 GS |
6334 | that far from the end of the string. If LENGTH is omitted, returns |
6335 | everything to the end of the string. If LENGTH is negative, leaves that | |
748a9306 LW |
6336 | many characters off the end of the string. |
6337 | ||
e1de3ec0 | 6338 | my $s = "The black cat climbed the green tree"; |
5ed4f2ec | 6339 | my $color = substr $s, 4, 5; # black |
6340 | my $middle = substr $s, 4, -11; # black cat climbed the | |
6341 | my $end = substr $s, 14; # climbed the green tree | |
6342 | my $tail = substr $s, -4; # tree | |
6343 | my $z = substr $s, -4, 2; # tr | |
e1de3ec0 | 6344 | |
2b5ab1e7 | 6345 | You can use the substr() function as an lvalue, in which case EXPR |
87275199 GS |
6346 | must itself be an lvalue. If you assign something shorter than LENGTH, |
6347 | the string will shrink, and if you assign something longer than LENGTH, | |
2b5ab1e7 | 6348 | the string will grow to accommodate it. To keep the string the same |
3b10bc60 | 6349 | length, you may need to pad or chop your value using C<sprintf>. |
a0d0e21e | 6350 | |
87275199 GS |
6351 | If OFFSET and LENGTH specify a substring that is partly outside the |
6352 | string, only the part within the string is returned. If the substring | |
6353 | is beyond either end of the string, substr() returns the undefined | |
6354 | value and produces a warning. When used as an lvalue, specifying a | |
3b10bc60 | 6355 | substring that is entirely outside the string raises an exception. |
87275199 GS |
6356 | Here's an example showing the behavior for boundary cases: |
6357 | ||
6358 | my $name = 'fred'; | |
5ed4f2ec | 6359 | substr($name, 4) = 'dy'; # $name is now 'freddy' |
3b10bc60 | 6360 | my $null = substr $name, 6, 2; # returns "" (no warning) |
5ed4f2ec | 6361 | my $oops = substr $name, 7; # returns undef, with warning |
3b10bc60 | 6362 | substr($name, 7) = 'gap'; # raises an exception |
87275199 | 6363 | |
2b5ab1e7 | 6364 | An alternative to using substr() as an lvalue is to specify the |
7b8d334a | 6365 | replacement string as the 4th argument. This allows you to replace |
2b5ab1e7 TC |
6366 | parts of the EXPR and return what was there before in one operation, |
6367 | just as you can with splice(). | |
7b8d334a | 6368 | |
e1de3ec0 | 6369 | my $s = "The black cat climbed the green tree"; |
5ed4f2ec | 6370 | my $z = substr $s, 14, 7, "jumped from"; # climbed |
e1de3ec0 GS |
6371 | # $s is now "The black cat jumped from the green tree" |
6372 | ||
cf264981 | 6373 | Note that the lvalue returned by the 3-arg version of substr() acts as |
91f73676 DM |
6374 | a 'magic bullet'; each time it is assigned to, it remembers which part |
6375 | of the original string is being modified; for example: | |
6376 | ||
6377 | $x = '1234'; | |
6378 | for (substr($x,1,2)) { | |
5ed4f2ec | 6379 | $_ = 'a'; print $x,"\n"; # prints 1a4 |
6380 | $_ = 'xyz'; print $x,"\n"; # prints 1xyz4 | |
91f73676 | 6381 | $x = '56789'; |
5ed4f2ec | 6382 | $_ = 'pq'; print $x,"\n"; # prints 5pq9 |
91f73676 DM |
6383 | } |
6384 | ||
91f73676 DM |
6385 | Prior to Perl version 5.9.1, the result of using an lvalue multiple times was |
6386 | unspecified. | |
c67bbae0 | 6387 | |
a0d0e21e | 6388 | =item symlink OLDFILE,NEWFILE |
d74e8afc | 6389 | X<symlink> X<link> X<symbolic link> X<link, symbolic> |
a0d0e21e LW |
6390 | |
6391 | Creates a new filename symbolically linked to the old filename. | |
7660c0ab | 6392 | Returns C<1> for success, C<0> otherwise. On systems that don't support |
3b10bc60 | 6393 | symbolic links, raises an exception. To check for that, |
a0d0e21e LW |
6394 | use eval: |
6395 | ||
2b5ab1e7 | 6396 | $symlink_exists = eval { symlink("",""); 1 }; |
a0d0e21e | 6397 | |
5702da47 | 6398 | =item syscall NUMBER, LIST |
d74e8afc | 6399 | X<syscall> X<system call> |
a0d0e21e LW |
6400 | |
6401 | Calls the system call specified as the first element of the list, | |
6402 | passing the remaining elements as arguments to the system call. If | |
3b10bc60 | 6403 | unimplemented, raises an exception. The arguments are interpreted |
a0d0e21e LW |
6404 | as follows: if a given argument is numeric, the argument is passed as |
6405 | an int. If not, the pointer to the string value is passed. You are | |
6406 | responsible to make sure a string is pre-extended long enough to | |
a3cb178b | 6407 | receive any result that might be written into a string. You can't use a |
19799a22 | 6408 | string literal (or other read-only string) as an argument to C<syscall> |
a3cb178b GS |
6409 | because Perl has to assume that any string pointer might be written |
6410 | through. If your | |
a0d0e21e | 6411 | integer arguments are not literals and have never been interpreted in a |
7660c0ab | 6412 | numeric context, you may need to add C<0> to them to force them to look |
19799a22 | 6413 | like numbers. This emulates the C<syswrite> function (or vice versa): |
a0d0e21e | 6414 | |
5ed4f2ec | 6415 | require 'syscall.ph'; # may need to run h2ph |
a3cb178b GS |
6416 | $s = "hi there\n"; |
6417 | syscall(&SYS_write, fileno(STDOUT), $s, length $s); | |
a0d0e21e | 6418 | |
3b10bc60 | 6419 | Note that Perl supports passing of up to only 14 arguments to your syscall, |
6420 | which in practice should (usually) suffice. | |
a0d0e21e | 6421 | |
fb73857a | 6422 | Syscall returns whatever value returned by the system call it calls. |
19799a22 | 6423 | If the system call fails, C<syscall> returns C<-1> and sets C<$!> (errno). |
7660c0ab | 6424 | Note that some system calls can legitimately return C<-1>. The proper |
fb73857a | 6425 | way to handle such calls is to assign C<$!=0;> before the call and |
7660c0ab | 6426 | check the value of C<$!> if syscall returns C<-1>. |
fb73857a | 6427 | |
6428 | There's a problem with C<syscall(&SYS_pipe)>: it returns the file | |
6429 | number of the read end of the pipe it creates. There is no way | |
b76cc8ba | 6430 | to retrieve the file number of the other end. You can avoid this |
19799a22 | 6431 | problem by using C<pipe> instead. |
fb73857a | 6432 | |
c07a80fd | 6433 | =item sysopen FILEHANDLE,FILENAME,MODE |
d74e8afc | 6434 | X<sysopen> |
c07a80fd | 6435 | |
6436 | =item sysopen FILEHANDLE,FILENAME,MODE,PERMS | |
6437 | ||
6438 | Opens the file whose filename is given by FILENAME, and associates it | |
6439 | with FILEHANDLE. If FILEHANDLE is an expression, its value is used as | |
6440 | the name of the real filehandle wanted. This function calls the | |
19799a22 | 6441 | underlying operating system's C<open> function with the parameters |
c07a80fd | 6442 | FILENAME, MODE, PERMS. |
6443 | ||
6444 | The possible values and flag bits of the MODE parameter are | |
6445 | system-dependent; they are available via the standard module C<Fcntl>. | |
ea2b5ef6 JH |
6446 | See the documentation of your operating system's C<open> to see which |
6447 | values and flag bits are available. You may combine several flags | |
6448 | using the C<|>-operator. | |
6449 | ||
6450 | Some of the most common values are C<O_RDONLY> for opening the file in | |
6451 | read-only mode, C<O_WRONLY> for opening the file in write-only mode, | |
c188b257 | 6452 | and C<O_RDWR> for opening the file in read-write mode. |
d74e8afc | 6453 | X<O_RDONLY> X<O_RDWR> X<O_WRONLY> |
ea2b5ef6 | 6454 | |
adf5897a | 6455 | For historical reasons, some values work on almost every system |
3b10bc60 | 6456 | supported by Perl: 0 means read-only, 1 means write-only, and 2 |
adf5897a | 6457 | means read/write. We know that these values do I<not> work under |
7c5ffed3 | 6458 | OS/390 & VM/ESA Unix and on the Macintosh; you probably don't want to |
4af147f6 | 6459 | use them in new code. |
c07a80fd | 6460 | |
19799a22 | 6461 | If the file named by FILENAME does not exist and the C<open> call creates |
7660c0ab | 6462 | it (typically because MODE includes the C<O_CREAT> flag), then the value of |
5a964f20 | 6463 | PERMS specifies the permissions of the newly created file. If you omit |
19799a22 | 6464 | the PERMS argument to C<sysopen>, Perl uses the octal value C<0666>. |
5a964f20 | 6465 | These permission values need to be in octal, and are modified by your |
0591cd52 | 6466 | process's current C<umask>. |
d74e8afc | 6467 | X<O_CREAT> |
0591cd52 | 6468 | |
ea2b5ef6 JH |
6469 | In many systems the C<O_EXCL> flag is available for opening files in |
6470 | exclusive mode. This is B<not> locking: exclusiveness means here that | |
c188b257 PF |
6471 | if the file already exists, sysopen() fails. C<O_EXCL> may not work |
6472 | on network filesystems, and has no effect unless the C<O_CREAT> flag | |
6473 | is set as well. Setting C<O_CREAT|O_EXCL> prevents the file from | |
6474 | being opened if it is a symbolic link. It does not protect against | |
6475 | symbolic links in the file's path. | |
d74e8afc | 6476 | X<O_EXCL> |
c188b257 PF |
6477 | |
6478 | Sometimes you may want to truncate an already-existing file. This | |
6479 | can be done using the C<O_TRUNC> flag. The behavior of | |
6480 | C<O_TRUNC> with C<O_RDONLY> is undefined. | |
d74e8afc | 6481 | X<O_TRUNC> |
ea2b5ef6 | 6482 | |
19799a22 | 6483 | You should seldom if ever use C<0644> as argument to C<sysopen>, because |
2b5ab1e7 TC |
6484 | that takes away the user's option to have a more permissive umask. |
6485 | Better to omit it. See the perlfunc(1) entry on C<umask> for more | |
6486 | on this. | |
c07a80fd | 6487 | |
4af147f6 | 6488 | Note that C<sysopen> depends on the fdopen() C library function. |
e1020413 | 6489 | On many Unix systems, fdopen() is known to fail when file descriptors |
4af147f6 CS |
6490 | exceed a certain value, typically 255. If you need more file |
6491 | descriptors than that, consider rebuilding Perl to use the C<sfio> | |
6492 | library, or perhaps using the POSIX::open() function. | |
6493 | ||
2b5ab1e7 | 6494 | See L<perlopentut> for a kinder, gentler explanation of opening files. |
28757baa | 6495 | |
a0d0e21e | 6496 | =item sysread FILEHANDLE,SCALAR,LENGTH,OFFSET |
d74e8afc | 6497 | X<sysread> |
a0d0e21e LW |
6498 | |
6499 | =item sysread FILEHANDLE,SCALAR,LENGTH | |
6500 | ||
3874323d | 6501 | Attempts to read LENGTH bytes of data into variable SCALAR from the |
3b10bc60 | 6502 | specified FILEHANDLE, using the read(2). It bypasses |
3874323d JH |
6503 | buffered IO, so mixing this with other kinds of reads, C<print>, |
6504 | C<write>, C<seek>, C<tell>, or C<eof> can cause confusion because the | |
6505 | perlio or stdio layers usually buffers data. Returns the number of | |
6506 | bytes actually read, C<0> at end of file, or undef if there was an | |
6507 | error (in the latter case C<$!> is also set). SCALAR will be grown or | |
6508 | shrunk so that the last byte actually read is the last byte of the | |
6509 | scalar after the read. | |
ff68c719 | 6510 | |
6511 | An OFFSET may be specified to place the read data at some place in the | |
6512 | string other than the beginning. A negative OFFSET specifies | |
9124316e JH |
6513 | placement at that many characters counting backwards from the end of |
6514 | the string. A positive OFFSET greater than the length of SCALAR | |
6515 | results in the string being padded to the required size with C<"\0"> | |
6516 | bytes before the result of the read is appended. | |
a0d0e21e | 6517 | |
2b5ab1e7 | 6518 | There is no syseof() function, which is ok, since eof() doesn't work |
80d38338 | 6519 | well on device files (like ttys) anyway. Use sysread() and check |
19799a22 | 6520 | for a return value for 0 to decide whether you're done. |
2b5ab1e7 | 6521 | |
3874323d JH |
6522 | Note that if the filehandle has been marked as C<:utf8> Unicode |
6523 | characters are read instead of bytes (the LENGTH, OFFSET, and the | |
5eadf7c5 | 6524 | return value of sysread() are in Unicode characters). |
3874323d JH |
6525 | The C<:encoding(...)> layer implicitly introduces the C<:utf8> layer. |
6526 | See L</binmode>, L</open>, and the C<open> pragma, L<open>. | |
6527 | ||
137443ea | 6528 | =item sysseek FILEHANDLE,POSITION,WHENCE |
d74e8afc | 6529 | X<sysseek> X<lseek> |
137443ea | 6530 | |
3b10bc60 | 6531 | Sets FILEHANDLE's system position in bytes using |
9124316e JH |
6532 | lseek(2). FILEHANDLE may be an expression whose value gives the name |
6533 | of the filehandle. The values for WHENCE are C<0> to set the new | |
6534 | position to POSITION, C<1> to set the it to the current position plus | |
6535 | POSITION, and C<2> to set it to EOF plus POSITION (typically | |
6536 | negative). | |
6537 | ||
6538 | Note the I<in bytes>: even if the filehandle has been set to operate | |
740d4bb2 JW |
6539 | on characters (for example by using the C<:encoding(utf8)> I/O layer), |
6540 | tell() will return byte offsets, not character offsets (because | |
80d38338 | 6541 | implementing that would render sysseek() unacceptably slow). |
9124316e | 6542 | |
3874323d | 6543 | sysseek() bypasses normal buffered IO, so mixing this with reads (other |
aaa270e5 | 6544 | than C<sysread>, for example C<< <> >> or read()) C<print>, C<write>, |
9124316e | 6545 | C<seek>, C<tell>, or C<eof> may cause confusion. |
86989e5d JH |
6546 | |
6547 | For WHENCE, you may also use the constants C<SEEK_SET>, C<SEEK_CUR>, | |
6548 | and C<SEEK_END> (start of the file, current position, end of the file) | |
6549 | from the Fcntl module. Use of the constants is also more portable | |
6550 | than relying on 0, 1, and 2. For example to define a "systell" function: | |
6551 | ||
5ed4f2ec | 6552 | use Fcntl 'SEEK_CUR'; |
6553 | sub systell { sysseek($_[0], 0, SEEK_CUR) } | |
8903cb82 | 6554 | |
6555 | Returns the new position, or the undefined value on failure. A position | |
19799a22 GS |
6556 | of zero is returned as the string C<"0 but true">; thus C<sysseek> returns |
6557 | true on success and false on failure, yet you can still easily determine | |
8903cb82 | 6558 | the new position. |
137443ea | 6559 | |
a0d0e21e | 6560 | =item system LIST |
d74e8afc | 6561 | X<system> X<shell> |
a0d0e21e | 6562 | |
8bf3b016 GS |
6563 | =item system PROGRAM LIST |
6564 | ||
19799a22 GS |
6565 | Does exactly the same thing as C<exec LIST>, except that a fork is |
6566 | done first, and the parent process waits for the child process to | |
80d38338 | 6567 | exit. Note that argument processing varies depending on the |
19799a22 GS |
6568 | number of arguments. If there is more than one argument in LIST, |
6569 | or if LIST is an array with more than one value, starts the program | |
6570 | given by the first element of the list with arguments given by the | |
6571 | rest of the list. If there is only one scalar argument, the argument | |
6572 | is checked for shell metacharacters, and if there are any, the | |
6573 | entire argument is passed to the system's command shell for parsing | |
6574 | (this is C</bin/sh -c> on Unix platforms, but varies on other | |
6575 | platforms). If there are no shell metacharacters in the argument, | |
6576 | it is split into words and passed directly to C<execvp>, which is | |
6577 | more efficient. | |
6578 | ||
0f897271 GS |
6579 | Beginning with v5.6.0, Perl will attempt to flush all files opened for |
6580 | output before any operation that may do a fork, but this may not be | |
6581 | supported on some platforms (see L<perlport>). To be safe, you may need | |
6582 | to set C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method | |
6583 | of C<IO::Handle> on any open handles. | |
a2008d6d | 6584 | |
9d6eb86e | 6585 | The return value is the exit status of the program as returned by the |
25379e53 RGS |
6586 | C<wait> call. To get the actual exit value, shift right by eight (see |
6587 | below). See also L</exec>. This is I<not> what you want to use to capture | |
54310121 | 6588 | the output from a command, for that you should use merely backticks or |
d5a9bfb0 | 6589 | C<qx//>, as described in L<perlop/"`STRING`">. Return value of -1 |
25379e53 RGS |
6590 | indicates a failure to start the program or an error of the wait(2) system |
6591 | call (inspect $! for the reason). | |
a0d0e21e | 6592 | |
1af1c0d6 JV |
6593 | If you'd like to make C<system> (and many other bits of Perl) die on error, |
6594 | have a look at the L<autodie> pragma. | |
6595 | ||
19799a22 GS |
6596 | Like C<exec>, C<system> allows you to lie to a program about its name if |
6597 | you use the C<system PROGRAM LIST> syntax. Again, see L</exec>. | |
8bf3b016 | 6598 | |
4c2e8b59 BD |
6599 | Since C<SIGINT> and C<SIGQUIT> are ignored during the execution of |
6600 | C<system>, if you expect your program to terminate on receipt of these | |
6601 | signals you will need to arrange to do so yourself based on the return | |
6602 | value. | |
28757baa | 6603 | |
6604 | @args = ("command", "arg1", "arg2"); | |
54310121 | 6605 | system(@args) == 0 |
a9a5a0dc | 6606 | or die "system @args failed: $?" |
28757baa | 6607 | |
95da743b | 6608 | If you'd like to manually inspect C<system>'s failure, you can check all |
1af1c0d6 | 6609 | possible failure modes by inspecting C<$?> like this: |
28757baa | 6610 | |
4ef107a6 | 6611 | if ($? == -1) { |
a9a5a0dc | 6612 | print "failed to execute: $!\n"; |
4ef107a6 DM |
6613 | } |
6614 | elsif ($? & 127) { | |
a9a5a0dc VP |
6615 | printf "child died with signal %d, %s coredump\n", |
6616 | ($? & 127), ($? & 128) ? 'with' : 'without'; | |
4ef107a6 DM |
6617 | } |
6618 | else { | |
a9a5a0dc | 6619 | printf "child exited with value %d\n", $? >> 8; |
4ef107a6 DM |
6620 | } |
6621 | ||
3b10bc60 | 6622 | Alternatively, you may inspect the value of C<${^CHILD_ERROR_NATIVE}> |
6623 | with the C<W*()> calls from the POSIX module. | |
9d6eb86e | 6624 | |
3b10bc60 | 6625 | When C<system>'s arguments are executed indirectly by the shell, |
6626 | results and return codes are subject to its quirks. | |
c8db1d39 | 6627 | See L<perlop/"`STRING`"> and L</exec> for details. |
bb32b41a | 6628 | |
a0d0e21e | 6629 | =item syswrite FILEHANDLE,SCALAR,LENGTH,OFFSET |
d74e8afc | 6630 | X<syswrite> |
a0d0e21e LW |
6631 | |
6632 | =item syswrite FILEHANDLE,SCALAR,LENGTH | |
6633 | ||
145d37e2 GA |
6634 | =item syswrite FILEHANDLE,SCALAR |
6635 | ||
3874323d | 6636 | Attempts to write LENGTH bytes of data from variable SCALAR to the |
3b10bc60 | 6637 | specified FILEHANDLE, using write(2). If LENGTH is |
3874323d | 6638 | not specified, writes whole SCALAR. It bypasses buffered IO, so |
9124316e | 6639 | mixing this with reads (other than C<sysread())>, C<print>, C<write>, |
3874323d JH |
6640 | C<seek>, C<tell>, or C<eof> may cause confusion because the perlio and |
6641 | stdio layers usually buffers data. Returns the number of bytes | |
6642 | actually written, or C<undef> if there was an error (in this case the | |
6643 | errno variable C<$!> is also set). If the LENGTH is greater than the | |
3b10bc60 | 6644 | data available in the SCALAR after the OFFSET, only as much data as is |
3874323d | 6645 | available will be written. |
ff68c719 | 6646 | |
6647 | An OFFSET may be specified to write the data from some part of the | |
6648 | string other than the beginning. A negative OFFSET specifies writing | |
9124316e | 6649 | that many characters counting backwards from the end of the string. |
3b10bc60 | 6650 | If SCALAR is of length zero, you can only use an OFFSET of 0. |
9124316e | 6651 | |
3b10bc60 | 6652 | B<Warning>: If the filehandle is marked C<:utf8>, Unicode characters |
6653 | encoded in UTF-8 are written instead of bytes, and the LENGTH, OFFSET, and | |
6654 | return value of syswrite() are in (UTF-8 encoded Unicode) characters. | |
3874323d JH |
6655 | The C<:encoding(...)> layer implicitly introduces the C<:utf8> layer. |
6656 | See L</binmode>, L</open>, and the C<open> pragma, L<open>. | |
a0d0e21e LW |
6657 | |
6658 | =item tell FILEHANDLE | |
d74e8afc | 6659 | X<tell> |
a0d0e21e LW |
6660 | |
6661 | =item tell | |
6662 | ||
9124316e JH |
6663 | Returns the current position I<in bytes> for FILEHANDLE, or -1 on |
6664 | error. FILEHANDLE may be an expression whose value gives the name of | |
6665 | the actual filehandle. If FILEHANDLE is omitted, assumes the file | |
6666 | last read. | |
6667 | ||
6668 | Note the I<in bytes>: even if the filehandle has been set to | |
740d4bb2 JW |
6669 | operate on characters (for example by using the C<:encoding(utf8)> open |
6670 | layer), tell() will return byte offsets, not character offsets (because | |
6671 | that would render seek() and tell() rather slow). | |
2b5ab1e7 | 6672 | |
cfd73201 JH |
6673 | The return value of tell() for the standard streams like the STDIN |
6674 | depends on the operating system: it may return -1 or something else. | |
6675 | tell() on pipes, fifos, and sockets usually returns -1. | |
6676 | ||
19799a22 | 6677 | There is no C<systell> function. Use C<sysseek(FH, 0, 1)> for that. |
a0d0e21e | 6678 | |
3b10bc60 | 6679 | Do not use tell() (or other buffered I/O operations) on a filehandle |
59c9df15 NIS |
6680 | that has been manipulated by sysread(), syswrite() or sysseek(). |
6681 | Those functions ignore the buffering, while tell() does not. | |
9124316e | 6682 | |
a0d0e21e | 6683 | =item telldir DIRHANDLE |
d74e8afc | 6684 | X<telldir> |
a0d0e21e | 6685 | |
19799a22 GS |
6686 | Returns the current position of the C<readdir> routines on DIRHANDLE. |
6687 | Value may be given to C<seekdir> to access a particular location in a | |
cf264981 SP |
6688 | directory. C<telldir> has the same caveats about possible directory |
6689 | compaction as the corresponding system library routine. | |
a0d0e21e | 6690 | |
4633a7c4 | 6691 | =item tie VARIABLE,CLASSNAME,LIST |
d74e8afc | 6692 | X<tie> |
a0d0e21e | 6693 | |
4633a7c4 LW |
6694 | This function binds a variable to a package class that will provide the |
6695 | implementation for the variable. VARIABLE is the name of the variable | |
6696 | to be enchanted. CLASSNAME is the name of a class implementing objects | |
19799a22 | 6697 | of correct type. Any additional arguments are passed to the C<new> |
8a059744 GS |
6698 | method of the class (meaning C<TIESCALAR>, C<TIEHANDLE>, C<TIEARRAY>, |
6699 | or C<TIEHASH>). Typically these are arguments such as might be passed | |
19799a22 GS |
6700 | to the C<dbm_open()> function of C. The object returned by the C<new> |
6701 | method is also returned by the C<tie> function, which would be useful | |
8a059744 | 6702 | if you want to access other methods in CLASSNAME. |
a0d0e21e | 6703 | |
19799a22 | 6704 | Note that functions such as C<keys> and C<values> may return huge lists |
1d2dff63 | 6705 | when used on large objects, like DBM files. You may prefer to use the |
19799a22 | 6706 | C<each> function to iterate over such. Example: |
a0d0e21e LW |
6707 | |
6708 | # print out history file offsets | |
4633a7c4 | 6709 | use NDBM_File; |
da0045b7 | 6710 | tie(%HIST, 'NDBM_File', '/usr/lib/news/history', 1, 0); |
a0d0e21e | 6711 | while (($key,$val) = each %HIST) { |
a9a5a0dc | 6712 | print $key, ' = ', unpack('L',$val), "\n"; |
a0d0e21e LW |
6713 | } |
6714 | untie(%HIST); | |
6715 | ||
aa689395 | 6716 | A class implementing a hash should have the following methods: |
a0d0e21e | 6717 | |
4633a7c4 | 6718 | TIEHASH classname, LIST |
a0d0e21e LW |
6719 | FETCH this, key |
6720 | STORE this, key, value | |
6721 | DELETE this, key | |
8a059744 | 6722 | CLEAR this |
a0d0e21e LW |
6723 | EXISTS this, key |
6724 | FIRSTKEY this | |
6725 | NEXTKEY this, lastkey | |
a3bcc51e | 6726 | SCALAR this |
8a059744 | 6727 | DESTROY this |
d7da42b7 | 6728 | UNTIE this |
a0d0e21e | 6729 | |
4633a7c4 | 6730 | A class implementing an ordinary array should have the following methods: |
a0d0e21e | 6731 | |
4633a7c4 | 6732 | TIEARRAY classname, LIST |
a0d0e21e LW |
6733 | FETCH this, key |
6734 | STORE this, key, value | |
8a059744 GS |
6735 | FETCHSIZE this |
6736 | STORESIZE this, count | |
6737 | CLEAR this | |
6738 | PUSH this, LIST | |
6739 | POP this | |
6740 | SHIFT this | |
6741 | UNSHIFT this, LIST | |
6742 | SPLICE this, offset, length, LIST | |
6743 | EXTEND this, count | |
6744 | DESTROY this | |
d7da42b7 | 6745 | UNTIE this |
8a059744 | 6746 | |
3b10bc60 | 6747 | A class implementing a filehandle should have the following methods: |
8a059744 GS |
6748 | |
6749 | TIEHANDLE classname, LIST | |
6750 | READ this, scalar, length, offset | |
6751 | READLINE this | |
6752 | GETC this | |
6753 | WRITE this, scalar, length, offset | |
6754 | PRINT this, LIST | |
6755 | PRINTF this, format, LIST | |
e08f2115 GA |
6756 | BINMODE this |
6757 | EOF this | |
6758 | FILENO this | |
6759 | SEEK this, position, whence | |
6760 | TELL this | |
6761 | OPEN this, mode, LIST | |
8a059744 GS |
6762 | CLOSE this |
6763 | DESTROY this | |
d7da42b7 | 6764 | UNTIE this |
a0d0e21e | 6765 | |
4633a7c4 | 6766 | A class implementing a scalar should have the following methods: |
a0d0e21e | 6767 | |
4633a7c4 | 6768 | TIESCALAR classname, LIST |
54310121 | 6769 | FETCH this, |
a0d0e21e | 6770 | STORE this, value |
8a059744 | 6771 | DESTROY this |
d7da42b7 | 6772 | UNTIE this |
8a059744 GS |
6773 | |
6774 | Not all methods indicated above need be implemented. See L<perltie>, | |
2b5ab1e7 | 6775 | L<Tie::Hash>, L<Tie::Array>, L<Tie::Scalar>, and L<Tie::Handle>. |
a0d0e21e | 6776 | |
3b10bc60 | 6777 | Unlike C<dbmopen>, the C<tie> function will not C<use> or C<require> a module |
6778 | for you; you need to do that explicitly yourself. See L<DB_File> | |
19799a22 | 6779 | or the F<Config> module for interesting C<tie> implementations. |
4633a7c4 | 6780 | |
b687b08b | 6781 | For further details see L<perltie>, L<"tied VARIABLE">. |
cc6b7395 | 6782 | |
f3cbc334 | 6783 | =item tied VARIABLE |
d74e8afc | 6784 | X<tied> |
f3cbc334 RS |
6785 | |
6786 | Returns a reference to the object underlying VARIABLE (the same value | |
19799a22 | 6787 | that was originally returned by the C<tie> call that bound the variable |
f3cbc334 RS |
6788 | to a package.) Returns the undefined value if VARIABLE isn't tied to a |
6789 | package. | |
6790 | ||
a0d0e21e | 6791 | =item time |
d74e8afc | 6792 | X<time> X<epoch> |
a0d0e21e | 6793 | |
da0045b7 | 6794 | Returns the number of non-leap seconds since whatever time the system |
ef4d88db NC |
6795 | considers to be the epoch, suitable for feeding to C<gmtime> and |
6796 | C<localtime>. On most systems the epoch is 00:00:00 UTC, January 1, 1970; | |
6797 | a prominent exception being Mac OS Classic which uses 00:00:00, January 1, | |
6798 | 1904 in the current local time zone for its epoch. | |
a0d0e21e | 6799 | |
68f8bed4 | 6800 | For measuring time in better granularity than one second, |
435fbc73 | 6801 | you may use either the L<Time::HiRes> module (from CPAN, and starting from |
c5f9c75a RGS |
6802 | Perl 5.8 part of the standard distribution), or if you have |
6803 | gettimeofday(2), you may be able to use the C<syscall> interface of Perl. | |
6804 | See L<perlfaq8> for details. | |
68f8bed4 | 6805 | |
435fbc73 GS |
6806 | For date and time processing look at the many related modules on CPAN. |
6807 | For a comprehensive date and time representation look at the | |
6808 | L<DateTime> module. | |
6809 | ||
a0d0e21e | 6810 | =item times |
d74e8afc | 6811 | X<times> |
a0d0e21e | 6812 | |
1d2dff63 | 6813 | Returns a four-element list giving the user and system times, in |
a0d0e21e LW |
6814 | seconds, for this process and the children of this process. |
6815 | ||
6816 | ($user,$system,$cuser,$csystem) = times; | |
6817 | ||
dc19f4fb MJD |
6818 | In scalar context, C<times> returns C<$user>. |
6819 | ||
3b10bc60 | 6820 | Children's times are only included for terminated children. |
2a958fe2 | 6821 | |
a0d0e21e LW |
6822 | =item tr/// |
6823 | ||
9f4b9cd0 SP |
6824 | The transliteration operator. Same as C<y///>. See |
6825 | L<perlop/"Quote and Quote-like Operators">. | |
a0d0e21e LW |
6826 | |
6827 | =item truncate FILEHANDLE,LENGTH | |
d74e8afc | 6828 | X<truncate> |
a0d0e21e LW |
6829 | |
6830 | =item truncate EXPR,LENGTH | |
6831 | ||
6832 | Truncates the file opened on FILEHANDLE, or named by EXPR, to the | |
3b10bc60 | 6833 | specified length. Raises an exception if truncate isn't implemented |
19799a22 | 6834 | on your system. Returns true if successful, the undefined value |
a3cb178b | 6835 | otherwise. |
a0d0e21e | 6836 | |
90ddc76f MS |
6837 | The behavior is undefined if LENGTH is greater than the length of the |
6838 | file. | |
6839 | ||
8577f58c RK |
6840 | The position in the file of FILEHANDLE is left unchanged. You may want to |
6841 | call L<seek> before writing to the file. | |
6842 | ||
a0d0e21e | 6843 | =item uc EXPR |
d74e8afc | 6844 | X<uc> X<uppercase> X<toupper> |
a0d0e21e | 6845 | |
54310121 | 6846 | =item uc |
bbce6d69 | 6847 | |
a0d0e21e | 6848 | Returns an uppercased version of EXPR. This is the internal function |
8bdbc703 | 6849 | implementing the C<\U> escape in double-quoted strings. Respects |
6850 | current LC_CTYPE locale if C<use locale> in force. See L<perllocale> | |
6851 | and L<perlunicode> for more details about locale and Unicode support. | |
983ffd37 JH |
6852 | It does not attempt to do titlecase mapping on initial letters. See |
6853 | C<ucfirst> for that. | |
a0d0e21e | 6854 | |
7660c0ab | 6855 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 6856 | |
a0d0e21e | 6857 | =item ucfirst EXPR |
d74e8afc | 6858 | X<ucfirst> X<uppercase> |
a0d0e21e | 6859 | |
54310121 | 6860 | =item ucfirst |
bbce6d69 | 6861 | |
ad0029c4 JH |
6862 | Returns the value of EXPR with the first character in uppercase |
6863 | (titlecase in Unicode). This is the internal function implementing | |
8bdbc703 | 6864 | the C<\u> escape in double-quoted strings. Respects current LC_CTYPE |
6865 | locale if C<use locale> in force. See L<perllocale> and L<perlunicode> | |
6866 | for more details about locale and Unicode support. | |
a0d0e21e | 6867 | |
7660c0ab | 6868 | If EXPR is omitted, uses C<$_>. |
bbce6d69 | 6869 | |
a0d0e21e | 6870 | =item umask EXPR |
d74e8afc | 6871 | X<umask> |
a0d0e21e LW |
6872 | |
6873 | =item umask | |
6874 | ||
2f9daede | 6875 | Sets the umask for the process to EXPR and returns the previous value. |
eec2d3df GS |
6876 | If EXPR is omitted, merely returns the current umask. |
6877 | ||
0591cd52 NT |
6878 | The Unix permission C<rwxr-x---> is represented as three sets of three |
6879 | bits, or three octal digits: C<0750> (the leading 0 indicates octal | |
b5a41e52 | 6880 | and isn't one of the digits). The C<umask> value is such a number |
0591cd52 NT |
6881 | representing disabled permissions bits. The permission (or "mode") |
6882 | values you pass C<mkdir> or C<sysopen> are modified by your umask, so | |
6883 | even if you tell C<sysopen> to create a file with permissions C<0777>, | |
6884 | if your umask is C<0022> then the file will actually be created with | |
6885 | permissions C<0755>. If your C<umask> were C<0027> (group can't | |
6886 | write; others can't read, write, or execute), then passing | |
19799a22 | 6887 | C<sysopen> C<0666> would create a file with mode C<0640> (C<0666 &~ |
0591cd52 NT |
6888 | 027> is C<0640>). |
6889 | ||
6890 | Here's some advice: supply a creation mode of C<0666> for regular | |
19799a22 GS |
6891 | files (in C<sysopen>) and one of C<0777> for directories (in |
6892 | C<mkdir>) and executable files. This gives users the freedom of | |
0591cd52 NT |
6893 | choice: if they want protected files, they might choose process umasks |
6894 | of C<022>, C<027>, or even the particularly antisocial mask of C<077>. | |
6895 | Programs should rarely if ever make policy decisions better left to | |
6896 | the user. The exception to this is when writing files that should be | |
6897 | kept private: mail files, web browser cookies, I<.rhosts> files, and | |
6898 | so on. | |
6899 | ||
f86cebdf | 6900 | If umask(2) is not implemented on your system and you are trying to |
3b10bc60 | 6901 | restrict access for I<yourself> (i.e., C<< (EXPR & 0700) > 0 >>), |
6902 | raises an exception. If umask(2) is not implemented and you are | |
eec2d3df GS |
6903 | not trying to restrict access for yourself, returns C<undef>. |
6904 | ||
6905 | Remember that a umask is a number, usually given in octal; it is I<not> a | |
6906 | string of octal digits. See also L</oct>, if all you have is a string. | |
a0d0e21e LW |
6907 | |
6908 | =item undef EXPR | |
d74e8afc | 6909 | X<undef> X<undefine> |
a0d0e21e LW |
6910 | |
6911 | =item undef | |
6912 | ||
54310121 | 6913 | Undefines the value of EXPR, which must be an lvalue. Use only on a |
19799a22 | 6914 | scalar value, an array (using C<@>), a hash (using C<%>), a subroutine |
3b10bc60 | 6915 | (using C<&>), or a typeglob (using C<*>). Saying C<undef $hash{$key}> |
20408e3c | 6916 | will probably not do what you expect on most predefined variables or |
3b10bc60 | 6917 | DBM list values, so don't do that; see L<delete>. Always returns the |
20408e3c GS |
6918 | undefined value. You can omit the EXPR, in which case nothing is |
6919 | undefined, but you still get an undefined value that you could, for | |
3b10bc60 | 6920 | instance, return from a subroutine, assign to a variable, or pass as a |
20408e3c | 6921 | parameter. Examples: |
a0d0e21e LW |
6922 | |
6923 | undef $foo; | |
f86cebdf | 6924 | undef $bar{'blurfl'}; # Compare to: delete $bar{'blurfl'}; |
a0d0e21e | 6925 | undef @ary; |
aa689395 | 6926 | undef %hash; |
a0d0e21e | 6927 | undef &mysub; |
20408e3c | 6928 | undef *xyz; # destroys $xyz, @xyz, %xyz, &xyz, etc. |
54310121 | 6929 | return (wantarray ? (undef, $errmsg) : undef) if $they_blew_it; |
2f9daede TP |
6930 | select undef, undef, undef, 0.25; |
6931 | ($a, $b, undef, $c) = &foo; # Ignore third value returned | |
a0d0e21e | 6932 | |
5a964f20 TC |
6933 | Note that this is a unary operator, not a list operator. |
6934 | ||
a0d0e21e | 6935 | =item unlink LIST |
dd184578 | 6936 | X<unlink> X<delete> X<remove> X<rm> X<del> |
a0d0e21e | 6937 | |
54310121 | 6938 | =item unlink |
bbce6d69 | 6939 | |
40ea6f68 | 6940 | Deletes a list of files. On success, it returns the number of files |
6941 | it successfully deleted. On failure, it returns false and sets C<$!> | |
6942 | (errno): | |
a0d0e21e | 6943 | |
40ea6f68 | 6944 | my $unlinked = unlink 'a', 'b', 'c'; |
a0d0e21e | 6945 | unlink @goners; |
40ea6f68 | 6946 | unlink glob "*.bak"; |
a0d0e21e | 6947 | |
40ea6f68 | 6948 | On error, C<unlink> will not tell you which files it could not remove. |
734c9e01 | 6949 | If you want to know which files you could not remove, try them one |
40ea6f68 | 6950 | at a time: |
a0d0e21e | 6951 | |
40ea6f68 | 6952 | foreach my $file ( @goners ) { |
6953 | unlink $file or warn "Could not unlink $file: $!"; | |
3b10bc60 | 6954 | } |
40ea6f68 | 6955 | |
6956 | Note: C<unlink> will not attempt to delete directories unless you are | |
6957 | superuser and the B<-U> flag is supplied to Perl. Even if these | |
6958 | conditions are met, be warned that unlinking a directory can inflict | |
6959 | damage on your filesystem. Finally, using C<unlink> on directories is | |
6960 | not supported on many operating systems. Use C<rmdir> instead. | |
6961 | ||
6962 | If LIST is omitted, C<unlink> uses C<$_>. | |
bbce6d69 | 6963 | |
a0d0e21e | 6964 | =item unpack TEMPLATE,EXPR |
d74e8afc | 6965 | X<unpack> |
a0d0e21e | 6966 | |
13dcffc6 CS |
6967 | =item unpack TEMPLATE |
6968 | ||
19799a22 | 6969 | C<unpack> does the reverse of C<pack>: it takes a string |
2b6c5635 | 6970 | and expands it out into a list of values. |
19799a22 | 6971 | (In scalar context, it returns merely the first value produced.) |
2b6c5635 | 6972 | |
8bdbc703 | 6973 | If EXPR is omitted, unpacks the C<$_> string. |
13dcffc6 | 6974 | |
2b6c5635 GS |
6975 | The string is broken into chunks described by the TEMPLATE. Each chunk |
6976 | is converted separately to a value. Typically, either the string is a result | |
f337b084 | 6977 | of C<pack>, or the characters of the string represent a C structure of some |
2b6c5635 GS |
6978 | kind. |
6979 | ||
19799a22 | 6980 | The TEMPLATE has the same format as in the C<pack> function. |
a0d0e21e LW |
6981 | Here's a subroutine that does substring: |
6982 | ||
6983 | sub substr { | |
5ed4f2ec | 6984 | my($what,$where,$howmuch) = @_; |
6985 | unpack("x$where a$howmuch", $what); | |
a0d0e21e LW |
6986 | } |
6987 | ||
6988 | and then there's | |
6989 | ||
f337b084 | 6990 | sub ordinal { unpack("W",$_[0]); } # same as ord() |
a0d0e21e | 6991 | |
2b6c5635 | 6992 | In addition to fields allowed in pack(), you may prefix a field with |
61eff3bc JH |
6993 | a %<number> to indicate that |
6994 | you want a <number>-bit checksum of the items instead of the items | |
2b6c5635 GS |
6995 | themselves. Default is a 16-bit checksum. Checksum is calculated by |
6996 | summing numeric values of expanded values (for string fields the sum of | |
6997 | C<ord($char)> is taken, for bit fields the sum of zeroes and ones). | |
6998 | ||
6999 | For example, the following | |
a0d0e21e LW |
7000 | computes the same number as the System V sum program: |
7001 | ||
19799a22 | 7002 | $checksum = do { |
5ed4f2ec | 7003 | local $/; # slurp! |
7004 | unpack("%32W*",<>) % 65535; | |
19799a22 | 7005 | }; |
a0d0e21e LW |
7006 | |
7007 | The following efficiently counts the number of set bits in a bit vector: | |
7008 | ||
7009 | $setbits = unpack("%32b*", $selectmask); | |
7010 | ||
951ba7fe | 7011 | The C<p> and C<P> formats should be used with care. Since Perl |
3160c391 GS |
7012 | has no way of checking whether the value passed to C<unpack()> |
7013 | corresponds to a valid memory location, passing a pointer value that's | |
7014 | not known to be valid is likely to have disastrous consequences. | |
7015 | ||
49704364 WL |
7016 | If there are more pack codes or if the repeat count of a field or a group |
7017 | is larger than what the remainder of the input string allows, the result | |
3b10bc60 | 7018 | is not well defined: the repeat count may be decreased, or |
7019 | C<unpack()> may produce empty strings or zeros, or it may raise an exception. | |
7020 | If the input string is longer than one described by the TEMPLATE, | |
7021 | the remainder of that input string is ignored. | |
2b6c5635 | 7022 | |
851646ae | 7023 | See L</pack> for more examples and notes. |
5a929a98 | 7024 | |
98293880 | 7025 | =item untie VARIABLE |
d74e8afc | 7026 | X<untie> |
98293880 | 7027 | |
19799a22 | 7028 | Breaks the binding between a variable and a package. (See C<tie>.) |
1188453a | 7029 | Has no effect if the variable is not tied. |
98293880 | 7030 | |
a0d0e21e | 7031 | =item unshift ARRAY,LIST |
d74e8afc | 7032 | X<unshift> |
a0d0e21e | 7033 | |
19799a22 | 7034 | Does the opposite of a C<shift>. Or the opposite of a C<push>, |
a0d0e21e LW |
7035 | depending on how you look at it. Prepends list to the front of the |
7036 | array, and returns the new number of elements in the array. | |
7037 | ||
76e4c2bb | 7038 | unshift(@ARGV, '-e') unless $ARGV[0] =~ /^-/; |
a0d0e21e LW |
7039 | |
7040 | Note the LIST is prepended whole, not one element at a time, so the | |
19799a22 | 7041 | prepended elements stay in the same order. Use C<reverse> to do the |
a0d0e21e LW |
7042 | reverse. |
7043 | ||
f6c8478c | 7044 | =item use Module VERSION LIST |
d74e8afc | 7045 | X<use> X<module> X<import> |
f6c8478c GS |
7046 | |
7047 | =item use Module VERSION | |
7048 | ||
a0d0e21e LW |
7049 | =item use Module LIST |
7050 | ||
7051 | =item use Module | |
7052 | ||
da0045b7 | 7053 | =item use VERSION |
7054 | ||
a0d0e21e LW |
7055 | Imports some semantics into the current package from the named module, |
7056 | generally by aliasing certain subroutine or variable names into your | |
7057 | package. It is exactly equivalent to | |
7058 | ||
6d9d0573 | 7059 | BEGIN { require Module; Module->import( LIST ); } |
a0d0e21e | 7060 | |
54310121 | 7061 | except that Module I<must> be a bareword. |
da0045b7 | 7062 | |
bd12309b DG |
7063 | In the peculiar C<use VERSION> form, VERSION may be either a positive |
7064 | decimal fraction such as 5.006, which will be compared to C<$]>, or a v-string | |
7065 | of the form v5.6.1, which will be compared to C<$^V> (aka $PERL_VERSION). An | |
3b10bc60 | 7066 | exception is raised if VERSION is greater than the version of the |
c986422f RGS |
7067 | current Perl interpreter; Perl will not attempt to parse the rest of the |
7068 | file. Compare with L</require>, which can do a similar check at run time. | |
7069 | Symmetrically, C<no VERSION> allows you to specify that you want a version | |
3b10bc60 | 7070 | of Perl older than the specified one. |
3b825e41 RK |
7071 | |
7072 | Specifying VERSION as a literal of the form v5.6.1 should generally be | |
7073 | avoided, because it leads to misleading error messages under earlier | |
2e8342de RGS |
7074 | versions of Perl (that is, prior to 5.6.0) that do not support this |
7075 | syntax. The equivalent numeric version should be used instead. | |
fbc891ce | 7076 | |
5ed4f2ec | 7077 | use v5.6.1; # compile time version check |
7078 | use 5.6.1; # ditto | |
7079 | use 5.006_001; # ditto; preferred for backwards compatibility | |
16070b82 GS |
7080 | |
7081 | This is often useful if you need to check the current Perl version before | |
2e8342de RGS |
7082 | C<use>ing library modules that won't work with older versions of Perl. |
7083 | (We try not to do this more than we have to.) | |
da0045b7 | 7084 | |
3b10bc60 | 7085 | Also, if the specified Perl version is greater than or equal to 5.9.5, |
c986422f RGS |
7086 | C<use VERSION> will also load the C<feature> pragma and enable all |
7087 | features available in the requested version. See L<feature>. | |
3b10bc60 | 7088 | Similarly, if the specified Perl version is greater than or equal to |
5cc917d6 RGS |
7089 | 5.11.0, strictures are enabled lexically as with C<use strict> (except |
7090 | that the F<strict.pm> file is not actually loaded). | |
7dfde25d | 7091 | |
19799a22 | 7092 | The C<BEGIN> forces the C<require> and C<import> to happen at compile time. The |
7660c0ab | 7093 | C<require> makes sure the module is loaded into memory if it hasn't been |
3b10bc60 | 7094 | yet. The C<import> is not a builtin; it's just an ordinary static method |
19799a22 | 7095 | call into the C<Module> package to tell the module to import the list of |
a0d0e21e | 7096 | features back into the current package. The module can implement its |
19799a22 GS |
7097 | C<import> method any way it likes, though most modules just choose to |
7098 | derive their C<import> method via inheritance from the C<Exporter> class that | |
7099 | is defined in the C<Exporter> module. See L<Exporter>. If no C<import> | |
593b9c14 YST |
7100 | method can be found then the call is skipped, even if there is an AUTOLOAD |
7101 | method. | |
cb1a09d0 | 7102 | |
31686daf JP |
7103 | If you do not want to call the package's C<import> method (for instance, |
7104 | to stop your namespace from being altered), explicitly supply the empty list: | |
cb1a09d0 AD |
7105 | |
7106 | use Module (); | |
7107 | ||
7108 | That is exactly equivalent to | |
7109 | ||
5a964f20 | 7110 | BEGIN { require Module } |
a0d0e21e | 7111 | |
da0045b7 | 7112 | If the VERSION argument is present between Module and LIST, then the |
71be2cbc | 7113 | C<use> will call the VERSION method in class Module with the given |
7114 | version as an argument. The default VERSION method, inherited from | |
44dcb63b | 7115 | the UNIVERSAL class, croaks if the given version is larger than the |
b76cc8ba | 7116 | value of the variable C<$Module::VERSION>. |
f6c8478c GS |
7117 | |
7118 | Again, there is a distinction between omitting LIST (C<import> called | |
7119 | with no arguments) and an explicit empty LIST C<()> (C<import> not | |
7120 | called). Note that there is no comma after VERSION! | |
da0045b7 | 7121 | |
a0d0e21e LW |
7122 | Because this is a wide-open interface, pragmas (compiler directives) |
7123 | are also implemented this way. Currently implemented pragmas are: | |
7124 | ||
f3798619 | 7125 | use constant; |
4633a7c4 | 7126 | use diagnostics; |
f3798619 | 7127 | use integer; |
4438c4b7 JH |
7128 | use sigtrap qw(SEGV BUS); |
7129 | use strict qw(subs vars refs); | |
7130 | use subs qw(afunc blurfl); | |
7131 | use warnings qw(all); | |
58c7fc7c | 7132 | use sort qw(stable _quicksort _mergesort); |
a0d0e21e | 7133 | |
19799a22 | 7134 | Some of these pseudo-modules import semantics into the current |
5a964f20 TC |
7135 | block scope (like C<strict> or C<integer>, unlike ordinary modules, |
7136 | which import symbols into the current package (which are effective | |
7137 | through the end of the file). | |
a0d0e21e | 7138 | |
c362798e Z |
7139 | Because C<use> takes effect at compile time, it doesn't respect the |
7140 | ordinary flow control of the code being compiled. In particular, putting | |
7141 | a C<use> inside the false branch of a conditional doesn't prevent it | |
3b10bc60 | 7142 | from being processed. If a module or pragma only needs to be loaded |
c362798e Z |
7143 | conditionally, this can be done using the L<if> pragma: |
7144 | ||
7145 | use if $] < 5.008, "utf8"; | |
7146 | use if WANT_WARNINGS, warnings => qw(all); | |
7147 | ||
19799a22 GS |
7148 | There's a corresponding C<no> command that unimports meanings imported |
7149 | by C<use>, i.e., it calls C<unimport Module LIST> instead of C<import>. | |
80d38338 TC |
7150 | It behaves just as C<import> does with VERSION, an omitted or empty LIST, |
7151 | or no unimport method being found. | |
a0d0e21e LW |
7152 | |
7153 | no integer; | |
7154 | no strict 'refs'; | |
4438c4b7 | 7155 | no warnings; |
a0d0e21e | 7156 | |
ac634a9a | 7157 | See L<perlmodlib> for a list of standard modules and pragmas. See L<perlrun> |
3b10bc60 | 7158 | for the C<-M> and C<-m> command-line options to Perl that give C<use> |
31686daf | 7159 | functionality from the command-line. |
a0d0e21e LW |
7160 | |
7161 | =item utime LIST | |
d74e8afc | 7162 | X<utime> |
a0d0e21e LW |
7163 | |
7164 | Changes the access and modification times on each file of a list of | |
7165 | files. The first two elements of the list must be the NUMERICAL access | |
7166 | and modification times, in that order. Returns the number of files | |
46cdf678 | 7167 | successfully changed. The inode change time of each file is set |
4bc2a53d | 7168 | to the current time. For example, this code has the same effect as the |
a4142048 WL |
7169 | Unix touch(1) command when the files I<already exist> and belong to |
7170 | the user running the program: | |
a0d0e21e LW |
7171 | |
7172 | #!/usr/bin/perl | |
2c21a326 GA |
7173 | $atime = $mtime = time; |
7174 | utime $atime, $mtime, @ARGV; | |
4bc2a53d | 7175 | |
3b10bc60 | 7176 | Since Perl 5.7.2, if the first two elements of the list are C<undef>, |
7177 | the utime(2) syscall from your C library is called with a null second | |
4bc2a53d | 7178 | argument. On most systems, this will set the file's access and |
80d38338 | 7179 | modification times to the current time (i.e., equivalent to the example |
3b10bc60 | 7180 | above) and will work even on files you don't own provided you have write |
a4142048 | 7181 | permission: |
c6f7b413 | 7182 | |
3b10bc60 | 7183 | for $file (@ARGV) { |
7184 | utime(undef, undef, $file) | |
7185 | || warn "couldn't touch $file: $!"; | |
7186 | } | |
c6f7b413 | 7187 | |
2c21a326 GA |
7188 | Under NFS this will use the time of the NFS server, not the time of |
7189 | the local machine. If there is a time synchronization problem, the | |
7190 | NFS server and local machine will have different times. The Unix | |
7191 | touch(1) command will in fact normally use this form instead of the | |
7192 | one shown in the first example. | |
7193 | ||
3b10bc60 | 7194 | Passing only one of the first two elements as C<undef> is |
7195 | equivalent to passing a 0 and will not have the effect | |
7196 | described when both are C<undef>. This also triggers an | |
2c21a326 GA |
7197 | uninitialized warning. |
7198 | ||
3b10bc60 | 7199 | On systems that support futimes(2), you may pass filehandles among the |
7200 | files. On systems that don't support futimes(2), passing filehandles raises | |
7201 | an exception. Filehandles must be passed as globs or glob references to be | |
7202 | recognized; barewords are considered filenames. | |
e96b369d | 7203 | |
aa689395 | 7204 | =item values HASH |
d74e8afc | 7205 | X<values> |
a0d0e21e | 7206 | |
aeedbbed NC |
7207 | =item values ARRAY |
7208 | ||
7209 | Returns a list consisting of all the values of the named hash, or the values | |
7210 | of an array. (In a scalar context, returns the number of values.) | |
504f80c1 JH |
7211 | |
7212 | The values are returned in an apparently random order. The actual | |
3b10bc60 | 7213 | random order is subject to change in future versions of Perl, but it |
504f80c1 | 7214 | is guaranteed to be the same order as either the C<keys> or C<each> |
4546b9e6 JH |
7215 | function would produce on the same (unmodified) hash. Since Perl |
7216 | 5.8.1 the ordering is different even between different runs of Perl | |
7217 | for security reasons (see L<perlsec/"Algorithmic Complexity Attacks">). | |
504f80c1 | 7218 | |
aeedbbed NC |
7219 | As a side effect, calling values() resets the HASH or ARRAY's internal |
7220 | iterator, | |
2f65b2f0 | 7221 | see L</each>. (In particular, calling values() in void context resets |
aeedbbed | 7222 | the iterator with no other overhead. Apart from resetting the iterator, |
80d38338 | 7223 | C<values @array> in list context is the same as plain C<@array>. |
aeedbbed NC |
7224 | We recommend that you use void context C<keys @array> for this, but reasoned |
7225 | that it taking C<values @array> out would require more documentation than | |
7226 | leaving it in.) | |
7227 | ||
ab192400 | 7228 | |
8ea1e5d4 GS |
7229 | Note that the values are not copied, which means modifying them will |
7230 | modify the contents of the hash: | |
2b5ab1e7 | 7231 | |
5ed4f2ec | 7232 | for (values %hash) { s/foo/bar/g } # modifies %hash values |
8ea1e5d4 | 7233 | for (@hash{keys %hash}) { s/foo/bar/g } # same |
2b5ab1e7 | 7234 | |
19799a22 | 7235 | See also C<keys>, C<each>, and C<sort>. |
a0d0e21e LW |
7236 | |
7237 | =item vec EXPR,OFFSET,BITS | |
d74e8afc | 7238 | X<vec> X<bit> X<bit vector> |
a0d0e21e | 7239 | |
e69129f1 GS |
7240 | Treats the string in EXPR as a bit vector made up of elements of |
7241 | width BITS, and returns the value of the element specified by OFFSET | |
7242 | as an unsigned integer. BITS therefore specifies the number of bits | |
7243 | that are reserved for each element in the bit vector. This must | |
7244 | be a power of two from 1 to 32 (or 64, if your platform supports | |
7245 | that). | |
c5a0f51a | 7246 | |
b76cc8ba | 7247 | If BITS is 8, "elements" coincide with bytes of the input string. |
c73032f5 IZ |
7248 | |
7249 | If BITS is 16 or more, bytes of the input string are grouped into chunks | |
7250 | of size BITS/8, and each group is converted to a number as with | |
b1866b2d | 7251 | pack()/unpack() with big-endian formats C<n>/C<N> (and analogously |
c73032f5 IZ |
7252 | for BITS==64). See L<"pack"> for details. |
7253 | ||
7254 | If bits is 4 or less, the string is broken into bytes, then the bits | |
7255 | of each byte are broken into 8/BITS groups. Bits of a byte are | |
7256 | numbered in a little-endian-ish way, as in C<0x01>, C<0x02>, | |
7257 | C<0x04>, C<0x08>, C<0x10>, C<0x20>, C<0x40>, C<0x80>. For example, | |
7258 | breaking the single input byte C<chr(0x36)> into two groups gives a list | |
7259 | C<(0x6, 0x3)>; breaking it into 4 groups gives C<(0x2, 0x1, 0x3, 0x0)>. | |
7260 | ||
81e118e0 JH |
7261 | C<vec> may also be assigned to, in which case parentheses are needed |
7262 | to give the expression the correct precedence as in | |
22dc801b | 7263 | |
7264 | vec($image, $max_x * $x + $y, 8) = 3; | |
a0d0e21e | 7265 | |
fe58ced6 MG |
7266 | If the selected element is outside the string, the value 0 is returned. |
7267 | If an element off the end of the string is written to, Perl will first | |
7268 | extend the string with sufficiently many zero bytes. It is an error | |
80d38338 | 7269 | to try to write off the beginning of the string (i.e., negative OFFSET). |
fac70343 | 7270 | |
2575c402 JW |
7271 | If the string happens to be encoded as UTF-8 internally (and thus has |
7272 | the UTF8 flag set), this is ignored by C<vec>, and it operates on the | |
7273 | internal byte string, not the conceptual character string, even if you | |
7274 | only have characters with values less than 256. | |
246fae53 | 7275 | |
fac70343 GS |
7276 | Strings created with C<vec> can also be manipulated with the logical |
7277 | operators C<|>, C<&>, C<^>, and C<~>. These operators will assume a bit | |
7278 | vector operation is desired when both operands are strings. | |
c5a0f51a | 7279 | See L<perlop/"Bitwise String Operators">. |
a0d0e21e | 7280 | |
7660c0ab | 7281 | The following code will build up an ASCII string saying C<'PerlPerlPerl'>. |
19799a22 | 7282 | The comments show the string after each step. Note that this code works |
cca87523 GS |
7283 | in the same way on big-endian or little-endian machines. |
7284 | ||
7285 | my $foo = ''; | |
5ed4f2ec | 7286 | vec($foo, 0, 32) = 0x5065726C; # 'Perl' |
e69129f1 GS |
7287 | |
7288 | # $foo eq "Perl" eq "\x50\x65\x72\x6C", 32 bits | |
5ed4f2ec | 7289 | print vec($foo, 0, 8); # prints 80 == 0x50 == ord('P') |
7290 | ||
7291 | vec($foo, 2, 16) = 0x5065; # 'PerlPe' | |
7292 | vec($foo, 3, 16) = 0x726C; # 'PerlPerl' | |
7293 | vec($foo, 8, 8) = 0x50; # 'PerlPerlP' | |
7294 | vec($foo, 9, 8) = 0x65; # 'PerlPerlPe' | |
7295 | vec($foo, 20, 4) = 2; # 'PerlPerlPe' . "\x02" | |
7296 | vec($foo, 21, 4) = 7; # 'PerlPerlPer' | |
7297 | # 'r' is "\x72" | |
7298 | vec($foo, 45, 2) = 3; # 'PerlPerlPer' . "\x0c" | |
7299 | vec($foo, 93, 1) = 1; # 'PerlPerlPer' . "\x2c" | |
7300 | vec($foo, 94, 1) = 1; # 'PerlPerlPerl' | |
7301 | # 'l' is "\x6c" | |
cca87523 | 7302 | |
19799a22 | 7303 | To transform a bit vector into a string or list of 0's and 1's, use these: |
a0d0e21e LW |
7304 | |
7305 | $bits = unpack("b*", $vector); | |
7306 | @bits = split(//, unpack("b*", $vector)); | |
7307 | ||
7660c0ab | 7308 | If you know the exact length in bits, it can be used in place of the C<*>. |
a0d0e21e | 7309 | |
e69129f1 GS |
7310 | Here is an example to illustrate how the bits actually fall in place: |
7311 | ||
7312 | #!/usr/bin/perl -wl | |
7313 | ||
7314 | print <<'EOT'; | |
b76cc8ba | 7315 | 0 1 2 3 |
e69129f1 GS |
7316 | unpack("V",$_) 01234567890123456789012345678901 |
7317 | ------------------------------------------------------------------ | |
7318 | EOT | |
7319 | ||
7320 | for $w (0..3) { | |
7321 | $width = 2**$w; | |
7322 | for ($shift=0; $shift < $width; ++$shift) { | |
7323 | for ($off=0; $off < 32/$width; ++$off) { | |
7324 | $str = pack("B*", "0"x32); | |
7325 | $bits = (1<<$shift); | |
7326 | vec($str, $off, $width) = $bits; | |
7327 | $res = unpack("b*",$str); | |
7328 | $val = unpack("V", $str); | |
7329 | write; | |
7330 | } | |
7331 | } | |
7332 | } | |
7333 | ||
7334 | format STDOUT = | |
7335 | vec($_,@#,@#) = @<< == @######### @>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> | |
7336 | $off, $width, $bits, $val, $res | |
7337 | . | |
7338 | __END__ | |
7339 | ||
80d38338 TC |
7340 | Regardless of the machine architecture on which it runs, the |
7341 | example above should print the following table: | |
e69129f1 | 7342 | |
b76cc8ba | 7343 | 0 1 2 3 |
e69129f1 GS |
7344 | unpack("V",$_) 01234567890123456789012345678901 |
7345 | ------------------------------------------------------------------ | |
7346 | vec($_, 0, 1) = 1 == 1 10000000000000000000000000000000 | |
7347 | vec($_, 1, 1) = 1 == 2 01000000000000000000000000000000 | |
7348 | vec($_, 2, 1) = 1 == 4 00100000000000000000000000000000 | |
7349 | vec($_, 3, 1) = 1 == 8 00010000000000000000000000000000 | |
7350 | vec($_, 4, 1) = 1 == 16 00001000000000000000000000000000 | |
7351 | vec($_, 5, 1) = 1 == 32 00000100000000000000000000000000 | |
7352 | vec($_, 6, 1) = 1 == 64 00000010000000000000000000000000 | |
7353 | vec($_, 7, 1) = 1 == 128 00000001000000000000000000000000 | |
7354 | vec($_, 8, 1) = 1 == 256 00000000100000000000000000000000 | |
7355 | vec($_, 9, 1) = 1 == 512 00000000010000000000000000000000 | |
7356 | vec($_,10, 1) = 1 == 1024 00000000001000000000000000000000 | |
7357 | vec($_,11, 1) = 1 == 2048 00000000000100000000000000000000 | |
7358 | vec($_,12, 1) = 1 == 4096 00000000000010000000000000000000 | |
7359 | vec($_,13, 1) = 1 == 8192 00000000000001000000000000000000 | |
7360 | vec($_,14, 1) = 1 == 16384 00000000000000100000000000000000 | |
7361 | vec($_,15, 1) = 1 == 32768 00000000000000010000000000000000 | |
7362 | vec($_,16, 1) = 1 == 65536 00000000000000001000000000000000 | |
7363 | vec($_,17, 1) = 1 == 131072 00000000000000000100000000000000 | |
7364 | vec($_,18, 1) = 1 == 262144 00000000000000000010000000000000 | |
7365 | vec($_,19, 1) = 1 == 524288 00000000000000000001000000000000 | |
7366 | vec($_,20, 1) = 1 == 1048576 00000000000000000000100000000000 | |
7367 | vec($_,21, 1) = 1 == 2097152 00000000000000000000010000000000 | |
7368 | vec($_,22, 1) = 1 == 4194304 00000000000000000000001000000000 | |
7369 | vec($_,23, 1) = 1 == 8388608 00000000000000000000000100000000 | |
7370 | vec($_,24, 1) = 1 == 16777216 00000000000000000000000010000000 | |
7371 | vec($_,25, 1) = 1 == 33554432 00000000000000000000000001000000 | |
7372 | vec($_,26, 1) = 1 == 67108864 00000000000000000000000000100000 | |
7373 | vec($_,27, 1) = 1 == 134217728 00000000000000000000000000010000 | |
7374 | vec($_,28, 1) = 1 == 268435456 00000000000000000000000000001000 | |
7375 | vec($_,29, 1) = 1 == 536870912 00000000000000000000000000000100 | |
7376 | vec($_,30, 1) = 1 == 1073741824 00000000000000000000000000000010 | |
7377 | vec($_,31, 1) = 1 == 2147483648 00000000000000000000000000000001 | |
7378 | vec($_, 0, 2) = 1 == 1 10000000000000000000000000000000 | |
7379 | vec($_, 1, 2) = 1 == 4 00100000000000000000000000000000 | |
7380 | vec($_, 2, 2) = 1 == 16 00001000000000000000000000000000 | |
7381 | vec($_, 3, 2) = 1 == 64 00000010000000000000000000000000 | |
7382 | vec($_, 4, 2) = 1 == 256 00000000100000000000000000000000 | |
7383 | vec($_, 5, 2) = 1 == 1024 00000000001000000000000000000000 | |
7384 | vec($_, 6, 2) = 1 == 4096 00000000000010000000000000000000 | |
7385 | vec($_, 7, 2) = 1 == 16384 00000000000000100000000000000000 | |
7386 | vec($_, 8, 2) = 1 == 65536 00000000000000001000000000000000 | |
7387 | vec($_, 9, 2) = 1 == 262144 00000000000000000010000000000000 | |
7388 | vec($_,10, 2) = 1 == 1048576 00000000000000000000100000000000 | |
7389 | vec($_,11, 2) = 1 == 4194304 00000000000000000000001000000000 | |
7390 | vec($_,12, 2) = 1 == 16777216 00000000000000000000000010000000 | |
7391 | vec($_,13, 2) = 1 == 67108864 00000000000000000000000000100000 | |
7392 | vec($_,14, 2) = 1 == 268435456 00000000000000000000000000001000 | |
7393 | vec($_,15, 2) = 1 == 1073741824 00000000000000000000000000000010 | |
7394 | vec($_, 0, 2) = 2 == 2 01000000000000000000000000000000 | |
7395 | vec($_, 1, 2) = 2 == 8 00010000000000000000000000000000 | |
7396 | vec($_, 2, 2) = 2 == 32 00000100000000000000000000000000 | |
7397 | vec($_, 3, 2) = 2 == 128 00000001000000000000000000000000 | |
7398 | vec($_, 4, 2) = 2 == 512 00000000010000000000000000000000 | |
7399 | vec($_, 5, 2) = 2 == 2048 00000000000100000000000000000000 | |
7400 | vec($_, 6, 2) = 2 == 8192 00000000000001000000000000000000 | |
7401 | vec($_, 7, 2) = 2 == 32768 00000000000000010000000000000000 | |
7402 | vec($_, 8, 2) = 2 == 131072 00000000000000000100000000000000 | |
7403 | vec($_, 9, 2) = 2 == 524288 00000000000000000001000000000000 | |
7404 | vec($_,10, 2) = 2 == 2097152 00000000000000000000010000000000 | |
7405 | vec($_,11, 2) = 2 == 8388608 00000000000000000000000100000000 | |
7406 | vec($_,12, 2) = 2 == 33554432 00000000000000000000000001000000 | |
7407 | vec($_,13, 2) = 2 == 134217728 00000000000000000000000000010000 | |
7408 | vec($_,14, 2) = 2 == 536870912 00000000000000000000000000000100 | |
7409 | vec($_,15, 2) = 2 == 2147483648 00000000000000000000000000000001 | |
7410 | vec($_, 0, 4) = 1 == 1 10000000000000000000000000000000 | |
7411 | vec($_, 1, 4) = 1 == 16 00001000000000000000000000000000 | |
7412 | vec($_, 2, 4) = 1 == 256 00000000100000000000000000000000 | |
7413 | vec($_, 3, 4) = 1 == 4096 00000000000010000000000000000000 | |
7414 | vec($_, 4, 4) = 1 == 65536 00000000000000001000000000000000 | |
7415 | vec($_, 5, 4) = 1 == 1048576 00000000000000000000100000000000 | |
7416 | vec($_, 6, 4) = 1 == 16777216 00000000000000000000000010000000 | |
7417 | vec($_, 7, 4) = 1 == 268435456 00000000000000000000000000001000 | |
7418 | vec($_, 0, 4) = 2 == 2 01000000000000000000000000000000 | |
7419 | vec($_, 1, 4) = 2 == 32 00000100000000000000000000000000 | |
7420 | vec($_, 2, 4) = 2 == 512 00000000010000000000000000000000 | |
7421 | vec($_, 3, 4) = 2 == 8192 00000000000001000000000000000000 | |
7422 | vec($_, 4, 4) = 2 == 131072 00000000000000000100000000000000 | |
7423 | vec($_, 5, 4) = 2 == 2097152 00000000000000000000010000000000 | |
7424 | vec($_, 6, 4) = 2 == 33554432 00000000000000000000000001000000 | |
7425 | vec($_, 7, 4) = 2 == 536870912 00000000000000000000000000000100 | |
7426 | vec($_, 0, 4) = 4 == 4 00100000000000000000000000000000 | |
7427 | vec($_, 1, 4) = 4 == 64 00000010000000000000000000000000 | |
7428 | vec($_, 2, 4) = 4 == 1024 00000000001000000000000000000000 | |
7429 | vec($_, 3, 4) = 4 == 16384 00000000000000100000000000000000 | |
7430 | vec($_, 4, 4) = 4 == 262144 00000000000000000010000000000000 | |
7431 | vec($_, 5, 4) = 4 == 4194304 00000000000000000000001000000000 | |
7432 | vec($_, 6, 4) = 4 == 67108864 00000000000000000000000000100000 | |
7433 | vec($_, 7, 4) = 4 == 1073741824 00000000000000000000000000000010 | |
7434 | vec($_, 0, 4) = 8 == 8 00010000000000000000000000000000 | |
7435 | vec($_, 1, 4) = 8 == 128 00000001000000000000000000000000 | |
7436 | vec($_, 2, 4) = 8 == 2048 00000000000100000000000000000000 | |
7437 | vec($_, 3, 4) = 8 == 32768 00000000000000010000000000000000 | |
7438 | vec($_, 4, 4) = 8 == 524288 00000000000000000001000000000000 | |
7439 | vec($_, 5, 4) = 8 == 8388608 00000000000000000000000100000000 | |
7440 | vec($_, 6, 4) = 8 == 134217728 00000000000000000000000000010000 | |
7441 | vec($_, 7, 4) = 8 == 2147483648 00000000000000000000000000000001 | |
7442 | vec($_, 0, 8) = 1 == 1 10000000000000000000000000000000 | |
7443 | vec($_, 1, 8) = 1 == 256 00000000100000000000000000000000 | |
7444 | vec($_, 2, 8) = 1 == 65536 00000000000000001000000000000000 | |
7445 | vec($_, 3, 8) = 1 == 16777216 00000000000000000000000010000000 | |
7446 | vec($_, 0, 8) = 2 == 2 01000000000000000000000000000000 | |
7447 | vec($_, 1, 8) = 2 == 512 00000000010000000000000000000000 | |
7448 | vec($_, 2, 8) = 2 == 131072 00000000000000000100000000000000 | |
7449 | vec($_, 3, 8) = 2 == 33554432 00000000000000000000000001000000 | |
7450 | vec($_, 0, 8) = 4 == 4 00100000000000000000000000000000 | |
7451 | vec($_, 1, 8) = 4 == 1024 00000000001000000000000000000000 | |
7452 | vec($_, 2, 8) = 4 == 262144 00000000000000000010000000000000 | |
7453 | vec($_, 3, 8) = 4 == 67108864 00000000000000000000000000100000 | |
7454 | vec($_, 0, 8) = 8 == 8 00010000000000000000000000000000 | |
7455 | vec($_, 1, 8) = 8 == 2048 00000000000100000000000000000000 | |
7456 | vec($_, 2, 8) = 8 == 524288 00000000000000000001000000000000 | |
7457 | vec($_, 3, 8) = 8 == 134217728 00000000000000000000000000010000 | |
7458 | vec($_, 0, 8) = 16 == 16 00001000000000000000000000000000 | |
7459 | vec($_, 1, 8) = 16 == 4096 00000000000010000000000000000000 | |
7460 | vec($_, 2, 8) = 16 == 1048576 00000000000000000000100000000000 | |
7461 | vec($_, 3, 8) = 16 == 268435456 00000000000000000000000000001000 | |
7462 | vec($_, 0, 8) = 32 == 32 00000100000000000000000000000000 | |
7463 | vec($_, 1, 8) = 32 == 8192 00000000000001000000000000000000 | |
7464 | vec($_, 2, 8) = 32 == 2097152 00000000000000000000010000000000 | |
7465 | vec($_, 3, 8) = 32 == 536870912 00000000000000000000000000000100 | |
7466 | vec($_, 0, 8) = 64 == 64 00000010000000000000000000000000 | |
7467 | vec($_, 1, 8) = 64 == 16384 00000000000000100000000000000000 | |
7468 | vec($_, 2, 8) = 64 == 4194304 00000000000000000000001000000000 | |
7469 | vec($_, 3, 8) = 64 == 1073741824 00000000000000000000000000000010 | |
7470 | vec($_, 0, 8) = 128 == 128 00000001000000000000000000000000 | |
7471 | vec($_, 1, 8) = 128 == 32768 00000000000000010000000000000000 | |
7472 | vec($_, 2, 8) = 128 == 8388608 00000000000000000000000100000000 | |
7473 | vec($_, 3, 8) = 128 == 2147483648 00000000000000000000000000000001 | |
7474 | ||
a0d0e21e | 7475 | =item wait |
d74e8afc | 7476 | X<wait> |
a0d0e21e | 7477 | |
3b10bc60 | 7478 | Behaves like wait(2) on your system: it waits for a child |
2b5ab1e7 | 7479 | process to terminate and returns the pid of the deceased process, or |
e5218da5 | 7480 | C<-1> if there are no child processes. The status is returned in C<$?> |
ca8d723e | 7481 | and C<${^CHILD_ERROR_NATIVE}>. |
2b5ab1e7 TC |
7482 | Note that a return value of C<-1> could mean that child processes are |
7483 | being automatically reaped, as described in L<perlipc>. | |
a0d0e21e LW |
7484 | |
7485 | =item waitpid PID,FLAGS | |
d74e8afc | 7486 | X<waitpid> |
a0d0e21e | 7487 | |
2b5ab1e7 TC |
7488 | Waits for a particular child process to terminate and returns the pid of |
7489 | the deceased process, or C<-1> if there is no such child process. On some | |
7490 | systems, a value of 0 indicates that there are processes still running. | |
ca8d723e | 7491 | The status is returned in C<$?> and C<${^CHILD_ERROR_NATIVE}>. If you say |
a0d0e21e | 7492 | |
5f05dabc | 7493 | use POSIX ":sys_wait_h"; |
5a964f20 | 7494 | #... |
b76cc8ba | 7495 | do { |
a9a5a0dc | 7496 | $kid = waitpid(-1, WNOHANG); |
84b74420 | 7497 | } while $kid > 0; |
a0d0e21e | 7498 | |
2b5ab1e7 TC |
7499 | then you can do a non-blocking wait for all pending zombie processes. |
7500 | Non-blocking wait is available on machines supporting either the | |
3b10bc60 | 7501 | waitpid(2) or wait4(2) syscalls. However, waiting for a particular |
2b5ab1e7 TC |
7502 | pid with FLAGS of C<0> is implemented everywhere. (Perl emulates the |
7503 | system call by remembering the status values of processes that have | |
7504 | exited but have not been harvested by the Perl script yet.) | |
a0d0e21e | 7505 | |
2b5ab1e7 TC |
7506 | Note that on some systems, a return value of C<-1> could mean that child |
7507 | processes are being automatically reaped. See L<perlipc> for details, | |
7508 | and for other examples. | |
5a964f20 | 7509 | |
a0d0e21e | 7510 | =item wantarray |
d74e8afc | 7511 | X<wantarray> X<context> |
a0d0e21e | 7512 | |
cc37eb0b | 7513 | Returns true if the context of the currently executing subroutine or |
20f13e4a | 7514 | C<eval> is looking for a list value. Returns false if the context is |
cc37eb0b RGS |
7515 | looking for a scalar. Returns the undefined value if the context is |
7516 | looking for no value (void context). | |
a0d0e21e | 7517 | |
5ed4f2ec | 7518 | return unless defined wantarray; # don't bother doing more |
54310121 | 7519 | my @a = complex_calculation(); |
7520 | return wantarray ? @a : "@a"; | |
a0d0e21e | 7521 | |
20f13e4a | 7522 | C<wantarray()>'s result is unspecified in the top level of a file, |
3c10abe3 AG |
7523 | in a C<BEGIN>, C<UNITCHECK>, C<CHECK>, C<INIT> or C<END> block, or |
7524 | in a C<DESTROY> method. | |
20f13e4a | 7525 | |
19799a22 GS |
7526 | This function should have been named wantlist() instead. |
7527 | ||
a0d0e21e | 7528 | =item warn LIST |
d74e8afc | 7529 | X<warn> X<warning> X<STDERR> |
a0d0e21e | 7530 | |
2d6d0015 | 7531 | Prints the value of LIST to STDERR. If the last element of LIST does |
afd8c9c8 DM |
7532 | not end in a newline, it appends the same file/line number text as C<die> |
7533 | does. | |
774d564b | 7534 | |
a96d0188 | 7535 | If the output is empty and C<$@> already contains a value (typically from a |
7660c0ab | 7536 | previous eval) that value is used after appending C<"\t...caught"> |
19799a22 GS |
7537 | to C<$@>. This is useful for staying almost, but not entirely similar to |
7538 | C<die>. | |
43051805 | 7539 | |
7660c0ab | 7540 | If C<$@> is empty then the string C<"Warning: Something's wrong"> is used. |
43051805 | 7541 | |
774d564b | 7542 | No message is printed if there is a C<$SIG{__WARN__}> handler |
7543 | installed. It is the handler's responsibility to deal with the message | |
19799a22 | 7544 | as it sees fit (like, for instance, converting it into a C<die>). Most |
80d38338 | 7545 | handlers must therefore arrange to actually display the |
19799a22 | 7546 | warnings that they are not prepared to deal with, by calling C<warn> |
774d564b | 7547 | again in the handler. Note that this is quite safe and will not |
7548 | produce an endless loop, since C<__WARN__> hooks are not called from | |
7549 | inside one. | |
7550 | ||
7551 | You will find this behavior is slightly different from that of | |
7552 | C<$SIG{__DIE__}> handlers (which don't suppress the error text, but can | |
19799a22 | 7553 | instead call C<die> again to change it). |
774d564b | 7554 | |
7555 | Using a C<__WARN__> handler provides a powerful way to silence all | |
7556 | warnings (even the so-called mandatory ones). An example: | |
7557 | ||
7558 | # wipe out *all* compile-time warnings | |
7559 | BEGIN { $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN } } | |
7560 | my $foo = 10; | |
7561 | my $foo = 20; # no warning about duplicate my $foo, | |
7562 | # but hey, you asked for it! | |
7563 | # no compile-time or run-time warnings before here | |
7564 | $DOWARN = 1; | |
7565 | ||
7566 | # run-time warnings enabled after here | |
7567 | warn "\$foo is alive and $foo!"; # does show up | |
7568 | ||
7569 | See L<perlvar> for details on setting C<%SIG> entries, and for more | |
2b5ab1e7 TC |
7570 | examples. See the Carp module for other kinds of warnings using its |
7571 | carp() and cluck() functions. | |
a0d0e21e LW |
7572 | |
7573 | =item write FILEHANDLE | |
d74e8afc | 7574 | X<write> |
a0d0e21e LW |
7575 | |
7576 | =item write EXPR | |
7577 | ||
7578 | =item write | |
7579 | ||
5a964f20 | 7580 | Writes a formatted record (possibly multi-line) to the specified FILEHANDLE, |
a0d0e21e | 7581 | using the format associated with that file. By default the format for |
54310121 | 7582 | a file is the one having the same name as the filehandle, but the |
19799a22 | 7583 | format for the current output channel (see the C<select> function) may be set |
184e9718 | 7584 | explicitly by assigning the name of the format to the C<$~> variable. |
a0d0e21e LW |
7585 | |
7586 | Top of form processing is handled automatically: if there is | |
7587 | insufficient room on the current page for the formatted record, the | |
7588 | page is advanced by writing a form feed, a special top-of-page format | |
7589 | is used to format the new page header, and then the record is written. | |
7590 | By default the top-of-page format is the name of the filehandle with | |
7591 | "_TOP" appended, but it may be dynamically set to the format of your | |
184e9718 | 7592 | choice by assigning the name to the C<$^> variable while the filehandle is |
a0d0e21e | 7593 | selected. The number of lines remaining on the current page is in |
7660c0ab | 7594 | variable C<$->, which can be set to C<0> to force a new page. |
a0d0e21e LW |
7595 | |
7596 | If FILEHANDLE is unspecified, output goes to the current default output | |
7597 | channel, which starts out as STDOUT but may be changed by the | |
19799a22 | 7598 | C<select> operator. If the FILEHANDLE is an EXPR, then the expression |
a0d0e21e LW |
7599 | is evaluated and the resulting string is used to look up the name of |
7600 | the FILEHANDLE at run time. For more on formats, see L<perlform>. | |
7601 | ||
19799a22 | 7602 | Note that write is I<not> the opposite of C<read>. Unfortunately. |
a0d0e21e LW |
7603 | |
7604 | =item y/// | |
7605 | ||
9f4b9cd0 SP |
7606 | The transliteration operator. Same as C<tr///>. See |
7607 | L<perlop/"Quote and Quote-like Operators">. | |
a0d0e21e LW |
7608 | |
7609 | =back |