201665cfda51d366a0a66f793f6ec0413a5f0234
[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 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             self.is_enum_flag = rna_prop.is_enum_flag
204         else:
205             self.is_enum_flag = False
206
207         if self.array_length:
208             self.default = tuple(getattr(rna_prop, "default_array", ()))
209         elif self.type == "enum" and self.is_enum_flag:
210             self.default = getattr(rna_prop, "default_flag", set())
211         else:
212             self.default = getattr(rna_prop, "default", None)
213         self.default_str = ""  # fallback
214
215         if self.type == "pointer":
216             # pointer has no default, just set as None
217             self.default = None
218             self.default_str = "None"
219         elif self.type == "string":
220             self.default_str = "\"%s\"" % self.default
221         elif self.type == "enum":
222             if self.is_enum_flag:
223                 self.default_str = "%r" % self.default  # repr or set()
224             else:
225                 self.default_str = "'%s'" % self.default
226         elif self.array_length:
227             self.default_str = ''
228             # special case for floats
229             if len(self.default) > 0:
230                 if self.type == "float":
231                     self.default_str = "(%s)" % ", ".join(float_as_string(f) for f in self.default)
232             if not self.default_str:
233                 self.default_str = str(self.default)
234         else:
235             if self.type == "float":
236                 self.default_str = float_as_string(self.default)
237             else:
238                 self.default_str = str(self.default)
239
240         self.srna = GetInfoStructRNA(rna_prop.srna)  # valid for pointer/collections
241
242     def get_arg_default(self, force=True):
243         default = self.default_str
244         if default and (force or self.is_required == False):
245             return "%s=%s" % (self.identifier, default)
246         return self.identifier
247
248     def get_type_description(self, as_ret=False, as_arg=False, class_fmt="%s"):
249         type_str = ""
250         if self.fixed_type is None:
251             type_str += self.type
252             if self.array_length:
253                 type_str += " array of %d items" % (self.array_length)
254
255             if self.type in ("float", "int"):
256                 type_str += " in [%s, %s]" % (range_str(self.min), range_str(self.max))
257             elif self.type == "enum":
258                 if self.is_enum_flag:
259                     type_str += " set in {%s}" % ", ".join(("'%s'" % s) for s in self.enum_items)
260                 else:
261                     type_str += " in [%s]" % ", ".join(("'%s'" % s) for s in self.enum_items)
262
263             if not (as_arg or as_ret):
264                 # write default property, ignore function args for this
265                 if self.type != "pointer":
266                     if self.default_str:
267                         type_str += ", default %s" % self.default_str
268
269         else:
270             if self.type == "collection":
271                 if self.collection_type:
272                     collection_str = (class_fmt % self.collection_type.identifier) + " collection of "
273                 else:
274                     collection_str = "Collection of "
275             else:
276                 collection_str = ""
277
278             type_str += collection_str + (class_fmt % self.fixed_type.identifier)
279
280         # setup qualifiers for this value.
281         type_info = []
282         if as_ret:
283             pass
284         elif as_arg:
285             if not self.is_required:
286                 type_info.append("optional")
287         else:  # readonly is only useful for selfs, not args
288             if self.is_readonly:
289                 type_info.append("readonly")
290
291         if self.is_never_none:
292             type_info.append("never None")
293
294         if type_info:
295             type_str += (", (%s)" % ", ".join(type_info))
296
297         return type_str
298
299     def __str__(self):
300         txt = ''
301         txt += ' * ' + self.identifier + ': ' + self.description
302
303         return txt
304
305
306 class InfoFunctionRNA:
307     global_lookup = {}
308
309     def __init__(self, rna_func):
310         self.bl_func = rna_func
311         self.identifier = rna_func.identifier
312         # self.name = rna_func.name # functions have no name!
313         self.description = rna_func.description.strip()
314         self.is_classmethod = not rna_func.use_self
315
316         self.args = []
317         self.return_values = ()
318
319     def build(self):
320         rna_func = self.bl_func
321         parent_id = rna_func
322         self.return_values = []
323
324         for rna_prop in rna_func.parameters.values():
325             prop = GetInfoPropertyRNA(rna_prop, parent_id)
326             if rna_prop.is_output:
327                 self.return_values.append(prop)
328             else:
329                 self.args.append(prop)
330
331         self.return_values = tuple(self.return_values)
332
333     def __str__(self):
334         txt = ''
335         txt += ' * ' + self.identifier + '('
336
337         for arg in self.args:
338             txt += arg.identifier + ', '
339         txt += '): ' + self.description
340         return txt
341
342
343 class InfoOperatorRNA:
344     global_lookup = {}
345
346     def __init__(self, rna_op):
347         self.bl_op = rna_op
348         self.identifier = rna_op.identifier
349
350         mod, name = self.identifier.split("_OT_", 1)
351         self.module_name = mod.lower()
352         self.func_name = name
353
354         # self.name = rna_func.name # functions have no name!
355         self.description = rna_op.description.strip()
356
357         self.args = []
358
359     def build(self):
360         rna_op = self.bl_op
361         parent_id = self.identifier
362         for rna_id, rna_prop in rna_op.properties.items():
363             if rna_id == "rna_type":
364                 continue
365
366             prop = GetInfoPropertyRNA(rna_prop, parent_id)
367             self.args.append(prop)
368
369     def get_location(self):
370         op_class = getattr(bpy.types, self.identifier)
371         op_func = getattr(op_class, "execute", None)
372         if op_func is None:
373             op_func = getattr(op_class, "invoke", None)
374         if op_func is None:
375             op_func = getattr(op_class, "poll", None)
376
377         if op_func:
378             op_code = op_func.__code__
379             source_path = op_code.co_filename
380
381             # clear the prefix
382             for p in script_paths:
383                 source_path = source_path.split(p)[-1]
384
385             if source_path[0] in "/\\":
386                 source_path = source_path[1:]
387
388             return source_path, op_code.co_firstlineno
389         else:
390             return None, None
391
392
393 def _GetInfoRNA(bl_rna, cls, parent_id=''):
394
395     if bl_rna is None:
396         return None
397
398     key = parent_id, bl_rna.identifier
399     try:
400         return cls.global_lookup[key]
401     except KeyError:
402         instance = cls.global_lookup[key] = cls(bl_rna)
403         return instance
404
405
406 def GetInfoStructRNA(bl_rna):
407     return _GetInfoRNA(bl_rna, InfoStructRNA)
408
409
410 def GetInfoPropertyRNA(bl_rna, parent_id):
411     return _GetInfoRNA(bl_rna, InfoPropertyRNA, parent_id)
412
413
414 def GetInfoFunctionRNA(bl_rna, parent_id):
415     return _GetInfoRNA(bl_rna, InfoFunctionRNA, parent_id)
416
417
418 def GetInfoOperatorRNA(bl_rna):
419     return _GetInfoRNA(bl_rna, InfoOperatorRNA)
420
421
422 def BuildRNAInfo():
423     # Use for faster lookups
424     # use rna_struct.identifier as the key for each dict
425     rna_struct_dict = {}  # store identifier:rna lookups
426     rna_full_path_dict = {}      # store the result of full_rna_struct_path(rna_struct)
427     rna_children_dict = {}  # store all rna_structs nested from here
428     rna_references_dict = {}  # store a list of rna path strings that reference this type
429     # rna_functions_dict = {}  # store all functions directly in this type (not inherited)
430
431     def full_rna_struct_path(rna_struct):
432         '''
433         Needed when referencing one struct from another
434         '''
435         nested = rna_struct.nested
436         if nested:
437             return "%s.%s" % (full_rna_struct_path(nested), rna_struct.identifier)
438         else:
439             return rna_struct.identifier
440
441     # def write_func(rna_func, ident):
442     def base_id(rna_struct):
443         try:
444             return rna_struct.base.identifier
445         except:
446             return ""  # invalid id
447
448     #structs = [(base_id(rna_struct), rna_struct.identifier, rna_struct) for rna_struct in bpy.doc.structs.values()]
449     '''
450     structs = []
451     for rna_struct in bpy.doc.structs.values():
452         structs.append( (base_id(rna_struct), rna_struct.identifier, rna_struct) )
453     '''
454     structs = []
455     for rna_type_name in dir(bpy.types):
456         rna_type = getattr(bpy.types, rna_type_name)
457
458         rna_struct = getattr(rna_type, "bl_rna", None)
459
460         if rna_struct:
461             #if not rna_type_name.startswith('__'):
462
463             identifier = rna_struct.identifier
464
465             if not rna_id_ignore(identifier):
466                 structs.append((base_id(rna_struct), identifier, rna_struct))
467
468                 # Simple lookup
469                 rna_struct_dict[identifier] = rna_struct
470
471                 # Store full rna path 'GameObjectSettings' -> 'Object.GameObjectSettings'
472                 rna_full_path_dict[identifier] = full_rna_struct_path(rna_struct)
473
474                 # Store a list of functions, remove inherited later
475                 # NOT USED YET
476                 ## rna_functions_dict[identifier] = get_direct_functions(rna_struct)
477
478                 # fill in these later
479                 rna_children_dict[identifier] = []
480                 rna_references_dict[identifier] = []
481         else:
482             print("Ignoring", rna_type_name)
483
484     structs.sort()  # not needed but speeds up sort below, setting items without an inheritance first
485
486     # Arrange so classes are always defined in the correct order
487     deps_ok = False
488     while deps_ok == False:
489         deps_ok = True
490         rna_done = set()
491
492         for i, (rna_base, identifier, rna_struct) in enumerate(structs):
493
494             rna_done.add(identifier)
495
496             if rna_base and rna_base not in rna_done:
497                 deps_ok = False
498                 data = structs.pop(i)
499                 ok = False
500                 while i < len(structs):
501                     if structs[i][1] == rna_base:
502                         structs.insert(i + 1, data)  # insert after the item we depend on.
503                         ok = True
504                         break
505                     i += 1
506
507                 if not ok:
508                     print('Dependancy "%s" could not be found for "%s"' % (identifier, rna_base))
509
510                 break
511
512     # Done ordering structs
513
514     # precalc vars to avoid a lot of looping
515     for (rna_base, identifier, rna_struct) in structs:
516
517         # rna_struct_path = full_rna_struct_path(rna_struct)
518         rna_struct_path = rna_full_path_dict[identifier]
519
520         for rna_prop in get_direct_properties(rna_struct):
521             rna_prop_identifier = rna_prop.identifier
522
523             if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
524                 continue
525
526             for rna_prop_ptr in (getattr(rna_prop, "fixed_type", None), getattr(rna_prop, "srna", None)):
527                 # Does this property point to me?
528                 if rna_prop_ptr:
529                     rna_references_dict[rna_prop_ptr.identifier].append("%s.%s" % (rna_struct_path, rna_prop_identifier))
530
531         for rna_func in get_direct_functions(rna_struct):
532             for rna_prop_identifier, rna_prop in rna_func.parameters.items():
533
534                 if rna_prop_identifier == 'RNA' or rna_id_ignore(rna_prop_identifier):
535                     continue
536
537                 rna_prop_ptr = getattr(rna_prop, "fixed_type", None)
538
539                 # Does this property point to me?
540                 if rna_prop_ptr:
541                     rna_references_dict[rna_prop_ptr.identifier].append("%s.%s" % (rna_struct_path, rna_func.identifier))
542
543         # Store nested children
544         nested = rna_struct.nested
545         if nested:
546             rna_children_dict[nested.identifier].append(rna_struct)
547
548     # Sort the refs, just reads nicer
549     for rna_refs in rna_references_dict.values():
550         rna_refs.sort()
551
552     info_structs = []
553     for (rna_base, identifier, rna_struct) in structs:
554         #if rna_struct.nested:
555         #    continue
556
557         #write_struct(rna_struct, '')
558         info_struct = GetInfoStructRNA(rna_struct)
559         if rna_base:
560             info_struct.base = GetInfoStructRNA(rna_struct_dict[rna_base])
561         info_struct.nested = GetInfoStructRNA(rna_struct.nested)
562         info_struct.children[:] = rna_children_dict[identifier]
563         info_struct.references[:] = rna_references_dict[identifier]
564         info_struct.full_path = rna_full_path_dict[identifier]
565
566         info_structs.append(info_struct)
567
568     for rna_info_prop in InfoPropertyRNA.global_lookup.values():
569         rna_info_prop.build()
570
571     for rna_info_prop in InfoFunctionRNA.global_lookup.values():
572         rna_info_prop.build()
573
574     for rna_info in InfoStructRNA.global_lookup.values():
575         rna_info.build()
576         for prop in rna_info.properties:
577             prop.build()
578         for func in rna_info.functions:
579             func.build()
580             for prop in func.args:
581                 prop.build()
582             for prop in func.return_values:
583                 prop.build()
584
585     if 1:
586         for rna_info in InfoStructRNA.global_lookup.values():
587             for prop in rna_info.properties:
588                 # ERROR CHECK
589                 default = prop.default
590                 if type(default) in (float, int):
591                     if default < prop.min or default > prop.max:
592                         print("\t %s.%s, %s not in [%s - %s]" % (rna_info.identifier, prop.identifier, default, prop.min, prop.max))
593
594     # now for operators
595     op_mods = dir(bpy.ops)
596
597     for op_mod_name in sorted(op_mods):
598         if op_mod_name.startswith('__'):
599             continue
600
601         op_mod = getattr(bpy.ops, op_mod_name)
602         operators = dir(op_mod)
603         for op in sorted(operators):
604             try:
605                 rna_prop = getattr(op_mod, op).get_rna()
606             except AttributeError:
607                 rna_prop = None
608             except TypeError:
609                 rna_prop = None
610
611             if rna_prop:
612                 GetInfoOperatorRNA(rna_prop.bl_rna)
613
614     for rna_info in InfoOperatorRNA.global_lookup.values():
615         rna_info.build()
616         for rna_prop in rna_info.args:
617             rna_prop.build()
618
619     #for rna_info in InfoStructRNA.global_lookup.values():
620     #    print(rna_info)
621     return InfoStructRNA.global_lookup, InfoFunctionRNA.global_lookup, InfoOperatorRNA.global_lookup, InfoPropertyRNA.global_lookup
622
623
624 if __name__ == "__main__":
625     import rna_info
626     struct = rna_info.BuildRNAInfo()[0]
627     data = []
628     for struct_id, v in sorted(struct.items()):
629         struct_id_str = v.identifier  # "".join(sid for sid in struct_id if struct_id)
630
631         for base in v.get_bases():
632             struct_id_str = base.identifier + "|" + struct_id_str
633
634         props = [(prop.identifier, prop) for prop in v.properties]
635         for prop_id, prop in sorted(props):
636             # if prop.type == 'boolean':
637             #     continue
638             prop_type = prop.type
639             if prop.array_length > 0:
640                 prop_type += "[%d]" % prop.array_length
641
642             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))
643         data.sort()
644
645     if bpy.app.background:
646         import sys
647         sys.stderr.write("\n".join(data))
648         sys.stderr.write("\n\nEOF\n")
649     else:
650         text = bpy.data.texts.new(name="api.py")
651         text.from_string(data)