[TYPE_SUPPORT] Better type support
[gnome.gobject-introspection] / giscanner / ast.py
index a965c2f..bc3a991 100644 (file)
@@ -1,6 +1,7 @@
 # -*- Mode: Python -*-
 # GObject-Introspection - a framework for introspecting GObject libraries
 # Copyright (C) 2008  Johan Dahlin
+# Copyright (C) 2008, 2009 Red Hat, Inc.
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -35,6 +36,8 @@ TYPE_ANY = 'any'
 TYPE_BOOLEAN = 'boolean'
 TYPE_INT8 = 'int8'
 TYPE_UINT8 = 'uint8'
+TYPE_SHORT = 'short'
+TYPE_USHORT = 'ushort'
 TYPE_INT16 = 'int16'
 TYPE_UINT16 = 'uint16'
 TYPE_INT = 'int'
@@ -56,9 +59,10 @@ TYPE_FILENAME = 'filename'
 
 BASIC_GIR_TYPES = [TYPE_BOOLEAN, TYPE_INT8, TYPE_UINT8, TYPE_INT16,
                    TYPE_UINT16, TYPE_INT32, TYPE_UINT32, TYPE_INT64,
-                   TYPE_UINT64, TYPE_INT, TYPE_UINT, TYPE_LONG,
-                   TYPE_ULONG, TYPE_SSIZET, TYPE_SIZET, TYPE_FLOAT,
-                   TYPE_DOUBLE, TYPE_TIMET, TYPE_GTYPE]
+                   TYPE_UINT64, TYPE_SHORT, TYPE_USHORT, TYPE_INT,
+                   TYPE_UINT, TYPE_LONG, TYPE_ULONG, TYPE_SSIZET,
+                   TYPE_SIZET, TYPE_FLOAT, TYPE_DOUBLE, TYPE_TIMET,
+                   TYPE_GTYPE]
 GIR_TYPES = [TYPE_NONE, TYPE_ANY]
 GIR_TYPES.extend(BASIC_GIR_TYPES)
 GIR_TYPES.extend([TYPE_STRING, TYPE_FILENAME])
@@ -86,38 +90,42 @@ type_names = {}
 for name in GIR_TYPES:
     type_names[name] = name
 
-# C
+# C builtin
 type_names['char'] = TYPE_INT8
 type_names['signed char'] = TYPE_INT8
 type_names['unsigned char'] = TYPE_UINT8
-type_names['short'] = TYPE_INT16
-type_names['signed short'] = TYPE_INT16
-type_names['unsigned short'] = TYPE_UINT16
+type_names['short'] = TYPE_SHORT
+type_names['signed short'] = TYPE_SHORT
+type_names['unsigned short'] = TYPE_USHORT
 type_names['int'] = TYPE_INT
 type_names['signed int'] = TYPE_INT
+type_names['unsigned short int'] = TYPE_USHORT
 type_names['signed'] = TYPE_INT
 type_names['unsigned int'] = TYPE_UINT
 type_names['unsigned'] = TYPE_UINT
 type_names['long'] = TYPE_LONG
 type_names['signed long'] = TYPE_LONG
 type_names['unsigned long'] = TYPE_ULONG
+type_names['unsigned long int'] = TYPE_ULONG
 type_names['float'] = TYPE_FLOAT
 type_names['double'] = TYPE_DOUBLE
 type_names['char*'] = TYPE_STRING
 type_names['void*'] = TYPE_ANY
 type_names['void'] = TYPE_NONE
-type_names['size_t'] = TYPE_SIZET
-type_names['ssize_t'] = TYPE_SSIZET
+
+# C unix types
 type_names['off_t'] = TYPE_SIZET
-# FIXME - can we make libraries use GPid?
 type_names['pid_t'] = TYPE_INT
+type_names['size_t'] = TYPE_SIZET
+type_names['ssize_t'] = TYPE_SSIZET
+type_names['socklen_t'] = TYPE_INT32
 
 # Obj-C
 type_names['id'] = TYPE_ANY
 
 # Suppress some GLib names
 type_names['uchar'] = TYPE_UINT8
-type_names['ushort'] = TYPE_UINT16
+type_names['ushort'] = TYPE_USHORT
 type_names['size'] = TYPE_SIZET
 type_names['ssize'] = TYPE_SSIZET
 type_names['pointer'] = TYPE_ANY
@@ -129,11 +137,12 @@ type_names['constpointer'] = TYPE_ANY
 # If you add/change these, be sure to update glibast.py too
 default_array_types = {}
 default_array_types['uint8*'] = TYPE_UINT8
-default_array_types['char**'] = TYPE_STRING
+default_array_types['utf8*'] = TYPE_STRING
 
 # These types, when seen by reference, are interpreted as out parameters
-default_out_types = (TYPE_INT, TYPE_UINT, TYPE_LONG, TYPE_ULONG,
-                     TYPE_FLOAT, TYPE_DOUBLE, TYPE_SIZET, TYPE_SSIZET)
+default_out_types = (TYPE_SHORT, TYPE_USHORT, TYPE_INT, TYPE_UINT,
+                     TYPE_LONG, TYPE_ULONG, TYPE_FLOAT, TYPE_DOUBLE,
+                     TYPE_SIZET, TYPE_SSIZET)
 
 
 def type_name_from_ctype(ctype):
@@ -144,12 +153,20 @@ class Node(object):
 
     def __init__(self, name=None):
         self.name = name
+        self.attributes = [] # (key, value)*
+        self.skip = False
         self.deprecated = None
         self.deprecated_version = None
+        self.version = None
+
+    def __cmp__(self, other):
+        return cmp(self.name, other.name)
 
     def __repr__(self):
         return '%s(%r)' % (self.__class__.__name__, self.name)
 
+    def remove_matching_children(self, pred):
+        pass
 
 class Namespace(Node):
 
@@ -162,6 +179,13 @@ class Namespace(Node):
         return '%s(%r, %r, %r)' % (self.__class__.__name__, self.name,
                                    self.version, self.nodes)
 
+    def remove_matching(self, pred):
+
+        def recursive_pred(node):
+            node.remove_matching_children(pred)
+            return pred(node)
+
+        self.nodes = filter(recursive_pred, self.nodes)
 
 class Include(Node):
 
@@ -188,24 +212,50 @@ class Include(Node):
     def __str__(self):
         return '%s-%s' % (self.name, self.version)
 
+class Callable(Node):
 
-class Function(Node):
-
-    def __init__(self, name, retval, parameters, symbol, throws=None):
+    def __init__(self, name, retval, parameters, throws):
         Node.__init__(self, name)
         self.retval = retval
         self.parameters = parameters
-        self.symbol = symbol
         self.throws = not not throws
+        self.doc = None
 
     def __repr__(self):
         return '%s(%r, %r, %r)' % (self.__class__.__name__,
                                    self.name, self.retval,
                                    self.parameters)
 
+class Function(Callable):
+
+    def __init__(self, name, retval, parameters, symbol, throws=None):
+        Callable.__init__(self, name, retval, parameters, throws)
+        self.symbol = symbol
+        self.is_method = False
+        self.doc = None
+
+    def get_parameter_index(self, name):
+        for i, parameter in enumerate(self.parameters):
+            if parameter.name == name:
+                return i + int(self.is_method)
+
+    def get_parameter(self, name):
+        for parameter in self.parameters:
+            if parameter.name == name:
+                return parameter
+
 
-class VFunction(Function):
-    pass
+class VFunction(Callable):
+
+    def __init__(self, name, retval, parameters, throws):
+        Callable.__init__(self, name, retval, parameters, throws)
+        self.invoker = None
+
+    @classmethod
+    def from_callback(cls, cb):
+        obj = cls(cb.name, cb.retval, cb.parameters[1:],
+                  cb.throws)
+        return obj
 
 
 class Type(Node):
@@ -214,6 +264,9 @@ class Type(Node):
         Node.__init__(self, name)
         self.ctype = ctype
         self.resolved = False
+        self.is_const = False
+        self.canonical = None
+        self.derefed_canonical = None
 
 
 class Varargs(Type):
@@ -233,7 +286,7 @@ class Array(Type):
         self.size = None
 
     def __repr__(self):
-        return 'Array(%r of %r)' % (self.name, self.element_type, )
+        return 'Array(%r, %r)' % (self.name, self.element_type, )
 
 
 class List(Type):
@@ -254,7 +307,7 @@ class Map(Type):
         self.value_type = value_type
 
     def __repr__(self):
-        return 'Map(%r <%r,%r.)' % (self.name, self.key_type, self.value_type)
+        return 'Map(%r <%r,%r>)' % (self.name, self.key_type, self.value_type)
 
 
 class Alias(Node):
@@ -279,22 +332,23 @@ class TypeContainer(Node):
         else:
             self.transfer = None
 
-        # transformer.py overrides this as needed
-        self.transfer_inferred = False
-
 
 class Parameter(TypeContainer):
 
-    def __init__(self, name, typenode, direction=PARAM_DIRECTION_IN,
-                 transfer=None, allow_none=False):
+    def __init__(self, name, typenode, direction=None,
+                 transfer=None, allow_none=False, scope=None):
         TypeContainer.__init__(self, name, typenode, transfer)
         if direction in [PARAM_DIRECTION_IN, PARAM_DIRECTION_OUT,
-                         PARAM_DIRECTION_INOUT]:
+                         PARAM_DIRECTION_INOUT, None]:
             self.direction = direction
         else:
             self.direction = PARAM_DIRECTION_IN
 
-        self.allow_none = not not allow_none
+        self.allow_none = allow_none
+        self.scope = scope
+        self.closure_index = -1
+        self.destroy_index = -1
+        self.doc = None
 
     def __repr__(self):
         return 'Parameter(%r, %r)' % (self.name, self.type)
@@ -306,11 +360,24 @@ class Enum(Node):
         Node.__init__(self, name)
         self.symbol = symbol
         self.members = members
+        self.doc = None
 
     def __repr__(self):
         return 'Enum(%r, %r)' % (self.name, self.members)
 
 
+class Bitfield(Node):
+
+    def __init__(self, name, symbol, members):
+        Node.__init__(self, name)
+        self.symbol = symbol
+        self.members = members
+        self.doc = None
+
+    def __repr__(self):
+        return 'Bitfield(%r, %r)' % (self.name, self.members)
+
+
 class Member(Node):
 
     def __init__(self, name, value, symbol):
@@ -322,13 +389,24 @@ class Member(Node):
         return 'Member(%r, %r)' % (self.name, self.value)
 
 
-class Struct(Node):
+class Record(Node):
 
-    def __init__(self, name, symbol):
+    def __init__(self, name, symbol, disguised=False):
         Node.__init__(self, name)
         self.fields = []
         self.constructors = []
         self.symbol = symbol
+        self.disguised = disguised
+        self.doc = None
+        self.methods = []
+
+    def remove_matching_children(self, pred):
+        self.fields = filter(pred, self.fields)
+        self.constructors = filter(pred, self.constructors)
+        self.methods = filter(pred, self.methods)
+
+# BW compat, remove
+Struct = Record
 
 
 class Field(Node):
@@ -352,6 +430,8 @@ class Return(TypeContainer):
 
     def __init__(self, rtype, transfer=None):
         TypeContainer.__init__(self, None, rtype, transfer)
+        self.direction = PARAM_DIRECTION_OUT
+        self.doc = None
 
     def __repr__(self):
         return 'Return(%r)' % (self.type, )
@@ -363,12 +443,22 @@ class Class(Node):
         Node.__init__(self, name)
         self.ctype = name
         self.parent = parent
+        self.glib_type_struct = None
         self.is_abstract = is_abstract
         self.methods = []
+        self.virtual_methods = []
+        self.static_methods = []
         self.interfaces = []
         self.constructors = []
         self.properties = []
         self.fields = []
+        self.doc = None
+
+    def remove_matching_children(self, pred):
+        self.methods = filter(pred, self.methods)
+        self.constructors = filter(pred, self.constructors)
+        self.properties = filter(pred, self.properties)
+        self.fields = filter(pred, self.fields)
 
     def __repr__(self):
         return '%s(%r, %r, %r)' % (
@@ -382,8 +472,12 @@ class Interface(Node):
         Node.__init__(self, name)
         self.parent = parent
         self.methods = []
+        self.virtual_methods = []
+        self.glib_type_struct = None
         self.properties = []
         self.fields = []
+        self.prerequisites = []
+        self.doc = None
 
     def __repr__(self):
         return '%s(%r, %r)' % (
@@ -413,6 +507,7 @@ class Property(Node):
         self.writable = writable
         self.construct = construct
         self.construct_only = construct_only
+        self.doc = None
 
     def __repr__(self):
         return '%s(%r, %r)' % (
@@ -430,6 +525,18 @@ class Callback(Node):
         self.retval = retval
         self.parameters = parameters
         self.ctype = ctype
+        self.throws = False
+        self.doc = None
+
+    def get_parameter_index(self, name):
+        for i, parameter in enumerate(self.parameters):
+            if parameter.name == name:
+                return i
+
+    def get_parameter(self, name):
+        for parameter in self.parameters:
+            if parameter.name == name:
+                return parameter
 
     def __repr__(self):
         return 'Callback(%r, %r, %r)' % (
@@ -442,7 +549,9 @@ class Union(Node):
         Node.__init__(self, name)
         self.fields = []
         self.constructors = []
+        self.methods = []
         self.symbol = symbol
+        self.doc = None
 
     def __repr__(self):
         return 'Union(%r, %r)' % (self.name, self.fields, )