2 # GObject-Introspection - a framework for introspecting GObject libraries
3 # Copyright (C) 2008 Johan Dahlin
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2 of the License, or (at your option) any later version.
10 # This library 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 GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the
17 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 # Boston, MA 02111-1307, USA.
23 from .ast import (Bitfield, Callback, Enum, Function, Namespace, Member,
24 Parameter, Return, Struct, Field,
25 Type, Array, Alias, Interface, Class, Node, Union,
26 Varargs, Constant, type_name_from_ctype,
27 type_names, TYPE_STRING, BASIC_GIR_TYPES)
28 from .config import DATADIR, GIR_DIR, GIR_SUFFIX
29 from .glibast import GLibBoxed
30 from .girparser import GIRParser
31 from .odict import odict
32 from .sourcescanner import (
33 SourceSymbol, ctype_name, CTYPE_POINTER,
34 CTYPE_BASIC_TYPE, CTYPE_UNION, CTYPE_ARRAY, CTYPE_TYPEDEF,
35 CTYPE_VOID, CTYPE_ENUM, CTYPE_FUNCTION, CTYPE_STRUCT,
36 CSYMBOL_TYPE_FUNCTION, CSYMBOL_TYPE_TYPEDEF, CSYMBOL_TYPE_STRUCT,
37 CSYMBOL_TYPE_ENUM, CSYMBOL_TYPE_UNION, CSYMBOL_TYPE_OBJECT,
38 CSYMBOL_TYPE_MEMBER, CSYMBOL_TYPE_ELLIPSIS, CSYMBOL_TYPE_CONST,
40 from .utils import to_underscores
42 _xdg_data_dirs = [x for x in os.environ.get('XDG_DATA_DIRS', '').split(':') \
43 + [DATADIR, '/usr/share'] if x]
46 class SkipError(Exception):
51 names = property(lambda self: self._names)
52 aliases = property(lambda self: self._aliases)
53 type_names = property(lambda self: self._type_names)
54 ctypes = property(lambda self: self._ctypes)
57 super(Names, self).__init__()
58 self._names = odict() # Maps from GIName -> (namespace, node)
59 self._aliases = {} # Maps from GIName -> GIName
60 self._type_names = {} # Maps from GTName -> (namespace, node)
61 self._ctypes = {} # Maps from CType -> (namespace, node)
64 class Transformer(object):
66 def __init__(self, cachestore, namespace_name, namespace_version):
67 self._cachestore = cachestore
69 self._namespace = Namespace(namespace_name, namespace_version)
71 self._pkg_config_packages = set()
72 self._typedefs_ns = {}
73 self._strip_prefix = ''
74 self._includes = set()
75 self._includepaths = []
80 def get_includes(self):
83 def set_strip_prefix(self, strip_prefix):
84 self._strip_prefix = strip_prefix
86 def get_strip_prefix(self):
87 return self._strip_prefix
89 def get_pkgconfig_packages(self):
90 return self._pkg_config_packages
92 def set_source_ast(self, src_ast):
93 self.generator = src_ast
97 for symbol in self.generator.get_symbols():
99 node = self._traverse_one(symbol)
103 return self._namespace
105 def set_include_paths(self, paths):
106 self._includepaths = list(paths)
108 def register_include(self, include):
109 if include in self._includes:
111 filename = self._find_include(include)
112 self._parse_include(filename)
113 self._includes.add(include)
117 def _find_include(self, include):
118 searchdirs = self._includepaths[:]
119 for path in _xdg_data_dirs:
120 searchdirs.append(os.path.join(path, GIR_SUFFIX))
121 searchdirs.append(GIR_DIR)
123 girname = '%s-%s.gir' % (include.name, include.version)
125 path = os.path.join(d, girname)
126 if os.path.exists(path):
128 sys.stderr.write("Couldn't find include %r (search path: %r)\n"\
129 % (girname, searchdirs))
132 def _parse_include(self, filename):
133 parser = self._cachestore.load(filename)
136 parser.set_include_parsing(True)
137 parser.parse(filename)
138 self._cachestore.store(filename, parser)
140 for include in parser.get_includes():
141 self.register_include(include)
143 for pkg in parser.get_pkgconfig_packages():
144 self._pkg_config_packages.add(pkg)
145 namespace = parser.get_namespace()
146 nsname = namespace.name
147 for node in namespace.nodes:
148 if isinstance(node, Alias):
149 self._names.aliases[node.name] = (nsname, node)
150 elif isinstance(node, (GLibBoxed, Interface, Class)):
151 self._names.type_names[node.type_name] = (nsname, node)
152 giname = '%s.%s' % (nsname, node.name)
153 self._names.names[giname] = (nsname, node)
154 if hasattr(node, 'ctype'):
155 self._names.ctypes[node.ctype] = (nsname, node)
156 elif hasattr(node, 'symbol'):
157 self._names.ctypes[node.symbol] = (nsname, node)
159 def _add_node(self, node):
162 if node.name.startswith('_'):
164 self._namespace.nodes.append(node)
165 self._names.names[node.name] = (None, node)
167 def _strip_namespace_func(self, name):
168 prefix = self._namespace.name.lower() + '_'
169 if name.lower().startswith(prefix):
170 name = name[len(prefix):]
172 prefix = to_underscores(self._namespace.name).lower() + '_'
173 if name.lower().startswith(prefix):
174 name = name[len(prefix):]
175 return self.remove_prefix(name, isfunction=True)
177 def remove_prefix(self, name, isfunction=False):
178 # when --strip-prefix=g:
179 # GHashTable -> HashTable
180 # g_hash_table_new -> hash_table_new
181 prefix = self._strip_prefix.lower()
184 if len(name) > len(prefix) and name.lower().startswith(prefix):
185 name = name[len(prefix):]
187 while name.startswith('_'):
191 def _traverse_one(self, symbol, stype=None):
192 assert isinstance(symbol, SourceSymbol), symbol
196 if stype == CSYMBOL_TYPE_FUNCTION:
197 return self._create_function(symbol)
198 elif stype == CSYMBOL_TYPE_TYPEDEF:
199 return self._create_typedef(symbol)
200 elif stype == CSYMBOL_TYPE_STRUCT:
201 return self._create_struct(symbol)
202 elif stype == CSYMBOL_TYPE_ENUM:
203 return self._create_enum(symbol)
204 elif stype == CSYMBOL_TYPE_OBJECT:
205 return self._create_object(symbol)
206 elif stype == CSYMBOL_TYPE_MEMBER:
207 return self._create_member(symbol)
208 elif stype == CSYMBOL_TYPE_UNION:
209 return self._create_union(symbol)
210 elif stype == CSYMBOL_TYPE_CONST:
211 return self._create_const(symbol)
213 raise NotImplementedError(
214 'Transformer: unhandled symbol: %r' % (symbol, ))
216 def _enum_common_prefix(self, symbol):
217 def common_prefix(a, b):
219 for aword, bword in zip(a.split('_'), b.split('_')):
221 return '_'.join(commonparts) + '_'
222 commonparts.append(aword)
225 # Nothing less than 2 has a common prefix
226 if len(list(symbol.base_type.child_list)) < 2:
229 for child in symbol.base_type.child_list:
233 prefix = common_prefix(prefix, child.ident)
238 def _create_enum(self, symbol):
239 prefix = self._enum_common_prefix(symbol)
241 prefixlen = len(prefix)
245 for child in symbol.base_type.child_list:
247 name = child.ident[prefixlen:]
249 # Ok, the enum members don't have a consistent prefix
250 # among them, so let's just remove the global namespace
252 name = self.remove_prefix(child.ident)
253 members.append(Member(name.lower(),
257 enum_name = self.remove_prefix(symbol.ident)
258 if symbol.base_type.is_bitfield:
262 node = klass(enum_name, symbol.ident, members)
263 self._names.type_names[symbol.ident] = (None, node)
266 def _create_object(self, symbol):
267 return Member(symbol.ident, symbol.base_type.name,
270 def _type_is_callback(self, type):
271 if isinstance(type, Callback):
273 node = self._names.names.get(type.name)
274 if node and isinstance(node[1], Callback):
278 def _handle_closure(self, param, closure_idx, closure_param):
279 if (closure_param.type.name == 'any' and
280 closure_param.name.endswith('data')):
281 param.closure_name = closure_param.name
282 param.closure_index = closure_idx
286 def _handle_destroy(self, param, destroy_idx, destroy_param):
287 if (destroy_param.type.name == 'GLib.DestroyNotify' or
288 destroy_param.type.ctype == 'GDestroyNotify'):
289 param.destroy_name = destroy_param.name
290 param.destroy_index = destroy_idx
294 def _augment_callback_params(self, params):
295 for i, param in enumerate(params):
296 if not self._type_is_callback(param.type):
299 # set a default scope
300 if param.scope is None:
303 # j is the index where we look for closure/destroy to
304 # group with the callback param
307 continue # no more args -> nothing to group
308 # look at the param directly following for either a
309 # closure or a destroy; only one of these will fire
310 had_closure = self._handle_closure(param, j, params[j])
311 had_destroy = self._handle_destroy(param, j, params[j])
313 # are we out of params, or did we find neither?
314 if j == len(params) or (not had_closure and not had_destroy):
316 # we found either a closure or a destroy; check the
317 # parameter following for the other
319 self._handle_closure(param, j, params[j])
321 self._handle_destroy(param, j, params[j])
323 def _create_function(self, symbol):
324 parameters = list(self._create_parameters(symbol.base_type))
325 return_ = self._create_return(symbol.base_type.base_type)
326 self._augment_callback_params(parameters)
327 name = self._strip_namespace_func(symbol.ident)
328 func = Function(name, return_, parameters, symbol.ident)
331 def _create_source_type(self, source_type):
332 if source_type is None:
334 if source_type.type == CTYPE_VOID:
336 elif source_type.type == CTYPE_BASIC_TYPE:
337 value = source_type.name
338 elif source_type.type == CTYPE_TYPEDEF:
339 value = source_type.name
340 elif source_type.type == CTYPE_ARRAY:
341 return self._create_source_type(source_type.base_type)
342 elif source_type.type == CTYPE_POINTER:
343 value = self._create_source_type(source_type.base_type) + '*'
348 def _create_parameters(self, base_type):
350 # warn if we see annotations for unknown parameters
351 param_names = set(child.ident for child in base_type.child_list)
352 for child in base_type.child_list:
353 yield self._create_parameter(child)
355 def _create_member(self, symbol):
356 source_type = symbol.base_type
357 if (source_type.type == CTYPE_POINTER and
358 symbol.base_type.base_type.type == CTYPE_FUNCTION):
359 node = self._create_callback(symbol)
360 elif source_type.type == CTYPE_STRUCT and source_type.name is None:
361 node = self._create_struct(symbol, anonymous=True)
362 elif source_type.type == CTYPE_UNION and source_type.name is None:
363 node = self._create_union(symbol, anonymous=True)
365 # Special handling for fields; we don't have annotations on them
366 # to apply later, yet.
367 if source_type.type == CTYPE_ARRAY:
368 ctype = self._create_source_type(source_type)
369 canonical_ctype = self._canonicalize_ctype(ctype)
370 if canonical_ctype[-1] == '*':
371 derefed_name = canonical_ctype[:-1]
373 derefed_name = canonical_ctype
374 derefed_name = self.resolve_param_type(derefed_name)
375 ftype = Array(ctype, self.parse_ctype(derefed_name))
376 child_list = list(symbol.base_type.child_list)
377 ftype.zeroterminated = False
379 ftype.size = '%d' % (child_list[0].const_int, )
381 ftype = self._create_type(symbol.base_type,
382 is_param=False, is_retval=False)
383 ftype = self.resolve_param_type(ftype)
384 # Fields are assumed to be read-write
385 # (except for Objects, see also glibtransformer.py)
386 node = Field(symbol.ident, ftype, ftype.name,
387 readable=True, writable=True, bits=symbol.const_int)
390 def _create_typedef(self, symbol):
391 ctype = symbol.base_type.type
392 if (ctype == CTYPE_POINTER and
393 symbol.base_type.base_type.type == CTYPE_FUNCTION):
394 node = self._create_typedef_callback(symbol)
395 elif (ctype == CTYPE_POINTER and
396 symbol.base_type.base_type.type == CTYPE_STRUCT):
397 node = self._create_typedef_struct(symbol, disguised=True)
398 elif ctype == CTYPE_STRUCT:
399 node = self._create_typedef_struct(symbol)
400 elif ctype == CTYPE_UNION:
401 node = self._create_typedef_union(symbol)
402 elif ctype == CTYPE_ENUM:
403 return self._create_enum(symbol)
404 elif ctype in (CTYPE_TYPEDEF,
408 name = self.remove_prefix(symbol.ident)
409 if symbol.base_type.name:
410 target = self.remove_prefix(symbol.base_type.name)
413 if name in type_names:
415 return Alias(name, target, ctype=symbol.ident)
417 raise NotImplementedError(
418 "symbol %r of type %s" % (symbol.ident, ctype_name(ctype)))
421 def _canonicalize_ctype(self, ctype):
422 # First look up the ctype including any pointers;
423 # a few type names like 'char*' have their own aliases
424 # and we need pointer information for those.
425 firstpass = type_name_from_ctype(ctype)
427 # If we have a particular alias for this, skip deep
428 # canonicalization to prevent changing
429 # e.g. char* -> int8*
430 if firstpass != ctype:
433 # We're also done if the type is already a fundamental
434 # known type, or there are no pointers.
435 if ctype in type_names or not firstpass.endswith('*'):
438 # We have a pointer type.
439 # Strip the end pointer, canonicalize our base type
440 base = firstpass[:-1]
441 canonical_base = self._canonicalize_ctype(base)
443 # Append the pointer again
444 canonical = canonical_base + '*'
448 def parse_ctype(self, ctype, is_member=False):
449 canonical = self._canonicalize_ctype(ctype)
451 # Remove all pointers - we require standard calling
452 # conventions. For example, an 'int' is always passed by
453 # value (unless it's out or inout).
454 derefed_typename = canonical.replace('*', '')
456 # Preserve "pointerness" of struct/union members
457 if (is_member and canonical.endswith('*') and
458 derefed_typename in BASIC_GIR_TYPES):
461 return derefed_typename
463 def _create_type(self, source_type, is_param, is_retval):
464 ctype = self._create_source_type(source_type)
465 if ctype.startswith('va_list'):
467 # FIXME: FILE* should not be skipped, it should be handled
469 elif ctype == 'FILE*':
472 is_member = not (is_param or is_retval)
473 # Here we handle basic type parsing; most of the heavy lifting
474 # and inference comes in annotationparser.py when we merge
475 # in annotation data.
476 derefed_name = self.parse_ctype(ctype, is_member)
477 rettype = Type(derefed_name, ctype)
478 rettype.canonical = self._canonicalize_ctype(ctype)
479 derefed_ctype = ctype.replace('*', '')
480 rettype.derefed_canonical = self._canonicalize_ctype(derefed_ctype)
482 canontype = type_name_from_ctype(ctype)
483 # Is it a const char * or a const gpointer?
484 if ((canontype == TYPE_STRING or source_type.type == CTYPE_POINTER) and
485 (source_type.base_type.type_qualifier & TYPE_QUALIFIER_CONST)):
486 rettype.is_const = True
489 def _create_parameter(self, symbol):
490 if symbol.type == CSYMBOL_TYPE_ELLIPSIS:
493 ptype = self._create_type(symbol.base_type,
494 is_param=True, is_retval=False)
495 ptype = self.resolve_param_type(ptype)
496 return Parameter(symbol.ident, ptype)
498 def _create_return(self, source_type):
499 rtype = self._create_type(source_type,
500 is_param=False, is_retval=True)
501 rtype = self.resolve_param_type(rtype)
502 return_ = Return(rtype)
505 def _create_const(self, symbol):
506 # Don't create constants for non-public things
507 # http://bugzilla.gnome.org/show_bug.cgi?id=572790
508 if (symbol.source_filename is None or
509 not symbol.source_filename.endswith('.h')):
511 name = self.remove_prefix(symbol.ident)
512 if symbol.const_string is not None:
514 value = symbol.const_string
515 elif symbol.const_int is not None:
517 value = symbol.const_int
518 elif symbol.const_double is not None:
520 value = symbol.const_double
522 raise AssertionError()
524 const = Constant(name, type_name, value)
527 def _create_typedef_struct(self, symbol, disguised=False):
528 name = self.remove_prefix(symbol.ident)
529 struct = Struct(name, symbol.ident, disguised)
530 self._typedefs_ns[symbol.ident] = struct
531 self._create_struct(symbol)
534 def _create_typedef_union(self, symbol):
535 name = self.remove_prefix(symbol.ident)
536 union = Union(name, symbol.ident)
537 self._typedefs_ns[symbol.ident] = union
538 self._create_union(symbol)
541 def _create_typedef_callback(self, symbol):
542 callback = self._create_callback(symbol)
543 self._typedefs_ns[callback.name] = callback
546 def _create_compound(self, klass, symbol, anonymous):
547 if symbol.ident is None:
548 # the compound is an anonymous member of another union or a struct
550 compound = klass(None, None)
552 compound = self._typedefs_ns.get(symbol.ident, None)
555 # This is a bit of a hack; really we should try
556 # to resolve through the typedefs to find the real
558 if symbol.ident.startswith('_'):
559 name = symbol.ident[1:]
560 compound = self._typedefs_ns.get(name, None)
564 name = self.remove_prefix(name)
565 compound = klass(name, symbol.ident)
567 for child in symbol.base_type.child_list:
568 field = self._traverse_one(child)
570 compound.fields.append(field)
574 def _create_struct(self, symbol, anonymous=False):
575 return self._create_compound(Struct, symbol, anonymous)
577 def _create_union(self, symbol, anonymous=False):
578 return self._create_compound(Union, symbol, anonymous)
580 def _create_callback(self, symbol):
581 parameters = list(self._create_parameters(symbol.base_type.base_type))
582 retval = self._create_return(symbol.base_type.base_type.base_type)
584 # Mark the 'user_data' arguments
585 for i, param in enumerate(parameters):
586 if (param.type.name == 'any' and
587 param.name == 'user_data'):
588 param.closure_index = i
590 if symbol.ident.find('_') > 0:
591 name = self.remove_prefix(symbol.ident, True)
593 name = self.remove_prefix(symbol.ident)
594 callback = Callback(name, retval, parameters, symbol.ident)
598 def _typepair_to_str(self, item):
602 return '%s.%s' % (nsname, item.name)
604 def _resolve_type_name_1(self, type_name, ctype, names):
605 # First look using the built-in names
608 return type_names[ctype]
612 return type_names[type_name]
617 ctype = ctype.replace('*', '')
618 resolved = names.ctypes.get(ctype)
620 return self._typepair_to_str(resolved)
621 type_name = self.remove_prefix(type_name)
622 resolved = names.aliases.get(type_name)
624 return self._typepair_to_str(resolved)
625 resolved = names.names.get(type_name)
627 return self._typepair_to_str(resolved)
628 resolved = names.type_names.get(type_name)
630 return self._typepair_to_str(resolved)
631 raise KeyError("failed to find %r" % (type_name, ))
633 def resolve_type_name_full(self, type_name, ctype,
634 names, allow_invalid=True):
636 return self._resolve_type_name_1(type_name, ctype, names)
639 return self._resolve_type_name_1(type_name, ctype, self._names)
641 if not allow_invalid:
645 def resolve_type_name(self, type_name, ctype=None):
647 return self.resolve_type_name_full(type_name, ctype, self._names)
651 def gtypename_to_giname(self, gtname, names):
652 resolved = names.type_names.get(gtname)
654 return self._typepair_to_str(resolved)
655 resolved = self._names.type_names.get(gtname)
657 return self._typepair_to_str(resolved)
658 raise KeyError("Failed to resolve GType name: %r" % (gtname, ))
660 def ctype_of(self, obj):
661 if hasattr(obj, 'ctype'):
663 elif hasattr(obj, 'symbol'):
668 def resolve_param_type_full(self, ptype, names, **kwargs):
669 if isinstance(ptype, Node):
670 ptype.name = self.resolve_type_name_full(ptype.name,
671 self.ctype_of(ptype),
673 elif isinstance(ptype, basestring):
674 return self.resolve_type_name_full(ptype, ptype, names, **kwargs)
676 raise AssertionError("Unhandled param: %r" % (ptype, ))
679 def resolve_param_type(self, ptype):
681 return self.resolve_param_type_full(ptype, self._names)
685 def follow_aliases(self, type_name, names):
687 resolved = names.aliases.get(type_name)
689 (ns, alias) = resolved
690 type_name = alias.target