a290992338846b0b351de32729011534176dcd84
[blender-staging.git] / source / blender / makesrna / rna_cleanup / rna_cleaner.py
1 #! /usr/bin/env python3.1
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 --python ./release/scripts/modules/rna_info.py > 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):
80     # reminder: props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
81     if '_' in prop:
82         prefix = prop.split('_')[0]
83         if prefix not in kw_prefixes:
84             return 'BAD-PREFIX: ' + prefix
85         else:
86             return prefix + '_'
87     elif prop in kw:
88         return 'SPECIAL-KEYWORD: ' + prop
89     else:
90         return 'BAD-KEYWORD: ' + prop
91
92
93 def check_if_changed(a,b):
94     if a != b: return 'changed'
95     else: return 'same'
96
97
98 def get_props_from_txt(input_filename):
99     """
100     If the file is *.txt, the script assumes it is formatted as outlined in this script docstring
101     """
102     
103     file=open(input_filename,'r')
104     file_lines=file.readlines()
105     file.close()
106
107     props_list=[]
108     props_length_max=[0,0,0,0,0,0,0,0]
109     for line in file_lines:
110         
111         # debug
112         #print(line)
113         
114         # empty line or comment
115         if not line.strip() or line.startswith('#'):
116             continue
117
118         # class
119         [bclass, tail] = [x.strip() for x in line.split('.', 1)]
120
121         # comment
122         if '*' in bclass:
123             [comment, bclass] = [x.strip() for x in bclass.split('*', 1)]
124         else:
125             comment= ''
126
127         # skipping the header if we have one.
128         # the header is assumed to be "NOTE * CLASS.FROM -> TO:   TYPE  DESCRIPTION"
129         if comment == 'NOTE' and bclass == 'CLASS':
130             continue
131
132         # from
133         [bfrom, tail] = [x.strip() for x in tail.split('->', 1)]
134
135         # to
136         [bto, tail] = [x.strip() for x in tail.split(':', 1)]
137
138         # type, description
139         try:
140             [btype, description] = tail.split(None, 1)
141             if '"' in description:
142                 description.replace('"', "'")
143         except ValueError:
144             [btype, description] = [tail,'NO DESCRIPTION']
145
146         # keyword-check
147         kwcheck = check_prefix(bto)
148
149         # changed
150         changed = check_if_changed(bfrom, bto)
151         
152         # lists formatting
153         props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, repr(description)]
154         props_list.append(props)
155         props_length_max=list(map(max,zip(props_length_max,list(map(len,props)))))
156         
157     return (props_list,props_length_max)
158
159
160 def get_props_from_py(input_filename):
161     """
162     If the file is *.py, the script assumes it contains a python list (as "rna_api=[...]")
163     This means that this script executes the text in the py file with an exec(text).
164     """    
165     # adds the list "rna_api" to this function's scope
166     rna_api = __import__(input_filename[:-3]).rna_api
167
168     props_length_max = [0 for i in rna_api[0]] # this way if the vector will take more elements we are safe
169     for index,props in enumerate(rna_api):
170         comment, changed, bclass, bfrom, bto, kwcheck, btype, description = props
171         kwcheck = check_prefix(bto)   # keyword-check
172         changed = check_if_changed(bfrom, bto)  # changed?
173         description = repr(description)
174         rna_api[index] = [comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
175         props_length = list(map(len,props)) # lengths
176         props_length_max = list(map(max,zip(props_length_max,props_length)))    # max lengths
177     return (rna_api,props_length_max)
178
179
180 def get_props(input_filename):
181     if input_filename.endswith(".txt"):
182         props_list,props_length_max = get_props_from_txt(input_filename)
183     elif input_filename.endswith(".py"):
184         props_list,props_length_max = get_props_from_py(input_filename)
185     return (props_list,props_length_max)
186
187         
188 def sort(props_list, sort_priority):
189     """
190     reminder
191     props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
192     """
193
194     # order based on the i-th element in lists
195     if sort_priority == "class.from":
196         props_list = sorted(props_list, key=lambda p: (p[2], p[3]))
197     else:
198         i = sort_choices.index(sort_priority)
199         if i == 0:
200             props_list = sorted(props_list, key=lambda p: p[i], reverse=True)
201         else:
202             props_list = sorted(props_list, key=lambda p: p[i])
203         
204     print ('\nSorted by %s.' % font_bold(sort_priority))
205     return props_list
206
207
208 def file_basename(input_filename):
209     # if needed will use os.path
210     if input_filename.endswith(".txt"):
211         if input_filename.endswith("_work.txt"):
212             base_filename = input_filename.replace("_work.txt", "")
213         else:
214             base_filename = input_filename.replace(".txt", "")
215     elif input_filename.endswith(".py"):
216         if input_filename.endswith("_work.py"):
217             base_filename = input_filename.replace("_work.py", "")
218         else:
219             base_filename = input_filename.replace(".py", "")
220
221     return base_filename
222
223
224 def write_files(basename, props_list, props_length_max):
225     """
226     Writes in 3 files:
227       * output_filename_work.txt: formatted as txt input file (can be edited)
228       * output_filename_work.py:  formatted for readability (can be edited)
229       * rna_api.py: unformatted, just as final output
230     """
231
232     f_rna = open("rna_api.py",'w')
233     f_txt = open(basename + '_work.txt','w')
234     f_py = open(basename + '_work.py','w')
235
236     # reminder: props=[comment, changed, bclass, bfrom, bto, kwcheck, btype, description]
237     # [comment *] ToolSettings.snap_align_rotation -> use_snap_align_rotation:    boolean    [Align rotation with the snapping target]
238     rna = py = txt = ''
239     props_list = [['NOTE', 'CHANGED', 'CLASS', 'FROM', 'TO', 'KEYWORD-CHECK', 'TYPE', 'DESCRIPTION']] + props_list
240     for props in props_list:
241         #txt
242         if props[0] != '': txt +=  '%s * ' % props[0]   # comment
243         txt +=  '%s.%s -> %s:   %s  %s\n' % tuple(props[2:5] + props[6:])   # skipping keyword-check
244         # rna_api
245         if props[0] == 'NOTE': indent = '#   '
246         else: indent = '    '
247         rna += indent + '("%s", "%s", "%s", "%s", %s),\n' % tuple(props[2:5] + props[6:]) # description is already string formatted
248         # py
249         blanks = [' '* (x[0]-x[1]) for x in zip(props_length_max,list(map(len,props)))]
250         props = [('"%s"%s' if props[-1] != x[0] else "%s%s") % (x[0],x[1]) for x in zip(props,blanks)]
251         py += indent + '(%s, %s, %s, %s, %s, %s, %s, %s),\n' % tuple(props)
252
253     f_txt.write(txt)
254     f_py.write("rna_api = [\n%s]\n" % py)
255     f_rna.write("rna_api = [\n%s]\n" % rna)
256     
257     # write useful py script, wont hurt
258     f_py.write("\n'''\n")
259     f_py.write("for p_note, p_changed, p_class, p_from, p_to, p_check, p_type, p_desc in rna_api:\n")
260     f_py.write("    print(p_to)\n")
261     f_py.write("\n'''\n")
262
263     f_txt.close()
264     f_py.close()
265     f_rna.close()
266
267     print ('\nSaved %s, %s and %s.\n' % (font_bold(f_txt.name), font_bold(f_py.name), font_bold(f_rna.name) ) )
268
269
270 def main():
271
272     global sort_choices, default_sort_choice
273     global kw_prefixes, kw
274
275     sort_choices = ['note','changed','class','from','to','kw', 'class.from']
276     default_sort_choice = sort_choices[-1]
277     kw_prefixes = [ 'active','apply','bl','exclude','has','invert','is','lock', \
278                     'pressed','show','show_only','use','use_only','layers','states']
279     kw = ['active','hide','invert','select','layers','mute','states','use','lock']
280
281     input_filename, sort_priority = check_commandline()
282     props_list,props_length_max = get_props(input_filename)
283     props_list = sort(props_list,sort_priority)
284
285     output_basename = file_basename(input_filename)
286     write_files(output_basename, props_list,props_length_max)
287
288
289 if __name__=='__main__':
290     import sys
291     if not sys.version.startswith("3"):
292         print("Incorrect python version, use python 3!")
293     else:
294         main()
295