source: for-distributions/trunk/bin/windows/perl/lib/Pod/perldata.pod@ 14489

Last change on this file since 14489 was 14489, checked in by oranfry, 17 years ago

upgrading to perl 5.8

File size: 35.5 KB
Line 
1=head1 NAME
2
3perldata - Perl data types
4
5=head1 DESCRIPTION
6
7=head2 Variable names
8X<variable, name> X<variable name> X<data type> X<type>
9
10Perl has three built-in data types: scalars, arrays of scalars, and
11associative arrays of scalars, known as "hashes". A scalar is a
12single string (of any size, limited only by the available memory),
13number, or a reference to something (which will be discussed
14in L<perlref>). Normal arrays are ordered lists of scalars indexed
15by number, starting with 0. Hashes are unordered collections of scalar
16values indexed by their associated string key.
17
18Values are usually referred to by name, or through a named reference.
19The first character of the name tells you to what sort of data
20structure it refers. The rest of the name tells you the particular
21value to which it refers. Usually this name is a single I<identifier>,
22that is, a string beginning with a letter or underscore, and
23containing letters, underscores, and digits. In some cases, it may
24be a chain of identifiers, separated by C<::> (or by the slightly
25archaic C<'>); all but the last are interpreted as names of packages,
26to locate the namespace in which to look up the final identifier
27(see L<perlmod/Packages> for details). It's possible to substitute
28for a simple identifier, an expression that produces a reference
29to the value at runtime. This is described in more detail below
30and in L<perlref>.
31X<identifier>
32
33Perl also has its own built-in variables whose names don't follow
34these rules. They have strange names so they don't accidentally
35collide with one of your normal variables. Strings that match
36parenthesized parts of a regular expression are saved under names
37containing only digits after the C<$> (see L<perlop> and L<perlre>).
38In addition, several special variables that provide windows into
39the inner working of Perl have names containing punctuation characters
40and control characters. These are documented in L<perlvar>.
41X<variable, built-in>
42
43Scalar values are always named with '$', even when referring to a
44scalar that is part of an array or a hash. The '$' symbol works
45semantically like the English word "the" in that it indicates a
46single value is expected.
47X<scalar>
48
49 $days # the simple scalar value "days"
50 $days[28] # the 29th element of array @days
51 $days{'Feb'} # the 'Feb' value from hash %days
52 $#days # the last index of array @days
53
54Entire arrays (and slices of arrays and hashes) are denoted by '@',
55which works much like the word "these" or "those" does in English,
56in that it indicates multiple values are expected.
57X<array>
58
59 @days # ($days[0], $days[1],... $days[n])
60 @days[3,4,5] # same as ($days[3],$days[4],$days[5])
61 @days{'a','c'} # same as ($days{'a'},$days{'c'})
62
63Entire hashes are denoted by '%':
64X<hash>
65
66 %days # (key1, val1, key2, val2 ...)
67
68In addition, subroutines are named with an initial '&', though this
69is optional when unambiguous, just as the word "do" is often redundant
70in English. Symbol table entries can be named with an initial '*',
71but you don't really care about that yet (if ever :-).
72
73Every variable type has its own namespace, as do several
74non-variable identifiers. This means that you can, without fear
75of conflict, use the same name for a scalar variable, an array, or
76a hash--or, for that matter, for a filehandle, a directory handle, a
77subroutine name, a format name, or a label. This means that $foo
78and @foo are two different variables. It also means that C<$foo[1]>
79is a part of @foo, not a part of $foo. This may seem a bit weird,
80but that's okay, because it is weird.
81X<namespace>
82
83Because variable references always start with '$', '@', or '%', the
84"reserved" words aren't in fact reserved with respect to variable
85names. They I<are> reserved with respect to labels and filehandles,
86however, which don't have an initial special character. You can't
87have a filehandle named "log", for instance. Hint: you could say
88C<open(LOG,'logfile')> rather than C<open(log,'logfile')>. Using
89uppercase filehandles also improves readability and protects you
90from conflict with future reserved words. Case I<is> significant--"FOO",
91"Foo", and "foo" are all different names. Names that start with a
92letter or underscore may also contain digits and underscores.
93X<identifier, case sensitivity>
94X<case>
95
96It is possible to replace such an alphanumeric name with an expression
97that returns a reference to the appropriate type. For a description
98of this, see L<perlref>.
99
100Names that start with a digit may contain only more digits. Names
101that do not start with a letter, underscore, digit or a caret (i.e.
102a control character) are limited to one character, e.g., C<$%> or
103C<$$>. (Most of these one character names have a predefined
104significance to Perl. For instance, C<$$> is the current process
105id.)
106
107=head2 Context
108X<context> X<scalar context> X<list context>
109
110The interpretation of operations and values in Perl sometimes depends
111on the requirements of the context around the operation or value.
112There are two major contexts: list and scalar. Certain operations
113return list values in contexts wanting a list, and scalar values
114otherwise. If this is true of an operation it will be mentioned in
115the documentation for that operation. In other words, Perl overloads
116certain operations based on whether the expected return value is
117singular or plural. Some words in English work this way, like "fish"
118and "sheep".
119
120In a reciprocal fashion, an operation provides either a scalar or a
121list context to each of its arguments. For example, if you say
122
123 int( <STDIN> )
124
125the integer operation provides scalar context for the <>
126operator, which responds by reading one line from STDIN and passing it
127back to the integer operation, which will then find the integer value
128of that line and return that. If, on the other hand, you say
129
130 sort( <STDIN> )
131
132then the sort operation provides list context for <>, which
133will proceed to read every line available up to the end of file, and
134pass that list of lines back to the sort routine, which will then
135sort those lines and return them as a list to whatever the context
136of the sort was.
137
138Assignment is a little bit special in that it uses its left argument
139to determine the context for the right argument. Assignment to a
140scalar evaluates the right-hand side in scalar context, while
141assignment to an array or hash evaluates the righthand side in list
142context. Assignment to a list (or slice, which is just a list
143anyway) also evaluates the righthand side in list context.
144
145When you use the C<use warnings> pragma or Perl's B<-w> command-line
146option, you may see warnings
147about useless uses of constants or functions in "void context".
148Void context just means the value has been discarded, such as a
149statement containing only C<"fred";> or C<getpwuid(0);>. It still
150counts as scalar context for functions that care whether or not
151they're being called in list context.
152
153User-defined subroutines may choose to care whether they are being
154called in a void, scalar, or list context. Most subroutines do not
155need to bother, though. That's because both scalars and lists are
156automatically interpolated into lists. See L<perlfunc/wantarray>
157for how you would dynamically discern your function's calling
158context.
159
160=head2 Scalar values
161X<scalar> X<number> X<string> X<reference>
162
163All data in Perl is a scalar, an array of scalars, or a hash of
164scalars. A scalar may contain one single value in any of three
165different flavors: a number, a string, or a reference. In general,
166conversion from one form to another is transparent. Although a
167scalar may not directly hold multiple values, it may contain a
168reference to an array or hash which in turn contains multiple values.
169
170Scalars aren't necessarily one thing or another. There's no place
171to declare a scalar variable to be of type "string", type "number",
172type "reference", or anything else. Because of the automatic
173conversion of scalars, operations that return scalars don't need
174to care (and in fact, cannot care) whether their caller is looking
175for a string, a number, or a reference. Perl is a contextually
176polymorphic language whose scalars can be strings, numbers, or
177references (which includes objects). Although strings and numbers
178are considered pretty much the same thing for nearly all purposes,
179references are strongly-typed, uncastable pointers with builtin
180reference-counting and destructor invocation.
181
182A scalar value is interpreted as TRUE in the Boolean sense if it is not
183the null string or the number 0 (or its string equivalent, "0"). The
184Boolean context is just a special kind of scalar context where no
185conversion to a string or a number is ever performed.
186X<boolean> X<bool> X<true> X<false> X<truth>
187
188There are actually two varieties of null strings (sometimes referred
189to as "empty" strings), a defined one and an undefined one. The
190defined version is just a string of length zero, such as C<"">.
191The undefined version is the value that indicates that there is
192no real value for something, such as when there was an error, or
193at end of file, or when you refer to an uninitialized variable or
194element of an array or hash. Although in early versions of Perl,
195an undefined scalar could become defined when first used in a
196place expecting a defined value, this no longer happens except for
197rare cases of autovivification as explained in L<perlref>. You can
198use the defined() operator to determine whether a scalar value is
199defined (this has no meaning on arrays or hashes), and the undef()
200operator to produce an undefined value.
201X<defined> X<undefined> X<undef> X<null> X<string, null>
202
203To find out whether a given string is a valid non-zero number, it's
204sometimes enough to test it against both numeric 0 and also lexical
205"0" (although this will cause noises if warnings are on). That's
206because strings that aren't numbers count as 0, just as they do in B<awk>:
207
208 if ($str == 0 && $str ne "0") {
209 warn "That doesn't look like a number";
210 }
211
212That method may be best because otherwise you won't treat IEEE
213notations like C<NaN> or C<Infinity> properly. At other times, you
214might prefer to determine whether string data can be used numerically
215by calling the POSIX::strtod() function or by inspecting your string
216with a regular expression (as documented in L<perlre>).
217
218 warn "has nondigits" if /\D/;
219 warn "not a natural number" unless /^\d+$/; # rejects -3
220 warn "not an integer" unless /^-?\d+$/; # rejects +3
221 warn "not an integer" unless /^[+-]?\d+$/;
222 warn "not a decimal number" unless /^-?\d+\.?\d*$/; # rejects .2
223 warn "not a decimal number" unless /^-?(?:\d+(?:\.\d*)?|\.\d+)$/;
224 warn "not a C float"
225 unless /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/;
226
227The length of an array is a scalar value. You may find the length
228of array @days by evaluating C<$#days>, as in B<csh>. However, this
229isn't the length of the array; it's the subscript of the last element,
230which is a different value since there is ordinarily a 0th element.
231Assigning to C<$#days> actually changes the length of the array.
232Shortening an array this way destroys intervening values. Lengthening
233an array that was previously shortened does not recover values
234that were in those elements. (It used to do so in Perl 4, but we
235had to break this to make sure destructors were called when expected.)
236X<$#> X<array, length>
237
238You can also gain some minuscule measure of efficiency by pre-extending
239an array that is going to get big. You can also extend an array
240by assigning to an element that is off the end of the array. You
241can truncate an array down to nothing by assigning the null list
242() to it. The following are equivalent:
243
244 @whatever = ();
245 $#whatever = -1;
246
247If you evaluate an array in scalar context, it returns the length
248of the array. (Note that this is not true of lists, which return
249the last value, like the C comma operator, nor of built-in functions,
250which return whatever they feel like returning.) The following is
251always true:
252X<array, length>
253
254 scalar(@whatever) == $#whatever - $[ + 1;
255
256Version 5 of Perl changed the semantics of C<$[>: files that don't set
257the value of C<$[> no longer need to worry about whether another
258file changed its value. (In other words, use of C<$[> is deprecated.)
259So in general you can assume that
260X<$[>
261
262 scalar(@whatever) == $#whatever + 1;
263
264Some programmers choose to use an explicit conversion so as to
265leave nothing to doubt:
266
267 $element_count = scalar(@whatever);
268
269If you evaluate a hash in scalar context, it returns false if the
270hash is empty. If there are any key/value pairs, it returns true;
271more precisely, the value returned is a string consisting of the
272number of used buckets and the number of allocated buckets, separated
273by a slash. This is pretty much useful only to find out whether
274Perl's internal hashing algorithm is performing poorly on your data
275set. For example, you stick 10,000 things in a hash, but evaluating
276%HASH in scalar context reveals C<"1/16">, which means only one out
277of sixteen buckets has been touched, and presumably contains all
27810,000 of your items. This isn't supposed to happen.
279X<hash, scalar context> X<hash, bucket> X<bucket>
280
281You can preallocate space for a hash by assigning to the keys() function.
282This rounds up the allocated buckets to the next power of two:
283
284 keys(%users) = 1000; # allocate 1024 buckets
285
286=head2 Scalar value constructors
287X<scalar, literal> X<scalar, constant>
288
289Numeric literals are specified in any of the following floating point or
290integer formats:
291
292 12345
293 12345.67
294 .23E-10 # a very small number
295 3.14_15_92 # a very important number
296 4_294_967_296 # underscore for legibility
297 0xff # hex
298 0xdead_beef # more hex
299 0377 # octal (only numbers, begins with 0)
300 0b011011 # binary
301
302You are allowed to use underscores (underbars) in numeric literals
303between digits for legibility. You could, for example, group binary
304digits by threes (as for a Unix-style mode argument such as 0b110_100_100)
305or by fours (to represent nibbles, as in 0b1010_0110) or in other groups.
306X<number, literal>
307
308String literals are usually delimited by either single or double
309quotes. They work much like quotes in the standard Unix shells:
310double-quoted string literals are subject to backslash and variable
311substitution; single-quoted strings are not (except for C<\'> and
312C<\\>). The usual C-style backslash rules apply for making
313characters such as newline, tab, etc., as well as some more exotic
314forms. See L<perlop/"Quote and Quote-like Operators"> for a list.
315X<string, literal>
316
317Hexadecimal, octal, or binary, representations in string literals
318(e.g. '0xff') are not automatically converted to their integer
319representation. The hex() and oct() functions make these conversions
320for you. See L<perlfunc/hex> and L<perlfunc/oct> for more details.
321
322You can also embed newlines directly in your strings, i.e., they can end
323on a different line than they begin. This is nice, but if you forget
324your trailing quote, the error will not be reported until Perl finds
325another line containing the quote character, which may be much further
326on in the script. Variable substitution inside strings is limited to
327scalar variables, arrays, and array or hash slices. (In other words,
328names beginning with $ or @, followed by an optional bracketed
329expression as a subscript.) The following code segment prints out "The
330price is $Z<>100."
331X<interpolation>
332
333 $Price = '$100'; # not interpolated
334 print "The price is $Price.\n"; # interpolated
335
336There is no double interpolation in Perl, so the C<$100> is left as is.
337
338As in some shells, you can enclose the variable name in braces to
339disambiguate it from following alphanumerics (and underscores).
340You must also do
341this when interpolating a variable into a string to separate the
342variable name from a following double-colon or an apostrophe, since
343these would be otherwise treated as a package separator:
344X<interpolation>
345
346 $who = "Larry";
347 print PASSWD "${who}::0:0:Superuser:/:/bin/perl\n";
348 print "We use ${who}speak when ${who}'s here.\n";
349
350Without the braces, Perl would have looked for a $whospeak, a
351C<$who::0>, and a C<$who's> variable. The last two would be the
352$0 and the $s variables in the (presumably) non-existent package
353C<who>.
354
355In fact, an identifier within such curlies is forced to be a string,
356as is any simple identifier within a hash subscript. Neither need
357quoting. Our earlier example, C<$days{'Feb'}> can be written as
358C<$days{Feb}> and the quotes will be assumed automatically. But
359anything more complicated in the subscript will be interpreted as an
360expression. This means for example that C<$version{2.0}++> is
361equivalent to C<$version{2}++>, not to C<$version{'2.0'}++>.
362
363=head3 Version Strings
364X<version string> X<vstring> X<v-string>
365
366B<Note:> Version Strings (v-strings) have been deprecated. They will
367not be available after Perl 5.8. The marginal benefits of v-strings
368were greatly outweighed by the potential for Surprise and Confusion.
369
370A literal of the form C<v1.20.300.4000> is parsed as a string composed
371of characters with the specified ordinals. This form, known as
372v-strings, provides an alternative, more readable way to construct
373strings, rather than use the somewhat less readable interpolation form
374C<"\x{1}\x{14}\x{12c}\x{fa0}">. This is useful for representing
375Unicode strings, and for comparing version "numbers" using the string
376comparison operators, C<cmp>, C<gt>, C<lt> etc. If there are two or
377more dots in the literal, the leading C<v> may be omitted.
378
379 print v9786; # prints UTF-8 encoded SMILEY, "\x{263a}"
380 print v102.111.111; # prints "foo"
381 print 102.111.111; # same
382
383Such literals are accepted by both C<require> and C<use> for
384doing a version check. The C<$^V> special variable also contains the
385running Perl interpreter's version in this form. See L<perlvar/$^V>.
386Note that using the v-strings for IPv4 addresses is not portable unless
387you also use the inet_aton()/inet_ntoa() routines of the Socket package.
388
389Note that since Perl 5.8.1 the single-number v-strings (like C<v65>)
390are not v-strings before the C<< => >> operator (which is usually used
391to separate a hash key from a hash value), instead they are interpreted
392as literal strings ('v65'). They were v-strings from Perl 5.6.0 to
393Perl 5.8.0, but that caused more confusion and breakage than good.
394Multi-number v-strings like C<v65.66> and C<65.66.67> continue to
395be v-strings always.
396
397=head3 Special Literals
398X<special literal> X<__END__> X<__DATA__> X<END> X<DATA>
399X<end> X<data> X<^D> X<^Z>
400
401The special literals __FILE__, __LINE__, and __PACKAGE__
402represent the current filename, line number, and package name at that
403point in your program. They may be used only as separate tokens; they
404will not be interpolated into strings. If there is no current package
405(due to an empty C<package;> directive), __PACKAGE__ is the undefined
406value.
407X<__FILE__> X<__LINE__> X<__PACKAGE__> X<line> X<file> X<package>
408
409The two control characters ^D and ^Z, and the tokens __END__ and __DATA__
410may be used to indicate the logical end of the script before the actual
411end of file. Any following text is ignored.
412
413Text after __DATA__ but may be read via the filehandle C<PACKNAME::DATA>,
414where C<PACKNAME> is the package that was current when the __DATA__
415token was encountered. The filehandle is left open pointing to the
416contents after __DATA__. It is the program's responsibility to
417C<close DATA> when it is done reading from it. For compatibility with
418older scripts written before __DATA__ was introduced, __END__ behaves
419like __DATA__ in the toplevel script (but not in files loaded with
420C<require> or C<do>) and leaves the remaining contents of the
421file accessible via C<main::DATA>.
422
423See L<SelfLoader> for more description of __DATA__, and
424an example of its use. Note that you cannot read from the DATA
425filehandle in a BEGIN block: the BEGIN block is executed as soon
426as it is seen (during compilation), at which point the corresponding
427__DATA__ (or __END__) token has not yet been seen.
428
429=head3 Barewords
430X<bareword>
431
432A word that has no other interpretation in the grammar will
433be treated as if it were a quoted string. These are known as
434"barewords". As with filehandles and labels, a bareword that consists
435entirely of lowercase letters risks conflict with future reserved
436words, and if you use the C<use warnings> pragma or the B<-w> switch,
437Perl will warn you about any
438such words. Some people may wish to outlaw barewords entirely. If you
439say
440
441 use strict 'subs';
442
443then any bareword that would NOT be interpreted as a subroutine call
444produces a compile-time error instead. The restriction lasts to the
445end of the enclosing block. An inner block may countermand this
446by saying C<no strict 'subs'>.
447
448=head3 Array Joining Delimiter
449X<array, interpolation> X<interpolation, array> X<$">
450
451Arrays and slices are interpolated into double-quoted strings
452by joining the elements with the delimiter specified in the C<$">
453variable (C<$LIST_SEPARATOR> if "use English;" is specified),
454space by default. The following are equivalent:
455
456 $temp = join($", @ARGV);
457 system "echo $temp";
458
459 system "echo @ARGV";
460
461Within search patterns (which also undergo double-quotish substitution)
462there is an unfortunate ambiguity: Is C</$foo[bar]/> to be interpreted as
463C</${foo}[bar]/> (where C<[bar]> is a character class for the regular
464expression) or as C</${foo[bar]}/> (where C<[bar]> is the subscript to array
465@foo)? If @foo doesn't otherwise exist, then it's obviously a
466character class. If @foo exists, Perl takes a good guess about C<[bar]>,
467and is almost always right. If it does guess wrong, or if you're just
468plain paranoid, you can force the correct interpretation with curly
469braces as above.
470
471If you're looking for the information on how to use here-documents,
472which used to be here, that's been moved to
473L<perlop/Quote and Quote-like Operators>.
474
475=head2 List value constructors
476X<list>
477
478List values are denoted by separating individual values by commas
479(and enclosing the list in parentheses where precedence requires it):
480
481 (LIST)
482
483In a context not requiring a list value, the value of what appears
484to be a list literal is simply the value of the final element, as
485with the C comma operator. For example,
486
487 @foo = ('cc', '-E', $bar);
488
489assigns the entire list value to array @foo, but
490
491 $foo = ('cc', '-E', $bar);
492
493assigns the value of variable $bar to the scalar variable $foo.
494Note that the value of an actual array in scalar context is the
495length of the array; the following assigns the value 3 to $foo:
496
497 @foo = ('cc', '-E', $bar);
498 $foo = @foo; # $foo gets 3
499
500You may have an optional comma before the closing parenthesis of a
501list literal, so that you can say:
502
503 @foo = (
504 1,
505 2,
506 3,
507 );
508
509To use a here-document to assign an array, one line per element,
510you might use an approach like this:
511
512 @sauces = <<End_Lines =~ m/(\S.*\S)/g;
513 normal tomato
514 spicy tomato
515 green chile
516 pesto
517 white wine
518 End_Lines
519
520LISTs do automatic interpolation of sublists. That is, when a LIST is
521evaluated, each element of the list is evaluated in list context, and
522the resulting list value is interpolated into LIST just as if each
523individual element were a member of LIST. Thus arrays and hashes lose their
524identity in a LIST--the list
525
526 (@foo,@bar,&SomeSub,%glarch)
527
528contains all the elements of @foo followed by all the elements of @bar,
529followed by all the elements returned by the subroutine named SomeSub
530called in list context, followed by the key/value pairs of %glarch.
531To make a list reference that does I<NOT> interpolate, see L<perlref>.
532
533The null list is represented by (). Interpolating it in a list
534has no effect. Thus ((),(),()) is equivalent to (). Similarly,
535interpolating an array with no elements is the same as if no
536array had been interpolated at that point.
537
538This interpolation combines with the facts that the opening
539and closing parentheses are optional (except when necessary for
540precedence) and lists may end with an optional comma to mean that
541multiple commas within lists are legal syntax. The list C<1,,3> is a
542concatenation of two lists, C<1,> and C<3>, the first of which ends
543with that optional comma. C<1,,3> is C<(1,),(3)> is C<1,3> (And
544similarly for C<1,,,3> is C<(1,),(,),3> is C<1,3> and so on.) Not that
545we'd advise you to use this obfuscation.
546
547A list value may also be subscripted like a normal array. You must
548put the list in parentheses to avoid ambiguity. For example:
549
550 # Stat returns list value.
551 $time = (stat($file))[8];
552
553 # SYNTAX ERROR HERE.
554 $time = stat($file)[8]; # OOPS, FORGOT PARENTHESES
555
556 # Find a hex digit.
557 $hexdigit = ('a','b','c','d','e','f')[$digit-10];
558
559 # A "reverse comma operator".
560 return (pop(@foo),pop(@foo))[0];
561
562Lists may be assigned to only when each element of the list
563is itself legal to assign to:
564
565 ($a, $b, $c) = (1, 2, 3);
566
567 ($map{'red'}, $map{'blue'}, $map{'green'}) = (0x00f, 0x0f0, 0xf00);
568
569An exception to this is that you may assign to C<undef> in a list.
570This is useful for throwing away some of the return values of a
571function:
572
573 ($dev, $ino, undef, undef, $uid, $gid) = stat($file);
574
575List assignment in scalar context returns the number of elements
576produced by the expression on the right side of the assignment:
577
578 $x = (($foo,$bar) = (3,2,1)); # set $x to 3, not 2
579 $x = (($foo,$bar) = f()); # set $x to f()'s return count
580
581This is handy when you want to do a list assignment in a Boolean
582context, because most list functions return a null list when finished,
583which when assigned produces a 0, which is interpreted as FALSE.
584
585It's also the source of a useful idiom for executing a function or
586performing an operation in list context and then counting the number of
587return values, by assigning to an empty list and then using that
588assignment in scalar context. For example, this code:
589
590 $count = () = $string =~ /\d+/g;
591
592will place into $count the number of digit groups found in $string.
593This happens because the pattern match is in list context (since it
594is being assigned to the empty list), and will therefore return a list
595of all matching parts of the string. The list assignment in scalar
596context will translate that into the number of elements (here, the
597number of times the pattern matched) and assign that to $count. Note
598that simply using
599
600 $count = $string =~ /\d+/g;
601
602would not have worked, since a pattern match in scalar context will
603only return true or false, rather than a count of matches.
604
605The final element of a list assignment may be an array or a hash:
606
607 ($a, $b, @rest) = split;
608 my($a, $b, %rest) = @_;
609
610You can actually put an array or hash anywhere in the list, but the first one
611in the list will soak up all the values, and anything after it will become
612undefined. This may be useful in a my() or local().
613
614A hash can be initialized using a literal list holding pairs of
615items to be interpreted as a key and a value:
616
617 # same as map assignment above
618 %map = ('red',0x00f,'blue',0x0f0,'green',0xf00);
619
620While literal lists and named arrays are often interchangeable, that's
621not the case for hashes. Just because you can subscript a list value like
622a normal array does not mean that you can subscript a list value as a
623hash. Likewise, hashes included as parts of other lists (including
624parameters lists and return lists from functions) always flatten out into
625key/value pairs. That's why it's good to use references sometimes.
626
627It is often more readable to use the C<< => >> operator between key/value
628pairs. The C<< => >> operator is mostly just a more visually distinctive
629synonym for a comma, but it also arranges for its left-hand operand to be
630interpreted as a string -- if it's a bareword that would be a legal simple
631identifier (C<< => >> doesn't quote compound identifiers, that contain
632double colons). This makes it nice for initializing hashes:
633
634 %map = (
635 red => 0x00f,
636 blue => 0x0f0,
637 green => 0xf00,
638 );
639
640or for initializing hash references to be used as records:
641
642 $rec = {
643 witch => 'Mable the Merciless',
644 cat => 'Fluffy the Ferocious',
645 date => '10/31/1776',
646 };
647
648or for using call-by-named-parameter to complicated functions:
649
650 $field = $query->radio_group(
651 name => 'group_name',
652 values => ['eenie','meenie','minie'],
653 default => 'meenie',
654 linebreak => 'true',
655 labels => \%labels
656 );
657
658Note that just because a hash is initialized in that order doesn't
659mean that it comes out in that order. See L<perlfunc/sort> for examples
660of how to arrange for an output ordering.
661
662=head2 Subscripts
663
664An array is subscripted by specifying a dollar sign (C<$>), then the
665name of the array (without the leading C<@>), then the subscript inside
666square brackets. For example:
667
668 @myarray = (5, 50, 500, 5000);
669 print "Element Number 2 is", $myarray[2], "\n";
670
671The array indices start with 0. A negative subscript retrieves its
672value from the end. In our example, C<$myarray[-1]> would have been
6735000, and C<$myarray[-2]> would have been 500.
674
675Hash subscripts are similar, only instead of square brackets curly brackets
676are used. For example:
677
678 %scientists =
679 (
680 "Newton" => "Isaac",
681 "Einstein" => "Albert",
682 "Darwin" => "Charles",
683 "Feynman" => "Richard",
684 );
685
686 print "Darwin's First Name is ", $scientists{"Darwin"}, "\n";
687
688=head2 Slices
689X<slice> X<array, slice> X<hash, slice>
690
691A common way to access an array or a hash is one scalar element at a
692time. You can also subscript a list to get a single element from it.
693
694 $whoami = $ENV{"USER"}; # one element from the hash
695 $parent = $ISA[0]; # one element from the array
696 $dir = (getpwnam("daemon"))[7]; # likewise, but with list
697
698A slice accesses several elements of a list, an array, or a hash
699simultaneously using a list of subscripts. It's more convenient
700than writing out the individual elements as a list of separate
701scalar values.
702
703 ($him, $her) = @folks[0,-1]; # array slice
704 @them = @folks[0 .. 3]; # array slice
705 ($who, $home) = @ENV{"USER", "HOME"}; # hash slice
706 ($uid, $dir) = (getpwnam("daemon"))[2,7]; # list slice
707
708Since you can assign to a list of variables, you can also assign to
709an array or hash slice.
710
711 @days[3..5] = qw/Wed Thu Fri/;
712 @colors{'red','blue','green'}
713 = (0xff0000, 0x0000ff, 0x00ff00);
714 @folks[0, -1] = @folks[-1, 0];
715
716The previous assignments are exactly equivalent to
717
718 ($days[3], $days[4], $days[5]) = qw/Wed Thu Fri/;
719 ($colors{'red'}, $colors{'blue'}, $colors{'green'})
720 = (0xff0000, 0x0000ff, 0x00ff00);
721 ($folks[0], $folks[-1]) = ($folks[-1], $folks[0]);
722
723Since changing a slice changes the original array or hash that it's
724slicing, a C<foreach> construct will alter some--or even all--of the
725values of the array or hash.
726
727 foreach (@array[ 4 .. 10 ]) { s/peter/paul/ }
728
729 foreach (@hash{qw[key1 key2]}) {
730 s/^\s+//; # trim leading whitespace
731 s/\s+$//; # trim trailing whitespace
732 s/(\w+)/\u\L$1/g; # "titlecase" words
733 }
734
735A slice of an empty list is still an empty list. Thus:
736
737 @a = ()[1,0]; # @a has no elements
738 @b = (@a)[0,1]; # @b has no elements
739 @c = (0,1)[2,3]; # @c has no elements
740
741But:
742
743 @a = (1)[1,0]; # @a has two elements
744 @b = (1,undef)[1,0,2]; # @b has three elements
745
746This makes it easy to write loops that terminate when a null list
747is returned:
748
749 while ( ($home, $user) = (getpwent)[7,0]) {
750 printf "%-8s %s\n", $user, $home;
751 }
752
753As noted earlier in this document, the scalar sense of list assignment
754is the number of elements on the right-hand side of the assignment.
755The null list contains no elements, so when the password file is
756exhausted, the result is 0, not 2.
757
758If you're confused about why you use an '@' there on a hash slice
759instead of a '%', think of it like this. The type of bracket (square
760or curly) governs whether it's an array or a hash being looked at.
761On the other hand, the leading symbol ('$' or '@') on the array or
762hash indicates whether you are getting back a singular value (a
763scalar) or a plural one (a list).
764
765=head2 Typeglobs and Filehandles
766X<typeglob> X<filehandle> X<*>
767
768Perl uses an internal type called a I<typeglob> to hold an entire
769symbol table entry. The type prefix of a typeglob is a C<*>, because
770it represents all types. This used to be the preferred way to
771pass arrays and hashes by reference into a function, but now that
772we have real references, this is seldom needed.
773
774The main use of typeglobs in modern Perl is create symbol table aliases.
775This assignment:
776
777 *this = *that;
778
779makes $this an alias for $that, @this an alias for @that, %this an alias
780for %that, &this an alias for &that, etc. Much safer is to use a reference.
781This:
782
783 local *Here::blue = \$There::green;
784
785temporarily makes $Here::blue an alias for $There::green, but doesn't
786make @Here::blue an alias for @There::green, or %Here::blue an alias for
787%There::green, etc. See L<perlmod/"Symbol Tables"> for more examples
788of this. Strange though this may seem, this is the basis for the whole
789module import/export system.
790
791Another use for typeglobs is to pass filehandles into a function or
792to create new filehandles. If you need to use a typeglob to save away
793a filehandle, do it this way:
794
795 $fh = *STDOUT;
796
797or perhaps as a real reference, like this:
798
799 $fh = \*STDOUT;
800
801See L<perlsub> for examples of using these as indirect filehandles
802in functions.
803
804Typeglobs are also a way to create a local filehandle using the local()
805operator. These last until their block is exited, but may be passed back.
806For example:
807
808 sub newopen {
809 my $path = shift;
810 local *FH; # not my!
811 open (FH, $path) or return undef;
812 return *FH;
813 }
814 $fh = newopen('/etc/passwd');
815
816Now that we have the C<*foo{THING}> notation, typeglobs aren't used as much
817for filehandle manipulations, although they're still needed to pass brand
818new file and directory handles into or out of functions. That's because
819C<*HANDLE{IO}> only works if HANDLE has already been used as a handle.
820In other words, C<*FH> must be used to create new symbol table entries;
821C<*foo{THING}> cannot. When in doubt, use C<*FH>.
822
823All functions that are capable of creating filehandles (open(),
824opendir(), pipe(), socketpair(), sysopen(), socket(), and accept())
825automatically create an anonymous filehandle if the handle passed to
826them is an uninitialized scalar variable. This allows the constructs
827such as C<open(my $fh, ...)> and C<open(local $fh,...)> to be used to
828create filehandles that will conveniently be closed automatically when
829the scope ends, provided there are no other references to them. This
830largely eliminates the need for typeglobs when opening filehandles
831that must be passed around, as in the following example:
832
833 sub myopen {
834 open my $fh, "@_"
835 or die "Can't open '@_': $!";
836 return $fh;
837 }
838
839 {
840 my $f = myopen("</etc/motd");
841 print <$f>;
842 # $f implicitly closed here
843 }
844
845Note that if an initialized scalar variable is used instead the
846result is different: C<my $fh='zzz'; open($fh, ...)> is equivalent
847to C<open( *{'zzz'}, ...)>.
848C<use strict 'refs'> forbids such practice.
849
850Another way to create anonymous filehandles is with the Symbol
851module or with the IO::Handle module and its ilk. These modules
852have the advantage of not hiding different types of the same name
853during the local(). See the bottom of L<perlfunc/open()> for an
854example.
855
856=head1 SEE ALSO
857
858See L<perlvar> for a description of Perl's built-in variables and
859a discussion of legal variable names. See L<perlref>, L<perlsub>,
860and L<perlmod/"Symbol Tables"> for more discussion on typeglobs and
861the C<*foo{THING}> syntax.
Note: See TracBrowser for help on using the repository browser.