git.roojs.org Git - gnome.gobject-introspection/blob - giscanner/ast.py

   1 # -*- Mode: Python -*-
   2 # GObject-Introspection - a framework for introspecting GObject libraries
   3 # Copyright (C) 2008  Johan Dahlin
   4 #
   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.
   9 #
  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.
  14 #
  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.
  19 #
  20
  21 """AST nodes
  22 This file descbribes abstract data type nodes independent on the
  23 implementation language.
  24
  25 These can later on be extended (eg subclassed) with additional information
  26 which is language/library/domain specific.
  27 """
  28
  29 ##
  30 ## Basic types, modeled on GITypeTag but not equivalent
  31 ##
  32
  33 TYPE_NONE = 'none' # We differ from repository on these first two
  34 TYPE_ANY = 'any'
  35 TYPE_BOOLEAN = 'boolean'
  36 TYPE_INT8 = 'int8'
  37 TYPE_UINT8 = 'uint8'
  38 TYPE_INT16 = 'int16'
  39 TYPE_UINT16 = 'uint16'
  40 TYPE_INT = 'int'
  41 TYPE_UINT = 'uint'
  42 TYPE_INT32 = 'int32'
  43 TYPE_UINT32 = 'uint32'
  44 TYPE_INT64 = 'int64'
  45 TYPE_UINT64 = 'uint64'
  46 TYPE_LONG = 'long'
  47 TYPE_ULONG = 'ulong'
  48 TYPE_SSIZET = 'ssize_t'
  49 TYPE_SIZET = 'size_t'
  50 TYPE_TIMET = 'time_t'
  51 TYPE_GTYPE = 'GType'
  52 TYPE_FLOAT = 'float'
  53 TYPE_DOUBLE = 'double'
  54 TYPE_STRING = 'utf8' # requires zero-terminated
  55 TYPE_FILENAME = 'filename'
  56
  57 BASIC_GIR_TYPES = [TYPE_BOOLEAN, TYPE_INT8, TYPE_UINT8, TYPE_INT16,
  58                    TYPE_UINT16, TYPE_INT32, TYPE_UINT32, TYPE_INT64,
  59                    TYPE_UINT64, TYPE_INT, TYPE_UINT, TYPE_LONG,
  60                    TYPE_ULONG, TYPE_SSIZET, TYPE_SIZET, TYPE_FLOAT,
  61                    TYPE_DOUBLE, TYPE_TIMET, TYPE_GTYPE]
  62 GIR_TYPES = [TYPE_NONE, TYPE_ANY]
  63 GIR_TYPES.extend(BASIC_GIR_TYPES)
  64 GIR_TYPES.extend([TYPE_STRING, TYPE_FILENAME])
  65
  66 # Higher-level data types
  67 TYPE_SEQUENCE = 'sequence' # Sequence of something
  68
  69 # Wide/Unicode
  70 TYPE_UCHAR = 'uchar'
  71 TYPE_USTRING = 'ustring'
  72
  73 ##
  74 ## Parameters
  75 ##
  76
  77 PARAM_DIRECTION_IN = 'in'
  78 PARAM_DIRECTION_OUT = 'out'
  79 PARAM_DIRECTION_INOUT = 'inout'
  80
  81 PARAM_TRANSFER_NONE = 'none'
  82 PARAM_TRANSFER_CONTAINER = 'container'
  83 PARAM_TRANSFER_FULL = 'full'
  84
  85 type_names = {}
  86 for name in GIR_TYPES:
  87     type_names[name] = name
  88
  89 # C builtin
  90 type_names['char'] = TYPE_INT8
  91 type_names['signed char'] = TYPE_INT8
  92 type_names['unsigned char'] = TYPE_UINT8
  93 type_names['short'] = TYPE_INT16
  94 type_names['signed short'] = TYPE_INT16
  95 type_names['unsigned short'] = TYPE_UINT16
  96 type_names['int'] = TYPE_INT
  97 type_names['signed int'] = TYPE_INT
  98 type_names['signed'] = TYPE_INT
  99 type_names['unsigned int'] = TYPE_UINT
 100 type_names['unsigned'] = TYPE_UINT
 101 type_names['long'] = TYPE_LONG
 102 type_names['signed long'] = TYPE_LONG
 103 type_names['unsigned long'] = TYPE_ULONG
 104 type_names['float'] = TYPE_FLOAT
 105 type_names['double'] = TYPE_DOUBLE
 106 type_names['char*'] = TYPE_STRING
 107 type_names['void*'] = TYPE_ANY
 108 type_names['void'] = TYPE_NONE
 109
 110 # C unix types
 111 type_names['off_t'] = TYPE_SIZET
 112 type_names['pid_t'] = TYPE_INT
 113 type_names['size_t'] = TYPE_SIZET
 114 type_names['ssize_t'] = TYPE_SSIZET
 115 type_names['socklen_t'] = TYPE_INT32
 116
 117 # Obj-C
 118 type_names['id'] = TYPE_ANY
 119
 120 # Suppress some GLib names
 121 type_names['uchar'] = TYPE_UINT8
 122 type_names['ushort'] = TYPE_UINT16
 123 type_names['size'] = TYPE_SIZET
 124 type_names['ssize'] = TYPE_SSIZET
 125 type_names['pointer'] = TYPE_ANY
 126 type_names['constpointer'] = TYPE_ANY
 127
 128
 129 # These types, when seen by reference, are converted into an Array()
 130 # by default
 131 # If you add/change these, be sure to update glibast.py too
 132 default_array_types = {}
 133 default_array_types['uint8*'] = TYPE_UINT8
 134 default_array_types['utf8*'] = TYPE_STRING
 135
 136 # These types, when seen by reference, are interpreted as out parameters
 137 default_out_types = (TYPE_INT, TYPE_UINT, TYPE_LONG, TYPE_ULONG,
 138                      TYPE_FLOAT, TYPE_DOUBLE, TYPE_SIZET, TYPE_SSIZET)
 139
 140
 141 def type_name_from_ctype(ctype):
 142     return type_names.get(ctype, ctype)
 143
 144
 145 class Node(object):
 146
 147     def __init__(self, name=None):
 148         self.name = name
 149         self.deprecated = None
 150         self.deprecated_version = None
 151         self.version = None
 152
 153     def __repr__(self):
 154         return '%s(%r)' % (self.__class__.__name__, self.name)
 155
 156
 157 class Namespace(Node):
 158
 159     def __init__(self, name, version):
 160         Node.__init__(self, name)
 161         self.version = version
 162         self.nodes = []
 163
 164     def __repr__(self):
 165         return '%s(%r, %r, %r)' % (self.__class__.__name__, self.name,
 166                                    self.version, self.nodes)
 167
 168
 169 class Include(Node):
 170
 171     def __init__(self, name, version):
 172         Node.__init__(self, 'include')
 173         self.name = name
 174         self.version = version
 175
 176     @classmethod
 177     def from_string(self, string):
 178         return Include(*string.split('-', 1))
 179
 180     def __cmp__(self, other):
 181         if not isinstance(other, Include):
 182             return cmp(self, other)
 183         namecmp = cmp(self.name, other.name)
 184         if namecmp != 0:
 185             return namecmp
 186         return cmp(self.version, other.version)
 187
 188     def __hash__(self):
 189         return hash((self.name, self.version))
 190
 191     def __str__(self):
 192         return '%s-%s' % (self.name, self.version)
 193
 194
 195 class Function(Node):
 196
 197     def __init__(self, name, retval, parameters, symbol, throws=None):
 198         Node.__init__(self, name)
 199         self.retval = retval
 200         self.parameters = parameters
 201         self.symbol = symbol
 202         self.throws = not not throws
 203         self.is_method = False
 204
 205     def get_parameter_index(self, name):
 206         for i, parameter in enumerate(self.parameters):
 207             if parameter.name == name:
 208                 return i + int(self.is_method)
 209
 210     def get_parameter(self, name):
 211         for parameter in self.parameters:
 212             if parameter.name == name:
 213                 return parameter
 214
 215     def __repr__(self):
 216         return '%s(%r, %r, %r)' % (self.__class__.__name__,
 217                                    self.name, self.retval,
 218                                    self.parameters)
 219
 220
 221 class VFunction(Function):
 222     pass
 223
 224
 225 class Type(Node):
 226
 227     def __init__(self, name, ctype=None):
 228         Node.__init__(self, name)
 229         self.ctype = ctype
 230         self.resolved = False
 231         self.is_const = False
 232         self.canonical = None
 233         self.derefed_canonical = None
 234
 235
 236 class Varargs(Type):
 237
 238     def __init__(self):
 239         Type.__init__(self, '<varargs>')
 240
 241
 242 class Array(Type):
 243
 244     def __init__(self, ctype, element_type):
 245         Type.__init__(self, '<carray>', ctype)
 246         self.element_type = element_type
 247         self.zeroterminated = True
 248         self.length_param_index = -1
 249         self.length_param_name = None
 250         self.size = None
 251
 252     def __repr__(self):
 253         return 'Array(%r, %r)' % (self.name, self.element_type, )
 254
 255
 256 class List(Type):
 257
 258     def __init__(self, name, ctype, element_type):
 259         Type.__init__(self, name, ctype)
 260         self.element_type = element_type
 261
 262     def __repr__(self):
 263         return 'List(%r of %r)' % (self.name, self.element_type, )
 264
 265
 266 class Map(Type):
 267
 268     def __init__(self, name, ctype, key_type, value_type):
 269         Type.__init__(self, name, ctype)
 270         self.key_type = key_type
 271         self.value_type = value_type
 272
 273     def __repr__(self):
 274         return 'Map(%r <%r,%r.)' % (self.name, self.key_type, self.value_type)
 275
 276
 277 class Alias(Node):
 278
 279     def __init__(self, name, target, ctype=None):
 280         Node.__init__(self, name)
 281         self.target = target
 282         self.ctype = ctype
 283
 284     def __repr__(self):
 285         return 'Alias(%r, %r)' % (self.name, self.target)
 286
 287
 288 class TypeContainer(Node):
 289
 290     def __init__(self, name, typenode, transfer):
 291         Node.__init__(self, name)
 292         self.type = typenode
 293         if transfer in [PARAM_TRANSFER_NONE, PARAM_TRANSFER_CONTAINER,
 294                         PARAM_TRANSFER_FULL]:
 295             self.transfer = transfer
 296         else:
 297             self.transfer = None
 298
 299
 300 class Parameter(TypeContainer):
 301
 302     def __init__(self, name, typenode, direction=None,
 303                  transfer=None, allow_none=False, scope=None):
 304         TypeContainer.__init__(self, name, typenode, transfer)
 305         if direction in [PARAM_DIRECTION_IN, PARAM_DIRECTION_OUT,
 306                          PARAM_DIRECTION_INOUT, None]:
 307             self.direction = direction
 308         else:
 309             self.direction = PARAM_DIRECTION_IN
 310
 311         self.allow_none = allow_none
 312         self.scope = scope
 313         self.closure_index = -1
 314         self.destroy_index = -1
 315
 316     def __repr__(self):
 317         return 'Parameter(%r, %r)' % (self.name, self.type)
 318
 319
 320 class Enum(Node):
 321
 322     def __init__(self, name, symbol, members):
 323         Node.__init__(self, name)
 324         self.symbol = symbol
 325         self.members = members
 326
 327     def __repr__(self):
 328         return 'Enum(%r, %r)' % (self.name, self.members)
 329
 330
 331 class Member(Node):
 332
 333     def __init__(self, name, value, symbol):
 334         Node.__init__(self, name)
 335         self.value = value
 336         self.symbol = symbol
 337
 338     def __repr__(self):
 339         return 'Member(%r, %r)' % (self.name, self.value)
 340
 341
 342 class Record(Node):
 343
 344     def __init__(self, name, symbol, disguised=False):
 345         Node.__init__(self, name)
 346         self.fields = []
 347         self.constructors = []
 348         self.symbol = symbol
 349         self.disguised = disguised
 350
 351 # BW compat, remove
 352 Struct = Record
 353
 354
 355 class Field(Node):
 356
 357     def __init__(self, name, typenode, symbol, readable, writable, bits=None):
 358         Node.__init__(self, name)
 359         self.type = typenode
 360         self.symbol = symbol
 361         self.readable = readable
 362         self.writable = writable
 363         self.bits = bits
 364
 365     def __repr__(self):
 366         if self.bits:
 367             return 'Field(%r, %r, %r)' % (self.name, self.type, self.bits)
 368         else:
 369             return 'Field(%r, %r)' % (self.name, self.type)
 370
 371
 372 class Return(TypeContainer):
 373
 374     def __init__(self, rtype, transfer=None):
 375         TypeContainer.__init__(self, None, rtype, transfer)
 376         self.direction = PARAM_DIRECTION_OUT
 377
 378     def __repr__(self):
 379         return 'Return(%r)' % (self.type, )
 380
 381
 382 class Class(Node):
 383
 384     def __init__(self, name, parent, is_abstract):
 385         Node.__init__(self, name)
 386         self.ctype = name
 387         self.parent = parent
 388         self.is_abstract = is_abstract
 389         self.methods = []
 390         self.static_methods = []
 391         self.interfaces = []
 392         self.constructors = []
 393         self.properties = []
 394         self.fields = []
 395
 396     def __repr__(self):
 397         return '%s(%r, %r, %r)' % (
 398             self.__class__.__name__,
 399             self.name, self.parent, self.methods)
 400
 401
 402 class Interface(Node):
 403
 404     def __init__(self, name, parent):
 405         Node.__init__(self, name)
 406         self.parent = parent
 407         self.methods = []
 408         self.properties = []
 409         self.fields = []
 410         self.prerequisites = []
 411
 412     def __repr__(self):
 413         return '%s(%r, %r)' % (
 414             self.__class__.__name__,
 415             self.name, self.methods)
 416
 417
 418 class Constant(Node):
 419
 420     def __init__(self, name, type_name, value):
 421         Node.__init__(self, name)
 422         self.type = Type(type_name)
 423         self.value = value
 424
 425     def __repr__(self):
 426         return 'Constant(%r, %r, %r)' % (
 427             self.name, self.type, self.value)
 428
 429
 430 class Property(Node):
 431
 432     def __init__(self, name, type_name, readable, writable,
 433                  construct, construct_only, ctype=None):
 434         Node.__init__(self, name)
 435         self.type = Type(type_name, ctype)
 436         self.readable = readable
 437         self.writable = writable
 438         self.construct = construct
 439         self.construct_only = construct_only
 440
 441     def __repr__(self):
 442         return '%s(%r, %r)' % (
 443             self.__class__.__name__,
 444             self.name, self.type)
 445
 446
 447 # FIXME: Inherit from Function
 448
 449
 450 class Callback(Node):
 451
 452     def __init__(self, name, retval, parameters, ctype=None):
 453         Node.__init__(self, name)
 454         self.retval = retval
 455         self.parameters = parameters
 456         self.ctype = ctype
 457         self.throws = False
 458
 459     def __repr__(self):
 460         return 'Callback(%r, %r, %r)' % (
 461             self.name, self.retval, self.parameters)
 462
 463
 464 class Union(Node):
 465
 466     def __init__(self, name, symbol):
 467         Node.__init__(self, name)
 468         self.fields = []
 469         self.constructors = []
 470         self.symbol = symbol
 471
 472     def __repr__(self):
 473         return 'Union(%r, %r)' % (self.name, self.fields, )