Merge branch 'mg/doc-remote-tags-or-not' into maint
[alt-git.git] / perl / Git / I18N.pm
blobf889fd6da91d2d9b6a7469442a02e5478f094f8d
1 package Git::I18N;
2 use 5.008;
3 use strict;
4 use warnings;
5 BEGIN {
6 require Exporter;
7 if ($] < 5.008003) {
8 *import = \&Exporter::import;
9 } else {
10 # Exporter 5.57 which supports this invocation was
11 # released with perl 5.8.3
12 Exporter->import('import');
16 our @EXPORT = qw(__);
17 our @EXPORT_OK = @EXPORT;
19 sub __bootstrap_locale_messages {
20 our $TEXTDOMAIN = 'git';
21 our $TEXTDOMAINDIR = $ENV{GIT_TEXTDOMAINDIR} || '++LOCALEDIR++';
23 require POSIX;
24 POSIX->import(qw(setlocale));
25 # Non-core prerequisite module
26 require Locale::Messages;
27 Locale::Messages->import(qw(:locale_h :libintl_h));
29 setlocale(LC_MESSAGES(), '');
30 setlocale(LC_CTYPE(), '');
31 textdomain($TEXTDOMAIN);
32 bindtextdomain($TEXTDOMAIN => $TEXTDOMAINDIR);
34 return;
37 BEGIN
39 # Used by our test script to see if it should test fallbacks or
40 # not.
41 our $__HAS_LIBRARY = 1;
43 local $@;
44 eval {
45 __bootstrap_locale_messages();
46 *__ = \&Locale::Messages::gettext;
48 } or do {
49 # Tell test.pl that we couldn't load the gettext library.
50 $Git::I18N::__HAS_LIBRARY = 0;
52 # Just a fall-through no-op
53 *__ = sub ($) { $_[0] };
59 __END__
61 =head1 NAME
63 Git::I18N - Perl interface to Git's Gettext localizations
65 =head1 SYNOPSIS
67 use Git::I18N;
69 print __("Welcome to Git!\n");
71 printf __("The following error occurred: %s\n"), $error;
73 =head1 DESCRIPTION
75 Git's internal Perl interface to gettext via L<Locale::Messages>. If
76 L<Locale::Messages> can't be loaded (it's not a core module) we
77 provide stub passthrough fallbacks.
79 This is a distilled interface to gettext, see C<info '(gettext)Perl'>
80 for the full interface. This module implements only a small part of
81 it.
83 =head1 FUNCTIONS
85 =head2 __($)
87 L<Locale::Messages>'s gettext function if all goes well, otherwise our
88 passthrough fallback function.
90 =head1 AUTHOR
92 E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason <avarab@gmail.com>
94 =head1 COPYRIGHT
96 Copyright 2010 E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason <avarab@gmail.com>
98 =cut