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.
24 from .ast import (Bitfield, Callback, Enum, Function, Namespace, Member,
25 Parameter, Return, Struct, Field,
26 Type, Array, Alias, Interface, Class, Node, Union,
27 Varargs, Constant, type_name_from_ctype,
28 type_names, TYPE_STRING, BASIC_GIR_TYPES)
29 from .config import DATADIR, GIR_DIR, GIR_SUFFIX
30 from .glibast import GLibBoxed
31 from .girparser import GIRParser
32 from .odict import odict
33 from .sourcescanner import (
34 SourceSymbol, ctype_name, CTYPE_POINTER,
35 CTYPE_BASIC_TYPE, CTYPE_UNION, CTYPE_ARRAY, CTYPE_TYPEDEF,
36 CTYPE_VOID, CTYPE_ENUM, CTYPE_FUNCTION, CTYPE_STRUCT, CTYPE_INVALID,
37 CSYMBOL_TYPE_FUNCTION, CSYMBOL_TYPE_TYPEDEF, CSYMBOL_TYPE_STRUCT,
38 CSYMBOL_TYPE_ENUM, CSYMBOL_TYPE_UNION, CSYMBOL_TYPE_OBJECT,
39 CSYMBOL_TYPE_MEMBER, CSYMBOL_TYPE_ELLIPSIS, CSYMBOL_TYPE_CONST,
41 from .utils import to_underscores
43 _xdg_data_dirs = [x for x in os.environ.get('XDG_DATA_DIRS', '').split(':') \
44 + [DATADIR, '/usr/share'] if x]
47 class SkipError(Exception):
50 class VaListSkipError(SkipError):
54 names = property(lambda self: self._names)
55 aliases = property(lambda self: self._aliases)
56 type_names = property(lambda self: self._type_names)
57 ctypes = property(lambda self: self._ctypes)
60 super(Names, self).__init__()
61 self._names = odict() # Maps from GIName -> (namespace, node)
62 self._aliases = {} # Maps from GIName -> GIName
63 self._type_names = {} # Maps from GTName -> (namespace, node)
64 self._ctypes = {} # Maps from CType -> (namespace, node)
67 class Transformer(object):
69 def __init__(self, cachestore, namespace_name, namespace_version):
70 self._cachestore = cachestore
72 self._namespace = Namespace(namespace_name, namespace_version)
74 self._pkg_config_packages = set()
75 self._typedefs_ns = {}
76 self._strip_prefix = ''
77 self._includes = set()
78 self._includepaths = []
83 def get_includes(self):
86 def set_strip_suffix(self, strip_suffix):
87 self._strip_suffix = strip_suffix
89 def set_strip_prefix(self, strip_prefix):
90 self._strip_prefix = strip_prefix
92 def get_strip_prefix(self):
93 return self._strip_prefix
95 def get_pkgconfig_packages(self):
96 return self._pkg_config_packages
98 def set_source_ast(self, src_ast):
99 self.generator = src_ast
103 for symbol in self.generator.get_symbols():
105 node = self._traverse_one(symbol)
109 return self._namespace
111 def set_include_paths(self, paths):
112 self._includepaths = list(paths)
114 def register_include(self, include):
115 if include in self._includes:
117 filename = self._find_include(include)
118 self._parse_include(filename)
119 self._includes.add(include)
123 def _find_include(self, include):
124 searchdirs = self._includepaths[:]
125 for path in _xdg_data_dirs:
126 searchdirs.append(os.path.join(path, GIR_SUFFIX))
127 searchdirs.append(GIR_DIR)
129 girname = '%s-%s.gir' % (include.name, include.version)
131 path = os.path.join(d, girname)
132 if os.path.exists(path):
134 sys.stderr.write("Couldn't find include %r (search path: %r)\n"\
135 % (girname, searchdirs))
138 def _parse_include(self, filename):
139 parser = self._cachestore.load(filename)
142 parser.set_include_parsing(True)
143 parser.parse(filename)
144 self._cachestore.store(filename, parser)
146 for include in parser.get_includes():
147 self.register_include(include)
149 for pkg in parser.get_pkgconfig_packages():
150 self._pkg_config_packages.add(pkg)
151 namespace = parser.get_namespace()
152 nsname = namespace.name
153 for node in namespace.nodes:
154 if isinstance(node, Alias):
155 self._names.aliases[node.name] = (nsname, node)
156 elif isinstance(node, (GLibBoxed, Interface, Class)):
157 self._names.type_names[node.type_name] = (nsname, node)
158 giname = '%s.%s' % (nsname, node.name)
159 self._names.names[giname] = (nsname, node)
160 if hasattr(node, 'ctype'):
161 self._names.ctypes[node.ctype] = (nsname, node)
162 elif hasattr(node, 'symbol'):
163 self._names.ctypes[node.symbol] = (nsname, node)
165 def _add_node(self, node):
168 if node.name.startswith('_'):
170 self._namespace.nodes.append(node)
171 self._names.names[node.name] = (None, node)
173 def _strip_namespace_func(self, name):
174 prefix = self._namespace.name.lower() + '_'
175 if name.lower().startswith(prefix):
176 name = name[len(prefix):]
178 prefix = to_underscores(self._namespace.name).lower() + '_'
179 if name.lower().startswith(prefix):
180 name = name[len(prefix):]
181 return self.remove_prefix(name, isfunction=True)
183 def remove_prefix(self, name, isfunction=False):
184 # when --strip-prefix=g:
185 # GHashTable -> HashTable
186 # g_hash_table_new -> hash_table_new
188 prefix = self._strip_prefix.lower()
190 if isfunction and '_' in name:
192 if len(name) > len(prefix) and name.lower().startswith(prefix):
193 name = name[len(prefix):]
196 while name.startswith('_'):
199 if (stripped and self._strip_suffix and
200 len(name) > len(self._strip_suffix) and
201 name.endswith(self._strip_suffix)):
202 name = name[:-1*len(self._strip_suffix)]
206 def _traverse_one(self, symbol, stype=None):
207 assert isinstance(symbol, SourceSymbol), symbol
211 if stype == CSYMBOL_TYPE_FUNCTION:
212 return self._create_function(symbol)
213 elif stype == CSYMBOL_TYPE_TYPEDEF:
214 return self._create_typedef(symbol)
215 elif stype == CSYMBOL_TYPE_STRUCT:
216 return self._create_struct(symbol)
217 elif stype == CSYMBOL_TYPE_ENUM:
218 return self._create_enum(symbol)
219 elif stype == CSYMBOL_TYPE_OBJECT:
220 return self._create_object(symbol)
221 elif stype == CSYMBOL_TYPE_MEMBER:
222 return self._create_member(symbol)
223 elif stype == CSYMBOL_TYPE_UNION:
224 return self._create_union(symbol)
225 elif stype == CSYMBOL_TYPE_CONST:
226 return self._create_const(symbol)
228 raise NotImplementedError(
229 'Transformer: unhandled symbol: %r' % (symbol, ))
231 def _enum_common_prefix(self, symbol):
232 def common_prefix(a, b):
234 for aword, bword in zip(a.split('_'), b.split('_')):
236 return '_'.join(commonparts) + '_'
237 commonparts.append(aword)
240 # Nothing less than 2 has a common prefix
241 if len(list(symbol.base_type.child_list)) < 2:
244 for child in symbol.base_type.child_list:
248 prefix = common_prefix(prefix, child.ident)
253 def _create_enum(self, symbol):
254 prefix = self._enum_common_prefix(symbol)
256 prefixlen = len(prefix)
260 for child in symbol.base_type.child_list:
262 name = child.ident[prefixlen:]
264 # Ok, the enum members don't have a consistent prefix
265 # among them, so let's just remove the global namespace
267 name = self.remove_prefix(child.ident)
268 members.append(Member(name.lower(),
272 enum_name = self.remove_prefix(symbol.ident)
273 if symbol.base_type.is_bitfield:
277 node = klass(enum_name, symbol.ident, members)
278 self._names.type_names[symbol.ident] = (None, node)
281 def _create_object(self, symbol):
282 return Member(symbol.ident, symbol.base_type.name,
285 def _type_is_callback(self, type):
286 if isinstance(type, Callback):
288 node = self._names.names.get(type.name)
289 if node and isinstance(node[1], Callback):
293 def _handle_closure(self, param, closure_idx, closure_param):
294 if (closure_param.type.name == 'any' and
295 closure_param.name.endswith('data')):
296 param.closure_name = closure_param.name
297 param.closure_index = closure_idx
301 def _handle_destroy(self, param, destroy_idx, destroy_param):
302 if (destroy_param.type.name == 'GLib.DestroyNotify' or
303 destroy_param.type.ctype == 'GDestroyNotify'):
304 param.destroy_name = destroy_param.name
305 param.destroy_index = destroy_idx
309 def _augment_callback_params(self, params):
310 for i, param in enumerate(params):
311 if not self._type_is_callback(param.type):
314 # set a default scope
315 if param.scope is None:
318 # j is the index where we look for closure/destroy to
319 # group with the callback param
322 continue # no more args -> nothing to group
323 # look at the param directly following for either a
324 # closure or a destroy; only one of these will fire
325 had_closure = self._handle_closure(param, j, params[j])
326 had_destroy = self._handle_destroy(param, j, params[j])
328 # are we out of params, or did we find neither?
329 if j == len(params) or (not had_closure and not had_destroy):
331 # we found either a closure or a destroy; check the
332 # parameter following for the other
334 self._handle_closure(param, j, params[j])
336 self._handle_destroy(param, j, params[j])
338 def _create_function(self, symbol):
339 parameters = list(self._create_parameters(symbol.base_type))
340 return_ = self._create_return(symbol.base_type.base_type)
341 self._augment_callback_params(parameters)
342 name = self._strip_namespace_func(symbol.ident)
343 func = Function(name, return_, parameters, symbol.ident)
346 def _create_source_type(self, source_type):
347 if source_type is None:
349 if source_type.type == CTYPE_VOID:
351 elif source_type.type == CTYPE_BASIC_TYPE:
352 value = source_type.name
353 # skip adding invalid types.
354 # share the const down the tree..
355 if not source_type.base_type:
357 value_add = self._create_source_type(source_type.base_type)
359 value += ' ' + value_add
360 elif source_type.type == CTYPE_TYPEDEF:
361 value = source_type.name
362 elif source_type.type == CTYPE_ARRAY:
363 return self._create_source_type(source_type.base_type)
364 elif source_type.type == CTYPE_POINTER:
365 value = self._create_source_type(source_type.base_type) + '*'
366 elif source_type.type == CTYPE_STRUCT:
367 value = source_type.name
368 elif source_type.type == CTYPE_INVALID:
369 #this happens if const is after the type..
375 def _create_parameters(self, base_type):
377 # warn if we see annotations for unknown parameters
378 param_names = set(child.ident for child in base_type.child_list)
379 for child in base_type.child_list:
380 yield self._create_parameter(child)
382 def _create_member(self, symbol):
383 source_type = symbol.base_type
384 if (source_type.type == CTYPE_POINTER and
385 symbol.base_type.base_type.type == CTYPE_FUNCTION):
387 node = self._create_callback(symbol)
388 except VaListSkipError:
389 #this handles va_list members, and converts them
390 #to unwritable, unreadable void*
391 ftype = Type("any", "void*")
392 ftype = self.resolve_param_type(ftype)
393 node = Field(symbol.ident, ftype, ftype.name,
394 readable=False, writable=False, bits=symbol.const_int)
397 elif source_type.type == CTYPE_STRUCT and source_type.name is None:
398 node = self._create_struct(symbol, anonymous=True)
399 elif source_type.type == CTYPE_UNION and source_type.name is None:
400 node = self._create_union(symbol, anonymous=True)
402 # Special handling for fields; we don't have annotations on them
403 # to apply later, yet.
404 if source_type.type == CTYPE_ARRAY:
405 ctype = self._create_source_type(source_type)
406 canonical_ctype = self._canonicalize_ctype(ctype)
407 if canonical_ctype[-1] == '*':
408 derefed_name = canonical_ctype[:-1]
410 derefed_name = canonical_ctype
411 derefed_name = self.resolve_param_type(derefed_name)
412 ftype = Array(ctype, self.parse_ctype(derefed_name))
413 child_list = list(symbol.base_type.child_list)
414 ftype.zeroterminated = False
416 ftype.size = '%d' % (child_list[0].const_int, )
418 ftype = self._create_type(symbol.base_type,
419 is_param=False, is_retval=False)
420 ftype = self.resolve_param_type(ftype)
421 # Fields are assumed to be read-write
422 # (except for Objects, see also glibtransformer.py)
423 node = Field(symbol.ident, ftype, ftype.name,
424 readable=True, writable=True, bits=symbol.const_int)
427 def _create_typedef(self, symbol):
428 ctype = symbol.base_type.type
429 if (ctype == CTYPE_POINTER and
430 symbol.base_type.base_type.type == CTYPE_FUNCTION):
431 node = self._create_typedef_callback(symbol)
432 # if (ctype == CTYPE_FUNCTION):
433 # node = self._create_typedef_callback(symbol)
434 elif (ctype == CTYPE_POINTER and
435 symbol.base_type.base_type.type == CTYPE_STRUCT):
436 node = self._create_typedef_struct(symbol, disguised=True)
437 elif ctype == CTYPE_STRUCT:
438 node = self._create_typedef_struct(symbol)
439 elif ctype == CTYPE_UNION:
440 node = self._create_typedef_union(symbol)
441 elif ctype == CTYPE_ENUM:
442 return self._create_enum(symbol)
443 elif ctype in (CTYPE_TYPEDEF,
447 name = self.remove_prefix(symbol.ident)
448 if symbol.base_type.name:
449 target = self.remove_prefix(symbol.base_type.name)
450 elif (ctype == CTYPE_POINTER and
451 symbol.base_type.base_type.name):
452 target = self.remove_prefix(
453 symbol.base_type.base_type.name) + '*'
454 elif (ctype == CTYPE_POINTER and
455 symbol.base_type.base_type.type == CTYPE_VOID):
459 if name in type_names:
461 return Alias(name, target, ctype=symbol.ident)
463 raise NotImplementedError(
464 "symbol %r of type %s" % (symbol.ident, ctype_name(ctype)))
467 def _canonicalize_ctype(self, ctype):
468 # First look up the ctype including any pointers;
469 # a few type names like 'char*' have their own aliases
470 # and we need pointer information for those.
471 firstpass = type_name_from_ctype(ctype)
473 # If we have a particular alias for this, skip deep
474 # canonicalization to prevent changing
475 # e.g. char* -> int8*
476 if firstpass != ctype:
479 # We're also done if the type is already a fundamental
480 # known type, or there are no pointers.
481 if ctype in type_names or not firstpass.endswith('*'):
484 # We have a pointer type.
485 # Strip the end pointer, canonicalize our base type
486 base = firstpass[:-1]
487 canonical_base = self._canonicalize_ctype(base)
489 # Append the pointer again
490 canonical = canonical_base + '*'
494 def parse_ctype(self, ctype, is_member=False):
495 canonical = self._canonicalize_ctype(ctype)
497 # Remove all pointers - we require standard calling
498 # conventions. For example, an 'int' is always passed by
499 # value (unless it's out or inout).
500 derefed_typename = canonical.replace('*', '')
502 # Preserve "pointerness" of struct/union members
503 if (is_member and canonical.endswith('*') and
504 derefed_typename in BASIC_GIR_TYPES):
507 return derefed_typename
509 def _create_type(self, source_type, is_param, is_retval):
510 ctype = self._create_source_type(source_type)
511 if ctype.startswith('va_list'):
512 raise VaListSkipError()
513 # FIXME: FILE* should not be skipped, it should be handled
515 elif ctype == 'FILE*':
518 is_member = not (is_param or is_retval)
519 # Here we handle basic type parsing; most of the heavy lifting
520 # and inference comes in annotationparser.py when we merge
521 # in annotation data.
522 derefed_name = self.parse_ctype(ctype, is_member)
523 rettype = Type(derefed_name, ctype)
524 rettype.canonical = self._canonicalize_ctype(ctype)
525 derefed_ctype = ctype.replace('*', '')
526 rettype.derefed_canonical = self._canonicalize_ctype(derefed_ctype)
528 canontype = type_name_from_ctype(ctype)
529 # Is it a const char * or a const gpointer?
530 if ((canontype == TYPE_STRING or source_type.type == CTYPE_POINTER) and
531 (source_type.base_type.type_qualifier & TYPE_QUALIFIER_CONST)):
532 rettype.is_const = True
535 def _create_parameter(self, symbol):
536 if symbol.type == CSYMBOL_TYPE_ELLIPSIS:
539 ptype = self._create_type(symbol.base_type,
540 is_param=True, is_retval=False)
541 ptype = self.resolve_param_type(ptype)
542 return Parameter(symbol.ident, ptype)
544 def _create_return(self, source_type):
545 rtype = self._create_type(source_type,
546 is_param=False, is_retval=True)
547 rtype = self.resolve_param_type(rtype)
548 return_ = Return(rtype)
551 def _create_const(self, symbol):
552 # Don't create constants for non-public things
553 # http://bugzilla.gnome.org/show_bug.cgi?id=572790
554 if (symbol.source_filename is None or
555 not symbol.source_filename.endswith('.h')):
557 name = self.remove_prefix(symbol.ident)
558 if symbol.const_string is not None:
560 value = symbol.const_string
561 elif symbol.const_int is not None:
563 value = symbol.const_int
564 elif symbol.const_double is not None:
566 value = symbol.const_double
568 raise AssertionError()
570 const = Constant(name, type_name, value)
573 def _create_typedef_struct(self, symbol, disguised=False):
574 name = self.remove_prefix(symbol.ident)
575 struct = Struct(name, symbol.ident, disguised)
576 self._typedefs_ns[symbol.ident] = struct
577 self._create_struct(symbol)
580 def _create_typedef_union(self, symbol):
581 name = self.remove_prefix(symbol.ident)
582 union = Union(name, symbol.ident)
583 self._typedefs_ns[symbol.ident] = union
584 self._create_union(symbol)
587 def _create_typedef_callback(self, symbol):
588 callback = self._create_callback(symbol)
589 self._typedefs_ns[callback.name] = callback
592 def _create_compound(self, klass, symbol, anonymous):
593 if symbol.ident is None:
594 # the compound is an anonymous member of another union or a struct
596 compound = klass(None, None)
598 compound = self._typedefs_ns.get(symbol.ident, None)
601 # This is a bit of a hack; really we should try
602 # to resolve through the typedefs to find the real
604 if symbol.ident.startswith('_'):
605 name = symbol.ident[1:]
606 compound = self._typedefs_ns.get(name, None)
610 name = self.remove_prefix(name)
611 compound = klass(name, symbol.ident)
613 for child in symbol.base_type.child_list:
614 field = self._traverse_one(child)
616 compound.fields.append(field)
620 def _create_struct(self, symbol, anonymous=False):
621 return self._create_compound(Struct, symbol, anonymous)
623 def _create_union(self, symbol, anonymous=False):
624 return self._create_compound(Union, symbol, anonymous)
626 def _create_callback(self, symbol):
627 parameters = list(self._create_parameters(symbol.base_type.base_type))
628 retval = self._create_return(symbol.base_type.base_type.base_type)
629 ret_type = symbol.base_type.base_type.base_type
631 ret_type = symbol.base_type.base_type
632 retval = self._create_return(ret_type)
634 # Mark the 'user_data' arguments
635 for i, param in enumerate(parameters):
636 if (param.type.name == 'any' and
637 param.name == 'user_data'):
638 param.closure_index = i
640 if symbol.ident.find('_') > 0:
641 name = self.remove_prefix(symbol.ident, True)
643 name = self.remove_prefix(symbol.ident)
644 callback = Callback(name, retval, parameters, symbol.ident)
648 def _typepair_to_str(self, item):
652 return '%s.%s' % (nsname, item.name)
654 def _resolve_type_name_1(self, type_name, ctype, names):
655 # First look using the built-in names
658 return type_names[ctype]
662 return type_names[type_name]
667 ctype = ctype.replace('*', '')
668 resolved = names.ctypes.get(ctype)
670 return self._typepair_to_str(resolved)
671 type_name = self.remove_prefix(type_name)
672 resolved = names.aliases.get(type_name)
674 return self._typepair_to_str(resolved)
675 resolved = names.names.get(type_name)
677 return self._typepair_to_str(resolved)
678 resolved = names.type_names.get(type_name)
680 return self._typepair_to_str(resolved)
681 raise KeyError("failed to find %r" % (type_name, ))
683 def resolve_type_name_full(self, type_name, ctype,
684 names, allow_invalid=True):
686 return self._resolve_type_name_1(type_name, ctype, names)
689 return self._resolve_type_name_1(type_name, ctype, self._names)
691 if not allow_invalid:
695 def resolve_type_name(self, type_name, ctype=None):
697 return self.resolve_type_name_full(type_name, ctype, self._names)
701 def gtypename_to_giname(self, gtname, names):
702 resolved = names.type_names.get(gtname)
704 return self._typepair_to_str(resolved)
705 resolved = self._names.type_names.get(gtname)
707 return self._typepair_to_str(resolved)
708 raise KeyError("Failed to resolve GType name: %r" % (gtname, ))
710 def ctype_of(self, obj):
711 if hasattr(obj, 'ctype'):
713 elif hasattr(obj, 'symbol'):
718 def resolve_param_type_full(self, ptype, names, **kwargs):
719 if isinstance(ptype, Node):
720 ptype.name = self.resolve_type_name_full(ptype.name,
721 self.ctype_of(ptype),
723 elif isinstance(ptype, basestring):
724 return self.resolve_type_name_full(ptype, ptype, names, **kwargs)
726 raise AssertionError("Unhandled param: %r" % (ptype, ))
729 def resolve_param_type(self, ptype):
731 return self.resolve_param_type_full(ptype, self._names)
735 def follow_aliases(self, type_name, names):
737 resolved = names.aliases.get(type_name)
739 (ns, alias) = resolved
740 type_name = alias.target
745 def iter_enums(self):
746 for node in self._namespace.nodes:
747 if isinstance(node, Enum):