Fix i18n messages extraction script, and a few more UI messages...
[blender.git] / release / scripts / modules / bl_i18n_utils / bl_extract_messages.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 # Populate a template file (POT format currently) from Blender RNA/py/C data.
22 # XXX: This script is meant to be used from inside Blender!
23 #      You should not directly use this script, rather use update_msg.py!
24
25 import collections
26 import copy
27 import datetime
28 import os
29 import re
30 import sys
31
32 # XXX Relative import does not work here when used from Blender...
33 from bl_i18n_utils import settings as settings_i18n, utils
34
35 import bpy
36
37 ##### Utils #####
38
39 # check for strings like "+%f°"
40 ignore_reg = re.compile(r"^(?:[-*.()/\\+%°0-9]|%d|%f|%s|%r|\s)*$")
41 filter_message = ignore_reg.match
42
43
44 def init_spell_check(settings, lang="en_US"):
45     try:
46         from bl_i18n_utils import utils_spell_check
47         return utils_spell_check.SpellChecker(settings, lang)
48     except Exception as e:
49         print("Failed to import utils_spell_check ({})".format(str(e)))
50         return None
51
52
53 def _gen_check_ctxt(settings):
54     return {
55         "multi_rnatip": set(),
56         "multi_lines": set(),
57         "py_in_rna": set(),
58         "not_capitalized": set(),
59         "end_point": set(),
60         "undoc_ops": set(),
61         "spell_checker": init_spell_check(settings),
62         "spell_errors": {},
63     }
64
65
66 def _diff_check_ctxt(check_ctxt, minus_check_ctxt):
67     """Removes minus_check_ctxt from check_ctxt"""
68     for key in check_ctxt:
69         if isinstance(check_ctxt[key], set):
70             for warning in minus_check_ctxt[key]:
71                 if warning in check_ctxt[key]:
72                     check_ctxt[key].remove(warning)
73         elif isinstance(check_ctxt[key], dict):
74             for warning in minus_check_ctxt[key]:
75                 if warning in check_ctxt[key]:
76                     del check_ctxt[key][warning]
77
78
79 def _gen_reports(check_ctxt):
80     return {
81         "check_ctxt": check_ctxt,
82         "rna_structs": [],
83         "rna_structs_skipped": [],
84         "rna_props": [],
85         "rna_props_skipped": [],
86         "py_messages": [],
87         "py_messages_skipped": [],
88         "src_messages": [],
89         "src_messages_skipped": [],
90         "messages_skipped": set(),
91     }
92
93
94 def check(check_ctxt, msgs, key, msgsrc, settings):
95     """
96     Performs a set of checks over the given key (context, message)...
97     """
98     if check_ctxt is None:
99         return
100     multi_rnatip = check_ctxt.get("multi_rnatip")
101     multi_lines = check_ctxt.get("multi_lines")
102     py_in_rna = check_ctxt.get("py_in_rna")
103     not_capitalized = check_ctxt.get("not_capitalized")
104     end_point = check_ctxt.get("end_point")
105     undoc_ops = check_ctxt.get("undoc_ops")
106     spell_checker = check_ctxt.get("spell_checker")
107     spell_errors = check_ctxt.get("spell_errors")
108
109     if multi_rnatip is not None:
110         if key in msgs and key not in multi_rnatip:
111             multi_rnatip.add(key)
112     if multi_lines is not None:
113         if '\n' in key[1]:
114             multi_lines.add(key)
115     if py_in_rna is not None:
116         if key in py_in_rna[1]:
117             py_in_rna[0].add(key)
118     if not_capitalized is not None:
119         if(key[1] not in settings.WARN_MSGID_NOT_CAPITALIZED_ALLOWED and
120            key[1][0].isalpha() and not key[1][0].isupper()):
121             not_capitalized.add(key)
122     if end_point is not None:
123         if (key[1].strip().endswith('.') and not key[1].strip().endswith('...') and
124             key[1] not in settings.WARN_MSGID_END_POINT_ALLOWED):
125             end_point.add(key)
126     if undoc_ops is not None:
127         if key[1] == settings.UNDOC_OPS_STR:
128             undoc_ops.add(key)
129     if spell_checker is not None and spell_errors is not None:
130         err = spell_checker.check(key[1])
131         if err:
132             spell_errors[key] = err
133
134
135 def print_info(reports, pot):
136     def _print(*args, **kwargs):
137         kwargs["file"] = sys.stderr
138         print(*args, **kwargs)
139
140     pot.update_info()
141
142     _print("{} RNA structs were processed (among which {} were skipped), containing {} RNA properties "
143            "(among which {} were skipped).".format(len(reports["rna_structs"]), len(reports["rna_structs_skipped"]),
144                                                    len(reports["rna_props"]), len(reports["rna_props_skipped"])))
145     _print("{} messages were extracted from Python UI code (among which {} were skipped), and {} from C source code "
146            "(among which {} were skipped).".format(len(reports["py_messages"]), len(reports["py_messages_skipped"]),
147                                                    len(reports["src_messages"]), len(reports["src_messages_skipped"])))
148     _print("{} messages were rejected.".format(len(reports["messages_skipped"])))
149     _print("\n")
150     _print("Current POT stats:")
151     pot.print_info(prefix="\t", output=_print)
152     _print("\n")
153
154     check_ctxt = reports["check_ctxt"]
155     if check_ctxt is None:
156         return
157     multi_rnatip = check_ctxt.get("multi_rnatip")
158     multi_lines = check_ctxt.get("multi_lines")
159     py_in_rna = check_ctxt.get("py_in_rna")
160     not_capitalized = check_ctxt.get("not_capitalized")
161     end_point = check_ctxt.get("end_point")
162     undoc_ops = check_ctxt.get("undoc_ops")
163     spell_errors = check_ctxt.get("spell_errors")
164
165     # XXX Temp, no multi_rnatip nor py_in_rna, see below.
166     keys = multi_lines | not_capitalized | end_point | undoc_ops | spell_errors.keys()
167     if keys:
168         _print("WARNINGS:")
169         for key in keys:
170             if undoc_ops and key in undoc_ops:
171                 _print("\tThe following operators are undocumented!")
172             else:
173                 _print("\t“{}”|“{}”:".format(*key))
174                 if multi_lines and key in multi_lines:
175                     _print("\t\t-> newline in this message!")
176                 if not_capitalized and key in not_capitalized:
177                     _print("\t\t-> message not capitalized!")
178                 if end_point and key in end_point:
179                     _print("\t\t-> message with endpoint!")
180                 # XXX Hide this one for now, too much false positives.
181 #                if multi_rnatip and key in multi_rnatip:
182 #                    _print("\t\t-> tip used in several RNA items")
183 #                if py_in_rna and key in py_in_rna:
184 #                    _print("\t\t-> RNA message also used in py UI code!")
185                 if spell_errors and spell_errors.get(key):
186                     lines = ["\t\t-> {}: misspelled, suggestions are ({})".format(w, "'" + "', '".join(errs) + "'")
187                              for w, errs in  spell_errors[key]]
188                     _print("\n".join(lines))
189             _print("\t\t{}".format("\n\t\t".join(pot.msgs[key].sources)))
190
191
192 def process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt, settings):
193     if filter_message(msgid):
194         reports["messages_skipped"].add((msgid, msgsrc))
195         return
196     if not msgctxt:
197         # We do *not* want any "" context!
198         msgctxt = settings.DEFAULT_CONTEXT
199     # Always unescape keys!
200     msgctxt = utils.I18nMessage.do_unescape(msgctxt)
201     msgid = utils.I18nMessage.do_unescape(msgid)
202     key = (msgctxt, msgid)
203     check(check_ctxt, msgs, key, msgsrc, settings)
204     msgsrc = settings.PO_COMMENT_PREFIX_SOURCE_CUSTOM + msgsrc
205     if key not in msgs:
206         msgs[key] = utils.I18nMessage([msgctxt], [msgid], [], [msgsrc], settings=settings)
207     else:
208         msgs[key].comment_lines.append(msgsrc)
209
210
211 ##### RNA #####
212 def dump_rna_messages(msgs, reports, settings, verbose=False):
213     """
214     Dump into messages dict all RNA-defined UI messages (labels en tooltips).
215     """
216     def class_blacklist():
217         blacklist_rna_class = {getattr(bpy.types, cls_id) for cls_id in (
218                 # core classes
219                 "Context", "Event", "Function", "UILayout", "UnknownType", "Property", "Struct",
220                 # registerable classes
221                 "Panel", "Menu", "Header", "RenderEngine", "Operator", "OperatorMacro", "Macro", "KeyingSetInfo",
222                 # window classes
223                 "Window",
224             )
225         }
226
227         # More builtin classes we don't need to parse.
228         blacklist_rna_class |= {cls for cls in bpy.types.Property.__subclasses__()}
229
230         # None of this seems needed anymore, and it's broken anyway with current master (blender 2.79.1)...
231         """
232         _rna = {getattr(bpy.types, cls) for cls in dir(bpy.types)}
233
234         # Classes which are attached to collections can be skipped too, these are api access only.
235         # XXX This is not true, some of those show in UI, see e.g. tooltip of KeyingSets.active...
236         #~ for cls in _rna:
237             #~ for prop in cls.bl_rna.properties:
238                 #~ if prop.type == 'COLLECTION':
239                     #~ prop_cls = prop.srna
240                     #~ if prop_cls is not None:
241                         #~ blacklist_rna_class.add(prop_cls.__class__)
242
243         # Now here is the *ugly* hack!
244         # Unfortunately, all classes we want to access are not available from bpy.types (OperatorProperties subclasses
245         # are not here, as they have the same name as matching Operator ones :( ). So we use __subclasses__() calls
246         # to walk through all rna hierachy.
247         # But unregistered classes remain listed by relevant __subclasses__() calls (be it a Py or BPY/RNA bug),
248         # and obviously the matching RNA struct exists no more, so trying to access their data (even the identifier)
249         # quickly leads to segfault!
250         # To address this, we have to blacklist classes which __name__ does not match any __name__ from bpy.types
251         # (we can't use only RNA identifiers, as some py-defined classes has a different name that rna id,
252         # and we can't use class object themselves, because OperatorProperties subclasses are not in bpy.types!)...
253
254         _rna_clss_ids = {cls.__name__ for cls in _rna} | {cls.bl_rna.identifier for cls in _rna}
255
256         # All registrable types.
257         blacklist_rna_class |= {cls for cls in bpy.types.OperatorProperties.__subclasses__() +
258                                                bpy.types.Operator.__subclasses__() +
259                                                bpy.types.OperatorMacro.__subclasses__() +
260                                                bpy.types.Header.__subclasses__() +
261                                                bpy.types.Panel.__subclasses__() +
262                                                bpy.types.Menu.__subclasses__() +
263                                                bpy.types.UIList.__subclasses__()
264                                     if cls.__name__ not in _rna_clss_ids}
265
266         # Collect internal operators
267         # extend with all internal operators
268         # note that this uses internal api introspection functions
269         # XXX Do not skip INTERNAL's anymore, some of those ops show up in UI now!
270         # all possible operator names
271         #op_ids = (set(cls.bl_rna.identifier for cls in bpy.types.OperatorProperties.__subclasses__()) |
272         #          set(cls.bl_rna.identifier for cls in bpy.types.Operator.__subclasses__()) |
273         #          set(cls.bl_rna.identifier for cls in bpy.types.OperatorMacro.__subclasses__()))
274
275         #get_instance = __import__("_bpy").ops.get_instance
276         #path_resolve = type(bpy.context).__base__.path_resolve
277         #for idname in op_ids:
278             #op = get_instance(idname)
279             #if 'INTERNAL' in path_resolve(op, "bl_options"):
280                 #blacklist_rna_class.add(idname)
281         """
282
283         return blacklist_rna_class
284
285     check_ctxt_rna = check_ctxt_rna_tip = None
286     check_ctxt = reports["check_ctxt"]
287     if check_ctxt:
288         check_ctxt_rna = {
289             "multi_lines": check_ctxt.get("multi_lines"),
290             "not_capitalized": check_ctxt.get("not_capitalized"),
291             "end_point": check_ctxt.get("end_point"),
292             "undoc_ops": check_ctxt.get("undoc_ops"),
293             "spell_checker": check_ctxt.get("spell_checker"),
294             "spell_errors": check_ctxt.get("spell_errors"),
295         }
296         check_ctxt_rna_tip = check_ctxt_rna
297         check_ctxt_rna_tip["multi_rnatip"] = check_ctxt.get("multi_rnatip")
298
299     default_context = settings.DEFAULT_CONTEXT
300
301     # Function definitions
302     def walk_properties(cls):
303         bl_rna = cls.bl_rna
304         # Get our parents' properties, to not export them multiple times.
305         bl_rna_base = bl_rna.base
306         if bl_rna_base:
307             bl_rna_base_props = set(bl_rna_base.properties.values())
308         else:
309             bl_rna_base_props = set()
310
311         props = sorted(bl_rna.properties, key=lambda p: p.identifier)
312         for prop in props:
313             # Only write this property if our parent hasn't got it.
314             if prop in bl_rna_base_props:
315                 continue
316             if prop.identifier == "rna_type":
317                 continue
318             reports["rna_props"].append((cls, prop))
319
320             msgsrc = "bpy.types.{}.{}".format(bl_rna.identifier, prop.identifier)
321             msgctxt = prop.translation_context or default_context
322
323             if prop.name and (prop.name != prop.identifier or msgctxt != default_context):
324                 process_msg(msgs, msgctxt, prop.name, msgsrc, reports, check_ctxt_rna, settings)
325             if prop.description:
326                 process_msg(msgs, default_context, prop.description, msgsrc, reports, check_ctxt_rna_tip, settings)
327
328             if isinstance(prop, bpy.types.EnumProperty):
329                 done_items = set()
330                 for item in prop.enum_items:
331                     msgsrc = "bpy.types.{}.{}:'{}'".format(bl_rna.identifier, prop.identifier, item.identifier)
332                     done_items.add(item.identifier)
333                     if item.name and item.name != item.identifier:
334                         process_msg(msgs, msgctxt, item.name, msgsrc, reports, check_ctxt_rna, settings)
335                     if item.description:
336                         process_msg(msgs, default_context, item.description, msgsrc, reports, check_ctxt_rna_tip,
337                                     settings)
338                 for item in prop.enum_items_static:
339                     if item.identifier in done_items:
340                         continue
341                     msgsrc = "bpy.types.{}.{}:'{}'".format(bl_rna.identifier, prop.identifier, item.identifier)
342                     done_items.add(item.identifier)
343                     if item.name and item.name != item.identifier:
344                         process_msg(msgs, msgctxt, item.name, msgsrc, reports, check_ctxt_rna, settings)
345                     if item.description:
346                         process_msg(msgs, default_context, item.description, msgsrc, reports, check_ctxt_rna_tip,
347                                     settings)
348
349     blacklist_rna_class = class_blacklist()
350
351     def walk_class(cls):
352         bl_rna = cls.bl_rna
353         msgsrc = "bpy.types." + bl_rna.identifier
354         msgctxt = bl_rna.translation_context or default_context
355
356         if bl_rna.name and (bl_rna.name != bl_rna.identifier or msgctxt != default_context):
357             process_msg(msgs, msgctxt, bl_rna.name, msgsrc, reports, check_ctxt_rna, settings)
358
359         if bl_rna.description:
360             process_msg(msgs, default_context, bl_rna.description, msgsrc, reports, check_ctxt_rna_tip, settings)
361         elif cls.__doc__:  # XXX Some classes (like KeyingSetInfo subclasses) have void description... :(
362             process_msg(msgs, default_context, cls.__doc__, msgsrc, reports, check_ctxt_rna_tip, settings)
363
364         # Panels' "tabs" system.
365         if hasattr(bl_rna, 'bl_category') and bl_rna.bl_category:
366             process_msg(msgs, default_context, bl_rna.bl_category, msgsrc, reports, check_ctxt_rna, settings)
367
368         if hasattr(bl_rna, 'bl_label') and bl_rna.bl_label:
369             process_msg(msgs, msgctxt, bl_rna.bl_label, msgsrc, reports, check_ctxt_rna, settings)
370
371         walk_properties(cls)
372
373     def walk_keymap_hierarchy(hier, msgsrc_prev):
374         km_i18n_context = bpy.app.translations.contexts.id_windowmanager
375         for lvl in hier:
376             msgsrc = msgsrc_prev + "." + lvl[1]
377             process_msg(msgs, km_i18n_context, lvl[0], msgsrc, reports, None, settings)
378             if lvl[3]:
379                 walk_keymap_hierarchy(lvl[3], msgsrc)
380
381     # Dump Messages
382     operator_categories = {}
383     def process_cls_list(cls_list):
384         if not cls_list:
385             return
386
387         def full_class_id(cls):
388             """Gives us 'ID.Lamp.AreaLamp' which is best for sorting."""
389             # Always the same issue, some classes listed in blacklist should actually no more exist (they have been
390             # unregistered), but are still listed by __subclasses__() calls... :/
391             if cls in blacklist_rna_class:
392                 return cls.__name__
393             cls_id = ""
394             bl_rna = cls.bl_rna
395             while bl_rna:
396                 cls_id = bl_rna.identifier + "." + cls_id
397                 bl_rna = bl_rna.base
398             return cls_id
399
400         def operator_category(cls):
401             """Extract operators' categories, as displayed in 'search' space menu."""
402             # NOTE: keep in sync with C code in ui_searchbox_region_draw_cb__operator().
403             if issubclass(cls, bpy.types.OperatorProperties) and "_OT_" in cls.__name__:
404                 cat_id = cls.__name__.split("_OT_")[0]
405                 if cat_id not in operator_categories:
406                     cat_str = cat_id.capitalize() + ":"
407                     operator_categories[cat_id] = cat_str
408
409         if verbose:
410             print(cls_list)
411         cls_list.sort(key=full_class_id)
412         for cls in cls_list:
413             if verbose:
414                 print(cls)
415             reports["rna_structs"].append(cls)
416             # Ignore those Operator sub-classes (anyway, will get the same from OperatorProperties sub-classes!)...
417             if (cls in blacklist_rna_class) or issubclass(cls, bpy.types.Operator):
418                 reports["rna_structs_skipped"].append(cls)
419             else:
420                 operator_category(cls)
421                 walk_class(cls)
422             # Recursively process subclasses.
423             process_cls_list(cls.__subclasses__())
424
425     # Parse everything (recursively parsing from bpy_struct "class"...).
426     process_cls_list(bpy.types.ID.__base__.__subclasses__())
427
428     # Finalize generated 'operator categories' messages.
429     for cat_str in operator_categories.values():
430         process_msg(msgs, bpy.app.translations.contexts.operator_default, cat_str, "Generated operator category",
431                     reports, check_ctxt_rna, settings)
432
433     # And parse keymaps!
434     from bpy_extras.keyconfig_utils import KM_HIERARCHY
435     walk_keymap_hierarchy(KM_HIERARCHY, "KM_HIERARCHY")
436
437
438 ##### Python source code #####
439 def dump_py_messages_from_files(msgs, reports, files, settings):
440     """
441     Dump text inlined in the python files given, e.g. 'My Name' in:
442         layout.prop("someprop", text="My Name")
443     """
444     import ast
445
446     bpy_struct = bpy.types.ID.__base__
447     i18n_contexts = bpy.app.translations.contexts
448
449     root_paths = tuple(bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM'))
450     def make_rel(path):
451         for rp in root_paths:
452             if path.startswith(rp):
453                 try:  # can't always find the relative path (between drive letters on windows)
454                     return os.path.relpath(path, rp)
455                 except ValueError:
456                     return path
457         # Use binary's dir as fallback...
458         try:  # can't always find the relative path (between drive letters on windows)
459             return os.path.relpath(path, os.path.dirname(bpy.app.binary_path))
460         except ValueError:
461             return path
462
463     # Helper function
464     def extract_strings_ex(node, is_split=False):
465         """
466         Recursively get strings, needed in case we have "Blah" + "Blah", passed as an argument in that case it won't
467         evaluate to a string. However, break on some kind of stopper nodes, like e.g. Subscript.
468         """
469         if type(node) == ast.Str:
470             eval_str = ast.literal_eval(node)
471             if eval_str:
472                 yield (is_split, eval_str, (node,))
473         else:
474             is_split = (type(node) in separate_nodes)
475             for nd in ast.iter_child_nodes(node):
476                 if type(nd) not in stopper_nodes:
477                     yield from extract_strings_ex(nd, is_split=is_split)
478
479     def _extract_string_merge(estr_ls, nds_ls):
480         return "".join(s for s in estr_ls if s is not None), tuple(n for n in nds_ls if n is not None)
481
482     def extract_strings(node):
483         estr_ls = []
484         nds_ls = []
485         for is_split, estr, nds in extract_strings_ex(node):
486             estr_ls.append(estr)
487             nds_ls.extend(nds)
488         ret = _extract_string_merge(estr_ls, nds_ls)
489         return ret
490
491     def extract_strings_split(node):
492         """
493         Returns a list args as returned by 'extract_strings()', but split into groups based on separate_nodes, this way
494         expressions like ("A" if test else "B") wont be merged but "A" + "B" will.
495         """
496         estr_ls = []
497         nds_ls = []
498         bag = []
499         for is_split, estr, nds in extract_strings_ex(node):
500             if is_split:
501                 bag.append((estr_ls, nds_ls))
502                 estr_ls = []
503                 nds_ls = []
504
505             estr_ls.append(estr)
506             nds_ls.extend(nds)
507
508         bag.append((estr_ls, nds_ls))
509
510         return [_extract_string_merge(estr_ls, nds_ls) for estr_ls, nds_ls in bag]
511
512     i18n_ctxt_ids = {v for v in bpy.app.translations.contexts_C_to_py.values()}
513     def _ctxt_to_ctxt(node):
514         # We must try, to some extend, to get contexts from vars instead of only literal strings...
515         ctxt = extract_strings(node)[0]
516         if ctxt:
517             return ctxt
518         # Basically, we search for attributes matching py context names, for now.
519         # So non-literal contexts should be used that way:
520         #     i18n_ctxt = bpy.app.translations.contexts
521         #     foobar(text="Foo", text_ctxt=i18n_ctxt.id_object)
522         if type(node) == ast.Attribute:
523             if node.attr in i18n_ctxt_ids:
524                 #print(node, node.attr, getattr(i18n_contexts, node.attr))
525                 return getattr(i18n_contexts, node.attr)
526         return i18n_contexts.default
527
528     def _op_to_ctxt(node):
529         # Some smart coders like things like:
530         #    >>> row.operator("wm.addon_disable" if is_enabled else "wm.addon_enable", ...)
531         # We only take first arg into account here!
532         bag = extract_strings_split(node)
533         opname, _ = bag[0]
534         if not opname:
535             return i18n_contexts.default
536         op = bpy.ops
537         for n in opname.split('.'):
538             op = getattr(op, n)
539         try:
540             return op.get_rna().bl_rna.translation_context
541         except Exception as e:
542             default_op_context = i18n_contexts.operator_default
543             print("ERROR: ", str(e))
544             print("       Assuming default operator context '{}'".format(default_op_context))
545             return default_op_context
546
547     # Gather function names.
548     # In addition of UI func, also parse pgettext ones...
549     # Tuples of (module name, (short names, ...)).
550     pgettext_variants = (
551         ("pgettext", ("_",)),
552         ("pgettext_iface", ("iface_",)),
553         ("pgettext_tip", ("tip_",)),
554         ("pgettext_data", ("data_",)),
555     )
556     pgettext_variants_args = {"msgid": (0, {"msgctxt": 1})}
557
558     # key: msgid keywords.
559     # val: tuples of ((keywords,), context_getter_func) to get a context for that msgid.
560     #      Note: order is important, first one wins!
561     translate_kw = {
562         "text": ((("text_ctxt",), _ctxt_to_ctxt),
563                  (("operator",), _op_to_ctxt),
564                 ),
565         "msgid": ((("msgctxt",), _ctxt_to_ctxt),
566                  ),
567         "message": (),
568     }
569
570     context_kw_set = {}
571     for k, ctxts in translate_kw.items():
572         s = set()
573         for c, _ in ctxts:
574             s |= set(c)
575         context_kw_set[k] = s
576
577     # {func_id: {msgid: (arg_pos,
578     #                    {msgctxt: arg_pos,
579     #                     ...
580     #                    }
581     #                   ),
582     #            ...
583     #           },
584     #  ...
585     # }
586     func_translate_args = {}
587
588     # First, functions from UILayout
589     # First loop is for msgid args, second one is for msgctxt args.
590     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
591         # check it has one or more arguments as defined in translate_kw
592         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
593             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
594                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
595     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
596         if func_id not in func_translate_args:
597             continue
598         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
599             if (not arg.is_output) and (arg.type == 'STRING'):
600                 for msgid, msgctxts in context_kw_set.items():
601                     if arg_kw in msgctxts:
602                         func_translate_args[func_id][msgid][1][arg_kw] = arg_pos
603     # The report() func of operators.
604     for func_id, func in bpy.types.Operator.bl_rna.functions.items():
605         # check it has one or more arguments as defined in translate_kw
606         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
607             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
608                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
609     # We manually add funcs from bpy.app.translations
610     for func_id, func_ids in pgettext_variants:
611         func_translate_args[func_id] = pgettext_variants_args
612         for func_id in func_ids:
613             func_translate_args[func_id] = pgettext_variants_args
614     #print(func_translate_args)
615
616     # Break recursive nodes look up on some kind of nodes.
617     # E.g. we don't want to get strings inside subscripts (blah["foo"])!
618     #      we don't want to get strings from comparisons (foo.type == 'BAR').
619     stopper_nodes = {ast.Subscript, ast.Compare}
620     # Consider strings separate: ("a" if test else "b")
621     separate_nodes = {ast.IfExp}
622
623     check_ctxt_py = None
624     if reports["check_ctxt"]:
625         check_ctxt = reports["check_ctxt"]
626         check_ctxt_py = {
627             "py_in_rna": (check_ctxt.get("py_in_rna"), set(msgs.keys())),
628             "multi_lines": check_ctxt.get("multi_lines"),
629             "not_capitalized": check_ctxt.get("not_capitalized"),
630             "end_point": check_ctxt.get("end_point"),
631             "spell_checker": check_ctxt.get("spell_checker"),
632             "spell_errors": check_ctxt.get("spell_errors"),
633         }
634
635     for fp in files:
636         with open(fp, 'r', encoding="utf8") as filedata:
637             root_node = ast.parse(filedata.read(), fp, 'exec')
638
639         fp_rel = make_rel(fp)
640
641         for node in ast.walk(root_node):
642             if type(node) == ast.Call:
643                 # print("found function at")
644                 # print("%s:%d" % (fp, node.lineno))
645
646                 # We can't skip such situations! from blah import foo\nfoo("bar") would also be an ast.Name func!
647                 if type(node.func) == ast.Name:
648                     func_id = node.func.id
649                 elif hasattr(node.func, "attr"):
650                     func_id = node.func.attr
651                 # Ugly things like getattr(self, con.type)(context, box, con)
652                 else:
653                     continue
654
655                 func_args = func_translate_args.get(func_id, {})
656
657                 # First try to get i18n contexts, for every possible msgid id.
658                 msgctxts = dict.fromkeys(func_args.keys(), "")
659                 for msgid, (_, context_args) in func_args.items():
660                     context_elements = {}
661                     for arg_kw, arg_pos in context_args.items():
662                         if arg_pos < len(node.args):
663                             context_elements[arg_kw] = node.args[arg_pos]
664                         else:
665                             for kw in node.keywords:
666                                 if kw.arg == arg_kw:
667                                     context_elements[arg_kw] = kw.value
668                                     break
669                     #print(context_elements)
670                     for kws, proc in translate_kw[msgid]:
671                         if set(kws) <= context_elements.keys():
672                             args = tuple(context_elements[k] for k in kws)
673                             #print("running ", proc, " with ", args)
674                             ctxt = proc(*args)
675                             if ctxt:
676                                 msgctxts[msgid] = ctxt
677                                 break
678
679                 #print(translate_args)
680                 # do nothing if not found
681                 for arg_kw, (arg_pos, _) in func_args.items():
682                     msgctxt = msgctxts[arg_kw]
683                     estr_lst = [(None, ())]
684                     if arg_pos < len(node.args):
685                         estr_lst = extract_strings_split(node.args[arg_pos])
686                         #print(estr, nds)
687                     else:
688                         for kw in node.keywords:
689                             if kw.arg == arg_kw:
690                                 estr_lst = extract_strings_split(kw.value)
691                                 break
692                         #print(estr, nds)
693                     for estr, nds in estr_lst:
694                         if estr:
695                             if nds:
696                                 msgsrc = "{}:{}".format(fp_rel, sorted({nd.lineno for nd in nds})[0])
697                             else:
698                                 msgsrc = "{}:???".format(fp_rel)
699                             process_msg(msgs, msgctxt, estr, msgsrc, reports, check_ctxt_py, settings)
700                             reports["py_messages"].append((msgctxt, estr, msgsrc))
701
702
703 def dump_py_messages(msgs, reports, addons, settings, addons_only=False):
704     def _get_files(path):
705         if not os.path.exists(path):
706             return []
707         if os.path.isdir(path):
708             return [os.path.join(dpath, fn) for dpath, _, fnames in os.walk(path) for fn in fnames
709                                             if not fn.startswith("_") and fn.endswith(".py")]
710         return [path]
711
712     files = []
713     if not addons_only:
714         for path in settings.CUSTOM_PY_UI_FILES:
715             for root in (bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM')):
716                 files += _get_files(os.path.join(root, path))
717
718     # Add all given addons.
719     for mod in addons:
720         fn = mod.__file__
721         if os.path.basename(fn) == "__init__.py":
722             files += _get_files(os.path.dirname(fn))
723         else:
724             files.append(fn)
725
726     dump_py_messages_from_files(msgs, reports, sorted(files), settings)
727
728
729 ##### C source code #####
730 def dump_src_messages(msgs, reports, settings):
731     def get_contexts():
732         """Return a mapping {C_CTXT_NAME: ctxt_value}."""
733         return {k: getattr(bpy.app.translations.contexts, n) for k, n in bpy.app.translations.contexts_C_to_py.items()}
734
735     contexts = get_contexts()
736
737     # Build regexes to extract messages (with optional contexts) from C source.
738     pygettexts = tuple(re.compile(r).search for r in settings.PYGETTEXT_KEYWORDS)
739
740     _clean_str = re.compile(settings.str_clean_re).finditer
741     clean_str = lambda s: "".join(m.group("clean") for m in _clean_str(s))
742
743     def dump_src_file(path, rel_path, msgs, reports, settings):
744         def process_entry(_msgctxt, _msgid):
745             # Context.
746             msgctxt = settings.DEFAULT_CONTEXT
747             if _msgctxt:
748                 if _msgctxt in contexts:
749                     msgctxt = contexts[_msgctxt]
750                 elif '"' in _msgctxt or "'" in _msgctxt:
751                     msgctxt = clean_str(_msgctxt)
752                 else:
753                     print("WARNING: raw context “{}” couldn’t be resolved!".format(_msgctxt))
754             # Message.
755             msgid = ""
756             if _msgid:
757                 if '"' in _msgid or "'" in _msgid:
758                     msgid = clean_str(_msgid)
759                 else:
760                     print("WARNING: raw message “{}” couldn’t be resolved!".format(_msgid))
761             return msgctxt, msgid
762
763         check_ctxt_src = None
764         if reports["check_ctxt"]:
765             check_ctxt = reports["check_ctxt"]
766             check_ctxt_src = {
767                 "multi_lines": check_ctxt.get("multi_lines"),
768                 "not_capitalized": check_ctxt.get("not_capitalized"),
769                 "end_point": check_ctxt.get("end_point"),
770                 "spell_checker": check_ctxt.get("spell_checker"),
771                 "spell_errors": check_ctxt.get("spell_errors"),
772             }
773
774         data = ""
775         with open(path) as f:
776             data = f.read()
777         for srch in pygettexts:
778             m = srch(data)
779             line = pos = 0
780             while m:
781                 d = m.groupdict()
782                 # Line.
783                 line += data[pos:m.start()].count('\n')
784                 msgsrc = rel_path + ":" + str(line)
785                 _msgid = d.get("msg_raw")
786                 # First, try the "multi-contexts" stuff!
787                 _msgctxts = tuple(d.get("ctxt_raw{}".format(i)) for i in range(settings.PYGETTEXT_MAX_MULTI_CTXT))
788                 if _msgctxts[0]:
789                     for _msgctxt in _msgctxts:
790                         if not _msgctxt:
791                             break
792                         msgctxt, msgid = process_entry(_msgctxt, _msgid)
793                         process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
794                         reports["src_messages"].append((msgctxt, msgid, msgsrc))
795                 else:
796                     _msgctxt = d.get("ctxt_raw")
797                     msgctxt, msgid = process_entry(_msgctxt, _msgid)
798                     process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
799                     reports["src_messages"].append((msgctxt, msgid, msgsrc))
800
801                 pos = m.end()
802                 line += data[m.start():pos].count('\n')
803                 m = srch(data, pos)
804
805     forbidden = set()
806     forced = set()
807     if os.path.isfile(settings.SRC_POTFILES):
808         with open(settings.SRC_POTFILES) as src:
809             for l in src:
810                 if l[0] == '-':
811                     forbidden.add(l[1:].rstrip('\n'))
812                 elif l[0] != '#':
813                     forced.add(l.rstrip('\n'))
814     for root, dirs, files in os.walk(settings.POTFILES_SOURCE_DIR):
815         if "/.svn" in root:
816             continue
817         for fname in files:
818             if os.path.splitext(fname)[1] not in settings.PYGETTEXT_ALLOWED_EXTS:
819                 continue
820             path = os.path.join(root, fname)
821             try:  # can't always find the relative path (between drive letters on windows)
822                 rel_path = os.path.relpath(path, settings.SOURCE_DIR)
823             except ValueError:
824                 rel_path = path
825             if rel_path in forbidden:
826                 continue
827             elif rel_path not in forced:
828                 forced.add(rel_path)
829     for rel_path in sorted(forced):
830         path = os.path.join(settings.SOURCE_DIR, rel_path)
831         if os.path.exists(path):
832             dump_src_file(path, rel_path, msgs, reports, settings)
833
834
835 ##### Main functions! #####
836 def dump_messages(do_messages, do_checks, settings):
837     bl_ver = "Blender " + bpy.app.version_string
838     bl_hash = bpy.app.build_hash
839     bl_date = datetime.datetime.strptime(bpy.app.build_date.decode() + "T" + bpy.app.build_time.decode(),
840                                          "%Y-%m-%dT%H:%M:%S")
841     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, bl_ver, bl_hash, bl_date, bl_date.year,
842                                                 settings=settings)
843     msgs = pot.msgs
844
845     # Enable all wanted addons.
846     # For now, enable all official addons, before extracting msgids.
847     addons = utils.enable_addons(support={"OFFICIAL"})
848     # Note this is not needed if we have been started with factory settings, but just in case...
849     utils.enable_addons(support={"COMMUNITY", "TESTING"}, disable=True)
850
851     reports = _gen_reports(_gen_check_ctxt(settings) if do_checks else None)
852
853     # Get strings from RNA.
854     dump_rna_messages(msgs, reports, settings)
855
856     # Get strings from UI layout definitions text="..." args.
857     dump_py_messages(msgs, reports, addons, settings)
858
859     # Get strings from C source code.
860     dump_src_messages(msgs, reports, settings)
861
862     # Get strings from addons' categories.
863     for uid, label, tip in bpy.types.WindowManager.addon_filter[1]['items'](bpy.context.window_manager, bpy.context):
864         process_msg(msgs, settings.DEFAULT_CONTEXT, label, "Add-ons' categories", reports, None, settings)
865         if tip:
866             process_msg(msgs, settings.DEFAULT_CONTEXT, tip, "Add-ons' categories", reports, None, settings)
867
868     # Get strings specific to translations' menu.
869     for lng in settings.LANGUAGES:
870         process_msg(msgs, settings.DEFAULT_CONTEXT, lng[1], "Languages’ labels from bl_i18n_utils/settings.py",
871                     reports, None, settings)
872     for cat in settings.LANGUAGES_CATEGORIES:
873         process_msg(msgs, settings.DEFAULT_CONTEXT, cat[1],
874                     "Language categories’ labels from bl_i18n_utils/settings.py", reports, None, settings)
875
876     #pot.check()
877     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
878     print_info(reports, pot)
879     #pot.check()
880
881     if do_messages:
882         print("Writing messages…")
883         pot.write('PO', settings.FILE_NAME_POT)
884
885     print("Finished extracting UI messages!")
886
887     return pot  # Not used currently, but may be useful later (and to be consistent with dump_addon_messages!).
888
889
890 def dump_addon_messages(module_name, do_checks, settings):
891     import addon_utils
892
893     # Get current addon state (loaded or not):
894     was_loaded = addon_utils.check(module_name)[1]
895
896     # Enable our addon.
897     addon = utils.enable_addons(addons={module_name})[0]
898
899     addon_info = addon_utils.module_bl_info(addon)
900     ver = addon_info["name"] + " " + ".".join(str(v) for v in addon_info["version"])
901     rev = 0
902     date = datetime.datetime.now()
903     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
904                                                 settings=settings)
905     msgs = pot.msgs
906
907     minus_pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
908                                                       settings=settings)
909     minus_msgs = minus_pot.msgs
910
911     check_ctxt = _gen_check_ctxt(settings) if do_checks else None
912     minus_check_ctxt = _gen_check_ctxt(settings) if do_checks else None
913
914     # Get strings from RNA, our addon being enabled.
915     print("A")
916     reports = _gen_reports(check_ctxt)
917     print("B")
918     dump_rna_messages(msgs, reports, settings)
919     print("C")
920
921     # Now disable our addon, and rescan RNA.
922     utils.enable_addons(addons={module_name}, disable=True)
923     print("D")
924     reports["check_ctxt"] = minus_check_ctxt
925     print("E")
926     dump_rna_messages(minus_msgs, reports, settings)
927     print("F")
928
929     # Restore previous state if needed!
930     if was_loaded:
931         utils.enable_addons(addons={module_name})
932
933     # and make the diff!
934     for key in minus_msgs:
935         if key != settings.PO_HEADER_KEY:
936             del msgs[key]
937
938     if check_ctxt:
939         _diff_check_ctxt(check_ctxt, minus_check_ctxt)
940
941     # and we are done with those!
942     del minus_pot
943     del minus_msgs
944     del minus_check_ctxt
945
946     # get strings from UI layout definitions text="..." args
947     reports["check_ctxt"] = check_ctxt
948     dump_py_messages(msgs, reports, {addon}, settings, addons_only=True)
949
950     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
951     print_info(reports, pot)
952
953     print("Finished extracting UI messages!")
954
955     return pot
956
957
958 def main():
959     try:
960         import bpy
961     except ImportError:
962         print("This script must run from inside blender")
963         return
964
965     import sys
966     import argparse
967
968     # Get rid of Blender args!
969     argv = sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else []
970
971     parser = argparse.ArgumentParser(description="Process UI messages from inside Blender.")
972     parser.add_argument('-c', '--no_checks', default=True, action="store_false", help="No checks over UI messages.")
973     parser.add_argument('-m', '--no_messages', default=True, action="store_false", help="No export of UI messages.")
974     parser.add_argument('-o', '--output', default=None, help="Output POT file path.")
975     parser.add_argument('-s', '--settings', default=None,
976                         help="Override (some) default settings. Either a JSon file name, or a JSon string.")
977     args = parser.parse_args(argv)
978
979     settings = settings_i18n.I18nSettings()
980     settings.from_json(args.settings)
981
982     if args.output:
983         settings.FILE_NAME_POT = args.output
984
985     dump_messages(do_messages=args.no_messages, do_checks=args.no_checks, settings=settings)
986
987
988 if __name__ == "__main__":
989     print("\n\n *** Running {} *** \n".format(__file__))
990     main()