pass -noaudio when running blender for various utilities - doc-gen and tests.
[blender.git] / source / blender / makesrna / rna_cleanup / rna_cleaner.py
1 #! /usr/bin/env python3
2
3 """
4 This script is used to help cleaning RNA api.
5
6 Typical line in the input file (elements in [] are optional).
7
8 [comment *] ToolSettings.snap_align_rotation -> use_snap_align_rotation:    boolean    [Align rotation with the snapping target]
9
10 Geterate output format from blender run this:
11  ./blender.bin --background -noaudio --python ./release/scripts/modules/rna_info.py 2> source/blender/makesrna/rna_cleanup/out.txt
12 """
13
14
15 def font_bold(mystring):
16     """
17     Formats the string as bold, to be used in printouts.
18     """
19     font_bold = "\033[1m"
20     font_reset = "\033[0;0m"
21     return font_bold + mystring + font_reset
22     
23
24 def usage():
25     """
26     Prints script usage.
27     """
28     import sys
29     scriptname = sys.argv[0]
30     sort_choices_string = '|'.join(sort_choices)
31     message = "\nUSAGE:"
32     message += "\n%s input-file (.txt|.py) order-priority (%s).\n" % (font_bold(scriptname), sort_choices_string)
33     message += "%s -h for help\n" % font_bold(scriptname)
34     print(message)
35     exit()
36
37
38 def help():
39     """
40     Prints script' help.
41     """
42     message = '\nHELP:'
43     message += '\nRun this script to re-format the edits you make in the input file.\n'
44     message += 'Do quick modification to important fields like \'to\' and don\'t care about fields like \'changed\' or \'description\' and save.\n'
45     message += 'The script outputs 3 files:\n'
46     message += '   1) *_clean.txt: is formatted same as the .txt input, can be edited by user.\n'
47     message += '   2) *_clean.py: is formatted same as the .py input, can be edited by user.\n'
48     message += '   3) rna_api.py is not formatted for readability and go under complete check. Can be used for rna cleanup.\n'
49     print(message)
50     usage()
51
52
53 def check_commandline():
54     """
55     Takes parameters from the commandline.
56     """
57     import sys
58     # Usage
59     if len(sys.argv)==1 or len(sys.argv)>3:
60         usage()
61     if sys.argv[1] == '-h':
62         help()
63     elif not (sys.argv[1].endswith(".txt") or sys.argv[1].endswith(".py")):
64         print ('\nBad input file extension... exiting.')
65         usage()
66     else:
67         inputfile = sys.argv[1]
68     if len(sys.argv) == 2:
69         sort_priority = default_sort_choice
70         print ('\nSecond parameter missing: choosing to order by %s.' % font_bold(sort_priority))
71     elif len(sys.argv)==3:
72         sort_priority = sys.argv[2]
73         if sort_priority not in sort_choices:
74             print('\nWrong sort_priority... exiting.')
75             usage()
76     return (inputfile, sort_priority)
77
78
79 def check_prefix(prop, btype):
80     # reminder: props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
81     if btype == "boolean":
82         if '_' in prop:
83             prefix = prop.split('_')[0]
84             if prefix not in kw_prefixes:
85                 return 'BAD-PREFIX: ' + prefix
86             else:
87                 return prefix + '_'
88         elif prop in kw:
89             return 'SPECIAL-KEYWORD: ' + prop
90         else:
91             return 'BAD-KEYWORD: ' + prop
92     else:
93         return ""
94
95
96 def check_if_changed(a,b):
97     if a != b: return 'changed'
98     else: return 'same'
99
100
101 def get_props_from_txt(input_filename):
102     """
103     If the file is *.txt, the script assumes it is formatted as outlined in this script docstring
104     """
105     
106     file=open(input_filename,'r')
107     file_lines=file.readlines()
108     file.close()
109
110     props_list=[]
111     props_length_max=[0,0,0,0,0,0,0,0]
112     
113     done_text = "+"
114     done = 0
115     tot = 0
116     
117     for iii, line in enumerate(file_lines):
118         
119         # debug
120         #print(line)
121         line_strip = line.strip()
122         # empty line or comment
123         if not line_strip:
124             continue
125             
126         if line_strip == "EOF":
127             break
128         
129         if line.startswith("#"):
130             line = line[1:]
131
132         # class
133         [bclass, tail] = [x.strip() for x in line.split('.', 1)]
134
135         # comment
136         if '*' in bclass:
137             [comment, bclass] = [x.strip() for x in bclass.split('*', 1)]
138         else:
139             comment= ''
140
141         # skipping the header if we have one.
142         # the header is assumed to be "NOTE * CLASS.FROM -> TO:   TYPE  DESCRIPTION"
143         if comment == 'NOTE' and bclass == 'CLASS':
144             continue
145
146         # from
147         [bfrom, tail] = [x.strip() for x in tail.split('->', 1)]
148
149         # to
150         [bto, tail] = [x.strip() for x in tail.split(':', 1)]
151
152         # type, description
153         try:
154             [btype, description] = tail.split(None, 1)
155             # make life easy and strip quotes
156             description = description.replace("'", "").replace('"', "").replace("\\", "").strip()
157         except ValueError:
158             [btype, description] = [tail,'NO DESCRIPTION']
159
160         # keyword-check
161         kwcheck = check_prefix(bto, btype)
162
163         # changed
164         changed = check_if_changed(bfrom, bto)
165         
166         # lists formatting
167         props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
168         props_list.append(props)
169         props_length_max=list(map(max,zip(props_length_max,list(map(len,props)))))
170         
171         if done_text in comment:
172             done += 1
173         tot += 1
174     
175     print("Total done %.2f" % (done / tot * 100.0) )
176     
177     return (props_list,props_length_max)
178
179
180 def get_props_from_py(input_filename):
181     """
182     If the file is *.py, the script assumes it contains a python list (as "rna_api=[...]")
183     This means that this script executes the text in the py file with an exec(text).
184     """    
185     # adds the list "rna_api" to this function's scope
186     rna_api = __import__(input_filename[:-3]).rna_api
187
188     props_length_max = [0 for i in rna_api[0]] # this way if the vector will take more elements we are safe
189     for index,props in enumerate(rna_api):
190         comment, changed, bclass, bfrom, bto, kwcheck, btype, description = props
191         kwcheck = check_prefix(bto, btype)   # keyword-check
192         changed = check_if_changed(bfrom, bto)  # changed?
193         description = repr(description)
194         description = description.replace("'", "").replace('"', "").replace("\\", "").strip()
195         rna_api[index] = [comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
196         props_length = list(map(len,props)) # lengths
197         props_length_max = list(map(max,zip(props_length_max,props_length)))    # max lengths
198     return (rna_api,props_length_max)
199
200
201 def get_props(input_filename):
202     if input_filename.endswith(".txt"):
203         props_list,props_length_max = get_props_from_txt(input_filename)
204     elif input_filename.endswith(".py"):
205         props_list,props_length_max = get_props_from_py(input_filename)
206     return (props_list,props_length_max)
207
208         
209 def sort(props_list, sort_priority):
210     """
211     reminder
212     props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
213     """
214
215     # order based on the i-th element in lists
216     if sort_priority == "class.to":
217         props_list = sorted(props_list, key=lambda p: (p[2], p[4]))
218     else:
219         i = sort_choices.index(sort_priority)
220         if i == 0:
221             props_list = sorted(props_list, key=lambda p: p[i], reverse=True)
222         else:
223             props_list = sorted(props_list, key=lambda p: p[i])
224         
225     print ('\nSorted by %s.' % font_bold(sort_priority))
226     return props_list
227
228
229 def file_basename(input_filename):
230     # if needed will use os.path
231     if input_filename.endswith(".txt"):
232         if input_filename.endswith("_work.txt"):
233             base_filename = input_filename.replace("_work.txt", "")
234         else:
235             base_filename = input_filename.replace(".txt", "")
236     elif input_filename.endswith(".py"):
237         if input_filename.endswith("_work.py"):
238             base_filename = input_filename.replace("_work.py", "")
239         else:
240             base_filename = input_filename.replace(".py", "")
241
242     return base_filename
243
244
245 def write_files(basename, props_list, props_length_max):
246     """
247     Writes in 3 files:
248       * output_filename_work.txt: formatted as txt input file (can be edited)
249       * output_filename_work.py:  formatted for readability (can be edited)
250       * rna_api.py: unformatted, just as final output
251     """
252
253     f_rna = open("rna_api.py",'w')
254     f_txt = open(basename + '_work.txt','w')
255     f_py = open(basename + '_work.py','w')
256
257     # reminder: props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
258     # [comment *] ToolSettings.snap_align_rotation -> use_snap_align_rotation:    boolean    [Align rotation with the snapping target]
259     rna = py = txt = ''
260     props_list = [['NOTE', 'CHANGED', 'CLASS', 'FROM', 'TO', 'KEYWORD-CHECK', 'TYPE', 'DESCRIPTION']] + props_list
261     for props in props_list:
262         #txt
263         
264         # quick way we can tell if it changed
265         if props[3] == props[4]: txt += "#"
266         else: txt += " "
267     
268         if props[0] != '': txt +=  '%s * ' % props[0]   # comment
269         txt +=  '%s.%s -> %s:   %s  "%s"\n' % tuple(props[2:5] + props[6:])   # skipping keyword-check
270         # rna_api
271         if props[0] == 'NOTE': indent = '#   '
272         else: indent = '    '
273         rna += indent + '("%s", "%s", "%s", "%s", "%s"),\n' % tuple(props[2:5] + props[6:]) # description is already string formatted
274         # py
275         blanks = [' '* (x[0]-x[1]) for x in zip(props_length_max,list(map(len,props)))]
276         props = [('"%s"%s' if props[-1] != x[0] else "%s%s") % (x[0],x[1]) for x in zip(props,blanks)]
277         py += indent + '(%s, %s, %s, %s, %s, %s, %s, "%s"),\n' % tuple(props)
278
279     f_txt.write(txt)
280     f_py.write("rna_api = [\n%s]\n" % py)
281     f_rna.write("rna_api = [\n%s]\n" % rna)
282     
283     # write useful py script, wont hurt
284     f_py.write("\n'''\n")
285     f_py.write("for p_note, p_changed, p_class, p_from, p_to, p_check, p_type, p_desc in rna_api:\n")
286     f_py.write("    print(p_to)\n")
287     f_py.write("\n'''\n")
288
289     f_txt.close()
290     f_py.close()
291     f_rna.close()
292
293     print ('\nSaved %s, %s and %s.\n' % (font_bold(f_txt.name), font_bold(f_py.name), font_bold(f_rna.name) ) )
294
295
296 def main():
297
298     global sort_choices, default_sort_choice
299     global kw_prefixes, kw
300
301     sort_choices = ['note','changed','class','from','to','kw', 'class.to']
302     default_sort_choice = sort_choices[-1]
303     kw_prefixes = [ 'active','apply','bl','exclude','has','invert','is','lock', \
304                     'pressed','show','show_only','use','use_only','layers','states', 'select']
305     kw = ['active','hide','invert','select','layers','mute','states','use','lock']
306
307     input_filename, sort_priority = check_commandline()
308     props_list,props_length_max = get_props(input_filename)
309     props_list = sort(props_list,sort_priority)
310
311     output_basename = file_basename(input_filename)
312     write_files(output_basename, props_list,props_length_max)
313
314
315 if __name__=='__main__':
316     import sys
317     if not sys.version.startswith("3"):
318         print("Incorrect python version, use python 3!")
319     else:
320         main()
321