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