Add test for grep() and wantarray
[p5sagit/p5-mst-13.2.git] / pod / perllocale.pod
index f77cd30..41a0bc5 100644 (file)
@@ -23,6 +23,8 @@ several environment variables.
 
 B<NOTE>: This feature is new in Perl 5.004, and does not apply unless an
 application specifically requests it - see L<Backward compatibility>.
+The one exception is that write() now B<always> uses the current locale
+- see L<"NOTES">.
 
 =head1 PREPARING TO USE LOCALES
 
@@ -204,15 +206,16 @@ command lines:
 
 and see whether they list something resembling these
 
+        en_US.ISO8859-1     de_DE.ISO8859-1     ru_RU.ISO8859-5
+        en_US               de_DE               ru_RU
         en                  de                  ru
-        english             de_DE               russian
-        english.iso88591    de_DE.ISO8859-1     russian.iso88595
-        en_US               german              ru_RU
-        en_US.ISO8859-1     german.iso88591     ru_RU.ISO8859-5
+        english             german              russian
+        english.iso88591    german.iso88591     russian.iso88595
 
 Sadly, even though the calling interface for setlocale() has been
-standardized, the names of the locales have not.  The form of the name
-is usually I<language_country>B</>I<territory>B<.>I<codeset>, but the
+standardized, the names of the locales and the directories where
+the configuration is, have not.  The basic form of the name is
+I<language_country/territory>B<.>I<codeset>, but the
 latter parts are not always present.
 
 Two special locales are worth particular mention: "C" and "POSIX".
@@ -320,18 +323,7 @@ can use POSIX::strcoll() if you don't want this fall-back:
 
 $equal_in_locale will be true if the collation locale specifies a
 dictionary-like ordering which ignores space characters completely, and
-which folds case.  Alternatively, you can use this idiom:
-
-        use locale;
-        $s_a = "space and case ignored";
-        $s_b = "SpaceAndCaseIgnored";
-        $equal_in_locale = $s_a ge $s_b && $s_a le $s_b;
-
-which works because neither C<ne> nor C<ge> falls back to doing a
-byte-by-byte comparison when the operands are equal according to the
-locale.  The idiom may be less efficient than using strcoll(), but,
-unlike that function, it is not confused by strings containing embedded
-nulls.
+which folds case.
 
 If you have a single string which you want to check for "equality in
 locale" against several others, you might think you could gain a little
@@ -356,10 +348,12 @@ a couple of transformations.  In fact, it doesn't save anything: Perl
 magic (see L<perlguts/Magic>) creates the transformed version of a
 string the first time it's needed in a comparison, then keeps it around
 in case it's needed again.  An example rewritten the easy way with
-C<cmp> runs just about as fast. It also copes with null characters
+C<cmp> runs just about as fast.  It also copes with null characters
 embedded in strings; if you call strxfrm() directly, it treats the first
-null it finds as a terminator. In short, don't call strxfrm() directly:
-let Perl do it for you.
+null it finds as a terminator.  And don't expect the transformed strings
+it produces to be portable across systems - or even from one revision
+of your operating system to the next.  In short, don't call strxfrm()
+directly: let Perl do it for you.
 
 Note: C<use locale> isn't shown in some of these examples, as it isn't
 needed: strcoll() and strxfrm() exist only to generate locale-dependent
@@ -376,7 +370,14 @@ regular expressions.)  Thanks to C<LC_CTYPE>, depending on your locale
 setting, characters like 'E<aelig>', 'E<eth>', 'E<szlig>', and
 'E<oslash>' may be understood as C<\w> characters.
 
-C<LC_CTYPE> also affects the POSIX character-class test functions -
+The C<LC_CTYPE> locale also provides the map used in translating
+characters between lower- and upper-case.  This affects the case-mapping
+functions - lc(), lcfirst, uc() and ucfirst(); case-mapping
+interpolation with C<\l>, C<\L>, C<\u> or <\U> in double-quoted strings
+and in C<s///> substitutions; and case-independent regular expression
+pattern matching using the C<i> modifier.
+
+Finally, C<LC_CTYPE> affects the POSIX character-class test functions -
 isalpha(), islower() and so on.  For example, if you move from the "C"
 locale to a 7-bit Scandinavian one, you may find - possibly to your
 surprise - that "|" moves from the ispunct() class to isalpha().
@@ -477,6 +478,12 @@ characters such as "E<gt>" and "|" are alphanumeric.
 
 =item *
 
+String interpolation with case-mapping, as in, say, C<$dest =
+"C:\U$name.$ext">, may produce dangerous results if a bogus LC_CTYPE
+case-mapping table is in effect.
+
+=item *
+
 If the decimal point character in the C<LC_NUMERIC> locale is
 surreptitiously changed from a dot to a comma, C<sprintf("%g",
 0.123456e3)> produces a string result of "123,456". Many people would
@@ -524,22 +531,31 @@ the locale:
 
 Scalar true/false (or less/equal/greater) result is never tainted.
 
+=item B<Case-mapping interpolation> (with C<\l>, C<\L>, C<\u> or <\U>)
+
+Result string containing interpolated material is tainted if
+C<use locale> is in effect.
+
 =item B<Matching operator> (C<m//>):
 
 Scalar true/false result never tainted.
 
 Subpatterns, either delivered as an array-context result, or as $1 etc.
 are tainted if C<use locale> is in effect, and the subpattern regular
-expression contains C<\w> (to match an alphanumeric character).  The
-matched pattern variable, $&, is also tainted if C<use locale> is in
-effect, and the regular expression contains C<\w>.
+expression contains C<\w> (to match an alphanumeric character), C<\W>
+(non-alphanumeric character), C<\s> (white-space character), or C<\S>
+(non white-space character).  The matched pattern variable, $&, $`
+(pre-match), $' (post-match), and $+ (last match) are also tainted if
+C<use locale> is in effect and the regular expression contains C<\w>,
+C<\W>, C<\s>, or C<\S>.
 
 =item B<Substitution operator> (C<s///>):
 
-Has the same behavior as the match operator.  When C<use locale> is
-in effect, he left operand of C<=~> will become tainted if it is
-modified as a result of a substitution based on a regular expression
-match involving C<\w>.
+Has the same behavior as the match operator.  Also, the left
+operand of C<=~> becomes tainted when C<use locale> in effect,
+if it is modified as a result of a substitution based on a regular
+expression match involving C<\w>, C<\W>, C<\s>, or C<\S>; or of
+case-mapping with C<\l>, C<\L>,C<\u> or <\U>.
 
 =item B<In-memory formatting function> (sprintf()):
 
@@ -717,6 +733,16 @@ exact multiplier depends on the string's contents, the operating system
 and the locale.) These downsides are dictated more by the operating
 system's implementation of the locale system than by Perl.
 
+=head2 write() and LC_NUMERIC
+
+Formats are the only part of Perl which unconditionally use information
+from a program's locale; if a program's environment specifies an
+LC_NUMERIC locale, it is always used to specify the decimal point
+character in formatted output.  Formatted output cannot be controlled by
+C<use locale> because the pragma is tied to the block structure of the
+program, and, for historical reasons, formats exist outside that block
+structure.
+
 =head2 Freely available locale definitions
 
 There is a large collection of locale definitions at
@@ -748,14 +774,14 @@ standard we've got.  This may be construed as a bug.
 
 =head2 Broken systems
 
-In certain system environments the operating system's locale support is
-broken and cannot be fixed or used by Perl.  Such deficiencies can and
-will result in mysterious hangs and/or Perl core dumps.  One example is
-IRIX before release 6.2, in which the C<LC_COLLATE> support simply does
-not work.  When confronted with such a system, please report in
-excruciating detail to C<perlbug@perl.com>, and complain to your vendor:
-maybe some bug fixes exist for these problems in your operating system.
-Sometimes such bug fixes are called an operating system upgrade.
+In certain system environments the operating system's locale support
+is broken and cannot be fixed or used by Perl.  Such deficiencies can
+and will result in mysterious hangs and/or Perl core dumps when the
+C<use locale> is in effect.  When confronted with such a system,
+please report in excruciating detail to C<perlbug@perl.com>, and
+complain to your vendor: maybe some bug fixes exist for these problems
+in your operating system.  Sometimes such bug fixes are called an
+operating system upgrade.
 
 =head1 SEE ALSO
 
@@ -771,4 +797,4 @@ L<POSIX (3)/strxfrm>
 Jarkko Hietaniemi's original F<perli18n.pod> heavily hacked by Dominic
 Dunlop, assisted by the perl5-porters.
 
-Last update: Tue Dec 24 16:43:11 EST 1996
+Last update: Wed Jan 22 11:04:58 EST 1997