File Coverage

File:Dpkg/Gettext.pm
Coverage:59.5%

linestmtbrancondsubpodtimecode
1# Based on Debconf::Gettext.
2#
3# Copyright © 2000 Joey Hess <joeyh@debian.org>
4# Copyright © 2006 Nicolas François <nicolas.francois@centraliens.net>
5# Copyright © 2007-2022 Guillem Jover <guillem@debian.org>
6#
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 2 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program.  If not, see <https://www.gnu.org/licenses/>.
19
20=encoding utf8
21
22 - 32
=head1 NAME

Dpkg::Gettext - convenience wrapper around Locale::gettext

=head1 DESCRIPTION

The Dpkg::Gettext module is a convenience wrapper over the L<Locale::gettext>
module, to guarantee we always have working gettext functions, and to add
some commonly used aliases.

=cut
33
34package Dpkg::Gettext 2.01;
35
36
2016
2016
2016
2016
4237
764
24968
use strict;
37
2016
2016
2016
2016
2775
1313
41656
use warnings;
38
2016
2016
2016
2016
2875
1258
90999
use feature qw(state);
39
40our @EXPORT = qw(
41    textdomain
42    gettext
43    ngettext
44    g_
45    P_
46    N_
47);
48
49
2016
2016
2016
2016
3008
1825
59218
use Exporter qw(import);
50
51 - 78
=head1 ENVIRONMENT

=over 4

=item DPKG_NLS

When set to 0, this environment variable will disable the National Language
Support in all Dpkg modules.

=back

=head1 VARIABLES

=over 4

=item $Dpkg::Gettext::DEFAULT_TEXT_DOMAIN

Specifies the default text domain name to be used with the short function
aliases. This is intended to be used by the Dpkg modules, so that they
can produce localized messages even when the calling program has set the
current domain with textdomain(). If you would like to use the aliases
for your own modules, you might want to set this variable to undef, or
to another domain, but then the Dpkg modules will not produce localized
messages.

=back

=cut
79
80our $DEFAULT_TEXT_DOMAIN = 'dpkg-dev';
81
82 - 121
=head1 FUNCTIONS

=over 4

=item $domain = textdomain($new_domain)

Compatibility textdomain() fallback when L<Locale::gettext> is not available.

If $new_domain is not undef, it will set the current domain to $new_domain.
Returns the current domain, after possibly changing it.

=item $trans = gettext($msgid)

Compatibility gettext() fallback when L<Locale::gettext> is not available.

Returns $msgid.

=item $trans = ngettext($msgid, $msgid_plural, $n)

Compatibility ngettext() fallback when L<Locale::gettext> is not available.

Returns $msgid if $n is 1 or $msgid_plural otherwise.

=item $trans = g_($msgid)

Calls dgettext() on the $msgid and returns its translation for the current
locale. If dgettext() is not available, simply returns $msgid.

=item $trans = C_($msgctxt, $msgid)

Calls dgettext() on the $msgid and returns its translation for the specific
$msgctxt supplied. If dgettext() is not available, simply returns $msgid.

=item $trans = P_($msgid, $msgid_plural, $n)

Calls dngettext(), returning the correct translation for the plural form
dependent on $n. If dngettext() is not available, returns $msgid if $n is 1
or $msgid_plural otherwise.

=cut
122
123
2016
2016
2016
2016
4607
1274
435037
use constant GETTEXT_CONTEXT_GLUE => "\004";
124
125BEGIN {
126
2016
50
2016
9499
    my $use_gettext = $ENV{DPKG_NLS} // 1;
127
2016
50
1675
    if ($use_gettext) {
128
2016
2016
2016
2016
2016
64125
254663
19707121
87725
        eval q{
129            use Locale::gettext;
130        };
131
2016
5630
        $use_gettext = not $@;
132    }
133
2016
50
4235
    if (not $use_gettext) {
134        *g_ = sub {
135
0
0
            return shift;
136
0
0
        };
137        *textdomain = sub {
138
0
0
            my $new_domain = shift;
139
0
0
            state $domain = $DEFAULT_TEXT_DOMAIN;
140
141
0
0
0
            $domain = $new_domain if defined $new_domain;
142
143
0
0
            return $domain;
144
0
0
        };
145        *gettext = sub {
146
0
0
            my $msgid = shift;
147
0
0
            return $msgid;
148
0
0
        };
149        *ngettext = sub {
150
0
0
            my ($msgid, $msgid_plural, $n) = @_;
151
0
0
0
            if ($n == 1) {
152
0
0
                return $msgid;
153            } else {
154
0
0
                return $msgid_plural;
155            }
156
0
0
        };
157        *C_ = sub {
158
0
0
            my ($msgctxt, $msgid) = @_;
159
0
0
            return $msgid;
160
0
0
        };
161        *P_ = sub {
162
0
0
            return ngettext(@_);
163
0
0
        };
164    } else {
165        *g_ = sub {
166
26574
26574
129535
            return dgettext($DEFAULT_TEXT_DOMAIN, shift);
167
2016
5056
        };
168        *C_ = sub {
169
0
0
0
            my ($msgctxt, $msgid) = @_;
170
0
0
            return dgettext($DEFAULT_TEXT_DOMAIN,
171                            $msgctxt . GETTEXT_CONTEXT_GLUE . $msgid);
172
2016
3677
        };
173        *P_ = sub {
174
3
3
81
            return dngettext($DEFAULT_TEXT_DOMAIN, @_);
175
2016
83858
        };
176    }
177}
178
179 - 187
=item $msgid = N_($msgid)

A pseudo function that servers as a marker for automated extraction of
messages, but does not call gettext(). The run-time translation is done
at a different place in the code.

=back

=cut
188
189sub N_
190{
191
4104
4104
1
2499
    my $msgid = shift;
192
4104
5079
    return $msgid;
193}
194
195 - 226
=head1 CHANGES

=head2 Version 2.01 (dpkg 1.21.10)

New function: gettext().

=head2 Version 2.00 (dpkg 1.20.0)

Remove function: _g().

=head2 Version 1.03 (dpkg 1.19.0)

New envvar: Add support for new B<DPKG_NLS> environment variable.

=head2 Version 1.02 (dpkg 1.18.3)

New function: N_().

=head2 Version 1.01 (dpkg 1.18.0)

Now the short aliases (g_ and P_) will call domain aware functions with
$DEFAULT_TEXT_DOMAIN.

New functions: g_(), C_().

Deprecated function: _g().

=head2 Version 1.00 (dpkg 1.15.6)

Mark the module as public.

=cut
227
2281;