Bug 557241 – "throws" flag for functions
[gnome.gobject-introspection] / giscanner / glibtransformer.py
1 # -*- Mode: Python -*-
2 # GObject-Introspection - a framework for introspecting GObject libraries
3 # Copyright (C) 2008  Johan Dahlin
4 #
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.
9 #
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.
14 #
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
18 # 02110-1301, USA.
19 #
20
21 import os
22 import re
23 import ctypes
24 from ctypes.util import find_library
25
26 from . import cgobject
27 from .ast import (Callback, Constant, Enum, Function, Member, Namespace,
28                   Parameter, Property, Return, Struct, Type, Alias,
29                   Union, Field, type_name_from_ctype,
30                   default_array_types, TYPE_UINT8, PARAM_DIRECTION_IN)
31 from .transformer import Names
32 from .glibast import (GLibBoxed, GLibEnum, GLibEnumMember, GLibFlags,
33                       GLibInterface, GLibObject, GLibSignal, GLibBoxedStruct,
34                       GLibBoxedUnion, GLibBoxedOther, type_names)
35 from .utils import extract_libtool, to_underscores, to_underscores_noprefix
36
37 default_array_types['guchar*'] = TYPE_UINT8
38
39 SYMBOL_BLACKLIST = [
40     # These ones break GError conventions
41     'g_simple_async_result_new_from_error',
42     'g_simple_async_result_set_from_error',
43     'g_simple_async_result_propagate_error',
44     'g_simple_async_result_report_error_in_idle',
45     'gtk_print_operation_get_error',
46 ]
47
48 SYMBOL_BLACKLIST_RE = [re.compile(x) for x in \
49                            [r'\w+_marshal_[A-Z]+__', ]]
50
51
52 class Unresolved(object):
53
54     def __init__(self, target):
55         self.target = target
56
57
58 class UnknownTypeError(Exception):
59     pass
60
61
62 class GLibTransformer(object):
63
64     def __init__(self, transformer, noclosure=False):
65         self._transformer = transformer
66         self._transformer.set_container_types(['GList*', 'GSList*'],
67                                               ['GHashtable*'])
68         self._namespace_name = None
69         self._names = Names()
70         self._uscore_type_names = {}
71         self._libraries = []
72         self._failed_types = {}
73         self._boxed_types = {}
74         self._private_internal_types = {}
75         self._noclosure = noclosure
76         self._validating = False
77
78     # Public API
79
80     def add_library(self, libname):
81         # For testing mainly.
82         libtool_libname = 'lib' + libname + '.la'
83         if os.path.exists(libtool_libname):
84             found_libname = extract_libtool(libtool_libname)
85         elif libname.endswith('.la'):
86             found_libname = extract_libtool(libname)
87         else:
88             found_libname = find_library(libname)
89         if not found_libname:
90             raise ValueError("Failed to find library: %r" % (libname, ))
91         self._libraries.append(ctypes.cdll.LoadLibrary(found_libname))
92
93     def _print_statistics(self):
94         nodes = list(self._names.names.itervalues())
95
96         def count_type(otype):
97             return len([x for x in nodes
98                         if isinstance(x[1], otype)])
99         objectcount = count_type(GLibObject)
100         ifacecount = count_type(GLibInterface)
101         enumcount = count_type(GLibEnum)
102         print " %d nodes; %d objects, %d interfaces, %d enums" \
103             % (len(nodes), objectcount, ifacecount, enumcount)
104
105     def parse(self):
106         namespace = self._transformer.parse()
107         self._namespace_name = namespace.name
108
109         # First pass: parsing
110         for node in namespace.nodes:
111             self._parse_node(node)
112
113         # We don't want an alias for this - it's handled specially in
114         # the typelib compiler.
115         if namespace.name == 'GObject':
116             del self._names.aliases['Type']
117
118         # Introspection is done from within parsing
119
120         # Second pass: pair boxed structures
121         for boxed in self._boxed_types.itervalues():
122             self._pair_boxed_type(boxed)
123         # Third pass: delete class structures, resolve
124         # all types we now know about
125         nodes = list(self._names.names.itervalues())
126         for (ns, node) in nodes:
127             try:
128                 self._resolve_node(node)
129             except KeyError, e:
130                 print "WARNING: DELETING node %s: %s" % (node.name, e)
131                 self._remove_attribute(node.name)
132             # associate GtkButtonClass with GtkButton
133             if isinstance(node, Struct):
134                 self._pair_class_struct(node)
135         for (ns, alias) in self._names.aliases.itervalues():
136             self._resolve_alias(alias)
137
138         self._print_statistics()
139         # Fourth pass: ensure all types are known
140         if not self._noclosure:
141             self._validate(nodes)
142
143         # Create a new namespace with what we found
144         namespace = Namespace(namespace.name, namespace.version)
145         namespace.nodes = map(lambda x: x[1], self._names.aliases.itervalues())
146         for (ns, x) in self._names.names.itervalues():
147             namespace.nodes.append(x)
148         return namespace
149
150     # Private
151
152     def _add_attribute(self, node, replace=False):
153         node_name = node.name
154         if (not replace) and node_name in self._names.names:
155             return
156         self._names.names[node_name] = (None, node)
157
158     def _remove_attribute(self, name):
159         del self._names.names[name]
160
161     def _get_attribute(self, name):
162         node = self._names.names.get(name)
163         if node:
164             return node[1]
165         return None
166
167     def _register_internal_type(self, type_name, node):
168         self._names.type_names[type_name] = (None, node)
169         uscored = to_underscores(type_name).lower()
170         self._uscore_type_names[uscored] = node
171         # Besides the straight underscore conversion, we also try
172         # removing the underscores from the namespace as a possible C
173         # mapping; e.g. it's webkit_web_view, not web_kit_web_view
174         suffix = self._transformer.remove_prefix(type_name)
175         prefix = type_name[:-len(suffix)]
176         no_uscore_prefixed = (prefix + '_' + to_underscores(suffix)).lower()
177         self._uscore_type_names[no_uscore_prefixed] = node
178
179     # Helper functions
180
181     def _type_from_gtype(self, type_id):
182         ctype = cgobject.type_name(type_id)
183         type_name = type_name_from_ctype(ctype)
184         type_name = type_name.replace('*', '')
185         type_name = self._resolve_type_name(type_name)
186         return Type(type_name, ctype)
187
188     def _resolve_gtypename(self, gtype_name):
189         try:
190             return self._transformer.gtypename_to_giname(gtype_name,
191                                                          self._names)
192         except KeyError, e:
193             return Unresolved(gtype_name)
194
195     def _create_gobject(self, node):
196         type_name = 'G' + node.name
197         if type_name == 'GObject':
198             parent_gitype = None
199             symbol = 'intern'
200         else:
201             type_id = cgobject.type_from_name(type_name)
202             parent_type_name = cgobject.type_name(
203                 cgobject.type_parent(type_id))
204             parent_gitype = self._resolve_gtypename(parent_type_name)
205             symbol = to_underscores(type_name).lower() + '_get_type'
206         node = GLibObject(node.name, parent_gitype, type_name, symbol, True)
207         type_id = cgobject.TYPE_OBJECT
208         self._introspect_properties(node, type_id)
209         self._introspect_signals(node, type_id)
210         self._add_attribute(node)
211         self._register_internal_type(type_name, node)
212
213     # Parser
214
215     def _parse_node(self, node):
216         if isinstance(node, Enum):
217             self._parse_enum(node)
218         elif isinstance(node, Function):
219             self._parse_function(node)
220         elif isinstance(node, Struct):
221             self._parse_struct(node)
222         elif isinstance(node, Callback):
223             self._parse_callback(node)
224         elif isinstance(node, Alias):
225             self._parse_alias(node)
226         elif isinstance(node, Member):
227             # FIXME: atk_misc_instance singletons
228             pass
229         elif isinstance(node, Union):
230             self._parse_union(node)
231         elif isinstance(node, Constant):
232             self._parse_constant(node)
233         else:
234             print 'GLIB Transformer: Unhandled node:', node
235
236     def _parse_alias(self, alias):
237         self._names.aliases[alias.name] = (None, alias)
238
239     def _parse_enum(self, enum):
240         self._add_attribute(enum)
241
242     def _parse_constant(self, constant):
243         self._add_attribute(constant)
244
245     def _parse_function(self, func):
246         if func.symbol in SYMBOL_BLACKLIST:
247             return
248         if func.symbol.startswith('_'):
249             return
250         for regexp in SYMBOL_BLACKLIST_RE:
251             if regexp.match(func.symbol):
252                 return
253         if self._parse_get_type_function(func):
254             return
255
256         self._add_attribute(func)
257
258     def _parse_get_type_function(self, func):
259         symbol = func.symbol
260         if not symbol.endswith('_get_type'):
261             return False
262         if self._namespace_name == 'GLib':
263             # No GObjects in GLib
264             return False
265         # GType *_get_type(void)
266         if func.retval.type.name not in ['Type',
267                                          'GType',
268                                          'GObject.Type',
269                                          'Gtk.Type']:
270             print ("Warning: *_get_type function returns '%r'"
271                    ", not GObject.Type") % (func.retval.type.name, )
272             return False
273         if func.parameters:
274             return False
275
276         if not self._libraries:
277             print "Warning: No libraries loaded, cannot call %s" % (symbol, )
278             return False
279
280         for library in self._libraries:
281             try:
282                 func = getattr(library, symbol)
283                 break
284             except AttributeError:
285                 continue
286         else:
287             print 'Warning: could not find symbol: %s' % symbol
288             name = symbol.replace('_get_type', '')
289             self._failed_types[name] = True
290             return False
291
292         func.restype = cgobject.GType
293         func.argtypes = []
294         type_id = func()
295         self._introspect_type(type_id, symbol)
296         return True
297
298     def _name_is_internal_gtype(self, giname):
299         try:
300             node = self._get_attribute(giname)
301             return isinstance(node, (GLibObject, GLibInterface,
302                                      GLibBoxed, GLibEnum, GLibFlags))
303         except KeyError, e:
304             return False
305
306     def _parse_method(self, func):
307         if not func.parameters:
308             return False
309         return self._parse_method_common(func, True)
310
311     def _parse_constructor(self, func):
312         return self._parse_method_common(func, False)
313
314     def _parse_method_common(self, func, is_method):
315         # Skip _get_type functions, we processed them
316         # already
317         if func.symbol.endswith('_get_type'):
318             return None
319         if self._namespace_name == 'GLib':
320             # No GObjects in GLib
321             return None
322
323         if not is_method:
324             target_arg = func.retval
325         else:
326             target_arg = func.parameters[0]
327         target_arg.type = self._resolve_param_type(target_arg.type)
328
329         if is_method:
330             # Methods require their first arg to be a known class
331             # Look at the original C type (before namespace stripping), without
332             # pointers: GtkButton -> gtk_button_, so we can figure out the
333             # method name
334             argtype = target_arg.type.ctype.replace('*', '')
335             name = self._transformer.remove_prefix(argtype)
336             name_uscore = to_underscores_noprefix(name).lower()
337             name_offset = func.symbol.find(name_uscore)
338             if name_offset < 0:
339                 return None
340             prefix = func.symbol[:name_offset+len(name_uscore)]
341         else:
342             # Constructors must have _new
343             # Take everything before that as class name
344             new_idx = func.symbol.find('_new')
345             if new_idx < 0:
346                 return None
347             # Constructors don't return basic types
348             derefed = self._transformer.follow_aliases(target_arg.type.name,
349                                                        self._names)
350             if derefed in type_names:
351                 #print "NOTE: Rejecting constructor returning basic: %r" \
352                 #    % (func.symbol, )
353                 return None
354             prefix = func.symbol[:new_idx]
355
356         klass = None
357
358         def valid_matching_klass(tclass):
359             if tclass is None:
360                 return False
361             elif isinstance(klass, (GLibEnum, GLibFlags)):
362                 return False
363             elif not isinstance(tclass, (GLibObject, GLibBoxed,
364                                           GLibInterface)):
365                 return False
366             else:
367                 return True
368
369         klass = self._uscore_type_names.get(prefix)
370         if klass is None:
371             #print "NOTE: No valid matching class for likely "+\
372             #    "method or constructor: %r" % (func.symbol, )
373             return None
374         # Enums can't have ctors or methods
375         if isinstance(klass, (GLibEnum, GLibFlags)):
376             return None
377
378         # The _uscore_type_names member holds the plain GLibBoxed
379         # object; we want to actually use the struct/record associated
380         if isinstance(klass, GLibBoxed):
381             name = self._transformer.remove_prefix(klass.type_name)
382             klass = self._get_attribute(name)
383
384         if not is_method:
385             # Interfaces can't have constructors, punt to global scope
386             if isinstance(klass, GLibInterface):
387                 #print "NOTE: Rejecting constructor for"+\
388                 #    " interface type: %r" % (func.symbol, )
389                 return None
390             # TODO - check that the return type is a subclass of the
391             # class from the prefix
392             # But for now, ensure that constructor returns are always
393             # the most concrete class
394             func.retval.type = Type(klass.name,
395                                     self._transformer.ctype_of(klass)+'*')
396
397         self._remove_attribute(func.name)
398         # Strip namespace and object prefix: gtk_window_new -> new
399         func.name = func.symbol[len(prefix)+1:]
400         if is_method:
401             # We don't need the "this" parameter
402             del func.parameters[0]
403             klass.methods.append(func)
404         else:
405             klass.constructors.append(func)
406         return func
407
408     def _parse_struct(self, struct):
409         # This is a hack, but GObject is a rather fundamental piece so.
410         internal_names = ["Object", 'InitiallyUnowned']
411         g_internal_names = ["G" + x for x in internal_names]
412         if (self._namespace_name == 'GObject' and
413             struct.name in internal_names):
414             self._create_gobject(struct)
415             return
416         elif struct.name in g_internal_names:
417             # Avoid duplicates
418             return
419         node = self._names.names.get(struct.name)
420         if node is None:
421             self._add_attribute(struct, replace=True)
422             return
423         (ns, node) = node
424         node.fields = struct.fields[:]
425
426     def _parse_union(self, union):
427         node = self._names.names.get(union.name)
428         if node is None:
429             self._add_attribute(union, replace=True)
430             return
431         (ns, node) = node
432         node.fields = union.fields[:]
433
434     def _parse_callback(self, callback):
435         self._add_attribute(callback)
436
437     def _strip_class_suffix(self, name):
438         if (name.endswith('Class') or
439             name.endswith('Iface')):
440             return name[:-5]
441         elif name.endswith('Interface'):
442             return name[:-9]
443         else:
444             return name
445
446     def _arg_is_failed(self, param):
447         ctype = self._transformer.ctype_of(param).replace('*', '')
448         uscored = to_underscores(self._strip_class_suffix(ctype)).lower()
449         if uscored in self._failed_types:
450             print "Warning: failed type: %r" % (param, )
451             return True
452         return False
453
454     def _pair_class_struct(self, maybe_class):
455         name = self._strip_class_suffix(maybe_class.name)
456         if name == maybe_class.name:
457             return
458
459         if self._arg_is_failed(maybe_class):
460             print "WARNING: deleting no-type %r" % (maybe_class.name, )
461             del self._names.names[maybe_class.name]
462             return
463
464         # Object class fields are assumed to be read-only
465         # (see also _introspect_object and transformer.py)
466         for field in maybe_class.fields:
467             if isinstance(field, Field):
468                 field.writable = False
469
470         name = self._resolve_type_name(name)
471         resolved = self._transformer.remove_prefix(name)
472         pair_class = self._get_attribute(resolved)
473         if pair_class and isinstance(pair_class,
474                                      (GLibObject, GLibInterface)):
475             for field in maybe_class.fields[1:]:
476                 pair_class.fields.append(field)
477             return
478         name = self._transformer.remove_prefix(maybe_class.name)
479         pair_class = self._get_attribute(name)
480         if pair_class and isinstance(pair_class,
481                                      (GLibObject, GLibInterface)):
482
483             del self._names.names[maybe_class.name]
484
485     # Introspection
486
487     def _introspect_type(self, type_id, symbol):
488         fundamental_type_id = cgobject.type_fundamental(type_id)
489         if (fundamental_type_id == cgobject.TYPE_ENUM or
490             fundamental_type_id == cgobject.TYPE_FLAGS):
491             self._introspect_enum(fundamental_type_id, type_id, symbol)
492         elif fundamental_type_id == cgobject.TYPE_OBJECT:
493             self._introspect_object(type_id, symbol)
494         elif fundamental_type_id == cgobject.TYPE_INTERFACE:
495             self._introspect_interface(type_id, symbol)
496         elif fundamental_type_id == cgobject.TYPE_BOXED:
497             self._introspect_boxed(type_id, symbol)
498         elif fundamental_type_id == cgobject.TYPE_BOXED:
499             self._introspect_boxed(type_id, symbol)
500         elif fundamental_type_id == cgobject.TYPE_POINTER:
501             # FIXME: Should we do something about these?
502             #        GHashTable, GValue and a few other fundamentals are
503             #        covered here
504             return
505         else:
506             print 'unhandled GType: %s(%d)' % (cgobject.type_name(type_id),
507                                                type_id)
508
509     def _introspect_enum(self, ftype_id, type_id, symbol):
510         type_class = cgobject.type_class_ref(type_id)
511         if type_class is None:
512             return
513
514         members = []
515         for enum_value in type_class.get_values():
516             members.append(GLibEnumMember(enum_value.value_nick,
517                                           enum_value.value,
518                                           enum_value.value_name,
519                                           enum_value.value_nick))
520
521         klass = (GLibFlags if ftype_id == cgobject.TYPE_FLAGS else GLibEnum)
522         type_name = cgobject.type_name(type_id)
523         enum_name = self._transformer.remove_prefix(type_name)
524         node = klass(enum_name, type_name, members, symbol)
525         self._add_attribute(node, replace=True)
526         self._register_internal_type(type_name, node)
527
528     def _introspect_object(self, type_id, symbol):
529         type_name = cgobject.type_name(type_id)
530         # We handle this specially above; in 2.16 and below there
531         # was no g_object_get_type, for later versions we need
532         # to skip it
533         if type_name == 'GObject':
534             return
535         parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
536         parent_gitype = self._resolve_gtypename(parent_type_name)
537         is_abstract = cgobject.type_is_abstract(type_id)
538         node = GLibObject(
539             self._transformer.remove_prefix(type_name),
540             parent_gitype,
541             type_name,
542             symbol, is_abstract)
543         self._introspect_properties(node, type_id)
544         self._introspect_signals(node, type_id)
545         self._introspect_implemented_interfaces(node, type_id)
546
547         # add struct fields
548         struct = self._get_attribute(node.name)
549         if struct is not None:
550             node.fields = struct.fields
551             for field in node.fields:
552                 if isinstance(field, Field):
553                     # Object instance fields are assumed to be read-only
554                     # (see also _pair_class_struct and transformer.py)
555                     field.writable = False
556
557         self._add_attribute(node, replace=True)
558         self._register_internal_type(type_name, node)
559
560     def _introspect_interface(self, type_id, symbol):
561         type_name = cgobject.type_name(type_id)
562         parent_type_name = cgobject.type_name(cgobject.type_parent(type_id))
563         if parent_type_name == 'GInterface':
564             parent_gitype = None
565         else:
566             parent_gitype = self._resolve_gtypename(parent_type_name)
567         node = GLibInterface(
568             self._transformer.remove_prefix(type_name),
569             parent_gitype,
570             type_name, symbol)
571         self._introspect_properties(node, type_id)
572         self._introspect_signals(node, type_id)
573         # GtkFileChooserEmbed is an example of a private interface, we
574         # just filter them out
575         if symbol.startswith('_'):
576             print "NOTICE: Marking %s as internal type" % (type_name, )
577             self._private_internal_types[type_name] = node
578         else:
579             self._add_attribute(node, replace=True)
580             self._register_internal_type(type_name, node)
581
582     def _introspect_boxed(self, type_id, symbol):
583         type_name = cgobject.type_name(type_id)
584         # This one doesn't go in the main namespace; we associate it with
585         # the struct or union
586         node = GLibBoxed(type_name, symbol)
587         self._boxed_types[node.type_name] = node
588         self._register_internal_type(type_name, node)
589
590     def _introspect_implemented_interfaces(self, node, type_id):
591         fundamental_type_id = cgobject.type_fundamental(type_id)
592         if fundamental_type_id != cgobject.TYPE_OBJECT:
593             raise AssertionError
594         interfaces = cgobject.type_interfaces(type_id)
595         gt_interfaces = []
596         for interface_typeid in interfaces:
597             iname = cgobject.type_name(interface_typeid)
598             gitype = self._resolve_gtypename(iname)
599             gt_interfaces.append(gitype)
600         node.interfaces = gt_interfaces
601
602     def _introspect_properties(self, node, type_id):
603         fundamental_type_id = cgobject.type_fundamental(type_id)
604         if fundamental_type_id == cgobject.TYPE_OBJECT:
605             pspecs = cgobject.object_class_list_properties(type_id)
606         elif fundamental_type_id == cgobject.TYPE_INTERFACE:
607             pspecs = cgobject.object_interface_list_properties(type_id)
608         else:
609             raise AssertionError
610
611         for pspec in pspecs:
612             if pspec.owner_type != type_id:
613                 continue
614             ctype = cgobject.type_name(pspec.value_type)
615             readable = (pspec.flags & 1) != 0
616             writable = (pspec.flags & 2) != 0
617             construct = (pspec.flags & 4) != 0
618             construct_only = (pspec.flags & 8) != 0
619             node.properties.append(Property(
620                 pspec.name,
621                 type_name_from_ctype(ctype),
622                 readable, writable, construct, construct_only,
623                 ctype,
624                 ))
625
626     def _introspect_signals(self, node, type_id):
627         for signal_info in cgobject.signal_list(type_id):
628             rtype = self._type_from_gtype(signal_info.return_type)
629             return_ = Return(rtype)
630             signal = GLibSignal(signal_info.signal_name, return_)
631             for i, parameter in enumerate(signal_info.get_params()):
632                 if i == 0:
633                     name = 'object'
634                 else:
635                     name = 'p%s' % (i-1, )
636                 ptype = self._type_from_gtype(parameter)
637                 param = Parameter(name, ptype)
638                 signal.parameters.append(param)
639             node.signals.append(signal)
640
641     # Resolver
642
643     def _resolve_type_name(self, type_name, ctype=None):
644         # Workaround glib bug #548689, to be included in 2.18.0
645         if type_name == "GParam":
646             type_name = "GObject.ParamSpec"
647
648         res = self._transformer.resolve_type_name_full
649         try:
650             return res(type_name, ctype, self._names)
651         except KeyError, e:
652             return self._transformer.resolve_type_name(type_name, ctype)
653
654     def _resolve_param_type(self, ptype, **kwargs):
655         return self._transformer.resolve_param_type_full(ptype,
656                                                          self._names,
657                                                          **kwargs)
658
659     def _resolve_node(self, node):
660         if isinstance(node, Function):
661             self._resolve_function_toplevel(node)
662
663         elif isinstance(node, Callback):
664             self._resolve_function(node)
665         elif isinstance(node, GLibObject):
666             self._resolve_glib_object(node)
667         elif isinstance(node, GLibInterface):
668             self._resolve_glib_interface(node)
669         elif isinstance(node, Struct):
670             self._resolve_struct(node)
671         elif isinstance(node, Union):
672             self._resolve_union(node)
673         elif isinstance(node, Alias):
674             self._resolve_alias(node)
675
676     def _resolve_function_toplevel(self, func):
677         newfunc = self._parse_constructor(func)
678         if not newfunc:
679             newfunc = self._parse_method(func)
680             if not newfunc:
681                 self._resolve_function(func)
682                 return
683         self._resolve_function(newfunc)
684
685     def _pair_boxed_type(self, boxed):
686         name = self._transformer.remove_prefix(boxed.type_name)
687         pair_node = self._get_attribute(name)
688         if not pair_node:
689             boxed_item = GLibBoxedOther(name, boxed.type_name,
690                                         boxed.get_type)
691         elif isinstance(pair_node, Struct):
692             boxed_item = GLibBoxedStruct(pair_node.name, boxed.type_name,
693                                          boxed.get_type)
694             boxed_item.fields = pair_node.fields
695         elif isinstance(pair_node, Union):
696             boxed_item = GLibBoxedUnion(pair_node.name, boxed.type_name,
697                                          boxed.get_type)
698             boxed_item.fields = pair_node.fields
699         else:
700             return False
701         self._add_attribute(boxed_item, replace=True)
702
703     def _resolve_struct(self, node):
704         for field in node.fields:
705             self._resolve_field(field)
706
707     def _resolve_union(self, node):
708         for field in node.fields:
709             self._resolve_field(field)
710
711     def _force_resolve(self, item, allow_unknown=False):
712         if isinstance(item, Unresolved):
713             if item.target in self._private_internal_types:
714                 return None
715             try:
716                 return self._transformer.gtypename_to_giname(item.target,
717                                                              self._names)
718             except KeyError, e:
719                 if allow_unknown:
720                     print "WARNING: Skipping unknown interface %s" % \
721                         (item.target, )
722                     return None
723                 else:
724                     raise
725         if item in self._private_internal_types:
726             return None
727         return item
728
729     def _resolve_glib_interface(self, node):
730         node.parent = self._force_resolve(node.parent)
731         self._resolve_methods(node.methods)
732         self._resolve_properties(node.properties, node)
733         self._resolve_signals(node.signals)
734
735     def _resolve_glib_object(self, node):
736         node.parent = self._force_resolve(node.parent)
737         node.interfaces = filter(None,
738             [self._force_resolve(x, allow_unknown=True)
739                                     for x in node.interfaces])
740         self._resolve_constructors(node.constructors)
741         self._resolve_methods(node.methods)
742         self._resolve_properties(node.properties, node)
743         self._resolve_signals(node.signals)
744         for field in node.fields:
745             self._resolve_field(field)
746
747     def _resolve_glib_boxed(self, node):
748         self._resolve_constructors(node.constructors)
749         self._resolve_methods(node.methods)
750
751     def _resolve_constructors(self, constructors):
752         for ctor in constructors:
753             self._resolve_function(ctor)
754
755     def _resolve_methods(self, methods):
756         for method in methods:
757             self._resolve_function(method)
758
759     def _resolve_signals(self, signals):
760         for signal in signals:
761             self._resolve_function(signal)
762
763     def _resolve_properties(self, properties, context):
764         failed = []
765         for prop in properties:
766             try:
767                 self._resolve_property(prop)
768             except KeyError, e:
769                 failed.append(prop)
770         for fail in failed:
771             print ("WARNING: Deleting object property %r (of %r)" +\
772                        "with unknown type") % (fail, context)
773             properties.remove(fail)
774
775     def _resolve_property(self, prop):
776         prop.type = self._resolve_param_type(prop.type, allow_invalid=False)
777
778     def _adjust_transfer(self, param):
779         # Do GLib/GObject-specific type transformations here
780
781         # Default to full transfer for GObjects
782         if isinstance(param, Parameter):
783             is_out = (param.direction != PARAM_DIRECTION_IN)
784         else:
785             is_out = True
786         if (is_out and
787             param.transfer is None and
788             (param.type.name == 'GObject.Object' or
789              (self._namespace_name == 'GObject'
790               and param.type.name == 'Object'))):
791             param.transfer = 'full'
792
793     def _adjust_throws(self, func):
794         if func.parameters == []:
795             return
796
797         last_param = func.parameters.pop()
798
799         if (last_param.type.name == 'GLib.Error' or
800             (self._namespace_name == 'GLib' and
801              last_param.type.name == 'Error')):
802             func.throws = True
803         else:
804             func.parameters.append(last_param)
805
806     def _resolve_function(self, func):
807         self._resolve_parameters(func.parameters)
808         func.retval.type = self._resolve_param_type(func.retval.type)
809         self._adjust_throws(func)
810         self._adjust_transfer(func.retval)
811
812     def _resolve_parameters(self, parameters):
813         for parameter in parameters:
814             parameter.type = self._resolve_param_type(parameter.type)
815             self._adjust_transfer(parameter)
816
817     def _resolve_field(self, field):
818         if isinstance(field, Callback):
819             self._resolve_function(field)
820             return
821         field.type = self._resolve_param_type(field.type)
822
823     def _resolve_alias(self, alias):
824         alias.target = self._resolve_type_name(alias.target, alias.target)
825
826     # Validation
827
828     def _validate(self, nodes):
829         nodes = list(self._names.names.itervalues())
830         i = 0
831         self._validating = True
832         while True:
833             initlen = len(nodes)
834
835             print "Type resolution; pass=%d" % (i, )
836             nodes = list(self._names.names.itervalues())
837             for node in nodes:
838                 try:
839                     self._resolve_node(node)
840                 except UnknownTypeError, e:
841                     print "WARNING: %s: Deleting %r" % (e, node)
842                     self._remove_attribute(node.name)
843             if len(nodes) == initlen:
844                 break
845             i += 1
846             self._print_statistics()
847         self._validating = False