Commit | Line | Data |
a0d0e21e |
1 | =head1 NAME |
2 | |
3 | perlvar - Perl predefined variables |
4 | |
5 | =head1 DESCRIPTION |
6 | |
7 | =head2 Predefined Names |
8 | |
5a964f20 |
9 | The following names have special meaning to Perl. Most |
14218588 |
10 | punctuation names have reasonable mnemonics, or analogs in the |
11 | shells. Nevertheless, if you wish to use long variable names, |
12 | you need only say |
a0d0e21e |
13 | |
14 | use English; |
15 | |
a1ce9542 |
16 | at the top of your program. This aliases all the short names to the long |
17 | names in the current package. Some even have medium names, generally |
18 | borrowed from B<awk>. In general, it's best to use the |
a0d0e21e |
19 | |
a1ce9542 |
20 | use English '-no_match_vars'; |
21 | |
22 | invocation if you don't need $PREMATCH, $MATCH, or $POSTMATCH, as it avoids |
23 | a certain performance hit with the use of regular expressions. See |
24 | L<English>. |
25 | |
26 | Variables that depend on the currently selected filehandle may be set by |
27 | calling an appropriate object method on the IO::Handle object, although |
28 | this is less efficient than using the regular built-in variables. (Summary |
29 | lines below for this contain the word HANDLE.) First you must say |
a0d0e21e |
30 | |
19799a22 |
31 | use IO::Handle; |
a0d0e21e |
32 | |
33 | after which you may use either |
34 | |
35 | method HANDLE EXPR |
36 | |
5a964f20 |
37 | or more safely, |
a0d0e21e |
38 | |
39 | HANDLE->method(EXPR) |
40 | |
14218588 |
41 | Each method returns the old value of the IO::Handle attribute. |
a1ce9542 |
42 | The methods each take an optional EXPR, which, if supplied, specifies the |
19799a22 |
43 | new value for the IO::Handle attribute in question. If not supplied, |
14218588 |
44 | most methods do nothing to the current value--except for |
a0d0e21e |
45 | autoflush(), which will assume a 1 for you, just to be different. |
a1ce9542 |
46 | |
14218588 |
47 | Because loading in the IO::Handle class is an expensive operation, you should |
19799a22 |
48 | learn how to use the regular built-in variables. |
a0d0e21e |
49 | |
748a9306 |
50 | A few of these variables are considered "read-only". This means that if |
51 | you try to assign to this variable, either directly or indirectly through |
52 | a reference, you'll raise a run-time exception. |
a0d0e21e |
53 | |
22d0716c |
54 | You should be very careful when modifying the default values of most |
55 | special variables described in this document. In most cases you want |
56 | to localize these variables before changing them, since if you don't, |
57 | the change may affect other modules which rely on the default values |
58 | of the special variables that you have changed. This is one of the |
59 | correct ways to read the whole file at once: |
60 | |
61 | open my $fh, "foo" or die $!; |
62 | local $/; # enable localized slurp mode |
63 | my $content = <$fh>; |
64 | close $fh; |
65 | |
66 | But the following code is quite bad: |
67 | |
68 | open my $fh, "foo" or die $!; |
69 | undef $/; # enable slurp mode |
70 | my $content = <$fh>; |
71 | close $fh; |
72 | |
73 | since some other module, may want to read data from some file in the |
74 | default "line mode", so if the code we have just presented has been |
75 | executed, the global value of C<$/> is now changed for any other code |
76 | running inside the same Perl interpreter. |
77 | |
78 | Usually when a variable is localized you want to make sure that this |
79 | change affects the shortest scope possible. So unless you are already |
80 | inside some short C<{}> block, you should create one yourself. For |
81 | example: |
82 | |
83 | my $content = ''; |
84 | open my $fh, "foo" or die $!; |
85 | { |
86 | local $/; |
87 | $content = <$fh>; |
88 | } |
89 | close $fh; |
90 | |
91 | Here is an example of how your own code can go broken: |
92 | |
93 | for (1..5){ |
94 | nasty_break(); |
95 | print "$_ "; |
96 | } |
97 | sub nasty_break { |
98 | $_ = 5; |
99 | # do something with $_ |
100 | } |
101 | |
102 | You probably expect this code to print: |
103 | |
104 | 1 2 3 4 5 |
105 | |
106 | but instead you get: |
107 | |
108 | 5 5 5 5 5 |
109 | |
110 | Why? Because nasty_break() modifies C<$_> without localizing it |
111 | first. The fix is to add local(): |
112 | |
113 | local $_ = 5; |
114 | |
115 | It's easy to notice the problem in such a short example, but in more |
116 | complicated code you are looking for trouble if you don't localize |
117 | changes to the special variables. |
118 | |
fb73857a |
119 | The following list is ordered by scalar variables first, then the |
87275199 |
120 | arrays, then the hashes. |
fb73857a |
121 | |
a0d0e21e |
122 | =over 8 |
123 | |
124 | =item $ARG |
125 | |
126 | =item $_ |
127 | |
128 | The default input and pattern-searching space. The following pairs are |
129 | equivalent: |
130 | |
19799a22 |
131 | while (<>) {...} # equivalent only in while! |
54310121 |
132 | while (defined($_ = <>)) {...} |
a0d0e21e |
133 | |
134 | /^Subject:/ |
135 | $_ =~ /^Subject:/ |
136 | |
137 | tr/a-z/A-Z/ |
138 | $_ =~ tr/a-z/A-Z/ |
139 | |
19799a22 |
140 | chomp |
141 | chomp($_) |
a0d0e21e |
142 | |
54310121 |
143 | Here are the places where Perl will assume $_ even if you |
cb1a09d0 |
144 | don't use it: |
145 | |
146 | =over 3 |
147 | |
148 | =item * |
149 | |
150 | Various unary functions, including functions like ord() and int(), as well |
151 | as the all file tests (C<-f>, C<-d>) except for C<-t>, which defaults to |
152 | STDIN. |
153 | |
154 | =item * |
155 | |
156 | Various list functions like print() and unlink(). |
157 | |
158 | =item * |
159 | |
160 | The pattern matching operations C<m//>, C<s///>, and C<tr///> when used |
161 | without an C<=~> operator. |
162 | |
54310121 |
163 | =item * |
cb1a09d0 |
164 | |
165 | The default iterator variable in a C<foreach> loop if no other |
166 | variable is supplied. |
167 | |
54310121 |
168 | =item * |
cb1a09d0 |
169 | |
170 | The implicit iterator variable in the grep() and map() functions. |
171 | |
54310121 |
172 | =item * |
cb1a09d0 |
173 | |
c47ff5f1 |
174 | The default place to put an input record when a C<< <FH> >> |
cb1a09d0 |
175 | operation's result is tested by itself as the sole criterion of a C<while> |
14218588 |
176 | test. Outside a C<while> test, this will not happen. |
cb1a09d0 |
177 | |
178 | =back |
179 | |
59f00321 |
180 | As C<$_> is a global variable, this may lead in some cases to unwanted |
181 | side-effects. As of perl 5.9.1, you can now use a lexical version of |
182 | C<$_> by declaring it in a file or in a block with C<my>. Moreover, |
183 | declaring C<our $> restores the global C<$_> in the current scope. |
184 | |
a0d0e21e |
185 | (Mnemonic: underline is understood in certain operations.) |
186 | |
6e2995f4 |
187 | =back |
188 | |
189 | =over 8 |
190 | |
a1db74c9 |
191 | =item $a |
192 | |
193 | =item $b |
194 | |
195 | Special package variables when using sort(), see L<perlfunc/sort>. |
196 | Because of this specialness $a and $b don't need to be declared |
f83912f2 |
197 | (using use vars, or our()) even when using the C<strict 'vars'> pragma. |
198 | Don't lexicalize them with C<my $a> or C<my $b> if you want to be |
199 | able to use them in the sort() comparison block or function. |
a1db74c9 |
200 | |
201 | =back |
202 | |
203 | =over 8 |
204 | |
c47ff5f1 |
205 | =item $<I<digits>> |
a0d0e21e |
206 | |
19799a22 |
207 | Contains the subpattern from the corresponding set of capturing |
208 | parentheses from the last pattern match, not counting patterns |
209 | matched in nested blocks that have been exited already. (Mnemonic: |
210 | like \digits.) These variables are all read-only and dynamically |
211 | scoped to the current BLOCK. |
a0d0e21e |
212 | |
213 | =item $MATCH |
214 | |
215 | =item $& |
216 | |
217 | The string matched by the last successful pattern match (not counting |
218 | any matches hidden within a BLOCK or eval() enclosed by the current |
19799a22 |
219 | BLOCK). (Mnemonic: like & in some editors.) This variable is read-only |
220 | and dynamically scoped to the current BLOCK. |
a0d0e21e |
221 | |
19ddd453 |
222 | The use of this variable anywhere in a program imposes a considerable |
667e1aea |
223 | performance penalty on all regular expression matches. See L</BUGS>. |
19ddd453 |
224 | |
a0d0e21e |
225 | =item $PREMATCH |
226 | |
227 | =item $` |
228 | |
229 | The string preceding whatever was matched by the last successful |
230 | pattern match (not counting any matches hidden within a BLOCK or eval |
a8f8344d |
231 | enclosed by the current BLOCK). (Mnemonic: C<`> often precedes a quoted |
a0d0e21e |
232 | string.) This variable is read-only. |
233 | |
19ddd453 |
234 | The use of this variable anywhere in a program imposes a considerable |
667e1aea |
235 | performance penalty on all regular expression matches. See L</BUGS>. |
19ddd453 |
236 | |
a0d0e21e |
237 | =item $POSTMATCH |
238 | |
239 | =item $' |
240 | |
241 | The string following whatever was matched by the last successful |
242 | pattern match (not counting any matches hidden within a BLOCK or eval() |
a8f8344d |
243 | enclosed by the current BLOCK). (Mnemonic: C<'> often follows a quoted |
a0d0e21e |
244 | string.) Example: |
245 | |
22d0716c |
246 | local $_ = 'abcdefghi'; |
a0d0e21e |
247 | /def/; |
248 | print "$`:$&:$'\n"; # prints abc:def:ghi |
249 | |
19799a22 |
250 | This variable is read-only and dynamically scoped to the current BLOCK. |
a0d0e21e |
251 | |
19ddd453 |
252 | The use of this variable anywhere in a program imposes a considerable |
667e1aea |
253 | performance penalty on all regular expression matches. See L</BUGS>. |
19ddd453 |
254 | |
a0d0e21e |
255 | =item $LAST_PAREN_MATCH |
256 | |
257 | =item $+ |
258 | |
a01268b5 |
259 | The text matched by the last bracket of the last successful search pattern. |
260 | This is useful if you don't know which one of a set of alternative patterns |
261 | matched. For example: |
a0d0e21e |
262 | |
263 | /Version: (.*)|Revision: (.*)/ && ($rev = $+); |
264 | |
265 | (Mnemonic: be positive and forward looking.) |
19799a22 |
266 | This variable is read-only and dynamically scoped to the current BLOCK. |
a0d0e21e |
267 | |
a01268b5 |
268 | =item $^N |
269 | |
270 | The text matched by the used group most-recently closed (i.e. the group |
271 | with the rightmost closing parenthesis) of the last successful search |
ad83b128 |
272 | pattern. (Mnemonic: the (possibly) Nested parenthesis that most |
273 | recently closed.) |
274 | |
210b36aa |
275 | This is primarily used inside C<(?{...})> blocks for examining text |
a01268b5 |
276 | recently matched. For example, to effectively capture text to a variable |
277 | (in addition to C<$1>, C<$2>, etc.), replace C<(...)> with |
278 | |
279 | (?:(...)(?{ $var = $^N })) |
280 | |
281 | By setting and then using C<$var> in this way relieves you from having to |
282 | worry about exactly which numbered set of parentheses they are. |
283 | |
284 | This variable is dynamically scoped to the current BLOCK. |
285 | |
fe307981 |
286 | =item @LAST_MATCH_END |
287 | |
6cef1e77 |
288 | =item @+ |
289 | |
4ba05bdc |
290 | This array holds the offsets of the ends of the last successful |
291 | submatches in the currently active dynamic scope. C<$+[0]> is |
292 | the offset into the string of the end of the entire match. This |
293 | is the same value as what the C<pos> function returns when called |
294 | on the variable that was matched against. The I<n>th element |
295 | of this array holds the offset of the I<n>th submatch, so |
296 | C<$+[1]> is the offset past where $1 ends, C<$+[2]> the offset |
297 | past where $2 ends, and so on. You can use C<$#+> to determine |
298 | how many subgroups were in the last successful match. See the |
299 | examples given for the C<@-> variable. |
6cef1e77 |
300 | |
fcc7d916 |
301 | =item HANDLE->input_line_number(EXPR) |
a0d0e21e |
302 | |
303 | =item $INPUT_LINE_NUMBER |
304 | |
305 | =item $NR |
306 | |
307 | =item $. |
308 | |
fcc7d916 |
309 | Current line number for the last filehandle accessed. |
310 | |
311 | Each filehandle in Perl counts the number of lines that have been read |
312 | from it. (Depending on the value of C<$/>, Perl's idea of what |
313 | constitutes a line may not match yours.) When a line is read from a |
314 | filehandle (via readline() or C<< <> >>), or when tell() or seek() is |
315 | called on it, C<$.> becomes an alias to the line counter for that |
316 | filehandle. |
317 | |
318 | You can adjust the counter by assigning to C<$.>, but this will not |
319 | actually move the seek pointer. I<Localizing C<$.> will not localize |
320 | the filehandle's line count>. Instead, it will localize perl's notion |
321 | of which filehandle C<$.> is currently aliased to. |
322 | |
323 | C<$.> is reset when the filehandle is closed, but B<not> when an open |
324 | filehandle is reopened without an intervening close(). For more |
e48df184 |
325 | details, see L<perlop/"IE<sol>O Operators">. Because C<< <> >> never does |
fcc7d916 |
326 | an explicit close, line numbers increase across ARGV files (but see |
327 | examples in L<perlfunc/eof>). |
328 | |
329 | You can also use C<< HANDLE->input_line_number(EXPR) >> to access the |
330 | line counter for a given filehandle without having to worry about |
331 | which handle you last accessed. |
332 | |
333 | (Mnemonic: many programs use "." to mean the current line number.) |
334 | |
335 | =item IO::Handle->input_record_separator(EXPR) |
a0d0e21e |
336 | |
337 | =item $INPUT_RECORD_SEPARATOR |
338 | |
339 | =item $RS |
340 | |
341 | =item $/ |
342 | |
14218588 |
343 | The input record separator, newline by default. This |
344 | influences Perl's idea of what a "line" is. Works like B<awk>'s RS |
19799a22 |
345 | variable, including treating empty lines as a terminator if set to |
14218588 |
346 | the null string. (An empty line cannot contain any spaces |
347 | or tabs.) You may set it to a multi-character string to match a |
19799a22 |
348 | multi-character terminator, or to C<undef> to read through the end |
349 | of file. Setting it to C<"\n\n"> means something slightly |
350 | different than setting to C<"">, if the file contains consecutive |
351 | empty lines. Setting to C<""> will treat two or more consecutive |
352 | empty lines as a single empty line. Setting to C<"\n\n"> will |
353 | blindly assume that the next input character belongs to the next |
14218588 |
354 | paragraph, even if it's a newline. (Mnemonic: / delimits |
19799a22 |
355 | line boundaries when quoting poetry.) |
a0d0e21e |
356 | |
22d0716c |
357 | local $/; # enable "slurp" mode |
358 | local $_ = <FH>; # whole file now here |
a0d0e21e |
359 | s/\n[ \t]+/ /g; |
360 | |
19799a22 |
361 | Remember: the value of C<$/> is a string, not a regex. B<awk> has to be |
362 | better for something. :-) |
68dc0745 |
363 | |
19799a22 |
364 | Setting C<$/> to a reference to an integer, scalar containing an integer, or |
365 | scalar that's convertible to an integer will attempt to read records |
5b2b9c68 |
366 | instead of lines, with the maximum record size being the referenced |
19799a22 |
367 | integer. So this: |
5b2b9c68 |
368 | |
22d0716c |
369 | local $/ = \32768; # or \"32768", or \$var_containing_32768 |
370 | open my $fh, $myfile or die $!; |
371 | local $_ = <$fh>; |
5b2b9c68 |
372 | |
19799a22 |
373 | will read a record of no more than 32768 bytes from FILE. If you're |
374 | not reading from a record-oriented file (or your OS doesn't have |
375 | record-oriented files), then you'll likely get a full chunk of data |
376 | with every read. If a record is larger than the record size you've |
377 | set, you'll get the record back in pieces. |
5b2b9c68 |
378 | |
19799a22 |
379 | On VMS, record reads are done with the equivalent of C<sysread>, |
380 | so it's best not to mix record and non-record reads on the same |
381 | file. (This is unlikely to be a problem, because any file you'd |
83763826 |
382 | want to read in record mode is probably unusable in line mode.) |
14218588 |
383 | Non-VMS systems do normal I/O, so it's safe to mix record and |
19799a22 |
384 | non-record reads of a file. |
5b2b9c68 |
385 | |
14218588 |
386 | See also L<perlport/"Newlines">. Also see C<$.>. |
883faa13 |
387 | |
fcc7d916 |
388 | =item HANDLE->autoflush(EXPR) |
a0d0e21e |
389 | |
390 | =item $OUTPUT_AUTOFLUSH |
391 | |
392 | =item $| |
393 | |
19799a22 |
394 | If set to nonzero, forces a flush right away and after every write |
395 | or print on the currently selected output channel. Default is 0 |
14218588 |
396 | (regardless of whether the channel is really buffered by the |
19799a22 |
397 | system or not; C<$|> tells you only whether you've asked Perl |
398 | explicitly to flush after each write). STDOUT will |
399 | typically be line buffered if output is to the terminal and block |
400 | buffered otherwise. Setting this variable is useful primarily when |
401 | you are outputting to a pipe or socket, such as when you are running |
402 | a Perl program under B<rsh> and want to see the output as it's |
403 | happening. This has no effect on input buffering. See L<perlfunc/getc> |
404 | for that. (Mnemonic: when you want your pipes to be piping hot.) |
a0d0e21e |
405 | |
46550894 |
406 | =item IO::Handle->output_field_separator EXPR |
a0d0e21e |
407 | |
408 | =item $OUTPUT_FIELD_SEPARATOR |
409 | |
410 | =item $OFS |
411 | |
412 | =item $, |
413 | |
d6584ed8 |
414 | The output field separator for the print operator. If defined, this |
415 | value is printed between each of print's arguments. Default is C<undef>. |
416 | (Mnemonic: what is printed when there is a "," in your print statement.) |
a0d0e21e |
417 | |
46550894 |
418 | =item IO::Handle->output_record_separator EXPR |
a0d0e21e |
419 | |
420 | =item $OUTPUT_RECORD_SEPARATOR |
421 | |
422 | =item $ORS |
423 | |
424 | =item $\ |
425 | |
d6584ed8 |
426 | The output record separator for the print operator. If defined, this |
427 | value is printed after the last of print's arguments. Default is C<undef>. |
428 | (Mnemonic: you set C<$\> instead of adding "\n" at the end of the print. |
429 | Also, it's just like C<$/>, but it's what you get "back" from Perl.) |
a0d0e21e |
430 | |
431 | =item $LIST_SEPARATOR |
432 | |
433 | =item $" |
434 | |
19799a22 |
435 | This is like C<$,> except that it applies to array and slice values |
436 | interpolated into a double-quoted string (or similar interpreted |
437 | string). Default is a space. (Mnemonic: obvious, I think.) |
a0d0e21e |
438 | |
439 | =item $SUBSCRIPT_SEPARATOR |
440 | |
441 | =item $SUBSEP |
442 | |
443 | =item $; |
444 | |
54310121 |
445 | The subscript separator for multidimensional array emulation. If you |
a0d0e21e |
446 | refer to a hash element as |
447 | |
448 | $foo{$a,$b,$c} |
449 | |
450 | it really means |
451 | |
452 | $foo{join($;, $a, $b, $c)} |
453 | |
454 | But don't put |
455 | |
456 | @foo{$a,$b,$c} # a slice--note the @ |
457 | |
458 | which means |
459 | |
460 | ($foo{$a},$foo{$b},$foo{$c}) |
461 | |
19799a22 |
462 | Default is "\034", the same as SUBSEP in B<awk>. If your |
463 | keys contain binary data there might not be any safe value for C<$;>. |
a0d0e21e |
464 | (Mnemonic: comma (the syntactic subscript separator) is a |
19799a22 |
465 | semi-semicolon. Yeah, I know, it's pretty lame, but C<$,> is already |
a0d0e21e |
466 | taken for something more important.) |
467 | |
19799a22 |
468 | Consider using "real" multidimensional arrays as described |
469 | in L<perllol>. |
a0d0e21e |
470 | |
fcc7d916 |
471 | =item HANDLE->format_page_number(EXPR) |
a0d0e21e |
472 | |
473 | =item $FORMAT_PAGE_NUMBER |
474 | |
475 | =item $% |
476 | |
477 | The current page number of the currently selected output channel. |
19799a22 |
478 | Used with formats. |
a0d0e21e |
479 | (Mnemonic: % is page number in B<nroff>.) |
480 | |
fcc7d916 |
481 | =item HANDLE->format_lines_per_page(EXPR) |
a0d0e21e |
482 | |
483 | =item $FORMAT_LINES_PER_PAGE |
484 | |
485 | =item $= |
486 | |
487 | The current page length (printable lines) of the currently selected |
19799a22 |
488 | output channel. Default is 60. |
489 | Used with formats. |
490 | (Mnemonic: = has horizontal lines.) |
a0d0e21e |
491 | |
fcc7d916 |
492 | =item HANDLE->format_lines_left(EXPR) |
a0d0e21e |
493 | |
494 | =item $FORMAT_LINES_LEFT |
495 | |
496 | =item $- |
497 | |
498 | The number of lines left on the page of the currently selected output |
19799a22 |
499 | channel. |
500 | Used with formats. |
501 | (Mnemonic: lines_on_page - lines_printed.) |
a0d0e21e |
502 | |
fe307981 |
503 | =item @LAST_MATCH_START |
504 | |
6cef1e77 |
505 | =item @- |
506 | |
19799a22 |
507 | $-[0] is the offset of the start of the last successful match. |
6cef1e77 |
508 | C<$-[>I<n>C<]> is the offset of the start of the substring matched by |
8f580fb8 |
509 | I<n>-th subpattern, or undef if the subpattern did not match. |
6cef1e77 |
510 | |
511 | Thus after a match against $_, $& coincides with C<substr $_, $-[0], |
5060ef7b |
512 | $+[0] - $-[0]>. Similarly, $I<n> coincides with C<substr $_, $-[n], |
513 | $+[n] - $-[n]> if C<$-[n]> is defined, and $+ coincides with |
514 | C<substr $_, $-[$#-], $+[$#-] - $-[$#-]>. One can use C<$#-> to find the last |
14218588 |
515 | matched subgroup in the last successful match. Contrast with |
516 | C<$#+>, the number of subgroups in the regular expression. Compare |
19799a22 |
517 | with C<@+>. |
6cef1e77 |
518 | |
4ba05bdc |
519 | This array holds the offsets of the beginnings of the last |
520 | successful submatches in the currently active dynamic scope. |
521 | C<$-[0]> is the offset into the string of the beginning of the |
522 | entire match. The I<n>th element of this array holds the offset |
0926d669 |
523 | of the I<n>th submatch, so C<$-[1]> is the offset where $1 |
524 | begins, C<$-[2]> the offset where $2 begins, and so on. |
4ba05bdc |
525 | |
526 | After a match against some variable $var: |
527 | |
528 | =over 5 |
529 | |
4375e838 |
530 | =item C<$`> is the same as C<substr($var, 0, $-[0])> |
4ba05bdc |
531 | |
4375e838 |
532 | =item C<$&> is the same as C<substr($var, $-[0], $+[0] - $-[0])> |
4ba05bdc |
533 | |
4375e838 |
534 | =item C<$'> is the same as C<substr($var, $+[0])> |
4ba05bdc |
535 | |
536 | =item C<$1> is the same as C<substr($var, $-[1], $+[1] - $-[1])> |
537 | |
538 | =item C<$2> is the same as C<substr($var, $-[2], $+[2] - $-[2])> |
539 | |
80dc6883 |
540 | =item C<$3> is the same as C<substr($var, $-[3], $+[3] - $-[3])> |
4ba05bdc |
541 | |
542 | =back |
543 | |
fcc7d916 |
544 | =item HANDLE->format_name(EXPR) |
a0d0e21e |
545 | |
546 | =item $FORMAT_NAME |
547 | |
548 | =item $~ |
549 | |
550 | The name of the current report format for the currently selected output |
14218588 |
551 | channel. Default is the name of the filehandle. (Mnemonic: brother to |
19799a22 |
552 | C<$^>.) |
a0d0e21e |
553 | |
fcc7d916 |
554 | =item HANDLE->format_top_name(EXPR) |
a0d0e21e |
555 | |
556 | =item $FORMAT_TOP_NAME |
557 | |
558 | =item $^ |
559 | |
560 | The name of the current top-of-page format for the currently selected |
14218588 |
561 | output channel. Default is the name of the filehandle with _TOP |
a0d0e21e |
562 | appended. (Mnemonic: points to top of page.) |
563 | |
46550894 |
564 | =item IO::Handle->format_line_break_characters EXPR |
a0d0e21e |
565 | |
566 | =item $FORMAT_LINE_BREAK_CHARACTERS |
567 | |
568 | =item $: |
569 | |
570 | The current set of characters after which a string may be broken to |
54310121 |
571 | fill continuation fields (starting with ^) in a format. Default is |
a0d0e21e |
572 | S<" \n-">, to break on whitespace or hyphens. (Mnemonic: a "colon" in |
573 | poetry is a part of a line.) |
574 | |
46550894 |
575 | =item IO::Handle->format_formfeed EXPR |
a0d0e21e |
576 | |
577 | =item $FORMAT_FORMFEED |
578 | |
579 | =item $^L |
580 | |
14218588 |
581 | What formats output as a form feed. Default is \f. |
a0d0e21e |
582 | |
583 | =item $ACCUMULATOR |
584 | |
585 | =item $^A |
586 | |
587 | The current value of the write() accumulator for format() lines. A format |
19799a22 |
588 | contains formline() calls that put their result into C<$^A>. After |
a0d0e21e |
589 | calling its format, write() prints out the contents of C<$^A> and empties. |
14218588 |
590 | So you never really see the contents of C<$^A> unless you call |
a0d0e21e |
591 | formline() yourself and then look at it. See L<perlform> and |
592 | L<perlfunc/formline()>. |
593 | |
594 | =item $CHILD_ERROR |
595 | |
596 | =item $? |
597 | |
54310121 |
598 | The status returned by the last pipe close, backtick (C<``>) command, |
19799a22 |
599 | successful call to wait() or waitpid(), or from the system() |
600 | operator. This is just the 16-bit status word returned by the |
e5218da5 |
601 | traditional Unix wait() system call (or else is made up to look like it). Thus, the |
c47ff5f1 |
602 | exit value of the subprocess is really (C<<< $? >> 8 >>>), and |
19799a22 |
603 | C<$? & 127> gives which signal, if any, the process died from, and |
604 | C<$? & 128> reports whether there was a core dump. (Mnemonic: |
605 | similar to B<sh> and B<ksh>.) |
a0d0e21e |
606 | |
7b8d334a |
607 | Additionally, if the C<h_errno> variable is supported in C, its value |
14218588 |
608 | is returned via $? if any C<gethost*()> function fails. |
7b8d334a |
609 | |
19799a22 |
610 | If you have installed a signal handler for C<SIGCHLD>, the |
aa689395 |
611 | value of C<$?> will usually be wrong outside that handler. |
612 | |
a8f8344d |
613 | Inside an C<END> subroutine C<$?> contains the value that is going to be |
614 | given to C<exit()>. You can modify C<$?> in an C<END> subroutine to |
19799a22 |
615 | change the exit status of your program. For example: |
616 | |
617 | END { |
618 | $? = 1 if $? == 255; # die would make it 255 |
619 | } |
a8f8344d |
620 | |
aa689395 |
621 | Under VMS, the pragma C<use vmsish 'status'> makes C<$?> reflect the |
ff0cee69 |
622 | actual VMS exit status, instead of the default emulation of POSIX |
9bc98430 |
623 | status; see L<perlvms/$?> for details. |
f86702cc |
624 | |
55602bd2 |
625 | Also see L<Error Indicators>. |
626 | |
e5218da5 |
627 | =item ${^CHILD_ERROR_NATIVE} |
628 | |
629 | The native status returned by the last pipe close, backtick (C<``>) |
630 | command, successful call to wait() or waitpid(), or from the system() |
631 | operator. On POSIX-like systems this value can be decoded with the |
632 | WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG, WIFSTOPPED, WSTOPSIG |
633 | and WIFCONTINUED functions provided by the L<POSIX> module. |
634 | |
635 | Under VMS this reflects the actual VMS exit status; i.e. it is the same |
636 | as $? when the pragma C<use vmsish 'status'> is in effect. |
637 | |
0a378802 |
638 | =item ${^ENCODING} |
639 | |
740bd165 |
640 | The I<object reference> to the Encode object that is used to convert |
641 | the source code to Unicode. Thanks to this variable your perl script |
642 | does not have to be written in UTF-8. Default is I<undef>. The direct |
643 | manipulation of this variable is highly discouraged. See L<encoding> |
048c20cb |
644 | for more details. |
0a378802 |
645 | |
a0d0e21e |
646 | =item $OS_ERROR |
647 | |
648 | =item $ERRNO |
649 | |
650 | =item $! |
651 | |
19799a22 |
652 | If used numerically, yields the current value of the C C<errno> |
6ab308ee |
653 | variable, or in other words, if a system or library call fails, it |
654 | sets this variable. This means that the value of C<$!> is meaningful |
655 | only I<immediately> after a B<failure>: |
656 | |
657 | if (open(FH, $filename)) { |
658 | # Here $! is meaningless. |
659 | ... |
660 | } else { |
661 | # ONLY here is $! meaningful. |
662 | ... |
663 | # Already here $! might be meaningless. |
664 | } |
665 | # Since here we might have either success or failure, |
666 | # here $! is meaningless. |
667 | |
668 | In the above I<meaningless> stands for anything: zero, non-zero, |
669 | C<undef>. A successful system or library call does B<not> set |
670 | the variable to zero. |
671 | |
271df126 |
672 | If used as a string, yields the corresponding system error string. |
19799a22 |
673 | You can assign a number to C<$!> to set I<errno> if, for instance, |
674 | you want C<"$!"> to return the string for error I<n>, or you want |
675 | to set the exit value for the die() operator. (Mnemonic: What just |
676 | went bang?) |
a0d0e21e |
677 | |
55602bd2 |
678 | Also see L<Error Indicators>. |
679 | |
4c5cef9b |
680 | =item %! |
681 | |
682 | Each element of C<%!> has a true value only if C<$!> is set to that |
683 | value. For example, C<$!{ENOENT}> is true if and only if the current |
3be065a1 |
684 | value of C<$!> is C<ENOENT>; that is, if the most recent error was |
685 | "No such file or directory" (or its moral equivalent: not all operating |
686 | systems give that exact error, and certainly not all languages). |
687 | To check if a particular key is meaningful on your system, use |
688 | C<exists $!{the_key}>; for a list of legal keys, use C<keys %!>. |
689 | See L<Errno> for more information, and also see above for the |
690 | validity of C<$!>. |
4c5cef9b |
691 | |
5c055ba3 |
692 | =item $EXTENDED_OS_ERROR |
693 | |
694 | =item $^E |
695 | |
22fae026 |
696 | Error information specific to the current operating system. At |
697 | the moment, this differs from C<$!> under only VMS, OS/2, and Win32 |
698 | (and for MacPerl). On all other platforms, C<$^E> is always just |
699 | the same as C<$!>. |
700 | |
701 | Under VMS, C<$^E> provides the VMS status value from the last |
702 | system error. This is more specific information about the last |
703 | system error than that provided by C<$!>. This is particularly |
d516a115 |
704 | important when C<$!> is set to B<EVMSERR>. |
22fae026 |
705 | |
1c1c7f20 |
706 | Under OS/2, C<$^E> is set to the error code of the last call to |
707 | OS/2 API either via CRT, or directly from perl. |
22fae026 |
708 | |
709 | Under Win32, C<$^E> always returns the last error information |
710 | reported by the Win32 call C<GetLastError()> which describes |
711 | the last error from within the Win32 API. Most Win32-specific |
19799a22 |
712 | code will report errors via C<$^E>. ANSI C and Unix-like calls |
22fae026 |
713 | set C<errno> and so most portable Perl code will report errors |
714 | via C<$!>. |
715 | |
716 | Caveats mentioned in the description of C<$!> generally apply to |
717 | C<$^E>, also. (Mnemonic: Extra error explanation.) |
5c055ba3 |
718 | |
55602bd2 |
719 | Also see L<Error Indicators>. |
720 | |
a0d0e21e |
721 | =item $EVAL_ERROR |
722 | |
723 | =item $@ |
724 | |
4a280ebe |
725 | The Perl syntax error message from the last eval() operator. |
726 | If $@ is the null string, the last eval() parsed and executed |
727 | correctly (although the operations you invoked may have failed in the |
728 | normal fashion). (Mnemonic: Where was the syntax error "at"?) |
a0d0e21e |
729 | |
19799a22 |
730 | Warning messages are not collected in this variable. You can, |
a8f8344d |
731 | however, set up a routine to process warnings by setting C<$SIG{__WARN__}> |
54310121 |
732 | as described below. |
748a9306 |
733 | |
55602bd2 |
734 | Also see L<Error Indicators>. |
735 | |
a0d0e21e |
736 | =item $PROCESS_ID |
737 | |
738 | =item $PID |
739 | |
740 | =item $$ |
741 | |
19799a22 |
742 | The process number of the Perl running this script. You should |
743 | consider this variable read-only, although it will be altered |
744 | across fork() calls. (Mnemonic: same as shells.) |
a0d0e21e |
745 | |
4d76a344 |
746 | Note for Linux users: on Linux, the C functions C<getpid()> and |
747 | C<getppid()> return different values from different threads. In order to |
748 | be portable, this behavior is not reflected by C<$$>, whose value remains |
749 | consistent across threads. If you want to call the underlying C<getpid()>, |
e3256f86 |
750 | you may use the CPAN module C<Linux::Pid>. |
4d76a344 |
751 | |
a0d0e21e |
752 | =item $REAL_USER_ID |
753 | |
754 | =item $UID |
755 | |
756 | =item $< |
757 | |
19799a22 |
758 | The real uid of this process. (Mnemonic: it's the uid you came I<from>, |
a043a685 |
759 | if you're running setuid.) You can change both the real uid and |
a537debe |
760 | the effective uid at the same time by using POSIX::setuid(). Since |
761 | changes to $< require a system call, check $! after a change attempt to |
762 | detect any possible errors. |
a0d0e21e |
763 | |
764 | =item $EFFECTIVE_USER_ID |
765 | |
766 | =item $EUID |
767 | |
768 | =item $> |
769 | |
770 | The effective uid of this process. Example: |
771 | |
772 | $< = $>; # set real to effective uid |
773 | ($<,$>) = ($>,$<); # swap real and effective uid |
774 | |
a043a685 |
775 | You can change both the effective uid and the real uid at the same |
a537debe |
776 | time by using POSIX::setuid(). Changes to $> require a check to $! |
777 | to detect any possible errors after an attempted change. |
a043a685 |
778 | |
19799a22 |
779 | (Mnemonic: it's the uid you went I<to>, if you're running setuid.) |
c47ff5f1 |
780 | C<< $< >> and C<< $> >> can be swapped only on machines |
8cc95fdb |
781 | supporting setreuid(). |
a0d0e21e |
782 | |
783 | =item $REAL_GROUP_ID |
784 | |
785 | =item $GID |
786 | |
787 | =item $( |
788 | |
789 | The real gid of this process. If you are on a machine that supports |
790 | membership in multiple groups simultaneously, gives a space separated |
791 | list of groups you are in. The first number is the one returned by |
792 | getgid(), and the subsequent ones by getgroups(), one of which may be |
8cc95fdb |
793 | the same as the first number. |
794 | |
19799a22 |
795 | However, a value assigned to C<$(> must be a single number used to |
796 | set the real gid. So the value given by C<$(> should I<not> be assigned |
797 | back to C<$(> without being forced numeric, such as by adding zero. |
8cc95fdb |
798 | |
a043a685 |
799 | You can change both the real gid and the effective gid at the same |
a537debe |
800 | time by using POSIX::setgid(). Changes to $( require a check to $! |
801 | to detect any possible errors after an attempted change. |
a043a685 |
802 | |
19799a22 |
803 | (Mnemonic: parentheses are used to I<group> things. The real gid is the |
804 | group you I<left>, if you're running setgid.) |
a0d0e21e |
805 | |
806 | =item $EFFECTIVE_GROUP_ID |
807 | |
808 | =item $EGID |
809 | |
810 | =item $) |
811 | |
812 | The effective gid of this process. If you are on a machine that |
813 | supports membership in multiple groups simultaneously, gives a space |
814 | separated list of groups you are in. The first number is the one |
815 | returned by getegid(), and the subsequent ones by getgroups(), one of |
8cc95fdb |
816 | which may be the same as the first number. |
817 | |
19799a22 |
818 | Similarly, a value assigned to C<$)> must also be a space-separated |
14218588 |
819 | list of numbers. The first number sets the effective gid, and |
8cc95fdb |
820 | the rest (if any) are passed to setgroups(). To get the effect of an |
821 | empty list for setgroups(), just repeat the new effective gid; that is, |
822 | to force an effective gid of 5 and an effectively empty setgroups() |
823 | list, say C< $) = "5 5" >. |
824 | |
a043a685 |
825 | You can change both the effective gid and the real gid at the same |
826 | time by using POSIX::setgid() (use only a single numeric argument). |
a537debe |
827 | Changes to $) require a check to $! to detect any possible errors |
828 | after an attempted change. |
a043a685 |
829 | |
19799a22 |
830 | (Mnemonic: parentheses are used to I<group> things. The effective gid |
831 | is the group that's I<right> for you, if you're running setgid.) |
a0d0e21e |
832 | |
c47ff5f1 |
833 | C<< $< >>, C<< $> >>, C<$(> and C<$)> can be set only on |
19799a22 |
834 | machines that support the corresponding I<set[re][ug]id()> routine. C<$(> |
835 | and C<$)> can be swapped only on machines supporting setregid(). |
a0d0e21e |
836 | |
837 | =item $PROGRAM_NAME |
838 | |
839 | =item $0 |
840 | |
80bca1b4 |
841 | Contains the name of the program being executed. |
842 | |
843 | On some (read: not all) operating systems assigning to C<$0> modifies |
844 | the argument area that the C<ps> program sees. On some platforms you |
845 | may have to use special C<ps> options or a different C<ps> to see the |
846 | changes. Modifying the $0 is more useful as a way of indicating the |
847 | current program state than it is for hiding the program you're |
848 | running. (Mnemonic: same as B<sh> and B<ksh>.) |
f9cbb277 |
849 | |
cf525c36 |
850 | Note that there are platform specific limitations on the maximum |
f9cbb277 |
851 | length of C<$0>. In the most extreme case it may be limited to the |
852 | space occupied by the original C<$0>. |
a0d0e21e |
853 | |
80bca1b4 |
854 | In some platforms there may be arbitrary amount of padding, for |
855 | example space characters, after the modified name as shown by C<ps>. |
dda345b7 |
856 | In some platforms this padding may extend all the way to the original |
c80e2480 |
857 | length of the argument area, no matter what you do (this is the case |
858 | for example with Linux 2.2). |
80bca1b4 |
859 | |
4bc88a62 |
860 | Note for BSD users: setting C<$0> does not completely remove "perl" |
6a4647a3 |
861 | from the ps(1) output. For example, setting C<$0> to C<"foobar"> may |
862 | result in C<"perl: foobar (perl)"> (whether both the C<"perl: "> prefix |
863 | and the " (perl)" suffix are shown depends on your exact BSD variant |
864 | and version). This is an operating system feature, Perl cannot help it. |
4bc88a62 |
865 | |
e2975953 |
866 | In multithreaded scripts Perl coordinates the threads so that any |
867 | thread may modify its copy of the C<$0> and the change becomes visible |
cf525c36 |
868 | to ps(1) (assuming the operating system plays along). Note that |
80bca1b4 |
869 | the view of C<$0> the other threads have will not change since they |
870 | have their own copies of it. |
e2975953 |
871 | |
a0d0e21e |
872 | =item $[ |
873 | |
874 | The index of the first element in an array, and of the first character |
19799a22 |
875 | in a substring. Default is 0, but you could theoretically set it |
876 | to 1 to make Perl behave more like B<awk> (or Fortran) when |
877 | subscripting and when evaluating the index() and substr() functions. |
878 | (Mnemonic: [ begins subscripts.) |
a0d0e21e |
879 | |
19799a22 |
880 | As of release 5 of Perl, assignment to C<$[> is treated as a compiler |
881 | directive, and cannot influence the behavior of any other file. |
f83ed198 |
882 | (That's why you can only assign compile-time constants to it.) |
19799a22 |
883 | Its use is highly discouraged. |
a0d0e21e |
884 | |
f83ed198 |
885 | Note that, unlike other compile-time directives (such as L<strict>), |
886 | assignment to $[ can be seen from outer lexical scopes in the same file. |
887 | However, you can use local() on it to strictly bound its value to a |
888 | lexical block. |
889 | |
a0d0e21e |
890 | =item $] |
891 | |
54310121 |
892 | The version + patchlevel / 1000 of the Perl interpreter. This variable |
893 | can be used to determine whether the Perl interpreter executing a |
894 | script is in the right range of versions. (Mnemonic: Is this version |
895 | of perl in the right bracket?) Example: |
a0d0e21e |
896 | |
897 | warn "No checksumming!\n" if $] < 3.019; |
898 | |
54310121 |
899 | See also the documentation of C<use VERSION> and C<require VERSION> |
19799a22 |
900 | for a convenient way to fail if the running Perl interpreter is too old. |
a0d0e21e |
901 | |
0c8d858b |
902 | The floating point representation can sometimes lead to inaccurate |
903 | numeric comparisons. See C<$^V> for a more modern representation of |
904 | the Perl version that allows accurate string comparisons. |
16070b82 |
905 | |
305aace0 |
906 | =item $COMPILING |
907 | |
908 | =item $^C |
909 | |
19799a22 |
910 | The current value of the flag associated with the B<-c> switch. |
911 | Mainly of use with B<-MO=...> to allow code to alter its behavior |
912 | when being compiled, such as for example to AUTOLOAD at compile |
913 | time rather than normal, deferred loading. See L<perlcc>. Setting |
914 | C<$^C = 1> is similar to calling C<B::minus_c>. |
305aace0 |
915 | |
a0d0e21e |
916 | =item $DEBUGGING |
917 | |
918 | =item $^D |
919 | |
920 | The current value of the debugging flags. (Mnemonic: value of B<-D> |
b4ab917c |
921 | switch.) May be read or set. Like its command-line equivalent, you can use |
922 | numeric or symbolic values, eg C<$^D = 10> or C<$^D = "st">. |
a0d0e21e |
923 | |
a3621e74 |
924 | =item ${^RE_DEBUG_FLAGS} |
925 | |
926 | The current value of the regex debugging flags. Set to 0 for no debug output |
927 | even when the re 'debug' module is loaded. See L<re> for details. |
928 | |
0111c4fd |
929 | =item ${^RE_TRIE_MAXBUF} |
a3621e74 |
930 | |
931 | Controls how certain regex optimisations are applied and how much memory they |
932 | utilize. This value by default is 65536 which corresponds to a 512kB temporary |
933 | cache. Set this to a higher value to trade memory for speed when matching |
934 | large alternations. Set it to a lower value if you want the optimisations to |
935 | be as conservative of memory as possible but still occur, and set it to a |
936 | negative value to prevent the optimisation and conserve the most memory. |
937 | Under normal situations this variable should be of no interest to you. |
938 | |
a0d0e21e |
939 | =item $SYSTEM_FD_MAX |
940 | |
941 | =item $^F |
942 | |
943 | The maximum system file descriptor, ordinarily 2. System file |
944 | descriptors are passed to exec()ed processes, while higher file |
945 | descriptors are not. Also, during an open(), system file descriptors are |
946 | preserved even if the open() fails. (Ordinary file descriptors are |
19799a22 |
947 | closed before the open() is attempted.) The close-on-exec |
a0d0e21e |
948 | status of a file descriptor will be decided according to the value of |
8d2a6795 |
949 | C<$^F> when the corresponding file, pipe, or socket was opened, not the |
950 | time of the exec(). |
a0d0e21e |
951 | |
6e2995f4 |
952 | =item $^H |
953 | |
0462a1ab |
954 | WARNING: This variable is strictly for internal use only. Its availability, |
955 | behavior, and contents are subject to change without notice. |
956 | |
957 | This variable contains compile-time hints for the Perl interpreter. At the |
958 | end of compilation of a BLOCK the value of this variable is restored to the |
959 | value when the interpreter started to compile the BLOCK. |
960 | |
961 | When perl begins to parse any block construct that provides a lexical scope |
962 | (e.g., eval body, required file, subroutine body, loop body, or conditional |
963 | block), the existing value of $^H is saved, but its value is left unchanged. |
964 | When the compilation of the block is completed, it regains the saved value. |
965 | Between the points where its value is saved and restored, code that |
966 | executes within BEGIN blocks is free to change the value of $^H. |
967 | |
968 | This behavior provides the semantic of lexical scoping, and is used in, |
969 | for instance, the C<use strict> pragma. |
970 | |
971 | The contents should be an integer; different bits of it are used for |
972 | different pragmatic flags. Here's an example: |
973 | |
974 | sub add_100 { $^H |= 0x100 } |
975 | |
976 | sub foo { |
977 | BEGIN { add_100() } |
978 | bar->baz($boon); |
979 | } |
980 | |
981 | Consider what happens during execution of the BEGIN block. At this point |
982 | the BEGIN block has already been compiled, but the body of foo() is still |
983 | being compiled. The new value of $^H will therefore be visible only while |
984 | the body of foo() is being compiled. |
985 | |
986 | Substitution of the above BEGIN block with: |
987 | |
988 | BEGIN { require strict; strict->import('vars') } |
989 | |
990 | demonstrates how C<use strict 'vars'> is implemented. Here's a conditional |
991 | version of the same lexical pragma: |
992 | |
993 | BEGIN { require strict; strict->import('vars') if $condition } |
994 | |
995 | =item %^H |
996 | |
997 | WARNING: This variable is strictly for internal use only. Its availability, |
998 | behavior, and contents are subject to change without notice. |
999 | |
1000 | The %^H hash provides the same scoping semantic as $^H. This makes it |
1001 | useful for implementation of lexically scoped pragmas. |
6e2995f4 |
1002 | |
a0d0e21e |
1003 | =item $INPLACE_EDIT |
1004 | |
1005 | =item $^I |
1006 | |
1007 | The current value of the inplace-edit extension. Use C<undef> to disable |
1008 | inplace editing. (Mnemonic: value of B<-i> switch.) |
1009 | |
fb73857a |
1010 | =item $^M |
1011 | |
19799a22 |
1012 | By default, running out of memory is an untrappable, fatal error. |
1013 | However, if suitably built, Perl can use the contents of C<$^M> |
1014 | as an emergency memory pool after die()ing. Suppose that your Perl |
1015 | were compiled with -DPERL_EMERGENCY_SBRK and used Perl's malloc. |
1016 | Then |
fb73857a |
1017 | |
19799a22 |
1018 | $^M = 'a' x (1 << 16); |
fb73857a |
1019 | |
51ee6500 |
1020 | would allocate a 64K buffer for use in an emergency. See the |
19799a22 |
1021 | F<INSTALL> file in the Perl distribution for information on how to |
1022 | enable this option. To discourage casual use of this advanced |
4ec0190b |
1023 | feature, there is no L<English|English> long name for this variable. |
fb73857a |
1024 | |
5c055ba3 |
1025 | =item $OSNAME |
6e2995f4 |
1026 | |
5c055ba3 |
1027 | =item $^O |
1028 | |
1029 | The name of the operating system under which this copy of Perl was |
1030 | built, as determined during the configuration process. The value |
19799a22 |
1031 | is identical to C<$Config{'osname'}>. See also L<Config> and the |
1032 | B<-V> command-line switch documented in L<perlrun>. |
5c055ba3 |
1033 | |
443f6d01 |
1034 | In Windows platforms, $^O is not very helpful: since it is always |
7f510801 |
1035 | C<MSWin32>, it doesn't tell the difference between |
1036 | 95/98/ME/NT/2000/XP/CE/.NET. Use Win32::GetOSName() or |
1037 | Win32::GetOSVersion() (see L<Win32> and L<perlport>) to distinguish |
1038 | between the variants. |
916d64a3 |
1039 | |
e2e27056 |
1040 | =item ${^OPEN} |
1041 | |
1042 | An internal variable used by PerlIO. A string in two parts, separated |
fae2c0fb |
1043 | by a C<\0> byte, the first part describes the input layers, the second |
1044 | part describes the output layers. |
e2e27056 |
1045 | |
a0d0e21e |
1046 | =item $PERLDB |
1047 | |
1048 | =item $^P |
1049 | |
19799a22 |
1050 | The internal variable for debugging support. The meanings of the |
1051 | various bits are subject to change, but currently indicate: |
84902520 |
1052 | |
1053 | =over 6 |
1054 | |
1055 | =item 0x01 |
1056 | |
1057 | Debug subroutine enter/exit. |
1058 | |
1059 | =item 0x02 |
1060 | |
1061 | Line-by-line debugging. |
1062 | |
1063 | =item 0x04 |
1064 | |
1065 | Switch off optimizations. |
1066 | |
1067 | =item 0x08 |
1068 | |
1069 | Preserve more data for future interactive inspections. |
1070 | |
1071 | =item 0x10 |
1072 | |
1073 | Keep info about source lines on which a subroutine is defined. |
1074 | |
1075 | =item 0x20 |
1076 | |
1077 | Start with single-step on. |
1078 | |
83ee9e09 |
1079 | =item 0x40 |
1080 | |
1081 | Use subroutine address instead of name when reporting. |
1082 | |
1083 | =item 0x80 |
1084 | |
1085 | Report C<goto &subroutine> as well. |
1086 | |
1087 | =item 0x100 |
1088 | |
1089 | Provide informative "file" names for evals based on the place they were compiled. |
1090 | |
1091 | =item 0x200 |
1092 | |
1093 | Provide informative names to anonymous subroutines based on the place they |
1094 | were compiled. |
1095 | |
7619c85e |
1096 | =item 0x400 |
1097 | |
1098 | Debug assertion subroutines enter/exit. |
1099 | |
84902520 |
1100 | =back |
1101 | |
19799a22 |
1102 | Some bits may be relevant at compile-time only, some at |
1103 | run-time only. This is a new mechanism and the details may change. |
a0d0e21e |
1104 | |
66558a10 |
1105 | =item $LAST_REGEXP_CODE_RESULT |
1106 | |
b9ac3b5b |
1107 | =item $^R |
1108 | |
19799a22 |
1109 | The result of evaluation of the last successful C<(?{ code })> |
1110 | regular expression assertion (see L<perlre>). May be written to. |
b9ac3b5b |
1111 | |
66558a10 |
1112 | =item $EXCEPTIONS_BEING_CAUGHT |
1113 | |
fb73857a |
1114 | =item $^S |
1115 | |
fa05a9fd |
1116 | Current state of the interpreter. |
1117 | |
1118 | $^S State |
1119 | --------- ------------------- |
1120 | undef Parsing module/eval |
1121 | true (1) Executing an eval |
1122 | false (0) Otherwise |
1123 | |
1124 | The first state may happen in $SIG{__DIE__} and $SIG{__WARN__} handlers. |
fb73857a |
1125 | |
a0d0e21e |
1126 | =item $BASETIME |
1127 | |
1128 | =item $^T |
1129 | |
19799a22 |
1130 | The time at which the program began running, in seconds since the |
5f05dabc |
1131 | epoch (beginning of 1970). The values returned by the B<-M>, B<-A>, |
19799a22 |
1132 | and B<-C> filetests are based on this value. |
a0d0e21e |
1133 | |
7c36658b |
1134 | =item ${^TAINT} |
1135 | |
9aa05f58 |
1136 | Reflects if taint mode is on or off. 1 for on (the program was run with |
1137 | B<-T>), 0 for off, -1 when only taint warnings are enabled (i.e. with |
18e8c5b0 |
1138 | B<-t> or B<-TU>). This variable is read-only. |
7c36658b |
1139 | |
a05d7ebb |
1140 | =item ${^UNICODE} |
1141 | |
ab9e1bb7 |
1142 | Reflects certain Unicode settings of Perl. See L<perlrun> |
1143 | documentation for the C<-C> switch for more information about |
1144 | the possible values. This variable is set during Perl startup |
1145 | and is thereafter read-only. |
fde18df1 |
1146 | |
ea8eae40 |
1147 | =item ${^UTF8LOCALE} |
1148 | |
1149 | This variable indicates whether an UTF-8 locale was detected by perl at |
1150 | startup. This information is used by perl when it's in |
1151 | adjust-utf8ness-to-locale mode (as when run with the C<-CL> command-line |
1152 | switch); see L<perlrun> for more info on this. |
1153 | |
44dcb63b |
1154 | =item $PERL_VERSION |
b459063d |
1155 | |
16070b82 |
1156 | =item $^V |
1157 | |
1158 | The revision, version, and subversion of the Perl interpreter, represented |
da2094fd |
1159 | as a string composed of characters with those ordinals. Thus in Perl v5.6.0 |
44dcb63b |
1160 | it equals C<chr(5) . chr(6) . chr(0)> and will return true for |
1161 | C<$^V eq v5.6.0>. Note that the characters in this string value can |
1162 | potentially be in Unicode range. |
16070b82 |
1163 | |
1164 | This can be used to determine whether the Perl interpreter executing a |
1165 | script is in the right range of versions. (Mnemonic: use ^V for Version |
44dcb63b |
1166 | Control.) Example: |
16070b82 |
1167 | |
3fd4402b |
1168 | warn "No \"our\" declarations!\n" if $^V and $^V lt v5.6.0; |
16070b82 |
1169 | |
aa2f2a36 |
1170 | To convert C<$^V> into its string representation use sprintf()'s |
1171 | C<"%vd"> conversion: |
1172 | |
1173 | printf "version is v%vd\n", $^V; # Perl's version |
1174 | |
44dcb63b |
1175 | See the documentation of C<use VERSION> and C<require VERSION> |
16070b82 |
1176 | for a convenient way to fail if the running Perl interpreter is too old. |
1177 | |
1178 | See also C<$]> for an older representation of the Perl version. |
1179 | |
a0d0e21e |
1180 | =item $WARNING |
1181 | |
1182 | =item $^W |
1183 | |
19799a22 |
1184 | The current value of the warning switch, initially true if B<-w> |
1185 | was used, false otherwise, but directly modifiable. (Mnemonic: |
4438c4b7 |
1186 | related to the B<-w> switch.) See also L<warnings>. |
1187 | |
6a818117 |
1188 | =item ${^WARNING_BITS} |
4438c4b7 |
1189 | |
1190 | The current set of warning checks enabled by the C<use warnings> pragma. |
1191 | See the documentation of C<warnings> for more details. |
a0d0e21e |
1192 | |
1193 | =item $EXECUTABLE_NAME |
1194 | |
1195 | =item $^X |
1196 | |
e71940de |
1197 | The name used to execute the current copy of Perl, from C's |
38e4f4ae |
1198 | C<argv[0]>. |
1199 | |
e71940de |
1200 | Depending on the host operating system, the value of $^X may be |
1201 | a relative or absolute pathname of the perl program file, or may |
1202 | be the string used to invoke perl but not the pathname of the |
1203 | perl program file. Also, most operating systems permit invoking |
1204 | programs that are not in the PATH environment variable, so there |
a10d74f3 |
1205 | is no guarantee that the value of $^X is in PATH. For VMS, the |
1206 | value may or may not include a version number. |
38e4f4ae |
1207 | |
e71940de |
1208 | You usually can use the value of $^X to re-invoke an independent |
1209 | copy of the same perl that is currently running, e.g., |
1210 | |
1211 | @first_run = `$^X -le "print int rand 100 for 1..100"`; |
1212 | |
1213 | But recall that not all operating systems support forking or |
1214 | capturing of the output of commands, so this complex statement |
1215 | may not be portable. |
38e4f4ae |
1216 | |
e71940de |
1217 | It is not safe to use the value of $^X as a path name of a file, |
1218 | as some operating systems that have a mandatory suffix on |
1219 | executable files do not require use of the suffix when invoking |
1220 | a command. To convert the value of $^X to a path name, use the |
1221 | following statements: |
1222 | |
304dea91 |
1223 | # Build up a set of file names (not command names). |
e71940de |
1224 | use Config; |
68fb0eb7 |
1225 | $this_perl = $^X; |
1226 | if ($^O ne 'VMS') |
1227 | {$this_perl .= $Config{_exe} |
1228 | unless $this_perl =~ m/$Config{_exe}$/i;} |
e71940de |
1229 | |
1230 | Because many operating systems permit anyone with read access to |
1231 | the Perl program file to make a copy of it, patch the copy, and |
1232 | then execute the copy, the security-conscious Perl programmer |
1233 | should take care to invoke the installed copy of perl, not the |
1234 | copy referenced by $^X. The following statements accomplish |
1235 | this goal, and produce a pathname that can be invoked as a |
1236 | command or referenced as a file. |
38e4f4ae |
1237 | |
1238 | use Config; |
68fb0eb7 |
1239 | $secure_perl_path = $Config{perlpath}; |
1240 | if ($^O ne 'VMS') |
1241 | {$secure_perl_path .= $Config{_exe} |
1242 | unless $secure_perl_path =~ m/$Config{_exe}$/i;} |
a0d0e21e |
1243 | |
2d84a16a |
1244 | =item ARGV |
1245 | |
1246 | The special filehandle that iterates over command-line filenames in |
1247 | C<@ARGV>. Usually written as the null filehandle in the angle operator |
1248 | C<< <> >>. Note that currently C<ARGV> only has its magical effect |
1249 | within the C<< <> >> operator; elsewhere it is just a plain filehandle |
1250 | corresponding to the last file opened by C<< <> >>. In particular, |
1251 | passing C<\*ARGV> as a parameter to a function that expects a filehandle |
1252 | may not cause your function to automatically read the contents of all the |
1253 | files in C<@ARGV>. |
1254 | |
a0d0e21e |
1255 | =item $ARGV |
1256 | |
c47ff5f1 |
1257 | contains the name of the current file when reading from <>. |
a0d0e21e |
1258 | |
1259 | =item @ARGV |
1260 | |
19799a22 |
1261 | The array @ARGV contains the command-line arguments intended for |
14218588 |
1262 | the script. C<$#ARGV> is generally the number of arguments minus |
19799a22 |
1263 | one, because C<$ARGV[0]> is the first argument, I<not> the program's |
1264 | command name itself. See C<$0> for the command name. |
a0d0e21e |
1265 | |
5ccee41e |
1266 | =item ARGVOUT |
1267 | |
1268 | The special filehandle that points to the currently open output file |
1269 | when doing edit-in-place processing with B<-i>. Useful when you have |
1270 | to do a lot of inserting and don't want to keep modifying $_. See |
1271 | L<perlrun> for the B<-i> switch. |
1272 | |
9b0e6e7a |
1273 | =item @F |
1274 | |
1275 | The array @F contains the fields of each line read in when autosplit |
1276 | mode is turned on. See L<perlrun> for the B<-a> switch. This array |
1277 | is package-specific, and must be declared or given a full package name |
1278 | if not in package main when running under C<strict 'vars'>. |
1279 | |
a0d0e21e |
1280 | =item @INC |
1281 | |
19799a22 |
1282 | The array @INC contains the list of places that the C<do EXPR>, |
1283 | C<require>, or C<use> constructs look for their library files. It |
1284 | initially consists of the arguments to any B<-I> command-line |
1285 | switches, followed by the default Perl library, probably |
1286 | F</usr/local/lib/perl>, followed by ".", to represent the current |
e48df184 |
1287 | directory. ("." will not be appended if taint checks are enabled, either by |
1288 | C<-T> or by C<-t>.) If you need to modify this at runtime, you should use |
19799a22 |
1289 | the C<use lib> pragma to get the machine-dependent library properly |
1290 | loaded also: |
a0d0e21e |
1291 | |
cb1a09d0 |
1292 | use lib '/mypath/libdir/'; |
1293 | use SomeMod; |
303f2f76 |
1294 | |
d54b56d5 |
1295 | You can also insert hooks into the file inclusion system by putting Perl |
1296 | code directly into @INC. Those hooks may be subroutine references, array |
1297 | references or blessed objects. See L<perlfunc/require> for details. |
1298 | |
fb73857a |
1299 | =item @_ |
1300 | |
1301 | Within a subroutine the array @_ contains the parameters passed to that |
19799a22 |
1302 | subroutine. See L<perlsub>. |
fb73857a |
1303 | |
a0d0e21e |
1304 | =item %INC |
1305 | |
19799a22 |
1306 | The hash %INC contains entries for each filename included via the |
1307 | C<do>, C<require>, or C<use> operators. The key is the filename |
1308 | you specified (with module names converted to pathnames), and the |
14218588 |
1309 | value is the location of the file found. The C<require> |
87275199 |
1310 | operator uses this hash to determine whether a particular file has |
19799a22 |
1311 | already been included. |
a0d0e21e |
1312 | |
89ccab8c |
1313 | If the file was loaded via a hook (e.g. a subroutine reference, see |
1314 | L<perlfunc/require> for a description of these hooks), this hook is |
9ae8cd5b |
1315 | by default inserted into %INC in place of a filename. Note, however, |
1316 | that the hook may have set the %INC entry by itself to provide some more |
1317 | specific info. |
44f0be63 |
1318 | |
b687b08b |
1319 | =item %ENV |
1320 | |
1321 | =item $ENV{expr} |
a0d0e21e |
1322 | |
1323 | The hash %ENV contains your current environment. Setting a |
19799a22 |
1324 | value in C<ENV> changes the environment for any child processes |
1325 | you subsequently fork() off. |
a0d0e21e |
1326 | |
b687b08b |
1327 | =item %SIG |
1328 | |
1329 | =item $SIG{expr} |
a0d0e21e |
1330 | |
14218588 |
1331 | The hash %SIG contains signal handlers for signals. For example: |
a0d0e21e |
1332 | |
1333 | sub handler { # 1st argument is signal name |
fb73857a |
1334 | my($sig) = @_; |
a0d0e21e |
1335 | print "Caught a SIG$sig--shutting down\n"; |
1336 | close(LOG); |
1337 | exit(0); |
1338 | } |
1339 | |
fb73857a |
1340 | $SIG{'INT'} = \&handler; |
1341 | $SIG{'QUIT'} = \&handler; |
a0d0e21e |
1342 | ... |
19799a22 |
1343 | $SIG{'INT'} = 'DEFAULT'; # restore default action |
a0d0e21e |
1344 | $SIG{'QUIT'} = 'IGNORE'; # ignore SIGQUIT |
1345 | |
f648820c |
1346 | Using a value of C<'IGNORE'> usually has the effect of ignoring the |
1347 | signal, except for the C<CHLD> signal. See L<perlipc> for more about |
1348 | this special case. |
1349 | |
19799a22 |
1350 | Here are some other examples: |
a0d0e21e |
1351 | |
fb73857a |
1352 | $SIG{"PIPE"} = "Plumber"; # assumes main::Plumber (not recommended) |
a0d0e21e |
1353 | $SIG{"PIPE"} = \&Plumber; # just fine; assume current Plumber |
19799a22 |
1354 | $SIG{"PIPE"} = *Plumber; # somewhat esoteric |
a0d0e21e |
1355 | $SIG{"PIPE"} = Plumber(); # oops, what did Plumber() return?? |
1356 | |
19799a22 |
1357 | Be sure not to use a bareword as the name of a signal handler, |
1358 | lest you inadvertently call it. |
748a9306 |
1359 | |
44a8e56a |
1360 | If your system has the sigaction() function then signal handlers are |
9ce5b4ad |
1361 | installed using it. This means you get reliable signal handling. |
44a8e56a |
1362 | |
9ce5b4ad |
1363 | The default delivery policy of signals changed in Perl 5.8.0 from |
1364 | immediate (also known as "unsafe") to deferred, also known as |
1365 | "safe signals". See L<perlipc> for more information. |
45c0772f |
1366 | |
748a9306 |
1367 | Certain internal hooks can be also set using the %SIG hash. The |
a8f8344d |
1368 | routine indicated by C<$SIG{__WARN__}> is called when a warning message is |
748a9306 |
1369 | about to be printed. The warning message is passed as the first |
1370 | argument. The presence of a __WARN__ hook causes the ordinary printing |
1371 | of warnings to STDERR to be suppressed. You can use this to save warnings |
1372 | in a variable, or turn warnings into fatal errors, like this: |
1373 | |
1374 | local $SIG{__WARN__} = sub { die $_[0] }; |
1375 | eval $proggie; |
1376 | |
a8f8344d |
1377 | The routine indicated by C<$SIG{__DIE__}> is called when a fatal exception |
748a9306 |
1378 | is about to be thrown. The error message is passed as the first |
1379 | argument. When a __DIE__ hook routine returns, the exception |
1380 | processing continues as it would have in the absence of the hook, |
cb1a09d0 |
1381 | unless the hook routine itself exits via a C<goto>, a loop exit, or a die(). |
774d564b |
1382 | The C<__DIE__> handler is explicitly disabled during the call, so that you |
fb73857a |
1383 | can die from a C<__DIE__> handler. Similarly for C<__WARN__>. |
1384 | |
19799a22 |
1385 | Due to an implementation glitch, the C<$SIG{__DIE__}> hook is called |
1386 | even inside an eval(). Do not use this to rewrite a pending exception |
1387 | in C<$@>, or as a bizarre substitute for overriding CORE::GLOBAL::die(). |
1388 | This strange action at a distance may be fixed in a future release |
1389 | so that C<$SIG{__DIE__}> is only called if your program is about |
1390 | to exit, as was the original intent. Any other use is deprecated. |
1391 | |
1392 | C<__DIE__>/C<__WARN__> handlers are very special in one respect: |
1393 | they may be called to report (probable) errors found by the parser. |
1394 | In such a case the parser may be in inconsistent state, so any |
1395 | attempt to evaluate Perl code from such a handler will probably |
1396 | result in a segfault. This means that warnings or errors that |
1397 | result from parsing Perl should be used with extreme caution, like |
1398 | this: |
fb73857a |
1399 | |
1400 | require Carp if defined $^S; |
1401 | Carp::confess("Something wrong") if defined &Carp::confess; |
1402 | die "Something wrong, but could not load Carp to give backtrace... |
1403 | To see backtrace try starting Perl with -MCarp switch"; |
1404 | |
1405 | Here the first line will load Carp I<unless> it is the parser who |
1406 | called the handler. The second line will print backtrace and die if |
1407 | Carp was available. The third line will be executed only if Carp was |
1408 | not available. |
1409 | |
19799a22 |
1410 | See L<perlfunc/die>, L<perlfunc/warn>, L<perlfunc/eval>, and |
4438c4b7 |
1411 | L<warnings> for additional information. |
68dc0745 |
1412 | |
a0d0e21e |
1413 | =back |
55602bd2 |
1414 | |
1415 | =head2 Error Indicators |
1416 | |
19799a22 |
1417 | The variables C<$@>, C<$!>, C<$^E>, and C<$?> contain information |
1418 | about different types of error conditions that may appear during |
1419 | execution of a Perl program. The variables are shown ordered by |
1420 | the "distance" between the subsystem which reported the error and |
1421 | the Perl process. They correspond to errors detected by the Perl |
1422 | interpreter, C library, operating system, or an external program, |
1423 | respectively. |
55602bd2 |
1424 | |
1425 | To illustrate the differences between these variables, consider the |
19799a22 |
1426 | following Perl expression, which uses a single-quoted string: |
55602bd2 |
1427 | |
19799a22 |
1428 | eval q{ |
22d0716c |
1429 | open my $pipe, "/cdrom/install |" or die $!; |
1430 | my @res = <$pipe>; |
1431 | close $pipe or die "bad pipe: $?, $!"; |
19799a22 |
1432 | }; |
55602bd2 |
1433 | |
1434 | After execution of this statement all 4 variables may have been set. |
1435 | |
19799a22 |
1436 | C<$@> is set if the string to be C<eval>-ed did not compile (this |
1437 | may happen if C<open> or C<close> were imported with bad prototypes), |
1438 | or if Perl code executed during evaluation die()d . In these cases |
1439 | the value of $@ is the compile error, or the argument to C<die> |
4cb1c523 |
1440 | (which will interpolate C<$!> and C<$?>). (See also L<Fatal>, |
19799a22 |
1441 | though.) |
1442 | |
c47ff5f1 |
1443 | When the eval() expression above is executed, open(), C<< <PIPE> >>, |
19799a22 |
1444 | and C<close> are translated to calls in the C run-time library and |
1445 | thence to the operating system kernel. C<$!> is set to the C library's |
1446 | C<errno> if one of these calls fails. |
1447 | |
1448 | Under a few operating systems, C<$^E> may contain a more verbose |
1449 | error indicator, such as in this case, "CDROM tray not closed." |
14218588 |
1450 | Systems that do not support extended error messages leave C<$^E> |
19799a22 |
1451 | the same as C<$!>. |
1452 | |
1453 | Finally, C<$?> may be set to non-0 value if the external program |
1454 | F</cdrom/install> fails. The upper eight bits reflect specific |
1455 | error conditions encountered by the program (the program's exit() |
1456 | value). The lower eight bits reflect mode of failure, like signal |
1457 | death and core dump information See wait(2) for details. In |
1458 | contrast to C<$!> and C<$^E>, which are set only if error condition |
1459 | is detected, the variable C<$?> is set on each C<wait> or pipe |
1460 | C<close>, overwriting the old value. This is more like C<$@>, which |
1461 | on every eval() is always set on failure and cleared on success. |
2b92dfce |
1462 | |
19799a22 |
1463 | For more details, see the individual descriptions at C<$@>, C<$!>, C<$^E>, |
1464 | and C<$?>. |
2b92dfce |
1465 | |
1466 | =head2 Technical Note on the Syntax of Variable Names |
1467 | |
19799a22 |
1468 | Variable names in Perl can have several formats. Usually, they |
1469 | must begin with a letter or underscore, in which case they can be |
1470 | arbitrarily long (up to an internal limit of 251 characters) and |
1471 | may contain letters, digits, underscores, or the special sequence |
1472 | C<::> or C<'>. In this case, the part before the last C<::> or |
1473 | C<'> is taken to be a I<package qualifier>; see L<perlmod>. |
2b92dfce |
1474 | |
1475 | Perl variable names may also be a sequence of digits or a single |
1476 | punctuation or control character. These names are all reserved for |
19799a22 |
1477 | special uses by Perl; for example, the all-digits names are used |
1478 | to hold data captured by backreferences after a regular expression |
1479 | match. Perl has a special syntax for the single-control-character |
1480 | names: It understands C<^X> (caret C<X>) to mean the control-C<X> |
1481 | character. For example, the notation C<$^W> (dollar-sign caret |
1482 | C<W>) is the scalar variable whose name is the single character |
1483 | control-C<W>. This is better than typing a literal control-C<W> |
1484 | into your program. |
2b92dfce |
1485 | |
87275199 |
1486 | Finally, new in Perl 5.6, Perl variable names may be alphanumeric |
19799a22 |
1487 | strings that begin with control characters (or better yet, a caret). |
1488 | These variables must be written in the form C<${^Foo}>; the braces |
1489 | are not optional. C<${^Foo}> denotes the scalar variable whose |
1490 | name is a control-C<F> followed by two C<o>'s. These variables are |
1491 | reserved for future special uses by Perl, except for the ones that |
1492 | begin with C<^_> (control-underscore or caret-underscore). No |
1493 | control-character name that begins with C<^_> will acquire a special |
1494 | meaning in any future version of Perl; such names may therefore be |
1495 | used safely in programs. C<$^_> itself, however, I<is> reserved. |
1496 | |
1497 | Perl identifiers that begin with digits, control characters, or |
2b92dfce |
1498 | punctuation characters are exempt from the effects of the C<package> |
747fafda |
1499 | declaration and are always forced to be in package C<main>; they are |
1500 | also exempt from C<strict 'vars'> errors. A few other names are also |
1501 | exempt in these ways: |
2b92dfce |
1502 | |
1503 | ENV STDIN |
1504 | INC STDOUT |
1505 | ARGV STDERR |
5b88253b |
1506 | ARGVOUT _ |
2b92dfce |
1507 | SIG |
1508 | |
1509 | In particular, the new special C<${^_XYZ}> variables are always taken |
19799a22 |
1510 | to be in package C<main>, regardless of any C<package> declarations |
747fafda |
1511 | presently in scope. |
2b92dfce |
1512 | |
19799a22 |
1513 | =head1 BUGS |
1514 | |
1515 | Due to an unfortunate accident of Perl's implementation, C<use |
1516 | English> imposes a considerable performance penalty on all regular |
1517 | expression matches in a program, regardless of whether they occur |
1518 | in the scope of C<use English>. For that reason, saying C<use |
1519 | English> in libraries is strongly discouraged. See the |
1520 | Devel::SawAmpersand module documentation from CPAN |
1577cd80 |
1521 | ( http://www.cpan.org/modules/by-module/Devel/ ) |
19799a22 |
1522 | for more information. |
2b92dfce |
1523 | |
19799a22 |
1524 | Having to even think about the C<$^S> variable in your exception |
1525 | handlers is simply wrong. C<$SIG{__DIE__}> as currently implemented |
1526 | invites grievous and difficult to track down errors. Avoid it |
1527 | and use an C<END{}> or CORE::GLOBAL::die override instead. |