== rna info ==
[blender-staging.git] / release / scripts / modules / rna_info.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 # classes for extracting info from blenders internal classes
22
23 import bpy
24
25 # use to strip python paths
26 script_paths = bpy.utils.script_paths()
27
28 _FAKE_STRUCT_SUBCLASS = True
29
30
31 def _get_direct_attr(rna_type, attr):
32     props = getattr(rna_type, attr)
33     base = rna_type.base
34
35     if not base:
36         return [prop for prop in props]
37     else:
38         props_base = getattr(base, attr).values()
39         return [prop for prop in props if prop not in props_base]
40
41
42 def get_direct_properties(rna_type):
43     return _get_direct_attr(rna_type, "properties")
44
45
46 def get_direct_functions(rna_type):
47     return _get_direct_attr(rna_type, "functions")
48
49
50 def rna_id_ignore(rna_id):
51     if rna_id == "rna_type":
52         return True
53
54     if "_OT_" in rna_id:
55         return True
56     if "_MT_" in rna_id:
57         return True
58     if "_PT_" in rna_id:
59         return True
60     if "_HT_" in rna_id:
61         return True
62     if "_KSI_" in rna_id:
63         return True
64     return False
65
66
67 def range_str(val):
68     if val < -10000000:
69         return '-inf'
70     elif val > 10000000:
71         return 'inf'
72     elif type(val) == float:
73         return '%g' % val
74     else:
75         return str(val)
76
77
78 def float_as_string(f):
79     val_str = "%g" % f
80     if '.' not in val_str and '-' not in val_str:  # value could be 1e-05
81         val_str += '.0'
82     return val_str
83
84
85 class InfoStructRNA:
86     global_lookup = {}
87
88     def __init__(self, rna_type):
89         self.bl_rna = rna_type
90
91         self.identifier = rna_type.identifier
92         self.name = rna_type.name
93         self.description = rna_type.description.strip()
94
95         # set later
96         self.base = None
97         self.nested = None
98         self.full_path = ""
99
100         self.functions = []
101         self.children = []
102         self.references = []
103         self.properties = []
104
105     def build(self):
106         rna_type = self.bl_rna
107         parent_id = self.identifier
108         self.properties[:] = [GetInfoPropertyRNA(rna_prop, parent_id) for rna_prop in get_direct_properties(rna_type) if rna_prop.identifier != "rna_type"]
109         self.functions[:] = [GetInfoFunctionRNA(rna_prop, parent_id) for rna_prop in get_direct_functions(rna_type)]
110
111     def get_bases(self):
112         bases = []
113         item = self
114
115         while item:
116             item = item.base
117             if item:
118                 bases.append(item)
119
120         return bases
121
122     def get_nested_properties(self, ls=None):
123         if not ls:
124             ls = self.properties[:]
125
126         if self.nested:
127             self.nested.get_nested_properties(ls)
128
129         return ls
130
131     def _get_py_visible_attrs(self):
132         attrs = []
133         py_class = getattr(bpy.types, self.identifier)
134         for attr_str in dir(py_class):
135             if attr_str.startswith("_"):
136                 continue
137             attrs.append((attr_str, getattr(py_class, attr_str)))
138         return attrs
139
140     def get_py_properties(self):
141         properties = []
142         for identifier, attr in self._get_py_visible_attrs():
143             if type(attr) is property:
144                 properties.append((identifier, attr))
145         return properties
146
147     def get_py_functions(self):
148         import types
149         functions = []
150         for identifier, attr in self._get_py_visible_attrs():
151             if type(attr) in (types.FunctionType, types.MethodType):
152                 functions.append((identifier, attr))
153         return functions
154
155     def __str__(self):
156
157         txt = ""
158         txt += self.identifier
159         if self.base:
160             txt += "(%s)" % self.base.identifier
161         txt += ": " + self.description + "\n"
162
163         for prop in self.properties:
164             txt += prop.__repr__() + "\n"
165
166         for func in self.functions:
167             txt += func.__repr__() + "\n"
168
169         return txt
170
171
172 class InfoPropertyRNA:
173     global_lookup = {}
174
175     def __init__(self, rna_prop):
176         self.bl_prop = rna_prop
177         self.identifier = rna_prop.identifier
178         self.name = rna_prop.name
179         self.description = rna_prop.description.strip()
180         self.default_str = "<UNKNOWN>"
181
182     def build(self):
183         rna_prop = self.bl_prop
184
185         self.enum_items = []
186         self.min = getattr(rna_prop, "hard_min", -1)
187         self.max = getattr(rna_prop, "hard_max", -1)
188         self.array_length = getattr(rna_prop, "array_length", 0)
189         self.collection_type = GetInfoStructRNA(rna_prop.srna)
190         self.is_required = rna_prop.is_required
191         self.is_readonly = rna_prop.is_readonly
192         self.is_never_none = rna_prop.is_never_none
193
194         self.type = rna_prop.type.lower()
195         fixed_type = getattr(rna_prop, "fixed_type", "")
196         if fixed_type:
197             self.fixed_type = GetInfoStructRNA(fixed_type)  # valid for pointer/collections
198         else:
199             self.fixed_type = None
200
201         if self.type == "enum":
202             self.enum_items[:] = rna_prop.items.keys()
203
204         if self.array_length:
205             self.default = tuple(getattr(rna_prop, "default_array", ()))
206         else:
207             self.default = getattr(rna_prop, "default", None)
208         self.default_str = ""  # fallback
209
210         if self.type == "pointer":
211             # pointer has no default, just set as None
212             self.default = None
213             self.default_str = "None"
214         elif self.type == "string":
215             self.default_str = "\"%s\"" % self.default
216         elif self.type == "enum":
217             self.default_str = "'%s'" % self.default
218         elif self.array_length:
219             self.default_str = ''
220             # special case for floats
221             if len(self.default) > 0:
222                 if self.type == "float":
223                     self.default_str = "(%s)" % ", ".join(float_as_string(f) for f in self.default)
224             if not self.default_str:
225                 self.default_str = str(self.default)
226         else:
227             if self.type == "float":
228                 self.default_str = float_as_string(self.default)
229             else:
230                 self.default_str = str(self.default)
231
232         self.srna = GetInfoStructRNA(rna_prop.srna)  # valid for pointer/collections
233
234     def get_arg_default(self, force=True):
235         default = self.default_str
236         if default and (force or self.is_required == False):
237             return "%s=%s" % (self.identifier, default)
238         return self.identifier
239
240     def get_type_description(self, as_ret=False, as_arg=False, class_fmt="%s"):
241         type_str = ""
242         if self.fixed_type is None:
243             type_str += self.type
244             if self.array_length:
245                 type_str += " array of %d items" % (self.array_length)
246
247             if self.type in ("float", "int"):
248                 type_str += " in [%s, %s]" % (range_str(self.min), range_str(self.max))
249             elif self.type == "enum":
250                 type_str += " in [%s]" % ", ".join(("'%s'" % s) for s in self.enum_items)
251
252             if not (as_arg or as_ret):
253                 # write default property, ignore function args for this
254                 if self.type != "pointer":
255                     if self.default_str:
256                         type_str += ", default %s" % self.default_str
257
258         else:
259             if self.type == "collection":
260                 if self.collection_type:
261                     collection_str = (class_fmt % self.collection_type.identifier) + " collection of "
262                 else:
263                     collection_str = "Collection of "
264             else:
265                 collection_str = ""
266
267             type_str += collection_str + (class_fmt % self.fixed_type.identifier)
268
269         # setup qualifiers for this value.
270         type_info = []
271         if as_ret:
272             pass
273         elif as_arg:
274             if not self.is_required:
275                 type_info.append("optional")
276         else:  # readonly is only useful for selfs, not args
277             if self.is_readonly:
278                 type_info.append("readonly")
279
280         if self.is_never_none:
281             type_info.append("never None")
282
283         if type_info:
284             type_str += (", (%s)" % ", ".join(type_info))
285
286         return type_str
287
288     def __str__(self):
289         txt = ''
290         txt += ' * ' + self.identifier + ': ' + self.description
291
292         return txt
293
294
295 class InfoFunctionRNA:
296     global_lookup = {}
297
298     def __init__(self, rna_func):
299         self.bl_func = rna_func
300         self.identifier = rna_func.identifier
301         # self.name = rna_func.name # functions have no name!
302         self.description = rna_func.description.strip()
303         self.is_classmethod = not rna_func.use_self
304
305         self.args = []
306         self.return_values = ()
307
308     def build(self):
309         rna_func = self.bl_func
310         parent_id = rna_func
311         self.return_values = []
312
313         for rna_prop in rna_func.parameters.values():
314             prop = GetInfoPropertyRNA(rna_prop, parent_id)
315             if rna_prop.is_output:
316                 self.return_values.append(prop)
317             else:
318                 self.args.append(prop)
319
320         self.return_values = tuple(self.return_values)
321
322     def __str__(self):
323         txt = ''
324         txt += ' * ' + self.identifier + '('
325
326         for arg in self.args:
327             txt += arg.identifier + ', '
328         txt += '): ' + self.description
329         return txt
330
331
332 class InfoOperatorRNA:
333     global_lookup = {}
334
335     def __init__(self, rna_op):
336         self.bl_op = rna_op
337         self.identifier = rna_op.identifier
338
339         mod, name = self.identifier.split("_OT_", 1)
340         self.module_name = mod.lower()
341         self.func_name = name
342
343         # self.name = rna_func.name # functions have no name!
344         self.description = rna_op.description.strip()
345
346         self.args = []
347
348     def build(self):
349         rna_op = self.bl_op
350         parent_id = self.identifier
351         for rna_id, rna_prop in rna_op.properties.items():
352             if rna_id == "rna_type":
353                 continue
354
355             prop = GetInfoPropertyRNA(rna_prop, parent_id)
356             self.args.append(prop)
357
358     def get_location(self):
359         op_class = getattr(bpy.types, self.identifier)
360         op_func = getattr(op_class, "execute", None)
361         if op_func is None:
362             op_func = getattr(op_class, "invoke", None)
363         if op_func is None:
364             op_func = getattr(op_class, "poll", None)
365
366         if op_func:
367             op_code = op_func.__code__
368             source_path = op_code.co_filename
369
370             # clear the prefix
371             for p in script_paths:
372                 source_path = source_path.split(p)[-1]
373
374             if source_path[0] in "/\\":
375                 source_path = source_path[1:]
376
377             return source_path, op_code.co_firstlineno
378         else:
379             return None, None
380
381
382 def _GetInfoRNA(bl_rna, cls, parent_id=''):
383
384     if bl_rna is None:
385         return None
386
387     key = parent_id, bl_rna.identifier
388     try:
389         return cls.global_lookup[key]
390     except KeyError:
391         instance = cls.global_lookup[key] = cls(bl_rna)
392         return instance
393
394
395 def GetInfoStructRNA(bl_rna):
396     return _GetInfoRNA(bl_rna, InfoStructRNA)
397
398
399 def GetInfoPropertyRNA(bl_rna, parent_id):
400     return _GetInfoRNA(bl_rna, InfoPropertyRNA, parent_id)
401
402
403 def GetInfoFunctionRNA(bl_rna, parent_id):
404     return _GetInfoRNA(bl_rna, InfoFunctionRNA, parent_id)
405
406
407 def GetInfoOperatorRNA(bl_rna):
408     return _GetInfoRNA(bl_rna, InfoOperatorRNA)
409
410
411 def BuildRNAInfo():
412     # Use for faster lookups
413     # use rna_struct.identifier as the key for each dict
414     rna_struct_dict = {}  # store identifier:rna lookups
415     rna_full_path_dict = {}      # store the result of full_rna_struct_path(rna_struct)
416     rna_children_dict = {}  # store all rna_structs nested from here
417     rna_references_dict = {}  # store a list of rna path strings that reference this type
418     # rna_functions_dict = {}  # store all functions directly in this type (not inherited)
419
420     def full_rna_struct_path(rna_struct):
421         '''
422         Needed when referencing one struct from another
423         '''
424         nested = rna_struct.nested
425         if nested:
426             return "%s.%s" % (full_rna_struct_path(nested), rna_struct.identifier)
427         else:
428             return rna_struct.identifier
429
430     # def write_func(rna_func, ident):
431     def base_id(rna_struct):
432         try:
433             return rna_struct.base.identifier
434         except:
435             return ""  # invalid id
436
437     #structs = [(base_id(rna_struct), rna_struct.identifier, rna_struct) for rna_struct in bpy.doc.structs.values()]
438     '''
439     structs = []
440     for rna_struct in bpy.doc.structs.values():
441         structs.append( (base_id(rna_struct), rna_struct.identifier, rna_struct) )
442     '''
443     structs = []
444     for rna_type_name in dir(bpy.types):
445         rna_type = getattr(bpy.types, rna_type_name)
446
447         rna_struct = getattr(rna_type, "bl_rna", None)
448
449         if rna_struct:
450             #if not rna_type_name.startswith('__'):
451
452             identifier = rna_struct.identifier
453
454             if not rna_id_ignore(identifier):
455                 structs.append((base_id(rna_struct), identifier, rna_struct))
456
457                 # Simple lookup
458                 rna_struct_dict[identifier] = rna_struct
459
460                 # Store full rna path 'GameObjectSettings' -> 'Object.GameObjectSettings'
461                 rna_full_path_dict[identifier] = full_rna_struct_path(rna_struct)
462
463                 # Store a list of functions, remove inherited later
464                 # NOT USED YET
465                 ## rna_functions_dict[identifier] = get_direct_functions(rna_struct)
466
467                 # fill in these later
468                 rna_children_dict[identifier] = []
469                 rna_references_dict[identifier] = []
470         else:
471             print("Ignoring", rna_type_name)
472
473     structs.sort()  # not needed but speeds up sort below, setting items without an inheritance first
474
475     # Arrange so classes are always defined in the correct order
476     deps_ok = False
477     while deps_ok == False:
478         deps_ok = True
479         rna_done = set()
480
481         for i, (rna_base, identifier, rna_struct) in enumerate(structs):
482
483             rna_done.add(identifier)
484
485             if rna_base and rna_base not in rna_done:
486                 deps_ok = False
487                 data = structs.pop(i)
488                 ok = False
489                 while i < len(structs):
490                     if structs[i][1] == rna_base:
491                         structs.insert(i + 1, data)  # insert after the item we depend on.
492                         ok = True
493                         break
494                     i += 1
495
496                 if not ok:
497                     print('Dependancy "%s" could not be found for "%s"' % (identifier, rna_base))
498
499                 break
500
501     # Done ordering structs
502
503     # precalc vars to avoid a lot of looping
504     for (rna_base, identifier, rna_struct) in structs:
505
506         # rna_struct_path = full_rna_struct_path(rna_struct)
507         rna_struct_path = rna_full_path_dict[identifier]
508
509         for rna_prop in get_direct_properties(rna_struct):
510             rna_prop_identifier = rna_prop.identifier
511
512             if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
513                 continue
514
515             for rna_prop_ptr in (getattr(rna_prop, "fixed_type", None), getattr(rna_prop, "srna", None)):
516                 # Does this property point to me?
517                 if rna_prop_ptr:
518                     rna_references_dict[rna_prop_ptr.identifier].append("%s.%s" % (rna_struct_path, rna_prop_identifier))
519
520         for rna_func in get_direct_functions(rna_struct):
521             for rna_prop_identifier, rna_prop in rna_func.parameters.items():
522
523                 if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
524                     continue
525
526                 rna_prop_ptr = getattr(rna_prop, "fixed_type", None)
527
528                 # Does this property point to me?
529                 if rna_prop_ptr:
530                     rna_references_dict[rna_prop_ptr.identifier].append("%s.%s" % (rna_struct_path, rna_func.identifier))
531
532         # Store nested children
533         nested = rna_struct.nested
534         if nested:
535             rna_children_dict[nested.identifier].append(rna_struct)
536
537     # Sort the refs, just reads nicer
538     for rna_refs in rna_references_dict.values():
539         rna_refs.sort()
540
541     info_structs = []
542     for (rna_base, identifier, rna_struct) in structs:
543         #if rna_struct.nested:
544         #    continue
545
546         #write_struct(rna_struct, '')
547         info_struct = GetInfoStructRNA(rna_struct)
548         if rna_base:
549             info_struct.base = GetInfoStructRNA(rna_struct_dict[rna_base])
550         info_struct.nested = GetInfoStructRNA(rna_struct.nested)
551         info_struct.children[:] = rna_children_dict[identifier]
552         info_struct.references[:] = rna_references_dict[identifier]
553         info_struct.full_path = rna_full_path_dict[identifier]
554
555         info_structs.append(info_struct)
556
557     for rna_info_prop in InfoPropertyRNA.global_lookup.values():
558         rna_info_prop.build()
559
560     for rna_info_prop in InfoFunctionRNA.global_lookup.values():
561         rna_info_prop.build()
562
563     for rna_info in InfoStructRNA.global_lookup.values():
564         rna_info.build()
565         for prop in rna_info.properties:
566             prop.build()
567         for func in rna_info.functions:
568             func.build()
569             for prop in func.args:
570                 prop.build()
571             for prop in func.return_values:
572                 prop.build()
573
574     if 1:
575         for rna_info in InfoStructRNA.global_lookup.values():
576             for prop in rna_info.properties:
577                 # ERROR CHECK
578                 default = prop.default
579                 if type(default) in (float, int):
580                     if default < prop.min or default > prop.max:
581                         print("\t %s.%s, %s not in [%s - %s]" % (rna_info.identifier, prop.identifier, default, prop.min, prop.max))
582
583     # now for operators
584     op_mods = dir(bpy.ops)
585
586     for op_mod_name in sorted(op_mods):
587         if op_mod_name.startswith('__'):
588             continue
589
590         op_mod = getattr(bpy.ops, op_mod_name)
591         operators = dir(op_mod)
592         for op in sorted(operators):
593             try:
594                 rna_prop = getattr(op_mod, op).get_rna()
595             except AttributeError:
596                 rna_prop = None
597             except TypeError:
598                 rna_prop = None
599
600             if rna_prop:
601                 GetInfoOperatorRNA(rna_prop.bl_rna)
602
603     for rna_info in InfoOperatorRNA.global_lookup.values():
604         rna_info.build()
605         for rna_prop in rna_info.args:
606             rna_prop.build()
607
608     #for rna_info in InfoStructRNA.global_lookup.values():
609     #    print(rna_info)
610     return InfoStructRNA.global_lookup, InfoFunctionRNA.global_lookup, InfoOperatorRNA.global_lookup, InfoPropertyRNA.global_lookup
611
612
613 if __name__ == "__main__":
614     import rna_info
615     struct = rna_info.BuildRNAInfo()[0]
616     data = []
617     for struct_id, v in sorted(struct.items()):
618         struct_id_str = v.identifier  # "".join(sid for sid in struct_id if struct_id)
619
620         for base in v.get_bases():
621             struct_id_str = base.identifier + "|" + struct_id_str
622
623         props = [(prop.identifier, prop) for prop in v.properties]
624         for prop_id, prop in sorted(props):
625             # if prop.type == 'boolean':
626             #     continue
627             prop_type = prop.type
628             if prop.array_length > 0:
629                 prop_type += "[%d]" % prop.array_length
630
631             data.append("%s.%s -> %s:    %s%s    %s" % (struct_id_str, prop.identifier, prop.identifier, prop_type, ", (read-only)" if prop.is_readonly else "", prop.description))
632         data.sort()
633
634     if bpy.app.background:
635         import sys
636         sys.stderr.write("\n".join(data))
637         sys.stderr.write("\n\nEOF\n")
638     else:
639         text = bpy.data.texts.new(name="api.py")
640         text.from_string(data)