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