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
22 from ctypes.util import find_library
24 from . import cgobject
25 from .ast import (Callback, Enum, Function, Member, Namespace, Parameter,
26 Sequence, Property, Return, Struct, Type, Alias,
27 Union, type_name_from_ctype)
28 from .transformer import Names
29 from .glibast import (GLibBoxed, GLibEnum, GLibEnumMember, GLibFlags,
30 GLibInterface, GLibObject, GLibSignal, type_names)
31 from .utils import extract_libtool, to_underscores
35 # These ones break GError conventions
36 'g_simple_async_result_new_from_error',
37 'g_simple_async_result_set_from_error',
38 'g_simple_async_result_propagate_error',
39 'gtk_print_operation_get_error',
43 class Unresolved(object):
45 def __init__(self, target):
49 class UnknownTypeError(Exception):
53 class GLibTransformer(object):
55 def __init__(self, transformer, noclosure=False):
56 self._transformer = transformer
57 self._namespace_name = None
59 self._uscore_type_names = {}
61 self._failed_types = {}
62 self._private_internal_types = {}
63 self._noclosure = noclosure
64 self._validating = False
68 def add_library(self, libname):
70 if libname.endswith('.la'):
71 found_libname = extract_libtool(libname)
73 found_libname = find_library(libname)
75 raise ValueError("Failed to find library: %r" % (libname, ))
76 self._libraries.append(ctypes.cdll.LoadLibrary(found_libname))
78 def _print_statistics(self):
79 nodes = list(self._names.names.itervalues())
81 def count_type(otype):
82 return len([x for x in nodes
83 if isinstance(x[1], otype)])
84 objectcount = count_type(GLibObject)
85 ifacecount = count_type(GLibInterface)
86 enumcount = count_type(GLibEnum)
87 boxedcount = count_type(GLibBoxed)
88 print " %d nodes; %d objects, %d interfaces, %d enums, %d boxed" \
89 % (len(nodes), objectcount, ifacecount, enumcount, boxedcount)
92 namespace = self._transformer.parse()
93 self._namespace_name = namespace.name
96 for node in namespace.nodes:
97 self._parse_node(node)
99 # Introspection is done from within parsing
101 # Second pass, delete class structures, resolve
102 # all types we now know about
103 nodes = list(self._names.names.itervalues())
104 for (ns, node) in nodes:
106 self._resolve_node(node)
108 print "WARNING: DELETING node %s: %s" % (node.name, e)
109 self._remove_attribute(node.name)
110 # associate GtkButtonClass with GtkButton
111 if isinstance(node, Struct):
112 self._pair_class_struct(node)
113 for (ns, alias) in self._names.aliases.itervalues():
114 self._resolve_alias(alias)
116 self._print_statistics()
117 # Third pass; ensure all types are known
118 if not self._noclosure:
119 self._validate(nodes)
121 # Create a new namespace with what we found
122 namespace = Namespace(namespace.name)
123 namespace.nodes = map(lambda x: x[1], self._names.aliases.itervalues())
124 for (ns, x) in self._names.names.itervalues():
125 namespace.nodes.append(x)
126 print "Scan complete."
131 def _add_attribute(self, node, replace=False):
132 node_name = node.name
133 if (not replace) and node_name in self._names.names:
135 self._names.names[node_name] = (None, node)
137 def _remove_attribute(self, name):
138 del self._names.names[name]
140 def _get_attribute(self, name):
141 node = self._names.names.get(name)
146 def _register_internal_type(self, type_name, node):
147 self._names.type_names[type_name] = (None, node)
148 self._uscore_type_names[to_underscores(type_name).lower()] = node
149 # Besides the straight underscore conversion, we also try
150 # removing the underscores from the namespace as a possible C
151 # mapping; e.g. it's webkit_web_view, not web_kit_web_view
152 suffix = self._transformer.strip_namespace_object(type_name)
153 prefix = type_name[:-len(suffix)]
154 no_uscore_prefixed = (prefix + '_' + to_underscores(suffix)).lower()
155 self._uscore_type_names[no_uscore_prefixed] = node
159 def _create_type(self, type_id):
160 ctype = cgobject.type_name(type_id)
161 type_name = type_name_from_ctype(ctype)
162 type_name = type_name.replace('*', '')
163 type_name = self._resolve_type_name(type_name)
164 return Type(type_name, ctype)
166 def _resolve_gtypename(self, gtype_name):
168 return self._transformer.gtypename_to_giname(gtype_name,
171 return Unresolved(gtype_name)
173 def _create_gobject(self, node):
174 type_name = 'G' + node.name
175 if type_name == 'GObject':
179 type_id = cgobject.type_from_name(type_name)
180 parent_type_name = cgobject.type_name(
181 cgobject.type_parent(type_id))
182 parent_gitype = self._resolve_gtypename(parent_type_name)
183 symbol = to_underscores(type_name).lower() + '_get_type'
184 node = GLibObject(node.name, parent_gitype, type_name, symbol)
185 type_id = cgobject.TYPE_OBJECT
186 self._introspect_properties(node, type_id)
187 self._introspect_signals(node, type_id)
188 self._add_attribute(node)
189 self._register_internal_type(type_name, node)
193 def _parse_node(self, node):
194 if isinstance(node, Enum):
195 self._parse_enum(node)
196 elif isinstance(node, Function):
197 self._parse_function(node)
198 elif isinstance(node, Struct):
199 self._parse_struct(node)
200 elif isinstance(node, Callback):
201 self._parse_callback(node)
202 elif isinstance(node, Alias):
203 self._parse_alias(node)
204 elif isinstance(node, Member):
205 # FIXME: atk_misc_instance singletons
207 elif isinstance(node, Union):
208 self._parse_union(node)
210 print 'GLIB Transformer: Unhandled node:', node
212 def _parse_alias(self, alias):
213 self._names.aliases[alias.name] = (None, alias)
215 def _parse_enum(self, enum):
216 self._add_attribute(enum)
218 def _parse_function(self, func):
219 if func.symbol in SYMBOL_BLACKLIST:
220 print "WARNING: Skipping blacklisted function: %r" \
223 if self._parse_get_type_function(func):
226 self._add_attribute(func)
228 def _parse_get_type_function(self, func):
230 if not symbol.endswith('_get_type'):
232 # GType *_get_type(void)
233 # This is a bit fishy, why do we need all these aliases?
234 if func.retval.type.name not in ['Type',
239 print ("Warning: *_get_type function returns '%r'"
240 ", not GObject.Type") % (func.retval.type.name, )
245 if not self._libraries:
246 print "Warning: No libraries loaded, cannot call %s" % (symbol, )
249 for library in self._libraries:
251 func = getattr(library, symbol)
253 except AttributeError:
256 print 'Warning: could not find symbol: %s' % symbol
257 name = symbol.replace('_get_type', '')
258 self._failed_types[name] = True
261 func.restype = cgobject.GType
264 self._introspect_type(type_id, symbol)
267 def _name_is_internal_gtype(self, giname):
269 node = self._get_attribute(giname)
270 return isinstance(node, (GLibObject, GLibInterface, GLibBoxed,
271 GLibEnum, GLibFlags))
275 def _parse_method(self, func):
276 if not func.parameters:
278 return self._parse_method_common(func, True)
280 def _parse_constructor(self, func):
281 return self._parse_method_common(func, False)
283 def _parse_method_common(self, func, is_method):
284 # Skip _get_type functions, we processed them
286 if func.symbol.endswith('_get_type'):
290 target_arg = func.retval
292 target_arg = func.parameters[0]
293 target_arg.type = self._resolve_param_type(target_arg.type)
296 # Methods require their first arg to be a known class
297 # Look at the original C type (before namespace stripping), without
298 # pointers: GtkButton -> gtk_button_, so we can figure out the
300 argtype = target_arg.type.ctype.replace('*', '')
301 name = self._transformer.strip_namespace_object(argtype)
302 name_uscore = to_underscores(name).lower()
303 name_offset = func.symbol.find(name_uscore)
306 prefix = func.symbol[:name_offset+len(name_uscore)]
308 # Constructors must have _new
309 # Take everything before that as class name
310 new_idx = func.symbol.find('_new')
313 # Constructors don't return basic types
314 if target_arg.type.name in type_names:
315 print "NOTE: Rejecting constructor returning basic: %r" \
318 prefix = func.symbol[:new_idx]
322 def valid_matching_klass(tclass):
323 return (tclass is not None and
324 isinstance(tclass, (GLibObject, GLibBoxed,
326 not isinstance(tclass, GLibEnum))
328 # First look for an exact match;
329 klass = self._uscore_type_names.get(prefix)
330 # Now try searching for a prefix as a last resort
331 if klass is None or not valid_matching_klass(klass):
332 for key in self._uscore_type_names:
334 if key.startswith(prefix):
335 klass = self._uscore_type_names.get(key)
336 if valid_matching_klass(klass):
338 # Enums can't have ctors or methods
340 print "NOTE: No valid matching class for likely "+\
341 "method or constructor: %r" % (func.symbol, )
345 # Interfaces can't have constructors, punt to global scope
346 if isinstance(klass, GLibInterface):
347 print "NOTE: Rejecting method or constructor for"+\
348 " interface type: %r" % (func.symbol, )
350 # TODO - check that the return type is a subclass of the
351 # class from the prefix
353 self._remove_attribute(func.name)
354 # Strip namespace and object prefix: gtk_window_new -> new
355 func.name = func.symbol[len(prefix)+1:]
357 klass.methods.append(func)
359 klass.constructors.append(func)
362 def _parse_struct(self, struct):
363 # This is a hack, but GObject is a rather fundamental piece so.
364 internal_names = ["Object", 'InitiallyUnowned']
365 g_internal_names = ["G" + x for x in internal_names]
366 if (self._namespace_name == 'GObject' and
367 struct.name in internal_names):
368 self._create_gobject(struct)
370 elif struct.name in g_internal_names:
373 node = self._names.names.get(struct.name)
375 self._add_attribute(struct, replace=True)
378 node.fields = struct.fields[:]
380 def _parse_union(self, union):
381 node = self._names.names.get(union.name)
383 self._add_attribute(union, replace=True)
386 node.fields = union.fields[:]
388 def _parse_callback(self, callback):
389 self._add_attribute(callback)
391 def _strip_class_suffix(self, name):
392 if (name.endswith('Class') or
393 name.endswith('Iface')):
395 elif name.endswith('Interface'):
400 def _arg_is_failed(self, param):
401 ctype = self._transformer.ctype_of(param).replace('*', '')
402 uscored = to_underscores(self._strip_class_suffix(ctype)).lower()
403 if uscored in self._failed_types:
404 print "Warning: failed type: %r" % (param, )
408 def _pair_class_struct(self, maybe_class):
409 name = self._strip_class_suffix(maybe_class.name)
410 if name == maybe_class.name:
413 if self._arg_is_failed(maybe_class):
414 print "WARNING: deleting no-type %r" % (maybe_class.name, )
415 del self._names.names[maybe_class.name]
418 name = self._resolve_type_name(name)
419 resolved = self._transformer.strip_namespace_object(name)
420 pair_class = self._get_attribute(resolved)
421 if pair_class and isinstance(pair_class,
422 (GLibObject, GLibBoxed, GLibInterface)):
423 for field in maybe_class.fields[1:]:
424 pair_class.fields.append(field)
426 name = self._transformer.strip_namespace_object(maybe_class.name)
427 pair_class = self._get_attribute(name)
428 if pair_class and isinstance(pair_class,
429 (GLibObject, GLibBoxed, GLibInterface)):
431 del self._names.names[maybe_class.name]
435 def _introspect_type(self, type_id, symbol):
436 fundamental_type_id = cgobject.type_fundamental(type_id)
437 if (fundamental_type_id == cgobject.TYPE_ENUM or
438 fundamental_type_id == cgobject.TYPE_FLAGS):
439 self._introspect_enum(fundamental_type_id, type_id, symbol)
440 elif fundamental_type_id == cgobject.TYPE_OBJECT:
441 self._introspect_object(type_id, symbol)
442 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
443 self._introspect_interface(type_id, symbol)
444 elif fundamental_type_id == cgobject.TYPE_BOXED:
445 self._introspect_boxed(type_id, symbol)
446 elif fundamental_type_id == cgobject.TYPE_BOXED:
447 self._introspect_boxed(type_id, symbol)
448 elif fundamental_type_id == cgobject.TYPE_POINTER:
449 # FIXME: Should we do something about these?
450 # GHashTable, GValue and a few other fundamentals are
454 print 'unhandled GType: %s(%d)' % (cgobject.type_name(type_id),
457 def _introspect_enum(self, ftype_id, type_id, symbol):
458 type_class = cgobject.type_class_ref(type_id)
459 if type_class is None:
463 for enum_value in type_class.get_values():
464 members.append(GLibEnumMember(enum_value.value_nick,
466 enum_value.value_name,
467 enum_value.value_nick))
469 klass = (GLibFlags if ftype_id == cgobject.TYPE_FLAGS else GLibEnum)
470 type_name = cgobject.type_name(type_id)
471 enum_name = self._transformer.strip_namespace_object(type_name)
472 node = klass(enum_name, type_name, members, symbol)
473 self._add_attribute(node, replace=True)
474 self._register_internal_type(type_name, node)
476 def _introspect_object(self, type_id, symbol):
477 type_name = cgobject.type_name(type_id)
478 # We handle this specially above; in 2.16 and below there
479 # was no g_object_get_type, for later versions we need
481 if type_name == 'GObject':
483 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
484 parent_gitype = self._resolve_gtypename(parent_type_name)
486 self._transformer.strip_namespace_object(type_name),
489 self._introspect_properties(node, type_id)
490 self._introspect_signals(node, type_id)
491 self._introspect_implemented_interfaces(node, type_id)
492 self._add_attribute(node, replace=True)
493 self._register_internal_type(type_name, node)
495 def _introspect_interface(self, type_id, symbol):
496 type_name = cgobject.type_name(type_id)
497 parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
498 if parent_type_name == 'GInterface':
501 parent_gitype = self._resolve_gtypename(parent_type_name)
502 node = GLibInterface(
503 self._transformer.strip_namespace_object(type_name),
506 self._introspect_properties(node, type_id)
507 self._introspect_signals(node, type_id)
508 # GtkFileChooserEmbed is an example of a private interface, we
509 # just filter them out
510 if symbol.startswith('_'):
511 print "NOTICE: Marking %s as internal type" % (type_name, )
512 self._private_internal_types[type_name] = node
514 self._add_attribute(node, replace=True)
515 self._register_internal_type(type_name, node)
517 def _introspect_boxed(self, type_id, symbol):
518 type_name = cgobject.type_name(type_id)
519 node = GLibBoxed(self._transformer.strip_namespace_object(type_name),
521 self._add_attribute(node, replace=True)
522 self._register_internal_type(type_name, node)
524 def _introspect_implemented_interfaces(self, node, type_id):
525 fundamental_type_id = cgobject.type_fundamental(type_id)
526 if fundamental_type_id != cgobject.TYPE_OBJECT:
528 interfaces = cgobject.type_interfaces(type_id)
530 for interface_typeid in interfaces:
531 iname = cgobject.type_name(interface_typeid)
532 gitype = self._resolve_gtypename(iname)
533 gt_interfaces.append(gitype)
534 node.interfaces = gt_interfaces
536 def _introspect_properties(self, node, type_id):
537 fundamental_type_id = cgobject.type_fundamental(type_id)
538 if fundamental_type_id == cgobject.TYPE_OBJECT:
539 pspecs = cgobject.object_class_list_properties(type_id)
540 elif fundamental_type_id == cgobject.TYPE_INTERFACE:
541 pspecs = cgobject.object_interface_list_properties(type_id)
546 if pspec.owner_type != type_id:
548 ctype = cgobject.type_name(pspec.value_type)
549 node.properties.append(Property(
551 type_name_from_ctype(ctype),
555 def _introspect_signals(self, node, type_id):
556 for signal_info in cgobject.signal_list(type_id):
557 rtype = self._create_type(signal_info.return_type)
558 return_ = Return(rtype)
559 signal = GLibSignal(signal_info.signal_name, return_)
560 for i, parameter in enumerate(signal_info.get_params()):
564 name = 'p%s' % (i-1, )
565 ptype = self._create_type(parameter)
566 param = Parameter(name, ptype)
567 signal.parameters.append(param)
568 node.signals.append(signal)
572 def _resolve_type_name(self, type_name, ctype=None):
573 # Workaround glib bug #548689, to be included in 2.18.0
574 if type_name == "GParam":
575 type_name = "GObject.ParamSpec"
577 res = self._transformer.resolve_type_name_full
579 return res(type_name, ctype, self._names)
581 return self._transformer.resolve_type_name(type_name, ctype)
583 def _validate_type_name(self, name):
584 if name in type_names:
586 if name.find('.') >= 0:
588 if name in self._names.aliases:
590 if name in self._names.names:
594 def _validate_type(self, ptype):
595 if isinstance(ptype, Sequence):
596 etype = ptype.element_type
597 if isinstance(etype, Sequence):
598 return self._validate_type(etype)
599 return self._validate_type_name(etype)
600 return self._validate_type_name(ptype.name)
602 def _resolve_param_type_validate(self, ptype):
603 ptype = self._resolve_param_type(ptype)
604 if self._validating and not self._validate_type(ptype):
605 raise UnknownTypeError("Unknown type %r" % (ptype, ))
608 def _resolve_param_type(self, ptype):
610 return self._transformer.resolve_param_type_full(ptype,
613 return self._transformer.resolve_param_type(ptype)
616 def _resolve_node(self, node):
617 if isinstance(node, Function):
618 self._resolve_function_toplevel(node)
620 elif isinstance(node, Callback):
621 self._resolve_function(node)
622 elif isinstance(node, GLibObject):
623 self._resolve_glib_object(node)
624 elif isinstance(node, GLibInterface):
625 self._resolve_glib_interface(node)
626 elif isinstance(node, GLibBoxed):
627 self._resolve_glib_boxed(node)
628 elif isinstance(node, Struct):
629 self._resolve_struct(node)
630 elif isinstance(node, Union):
631 self._resolve_union(node)
632 elif isinstance(node, Alias):
633 self._resolve_alias(node)
635 def _resolve_function_toplevel(self, func):
636 newfunc = self._parse_constructor(func)
638 newfunc = self._parse_method(func)
640 self._resolve_function(func)
642 self._resolve_function(newfunc)
644 def _resolve_struct(self, node):
645 for field in node.fields:
646 self._resolve_field(field)
648 def _resolve_union(self, node):
649 for field in node.fields:
650 self._resolve_field(field)
652 def _force_resolve(self, item, allow_unknown=False):
653 if isinstance(item, Unresolved):
654 if item.target in self._private_internal_types:
657 return self._transformer.gtypename_to_giname(item.target,
661 print "WARNING: Skipping unknown interface %s" % \
666 if item in self._private_internal_types:
670 def _resolve_glib_interface(self, node):
671 node.parent = self._force_resolve(node.parent)
672 self._resolve_methods(node.methods)
673 self._resolve_properties(node.properties)
674 self._resolve_signals(node.signals)
676 def _resolve_glib_object(self, node):
677 node.parent = self._force_resolve(node.parent)
678 node.interfaces = filter(None,
679 [self._force_resolve(x, allow_unknown=True)
680 for x in node.interfaces])
681 self._resolve_constructors(node.constructors)
682 self._resolve_methods(node.methods)
683 self._resolve_properties(node.properties)
684 self._resolve_signals(node.signals)
686 def _resolve_glib_boxed(self, node):
687 self._resolve_constructors(node.constructors)
688 self._resolve_methods(node.methods)
690 def _resolve_constructors(self, constructors):
691 for ctor in constructors:
692 self._resolve_function(ctor)
694 def _resolve_methods(self, methods):
695 for method in methods:
696 self._resolve_function(method)
698 def _resolve_signals(self, signals):
699 for signal in signals:
700 self._resolve_function(signal)
702 def _resolve_properties(self, properties):
703 for prop in properties:
704 self._resolve_property(prop)
706 def _resolve_property(self, prop):
707 prop.type = self._resolve_param_type(prop.type)
709 def _resolve_function(self, func):
710 self._resolve_parameters(func.parameters)
711 func.retval.type = self._resolve_param_type(func.retval.type)
713 def _resolve_parameters(self, parameters):
714 for parameter in parameters:
715 parameter.type = self._resolve_param_type(parameter.type)
717 def _resolve_field(self, field):
718 if isinstance(field, Callback):
719 self._resolve_function(field)
721 field.type = self._resolve_param_type(field.type)
723 def _resolve_alias(self, alias):
724 alias.target = self._resolve_type_name(alias.target, alias.target)
728 def _validate(self, nodes):
729 nodes = list(self._names.names.itervalues())
731 self._validating = True
735 print "Type resolution; pass=%d" % (i, )
736 nodes = list(self._names.names.itervalues())
739 self._resolve_node(node)
740 except UnknownTypeError, e:
741 print "WARNING: %s: Deleting %r" % (e, node)
742 self._remove_attribute(node.name)
743 if len(nodes) == initlen:
746 self._print_statistics()
747 self._validating = False