giscanner/ast.py

   1 # -*- Mode: Python -*-
   2 # GObject-Introspection - a framework for introspecting GObject libraries
   3 # Copyright (C) 2008  Johan Dahlin
   4 # Copyright (C) 2008, 2009 Red Hat, Inc.
   5 #
   6 # This library is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU Lesser General Public
   8 # License as published by the Free Software Foundation; either
   9 # version 2 of the License, or (at your option) any later version.
  10 #
  11 # This library is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # Lesser General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU Lesser General Public
  17 # License along with this library; if not, write to the
  18 # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 # Boston, MA 02111-1307, USA.
  20 #
  21
  22 import copy
  23
  24 from . import message
  25
  26 from .message import Position
  27 from .odict import odict
  28 from .utils import to_underscores
  29
  30 class Type(object):
  31     """A Type can be either:
  32 * A reference to a node (target_giname)
  33 * A reference to a "fundamental" type like 'utf8'
  34 * A "foreign" type - this can be any string."
  35 If none are specified, then it's in an "unresolved" state.  An
  36 unresolved type can have two data sources; a "ctype" which comes
  37 from a C type string, or a gtype_name (from g_type_name()).
  38 """ # '''
  39
  40     def __init__(self,
  41                  ctype=None,
  42                  gtype_name=None,
  43                  target_fundamental=None,
  44                  target_giname=None,
  45                  target_foreign=None,
  46                  _target_unknown=False,
  47                  is_const=False,
  48                  origin_symbol=None,
  49                  complete_ctype=None):
  50         self.ctype = ctype
  51         self.gtype_name = gtype_name
  52         self.origin_symbol = origin_symbol
  53         if _target_unknown:
  54             assert isinstance(self, TypeUnknown)
  55         elif target_fundamental:
  56             assert target_giname is None
  57             assert target_foreign is None
  58         elif target_giname:
  59             assert '.' in target_giname
  60             assert target_fundamental is None
  61             assert target_foreign is None
  62         elif target_foreign:
  63             assert ctype is not None
  64             assert target_giname is None
  65             assert target_fundamental is None
  66         else:
  67             assert (ctype is not None) or (gtype_name is not None)
  68         self.target_fundamental = target_fundamental
  69         self.target_giname = target_giname
  70         self.target_foreign = target_foreign
  71         self.is_const = is_const
  72         self.complete_ctype = complete_ctype
  73
  74     @property
  75     def resolved(self):
  76         return (self.target_fundamental or
  77                 self.target_giname or
  78                 self.target_foreign)
  79
  80     @property
  81     def unresolved_string(self):
  82         if self.ctype:
  83             return self.ctype
  84         elif self.gtype_name:
  85             return self.gtype_name
  86         else:
  87             assert False
  88
  89     @classmethod
  90     def create_from_gtype_name(cls, gtype_name):
  91         """Parse a GType name (as from g_type_name()), and return a
  92 Type instance.  Note that this function performs namespace lookup,
  93 in contrast to the other create_type() functions."""
  94         # First, is it a fundamental?
  95         fundamental = type_names.get(gtype_name)
  96         if fundamental is not None:
  97             return cls(target_fundamental=fundamental.target_fundamental)
  98         if gtype_name == 'GHashTable':
  99             return Map(TYPE_ANY, TYPE_ANY, gtype_name=gtype_name)
 100         elif gtype_name in ('GArray', 'GPtrArray', 'GByteArray'):
 101             return Array('GLib.' + gtype_name[1:], TYPE_ANY,
 102                          gtype_name=gtype_name)
 103         elif gtype_name == 'GStrv':
 104             bare_utf8 = TYPE_STRING.clone()
 105             bare_utf8.ctype = None
 106             return Array(None, bare_utf8, ctype=None, gtype_name=gtype_name,
 107                          is_const=False)
 108
 109         # Workaround for Gdk.Rectangle being boxed alias for
 110         # cairo.RectangleInt.  G-I does not support boxing of aliases.
 111         # See https://bugzilla.gnome.org/show_bug.cgi?id=655423
 112         if gtype_name == 'GdkRectangle':
 113             gtype_name = 'CairoRectangleInt'
 114
 115         return cls(gtype_name=gtype_name)
 116
 117     def get_giname(self):
 118         assert self.target_giname is not None
 119         return self.target_giname.split('.')[1]
 120
 121     def __cmp__(self, other):
 122         if self.target_fundamental:
 123             return cmp(self.target_fundamental, other.target_fundamental)
 124         if self.target_giname:
 125             return cmp(self.target_giname, other.target_giname)
 126         if self.target_foreign:
 127             return cmp(self.target_foreign, other.target_foreign)
 128         return cmp(self.ctype, other.ctype)
 129
 130     def is_equiv(self, typeval):
 131         """Return True if the specified types are compatible at
 132         an introspection level, disregarding their C types.
 133         A sequence may be given for typeval, in which case
 134         this function returns True if the type is compatible with
 135         any."""
 136         if isinstance(typeval, (list, tuple)):
 137             for val in typeval:
 138                 if self.is_equiv(val):
 139                     return True
 140             return False
 141         return self == typeval
 142
 143     def clone(self):
 144         return Type(target_fundamental=self.target_fundamental,
 145                     target_giname=self.target_giname,
 146                     target_foreign=self.target_foreign,
 147                     ctype=self.ctype,
 148                     is_const=self.is_const)
 149
 150     def __str__(self):
 151         if self.target_fundamental:
 152             return self.target_fundamental
 153         elif self.target_giname:
 154             return self.target_giname
 155         elif self.target_foreign:
 156             return self.target_foreign
 157
 158     def __repr__(self):
 159         if self.target_fundamental:
 160             data = 'target_fundamental=%s, ' % (self.target_fundamental, )
 161         elif self.target_giname:
 162             data = 'target_giname=%s, ' % (self.target_giname, )
 163         elif self.target_foreign:
 164             data = 'target_foreign=%s, ' % (self.target_foreign, )
 165         else:
 166             data = ''
 167         return '%s(%sctype=%s)' % (self.__class__.__name__, data, self.ctype)
 168
 169 class TypeUnknown(Type):
 170     def __init__(self):
 171         Type.__init__(self, _target_unknown=True)
 172
 173 ######
 174 ## Fundamental types
 175 ######
 176 # Two special ones
 177 TYPE_NONE = Type(target_fundamental='none', ctype='void')
 178 TYPE_ANY = Type(target_fundamental='gpointer', ctype='gpointer')
 179 # "Basic" types
 180 TYPE_BOOLEAN = Type(target_fundamental='gboolean', ctype='gboolean')
 181 TYPE_INT8 = Type(target_fundamental='gint8', ctype='gint8')
 182 TYPE_UINT8 = Type(target_fundamental='guint8', ctype='guint8')
 183 TYPE_INT16 = Type(target_fundamental='gint16', ctype='gint16')
 184 TYPE_UINT16 = Type(target_fundamental='guint16', ctype='guint16')
 185 TYPE_INT32 = Type(target_fundamental='gint32', ctype='gint32')
 186 TYPE_UINT32 = Type(target_fundamental='guint32', ctype='guint32')
 187 TYPE_INT64 = Type(target_fundamental='gint64', ctype='gint64')
 188 TYPE_UINT64 = Type(target_fundamental='guint64', ctype='guint64')
 189 TYPE_CHAR = Type(target_fundamental='gchar', ctype='gchar')
 190 TYPE_SHORT = Type(target_fundamental='gshort', ctype='gshort')
 191 TYPE_USHORT = Type(target_fundamental='gushort', ctype='gushort')
 192 TYPE_INT = Type(target_fundamental='gint', ctype='gint')
 193 TYPE_UINT = Type(target_fundamental='guint', ctype='guint')
 194 TYPE_LONG = Type(target_fundamental='glong', ctype='glong')
 195 TYPE_ULONG = Type(target_fundamental='gulong', ctype='gulong')
 196 TYPE_SIZE = Type(target_fundamental='gsize', ctype='gsize')
 197 TYPE_SSIZE = Type(target_fundamental='gssize', ctype='gssize')
 198 TYPE_INTPTR = Type(target_fundamental='gintptr', ctype='gintptr')
 199 TYPE_UINTPTR = Type(target_fundamental='guintptr', ctype='guintptr')
 200 # C99 types
 201 TYPE_LONG_LONG = Type(target_fundamental='long long', ctype='long long')
 202 TYPE_LONG_ULONG = Type(target_fundamental='unsigned long long',
 203                        ctype='unsigned long long')
 204 TYPE_FLOAT = Type(target_fundamental='gfloat', ctype='gfloat')
 205 TYPE_DOUBLE = Type(target_fundamental='gdouble', ctype='gdouble')
 206 # ?
 207 TYPE_LONG_DOUBLE = Type(target_fundamental='long double',
 208                         ctype='long double')
 209 TYPE_UNICHAR = Type(target_fundamental='gunichar', ctype='gunichar')
 210
 211 # C types with semantics overlaid
 212 TYPE_GTYPE = Type(target_fundamental='GType', ctype='GType')
 213 TYPE_STRING = Type(target_fundamental='utf8', ctype='gchar*')
 214 TYPE_FILENAME = Type(target_fundamental='filename', ctype='gchar*')
 215
 216 TYPE_VALIST = Type(target_fundamental='va_list', ctype='va_list')
 217
 218 BASIC_GIR_TYPES = [TYPE_BOOLEAN, TYPE_INT8, TYPE_UINT8, TYPE_INT16,
 219                    TYPE_UINT16, TYPE_INT32, TYPE_UINT32, TYPE_INT64,
 220                    TYPE_UINT64, TYPE_CHAR, TYPE_SHORT, TYPE_USHORT, TYPE_INT,
 221                    TYPE_UINT, TYPE_LONG, TYPE_ULONG, TYPE_SIZE, TYPE_SSIZE,
 222                    TYPE_LONG_LONG, TYPE_LONG_ULONG, TYPE_INTPTR, TYPE_UINTPTR,
 223                    TYPE_FLOAT, TYPE_DOUBLE,
 224                    TYPE_LONG_DOUBLE, TYPE_UNICHAR, TYPE_GTYPE]
 225 GIR_TYPES = [TYPE_NONE, TYPE_ANY]
 226 GIR_TYPES.extend(BASIC_GIR_TYPES)
 227 GIR_TYPES.extend([TYPE_STRING, TYPE_FILENAME, TYPE_VALIST])
 228
 229 # These are the only basic types that are guaranteed to
 230 # be as big as a pointer (and thus are allowed in GPtrArray)
 231 POINTER_TYPES = [TYPE_ANY, TYPE_INTPTR, TYPE_UINTPTR]
 232
 233 INTROSPECTABLE_BASIC = list(GIR_TYPES)
 234 for v in [TYPE_NONE, TYPE_ANY,
 235           TYPE_LONG_LONG, TYPE_LONG_ULONG,
 236           TYPE_LONG_DOUBLE, TYPE_VALIST]:
 237     INTROSPECTABLE_BASIC.remove(v)
 238
 239 type_names = {}
 240 for typeval in GIR_TYPES:
 241     type_names[typeval.target_fundamental] = typeval
 242 basic_type_names = {}
 243 for typeval in BASIC_GIR_TYPES:
 244     basic_type_names[typeval.target_fundamental] = typeval
 245
 246 # C builtin
 247 type_names['char'] = TYPE_CHAR
 248 type_names['signed char'] = TYPE_INT8
 249 type_names['unsigned char'] = TYPE_UINT8
 250 type_names['short'] = TYPE_SHORT
 251 type_names['signed short'] = TYPE_SHORT
 252 type_names['unsigned short'] = TYPE_USHORT
 253 type_names['int'] = TYPE_INT
 254 type_names['signed int'] = TYPE_INT
 255 type_names['unsigned short int'] = TYPE_USHORT
 256 type_names['signed'] = TYPE_INT
 257 type_names['unsigned int'] = TYPE_UINT
 258 type_names['unsigned'] = TYPE_UINT
 259 type_names['long'] = TYPE_LONG
 260 type_names['signed long'] = TYPE_LONG
 261 type_names['unsigned long'] = TYPE_ULONG
 262 type_names['unsigned long int'] = TYPE_ULONG
 263 type_names['float'] = TYPE_FLOAT
 264 type_names['double'] = TYPE_DOUBLE
 265 type_names['char*'] = TYPE_STRING
 266 type_names['void*'] = TYPE_ANY
 267 type_names['void'] = TYPE_NONE
 268 # Also alias the signed one here
 269 type_names['signed long long'] = TYPE_LONG_LONG
 270 # C99 stdint exact width types
 271 type_names['int8_t'] = TYPE_INT8
 272 type_names['uint8_t'] = TYPE_UINT8
 273 type_names['int16_t'] = TYPE_INT16
 274 type_names['uint16_t'] = TYPE_UINT16
 275 type_names['int32_t'] = TYPE_INT32
 276 type_names['uint32_t'] = TYPE_UINT32
 277 type_names['int64_t'] = TYPE_INT64
 278 type_names['uint64_t'] = TYPE_UINT64
 279
 280 # A few additional GLib type aliases
 281 type_names['guchar'] = TYPE_UINT8
 282 type_names['gchararray'] = TYPE_STRING
 283 type_names['gchar*'] = TYPE_STRING
 284 type_names['goffset'] = TYPE_INT64
 285 type_names['gunichar2'] = TYPE_UINT16
 286 type_names['gsize'] = TYPE_SIZE
 287 type_names['gssize'] = TYPE_SSIZE
 288 type_names['gintptr'] = TYPE_INTPTR
 289 type_names['guintptr'] = TYPE_UINTPTR
 290 type_names['gconstpointer'] = TYPE_ANY
 291
 292 # We used to support these; continue to do so
 293 type_names['any'] = TYPE_ANY
 294 type_names['boolean'] = TYPE_BOOLEAN
 295 type_names['uint'] = TYPE_UINT
 296 type_names['ulong'] = TYPE_ULONG
 297
 298 # C stdio, used in GLib public headers; squash this for now here
 299 # until we move scanning into GLib and can (skip)
 300 type_names['FILE*'] = TYPE_ANY
 301
 302 # One off C unix type definitions; note some of these may be GNU Libc
 303 # specific.  If someone is actually bitten by this, feel free to do
 304 # the required configure goop to determine their size and replace
 305 # here.
 306 #
 307 # We don't want to encourage people to use these in their APIs because
 308 # they compromise the platform-independence that GLib gives you.
 309 # These are here mostly to avoid blowing when random platform-specific
 310 # methods are added under #ifdefs inside GLib itself.  We could just (skip)
 311 # the relevant methods, but on the other hand, since these types are just
 312 # integers it's easy enough to expand them.
 313 type_names['size_t'] = type_names['gsize']
 314 type_names['time_t'] = TYPE_LONG
 315 type_names['off_t'] = type_names['gsize']
 316 type_names['pid_t'] = TYPE_INT
 317 type_names['uid_t'] = TYPE_UINT
 318 type_names['gid_t'] = TYPE_UINT
 319 type_names['dev_t'] = TYPE_INT
 320 type_names['socklen_t'] = TYPE_INT32
 321 type_names['size_t'] = TYPE_ULONG
 322 type_names['ssize_t'] = TYPE_LONG
 323
 324 # Obj-C
 325 type_names['id'] = TYPE_ANY
 326
 327 ##
 328 ## Parameters
 329 ##
 330
 331 PARAM_DIRECTION_IN = 'in'
 332 PARAM_DIRECTION_OUT = 'out'
 333 PARAM_DIRECTION_INOUT = 'inout'
 334
 335 PARAM_SCOPE_CALL = 'call'
 336 PARAM_SCOPE_ASYNC = 'async'
 337 PARAM_SCOPE_NOTIFIED = 'notified'
 338
 339 PARAM_TRANSFER_NONE = 'none'
 340 PARAM_TRANSFER_CONTAINER = 'container'
 341 PARAM_TRANSFER_FULL = 'full'
 342
 343 SIGNAL_FIRST = 'first'
 344 SIGNAL_LAST = 'last'
 345 SIGNAL_CLEANUP = 'cleanup'
 346 SIGNAL_MUST_COLLECT = 'must-collect'
 347
 348
 349 class Namespace(object):
 350     def __init__(self, name, version,
 351                  identifier_prefixes=None,
 352                  symbol_prefixes=None):
 353         self.name = name
 354         self.version = version
 355         if identifier_prefixes is not None:
 356             self.identifier_prefixes = identifier_prefixes
 357         else:
 358             self.identifier_prefixes = [name]
 359         if symbol_prefixes is not None:
 360             self.symbol_prefixes = symbol_prefixes
 361         else:
 362             ps = self.identifier_prefixes
 363             self.symbol_prefixes = [to_underscores(p).lower() for p in ps]
 364         # cache upper-cased versions
 365         self._ucase_symbol_prefixes = [p.upper() for p in self.symbol_prefixes]
 366         self.names = odict() # Maps from GIName -> node
 367         self.aliases = {} # Maps from GIName -> GIName
 368         self.type_names = {} # Maps from GTName -> node
 369         self.ctypes = {} # Maps from CType -> node
 370         self.symbols = {} # Maps from function symbols -> Function
 371
 372     def type_from_name(self, name, ctype=None):
 373         """Backwards compatibility method for older .gir files, which
 374 only use the 'name' attribute.  If name refers to a fundamental type,
 375 create a Type object referncing it.  If name is already a
 376 fully-qualified GIName like 'Foo.Bar', returns a Type targeting it .
 377 Otherwise a Type targeting name qualififed with the namespace name is
 378 returned."""
 379         if name in type_names:
 380             return Type(target_fundamental=name, ctype=ctype)
 381         if '.' in name:
 382             target = name
 383         else:
 384             target = '%s.%s' % (self.name, name)
 385         return Type(target_giname=target, ctype=ctype)
 386
 387     def append(self, node, replace=False):
 388         previous = self.names.get(node.name)
 389         if previous is not None:
 390             if not replace:
 391                 raise ValueError("Namespace conflict: %r" % (node, ))
 392             self.remove(previous)
 393         # A layering violation...but oh well.
 394         if isinstance(node, Alias):
 395             self.aliases[node.name] = node
 396         elif isinstance(node, Registered) and node.gtype_name is not None:
 397             self.type_names[node.gtype_name] = node
 398         elif isinstance(node, Function):
 399             self.symbols[node.symbol] = node
 400         assert isinstance(node, Node)
 401         assert node.namespace is None
 402         node.namespace = self
 403         self.names[node.name] = node
 404         if hasattr(node, 'ctype'):
 405             self.ctypes[node.ctype] = node
 406         if hasattr(node, 'symbol'):
 407             self.ctypes[node.symbol] = node
 408
 409     def remove(self, node):
 410         if isinstance(node, Alias):
 411             del self.aliases[node.name]
 412         elif isinstance(node, Registered) and node.gtype_name is not None:
 413             del self.type_names[node.gtype_name]
 414         del self.names[node.name]
 415         node.namespace = None
 416         if hasattr(node, 'ctype'):
 417             del self.ctypes[node.ctype]
 418         if isinstance(node, Function):
 419             del self.symbols[node.symbol]
 420
 421     def float(self, node):
 422         """Like remove(), but doesn't unset the node's namespace
 423 back-reference, and it's still possible to look up
 424 functions via get_by_symbol()."""
 425         if isinstance(node, Function):
 426             symbol = node.symbol
 427         self.remove(node)
 428         self.symbols[symbol] = node
 429         node.namespace = self
 430
 431     def __iter__(self):
 432         return iter(self.names)
 433
 434     def iteritems(self):
 435         return self.names.iteritems()
 436
 437     def itervalues(self):
 438         return self.names.itervalues()
 439
 440     def get(self, name):
 441         return self.names.get(name)
 442
 443     def get_by_ctype(self, ctype):
 444         return self.ctypes.get(ctype)
 445
 446     def get_by_symbol(self, symbol):
 447         return self.symbols.get(symbol)
 448
 449     def walk(self, callback):
 450         for node in self.itervalues():
 451             node.walk(callback, [])
 452
 453 class Include(object):
 454
 455     def __init__(self, name, version):
 456         self.name = name
 457         self.version = version
 458
 459     @classmethod
 460     def from_string(cls, string):
 461         return cls(*string.split('-', 1))
 462
 463     def __cmp__(self, other):
 464         namecmp = cmp(self.name, other.name)
 465         if namecmp != 0:
 466             return namecmp
 467         return cmp(self.version, other.version)
 468
 469     def __hash__(self):
 470         return hash(str(self))
 471
 472     def __str__(self):
 473         return '%s-%s' % (self.name, self.version)
 474
 475 class Annotated(object):
 476     """An object which has a few generic metadata
 477 properties."""
 478     def __init__(self):
 479         self.version = None
 480         self.skip = False
 481         self.introspectable = True
 482         self.attributes = [] # (key, value)*
 483         self.stability = None
 484         self.deprecated = None
 485         self.deprecated_version = None
 486         self.doc = None
 487
 488 class Node(Annotated):
 489     """A node is a type of object which is uniquely identified by its
 490 (namespace, name) pair.  When combined with a ., this is called a
 491 GIName.  It's possible for nodes to contain or point to other nodes."""
 492
 493     c_name = property(lambda self: self.namespace.name + self.name)
 494     gi_name = property(lambda self: '%s.%s' % (self.namespace.name, self.name))
 495
 496     def __init__(self, name=None):
 497         Annotated.__init__(self)
 498         self.namespace = None # Should be set later by Namespace.append()
 499         self.name = name
 500         self.foreign = False
 501         self.file_positions = set()
 502
 503     def create_type(self):
 504         """Create a Type object referencing this node."""
 505         assert self.namespace is not None
 506         return Type(target_giname=('%s.%s' % (self.namespace.name, self.name)))
 507
 508     def __cmp__(self, other):
 509         nscmp = cmp(self.namespace, other.namespace)
 510         if nscmp != 0:
 511             return nscmp
 512         return cmp(self.name, other.name)
 513
 514     def __repr__(self):
 515         return '%s(%r)' % (self.__class__.__name__, self.name)
 516
 517     def inherit_file_positions(self, node):
 518         self.file_positions.update(node.file_positions)
 519
 520     def add_file_position(self, position):
 521         self.file_positions.add(position)
 522
 523     def add_symbol_reference(self, symbol):
 524         if symbol.source_filename:
 525             self.add_file_position(Position(symbol.source_filename, symbol.line))
 526
 527     def walk(self, callback, chain):
 528         res = callback(self, chain)
 529         assert res in (True, False), "Walk function must return boolean, not %r" % (res, )
 530         if not res:
 531             return False
 532         chain.append(self)
 533         self._walk(callback, chain)
 534         chain.pop()
 535
 536     def _walk(self, callback, chain):
 537         pass
 538
 539
 540 class Registered:
 541     """A node that (possibly) has gtype_name and get_type."""
 542     def __init__(self, gtype_name, get_type):
 543         assert (gtype_name is None and get_type is None) or \
 544                (gtype_name is not None and get_type is not None)
 545         self.gtype_name = gtype_name
 546         self.get_type = get_type
 547
 548
 549 class Callable(Node):
 550
 551     def __init__(self, name, retval, parameters, throws):
 552         Node.__init__(self, name)
 553         self.retval = retval
 554         self.parameters = parameters
 555         self.throws = not not throws
 556         self.instance_parameter = None # Parameter
 557         self.parent = None # A Class or Interface
 558
 559     def get_parameter_index(self, name):
 560         for i, parameter in enumerate(self.parameters):
 561             if parameter.argname == name:
 562                 return i
 563         raise ValueError("Unknown argument %s" % (name, ))
 564
 565     def get_parameter(self, name):
 566         for parameter in self.parameters:
 567             if parameter.argname == name:
 568                 return parameter
 569         raise ValueError("Unknown argument %s" % (name, ))
 570
 571
 572 class Function(Callable):
 573
 574     def __init__(self, name, retval, parameters, throws, symbol):
 575         Callable.__init__(self, name, retval, parameters, throws)
 576         self.symbol = symbol
 577         self.is_method = False
 578         self.is_constructor = False
 579         self.shadowed_by = None # C symbol string
 580         self.shadows = None # C symbol string
 581         self.moved_to = None # namespaced function name string
 582
 583     def clone(self):
 584         clone = copy.copy(self)
 585         # copy the parameters array so a change to self.parameters does not
 586         # influence clone.parameters.
 587         clone.parameters = self.parameters[:]
 588         return clone
 589
 590     def is_type_meta_function(self):
 591         # Named correctly
 592         if not (self.name.endswith('_get_type') or
 593                 self.name.endswith('_get_gtype')):
 594                 return False
 595
 596         # Doesn't have any parameters
 597         if self.parameters:
 598             return False
 599
 600         # Returns GType
 601         rettype = self.retval.type
 602         if (not rettype.is_equiv(TYPE_GTYPE) and
 603            rettype.target_giname != 'Gtk.Type'):
 604             message.warn("function '%s' returns '%r', not a GType" %
 605                          (self.name, rettype))
 606             return False
 607
 608         return True
 609
 610 class ErrorQuarkFunction(Function):
 611
 612     def __init__(self, name, retval, parameters, throws, symbol, error_domain):
 613         Function.__init__(self, name, retval, parameters, throws, symbol)
 614         self.error_domain = error_domain
 615
 616
 617 class VFunction(Callable):
 618
 619     def __init__(self, name, retval, parameters, throws):
 620         Callable.__init__(self, name, retval, parameters, throws)
 621         self.invoker = None
 622
 623     @classmethod
 624     def from_callback(cls, cb):
 625         obj = cls(cb.name, cb.retval, cb.parameters[1:],
 626                   cb.throws)
 627         return obj
 628
 629
 630
 631 class Varargs(Type):
 632
 633     def __init__(self):
 634         Type.__init__(self, '<varargs>', target_fundamental='<varargs>')
 635
 636
 637 class Array(Type):
 638     C = '<c>'
 639     GLIB_ARRAY = 'GLib.Array'
 640     GLIB_BYTEARRAY = 'GLib.ByteArray'
 641     GLIB_PTRARRAY = 'GLib.PtrArray'
 642
 643     def __init__(self, array_type, element_type, **kwargs):
 644         Type.__init__(self, target_fundamental='<array>',
 645                       **kwargs)
 646         if (array_type is None or array_type == self.C):
 647             self.array_type = self.C
 648         else:
 649             assert array_type in (self.GLIB_ARRAY,
 650                                   self.GLIB_BYTEARRAY,
 651                                   self.GLIB_PTRARRAY), array_type
 652             self.array_type = array_type
 653         assert isinstance(element_type, Type)
 654         self.element_type = element_type
 655         self.zeroterminated = True
 656         self.length_param_name = None
 657         self.size = None
 658
 659     def clone(self):
 660         arr = Array(self.array_type, self.element_type)
 661         arr.zeroterminated = self.zeroterminated
 662         arr.length_param_name = self.length_param_name
 663         arr.size = self.size
 664         return arr
 665
 666 class List(Type):
 667
 668     def __init__(self, name, element_type, **kwargs):
 669         Type.__init__(self, target_fundamental='<list>',
 670                       **kwargs)
 671         self.name = name
 672         assert isinstance(element_type, Type)
 673         self.element_type = element_type
 674
 675     def clone(self):
 676         return List(self.name, self.element_type)
 677
 678 class Map(Type):
 679
 680     def __init__(self, key_type, value_type, **kwargs):
 681         Type.__init__(self, target_fundamental='<map>', **kwargs)
 682         assert isinstance(key_type, Type)
 683         self.key_type = key_type
 684         assert isinstance(value_type, Type)
 685         self.value_type = value_type
 686
 687     def clone(self):
 688         return Map(self.key_type, self.value_type)
 689
 690 class Alias(Node):
 691
 692     def __init__(self, name, target, ctype=None):
 693         Node.__init__(self, name)
 694         self.target = target
 695         self.ctype = ctype
 696
 697
 698 class TypeContainer(Annotated):
 699     """A fundamental base class for Return and Parameter."""
 700
 701     def __init__(self, typenode, transfer):
 702         Annotated.__init__(self)
 703         self.type = typenode
 704         if transfer is not None:
 705             self.transfer = transfer
 706         elif typenode.is_const:
 707             self.transfer = PARAM_TRANSFER_NONE
 708         else:
 709             self.transfer = None
 710
 711
 712 class Parameter(TypeContainer):
 713     """An argument to a function."""
 714
 715     def __init__(self, argname, typenode, direction=None,
 716                  transfer=None, allow_none=False, scope=None,
 717                  caller_allocates=False):
 718         TypeContainer.__init__(self, typenode, transfer)
 719         self.argname = argname
 720         self.direction = direction
 721         self.allow_none = allow_none
 722         self.scope = scope
 723         self.caller_allocates = caller_allocates
 724         self.closure_name = None
 725         self.destroy_name = None
 726
 727
 728 class Return(TypeContainer):
 729     """A return value from a function."""
 730
 731     def __init__(self, rtype, transfer=None):
 732         TypeContainer.__init__(self, rtype, transfer)
 733         self.direction = PARAM_DIRECTION_OUT
 734
 735
 736 class Enum(Node, Registered):
 737
 738     def __init__(self, name, ctype,
 739                  gtype_name=None,
 740                  get_type=None,
 741                  c_symbol_prefix=None,
 742                  members=None):
 743         Node.__init__(self, name)
 744         Registered.__init__(self, gtype_name, get_type)
 745         self.c_symbol_prefix = c_symbol_prefix
 746         self.ctype = ctype
 747         self.members = members
 748         # Associated error domain name
 749         self.error_domain = None
 750         self.static_methods = []
 751
 752     def _walk(self, callback, chain):
 753         for meth in self.static_methods:
 754             meth.walk(callback, chain)
 755
 756
 757 class Bitfield(Node, Registered):
 758
 759     def __init__(self, name, ctype,
 760                  gtype_name=None,
 761                  c_symbol_prefix=None,
 762                  get_type=None,
 763                  members=None):
 764         Node.__init__(self, name)
 765         Registered.__init__(self, gtype_name, get_type)
 766         self.ctype = ctype
 767         self.c_symbol_prefix = c_symbol_prefix
 768         self.members = members
 769         self.static_methods = []
 770
 771     def _walk(self, callback, chain):
 772         for meth in self.static_methods:
 773             meth.walk(callback, chain)
 774
 775
 776 class Member(Annotated):
 777
 778     def __init__(self, name, value, symbol, nick):
 779         Annotated.__init__(self)
 780         self.name = name
 781         self.value = value
 782         self.symbol = symbol
 783         self.nick = nick
 784
 785     def __cmp__(self, other):
 786         return cmp(self.name, other.name)
 787
 788
 789
 790 class Compound(Node, Registered):
 791     def __init__(self, name,
 792                  ctype=None,
 793                  gtype_name=None,
 794                  get_type=None,
 795                  c_symbol_prefix=None,
 796                  disguised=False):
 797         Node.__init__(self, name)
 798         Registered.__init__(self, gtype_name, get_type)
 799         self.ctype = ctype
 800         self.methods = []
 801         self.static_methods = []
 802         self.fields = []
 803         self.constructors = []
 804         self.disguised = disguised
 805         self.gtype_name = gtype_name
 806         self.get_type = get_type
 807         self.c_symbol_prefix = c_symbol_prefix
 808
 809     def add_gtype(self, gtype_name, get_type):
 810         self.gtype_name = gtype_name
 811         self.get_type = get_type
 812         self.namespace.type_names[gtype_name] = self
 813
 814     def _walk(self, callback, chain):
 815         for ctor in self.constructors:
 816             ctor.walk(callback, chain)
 817         for func in self.methods:
 818             func.walk(callback, chain)
 819         for func in self.static_methods:
 820             func.walk(callback, chain)
 821         for field in self.fields:
 822             if field.anonymous_node is not None:
 823                 field.anonymous_node.walk(callback, chain)
 824
 825 class Field(Annotated):
 826
 827     def __init__(self, name, typenode, readable, writable, bits=None,
 828                  anonymous_node=None):
 829         Annotated.__init__(self)
 830         assert (typenode or anonymous_node)
 831         self.name = name
 832         self.type = typenode
 833         self.readable = readable
 834         self.writable = writable
 835         self.bits = bits
 836         self.anonymous_node = anonymous_node
 837         self.private = False
 838
 839     def __cmp__(self, other):
 840         return cmp(self.name, other.name)
 841
 842
 843 class Record(Compound):
 844
 845     def __init__(self, name,
 846                  ctype=None,
 847                  gtype_name=None,
 848                  get_type=None,
 849                  c_symbol_prefix=None,
 850                  disguised=False):
 851         Compound.__init__(self, name,
 852                           ctype=ctype,
 853                           gtype_name=gtype_name,
 854                           get_type=get_type,
 855                           c_symbol_prefix=c_symbol_prefix,
 856                           disguised=disguised)
 857         # If non-None, this record defines the FooClass C structure
 858         # for some Foo GObject (or similar for GInterface)
 859         self.is_gtype_struct_for = None
 860
 861
 862 class Union(Compound):
 863
 864     def __init__(self, name,
 865                  ctype=None,
 866                  gtype_name=None,
 867                  get_type=None,
 868                  c_symbol_prefix=None,
 869                  disguised=False):
 870         Compound.__init__(self, name,
 871                           ctype=ctype,
 872                           gtype_name=gtype_name,
 873                           get_type=get_type,
 874                           c_symbol_prefix=c_symbol_prefix,
 875                           disguised=disguised)
 876
 877
 878 class Boxed(Node, Registered):
 879     """A boxed type with no known associated structure/union."""
 880     def __init__(self, name,
 881                  gtype_name=None,
 882                  get_type=None,
 883                  c_symbol_prefix=None):
 884         assert gtype_name is not None
 885         assert get_type is not None
 886         Node.__init__(self, name)
 887         Registered.__init__(self, gtype_name, get_type)
 888         if get_type is not None:
 889             assert c_symbol_prefix is not None
 890         self.c_symbol_prefix = c_symbol_prefix
 891         self.constructors = []
 892         self.methods = []
 893         self.static_methods = []
 894
 895     def _walk(self, callback, chain):
 896         for ctor in self.constructors:
 897             ctor.walk(callback, chain)
 898         for meth in self.methods:
 899             meth.walk(callback, chain)
 900         for meth in self.static_methods:
 901             meth.walk(callback, chain)
 902
 903
 904 class Signal(Callable):
 905
 906     def __init__(self, name, retval, parameters, when=None,
 907                  no_recurse=False, detailed=False, action=False,
 908                  no_hooks=False):
 909         Callable.__init__(self, name, retval, parameters, False)
 910         self.when = when
 911         self.no_recurse = no_recurse
 912         self.detailed = detailed
 913         self.action = action
 914         self.no_hooks = no_hooks
 915
 916
 917 class Class(Node, Registered):
 918
 919     def __init__(self, name, parent,
 920                  ctype=None,
 921                  gtype_name=None,
 922                  get_type=None,
 923                  c_symbol_prefix=None,
 924                  is_abstract=False):
 925         Node.__init__(self, name)
 926         Registered.__init__(self, gtype_name, get_type)
 927         self.ctype = ctype
 928         self.c_symbol_prefix = c_symbol_prefix
 929         self.parent = parent
 930         self.fundamental = False
 931         self.unref_func = None
 932         self.ref_func = None
 933         self.set_value_func = None
 934         self.get_value_func = None
 935         # When we're in the scanner, we keep around a list
 936         # of parents so that we can transparently fall back
 937         # if there are 'hidden' parents
 938         self.parent_chain = []
 939         self.glib_type_struct = None
 940         self.is_abstract = is_abstract
 941         self.methods = []
 942         self.virtual_methods = []
 943         self.static_methods = []
 944         self.interfaces = []
 945         self.constructors = []
 946         self.properties = []
 947         self.fields = []
 948         self.signals = []
 949
 950     def _walk(self, callback, chain):
 951         for meth in self.methods:
 952             meth.walk(callback, chain)
 953         for meth in self.virtual_methods:
 954             meth.walk(callback, chain)
 955         for meth in self.static_methods:
 956             meth.walk(callback, chain)
 957         for ctor in self.constructors:
 958             ctor.walk(callback, chain)
 959         for field in self.fields:
 960             if field.anonymous_node:
 961                 field.anonymous_node.walk(callback, chain)
 962         for sig in self.signals:
 963             sig.walk(callback, chain)
 964
 965
 966 class Interface(Node, Registered):
 967
 968     def __init__(self, name, parent,
 969                  ctype=None,
 970                  gtype_name=None,
 971                  get_type=None,
 972                  c_symbol_prefix=None):
 973         Node.__init__(self, name)
 974         Registered.__init__(self, gtype_name, get_type)
 975         self.ctype = ctype
 976         self.c_symbol_prefix = c_symbol_prefix
 977         self.parent = parent
 978         self.parent_chain = []
 979         self.methods = []
 980         self.signals = []
 981         self.static_methods = []
 982         self.virtual_methods = []
 983         self.glib_type_struct = None
 984         self.properties = []
 985         self.fields = []
 986         self.prerequisites = []
 987
 988     def _walk(self, callback, chain):
 989         for meth in self.methods:
 990             meth.walk(callback, chain)
 991         for meth in self.static_methods:
 992             meth.walk(callback, chain)
 993         for meth in self.virtual_methods:
 994             meth.walk(callback, chain)
 995         for field in self.fields:
 996             if field.anonymous_node:
 997                 field.anonymous_node.walk(callback, chain)
 998         for sig in self.signals:
 999             sig.walk(callback, chain)
1000
1001
1002 class Constant(Node):
1003
1004     def __init__(self, name, value_type, value, ctype):
1005         Node.__init__(self, name)
1006         self.value_type = value_type
1007         self.value = value
1008         self.ctype = ctype
1009
1010
1011 class Property(Node):
1012
1013     def __init__(self, name, typeobj, readable, writable,
1014                  construct, construct_only, transfer=None):
1015         Node.__init__(self, name)
1016         self.type = typeobj
1017         self.readable = readable
1018         self.writable = writable
1019         self.construct = construct
1020         self.construct_only = construct_only
1021         if transfer is None:
1022             self.transfer = PARAM_TRANSFER_NONE
1023         else:
1024             self.transfer = transfer
1025         self.parent = None # A Class or Interface
1026
1027
1028 class Callback(Callable):
1029
1030     def __init__(self, name, retval, parameters, throws, ctype=None):
1031         Callable.__init__(self, name, retval, parameters, throws)
1032         self.ctype = ctype