95020489e1ca398f981bf276e390b9c95c6d6e3c
[blender.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 def get_py_class_from_rna(rna_type):
86     """ Get's the Python type for a class which isn't necessarily added to ``bpy.types``.
87     """
88     identifier = rna_type.identifier
89     py_class = getattr(bpy.types, identifier, None)
90     if py_class is not None:
91         return py_class
92
93     def subclasses_recurse(cls):
94         for c in cls.__subclasses__():
95             # is_registered
96             if "bl_rna" in cls.__dict__:
97                 yield c
98             yield from subclasses_recurse(c)
99
100     while py_class is None:
101         base = rna_type.base
102         if base is None:
103             raise Exception("can't find type")
104         py_class_base = getattr(bpy.types, base.identifier, None)
105         if py_class_base is not None:
106             for cls in subclasses_recurse(py_class_base):
107                 if cls.bl_rna.identifier == identifier:
108                     return cls
109
110
111 class InfoStructRNA:
112     __slots__ = (
113         "bl_rna",
114         "identifier",
115         "name",
116         "description",
117         "base",
118         "nested",
119         "full_path",
120         "functions",
121         "children",
122         "references",
123         "properties",
124     )
125
126     global_lookup = {}
127
128     def __init__(self, rna_type):
129         self.bl_rna = rna_type
130
131         self.identifier = rna_type.identifier
132         self.name = rna_type.name
133         self.description = rna_type.description.strip()
134
135         # set later
136         self.base = None
137         self.nested = None
138         self.full_path = ""
139
140         self.functions = []
141         self.children = []
142         self.references = []
143         self.properties = []
144
145     def build(self):
146         rna_type = self.bl_rna
147         parent_id = self.identifier
148         self.properties[:] = [GetInfoPropertyRNA(rna_prop, parent_id)
149                               for rna_prop in get_direct_properties(rna_type) if rna_prop.identifier != "rna_type"]
150         self.functions[:] = [GetInfoFunctionRNA(rna_prop, parent_id)
151                              for rna_prop in get_direct_functions(rna_type)]
152
153     def get_bases(self):
154         bases = []
155         item = self
156
157         while item:
158             item = item.base
159             if item:
160                 bases.append(item)
161
162         return bases
163
164     def get_nested_properties(self, ls=None):
165         if not ls:
166             ls = self.properties[:]
167
168         if self.nested:
169             self.nested.get_nested_properties(ls)
170
171         return ls
172
173     def _get_py_visible_attrs(self):
174         attrs = []
175         py_class = get_py_class_from_rna(self.bl_rna)
176
177         for attr_str in dir(py_class):
178             if attr_str.startswith("_"):
179                 continue
180             attrs.append((attr_str, getattr(py_class, attr_str)))
181         return attrs
182
183     def get_py_properties(self):
184         properties = []
185         for identifier, attr in self._get_py_visible_attrs():
186             if type(attr) is property:
187                 properties.append((identifier, attr))
188         return properties
189
190     def get_py_functions(self):
191         import types
192         functions = []
193         for identifier, attr in self._get_py_visible_attrs():
194             # methods may be python wrappers to C functions
195             attr_func = getattr(attr, "__func__", attr)
196             if type(attr_func) in {types.FunctionType, types.MethodType}:
197                 functions.append((identifier, attr))
198         return functions
199
200     def get_py_c_functions(self):
201         import types
202         functions = []
203         for identifier, attr in self._get_py_visible_attrs():
204             # methods may be python wrappers to C functions
205             attr_func = getattr(attr, "__func__", attr)
206             if type(attr_func) in {types.BuiltinMethodType, types.BuiltinFunctionType}:
207                 functions.append((identifier, attr))
208         return functions
209
210     def __str__(self):
211
212         txt = ""
213         txt += self.identifier
214         if self.base:
215             txt += "(%s)" % self.base.identifier
216         txt += ": " + self.description + "\n"
217
218         for prop in self.properties:
219             txt += prop.__repr__() + "\n"
220
221         for func in self.functions:
222             txt += func.__repr__() + "\n"
223
224         return txt
225
226
227 class InfoPropertyRNA:
228     __slots__ = (
229         "bl_prop",
230         "srna",
231         "identifier",
232         "name",
233         "description",
234         "default_str",
235         "default",
236         "enum_items",
237         "min",
238         "max",
239         "array_length",
240         "collection_type",
241         "type",
242         "fixed_type",
243         "is_argument_optional",
244         "is_enum_flag",
245         "is_required",
246         "is_readonly",
247         "is_never_none",
248     )
249     global_lookup = {}
250
251     def __init__(self, rna_prop):
252         self.bl_prop = rna_prop
253         self.identifier = rna_prop.identifier
254         self.name = rna_prop.name
255         self.description = rna_prop.description.strip()
256         self.default_str = "<UNKNOWN>"
257
258     def build(self):
259         rna_prop = self.bl_prop
260
261         self.enum_items = []
262         self.min = getattr(rna_prop, "hard_min", -1)
263         self.max = getattr(rna_prop, "hard_max", -1)
264         self.array_length = getattr(rna_prop, "array_length", 0)
265         self.collection_type = GetInfoStructRNA(rna_prop.srna)
266         self.is_required = rna_prop.is_required
267         self.is_readonly = rna_prop.is_readonly
268         self.is_never_none = rna_prop.is_never_none
269         self.is_argument_optional = rna_prop.is_argument_optional
270
271         self.type = rna_prop.type.lower()
272         fixed_type = getattr(rna_prop, "fixed_type", "")
273         if fixed_type:
274             self.fixed_type = GetInfoStructRNA(fixed_type)  # valid for pointer/collections
275         else:
276             self.fixed_type = None
277
278         if self.type == "enum":
279             self.enum_items[:] = [(item.identifier, item.name, item.description) for item in rna_prop.enum_items]
280             self.is_enum_flag = rna_prop.is_enum_flag
281         else:
282             self.is_enum_flag = False
283
284         if self.array_length:
285             self.default = tuple(getattr(rna_prop, "default_array", ()))
286         elif self.type == "enum" and self.is_enum_flag:
287             self.default = getattr(rna_prop, "default_flag", set())
288         else:
289             self.default = getattr(rna_prop, "default", None)
290         self.default_str = ""  # fallback
291
292         if self.type == "pointer":
293             # pointer has no default, just set as None
294             self.default = None
295             self.default_str = "None"
296         elif self.type == "string":
297             self.default_str = "\"%s\"" % self.default
298         elif self.type == "enum":
299             if self.is_enum_flag:
300                 # self.default_str = "%r" % self.default  # repr or set()
301                 self.default_str = "{%s}" % repr(list(sorted(self.default)))[1:-1]
302             else:
303                 self.default_str = "'%s'" % self.default
304         elif self.array_length:
305             self.default_str = ''
306             # special case for floats
307             if len(self.default) > 0:
308                 if self.type == "float":
309                     self.default_str = "(%s)" % ", ".join(float_as_string(f) for f in self.default)
310             if not self.default_str:
311                 self.default_str = str(self.default)
312         else:
313             if self.type == "float":
314                 self.default_str = float_as_string(self.default)
315             else:
316                 self.default_str = str(self.default)
317
318         self.srna = GetInfoStructRNA(rna_prop.srna)  # valid for pointer/collections
319
320     def get_arg_default(self, force=True):
321         default = self.default_str
322         if default and (force or self.is_required is False):
323             return "%s=%s" % (self.identifier, default)
324         return self.identifier
325
326     def get_type_description(self, as_ret=False, as_arg=False, class_fmt="%s", collection_id="Collection"):
327         type_str = ""
328         if self.fixed_type is None:
329             type_str += self.type
330             if self.array_length:
331                 type_str += " array of %d items" % (self.array_length)
332
333             if self.type in {"float", "int"}:
334                 type_str += " in [%s, %s]" % (range_str(self.min), range_str(self.max))
335             elif self.type == "enum":
336                 if self.is_enum_flag:
337                     type_str += " set in {%s}" % ", ".join(("'%s'" % s[0]) for s in self.enum_items)
338                 else:
339                     type_str += " in [%s]" % ", ".join(("'%s'" % s[0]) for s in self.enum_items)
340
341             if not (as_arg or as_ret):
342                 # write default property, ignore function args for this
343                 if self.type != "pointer":
344                     if self.default_str:
345                         type_str += ", default %s" % self.default_str
346
347         else:
348             if self.type == "collection":
349                 if self.collection_type:
350                     collection_str = (class_fmt % self.collection_type.identifier) + (" %s of " % collection_id)
351                 else:
352                     collection_str = "%s of " % collection_id
353             else:
354                 collection_str = ""
355
356             type_str += collection_str + (class_fmt % self.fixed_type.identifier)
357
358         # setup qualifiers for this value.
359         type_info = []
360         if as_ret:
361             pass
362         elif as_arg:
363             if not self.is_required:
364                 type_info.append("optional")
365             if self.is_argument_optional:
366                 type_info.append("optional argument")
367         else:  # readonly is only useful for self's, not args
368             if self.is_readonly:
369                 type_info.append("readonly")
370
371         if self.is_never_none:
372             type_info.append("never None")
373
374         if type_info:
375             type_str += (", (%s)" % ", ".join(type_info))
376
377         return type_str
378
379     def __str__(self):
380         txt = ""
381         txt += " * " + self.identifier + ": " + self.description
382
383         return txt
384
385
386 class InfoFunctionRNA:
387     __slots__ = (
388         "bl_func",
389         "identifier",
390         "description",
391         "args",
392         "return_values",
393         "is_classmethod",
394     )
395     global_lookup = {}
396
397     def __init__(self, rna_func):
398         self.bl_func = rna_func
399         self.identifier = rna_func.identifier
400         # self.name = rna_func.name # functions have no name!
401         self.description = rna_func.description.strip()
402         self.is_classmethod = not rna_func.use_self
403
404         self.args = []
405         self.return_values = ()
406
407     def build(self):
408         rna_func = self.bl_func
409         parent_id = rna_func
410         self.return_values = []
411
412         for rna_prop in rna_func.parameters.values():
413             prop = GetInfoPropertyRNA(rna_prop, parent_id)
414             if rna_prop.is_output:
415                 self.return_values.append(prop)
416             else:
417                 self.args.append(prop)
418
419         self.return_values = tuple(self.return_values)
420
421     def __str__(self):
422         txt = ''
423         txt += ' * ' + self.identifier + '('
424
425         for arg in self.args:
426             txt += arg.identifier + ', '
427         txt += '): ' + self.description
428         return txt
429
430
431 class InfoOperatorRNA:
432     __slots__ = (
433         "bl_op",
434         "identifier",
435         "name",
436         "module_name",
437         "func_name",
438         "description",
439         "args",
440     )
441     global_lookup = {}
442
443     def __init__(self, rna_op):
444         self.bl_op = rna_op
445         self.identifier = rna_op.identifier
446
447         mod, name = self.identifier.split("_OT_", 1)
448         self.module_name = mod.lower()
449         self.func_name = name
450
451         # self.name = rna_func.name # functions have no name!
452         self.description = rna_op.description.strip()
453
454         self.args = []
455
456     def build(self):
457         rna_op = self.bl_op
458         parent_id = self.identifier
459         for rna_id, rna_prop in rna_op.properties.items():
460             if rna_id == "rna_type":
461                 continue
462
463             prop = GetInfoPropertyRNA(rna_prop, parent_id)
464             self.args.append(prop)
465
466     def get_location(self):
467         try:
468             op_class = getattr(bpy.types, self.identifier)
469         except AttributeError:
470             # defined in C.
471             return None, None
472         op_func = getattr(op_class, "execute", None)
473         if op_func is None:
474             op_func = getattr(op_class, "invoke", None)
475         if op_func is None:
476             op_func = getattr(op_class, "poll", None)
477
478         if op_func:
479             op_code = op_func.__code__
480             source_path = op_code.co_filename
481
482             # clear the prefix
483             for p in script_paths:
484                 source_path = source_path.split(p)[-1]
485
486             if source_path[0] in "/\\":
487                 source_path = source_path[1:]
488
489             return source_path, op_code.co_firstlineno
490         else:
491             return None, None
492
493
494 def _GetInfoRNA(bl_rna, cls, parent_id=""):
495
496     if bl_rna is None:
497         return None
498
499     key = parent_id, bl_rna.identifier
500     try:
501         return cls.global_lookup[key]
502     except KeyError:
503         instance = cls.global_lookup[key] = cls(bl_rna)
504         return instance
505
506
507 def GetInfoStructRNA(bl_rna):
508     return _GetInfoRNA(bl_rna, InfoStructRNA)
509
510
511 def GetInfoPropertyRNA(bl_rna, parent_id):
512     return _GetInfoRNA(bl_rna, InfoPropertyRNA, parent_id)
513
514
515 def GetInfoFunctionRNA(bl_rna, parent_id):
516     return _GetInfoRNA(bl_rna, InfoFunctionRNA, parent_id)
517
518
519 def GetInfoOperatorRNA(bl_rna):
520     return _GetInfoRNA(bl_rna, InfoOperatorRNA)
521
522
523 def BuildRNAInfo():
524
525     # needed on successive calls to prevent stale data access
526     for cls in (InfoStructRNA, InfoFunctionRNA, InfoOperatorRNA, InfoPropertyRNA):
527         cls.global_lookup.clear()
528     del cls
529
530     # Use for faster lookups
531     # use rna_struct.identifier as the key for each dict
532     rna_struct_dict = {}  # store identifier:rna lookups
533     rna_full_path_dict = {}      # store the result of full_rna_struct_path(rna_struct)
534     rna_children_dict = {}  # store all rna_structs nested from here
535     rna_references_dict = {}  # store a list of rna path strings that reference this type
536     # rna_functions_dict = {}  # store all functions directly in this type (not inherited)
537
538     def full_rna_struct_path(rna_struct):
539         """
540         Needed when referencing one struct from another
541         """
542         nested = rna_struct.nested
543         if nested:
544             return "%s.%s" % (full_rna_struct_path(nested), rna_struct.identifier)
545         else:
546             return rna_struct.identifier
547
548     # def write_func(rna_func, ident):
549     def base_id(rna_struct):
550         try:
551             return rna_struct.base.identifier
552         except:
553             return ""  # invalid id
554
555     #structs = [(base_id(rna_struct), rna_struct.identifier, rna_struct) for rna_struct in bpy.doc.structs.values()]
556     '''
557     structs = []
558     for rna_struct in bpy.doc.structs.values():
559         structs.append( (base_id(rna_struct), rna_struct.identifier, rna_struct) )
560     '''
561     structs = []
562     for rna_type_name in dir(bpy.types):
563         rna_type = getattr(bpy.types, rna_type_name)
564
565         rna_struct = getattr(rna_type, "bl_rna", None)
566
567         if rna_struct:
568             # if not rna_type_name.startswith('__'):
569
570             identifier = rna_struct.identifier
571
572             if not rna_id_ignore(identifier):
573                 structs.append((base_id(rna_struct), identifier, rna_struct))
574
575                 # Simple lookup
576                 rna_struct_dict[identifier] = rna_struct
577
578                 # Store full rna path 'GameObjectSettings' -> 'Object.GameObjectSettings'
579                 rna_full_path_dict[identifier] = full_rna_struct_path(rna_struct)
580
581                 # Store a list of functions, remove inherited later
582                 # NOT USED YET
583                 ## rna_functions_dict[identifier] = get_direct_functions(rna_struct)
584
585                 # fill in these later
586                 rna_children_dict[identifier] = []
587                 rna_references_dict[identifier] = []
588         else:
589             print("Ignoring", rna_type_name)
590
591     structs.sort()  # not needed but speeds up sort below, setting items without an inheritance first
592
593     # Arrange so classes are always defined in the correct order
594     deps_ok = False
595     while deps_ok is False:
596         deps_ok = True
597         rna_done = set()
598
599         for i, (rna_base, identifier, rna_struct) in enumerate(structs):
600
601             rna_done.add(identifier)
602
603             if rna_base and rna_base not in rna_done:
604                 deps_ok = False
605                 data = structs.pop(i)
606                 ok = False
607                 while i < len(structs):
608                     if structs[i][1] == rna_base:
609                         structs.insert(i + 1, data)  # insert after the item we depend on.
610                         ok = True
611                         break
612                     i += 1
613
614                 if not ok:
615                     print('Dependancy "%s" could not be found for "%s"' % (identifier, rna_base))
616
617                 break
618
619     # Done ordering structs
620
621     # precalculate vars to avoid a lot of looping
622     for (rna_base, identifier, rna_struct) in structs:
623
624         # rna_struct_path = full_rna_struct_path(rna_struct)
625         rna_struct_path = rna_full_path_dict[identifier]
626
627         for rna_prop in get_direct_properties(rna_struct):
628             rna_prop_identifier = rna_prop.identifier
629
630             if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
631                 continue
632
633             for rna_prop_ptr in (getattr(rna_prop, "fixed_type", None), getattr(rna_prop, "srna", None)):
634                 # Does this property point to me?
635                 if rna_prop_ptr and rna_prop_ptr.identifier in rna_references_dict:
636                     rna_references_dict[rna_prop_ptr.identifier].append(
637                         "%s.%s" % (rna_struct_path, rna_prop_identifier))
638
639         for rna_func in get_direct_functions(rna_struct):
640             for rna_prop_identifier, rna_prop in rna_func.parameters.items():
641
642                 if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
643                     continue
644
645                 rna_prop_ptr = getattr(rna_prop, "fixed_type", None)
646
647                 # Does this property point to me?
648                 if rna_prop_ptr and rna_prop_ptr.identifier in rna_references_dict:
649                     rna_references_dict[rna_prop_ptr.identifier].append(
650                         "%s.%s" % (rna_struct_path, rna_func.identifier))
651
652         # Store nested children
653         nested = rna_struct.nested
654         if nested:
655             rna_children_dict[nested.identifier].append(rna_struct)
656
657     # Sort the refs, just reads nicer
658     for rna_refs in rna_references_dict.values():
659         rna_refs.sort()
660
661     info_structs = []
662     for (rna_base, identifier, rna_struct) in structs:
663         # if rna_struct.nested:
664         #     continue
665
666         #write_struct(rna_struct, '')
667         info_struct = GetInfoStructRNA(rna_struct)
668         if rna_base:
669             info_struct.base = GetInfoStructRNA(rna_struct_dict[rna_base])
670         info_struct.nested = GetInfoStructRNA(rna_struct.nested)
671         info_struct.children[:] = rna_children_dict[identifier]
672         info_struct.references[:] = rna_references_dict[identifier]
673         info_struct.full_path = rna_full_path_dict[identifier]
674
675         info_structs.append(info_struct)
676
677     for rna_info_prop in InfoPropertyRNA.global_lookup.values():
678         rna_info_prop.build()
679
680     for rna_info_prop in InfoFunctionRNA.global_lookup.values():
681         rna_info_prop.build()
682
683     done_keys = set()
684     new_keys = set(InfoStructRNA.global_lookup.keys())
685     while new_keys:
686         for rna_key in new_keys:
687             rna_info = InfoStructRNA.global_lookup[rna_key]
688             rna_info.build()
689             for prop in rna_info.properties:
690                 prop.build()
691             for func in rna_info.functions:
692                 func.build()
693                 for prop in func.args:
694                     prop.build()
695                 for prop in func.return_values:
696                     prop.build()
697         done_keys |= new_keys
698         new_keys = set(InfoStructRNA.global_lookup.keys()) - done_keys
699
700     # there are too many invalid defaults, unless we intend to fix, leave this off
701     if 0:
702         for rna_info in InfoStructRNA.global_lookup.values():
703             for prop in rna_info.properties:
704                 # ERROR CHECK
705                 default = prop.default
706                 if type(default) in {float, int}:
707                     if default < prop.min or default > prop.max:
708                         print("\t %s.%s, %s not in [%s - %s]" %
709                               (rna_info.identifier, prop.identifier, default, prop.min, prop.max))
710
711     # now for operators
712     op_mods = dir(bpy.ops)
713
714     for op_mod_name in sorted(op_mods):
715         if op_mod_name.startswith('__'):
716             continue
717
718         op_mod = getattr(bpy.ops, op_mod_name)
719         operators = dir(op_mod)
720         for op in sorted(operators):
721             try:
722                 rna_prop = getattr(op_mod, op).get_rna()
723             except AttributeError:
724                 rna_prop = None
725             except TypeError:
726                 rna_prop = None
727
728             if rna_prop:
729                 GetInfoOperatorRNA(rna_prop.bl_rna)
730
731     for rna_info in InfoOperatorRNA.global_lookup.values():
732         rna_info.build()
733         for rna_prop in rna_info.args:
734             rna_prop.build()
735
736     # for rna_info in InfoStructRNA.global_lookup.values():
737     #     print(rna_info)
738     return InfoStructRNA.global_lookup, InfoFunctionRNA.global_lookup, InfoOperatorRNA.global_lookup, InfoPropertyRNA.global_lookup
739
740
741 def main():
742     import rna_info
743     struct = rna_info.BuildRNAInfo()[0]
744     data = []
745     for struct_id, v in sorted(struct.items()):
746         struct_id_str = v.identifier  # "".join(sid for sid in struct_id if struct_id)
747
748         for base in v.get_bases():
749             struct_id_str = base.identifier + "|" + struct_id_str
750
751         props = [(prop.identifier, prop) for prop in v.properties]
752         for prop_id, prop in sorted(props):
753             # if prop.type == "boolean":
754             #     continue
755             prop_type = prop.type
756             if prop.array_length > 0:
757                 prop_type += "[%d]" % prop.array_length
758
759             data.append(
760                 "%s.%s -> %s:    %s%s    %s" %
761                 (struct_id_str, prop.identifier, prop.identifier, prop_type,
762                  ", (read-only)" if prop.is_readonly else "", prop.description))
763         data.sort()
764
765     if bpy.app.background:
766         import sys
767         sys.stderr.write("\n".join(data))
768         sys.stderr.write("\n\nEOF\n")
769     else:
770         text = bpy.data.texts.new(name="api.py")
771         text.from_string(data)
772
773
774 if __name__ == "__main__":
775     main()