Added Macro and KeyingSetInfo to blacklisted msg classes. Also updated french po...
[blender.git] / po / update_msg.py
1 # $Id$
2 # ***** BEGIN GPL LICENSE BLOCK *****
3 #
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
8 #
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software Foundation,
16 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 #
18 # ***** END GPL LICENSE BLOCK *****
19
20 # <pep8-80 compliant>
21
22 # Write out messages.txt from blender
23
24 # Execite:
25 #   blender --background --python po/update_msg.py
26
27 import os
28
29 CURRENT_DIR = os.path.abspath(os.path.dirname(__file__))
30 SOURCE_DIR = os.path.normpath(os.path.abspath(os.path.join(CURRENT_DIR, "..")))
31
32 FILE_NAME_MESSAGES = os.path.join(CURRENT_DIR, "messages.txt")
33 COMMENT_PREFIX = "#~ "
34
35
36 def dump_messages_rna(messages):
37     import bpy
38
39     def classBlackList():
40         blacklist_rna_class = [
41                                # core classes
42                                "Context", "Event", "Function", "UILayout",
43                                "BlendData",
44                                # registerable classes
45                                "Panel", "Menu", "Header", "RenderEngine",
46                                "Operator", "OperatorMacro", "Macro",
47                                "KeyingSetInfo", "UnknownType",
48                                # window classes
49                                "WindowManager", "Window"
50                                ]
51
52         # ---------------------------------------------------------------------
53         # Collect internal operators
54
55         # extend with all internal operators
56         # note that this uses internal api introspection functions
57         # all possible operator names
58         op_names = list(sorted(set(
59             [cls.bl_rna.identifier for cls in
60              bpy.types.OperatorProperties.__subclasses__()] +
61             [cls.bl_rna.identifier for cls in
62              bpy.types.Operator.__subclasses__()] +
63             [cls.bl_rna.identifier for cls in
64              bpy.types.OperatorMacro.__subclasses__()]
65             )))
66
67         get_inatance = __import__("_bpy").ops.get_instance
68         path_resolve = type(bpy.context).__base__.path_resolve
69         for idname in op_names:
70             op = get_inatance(idname)
71             if 'INTERNAL' in path_resolve(op, "bl_options"):
72                 blacklist_rna_class.append(idname)
73
74         # ---------------------------------------------------------------------
75         # Collect builtin classes we dont need to doc
76         blacklist_rna_class.append("Property")
77         blacklist_rna_class.extend(
78                 [cls.__name__ for cls in
79                  bpy.types.Property.__subclasses__()])
80
81         # ---------------------------------------------------------------------
82         # Collect classes which are attached to collections, these are api
83         # access only.
84         collection_props = set()
85         for cls_id in dir(bpy.types):
86             cls = getattr(bpy.types, cls_id)
87             for prop in cls.bl_rna.properties:
88                 if prop.type == 'COLLECTION':
89                     prop_cls = prop.srna
90                     if prop_cls is not None:
91                         collection_props.add(prop_cls.identifier)
92         blacklist_rna_class.extend(sorted(collection_props))
93
94         return blacklist_rna_class
95
96     blacklist_rna_class = classBlackList()
97
98     def filterRNA(bl_rna):
99         id = bl_rna.identifier
100         if id in blacklist_rna_class:
101             print("  skipping", id)
102             return True
103         return False
104
105     # -------------------------------------------------------------------------
106     # Function definitions
107
108     def walkProperties(bl_rna):
109         import bpy
110
111         # get our parents properties not to export them multiple times
112         bl_rna_base = bl_rna.base
113         if bl_rna_base:
114             bl_rna_base_props = bl_rna_base.properties.values()
115         else:
116             bl_rna_base_props = ()
117
118         for prop in bl_rna.properties:
119             # only write this property is our parent hasn't got it.
120             if prop in bl_rna_base_props:
121                 continue
122             if prop.identifier == "rna_type":
123                 continue
124
125             msgsrc = "bpy.types.%s.%s" % (bl_rna.identifier, prop.identifier)
126             messages.setdefault(prop.name, []).append(msgsrc)
127             messages.setdefault(prop.description, []).append(msgsrc)
128
129             if isinstance(prop, bpy.types.EnumProperty):
130                 for item in prop.enum_items:
131                     msgsrc = "bpy.types.%s.%s, '%s'" % (bl_rna.identifier,
132                                                         prop.identifier,
133                                                         item.identifier,
134                                                         )
135                     messages.setdefault(item.name, []).append(msgsrc)
136                     messages.setdefault(item.description, []).append(msgsrc)
137
138     def walkRNA(bl_rna):
139
140         if filterRNA(bl_rna):
141             return
142
143         msgsrc = "bpy.types.%s" % bl_rna.identifier
144
145         if bl_rna.name and bl_rna.name != bl_rna.identifier:
146             messages.setdefault(bl_rna.name, []).append(msgsrc)
147
148         if bl_rna.description:
149             messages.setdefault(bl_rna.description, []).append(msgsrc)
150
151         if hasattr(bl_rna, 'bl_label') and  bl_rna.bl_label:
152             messages.setdefault(bl_rna.bl_label, []).append(msgsrc)
153
154         walkProperties(bl_rna)
155
156     def walkClass(cls):
157         walkRNA(cls.bl_rna)
158
159     def walk_keymap_hierarchy(hier, msgsrc_prev):
160         for lvl in hier:
161             msgsrc = "%s.%s" % (msgsrc_prev, lvl[1])
162             messages.setdefault(lvl[0], []).append(msgsrc)
163
164             if lvl[3]:
165                 walk_keymap_hierarchy(lvl[3], msgsrc)
166
167     # -------------------------------------------------------------------------
168     # Dump Messages
169
170     def full_class_id(cls):
171         """ gives us 'ID.Lamp.AreaLamp' which is best for sorting.
172         """
173         cls_id = ""
174         bl_rna = cls.bl_rna
175         while bl_rna:
176             cls_id = "%s.%s" % (bl_rna.identifier, cls_id)
177             bl_rna = bl_rna.base
178         return cls_id
179
180     cls_list = type(bpy.context).__base__.__subclasses__()
181     cls_list.sort(key=full_class_id)
182     for cls in cls_list:
183         walkClass(cls)
184
185     cls_list = bpy.types.Space.__subclasses__()
186     cls_list.sort(key=full_class_id)
187     for cls in cls_list:
188         walkClass(cls)
189
190     cls_list = bpy.types.Operator.__subclasses__()
191     cls_list.sort(key=full_class_id)
192     for cls in cls_list:
193         walkClass(cls)
194
195     cls_list = bpy.types.OperatorProperties.__subclasses__()
196     cls_list.sort(key=full_class_id)
197     for cls in cls_list:
198         walkClass(cls)
199
200     cls_list = bpy.types.Menu.__subclasses__()
201     cls_list.sort(key=full_class_id)
202     for cls in cls_list:
203         walkClass(cls)
204
205     from bpy_extras.keyconfig_utils import KM_HIERARCHY
206
207     walk_keymap_hierarchy(KM_HIERARCHY, "KM_HIERARCHY")
208
209
210 def dump_messages_pytext(messages):
211     """ dumps text inlined in the python user interface: eg.
212
213         layout.prop("someprop", text="My Name")
214     """
215     import ast
216
217     # -------------------------------------------------------------------------
218     # Gather function names
219
220     import bpy
221     # key: func_id
222     # val: [(arg_kw, arg_pos), (arg_kw, arg_pos), ...]
223     func_translate_args = {}
224
225     # so far only 'text' keywords, but we may want others translated later
226     translate_kw = ("text", )
227
228     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
229         # check it has a 'text' argument
230         for (arg_pos, (arg_kw, arg)) in enumerate(func.parameters.items()):
231             if ((arg_kw in translate_kw) and
232                 (arg.is_output == False) and
233                 (arg.type == 'STRING')):
234
235                 func_translate_args.setdefault(func_id, []).append((arg_kw,
236                                                                     arg_pos))
237     # print(func_translate_args)
238
239     # -------------------------------------------------------------------------
240     # Function definitions
241
242     def extract_strings(fp_rel, node_container):
243         """ Recursively get strings, needed incase we have "Blah" + "Blah",
244             passed as an argument in that case it wont evaluate to a string.
245         """
246
247         for node in ast.walk(node_container):
248             if type(node) == ast.Str:
249                 eval_str = ast.literal_eval(node)
250                 if eval_str:
251                     # print("%s:%d: %s" % (fp, node.lineno, eval_str))
252                     msgsrc = "%s:%s" % (fp_rel, node.lineno)
253                     messages.setdefault(eval_str, []).append(msgsrc)
254
255     def extract_strings_from_file(fp):
256         filedata = open(fp, 'r', encoding="utf8")
257         root_node = ast.parse(filedata.read(), fp, 'exec')
258         filedata.close()
259
260         fp_rel = os.path.relpath(fp, SOURCE_DIR)
261
262         for node in ast.walk(root_node):
263             if type(node) == ast.Call:
264                 # print("found function at")
265                 # print("%s:%d" % (fp, node.lineno))
266
267                 # lambda's
268                 if type(node.func) == ast.Name:
269                     continue
270
271                 # getattr(self, con.type)(context, box, con)
272                 if not hasattr(node.func, "attr"):
273                     continue
274
275                 translate_args = func_translate_args.get(node.func.attr, ())
276
277                 # do nothing if not found
278                 for arg_kw, arg_pos in translate_args:
279                     if arg_pos < len(node.args):
280                         extract_strings(fp_rel, node.args[arg_pos])
281                     else:
282                         for kw in node.keywords:
283                             if kw.arg == arg_kw:
284                                 extract_strings(fp_rel, kw.value)
285
286     # -------------------------------------------------------------------------
287     # Dump Messages
288
289     mod_dir = os.path.join(SOURCE_DIR,
290                            "release",
291                            "scripts",
292                            "startup",
293                            "bl_ui")
294
295     files = [os.path.join(mod_dir, fn)
296              for fn in sorted(os.listdir(mod_dir))
297              if not fn.startswith("_")
298              if fn.endswith("py")
299              ]
300
301     for fp in files:
302         extract_strings_from_file(fp)
303
304
305 def dump_messages():
306
307     def filter_message(msg):
308
309         # check for strings like ": %d"
310         msg_test = msg
311         for ignore in ("%d", "%s", "%r",  # string formatting
312                        "*", ".", "(", ")", "-", "/", "\\", "+", ":", "#", "%"
313                        "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
314                        "x",  # used on its own eg: 100x200
315                        "X", "Y", "Z",  # used alone. no need to include
316                        ):
317             msg_test = msg_test.replace(ignore, "")
318         msg_test = msg_test.strip()
319         if not msg_test:
320             # print("Skipping: '%s'" % msg)
321             return True
322
323         # we could filter out different strings here
324
325         return False
326
327     if 1:
328         import collections
329         messages = collections.OrderedDict()
330     else:
331         messages = {}
332
333     messages[""] = []
334
335     # get strings from RNA
336     dump_messages_rna(messages)
337
338     # get strings from UI layout definitions text="..." args
339     dump_messages_pytext(messages)
340
341     del messages[""]
342
343     message_file = open(FILE_NAME_MESSAGES, 'w', encoding="utf8")
344     # message_file.writelines("\n".join(sorted(messages)))
345
346     for key, value in messages.items():
347
348         # filter out junk values
349         if filter_message(key):
350             continue
351
352         for msgsrc in value:
353             message_file.write("%s%s\n" % (COMMENT_PREFIX, msgsrc))
354         message_file.write("%s\n" % key)
355
356     message_file.close()
357
358     print("Written %d messages to: %r" % (len(messages), FILE_NAME_MESSAGES))
359
360
361 def main():
362
363     try:
364         import bpy
365     except ImportError:
366         print("This script must run from inside blender")
367         return
368
369     dump_messages()
370
371
372 if __name__ == "__main__":
373     print("\n\n *** Running %r *** \n" % __file__)
374     main()