ext/I18N-Langinfo/Langinfo.pm

   1 package I18N::Langinfo;
   2
   3 use 5.006;
   4 use strict;
   5 use warnings;
   6 use Carp;
   7
   8 require Exporter;
   9 require XSLoader;
  10
  11 our @ISA = qw(Exporter);
  12
  13 our @EXPORT = qw(langinfo);
  14
  15 our @EXPORT_OK = qw(
  16         ABDAY_1
  17         ABDAY_2
  18         ABDAY_3
  19         ABDAY_4
  20         ABDAY_5
  21         ABDAY_6
  22         ABDAY_7
  23         ABMON_1
  24         ABMON_10
  25         ABMON_11
  26         ABMON_12
  27         ABMON_2
  28         ABMON_3
  29         ABMON_4
  30         ABMON_5
  31         ABMON_6
  32         ABMON_7
  33         ABMON_8
  34         ABMON_9
  35         ALT_DIGITS
  36         AM_STR
  37         CODESET
  38         CRNCYSTR
  39         DAY_1
  40         DAY_2
  41         DAY_3
  42         DAY_4
  43         DAY_5
  44         DAY_6
  45         DAY_7
  46         D_FMT
  47         D_T_FMT
  48         ERA
  49         ERA_D_FMT
  50         ERA_D_T_FMT
  51         ERA_T_FMT
  52         MON_1
  53         MON_10
  54         MON_11
  55         MON_12
  56         MON_2
  57         MON_3
  58         MON_4
  59         MON_5
  60         MON_6
  61         MON_7
  62         MON_8
  63         MON_9
  64         NOEXPR
  65         NOSTR
  66         PM_STR
  67         RADIXCHAR
  68         THOUSEP
  69         T_FMT
  70         T_FMT_AMPM
  71         YESEXPR
  72         YESSTR
  73 );
  74
  75 our $VERSION = '0.15';
  76
  77 XSLoader::load();
  78
  79 1;
  80 __END__
  81
  82 =head1 NAME
  83
  84 I18N::Langinfo - query locale information
  85
  86 =head1 SYNOPSIS
  87
  88   use I18N::Langinfo;
  89
  90 =head1 DESCRIPTION
  91
  92 The langinfo() function queries various locale information that can be
  93 used to localize output and user interfaces.  It uses the current underlying
  94 locale, regardless of whether or not it was called from within the scope of
  95 S<C<use locale>>.  The langinfo() requires
  96 one numeric argument that identifies the locale constant to query:
  97 if no argument is supplied, C<$_> is used.  The numeric constants
  98 appropriate to be used as arguments are exportable from I18N::Langinfo.
  99
 100 The following example will import the langinfo() function itself and
 101 three constants to be used as arguments to langinfo(): a constant for
 102 the abbreviated first day of the week (the numbering starts from
 103 Sunday = 1) and two more constants for the affirmative and negative
 104 answers for a yes/no question in the current locale.
 105
 106     use I18N::Langinfo qw(langinfo ABDAY_1 YESSTR NOSTR);
 107
 108     my ($abday_1, $yesstr, $nostr) =
 109         map { langinfo($_) } (ABDAY_1, YESSTR, NOSTR);
 110
 111     print "$abday_1? [$yesstr/$nostr] ";
 112
 113 In other words, in the "C" (or English) locale the above will probably
 114 print something like:
 115
 116     Sun? [yes/no]
 117
 118 but under a French locale
 119
 120     dim? [oui/non]
 121
 122 The usually available constants are
 123
 124     ABDAY_1 ABDAY_2 ABDAY_3 ABDAY_4 ABDAY_5 ABDAY_6 ABDAY_7
 125     ABMON_1 ABMON_2 ABMON_3 ABMON_4 ABMON_5 ABMON_6
 126     ABMON_7 ABMON_8 ABMON_9 ABMON_10 ABMON_11 ABMON_12
 127     DAY_1 DAY_2 DAY_3 DAY_4 DAY_5 DAY_6 DAY_7
 128     MON_1 MON_2 MON_3 MON_4 MON_5 MON_6
 129     MON_7 MON_8 MON_9 MON_10 MON_11 MON_12
 130
 131 for abbreviated and full length days of the week and months of the year,
 132
 133     D_T_FMT D_FMT T_FMT
 134
 135 for the date-time, date, and time formats used by the strftime() function
 136 (see L<POSIX>)
 137
 138     AM_STR PM_STR T_FMT_AMPM
 139
 140 for the locales for which it makes sense to have ante meridiem and post
 141 meridiem time formats,
 142
 143     CODESET CRNCYSTR RADIXCHAR
 144
 145 for the character code set being used (such as "ISO8859-1", "cp850",
 146 "koi8-r", "sjis", "utf8", etc.), for the currency string, for the
 147 radix character used between the integer and the fractional part
 148 of decimal numbers (yes, this is redundant with POSIX::localeconv())
 149
 150     YESSTR YESEXPR NOSTR NOEXPR
 151
 152 for the affirmative and negative responses and expressions, and
 153
 154     ERA ERA_D_FMT ERA_D_T_FMT ERA_T_FMT
 155
 156 for the Japanese Emperor eras (naturally only defined under Japanese locales).
 157
 158 See your L<langinfo(3)> for more information about the available
 159 constants.  (Often this means having to look directly at the
 160 F<langinfo.h> C header file.)
 161
 162 Note that unfortunately none of the above constants are guaranteed
 163 to be available on a particular platform.  To be on the safe side
 164 you can wrap the import in an eval like this:
 165
 166     eval {
 167         require I18N::Langinfo;
 168         I18N::Langinfo->import(qw(langinfo CODESET));
 169         $codeset = langinfo(CODESET()); # note the ()
 170     };
 171     if ($@) { ... failed ... }
 172
 173 =head2 EXPORT
 174
 175 By default only the C<langinfo()> function is exported.
 176
 177 =head1 BUGS
 178
 179 Before Perl 5.28, the returned values are unreliable for the C<RADIXCHAR> and
 180 C<THOUSEP> locale constants.
 181
 182 =head1 SEE ALSO
 183
 184 L<perllocale>, L<POSIX/localeconv>, L<POSIX/setlocale>, L<nl_langinfo(3)>.
 185
 186 The langinfo() is just a wrapper for the C nl_langinfo() interface.
 187
 188 =head1 AUTHOR
 189
 190 Jarkko Hietaniemi, E<lt>jhi@hut.fiE<gt>
 191
 192 =head1 COPYRIGHT AND LICENSE
 193
 194 Copyright 2001 by Jarkko Hietaniemi
 195
 196 This library is free software; you can redistribute it and/or modify
 197 it under the same terms as Perl itself.
 198
 199 =cut