Handle of new BLF_I18N_MSGID_MULTI_CTXT macro, which allows to define a same msgid...
[blender.git] / release / scripts / modules / bl_i18n_utils / settings.py
1 # ***** BEGIN GPL LICENSE BLOCK *****
2 #
3 # This program is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU General Public License
5 # as published by the Free Software Foundation; either version 2
6 # of the License, or (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software Foundation,
15 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ***** END GPL LICENSE BLOCK *****
18
19 # <pep8 compliant>
20
21 # Global settings used by all scripts in this dir.
22 # XXX Before any use of the tools in this dir, please make a copy of this file
23 #     named "setting.py"
24 # XXX This is a template, most values should be OK, but some you’ll have to
25 #     edit (most probably, BLENDER_EXEC and SOURCE_DIR).
26
27 import os.path
28
29
30 ###############################################################################
31 # MISC
32 ###############################################################################
33
34 # The languages defined in Blender.
35 LANGUAGES_CATEGORIES = (
36     # Min completeness level, UI english label.
37     ( 0.95, "Complete"),
38     ( 0.33, "In Progress"),
39     ( -1.0, "Starting"),
40 )
41 LANGUAGES = (
42     # ID, UI english label, ISO code.
43     ( 0, "Default (Default)", "DEFAULT"),
44     ( 1, "English (English)", "en_US"),
45     ( 2, "Japanese (日本語)", "ja_JP"),
46     ( 3, "Dutch (Nederlandse taal)", "nl_NL"),
47     ( 4, "Italian (Italiano)", "it_IT"),
48     ( 5, "German (Deutsch)", "de_DE"),
49     ( 6, "Finnish (Suomi)", "fi_FI"),
50     ( 7, "Swedish (Svenska)", "sv_SE"),
51     ( 8, "French (Français)", "fr_FR"),
52     ( 9, "Spanish (Español)", "es"),
53     (10, "Catalan (Català)", "ca_AD"),
54     (11, "Czech (Český)", "cs_CZ"),
55     (12, "Portuguese (Português)", "pt_PT"),
56     (13, "Simplified Chinese (简体中文)", "zh_CN"),
57     (14, "Traditional Chinese (繁體中文)", "zh_TW"),
58     (15, "Russian (Русский)", "ru_RU"),
59     (16, "Croatian (Hrvatski)", "hr_HR"),
60     (17, "Serbian (Српски)", "sr_RS"),
61     (18, "Ukrainian (Український)", "uk_UA"),
62     (19, "Polish (Polski)", "pl_PL"),
63     (20, "Romanian (Român)", "ro_RO"),
64     # Using the utf8 flipped form of Arabic (العربية).
65     (21, "Arabic (ﺔﻴﺑﺮﻌﻟﺍ)", "ar_EG"),
66     (22, "Bulgarian (Български)", "bg_BG"),
67     (23, "Greek (Ελληνικά)", "el_GR"),
68     (24, "Korean (한국 언어)", "ko_KR"),
69     (25, "Nepali (नेपाली)", "ne_NP"),
70     # Using the utf8 flipped form of Persian (فارسی).
71     (26, "Persian (ﯽﺳﺭﺎﻓ)", "fa_IR"),
72     (27, "Indonesian (Bahasa indonesia)", "id_ID"),
73     (28, "Serbian Latin (Srpski latinica)", "sr_RS@latin"),
74     (29, "Kyrgyz (Кыргыз тили)", "ky_KG"),
75     (30, "Turkish (Türkçe)", "tr_TR"),
76     (31, "Hungarian (Magyar)", "hu_HU"),
77     (32, "Brazilian Portuguese (Português do Brasil)", "pt_BR"),
78     # Using the utf8 flipped form of Hebrew (עִבְרִית)).
79     (33, "Hebrew (תירִבְעִ)", "he_IL"),
80     (34, "Estonian (Eestlane)", "et_EE"),
81     (35, "Esperanto (Esperanto)", "eo"),
82     (36, "Spanish from Spain (Español de España)", "es_ES"),
83 )
84
85 # Name of language file used by Blender to generate translations' menu.
86 LANGUAGES_FILE = "languages"
87
88 # The min level of completeness for a po file to be imported from /branches
89 # into /trunk, as a percentage. -1 means "import everything".
90 IMPORT_MIN_LEVEL = -1
91
92 # Languages in /branches we do not want to import in /trunk currently...
93 IMPORT_LANGUAGES_SKIP = {'bg', 'ca', 'fi', 'el', 'ko', 'ne', 'pl', 'ro'}
94
95 # The comment prefix used in generated messages.txt file.
96 COMMENT_PREFIX = "#~ "
97
98 # The comment prefix used to mark sources of msgids, in po's.
99 COMMENT_PREFIX_SOURCE = "#: "
100
101 # The comment prefix used in generated messages.txt file.
102 CONTEXT_PREFIX = "MSGCTXT:"
103
104 # Default context.
105 CONTEXT_DEFAULT = ""
106
107 # Undocumented operator placeholder string.
108 UNDOC_OPS_STR = "(undocumented operator)"
109
110 # The gettext domain.
111 DOMAIN = "blender"
112
113 # Our own "gettext" stuff.
114 # File type (ext) to parse.
115 PYGETTEXT_ALLOWED_EXTS = {".c", ".cpp", ".cxx", ".hpp", ".hxx", ".h"}
116
117 # Max number of contexts into a BLF_I18N_MSGID_MULTI_CTXT macro...
118 PYGETTEXT_MAX_MULTI_CTXT = 16
119
120 # Where to search contexts definitions, relative to SOURCE_DIR (defined below).
121 PYGETTEXT_CONTEXTS_DEFSRC = os.path.join("source", "blender", "blenfont",
122                                          "BLF_translation.h")
123
124 # Regex to extract contexts defined in BLF_translation.h
125 # XXX Not full-proof, but should be enough here!
126 PYGETTEXT_CONTEXTS = "#define\\s+(BLF_I18NCONTEXT_[A-Z_0-9]+)\\s+\"([^\"]*)\""
127
128 # Keywords' regex.
129 # XXX Most unfortunately, we can't use named backreferences inside character sets,
130 #     which makes the regexes even more twisty... :/
131 _str_base = (
132     # Match void string
133     "(?P<{_}1>[\"'])(?P={_}1)"  # Get opening quote (' or "), and closing immediately.
134     "|"
135     # Or match non-void string
136     "(?P<{_}2>[\"'])"  # Get opening quote (' or ").
137         "(?{capt}(?:"
138             # This one is for crazy things like "hi \\\\\" folks!"...
139             r"(?:(?!<\\)(?:\\\\)*\\(?=(?P={_}2)))|"
140             # The most common case.
141             ".(?!(?P={_}2))"
142         ")+.)"  # Don't forget the last char!
143     "(?P={_}2)"  # And closing quote.
144 )
145 str_clean_re = _str_base.format(_="g", capt="P<clean>")
146 # Here we have to consider two different cases (empty string and other).
147 _str_whole_re = (
148     _str_base.format(_="{_}1_", capt=":") +
149     # Optional loop start, this handles "split" strings...
150     "(?:(?<=[\"'])\\s*(?=[\"'])(?:"
151         + _str_base.format(_="{_}2_", capt=":") +
152     # End of loop.
153     "))*"
154 )
155 _ctxt_re_gen = lambda uid : r"(?P<ctxt_raw{uid}>(?:".format(uid=uid) + \
156                             _str_whole_re.format(_="_ctxt{uid}".format(uid=uid)) + \
157                             r")|(?:[A-Z_0-9]+))"
158 _ctxt_re = _ctxt_re_gen("")
159 _msg_re = r"(?P<msg_raw>" + _str_whole_re.format(_="_msg") + r")"
160 PYGETTEXT_KEYWORDS = (() +
161     tuple((r"{}\(\s*" + _msg_re + r"\s*\)").format(it)
162           for it in ("IFACE_", "TIP_", "N_")) +
163
164     tuple((r"{}\(\s*" + _ctxt_re + r"\s*,\s*" + _msg_re + r"\s*\)").format(it)
165           for it in ("CTX_IFACE_", "CTX_TIP_", "CTX_N_")) + 
166
167     tuple(("{}\\((?:[^\"',]+,){{1,2}}\\s*" + _msg_re + r"\s*(?:\)|,)").format(it)
168           for it in ("BKE_report", "BKE_reportf", "BKE_reports_prepend", "BKE_reports_prependf")) +
169
170     tuple(("{}\\((?:[^\"',]+,){{3}}\\s*" + _msg_re + r"\s*,").format(it)
171           for it in ("BMO_error_raise",)) +
172
173     tuple(("{}\\((?:[^\"',]+,)\\s*" + _msg_re + r"\s*(?:\)|,)").format(it)
174           for it in ("modifier_setError",)) +
175
176     tuple((r"{}\(\s*" + _msg_re + r"\s*,\s*(?:" + \
177            r"\s*,\s*)?(?:".join(_ctxt_re_gen(i) for i in range(PYGETTEXT_MAX_MULTI_CTXT)) + r")?\s*\)").format(it)
178           for it in ("BLF_I18N_MSGID_MULTI_CTXT",))
179 )
180
181 ESCAPE_RE = (
182     (r'((?<!\\)"|(?<!\\)\\(?!\\|"))', r"\\\1"),
183     ('\t', r"\\t"),
184 )
185
186 # Should po parser warn when finding a first letter not capitalized?
187 WARN_MSGID_NOT_CAPITALIZED = True
188
189 # Strings that should not raise above warning!
190 WARN_MSGID_NOT_CAPITALIZED_ALLOWED = {
191     "",  # Simplifies things... :p
192     "sin(x) / x",
193     "fBM",
194     "sqrt(x*x+y*y+z*z)",
195     "iTaSC",
196     "bItasc",
197     "px",
198     "mm",
199     "fStop",
200     "sRGB",
201     "iso-8859-15",
202     "utf-8",
203     "ascii",
204     "re",
205     "y",
206     "ac3",
207     "flac",
208     "mkv",
209     "mp2",
210     "mp3",
211     "ogg",
212     "wav",
213     "iTaSC parameters",
214     "vBVH",
215     "rv",
216     "et_EE",
217     "eo",
218     "available with",                # Is part of multi-line msg.
219     "virtual parents",               # Is part of multi-line msg.
220     "description",                   # Addons' field. :/
221     "location",                      # Addons' field. :/
222     "author",                        # Addons' field. :/
223     "in memory to enable editing!",  # Is part of multi-line msg.
224     "iScale",
225     "dx",
226     "p0",
227     "res",
228 }
229 WARN_MSGID_NOT_CAPITALIZED_ALLOWED |= set(lng[2] for lng in LANGUAGES)
230
231
232 ###############################################################################
233 # PATHS
234 ###############################################################################
235
236 # The tools path, should be OK.
237 TOOLS_DIR = os.path.join(os.path.dirname(__file__))
238
239 # The Python3 executable.You’ll likely have to edit it in your user_settings.py
240 # if you’re under Windows.
241 PYTHON3_EXEC = "python3"
242
243 # The Blender executable!
244 # This is just an example, you’ll most likely have to edit it in your user_settings.py!
245 BLENDER_EXEC = os.path.abspath(os.path.join(TOOLS_DIR, "..", "..", "..", "..", "blender"))
246
247 # The xgettext tool. You’ll likely have to edit it in your user_settings.py if you’re under Windows.
248 GETTEXT_XGETTEXT_EXECUTABLE = "xgettext"
249
250 # The gettext msgmerge tool. You’ll likely have to edit it in your user_settings.py if you’re under Windows.
251 GETTEXT_MSGMERGE_EXECUTABLE = "msgmerge"
252
253 # The gettext msgfmt "compiler". You’ll likely have to edit it in your user_settings.py if you’re under Windows.
254 GETTEXT_MSGFMT_EXECUTABLE = "msgfmt"
255
256 # The svn binary... You’ll likely have to edit it in your user_settings.py if you’re under Windows.
257 SVN_EXECUTABLE = "svn"
258
259 # The FriBidi C compiled library (.so under Linux, .dll under windows...).
260 # You’ll likely have to edit it in your user_settings.py if you’re under Windows., e.g. using the included one:
261 #     FRIBIDI_LIB = os.path.join(TOOLS_DIR, "libfribidi.dll")
262 FRIBIDI_LIB = "libfribidi.so.0"
263
264 # The name of the (currently empty) file that must be present in a po's directory to enable rtl-preprocess.
265 RTL_PREPROCESS_FILE = "is_rtl"
266
267 # The Blender source root path.
268 # This is just an example, you’ll most likely have to override it in your user_settings.py!
269 SOURCE_DIR = os.path.abspath(os.path.join(TOOLS_DIR, "..", "..", "..", "..", "..", "..", "blender_msgs"))
270
271 # The bf-translation repository (you'll likely have to override this in your user_settings.py).
272 I18N_DIR = os.path.abspath(os.path.join(TOOLS_DIR, "..", "..", "..", "..", "..", "..", "i18n"))
273
274 # The /branches path (overriden in bf-translation's i18n_override_settings.py).
275 BRANCHES_DIR = os.path.join(I18N_DIR, "branches")
276
277 # The /trunk path (overriden in bf-translation's i18n_override_settings.py).
278 TRUNK_DIR = os.path.join(I18N_DIR, "trunk")
279
280 # The /trunk/po path (overriden in bf-translation's i18n_override_settings.py).
281 TRUNK_PO_DIR = os.path.join(TRUNK_DIR, "po")
282
283 # The /trunk/mo path (overriden in bf-translation's i18n_override_settings.py).
284 TRUNK_MO_DIR = os.path.join(TRUNK_DIR, "locale")
285
286 # The file storing Blender-generated messages.
287 FILE_NAME_MESSAGES = os.path.join(TRUNK_PO_DIR, "messages.txt")
288
289 # The Blender source path to check for i18n macros.
290 POTFILES_SOURCE_DIR = os.path.join(SOURCE_DIR, "source")
291
292 # The "source" file storing which files should be processed by xgettext, used to create FILE_NAME_POTFILES
293 FILE_NAME_SRC_POTFILES = os.path.join(TRUNK_PO_DIR, "_POTFILES.in")
294
295 # The final (generated) file storing which files should be processed by xgettext.
296 FILE_NAME_POTFILES = os.path.join(TRUNK_PO_DIR, "POTFILES.in")
297
298 # The template messages file.
299 FILE_NAME_POT = os.path.join(TRUNK_PO_DIR, ".".join((DOMAIN, "pot")))
300
301 # Other py files that should be searched for ui strings, relative to SOURCE_DIR.
302 # Needed for Cycles, currently...
303 CUSTOM_PY_UI_FILES = [os.path.join("intern", "cycles", "blender", "addon", "ui.py"),]
304
305
306 # A cache storing validated msgids, to avoid re-spellchecking them.
307 SPELL_CACHE = os.path.join("/tmp", ".spell_cache")
308
309
310 # Custom override settings must be one dir above i18n tools itself!
311 import sys
312 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
313 try:
314     from bl_i18n_override_settings import *
315 except ImportError:  # If no i18n_override_settings available, it’s no error!
316     pass
317
318 # Override with custom user settings, if available.
319 try:
320     from user_settings import *
321 except ImportError:  # If no user_settings available, it’s no error!
322     pass