package I18N::Langinfo;

use 5.006;
use strict;
use warnings;
use Carp;

use Exporter 'import';
require XSLoader;

our @EXPORT = qw(langinfo);

our @EXPORT_OK = qw(
                    ABDAY_1
                    ABDAY_2
                    ABDAY_3
                    ABDAY_4
                    ABDAY_5
                    ABDAY_6
                    ABDAY_7
                    ABMON_1
                    ABMON_2
                    ABMON_3
                    ABMON_4
                    ABMON_5
                    ABMON_6
                    ABMON_7
                    ABMON_8
                    ABMON_9
                    ABMON_10
                    ABMON_11
                    ABMON_12
                    ALT_DIGITS
                    AM_STR
                    CODESET
                    CRNCYSTR
                    DAY_1
                    DAY_2
                    DAY_3
                    DAY_4
                    DAY_5
                    DAY_6
                    DAY_7
                    D_FMT
                    D_T_FMT
                    ERA
                    ERA_D_FMT
                    ERA_D_T_FMT
                    ERA_T_FMT
                    MON_1
                    MON_2
                    MON_3
                    MON_4
                    MON_5
                    MON_6
                    MON_7
                    MON_8
                    MON_9
                    MON_10
                    MON_11
                    MON_12
                    NOEXPR
                    NOSTR
                    PM_STR
                    RADIXCHAR
                    THOUSEP
                    T_FMT
                    T_FMT_AMPM
                    YESEXPR
                    YESSTR
                    _NL_ADDRESS_POSTAL_FMT
                    _NL_ADDRESS_COUNTRY_NAME
                    _NL_ADDRESS_COUNTRY_POST
                    _NL_ADDRESS_COUNTRY_AB2
                    _NL_ADDRESS_COUNTRY_AB3
                    _NL_ADDRESS_COUNTRY_CAR
                    _NL_ADDRESS_COUNTRY_NUM
                    _NL_ADDRESS_COUNTRY_ISBN
                    _NL_ADDRESS_LANG_NAME
                    _NL_ADDRESS_LANG_AB
                    _NL_ADDRESS_LANG_TERM
                    _NL_ADDRESS_LANG_LIB
                    _NL_IDENTIFICATION_TITLE
                    _NL_IDENTIFICATION_SOURCE
                    _NL_IDENTIFICATION_ADDRESS
                    _NL_IDENTIFICATION_CONTACT
                    _NL_IDENTIFICATION_EMAIL
                    _NL_IDENTIFICATION_TEL
                    _NL_IDENTIFICATION_FAX
                    _NL_IDENTIFICATION_LANGUAGE
                    _NL_IDENTIFICATION_TERRITORY
                    _NL_IDENTIFICATION_AUDIENCE
                    _NL_IDENTIFICATION_APPLICATION
                    _NL_IDENTIFICATION_ABBREVIATION
                    _NL_IDENTIFICATION_REVISION
                    _NL_IDENTIFICATION_DATE
                    _NL_IDENTIFICATION_CATEGORY
                    _NL_MEASUREMENT_MEASUREMENT
                    _NL_NAME_NAME_FMT
                    _NL_NAME_NAME_GEN
                    _NL_NAME_NAME_MR
                    _NL_NAME_NAME_MRS
                    _NL_NAME_NAME_MISS
                    _NL_NAME_NAME_MS
                    _NL_PAPER_HEIGHT
                    _NL_PAPER_WIDTH
                    _NL_TELEPHONE_TEL_INT_FMT
                    _NL_TELEPHONE_TEL_DOM_FMT
                    _NL_TELEPHONE_INT_SELECT
                    _NL_TELEPHONE_INT_PREFIX
                   );

our $VERSION = '0.24';

XSLoader::load();

1;
__END__

=encoding utf8

=head1 NAME

I18N::Langinfo - query locale information

=head1 SYNOPSIS

  use I18N::Langinfo;

=head1 DESCRIPTION

The langinfo() function queries various locale information that can be
used to localize output and user interfaces.  It uses the current underlying
locale, regardless of whether or not it was called from within the scope of
S<C<use locale>>.  The langinfo() function requires
one numeric argument that identifies the locale constant to query:
if no argument is supplied, C<$_> is used.  The numeric constants
appropriate to be used as arguments are exportable from I18N::Langinfo.

The following example will import the langinfo() function itself and
three constants to be used as arguments to langinfo(): a constant for
the abbreviated first day of the week (the numbering starts from
Sunday = 1) and two more constants for the affirmative and negative
answers for a yes/no question in the current locale.

    use I18N::Langinfo qw(langinfo ABDAY_1 YESSTR NOSTR);

    my ($abday_1, $yesstr, $nostr) =
        map { langinfo($_) } (ABDAY_1, YESSTR, NOSTR);

    print "$abday_1? [$yesstr/$nostr] ";

In other words, in the "C" (or English) locale the above will probably
print something like:

    Sun? [yes/no]

but under a French locale

    dim? [oui/non]

The usually available constants are as follows.

=over 4

=item *

For abbreviated and full length days of the week and months of the year:

    ABDAY_1 ABDAY_2 ABDAY_3 ABDAY_4 ABDAY_5 ABDAY_6 ABDAY_7
    ABMON_1 ABMON_2 ABMON_3 ABMON_4 ABMON_5 ABMON_6
    ABMON_7 ABMON_8 ABMON_9 ABMON_10 ABMON_11 ABMON_12
    DAY_1 DAY_2 DAY_3 DAY_4 DAY_5 DAY_6 DAY_7
    MON_1 MON_2 MON_3 MON_4 MON_5 MON_6
    MON_7 MON_8 MON_9 MON_10 MON_11 MON_12

=item *

For the date-time, date, and time formats used by the strftime() function
(see L<POSIX>):

    D_T_FMT D_FMT T_FMT

=item *

For the locales for which it makes sense to have ante meridiem and post
meridiem time formats:

    AM_STR PM_STR T_FMT_AMPM

=item *

For the character code set being used (such as "ISO8859-1", "cp850",
"koi8-r", "sjis", "utf8", etc.):

    CODESET

=item *

For the symbol or string of characters that indicates a number is a monetary
value:

    CRNCYSTR

An example is the dollar sign C<$>.  Some locales not associated with
particular locations may have an empty currency string.  (The C locale is
one.)  Otherwise, the return of this is always prefixed by one of these three
characters:

=over

=item C<->

indicates that in this locale, the string precedes the numeric value, as in a
U.S. locale: C<$9.95>.

=item C<+>

indicates that in this locale, the string follows the numeric value, like
C<9.95USD>.

=item C<.>

indicates that in this locale, the string replaces the radix character, like
C<9$95>.

=back

=item *

For the radix character used between the integer and the fractional part of
decimal numbers, and the group separator string for large-ish floating point
numbers (yes, these are redundant with
L<POSIX::localeconv()|POSIX/localeconv>):

    RADIXCHAR THOUSEP

=item *

For any alternate digits used in this locale besides the standard C<0..9>:

    ALT_DIGITS

This returns a sequence of alternate numeric reprsesentations for the numbers
C<0> ... up to C<99>.  The representations are returned in a single string,
with a semi-colon C<;> used to separated the individual ones.

Most locales don't have alternate digits, so the string will be empty.

To access this data conveniently, you could do something like

 use I18N::Langinfo qw(langinfo ALT_DIGITS);
 my @alt_digits = split ';', langinfo(ALT_DIGITS);

The array C<@alt_digits> will contain 0 elements if the current locale doesn't
have alternate digits specified for it.  Otherwise, it will have as many
elements as the locale defines, with C<[0]> containing the alternate digit for
zero; C<[1]> for one; and so forth, up to potentially C<[99]> for the
alternate representation of ninety-nine.

Be aware that the alternate representation in some locales for the numbers
0..9 will have a leading alternate-zero, so would look like the equivalent of
00..09.

Running this program

 use I18N::Langinfo qw(langinfo ALT_DIGITS);
 my @alt_digits = split ';', langinfo(ALT_DIGITS);
 splice @alt_digits, 15;
 print join " ", @alt_digits, "\n";

on a Japanese locale yields

S<C<〇 一 二 三 四 五 六 七 八 九 十 十一 十二 十三 十四>>

on some platforms.

=item *

For the affirmative and negative responses and expressions:

    YESSTR YESEXPR NOSTR NOEXPR

=item *

For the eras based on typically some ruler, such as the Japanese Emperor
(naturally only defined in the appropriate locales):

    ERA ERA_D_FMT ERA_D_T_FMT ERA_T_FMT

=back

In addition, Linux boxes have extra items, as follows.  (When called from
other platform types, these return a stub value, of not much use.)

=over

=item C<_NL_ADDRESS_POSTAL_FMT>

=item C<_NL_ADDRESS_COUNTRY_NAME>

=item C<_NL_ADDRESS_COUNTRY_POST>

=item C<_NL_ADDRESS_COUNTRY_AB2>

=item C<_NL_ADDRESS_COUNTRY_AB3>

=item C<_NL_ADDRESS_COUNTRY_CAR>

=item C<_NL_ADDRESS_COUNTRY_NUM>

=item C<_NL_ADDRESS_COUNTRY_ISBN>

=item C<_NL_ADDRESS_LANG_NAME>

=item C<_NL_ADDRESS_LANG_AB>

=item C<_NL_ADDRESS_LANG_TERM>

=item C<_NL_ADDRESS_LANG_LIB>

On Linux boxes, these return information about the country for the current
locale.  Further information is found in F<langinfo.h>

=item C<_NL_IDENTIFICATION_TITLE>

=item C<_NL_IDENTIFICATION_SOURCE>

=item C<_NL_IDENTIFICATION_ADDRESS>

=item C<_NL_IDENTIFICATION_CONTACT>

=item C<_NL_IDENTIFICATION_EMAIL>

=item C<_NL_IDENTIFICATION_TEL>

=item C<_NL_IDENTIFICATION_FAX>

=item C<_NL_IDENTIFICATION_LANGUAGE>

=item C<_NL_IDENTIFICATION_TERRITORY>

=item C<_NL_IDENTIFICATION_AUDIENCE>

=item C<_NL_IDENTIFICATION_APPLICATION>

=item C<_NL_IDENTIFICATION_ABBREVIATION>

=item C<_NL_IDENTIFICATION_REVISION>

=item C<_NL_IDENTIFICATION_DATE>

=item C<_NL_IDENTIFICATION_CATEGORY>

On Linux boxes, these return meta information about the current locale,
such as how to get in touch with its maintainers.
Further information is found in F<langinfo.h>

=item C<_NL_MEASUREMENT_MEASUREMENT>

On Linux boxes, it returns 1 if the metric system of measurement prevails in
the locale; or 2 if US customary units prevail.

=item C<_NL_NAME_NAME_FMT>

=item C<_NL_NAME_NAME_GEN>

=item C<_NL_NAME_NAME_MR>

=item C<_NL_NAME_NAME_MRS>

=item C<_NL_NAME_NAME_MISS>

=item C<_NL_NAME_NAME_MS>

On Linux boxes, these return information about how names are formatted and
the personal salutations used in the current locale.  Further information
is found in L<locale(7)> and F<langinfo.h>

=item C<_NL_PAPER_HEIGHT>

=item C<_NL_PAPER_WIDTH>

On Linux boxes, these return the standard size of sheets of paper (in
millimeters) in the current locale.

=item C<_NL_TELEPHONE_TEL_INT_FMT>

=item C<_NL_TELEPHONE_TEL_DOM_FMT>

=item C<_NL_TELEPHONE_INT_SELECT>

=item C<_NL_TELEPHONE_INT_PREFIX>

On Linux boxes, these return information about how telephone numbers are
formatted (both domestically and international calling) in the current locale.
Further information is found in F<langinfo.h>

=back

=head2 For systems without C<nl_langinfo>

This module originally was just a wrapper for the libc C<nl_langinfo>
function, and did not work on systems lacking it, such as Windows.

Starting in Perl 5.28, this module works on all platforms.  When
C<nl_langinfo> is not available, it uses various methods to construct
what that function, if present, would return.  But there are potential
glitches.  These are the items that could be different:

=over

=item C<ERA>

Unimplemented, so returns C<"">.

=item C<CODESET>

This should work properly for Windows platforms.  On almost all other modern
platforms, it will reliably return "UTF-8" if that is the code set.
Otherwise, it depends on the locale's name.  If that is of the form
C<foo.bar>, it will assume C<bar> is the code set; and it also knows about the
two locales "C" and "POSIX".  If none of those apply it returns C<"">.

=item C<YESEXPR>

=item C<YESSTR>

=item C<NOEXPR>

=item C<NOSTR>

Only the values for English are returned.  C<YESSTR> and C<NOSTR> have been
removed from POSIX 2008, and are retained here for backwards compatibility.
Your platform's C<nl_langinfo> may not support them.

=item C<ALT_DIGITS>

On systems with a C<L<strftime(3)>> that recognizes the POSIX-defined C<%O>
format modifier (not Windows), perl tries hard to return these.  The result
likely will go as high as what C<nl_langinfo()> would return, but not
necessarily; and the numbers from C<0..9> will always be stripped of leading
zeros.

Without C<%O>, an empty string is always returned.

=item C<D_FMT>

Always evaluates to C<%x>, the locale's appropriate date representation.

=item C<T_FMT>

Always evaluates to C<%X>, the locale's appropriate time representation.

=item C<D_T_FMT>

Always evaluates to C<%c>, the locale's appropriate date and time
representation.

=item C<CRNCYSTR>

The return may be incorrect for those rare locales where the currency symbol
replaces the radix character.  If you have examples of it needing to work
differently, please file a report at L<https://github.com/Perl/perl5/issues>.

=item C<ERA_D_FMT>

=item C<ERA_T_FMT>

=item C<ERA_D_T_FMT>

=item C<T_FMT_AMPM>

These are derived by using C<strftime()>, and not all versions of that function
know about them.  C<""> is returned for these on such systems.

=item All C<_NL_I<foo>> items

These return the same values as they do on boxes that don't have the
appropriate underlying locale categories.

=back

See your L<nl_langinfo(3)> for more information about the available
constants.  (Often this means having to look directly at the
F<langinfo.h> C header file.)

=head2 EXPORT

By default only the C<langinfo()> function is exported.

=head1 BUGS

Before Perl 5.28, the returned values are unreliable for the C<RADIXCHAR> and
C<THOUSEP> locale constants.

Starting in 5.28, changing locales on threaded builds is supported on systems
that offer thread-safe locale functions.  These include POSIX 2008 systems and
Windows starting with Visual Studio 2005, and this module will work properly
in such situations.  However, on threaded builds on Windows prior to Visual
Studio 2015, retrieving the items C<CRNCYSTR> and C<THOUSEP> can result in a
race with a thread that has converted to use the global locale.  It is quite
uncommon for a thread to have done this.  It would be possible to construct a
workaround for this; patches welcome: see L<perlapi/switch_to_global_locale>.

=head1 SEE ALSO

L<perllocale>, L<POSIX/localeconv>, L<POSIX/setlocale>, L<nl_langinfo(3)>.

=head1 AUTHOR

Jarkko Hietaniemi, E<lt>jhi@hut.fiE<gt>.  Now maintained by Perl 5 porters.

=head1 COPYRIGHT AND LICENSE

Copyright 2001 by Jarkko Hietaniemi

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut