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
23 from ctypes.util import find_library
25 from . import cgobject
26 from .ast import (Callback, Enum, Function, Member, Namespace, Parameter,
27 Sequence, Property, Return, Struct, Type, Alias,
28 Union, type_name_from_ctype)
29 from .transformer import Names
30 from .glibast import (GLibBoxed, GLibEnum, GLibEnumMember, GLibFlags,
31 GLibInterface, GLibObject, GLibSignal, type_names)
32 from .utils import extract_libtool, to_underscores
36 # These ones break GError conventions
37 'g_simple_async_result_new_from_error',
38 'g_simple_async_result_set_from_error',
39 'g_simple_async_result_propagate_error',
40 'gtk_print_operation_get_error',
44 class Unresolved(object):
46 def __init__(self, target):
50 class UnknownTypeError(Exception):
54 class GLibTransformer(object):
56 def __init__(self, transformer, noclosure=False):
57 self._transformer = transformer
58 self._namespace_name = None
60 self._uscore_type_names = {}
62 self._failed_types = {}
63 self._private_internal_types = {}
64 self._noclosure = noclosure
65 self._validating = False
69 def add_library(self, libname):
71 libtool_libname = 'lib' + libname + '.la'
72 if os.path.exists(libtool_libname):
73 found_libname = extract_libtool(libtool_libname)
74 elif libname.endswith('.la'):
75 found_libname = extract_libtool(libname)
77 found_libname = find_library(libname)
79 raise ValueError("Failed to find library: %r" % (libname, ))
80 self._libraries.append(ctypes.cdll.LoadLibrary(found_libname))
82 def _print_statistics(self):
83 nodes = list(self._names.names.itervalues())
85 def count_type(otype):
86 return len([x for x in nodes
87 if isinstance(x[1], otype)])
88 objectcount = count_type(GLibObject)
89 ifacecount = count_type(GLibInterface)
90 enumcount = count_type(GLibEnum)
91 boxedcount = count_type(GLibBoxed)
92 print " %d nodes; %d objects, %d interfaces, %d enums, %d boxed" \
93 % (len(nodes), objectcount, ifacecount, enumcount, boxedcount)
96 namespace = self._transformer.parse()
97 self._namespace_name = namespace.name
100 for node in namespace.nodes:
101 self._parse_node(node)
103 # Introspection is done from within parsing
105 # Second pass, delete class structures, resolve
106 # all types we now know about
107 nodes = list(self._names.names.itervalues())
108 for (ns, node) in nodes:
110 self._resolve_node(node)
112 print "WARNING: DELETING node %s: %s" % (node.name, e)
113 self._remove_attribute(node.name)
114 # associate GtkButtonClass with GtkButton
115 if isinstance(node, Struct):
116 self._pair_class_struct(node)
117 for (ns, alias) in self._names.aliases.itervalues():
118 self._resolve_alias(alias)
120 self._print_statistics()
121 # Third pass; ensure all types are known
122 if not self._noclosure:
123 self._validate(nodes)
125 # Create a new namespace with what we found
126 namespace = Namespace(namespace.name)
127 namespace.nodes = map(lambda x: x[1], self._names.aliases.itervalues())
128 for (ns, x) in self._names.names.itervalues():
129 namespace.nodes.append(x)
130 print "Scan complete."
135 def _add_attribute(self, node, replace=False):
136 node_name = node.name
137 if (not replace) and node_name in self._names.names:
139 self._names.names[node_name] = (None, node)
141 def _remove_attribute(self, name):
142 del self._names.names[name]
144 def _get_attribute(self, name):
145 node = self._names.names.get(name)
150 def _register_internal_type(self, type_name, node):
151 self._names.type_names[type_name] = (None, node)
152 self._uscore_type_names[to_underscores(type_name).lower()] = node
153 # Besides the straight underscore conversion, we also try
154 # removing the underscores from the namespace as a possible C
155 # mapping; e.g. it's webkit_web_view, not web_kit_web_view
156 suffix = self._transformer.strip_namespace_object(type_name)
157 prefix = type_name[:-len(suffix)]
158 no_uscore_prefixed = (prefix + '_' + to_underscores(suffix)).lower()
159 self._uscore_type_names[no_uscore_prefixed] = node
163 def _create_type(self, type_id):
164 ctype = cgobject.type_name(type_id)
165 type_name = type_name_from_ctype(ctype)
166 type_name = type_name.replace('*', '')
167 type_name = self._resolve_type_name(type_name)
168 return Type(type_name, ctype)
170 def _resolve_gtypename(self, gtype_name):
172 return self._transformer.gtypename_to_giname(gtype_name,
175 return Unresolved(gtype_name)
177 def _create_gobject(self, node):
178 type_name = 'G' + node.name
179 if type_name == 'GObject':
183 type_id = cgobject.type_from_name(type_name)
184 parent_type_name = cgobject.type_name(
185 cgobject.type_parent(type_id))
186 parent_gitype = self._resolve_gtypename(parent_type_name)
187 symbol = to_underscores(type_name).lower() + '_get_type'
188 node = GLibObject(node.name, parent_gitype, type_name, symbol)
189 type_id = cgobject.TYPE_OBJECT
190 self._introspect_properties(node, type_id)
191 self._introspect_signals(node, type_id)
192 self._add_attribute(node)
193 self._register_internal_type(type_name, node)
197 def _parse_node(self, node):
198 if isinstance(node, Enum):
199 self._parse_enum(node)
200 elif isinstance(node, Function):
201 self._parse_function(node)
202 elif isinstance(node, Struct):
203 self._parse_struct(node)
204 elif isinstance(node, Callback):
205 self._parse_callback(node)
206 elif isinstance(node, Alias):
207 self._parse_alias(node)
208 elif isinstance(node, Member):
209 # FIXME: atk_misc_instance singletons
211 elif isinstance(node, Union):
212 self._parse_union(node)
214 print 'GLIB Transformer: Unhandled node:', node
216 def _parse_alias(self, alias):
217 self._names.aliases[alias.name] = (None, alias)
219 def _parse_enum(self, enum):
220 self._add_attribute(enum)
222 def _parse_function(self, func):
223 if func.symbol in SYMBOL_BLACKLIST:
225 if self._parse_get_type_function(func):
228 self._add_attribute(func)
230 def _parse_get_type_function(self, func):
232 if not symbol.endswith('_get_type'):
234 if self._namespace_name == 'GLib':
235 # No GObjects in GLib
237 # GType *_get_type(void)
238 # This is a bit fishy, why do we need all these aliases?
239 if func.retval.type.name not in ['Type',
244 print ("Warning: *_get_type function returns '%r'"
245 ", not GObject.Type") % (func.retval.type.name, )
250 if not self._libraries:
251 print "Warning: No libraries loaded, cannot call %s" % (symbol, )
254 for library in self._libraries:
256 func = getattr(library, symbol)
258 except AttributeError:
261 print 'Warning: could not find symbol: %s' % symbol
262 name = symbol.replace('_get_type', '')
263 self._failed_types[name] = True
266 func.restype = cgobject.GType
269 self._introspect_type(type_id, symbol)
272 def _name_is_internal_gtype(self, giname):
274 node = self._get_attribute(giname)
275 return isinstance(node, (GLibObject, GLibInterface, GLibBoxed,
276 GLibEnum, GLibFlags))
280 def _parse_method(self, func):
281 if not func.parameters:
283 return self._parse_method_common(func, True)
285 def _parse_constructor(self, func):
286 return self._parse_method_common(func, False)
288 def _parse_method_common(self, func, is_method):
289 # Skip _get_type functions, we processed them
291 if func.symbol.endswith('_get_type'):
293 if self._namespace_name == 'GLib':
294 # No GObjects in GLib
298 target_arg = func.retval
300 target_arg = func.parameters[0]
301 target_arg.type = self._resolve_param_type(target_arg.type)
304 # Methods require their first arg to be a known class
305 # Look at the original C type (before namespace stripping), without
306 # pointers: GtkButton -> gtk_button_, so we can figure out the
308 argtype = target_arg.type.ctype.replace('*', '')
309 name = self._transformer.strip_namespace_object(argtype)
310 name_uscore = to_underscores(name).lower()
311 name_offset = func.symbol.find(name_uscore)
314 prefix = func.symbol[:name_offset+len(name_uscore)]
316 # Constructors must have _new
317 # Take everything before that as class name
318 new_idx = func.symbol.find('_new')
321 # Constructors don't return basic types
322 derefed = self._transformer.follow_aliases(target_arg.type.name,
324 if derefed in type_names:
325 print "NOTE: Rejecting constructor returning basic: %r" \
328 prefix = func.symbol[:new_idx]
332 def valid_matching_klass(tclass):
335 elif isinstance(klass, (GLibEnum, GLibFlags)):
337 elif not isinstance(tclass, (GLibObject, GLibBoxed,
343 # First look for an exact match;
344 klass = self._uscore_type_names.get(prefix)
345 # Now try searching for a prefix as a last resort
346 if klass is None or not valid_matching_klass(klass):
347 for key in self._uscore_type_names:
349 if key.startswith(prefix):
350 klass = self._uscore_type_names.get(key)
351 if valid_matching_klass(klass):
353 # Enums can't have ctors or methods
355 print "NOTE: No valid matching class for likely "+\
356 "method or constructor: %r" % (func.symbol, )
358 if isinstance(klass, (GLibEnum, GLibFlags)):
362 # Interfaces can't have constructors, punt to global scope
363 if isinstance(klass, GLibInterface):
364 print "NOTE: Rejecting constructor for"+\
365 " interface type: %r" % (func.symbol, )
367 # TODO - check that the return type is a subclass of the
368 # class from the prefix
370 self._remove_attribute(func.name)
371 # Strip namespace and object prefix: gtk_window_new -> new
372 func.name = func.symbol[len(prefix)+1:]
374 klass.methods.append(func)
376 klass.constructors.append(func)
379 def _parse_struct(self, struct):
380 # This is a hack, but GObject is a rather fundamental piece so.
381 internal_names = ["Object", 'InitiallyUnowned']
382 g_internal_names = ["G" + x for x in internal_names]
383 if (self._namespace_name == 'GObject' and
384 struct.name in internal_names):
385 self._create_gobject(struct)
387 elif struct.name in g_internal_names:
390 node = self._names.names.get(struct.name)
392 self._add_attribute(struct, replace=True)
395 node.fields = struct.fields[:]
397 def _parse_union(self, union):
398 node = self._names.names.get(union.name)
400 self._add_attribute(union, replace=True)
403 node.fields = union.fields[:]
405 def _parse_callback(self, callback):
406 self._add_attribute(callback)
408 def _strip_class_suffix(self, name):
409 if (name.endswith('Class') or
410 name.endswith('Iface')):
412 elif name.endswith('Interface'):
417 def _arg_is_failed(self, param):
418 ctype = self._transformer.ctype_of(param).replace('*', '')
419 uscored = to_underscores(self._strip_class_suffix(ctype)).lower()
420 if uscored in self._failed_types:
421 print "Warning: failed type: %r" % (param, )
425 def _pair_class_struct(self, maybe_class):
426 name = self._strip_class_suffix(maybe_class.name)
427 if name == maybe_class.name:
430 if self._arg_is_failed(maybe_class):
431 print "WARNING: deleting no-type %r" % (maybe_class.name, )
432 del self._names.names[maybe_class.name]
435 name = self._resolve_type_name(name)
436 resolved = self._transformer.strip_namespace_object(name)
437 pair_class = self._get_attribute(resolved)
438 if pair_class and isinstance(pair_class,
439 (GLibObject, GLibBoxed, GLibInterface)):
440 for field in maybe_class.fields[1:]:
441 pair_class.fields.append(field)
443 name = self._transformer.strip_namespace_object(maybe_class.name)
444 pair_class = self._get_attribute(name)
445 if pair_class and isinstance(pair_class,
446 (GLibObject, GLibBoxed, GLibInterface)):
448 del self._names.names[maybe_class.name]
452 def _introspect_type(self, type_id, symbol):
453 fundamental_type_id = cgobject.type_fundamental(type_id)
454 if (fundamental_type_id == cgobject.TYPE_ENUM or
455 fundamental_type_id == cgobject.TYPE_FLAGS):
456 self._introspect_enum(fundamental_type_id, type_id, symbol)
457 elif fundamental_type_id == cgobject.TYPE_OBJECT:
458 self._introspect_object(type_id, symbol)
459 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
460 self._introspect_interface(type_id, symbol)
461 elif fundamental_type_id == cgobject.TYPE_BOXED:
462 self._introspect_boxed(type_id, symbol)
463 elif fundamental_type_id == cgobject.TYPE_BOXED:
464 self._introspect_boxed(type_id, symbol)
465 elif fundamental_type_id == cgobject.TYPE_POINTER:
466 # FIXME: Should we do something about these?
467 # GHashTable, GValue and a few other fundamentals are
471 print 'unhandled GType: %s(%d)' % (cgobject.type_name(type_id),
474 def _introspect_enum(self, ftype_id, type_id, symbol):
475 type_class = cgobject.type_class_ref(type_id)
476 if type_class is None:
480 for enum_value in type_class.get_values():
481 members.append(GLibEnumMember(enum_value.value_nick,
483 enum_value.value_name,
484 enum_value.value_nick))
486 klass = (GLibFlags if ftype_id == cgobject.TYPE_FLAGS else GLibEnum)
487 type_name = cgobject.type_name(type_id)
488 enum_name = self._transformer.strip_namespace_object(type_name)
489 node = klass(enum_name, type_name, members, symbol)
490 self._add_attribute(node, replace=True)
491 self._register_internal_type(type_name, node)
493 def _introspect_object(self, type_id, symbol):
494 type_name = cgobject.type_name(type_id)
495 # We handle this specially above; in 2.16 and below there
496 # was no g_object_get_type, for later versions we need
498 if type_name == 'GObject':
500 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
501 parent_gitype = self._resolve_gtypename(parent_type_name)
503 self._transformer.strip_namespace_object(type_name),
506 self._introspect_properties(node, type_id)
507 self._introspect_signals(node, type_id)
508 self._introspect_implemented_interfaces(node, type_id)
509 self._add_attribute(node, replace=True)
510 self._register_internal_type(type_name, node)
512 def _introspect_interface(self, type_id, symbol):
513 type_name = cgobject.type_name(type_id)
514 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
515 if parent_type_name == 'GInterface':
518 parent_gitype = self._resolve_gtypename(parent_type_name)
519 node = GLibInterface(
520 self._transformer.strip_namespace_object(type_name),
523 self._introspect_properties(node, type_id)
524 self._introspect_signals(node, type_id)
525 # GtkFileChooserEmbed is an example of a private interface, we
526 # just filter them out
527 if symbol.startswith('_'):
528 print "NOTICE: Marking %s as internal type" % (type_name, )
529 self._private_internal_types[type_name] = node
531 self._add_attribute(node, replace=True)
532 self._register_internal_type(type_name, node)
534 def _introspect_boxed(self, type_id, symbol):
535 type_name = cgobject.type_name(type_id)
536 node = GLibBoxed(self._transformer.strip_namespace_object(type_name),
538 self._add_attribute(node, replace=True)
539 self._register_internal_type(type_name, node)
541 def _introspect_implemented_interfaces(self, node, type_id):
542 fundamental_type_id = cgobject.type_fundamental(type_id)
543 if fundamental_type_id != cgobject.TYPE_OBJECT:
545 interfaces = cgobject.type_interfaces(type_id)
547 for interface_typeid in interfaces:
548 iname = cgobject.type_name(interface_typeid)
549 gitype = self._resolve_gtypename(iname)
550 gt_interfaces.append(gitype)
551 node.interfaces = gt_interfaces
553 def _introspect_properties(self, node, type_id):
554 fundamental_type_id = cgobject.type_fundamental(type_id)
555 if fundamental_type_id == cgobject.TYPE_OBJECT:
556 pspecs = cgobject.object_class_list_properties(type_id)
557 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
558 pspecs = cgobject.object_interface_list_properties(type_id)
563 if pspec.owner_type != type_id:
565 ctype = cgobject.type_name(pspec.value_type)
566 node.properties.append(Property(
568 type_name_from_ctype(ctype),
572 def _introspect_signals(self, node, type_id):
573 for signal_info in cgobject.signal_list(type_id):
574 rtype = self._create_type(signal_info.return_type)
575 return_ = Return(rtype)
576 signal = GLibSignal(signal_info.signal_name, return_)
577 for i, parameter in enumerate(signal_info.get_params()):
581 name = 'p%s' % (i-1, )
582 ptype = self._create_type(parameter)
583 param = Parameter(name, ptype)
584 signal.parameters.append(param)
585 node.signals.append(signal)
589 def _resolve_type_name(self, type_name, ctype=None):
590 # Workaround glib bug #548689, to be included in 2.18.0
591 if type_name == "GParam":
592 type_name = "GObject.ParamSpec"
594 res = self._transformer.resolve_type_name_full
596 return res(type_name, ctype, self._names)
598 return self._transformer.resolve_type_name(type_name, ctype)
600 def _validate_type_name(self, name):
601 if name in type_names:
603 if name.find('.') >= 0:
605 if name in self._names.aliases:
607 if name in self._names.names:
611 def _validate_type(self, ptype):
612 if isinstance(ptype, Sequence):
613 etype = ptype.element_type
614 if isinstance(etype, Sequence):
615 return self._validate_type(etype)
616 return self._validate_type_name(etype)
617 return self._validate_type_name(ptype.name)
619 def _resolve_param_type_validate(self, ptype):
620 ptype = self._resolve_param_type(ptype)
621 if self._validating and not self._validate_type(ptype):
622 raise UnknownTypeError("Unknown type %r" % (ptype, ))
625 def _resolve_param_type(self, ptype):
627 return self._transformer.resolve_param_type_full(ptype,
630 return self._transformer.resolve_param_type(ptype)
633 def _resolve_node(self, node):
634 if isinstance(node, Function):
635 self._resolve_function_toplevel(node)
637 elif isinstance(node, Callback):
638 self._resolve_function(node)
639 elif isinstance(node, GLibObject):
640 self._resolve_glib_object(node)
641 elif isinstance(node, GLibInterface):
642 self._resolve_glib_interface(node)
643 elif isinstance(node, GLibBoxed):
644 self._resolve_glib_boxed(node)
645 elif isinstance(node, Struct):
646 self._resolve_struct(node)
647 elif isinstance(node, Union):
648 self._resolve_union(node)
649 elif isinstance(node, Alias):
650 self._resolve_alias(node)
652 def _resolve_function_toplevel(self, func):
653 newfunc = self._parse_constructor(func)
655 newfunc = self._parse_method(func)
657 self._resolve_function(func)
659 self._resolve_function(newfunc)
661 def _resolve_struct(self, node):
662 for field in node.fields:
663 self._resolve_field(field)
665 def _resolve_union(self, node):
666 for field in node.fields:
667 self._resolve_field(field)
669 def _force_resolve(self, item, allow_unknown=False):
670 if isinstance(item, Unresolved):
671 if item.target in self._private_internal_types:
674 return self._transformer.gtypename_to_giname(item.target,
678 print "WARNING: Skipping unknown interface %s" % \
683 if item in self._private_internal_types:
687 def _resolve_glib_interface(self, node):
688 node.parent = self._force_resolve(node.parent)
689 self._resolve_methods(node.methods)
690 self._resolve_properties(node.properties)
691 self._resolve_signals(node.signals)
693 def _resolve_glib_object(self, node):
694 node.parent = self._force_resolve(node.parent)
695 node.interfaces = filter(None,
696 [self._force_resolve(x, allow_unknown=True)
697 for x in node.interfaces])
698 self._resolve_constructors(node.constructors)
699 self._resolve_methods(node.methods)
700 self._resolve_properties(node.properties)
701 self._resolve_signals(node.signals)
703 def _resolve_glib_boxed(self, node):
704 self._resolve_constructors(node.constructors)
705 self._resolve_methods(node.methods)
707 def _resolve_constructors(self, constructors):
708 for ctor in constructors:
709 self._resolve_function(ctor)
711 def _resolve_methods(self, methods):
712 for method in methods:
713 self._resolve_function(method)
715 def _resolve_signals(self, signals):
716 for signal in signals:
717 self._resolve_function(signal)
719 def _resolve_properties(self, properties):
720 for prop in properties:
721 self._resolve_property(prop)
723 def _resolve_property(self, prop):
724 prop.type = self._resolve_param_type(prop.type)
726 def _resolve_function(self, func):
727 self._resolve_parameters(func.parameters)
728 func.retval.type = self._resolve_param_type(func.retval.type)
730 def _resolve_parameters(self, parameters):
731 for parameter in parameters:
732 parameter.type = self._resolve_param_type(parameter.type)
734 def _resolve_field(self, field):
735 if isinstance(field, Callback):
736 self._resolve_function(field)
738 field.type = self._resolve_param_type(field.type)
740 def _resolve_alias(self, alias):
741 alias.target = self._resolve_type_name(alias.target, alias.target)
745 def _validate(self, nodes):
746 nodes = list(self._names.names.itervalues())
748 self._validating = True
752 print "Type resolution; pass=%d" % (i, )
753 nodes = list(self._names.names.itervalues())
756 self._resolve_node(node)
757 except UnknownTypeError, e:
758 print "WARNING: %s: Deleting %r" % (e, node)
759 self._remove_attribute(node.name)
760 if len(nodes) == initlen:
763 self._print_statistics()
764 self._validating = False