2 # GObject-Introspection - a framework for introspecting GObject libraries
3 # Copyright (C) 2008 Johan Dahlin
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 from ctypes.util import find_library
26 from . import cgobject
27 from .ast import (Callback, Enum, Function, Member, Namespace, Parameter,
28 Sequence, Property, Return, Struct, Type, Alias,
29 Union, type_name_from_ctype)
30 from .transformer import Names
31 from .glibast import (GLibBoxed, GLibEnum, GLibEnumMember, GLibFlags,
32 GLibInterface, GLibObject, GLibSignal, GLibBoxedStruct,
33 GLibBoxedUnion, GLibBoxedOther, type_names)
34 from .utils import extract_libtool, to_underscores, to_underscores_noprefix
38 # These ones break GError conventions
39 'g_simple_async_result_new_from_error',
40 'g_simple_async_result_set_from_error',
41 'g_simple_async_result_propagate_error',
42 'g_simple_async_result_report_error_in_idle',
43 'gtk_print_operation_get_error',
46 SYMBOL_BLACKLIST_RE = [re.compile(x) for x in \
47 [r'\w+_marshal_[A-Z]+__', ]]
50 class Unresolved(object):
52 def __init__(self, target):
56 class UnknownTypeError(Exception):
60 class GLibTransformer(object):
62 def __init__(self, transformer, noclosure=False):
63 self._transformer = transformer
64 self._namespace_name = None
66 self._uscore_type_names = {}
68 self._failed_types = {}
69 self._boxed_types = {}
70 self._private_internal_types = {}
71 self._noclosure = noclosure
72 self._validating = False
76 def add_library(self, libname):
78 libtool_libname = 'lib' + libname + '.la'
79 if os.path.exists(libtool_libname):
80 found_libname = extract_libtool(libtool_libname)
81 elif libname.endswith('.la'):
82 found_libname = extract_libtool(libname)
84 found_libname = find_library(libname)
86 raise ValueError("Failed to find library: %r" % (libname, ))
87 self._libraries.append(ctypes.cdll.LoadLibrary(found_libname))
89 def _print_statistics(self):
90 nodes = list(self._names.names.itervalues())
92 def count_type(otype):
93 return len([x for x in nodes
94 if isinstance(x[1], otype)])
95 objectcount = count_type(GLibObject)
96 ifacecount = count_type(GLibInterface)
97 enumcount = count_type(GLibEnum)
98 print " %d nodes; %d objects, %d interfaces, %d enumsr" \
99 % (len(nodes), objectcount, ifacecount, enumcount)
102 namespace = self._transformer.parse()
103 self._namespace_name = namespace.name
105 # First pass: parsing
106 for node in namespace.nodes:
107 self._parse_node(node)
109 # Introspection is done from within parsing
111 # Second pass: pair boxed structures
112 for boxed in self._boxed_types.itervalues():
113 self._pair_boxed_type(boxed)
114 # Third pass: delete class structures, resolve
115 # all types we now know about
116 nodes = list(self._names.names.itervalues())
117 for (ns, node) in nodes:
119 self._resolve_node(node)
121 print "WARNING: DELETING node %s: %s" % (node.name, e)
122 self._remove_attribute(node.name)
123 # associate GtkButtonClass with GtkButton
124 if isinstance(node, Struct):
125 self._pair_class_struct(node)
126 for (ns, alias) in self._names.aliases.itervalues():
127 self._resolve_alias(alias)
129 self._print_statistics()
130 # Fourth pass: ensure all types are known
131 if not self._noclosure:
132 self._validate(nodes)
134 # Create a new namespace with what we found
135 namespace = Namespace(namespace.name)
136 namespace.nodes = map(lambda x: x[1], self._names.aliases.itervalues())
137 for (ns, x) in self._names.names.itervalues():
138 namespace.nodes.append(x)
143 def _add_attribute(self, node, replace=False):
144 node_name = node.name
145 if (not replace) and node_name in self._names.names:
147 self._names.names[node_name] = (None, node)
149 def _remove_attribute(self, name):
150 del self._names.names[name]
152 def _get_attribute(self, name):
153 node = self._names.names.get(name)
158 def _register_internal_type(self, type_name, node):
159 self._names.type_names[type_name] = (None, node)
160 uscored = to_underscores(type_name).lower()
161 self._uscore_type_names[uscored] = node
162 # Besides the straight underscore conversion, we also try
163 # removing the underscores from the namespace as a possible C
164 # mapping; e.g. it's webkit_web_view, not web_kit_web_view
165 suffix = self._transformer.strip_namespace_object(type_name)
166 prefix = type_name[:-len(suffix)]
167 no_uscore_prefixed = (prefix + '_' + to_underscores(suffix)).lower()
168 self._uscore_type_names[no_uscore_prefixed] = node
172 def _type_from_gtype(self, type_id):
173 ctype = cgobject.type_name(type_id)
174 type_name = type_name_from_ctype(ctype)
175 type_name = type_name.replace('*', '')
176 type_name = self._resolve_type_name(type_name)
177 return Type(type_name, ctype)
179 def _resolve_gtypename(self, gtype_name):
181 return self._transformer.gtypename_to_giname(gtype_name,
184 return Unresolved(gtype_name)
186 def _create_gobject(self, node):
187 type_name = 'G' + node.name
188 if type_name == 'GObject':
192 type_id = cgobject.type_from_name(type_name)
193 parent_type_name = cgobject.type_name(
194 cgobject.type_parent(type_id))
195 parent_gitype = self._resolve_gtypename(parent_type_name)
196 symbol = to_underscores(type_name).lower() + '_get_type'
197 node = GLibObject(node.name, parent_gitype, type_name, symbol)
198 type_id = cgobject.TYPE_OBJECT
199 self._introspect_properties(node, type_id)
200 self._introspect_signals(node, type_id)
201 self._add_attribute(node)
202 self._register_internal_type(type_name, node)
206 def _parse_node(self, node):
207 if isinstance(node, Enum):
208 self._parse_enum(node)
209 elif isinstance(node, Function):
210 self._parse_function(node)
211 elif isinstance(node, Struct):
212 self._parse_struct(node)
213 elif isinstance(node, Callback):
214 self._parse_callback(node)
215 elif isinstance(node, Alias):
216 self._parse_alias(node)
217 elif isinstance(node, Member):
218 # FIXME: atk_misc_instance singletons
220 elif isinstance(node, Union):
221 self._parse_union(node)
223 print 'GLIB Transformer: Unhandled node:', node
225 def _parse_alias(self, alias):
226 self._names.aliases[alias.name] = (None, alias)
228 def _parse_enum(self, enum):
229 self._add_attribute(enum)
231 def _parse_function(self, func):
232 if func.symbol in SYMBOL_BLACKLIST:
234 if func.symbol.startswith('_'):
236 for regexp in SYMBOL_BLACKLIST_RE:
237 if regexp.match(func.symbol):
239 if self._parse_get_type_function(func):
242 self._add_attribute(func)
244 def _parse_get_type_function(self, func):
246 if not symbol.endswith('_get_type'):
248 if self._namespace_name == 'GLib':
249 # No GObjects in GLib
251 # GType *_get_type(void)
252 # This is a bit fishy, why do we need all these aliases?
253 if func.retval.type.name not in ['Type',
259 print ("Warning: *_get_type function returns '%r'"
260 ", not GObject.Type") % (func.retval.type.name, )
265 if not self._libraries:
266 print "Warning: No libraries loaded, cannot call %s" % (symbol, )
269 for library in self._libraries:
271 func = getattr(library, symbol)
273 except AttributeError:
276 print 'Warning: could not find symbol: %s' % symbol
277 name = symbol.replace('_get_type', '')
278 self._failed_types[name] = True
281 func.restype = cgobject.GType
284 self._introspect_type(type_id, symbol)
287 def _name_is_internal_gtype(self, giname):
289 node = self._get_attribute(giname)
290 return isinstance(node, (GLibObject, GLibInterface,
291 GLibEnum, GLibFlags))
295 def _parse_method(self, func):
296 if not func.parameters:
298 return self._parse_method_common(func, True)
300 def _parse_constructor(self, func):
301 return self._parse_method_common(func, False)
303 def _parse_method_common(self, func, is_method):
304 # Skip _get_type functions, we processed them
306 if func.symbol.endswith('_get_type'):
308 if self._namespace_name == 'GLib':
309 # No GObjects in GLib
313 target_arg = func.retval
315 target_arg = func.parameters[0]
316 target_arg.type = self._resolve_param_type(target_arg.type)
319 # Methods require their first arg to be a known class
320 # Look at the original C type (before namespace stripping), without
321 # pointers: GtkButton -> gtk_button_, so we can figure out the
323 argtype = target_arg.type.ctype.replace('*', '')
324 name = self._transformer.strip_namespace_object(argtype)
325 name_uscore = to_underscores_noprefix(name).lower()
326 name_offset = func.symbol.find(name_uscore)
329 prefix = func.symbol[:name_offset+len(name_uscore)]
331 # Constructors must have _new
332 # Take everything before that as class name
333 new_idx = func.symbol.find('_new')
336 # Constructors don't return basic types
337 derefed = self._transformer.follow_aliases(target_arg.type.name,
339 if derefed in type_names:
340 #print "NOTE: Rejecting constructor returning basic: %r" \
343 prefix = func.symbol[:new_idx]
347 def valid_matching_klass(tclass):
350 elif isinstance(klass, (GLibEnum, GLibFlags)):
352 elif not isinstance(tclass, (GLibObject, GLibBoxed,
358 klass = self._uscore_type_names.get(prefix)
360 #print "NOTE: No valid matching class for likely "+\
361 # "method or constructor: %r" % (func.symbol, )
363 # Enums can't have ctors or methods
364 if isinstance(klass, (GLibEnum, GLibFlags)):
367 # The _uscore_type_names member holds the plain GLibBoxed
368 # object; we want to actually use the struct/record associated
369 if isinstance(klass, GLibBoxed):
370 name = self._transformer.strip_namespace_object(klass.type_name)
371 klass = self._get_attribute(name)
374 # Interfaces can't have constructors, punt to global scope
375 if isinstance(klass, (GLibInterface, GLibBoxed)):
376 #print "NOTE: Rejecting constructor for"+\
377 # " interface type: %r" % (func.symbol, )
379 # TODO - check that the return type is a subclass of the
380 # class from the prefix
381 # But for now, ensure that constructor returns are always
382 # the most concrete class
383 func.retval.type = Type(klass.name, klass.ctype+'*')
385 self._remove_attribute(func.name)
386 # Strip namespace and object prefix: gtk_window_new -> new
387 func.name = func.symbol[len(prefix)+1:]
389 klass.methods.append(func)
391 klass.constructors.append(func)
394 def _parse_struct(self, struct):
395 # This is a hack, but GObject is a rather fundamental piece so.
396 internal_names = ["Object", 'InitiallyUnowned']
397 g_internal_names = ["G" + x for x in internal_names]
398 if (self._namespace_name == 'GObject' and
399 struct.name in internal_names):
400 self._create_gobject(struct)
402 elif struct.name in g_internal_names:
405 node = self._names.names.get(struct.name)
407 self._add_attribute(struct, replace=True)
410 node.fields = struct.fields[:]
412 def _parse_union(self, union):
413 node = self._names.names.get(union.name)
415 self._add_attribute(union, replace=True)
418 node.fields = union.fields[:]
420 def _parse_callback(self, callback):
421 self._add_attribute(callback)
423 def _strip_class_suffix(self, name):
424 if (name.endswith('Class') or
425 name.endswith('Iface')):
427 elif name.endswith('Interface'):
432 def _arg_is_failed(self, param):
433 ctype = self._transformer.ctype_of(param).replace('*', '')
434 uscored = to_underscores(self._strip_class_suffix(ctype)).lower()
435 if uscored in self._failed_types:
436 print "Warning: failed type: %r" % (param, )
440 def _pair_class_struct(self, maybe_class):
441 name = self._strip_class_suffix(maybe_class.name)
442 if name == maybe_class.name:
445 if self._arg_is_failed(maybe_class):
446 print "WARNING: deleting no-type %r" % (maybe_class.name, )
447 del self._names.names[maybe_class.name]
450 name = self._resolve_type_name(name)
451 resolved = self._transformer.strip_namespace_object(name)
452 pair_class = self._get_attribute(resolved)
453 if pair_class and isinstance(pair_class,
454 (GLibObject, GLibInterface)):
455 for field in maybe_class.fields[1:]:
456 pair_class.fields.append(field)
458 name = self._transformer.strip_namespace_object(maybe_class.name)
459 pair_class = self._get_attribute(name)
460 if pair_class and isinstance(pair_class,
461 (GLibObject, GLibInterface)):
463 del self._names.names[maybe_class.name]
467 def _introspect_type(self, type_id, symbol):
468 fundamental_type_id = cgobject.type_fundamental(type_id)
469 if (fundamental_type_id == cgobject.TYPE_ENUM or
470 fundamental_type_id == cgobject.TYPE_FLAGS):
471 self._introspect_enum(fundamental_type_id, type_id, symbol)
472 elif fundamental_type_id == cgobject.TYPE_OBJECT:
473 self._introspect_object(type_id, symbol)
474 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
475 self._introspect_interface(type_id, symbol)
476 elif fundamental_type_id == cgobject.TYPE_BOXED:
477 self._introspect_boxed(type_id, symbol)
478 elif fundamental_type_id == cgobject.TYPE_BOXED:
479 self._introspect_boxed(type_id, symbol)
480 elif fundamental_type_id == cgobject.TYPE_POINTER:
481 # FIXME: Should we do something about these?
482 # GHashTable, GValue and a few other fundamentals are
486 print 'unhandled GType: %s(%d)' % (cgobject.type_name(type_id),
489 def _introspect_enum(self, ftype_id, type_id, symbol):
490 type_class = cgobject.type_class_ref(type_id)
491 if type_class is None:
495 for enum_value in type_class.get_values():
496 members.append(GLibEnumMember(enum_value.value_nick,
498 enum_value.value_name,
499 enum_value.value_nick))
501 klass = (GLibFlags if ftype_id == cgobject.TYPE_FLAGS else GLibEnum)
502 type_name = cgobject.type_name(type_id)
503 enum_name = self._transformer.strip_namespace_object(type_name)
504 node = klass(enum_name, type_name, members, symbol)
505 self._add_attribute(node, replace=True)
506 self._register_internal_type(type_name, node)
508 def _introspect_object(self, type_id, symbol):
509 type_name = cgobject.type_name(type_id)
510 # We handle this specially above; in 2.16 and below there
511 # was no g_object_get_type, for later versions we need
513 if type_name == 'GObject':
515 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
516 parent_gitype = self._resolve_gtypename(parent_type_name)
518 self._transformer.strip_namespace_object(type_name),
521 self._introspect_properties(node, type_id)
522 self._introspect_signals(node, type_id)
523 self._introspect_implemented_interfaces(node, type_id)
524 self._add_attribute(node, replace=True)
525 self._register_internal_type(type_name, node)
527 def _introspect_interface(self, type_id, symbol):
528 type_name = cgobject.type_name(type_id)
529 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
530 if parent_type_name == 'GInterface':
533 parent_gitype = self._resolve_gtypename(parent_type_name)
534 node = GLibInterface(
535 self._transformer.strip_namespace_object(type_name),
538 self._introspect_properties(node, type_id)
539 self._introspect_signals(node, type_id)
540 # GtkFileChooserEmbed is an example of a private interface, we
541 # just filter them out
542 if symbol.startswith('_'):
543 print "NOTICE: Marking %s as internal type" % (type_name, )
544 self._private_internal_types[type_name] = node
546 self._add_attribute(node, replace=True)
547 self._register_internal_type(type_name, node)
549 def _introspect_boxed(self, type_id, symbol):
550 type_name = cgobject.type_name(type_id)
551 # This one doesn't go in the main namespace; we associate it with
552 # the struct or union
553 node = GLibBoxed(type_name, symbol)
554 self._boxed_types[node.type_name] = node
555 self._register_internal_type(type_name, node)
557 def _introspect_implemented_interfaces(self, node, type_id):
558 fundamental_type_id = cgobject.type_fundamental(type_id)
559 if fundamental_type_id != cgobject.TYPE_OBJECT:
561 interfaces = cgobject.type_interfaces(type_id)
563 for interface_typeid in interfaces:
564 iname = cgobject.type_name(interface_typeid)
565 gitype = self._resolve_gtypename(iname)
566 gt_interfaces.append(gitype)
567 node.interfaces = gt_interfaces
569 def _introspect_properties(self, node, type_id):
570 fundamental_type_id = cgobject.type_fundamental(type_id)
571 if fundamental_type_id == cgobject.TYPE_OBJECT:
572 pspecs = cgobject.object_class_list_properties(type_id)
573 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
574 pspecs = cgobject.object_interface_list_properties(type_id)
579 if pspec.owner_type != type_id:
581 ctype = cgobject.type_name(pspec.value_type)
582 readable = (pspec.flags & 1) != 0
583 writable = (pspec.flags & 2) != 0
584 construct = (pspec.flags & 4) != 0
585 construct_only = (pspec.flags & 8) != 0
586 node.properties.append(Property(
588 type_name_from_ctype(ctype),
589 readable, writable, construct, construct_only,
593 def _introspect_signals(self, node, type_id):
594 for signal_info in cgobject.signal_list(type_id):
595 rtype = self._type_from_gtype(signal_info.return_type)
596 return_ = Return(rtype)
597 signal = GLibSignal(signal_info.signal_name, return_)
598 for i, parameter in enumerate(signal_info.get_params()):
602 name = 'p%s' % (i-1, )
603 ptype = self._type_from_gtype(parameter)
604 param = Parameter(name, ptype)
605 signal.parameters.append(param)
606 node.signals.append(signal)
610 def _resolve_type_name(self, type_name, ctype=None):
611 # Workaround glib bug #548689, to be included in 2.18.0
612 if type_name == "GParam":
613 type_name = "GObject.ParamSpec"
615 res = self._transformer.resolve_type_name_full
617 return res(type_name, ctype, self._names)
619 return self._transformer.resolve_type_name(type_name, ctype)
621 def _validate_type_name(self, name):
622 if name in type_names:
624 if name.find('.') >= 0:
626 if name in self._names.aliases:
628 if name in self._names.names:
632 def _validate_type(self, ptype):
633 if isinstance(ptype, Sequence):
634 etype = ptype.element_type
635 if isinstance(etype, Sequence):
636 return self._validate_type(etype)
637 return self._validate_type_name(etype)
638 return self._validate_type_name(ptype.name)
640 def _resolve_param_type_validate(self, ptype):
641 ptype = self._resolve_param_type(ptype)
642 if self._validating and not self._validate_type(ptype):
643 raise UnknownTypeError("Unknown type %r" % (ptype, ))
646 def _resolve_param_type(self, ptype):
648 return self._transformer.resolve_param_type_full(ptype,
651 return self._transformer.resolve_param_type(ptype)
654 def _resolve_node(self, node):
655 if isinstance(node, Function):
656 self._resolve_function_toplevel(node)
658 elif isinstance(node, Callback):
659 self._resolve_function(node)
660 elif isinstance(node, GLibObject):
661 self._resolve_glib_object(node)
662 elif isinstance(node, GLibInterface):
663 self._resolve_glib_interface(node)
664 elif isinstance(node, Struct):
665 self._resolve_struct(node)
666 elif isinstance(node, Union):
667 self._resolve_union(node)
668 elif isinstance(node, Alias):
669 self._resolve_alias(node)
671 def _resolve_function_toplevel(self, func):
672 newfunc = self._parse_constructor(func)
674 newfunc = self._parse_method(func)
676 self._resolve_function(func)
678 self._resolve_function(newfunc)
680 def _pair_boxed_type(self, boxed):
681 name = self._transformer.strip_namespace_object(boxed.type_name)
682 pair_node = self._get_attribute(name)
684 boxed_item = GLibBoxedOther(name, boxed.type_name,
686 elif isinstance(pair_node, Struct):
687 boxed_item = GLibBoxedStruct(pair_node.name, boxed.type_name,
689 boxed_item.fields = pair_node.fields
690 elif isinstance(pair_node, Union):
691 boxed_item = GLibBoxedUnion(pair_node.name, boxed.type_name,
693 boxed_item.fields = pair_node.fields
696 self._add_attribute(boxed_item, replace=True)
698 def _resolve_struct(self, node):
699 for field in node.fields:
700 self._resolve_field(field)
702 def _resolve_union(self, node):
703 for field in node.fields:
704 self._resolve_field(field)
706 def _force_resolve(self, item, allow_unknown=False):
707 if isinstance(item, Unresolved):
708 if item.target in self._private_internal_types:
711 return self._transformer.gtypename_to_giname(item.target,
715 print "WARNING: Skipping unknown interface %s" % \
720 if item in self._private_internal_types:
724 def _resolve_glib_interface(self, node):
725 node.parent = self._force_resolve(node.parent)
726 self._resolve_methods(node.methods)
727 self._resolve_properties(node.properties)
728 self._resolve_signals(node.signals)
730 def _resolve_glib_object(self, node):
731 node.parent = self._force_resolve(node.parent)
732 node.interfaces = filter(None,
733 [self._force_resolve(x, allow_unknown=True)
734 for x in node.interfaces])
735 self._resolve_constructors(node.constructors)
736 self._resolve_methods(node.methods)
737 self._resolve_properties(node.properties)
738 self._resolve_signals(node.signals)
740 def _resolve_glib_boxed(self, node):
741 self._resolve_constructors(node.constructors)
742 self._resolve_methods(node.methods)
744 def _resolve_constructors(self, constructors):
745 for ctor in constructors:
746 self._resolve_function(ctor)
748 def _resolve_methods(self, methods):
749 for method in methods:
750 self._resolve_function(method)
752 def _resolve_signals(self, signals):
753 for signal in signals:
754 self._resolve_function(signal)
756 def _resolve_properties(self, properties):
757 for prop in properties:
758 self._resolve_property(prop)
760 def _resolve_property(self, prop):
761 prop.type = self._resolve_param_type(prop.type)
763 def _resolve_function(self, func):
764 self._resolve_parameters(func.parameters)
765 func.retval.type = self._resolve_param_type(func.retval.type)
767 def _resolve_parameters(self, parameters):
768 for parameter in parameters:
769 parameter.type = self._resolve_param_type(parameter.type)
771 def _resolve_field(self, field):
772 if isinstance(field, Callback):
773 self._resolve_function(field)
775 field.type = self._resolve_param_type(field.type)
777 def _resolve_alias(self, alias):
778 alias.target = self._resolve_type_name(alias.target, alias.target)
782 def _validate(self, nodes):
783 nodes = list(self._names.names.itervalues())
785 self._validating = True
789 print "Type resolution; pass=%d" % (i, )
790 nodes = list(self._names.names.itervalues())
793 self._resolve_node(node)
794 except UnknownTypeError, e:
795 print "WARNING: %s: Deleting %r" % (e, node)
796 self._remove_attribute(node.name)
797 if len(nodes) == initlen:
800 self._print_statistics()
801 self._validating = False