~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/i18n.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-10 17:52:08 UTC
  • mfrom: (5021 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5023.
  • Revision ID: john@arbash-meinel.com-20100210175208-bubuwav4uqigu291
Merge bzr.dev 5021 to resolve NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: utf-8 -*-
2
 
#
3
 
# Copyright (C) 2007 Lukáš Lalinský <lalinsky@gmail.com>
4
 
# Copyright (C) 2007,2009 Alexander Belchenko <bialix@ukr.net>
5
 
# Copyright (C) 2011 Canonical Ltd
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, write to the Free Software
19
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
 
 
21
 
# This module is copied from Bazaar Explorer and modified for bzr.
22
 
 
23
 
"""i18n and l10n support for Bazaar."""
24
 
 
25
 
import gettext as _gettext
26
 
import os
27
 
import sys
28
 
 
29
 
 
30
 
_translations = None
31
 
 
32
 
 
33
 
def gettext(message):
34
 
    """Translate message. 
35
 
    
36
 
    :returns: translated message as unicode.
37
 
    """
38
 
    install()
39
 
    return _translations.ugettext(message)
40
 
 
41
 
 
42
 
def ngettext(singular, plural, number):
43
 
    """Translate message with plural forms based on `number`.
44
 
 
45
 
    :param singular: English language message in singular form
46
 
    :param plural: English language message in plural form
47
 
    :param number: the number this message should be translated for
48
 
 
49
 
    :returns: translated message as unicode.
50
 
    """
51
 
    install()
52
 
    return _translations.ungettext(singular, plural, number)
53
 
 
54
 
 
55
 
def N_(msg):
56
 
    """Mark message for translation but don't translate it right away."""
57
 
    return msg
58
 
 
59
 
 
60
 
def gettext_per_paragraph(message):
61
 
    """Translate message per paragraph.
62
 
 
63
 
    :returns: concatenated translated message as unicode.
64
 
    """
65
 
    install()
66
 
    paragraphs = message.split(u'\n\n')
67
 
    ugettext = _translations.ugettext
68
 
    # Be careful not to translate the empty string -- it holds the
69
 
    # meta data of the .po file.
70
 
    return u'\n\n'.join(ugettext(p) if p else u'' for p in paragraphs)
71
 
 
72
 
 
73
 
def disable_i18n():
74
 
    """Do not allow i18n to be enabled.  Useful for third party users
75
 
    of bzrlib."""
76
 
    global _translations
77
 
    _translations = _gettext.NullTranslations()
78
 
 
79
 
 
80
 
def installed():
81
 
    """Returns whether translations are in use or not."""
82
 
    return _translations is not None
83
 
 
84
 
 
85
 
def install(lang=None):
86
 
    """Enables gettext translations in bzr."""
87
 
    global _translations
88
 
    if installed():
89
 
        return
90
 
    _translations = install_translations(lang)
91
 
 
92
 
 
93
 
def install_translations(lang=None, domain='bzr', locale_base=None):
94
 
    """Create a gettext translation object.
95
 
    
96
 
    :param lang: language to install.
97
 
    :param domain: translation domain to install.
98
 
    :param locale_base: plugins can specify their own directory.
99
 
 
100
 
    :returns: a gettext translations object to use
101
 
    """
102
 
    if lang is None:
103
 
        lang = _get_current_locale()
104
 
    if lang is not None:
105
 
        languages = lang.split(':')
106
 
    else:
107
 
        languages = None
108
 
    translation = _gettext.translation(
109
 
            domain,
110
 
            localedir=_get_locale_dir(locale_base),
111
 
            languages=languages,
112
 
            fallback=True)
113
 
    return translation
114
 
 
115
 
 
116
 
def add_fallback(fallback):
117
 
    """
118
 
    Add a fallback translations object.  Typically used by plugins.
119
 
 
120
 
    :param fallback: gettext.GNUTranslations object
121
 
    """
122
 
    install()
123
 
    _translations.add_fallback(fallback)
124
 
 
125
 
 
126
 
def uninstall():
127
 
    """Disables gettext translations."""
128
 
    global _translations
129
 
    _translations = None
130
 
 
131
 
 
132
 
def _get_locale_dir(base):
133
 
    """Returns directory to find .mo translations file in, either local or system
134
 
 
135
 
    :param base: plugins can specify their own local directory
136
 
    """
137
 
    if hasattr(sys, 'frozen'):
138
 
        if base is None:
139
 
            base = os.path.dirname(
140
 
                unicode(sys.executable, sys.getfilesystemencoding()))
141
 
        return os.path.join(base, u'locale')
142
 
    else:
143
 
        if base is None:
144
 
            base = os.path.dirname(unicode(__file__, sys.getfilesystemencoding()))
145
 
        dirpath = os.path.realpath(os.path.join(base, u'locale'))
146
 
        if os.path.exists(dirpath):
147
 
            return dirpath
148
 
        else:
149
 
            return '/usr/share/locale'
150
 
 
151
 
 
152
 
def _check_win32_locale():
153
 
    for i in ('LANGUAGE','LC_ALL','LC_MESSAGES','LANG'):
154
 
        if os.environ.get(i):
155
 
            break
156
 
    else:
157
 
        lang = None
158
 
        import locale
159
 
        try:
160
 
            import ctypes
161
 
        except ImportError:
162
 
            # use only user's default locale
163
 
            lang = locale.getdefaultlocale()[0]
164
 
        else:
165
 
            # using ctypes to determine all locales
166
 
            lcid_user = ctypes.windll.kernel32.GetUserDefaultLCID()
167
 
            lcid_system = ctypes.windll.kernel32.GetSystemDefaultLCID()
168
 
            if lcid_user != lcid_system:
169
 
                lcid = [lcid_user, lcid_system]
170
 
            else:
171
 
                lcid = [lcid_user]
172
 
            lang = [locale.windows_locale.get(i) for i in lcid]
173
 
            lang = ':'.join([i for i in lang if i])
174
 
        # set lang code for gettext
175
 
        if lang:
176
 
            os.environ['LANGUAGE'] = lang
177
 
 
178
 
 
179
 
def _get_current_locale():
180
 
    if not os.environ.get('LANGUAGE'):
181
 
        from bzrlib import config
182
 
        lang = config.GlobalStack().get('language')
183
 
        if lang:
184
 
            os.environ['LANGUAGE'] = lang
185
 
            return lang
186
 
    if sys.platform == 'win32':
187
 
        _check_win32_locale()
188
 
    for i in ('LANGUAGE','LC_ALL','LC_MESSAGES','LANG'):
189
 
        lang = os.environ.get(i)
190
 
        if lang:
191
 
            return lang
192
 
    return None
193
 
 
194
 
 
195
 
def load_plugin_translations(domain):
196
 
    """Load the translations for a specific plugin.
197
 
 
198
 
    :param domain: Gettext domain name (usually 'bzr-PLUGINNAME')
199
 
    """
200
 
    locale_base = os.path.dirname(
201
 
        unicode(__file__, sys.getfilesystemencoding()))
202
 
    translation = install_translations(domain=domain,
203
 
        locale_base=locale_base)
204
 
    add_fallback(translation)
205
 
    return translation