improvements to translation message generator
[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 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     # -------------------------------------------------------------------------
40     # Function definitions
41
42     def walkProperties(bl_rna):
43         import bpy
44
45         # get our parents properties not to export them multiple times
46         bl_rna_base = bl_rna.base
47         if bl_rna_base:
48             bl_rna_base_props = bl_rna_base.properties.values()
49         else:
50             bl_rna_base_props = ()
51
52         for prop in bl_rna.properties:
53             # only write this property is our parent hasn't got it.
54             if prop in bl_rna_base_props:
55                 continue
56             if prop.identifier == "rna_type":
57                 continue
58
59             msgsrc = "bpy.types.%s.%s" % (bl_rna.identifier, prop.identifier)
60             messages.setdefault(prop.name, []).append(msgsrc)
61             messages.setdefault(prop.description, []).append(msgsrc)
62
63             if isinstance(prop, bpy.types.EnumProperty):
64                 for item in prop.enum_items:
65                     msgsrc = "bpy.types.%s.%s, '%s'" % (bl_rna.identifier,
66                                                         prop.identifier,
67                                                         item.identifier,
68                                                         )
69                     messages.setdefault(item.name, []).append(msgsrc)
70                     messages.setdefault(item.description, []).append(msgsrc)
71
72     def walkRNA(bl_rna):
73         msgsrc = "bpy.types.%s" % bl_rna.identifier
74
75         if bl_rna.name and bl_rna.name != bl_rna.identifier:
76             messages.setdefault(bl_rna.name, []).append(msgsrc)
77
78         if bl_rna.description:
79             messages.setdefault(bl_rna.description, []).append(msgsrc)
80
81         walkProperties(bl_rna)
82
83     def walkClass(cls):
84         walkRNA(cls.bl_rna)
85
86     def walk_keymap_hierarchy(hier, msgsrc_prev):
87         for lvl in hier:
88             msgsrc = "%s.%s" % (msgsrc_prev, lvl[1])
89             messages.setdefault(lvl[0], []).append(msgsrc)
90
91             if lvl[3]:
92                 walk_keymap_hierarchy(lvl[3], msgsrc)
93
94     # -------------------------------------------------------------------------
95     # Dump Messages
96
97     def full_class_id(cls):
98         """ gives us 'ID.Lamp.AreaLamp' which is best for sorting.
99         """
100         cls_id = ""
101         bl_rna = cls.bl_rna
102         while bl_rna:
103             cls_id = "%s.%s" % (bl_rna.identifier, cls_id)
104             bl_rna = bl_rna.base
105         return cls_id
106
107     cls_list = type(bpy.context).__base__.__subclasses__()
108     cls_list.sort(key=full_class_id)
109     for cls in cls_list:
110         walkClass(cls)
111
112     cls_list = bpy.types.Space.__subclasses__()
113     cls_list.sort(key=full_class_id)
114     for cls in cls_list:
115         walkClass(cls)
116
117     cls_list = bpy.types.Operator.__subclasses__()
118     cls_list.sort(key=full_class_id)
119     for cls in cls_list:
120         walkClass(cls)
121
122     from bpy_extras.keyconfig_utils import KM_HIERARCHY
123
124     walk_keymap_hierarchy(KM_HIERARCHY, "KM_HIERARCHY")
125
126
127     ## XXX. what is this supposed to do, we wrote the file already???
128     #_walkClass(bpy.types.SpaceDopeSheetEditor)
129
130
131 def dump_messages_pytext(messages):
132     """ dumps text inlined in the python user interface: eg.
133
134         layout.prop("someprop", text="My Name")
135     """
136     import ast
137
138     # -------------------------------------------------------------------------
139     # Gather function names
140
141     import bpy
142     # key: func_id
143     # val: [(arg_kw, arg_pos), (arg_kw, arg_pos), ...]
144     func_translate_args = {}
145
146     # so far only 'text' keywords, but we may want others translated later
147     translate_kw = ("text", )
148
149     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
150         # check it has a 'text' argument
151         for (arg_pos, (arg_kw, arg)) in enumerate(func.parameters.items()):
152             if ((arg_kw in translate_kw) and
153                 (arg.is_output == False) and
154                 (arg.type == 'STRING')):
155
156                 func_translate_args.setdefault(func_id, []).append((arg_kw,
157                                                                     arg_pos))
158     # print(func_translate_args)
159
160     # -------------------------------------------------------------------------
161     # Function definitions
162
163     def extract_strings(fp_rel, node_container):
164         """ Recursively get strings, needed incase we have "Blah" + "Blah",
165             passed as an argument in that case it wont evaluate to a string.
166         """
167
168         for node in ast.walk(node_container):
169             if type(node) == ast.Str:
170                 eval_str = ast.literal_eval(node)
171                 if eval_str:
172                     # print("%s:%d: %s" % (fp, node.lineno, eval_str))
173                     msgsrc = "%s:%s" % (fp_rel, node.lineno)
174                     messages.setdefault(eval_str, []).append(msgsrc)
175
176     def extract_strings_from_file(fp):
177         filedata = open(fp, 'r', encoding="utf8")
178         root_node = ast.parse(filedata.read(), fp, 'exec')
179         filedata.close()
180
181         fp_rel = os.path.relpath(fp, SOURCE_DIR)
182
183         for node in ast.walk(root_node):
184             if type(node) == ast.Call:
185                 # print("found function at")
186                 # print("%s:%d" % (fp, node.lineno))
187
188                 # lambda's
189                 if type(node.func) == ast.Name:
190                     continue
191
192                 # getattr(self, con.type)(context, box, con)
193                 if not hasattr(node.func, "attr"):
194                     continue
195
196                 translate_args = func_translate_args.get(node.func.attr, ())
197
198                 # do nothing if not found
199                 for arg_kw, arg_pos in translate_args:
200                     if arg_pos < len(node.args):
201                         extract_strings(fp_rel, node.args[arg_pos])
202                     else:
203                         for kw in node.keywords:
204                             if kw.arg == arg_kw:
205                                 extract_strings(fp_rel, kw.value)
206
207     # -------------------------------------------------------------------------
208     # Dump Messages
209
210     mod_dir = os.path.join(SOURCE_DIR,
211                            "release",
212                            "scripts",
213                            "startup",
214                            "bl_ui")
215
216     files = [os.path.join(mod_dir, fn)
217              for fn in sorted(os.listdir(mod_dir))
218              if not fn.startswith("_")
219              if fn.endswith("py")
220              ]
221
222     for fp in files:
223         extract_strings_from_file(fp)
224
225
226 def dump_messages():
227
228     def filter_message(msg):
229
230         # check for strings like ": %d"
231         msg_test = msg
232         for ignore in ("%d", "%s", "%r",  # string formatting
233                        "*", ".", "(", ")", "-", "/", "\\", "+", ":", "#", "%"
234                        "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
235                        "x",  # used on its own eg: 100x200
236                        "X", "Y", "Z",  # used alone. no need to include
237                        ):
238             msg_test = msg_test.replace(ignore, "")
239         msg_test = msg_test.strip()
240         if not msg_test:
241             # print("Skipping: '%s'" % msg)
242             return True
243
244         # we could filter out different strings here
245
246         return False
247
248     if 1:
249         import collections
250         messages = collections.OrderedDict()
251     else:
252         messages = {}
253
254     messages[""] = []
255
256     # get strings from RNA
257     dump_messages_rna(messages)
258
259     # get strings from UI layout definitions text="..." args
260     dump_messages_pytext(messages)
261
262     del messages[""]
263
264     message_file = open(FILE_NAME_MESSAGES, 'w', encoding="utf8")
265     # message_file.writelines("\n".join(sorted(messages)))
266
267     for key, value in messages.items():
268
269         # filter out junk values
270         if filter_message(key):
271             continue
272
273         for msgsrc in value:
274             message_file.write("%s%s\n" % (COMMENT_PREFIX, msgsrc))
275         message_file.write("%s\n" % key)
276
277     message_file.close()
278
279     print("Written %d messages to: %r" % (len(messages), FILE_NAME_MESSAGES))
280
281
282 def main():
283
284     try:
285         import bpy
286     except ImportError:
287         print("This script must run from inside blender")
288         return
289
290     dump_messages()
291
292
293 if __name__ == "__main__":
294     print("\n\n *** Running %r *** \n" % __file__)
295     main()