José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 1 | ########################################################################## |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 2 | # |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 3 | # Copyright 2008-2010 VMware, Inc. |
José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 4 | # All Rights Reserved. |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 5 | # |
José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 6 | # Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | # of this software and associated documentation files (the "Software"), to deal |
| 8 | # in the Software without restriction, including without limitation the rights |
| 9 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | # copies of the Software, and to permit persons to whom the Software is |
| 11 | # furnished to do so, subject to the following conditions: |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 12 | # |
José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 13 | # The above copyright notice and this permission notice shall be included in |
| 14 | # all copies or substantial portions of the Software. |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 15 | # |
José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 16 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | # THE SOFTWARE. |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 23 | # |
José Fonseca | 7ad4026 | 2009-09-30 17:17:12 +0100 | [diff] [blame] | 24 | ##########################################################################/ |
José Fonseca | 9544244 | 2008-07-08 10:32:53 +0900 | [diff] [blame] | 25 | |
José Fonseca | d626cf4 | 2008-07-07 07:43:16 +0900 | [diff] [blame] | 26 | """C basic types""" |
| 27 | |
José Fonseca | 8a56d14 | 2008-07-09 12:18:08 +0900 | [diff] [blame] | 28 | |
| 29 | import debug |
| 30 | |
| 31 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 32 | class Type: |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 33 | """Base class for all types.""" |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 34 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 35 | __tags = set() |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 36 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 37 | def __init__(self, expr, tag = None): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 38 | self.expr = expr |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 39 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 40 | # Generate a default tag, used when naming functions that will operate |
| 41 | # on this type, so it should preferrably be something representative of |
| 42 | # the type. |
| 43 | if tag is None: |
José Fonseca | 5b6fb75 | 2012-04-14 14:56:45 +0100 | [diff] [blame] | 44 | if expr is not None: |
| 45 | tag = ''.join([c for c in expr if c.isalnum() or c in '_']) |
| 46 | else: |
| 47 | tag = 'anonynoums' |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 48 | else: |
| 49 | for c in tag: |
| 50 | assert c.isalnum() or c in '_' |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 51 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 52 | # Ensure it is unique. |
| 53 | if tag in Type.__tags: |
| 54 | suffix = 1 |
| 55 | while tag + str(suffix) in Type.__tags: |
| 56 | suffix += 1 |
| 57 | tag += str(suffix) |
| 58 | |
| 59 | assert tag not in Type.__tags |
| 60 | Type.__tags.add(tag) |
| 61 | |
| 62 | self.tag = tag |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 63 | |
| 64 | def __str__(self): |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 65 | """Return the C/C++ type expression for this type.""" |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 66 | return self.expr |
| 67 | |
| 68 | def visit(self, visitor, *args, **kwargs): |
| 69 | raise NotImplementedError |
| 70 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 71 | def mutable(self): |
| 72 | '''Return a mutable version of this type. |
| 73 | |
| 74 | Convenience wrapper around MutableRebuilder.''' |
| 75 | visitor = MutableRebuilder() |
| 76 | return visitor.visit(self) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 77 | |
| 78 | |
| 79 | class _Void(Type): |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 80 | """Singleton void type.""" |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 81 | |
| 82 | def __init__(self): |
| 83 | Type.__init__(self, "void") |
| 84 | |
| 85 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 86 | return visitor.visitVoid(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 87 | |
| 88 | Void = _Void() |
| 89 | |
| 90 | |
| 91 | class Literal(Type): |
José Fonseca | 2f2ea48 | 2011-10-15 15:10:06 +0100 | [diff] [blame] | 92 | """Class to describe literal types. |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 93 | |
José Fonseca | 2f2ea48 | 2011-10-15 15:10:06 +0100 | [diff] [blame] | 94 | Types which are not defined in terms of other types, such as integers and |
| 95 | floats.""" |
| 96 | |
| 97 | def __init__(self, expr, kind): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 98 | Type.__init__(self, expr) |
José Fonseca | 2f2ea48 | 2011-10-15 15:10:06 +0100 | [diff] [blame] | 99 | self.kind = kind |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 100 | |
| 101 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 102 | return visitor.visitLiteral(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 103 | |
| 104 | |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 105 | Bool = Literal("bool", "Bool") |
| 106 | SChar = Literal("signed char", "SInt") |
| 107 | UChar = Literal("unsigned char", "UInt") |
| 108 | Short = Literal("short", "SInt") |
| 109 | Int = Literal("int", "SInt") |
| 110 | Long = Literal("long", "SInt") |
| 111 | LongLong = Literal("long long", "SInt") |
| 112 | UShort = Literal("unsigned short", "UInt") |
| 113 | UInt = Literal("unsigned int", "UInt") |
| 114 | ULong = Literal("unsigned long", "UInt") |
| 115 | ULongLong = Literal("unsigned long long", "UInt") |
| 116 | Float = Literal("float", "Float") |
| 117 | Double = Literal("double", "Double") |
| 118 | SizeT = Literal("size_t", "UInt") |
| 119 | |
| 120 | Char = Literal("char", "SInt") |
| 121 | WChar = Literal("wchar_t", "SInt") |
| 122 | |
| 123 | Int8 = Literal("int8_t", "SInt") |
| 124 | UInt8 = Literal("uint8_t", "UInt") |
| 125 | Int16 = Literal("int16_t", "SInt") |
| 126 | UInt16 = Literal("uint16_t", "UInt") |
| 127 | Int32 = Literal("int32_t", "SInt") |
| 128 | UInt32 = Literal("uint32_t", "UInt") |
| 129 | Int64 = Literal("int64_t", "SInt") |
| 130 | UInt64 = Literal("uint64_t", "UInt") |
| 131 | |
José Fonseca | cb9d2e0 | 2012-10-19 14:51:48 +0100 | [diff] [blame] | 132 | IntPtr = Literal("intptr_t", "SInt") |
| 133 | UIntPtr = Literal("uintptr_t", "UInt") |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 134 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 135 | class Const(Type): |
| 136 | |
| 137 | def __init__(self, type): |
José Fonseca | 903c2ca | 2011-09-23 09:43:05 +0100 | [diff] [blame] | 138 | # While "const foo" and "foo const" are synonymous, "const foo *" and |
| 139 | # "foo * const" are not quite the same, and some compilers do enforce |
| 140 | # strict const correctness. |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 141 | if type.expr.startswith("const ") or '*' in type.expr: |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 142 | expr = type.expr + " const" |
| 143 | else: |
José Fonseca | 903c2ca | 2011-09-23 09:43:05 +0100 | [diff] [blame] | 144 | # The most legible |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 145 | expr = "const " + type.expr |
| 146 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 147 | Type.__init__(self, expr, 'C' + type.tag) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 148 | |
| 149 | self.type = type |
| 150 | |
| 151 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 152 | return visitor.visitConst(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 153 | |
| 154 | |
| 155 | class Pointer(Type): |
| 156 | |
| 157 | def __init__(self, type): |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 158 | Type.__init__(self, type.expr + " *", 'P' + type.tag) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 159 | self.type = type |
| 160 | |
| 161 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 162 | return visitor.visitPointer(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 163 | |
| 164 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 165 | class IntPointer(Type): |
| 166 | '''Integer encoded as a pointer.''' |
| 167 | |
| 168 | def visit(self, visitor, *args, **kwargs): |
| 169 | return visitor.visitIntPointer(self, *args, **kwargs) |
| 170 | |
| 171 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 172 | class ObjPointer(Type): |
| 173 | '''Pointer to an object.''' |
| 174 | |
| 175 | def __init__(self, type): |
| 176 | Type.__init__(self, type.expr + " *", 'P' + type.tag) |
| 177 | self.type = type |
| 178 | |
| 179 | def visit(self, visitor, *args, **kwargs): |
| 180 | return visitor.visitObjPointer(self, *args, **kwargs) |
| 181 | |
| 182 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 183 | class LinearPointer(Type): |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 184 | '''Pointer to a linear range of memory.''' |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 185 | |
| 186 | def __init__(self, type, size = None): |
| 187 | Type.__init__(self, type.expr + " *", 'P' + type.tag) |
| 188 | self.type = type |
| 189 | self.size = size |
| 190 | |
| 191 | def visit(self, visitor, *args, **kwargs): |
| 192 | return visitor.visitLinearPointer(self, *args, **kwargs) |
| 193 | |
| 194 | |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 195 | class Reference(Type): |
| 196 | '''C++ references.''' |
| 197 | |
| 198 | def __init__(self, type): |
| 199 | Type.__init__(self, type.expr + " &", 'R' + type.tag) |
| 200 | self.type = type |
| 201 | |
| 202 | def visit(self, visitor, *args, **kwargs): |
| 203 | return visitor.visitReference(self, *args, **kwargs) |
| 204 | |
| 205 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 206 | class Handle(Type): |
| 207 | |
José Fonseca | 8a844ae | 2010-12-06 18:50:52 +0000 | [diff] [blame] | 208 | def __init__(self, name, type, range=None, key=None): |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 209 | Type.__init__(self, type.expr, 'P' + type.tag) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 210 | self.name = name |
| 211 | self.type = type |
| 212 | self.range = range |
José Fonseca | 8a844ae | 2010-12-06 18:50:52 +0000 | [diff] [blame] | 213 | self.key = key |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 214 | |
| 215 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 216 | return visitor.visitHandle(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 217 | |
| 218 | |
| 219 | def ConstPointer(type): |
| 220 | return Pointer(Const(type)) |
| 221 | |
| 222 | |
| 223 | class Enum(Type): |
| 224 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 225 | __id = 0 |
| 226 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 227 | def __init__(self, name, values): |
| 228 | Type.__init__(self, name) |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 229 | |
| 230 | self.id = Enum.__id |
| 231 | Enum.__id += 1 |
| 232 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 233 | self.values = list(values) |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 234 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 235 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 236 | return visitor.visitEnum(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 237 | |
| 238 | |
| 239 | def FakeEnum(type, values): |
| 240 | return Enum(type.expr, values) |
| 241 | |
| 242 | |
| 243 | class Bitmask(Type): |
| 244 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 245 | __id = 0 |
| 246 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 247 | def __init__(self, type, values): |
| 248 | Type.__init__(self, type.expr) |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 249 | |
| 250 | self.id = Bitmask.__id |
| 251 | Bitmask.__id += 1 |
| 252 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 253 | self.type = type |
| 254 | self.values = values |
| 255 | |
| 256 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 257 | return visitor.visitBitmask(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 258 | |
| 259 | Flags = Bitmask |
| 260 | |
| 261 | |
| 262 | class Array(Type): |
| 263 | |
| 264 | def __init__(self, type, length): |
| 265 | Type.__init__(self, type.expr + " *") |
| 266 | self.type = type |
| 267 | self.length = length |
| 268 | |
| 269 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 270 | return visitor.visitArray(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 271 | |
| 272 | |
Andreas Hartmetz | ba7bb0d | 2013-07-07 22:51:12 +0200 | [diff] [blame] | 273 | class AttribArray(Type): |
| 274 | |
Andreas Hartmetz | b936e55 | 2013-07-08 12:36:11 +0200 | [diff] [blame^] | 275 | def __init__(self, keyType, valueTypes, isConst = True): |
| 276 | if isConst: |
| 277 | Type.__init__(self, (Pointer(Const(Int))).expr) |
| 278 | else: |
| 279 | Type.__init__(self, (Pointer(Int)).expr) |
Andreas Hartmetz | ba7bb0d | 2013-07-07 22:51:12 +0200 | [diff] [blame] | 280 | self.type = (Pointer(Const(Int))) # for function prototypes and such |
| 281 | self.keyType = keyType |
| 282 | self.valueTypes = valueTypes |
| 283 | |
| 284 | def visit(self, visitor, *args, **kwargs): |
| 285 | return visitor.visitAttribArray(self, *args, **kwargs) |
| 286 | |
| 287 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 288 | class Blob(Type): |
| 289 | |
| 290 | def __init__(self, type, size): |
| 291 | Type.__init__(self, type.expr + ' *') |
| 292 | self.type = type |
| 293 | self.size = size |
| 294 | |
| 295 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 296 | return visitor.visitBlob(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 297 | |
| 298 | |
| 299 | class Struct(Type): |
| 300 | |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 301 | __id = 0 |
| 302 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 303 | def __init__(self, name, members): |
| 304 | Type.__init__(self, name) |
José Fonseca | 02c2500 | 2011-10-15 13:17:26 +0100 | [diff] [blame] | 305 | |
| 306 | self.id = Struct.__id |
| 307 | Struct.__id += 1 |
| 308 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 309 | self.name = name |
José Fonseca | dbf714b | 2012-11-20 17:03:43 +0000 | [diff] [blame] | 310 | self.members = members |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 311 | |
| 312 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 313 | return visitor.visitStruct(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 314 | |
| 315 | |
José Fonseca | dbf714b | 2012-11-20 17:03:43 +0000 | [diff] [blame] | 316 | def Union(kindExpr, kindTypes, contextLess=True): |
José Fonseca | eb216e6 | 2012-11-20 11:08:08 +0000 | [diff] [blame] | 317 | switchTypes = [] |
| 318 | for kindCase, kindType, kindMemberName in kindTypes: |
| 319 | switchType = Struct(None, [(kindType, kindMemberName)]) |
| 320 | switchTypes.append((kindCase, switchType)) |
| 321 | return Polymorphic(kindExpr, switchTypes, contextLess=contextLess) |
| 322 | |
José Fonseca | 5b6fb75 | 2012-04-14 14:56:45 +0100 | [diff] [blame] | 323 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 324 | class Alias(Type): |
| 325 | |
| 326 | def __init__(self, expr, type): |
| 327 | Type.__init__(self, expr) |
| 328 | self.type = type |
| 329 | |
| 330 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 331 | return visitor.visitAlias(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 332 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 333 | class Arg: |
| 334 | |
José Fonseca | 9dd8f70 | 2012-04-07 10:42:50 +0100 | [diff] [blame] | 335 | def __init__(self, type, name, input=True, output=False): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 336 | self.type = type |
| 337 | self.name = name |
José Fonseca | 9dd8f70 | 2012-04-07 10:42:50 +0100 | [diff] [blame] | 338 | self.input = input |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 339 | self.output = output |
| 340 | self.index = None |
| 341 | |
| 342 | def __str__(self): |
| 343 | return '%s %s' % (self.type, self.name) |
| 344 | |
| 345 | |
José Fonseca | 9dd8f70 | 2012-04-07 10:42:50 +0100 | [diff] [blame] | 346 | def In(type, name): |
| 347 | return Arg(type, name, input=True, output=False) |
| 348 | |
| 349 | def Out(type, name): |
| 350 | return Arg(type, name, input=False, output=True) |
| 351 | |
| 352 | def InOut(type, name): |
| 353 | return Arg(type, name, input=True, output=True) |
| 354 | |
| 355 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 356 | class Function: |
| 357 | |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 358 | def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 359 | self.type = type |
| 360 | self.name = name |
| 361 | |
| 362 | self.args = [] |
| 363 | index = 0 |
| 364 | for arg in args: |
José Fonseca | 8384ccb | 2011-05-25 10:12:02 +0100 | [diff] [blame] | 365 | if not isinstance(arg, Arg): |
| 366 | if isinstance(arg, tuple): |
| 367 | arg_type, arg_name = arg |
| 368 | else: |
| 369 | arg_type = arg |
| 370 | arg_name = "arg%u" % index |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 371 | arg = Arg(arg_type, arg_name) |
| 372 | arg.index = index |
| 373 | index += 1 |
| 374 | self.args.append(arg) |
| 375 | |
| 376 | self.call = call |
| 377 | self.fail = fail |
| 378 | self.sideeffects = sideeffects |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 379 | self.internal = internal |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 380 | |
| 381 | def prototype(self, name=None): |
| 382 | if name is not None: |
| 383 | name = name.strip() |
| 384 | else: |
| 385 | name = self.name |
| 386 | s = name |
| 387 | if self.call: |
| 388 | s = self.call + ' ' + s |
| 389 | if name.startswith('*'): |
| 390 | s = '(' + s + ')' |
| 391 | s = self.type.expr + ' ' + s |
| 392 | s += "(" |
| 393 | if self.args: |
| 394 | s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args]) |
| 395 | else: |
| 396 | s += "void" |
| 397 | s += ")" |
| 398 | return s |
| 399 | |
José Fonseca | 568ecc2 | 2012-01-15 13:57:03 +0000 | [diff] [blame] | 400 | def argNames(self): |
| 401 | return [arg.name for arg in self.args] |
| 402 | |
José Fonseca | 999284f | 2013-02-19 13:29:26 +0000 | [diff] [blame] | 403 | def getArgByName(self, name): |
| 404 | for arg in self.args: |
| 405 | if arg.name == name: |
| 406 | return arg |
| 407 | return None |
| 408 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 409 | |
| 410 | def StdFunction(*args, **kwargs): |
| 411 | kwargs.setdefault('call', '__stdcall') |
| 412 | return Function(*args, **kwargs) |
| 413 | |
| 414 | |
| 415 | def FunctionPointer(type, name, args, **kwargs): |
| 416 | # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion |
| 417 | return Opaque(name) |
| 418 | |
| 419 | |
| 420 | class Interface(Type): |
| 421 | |
| 422 | def __init__(self, name, base=None): |
| 423 | Type.__init__(self, name) |
| 424 | self.name = name |
| 425 | self.base = base |
| 426 | self.methods = [] |
| 427 | |
| 428 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 429 | return visitor.visitInterface(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 430 | |
José Fonseca | bd08634 | 2012-04-18 19:58:32 +0100 | [diff] [blame] | 431 | def getMethodByName(self, name): |
José Fonseca | d275d0a | 2012-04-30 23:18:05 +0100 | [diff] [blame] | 432 | for method in self.iterMethods(): |
| 433 | if method.name == name: |
| 434 | return method |
José Fonseca | bd08634 | 2012-04-18 19:58:32 +0100 | [diff] [blame] | 435 | return None |
| 436 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 437 | def iterMethods(self): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 438 | if self.base is not None: |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 439 | for method in self.base.iterMethods(): |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 440 | yield method |
| 441 | for method in self.methods: |
| 442 | yield method |
| 443 | raise StopIteration |
| 444 | |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 445 | def iterBases(self): |
| 446 | iface = self |
| 447 | while iface is not None: |
| 448 | yield iface |
| 449 | iface = iface.base |
| 450 | raise StopIteration |
| 451 | |
José Fonseca | 5abf560 | 2013-05-30 14:00:44 +0100 | [diff] [blame] | 452 | def hasBase(self, *bases): |
| 453 | for iface in self.iterBases(): |
| 454 | if iface in bases: |
| 455 | return True |
| 456 | return False |
| 457 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 458 | def iterBaseMethods(self): |
| 459 | if self.base is not None: |
| 460 | for iface, method in self.base.iterBaseMethods(): |
| 461 | yield iface, method |
| 462 | for method in self.methods: |
| 463 | yield self, method |
| 464 | raise StopIteration |
| 465 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 466 | |
| 467 | class Method(Function): |
| 468 | |
José Fonseca | 43aa19f | 2012-11-10 09:29:38 +0000 | [diff] [blame] | 469 | def __init__(self, type, name, args, call = '', const=False, sideeffects=True): |
| 470 | assert call == '__stdcall' |
José Fonseca | 5b6fb75 | 2012-04-14 14:56:45 +0100 | [diff] [blame] | 471 | Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 472 | for index in range(len(self.args)): |
| 473 | self.args[index].index = index + 1 |
José Fonseca | 9dbeda6 | 2012-02-03 19:05:54 +0000 | [diff] [blame] | 474 | self.const = const |
| 475 | |
| 476 | def prototype(self, name=None): |
| 477 | s = Function.prototype(self, name) |
| 478 | if self.const: |
| 479 | s += ' const' |
| 480 | return s |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 481 | |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 482 | |
José Fonseca | 5b6fb75 | 2012-04-14 14:56:45 +0100 | [diff] [blame] | 483 | def StdMethod(*args, **kwargs): |
| 484 | kwargs.setdefault('call', '__stdcall') |
| 485 | return Method(*args, **kwargs) |
| 486 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 487 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 488 | class String(Type): |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 489 | '''Human-legible character string.''' |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 490 | |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 491 | def __init__(self, type = Char, length = None, wide = False): |
| 492 | assert isinstance(type, Type) |
| 493 | Type.__init__(self, type.expr + ' *') |
| 494 | self.type = type |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 495 | self.length = length |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 496 | self.wide = wide |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 497 | |
| 498 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 499 | return visitor.visitString(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 500 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 501 | |
| 502 | class Opaque(Type): |
| 503 | '''Opaque pointer.''' |
| 504 | |
| 505 | def __init__(self, expr): |
| 506 | Type.__init__(self, expr) |
| 507 | |
| 508 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 509 | return visitor.visitOpaque(self, *args, **kwargs) |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 510 | |
| 511 | |
| 512 | def OpaquePointer(type, *args): |
| 513 | return Opaque(type.expr + ' *') |
| 514 | |
| 515 | def OpaqueArray(type, size): |
| 516 | return Opaque(type.expr + ' *') |
| 517 | |
| 518 | def OpaqueBlob(type, size): |
| 519 | return Opaque(type.expr + ' *') |
José Fonseca | 8a56d14 | 2008-07-09 12:18:08 +0900 | [diff] [blame] | 520 | |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 521 | |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 522 | class Polymorphic(Type): |
| 523 | |
José Fonseca | eb216e6 | 2012-11-20 11:08:08 +0000 | [diff] [blame] | 524 | def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True): |
| 525 | if defaultType is None: |
| 526 | Type.__init__(self, None) |
| 527 | contextLess = False |
| 528 | else: |
| 529 | Type.__init__(self, defaultType.expr) |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 530 | self.switchExpr = switchExpr |
| 531 | self.switchTypes = switchTypes |
José Fonseca | b95e372 | 2012-04-16 14:01:15 +0100 | [diff] [blame] | 532 | self.defaultType = defaultType |
| 533 | self.contextLess = contextLess |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 534 | |
| 535 | def visit(self, visitor, *args, **kwargs): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 536 | return visitor.visitPolymorphic(self, *args, **kwargs) |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 537 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 538 | def iterSwitch(self): |
José Fonseca | eb216e6 | 2012-11-20 11:08:08 +0000 | [diff] [blame] | 539 | cases = [] |
| 540 | types = [] |
| 541 | |
| 542 | if self.defaultType is not None: |
| 543 | cases.append(['default']) |
| 544 | types.append(self.defaultType) |
José Fonseca | 4616111 | 2011-10-14 10:04:55 +0100 | [diff] [blame] | 545 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 546 | for expr, type in self.switchTypes: |
José Fonseca | 4616111 | 2011-10-14 10:04:55 +0100 | [diff] [blame] | 547 | case = 'case %s' % expr |
| 548 | try: |
| 549 | i = types.index(type) |
| 550 | except ValueError: |
| 551 | cases.append([case]) |
| 552 | types.append(type) |
| 553 | else: |
| 554 | cases[i].append(case) |
| 555 | |
| 556 | return zip(cases, types) |
| 557 | |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 558 | |
José Fonseca | b95e372 | 2012-04-16 14:01:15 +0100 | [diff] [blame] | 559 | def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True): |
| 560 | enumValues = [expr for expr, type in switchTypes] |
| 561 | enum = Enum(enumName, enumValues) |
| 562 | polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess) |
| 563 | return enum, polymorphic |
| 564 | |
| 565 | |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 566 | class Visitor: |
José Fonseca | 9c4a257 | 2012-01-13 23:21:10 +0000 | [diff] [blame] | 567 | '''Abstract visitor for the type hierarchy.''' |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 568 | |
| 569 | def visit(self, type, *args, **kwargs): |
| 570 | return type.visit(self, *args, **kwargs) |
| 571 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 572 | def visitVoid(self, void, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 573 | raise NotImplementedError |
| 574 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 575 | def visitLiteral(self, literal, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 576 | raise NotImplementedError |
| 577 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 578 | def visitString(self, string, *args, **kwargs): |
José Fonseca | 2defc98 | 2010-11-22 16:59:10 +0000 | [diff] [blame] | 579 | raise NotImplementedError |
| 580 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 581 | def visitConst(self, const, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 582 | raise NotImplementedError |
| 583 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 584 | def visitStruct(self, struct, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 585 | raise NotImplementedError |
| 586 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 587 | def visitArray(self, array, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 588 | raise NotImplementedError |
| 589 | |
Andreas Hartmetz | ba7bb0d | 2013-07-07 22:51:12 +0200 | [diff] [blame] | 590 | def visitAttribArray(self, array, *args, **kwargs): |
| 591 | raise NotImplementedError |
| 592 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 593 | def visitBlob(self, blob, *args, **kwargs): |
José Fonseca | 885f265 | 2010-11-20 11:22:25 +0000 | [diff] [blame] | 594 | raise NotImplementedError |
| 595 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 596 | def visitEnum(self, enum, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 597 | raise NotImplementedError |
| 598 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 599 | def visitBitmask(self, bitmask, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 600 | raise NotImplementedError |
| 601 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 602 | def visitPointer(self, pointer, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 603 | raise NotImplementedError |
| 604 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 605 | def visitIntPointer(self, pointer, *args, **kwargs): |
| 606 | raise NotImplementedError |
| 607 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 608 | def visitObjPointer(self, pointer, *args, **kwargs): |
| 609 | raise NotImplementedError |
| 610 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 611 | def visitLinearPointer(self, pointer, *args, **kwargs): |
| 612 | raise NotImplementedError |
| 613 | |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 614 | def visitReference(self, reference, *args, **kwargs): |
| 615 | raise NotImplementedError |
| 616 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 617 | def visitHandle(self, handle, *args, **kwargs): |
José Fonseca | 50d78d8 | 2010-11-23 22:13:14 +0000 | [diff] [blame] | 618 | raise NotImplementedError |
| 619 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 620 | def visitAlias(self, alias, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 621 | raise NotImplementedError |
| 622 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 623 | def visitOpaque(self, opaque, *args, **kwargs): |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 624 | raise NotImplementedError |
| 625 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 626 | def visitInterface(self, interface, *args, **kwargs): |
José Fonseca | c356d6a | 2010-11-23 14:27:25 +0000 | [diff] [blame] | 627 | raise NotImplementedError |
| 628 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 629 | def visitPolymorphic(self, polymorphic, *args, **kwargs): |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 630 | raise NotImplementedError |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 631 | #return self.visit(polymorphic.defaultType, *args, **kwargs) |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 632 | |
José Fonseca | c356d6a | 2010-11-23 14:27:25 +0000 | [diff] [blame] | 633 | |
| 634 | class OnceVisitor(Visitor): |
José Fonseca | 9c4a257 | 2012-01-13 23:21:10 +0000 | [diff] [blame] | 635 | '''Visitor that guarantees that each type is visited only once.''' |
José Fonseca | c356d6a | 2010-11-23 14:27:25 +0000 | [diff] [blame] | 636 | |
| 637 | def __init__(self): |
| 638 | self.__visited = set() |
| 639 | |
| 640 | def visit(self, type, *args, **kwargs): |
| 641 | if type not in self.__visited: |
| 642 | self.__visited.add(type) |
| 643 | return type.visit(self, *args, **kwargs) |
| 644 | return None |
| 645 | |
José Fonseca | 501f286 | 2010-11-19 20:41:18 +0000 | [diff] [blame] | 646 | |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 647 | class Rebuilder(Visitor): |
José Fonseca | 9c4a257 | 2012-01-13 23:21:10 +0000 | [diff] [blame] | 648 | '''Visitor which rebuild types as it visits them. |
| 649 | |
| 650 | By itself it is a no-op -- it is intended to be overwritten. |
| 651 | ''' |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 652 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 653 | def visitVoid(self, void): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 654 | return void |
| 655 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 656 | def visitLiteral(self, literal): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 657 | return literal |
| 658 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 659 | def visitString(self, string): |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 660 | string_type = self.visit(string.type) |
| 661 | if string_type is string.type: |
| 662 | return string |
| 663 | else: |
| 664 | return String(string_type, string.length, string.wide) |
José Fonseca | 2defc98 | 2010-11-22 16:59:10 +0000 | [diff] [blame] | 665 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 666 | def visitConst(self, const): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 667 | const_type = self.visit(const.type) |
| 668 | if const_type is const.type: |
| 669 | return const |
| 670 | else: |
| 671 | return Const(const_type) |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 672 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 673 | def visitStruct(self, struct): |
José Fonseca | 06aa284 | 2011-05-05 07:55:54 +0100 | [diff] [blame] | 674 | members = [(self.visit(type), name) for type, name in struct.members] |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 675 | return Struct(struct.name, members) |
| 676 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 677 | def visitArray(self, array): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 678 | type = self.visit(array.type) |
| 679 | return Array(type, array.length) |
| 680 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 681 | def visitBlob(self, blob): |
José Fonseca | 885f265 | 2010-11-20 11:22:25 +0000 | [diff] [blame] | 682 | type = self.visit(blob.type) |
| 683 | return Blob(type, blob.size) |
| 684 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 685 | def visitEnum(self, enum): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 686 | return enum |
| 687 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 688 | def visitBitmask(self, bitmask): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 689 | type = self.visit(bitmask.type) |
| 690 | return Bitmask(type, bitmask.values) |
| 691 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 692 | def visitPointer(self, pointer): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 693 | pointer_type = self.visit(pointer.type) |
| 694 | if pointer_type is pointer.type: |
| 695 | return pointer |
| 696 | else: |
| 697 | return Pointer(pointer_type) |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 698 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 699 | def visitIntPointer(self, pointer): |
| 700 | return pointer |
| 701 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 702 | def visitObjPointer(self, pointer): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 703 | pointer_type = self.visit(pointer.type) |
| 704 | if pointer_type is pointer.type: |
| 705 | return pointer |
| 706 | else: |
| 707 | return ObjPointer(pointer_type) |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 708 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 709 | def visitLinearPointer(self, pointer): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 710 | pointer_type = self.visit(pointer.type) |
| 711 | if pointer_type is pointer.type: |
| 712 | return pointer |
| 713 | else: |
| 714 | return LinearPointer(pointer_type) |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 715 | |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 716 | def visitReference(self, reference): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 717 | reference_type = self.visit(reference.type) |
| 718 | if reference_type is reference.type: |
| 719 | return reference |
| 720 | else: |
| 721 | return Reference(reference_type) |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 722 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 723 | def visitHandle(self, handle): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 724 | handle_type = self.visit(handle.type) |
| 725 | if handle_type is handle.type: |
| 726 | return handle |
| 727 | else: |
| 728 | return Handle(handle.name, handle_type, range=handle.range, key=handle.key) |
José Fonseca | 50d78d8 | 2010-11-23 22:13:14 +0000 | [diff] [blame] | 729 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 730 | def visitAlias(self, alias): |
José Fonseca | f182eda | 2012-04-05 19:59:56 +0100 | [diff] [blame] | 731 | alias_type = self.visit(alias.type) |
| 732 | if alias_type is alias.type: |
| 733 | return alias |
| 734 | else: |
| 735 | return Alias(alias.expr, alias_type) |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 736 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 737 | def visitOpaque(self, opaque): |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 738 | return opaque |
| 739 | |
José Fonseca | 7814edf | 2012-01-31 10:55:49 +0000 | [diff] [blame] | 740 | def visitInterface(self, interface, *args, **kwargs): |
| 741 | return interface |
| 742 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 743 | def visitPolymorphic(self, polymorphic): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 744 | switchExpr = polymorphic.switchExpr |
| 745 | switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes] |
José Fonseca | eb216e6 | 2012-11-20 11:08:08 +0000 | [diff] [blame] | 746 | if polymorphic.defaultType is None: |
| 747 | defaultType = None |
| 748 | else: |
| 749 | defaultType = self.visit(polymorphic.defaultType) |
José Fonseca | b95e372 | 2012-04-16 14:01:15 +0100 | [diff] [blame] | 750 | return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess) |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 751 | |
José Fonseca | c9edb83 | 2010-11-20 09:03:10 +0000 | [diff] [blame] | 752 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 753 | class MutableRebuilder(Rebuilder): |
| 754 | '''Type visitor which derives a mutable type.''' |
| 755 | |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 756 | def visitString(self, string): |
| 757 | return string |
| 758 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 759 | def visitConst(self, const): |
| 760 | # Strip out const qualifier |
| 761 | return const.type |
| 762 | |
| 763 | def visitAlias(self, alias): |
| 764 | # Tear the alias on type changes |
| 765 | type = self.visit(alias.type) |
| 766 | if type is alias.type: |
| 767 | return alias |
| 768 | return type |
| 769 | |
| 770 | def visitReference(self, reference): |
| 771 | # Strip out references |
| 772 | return reference.type |
| 773 | |
| 774 | |
| 775 | class Traverser(Visitor): |
| 776 | '''Visitor which all types.''' |
| 777 | |
| 778 | def visitVoid(self, void, *args, **kwargs): |
| 779 | pass |
| 780 | |
| 781 | def visitLiteral(self, literal, *args, **kwargs): |
| 782 | pass |
| 783 | |
| 784 | def visitString(self, string, *args, **kwargs): |
| 785 | pass |
| 786 | |
| 787 | def visitConst(self, const, *args, **kwargs): |
| 788 | self.visit(const.type, *args, **kwargs) |
| 789 | |
| 790 | def visitStruct(self, struct, *args, **kwargs): |
| 791 | for type, name in struct.members: |
| 792 | self.visit(type, *args, **kwargs) |
| 793 | |
| 794 | def visitArray(self, array, *args, **kwargs): |
| 795 | self.visit(array.type, *args, **kwargs) |
| 796 | |
Andreas Hartmetz | ba7bb0d | 2013-07-07 22:51:12 +0200 | [diff] [blame] | 797 | def visitAttribArray(self, attribs, *args, **kwargs): |
| 798 | for key, valueType in attribs.valueTypes: |
| 799 | self.visit(valueType, *args, **kwargs) |
| 800 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 801 | def visitBlob(self, array, *args, **kwargs): |
| 802 | pass |
| 803 | |
| 804 | def visitEnum(self, enum, *args, **kwargs): |
| 805 | pass |
| 806 | |
| 807 | def visitBitmask(self, bitmask, *args, **kwargs): |
| 808 | self.visit(bitmask.type, *args, **kwargs) |
| 809 | |
| 810 | def visitPointer(self, pointer, *args, **kwargs): |
| 811 | self.visit(pointer.type, *args, **kwargs) |
| 812 | |
| 813 | def visitIntPointer(self, pointer, *args, **kwargs): |
| 814 | pass |
| 815 | |
| 816 | def visitObjPointer(self, pointer, *args, **kwargs): |
| 817 | self.visit(pointer.type, *args, **kwargs) |
| 818 | |
| 819 | def visitLinearPointer(self, pointer, *args, **kwargs): |
| 820 | self.visit(pointer.type, *args, **kwargs) |
| 821 | |
| 822 | def visitReference(self, reference, *args, **kwargs): |
| 823 | self.visit(reference.type, *args, **kwargs) |
| 824 | |
| 825 | def visitHandle(self, handle, *args, **kwargs): |
| 826 | self.visit(handle.type, *args, **kwargs) |
| 827 | |
| 828 | def visitAlias(self, alias, *args, **kwargs): |
| 829 | self.visit(alias.type, *args, **kwargs) |
| 830 | |
| 831 | def visitOpaque(self, opaque, *args, **kwargs): |
| 832 | pass |
| 833 | |
| 834 | def visitInterface(self, interface, *args, **kwargs): |
| 835 | if interface.base is not None: |
| 836 | self.visit(interface.base, *args, **kwargs) |
| 837 | for method in interface.iterMethods(): |
| 838 | for arg in method.args: |
| 839 | self.visit(arg.type, *args, **kwargs) |
| 840 | self.visit(method.type, *args, **kwargs) |
| 841 | |
| 842 | def visitPolymorphic(self, polymorphic, *args, **kwargs): |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 843 | for expr, type in polymorphic.switchTypes: |
| 844 | self.visit(type, *args, **kwargs) |
José Fonseca | eb216e6 | 2012-11-20 11:08:08 +0000 | [diff] [blame] | 845 | if polymorphic.defaultType is not None: |
| 846 | self.visit(polymorphic.defaultType, *args, **kwargs) |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 847 | |
| 848 | |
| 849 | class Collector(Traverser): |
José Fonseca | 9c4a257 | 2012-01-13 23:21:10 +0000 | [diff] [blame] | 850 | '''Visitor which collects all unique types as it traverses them.''' |
José Fonseca | e6a50bd | 2010-11-24 10:12:22 +0000 | [diff] [blame] | 851 | |
| 852 | def __init__(self): |
| 853 | self.__visited = set() |
| 854 | self.types = [] |
| 855 | |
| 856 | def visit(self, type): |
| 857 | if type in self.__visited: |
| 858 | return |
| 859 | self.__visited.add(type) |
| 860 | Visitor.visit(self, type) |
| 861 | self.types.append(type) |
| 862 | |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 863 | |
José Fonseca | dbf714b | 2012-11-20 17:03:43 +0000 | [diff] [blame] | 864 | class ExpanderMixin: |
| 865 | '''Mixin class that provides a bunch of methods to expand C expressions |
| 866 | from the specifications.''' |
| 867 | |
| 868 | __structs = None |
| 869 | __indices = None |
| 870 | |
| 871 | def expand(self, expr): |
| 872 | # Expand a C expression, replacing certain variables |
| 873 | if not isinstance(expr, basestring): |
| 874 | return expr |
| 875 | variables = {} |
| 876 | |
| 877 | if self.__structs is not None: |
| 878 | variables['self'] = '(%s)' % self.__structs[0] |
| 879 | if self.__indices is not None: |
| 880 | variables['i'] = self.__indices[0] |
| 881 | |
| 882 | expandedExpr = expr.format(**variables) |
| 883 | if expandedExpr != expr and 0: |
| 884 | sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr)) |
| 885 | return expandedExpr |
| 886 | |
| 887 | def visitMember(self, member, structInstance, *args, **kwargs): |
| 888 | memberType, memberName = member |
| 889 | if memberName is None: |
| 890 | # Anonymous structure/union member |
| 891 | memberInstance = structInstance |
| 892 | else: |
| 893 | memberInstance = '(%s).%s' % (structInstance, memberName) |
| 894 | self.__structs = (structInstance, self.__structs) |
| 895 | try: |
| 896 | return self.visit(memberType, memberInstance, *args, **kwargs) |
| 897 | finally: |
| 898 | _, self.__structs = self.__structs |
| 899 | |
| 900 | def visitElement(self, elementIndex, elementType, *args, **kwargs): |
| 901 | self.__indices = (elementIndex, self.__indices) |
| 902 | try: |
| 903 | return self.visit(elementType, *args, **kwargs) |
| 904 | finally: |
| 905 | _, self.__indices = self.__indices |
| 906 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 907 | |
José Fonseca | 8130193 | 2012-11-11 00:10:20 +0000 | [diff] [blame] | 908 | class Module: |
| 909 | '''A collection of functions.''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 910 | |
José Fonseca | 68ec412 | 2011-02-20 11:25:25 +0000 | [diff] [blame] | 911 | def __init__(self, name = None): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 912 | self.name = name |
| 913 | self.headers = [] |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 914 | self.functions = [] |
| 915 | self.interfaces = [] |
| 916 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 917 | def addFunctions(self, functions): |
José Fonseca | 8130193 | 2012-11-11 00:10:20 +0000 | [diff] [blame] | 918 | self.functions.extend(functions) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 919 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 920 | def addInterfaces(self, interfaces): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 921 | self.interfaces.extend(interfaces) |
| 922 | |
José Fonseca | 8130193 | 2012-11-11 00:10:20 +0000 | [diff] [blame] | 923 | def mergeModule(self, module): |
| 924 | self.headers.extend(module.headers) |
| 925 | self.functions.extend(module.functions) |
| 926 | self.interfaces.extend(module.interfaces) |
José Fonseca | 68ec412 | 2011-02-20 11:25:25 +0000 | [diff] [blame] | 927 | |
José Fonseca | 1b6c875 | 2012-04-15 14:33:00 +0100 | [diff] [blame] | 928 | def getFunctionByName(self, name): |
José Fonseca | eccec3e | 2011-02-20 09:01:25 +0000 | [diff] [blame] | 929 | for function in self.functions: |
| 930 | if function.name == name: |
| 931 | return function |
| 932 | return None |
| 933 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 934 | |
José Fonseca | 8130193 | 2012-11-11 00:10:20 +0000 | [diff] [blame] | 935 | class API: |
| 936 | '''API abstraction. |
| 937 | |
| 938 | Essentially, a collection of types, functions, and interfaces. |
| 939 | ''' |
| 940 | |
| 941 | def __init__(self, modules = None): |
| 942 | self.modules = [] |
| 943 | if modules is not None: |
| 944 | self.modules.extend(modules) |
| 945 | |
| 946 | def getAllTypes(self): |
| 947 | collector = Collector() |
| 948 | for module in self.modules: |
| 949 | for function in module.functions: |
| 950 | for arg in function.args: |
| 951 | collector.visit(arg.type) |
| 952 | collector.visit(function.type) |
| 953 | for interface in module.interfaces: |
| 954 | collector.visit(interface) |
| 955 | for method in interface.iterMethods(): |
| 956 | for arg in method.args: |
| 957 | collector.visit(arg.type) |
| 958 | collector.visit(method.type) |
| 959 | return collector.types |
| 960 | |
| 961 | def getAllFunctions(self): |
| 962 | functions = [] |
| 963 | for module in self.modules: |
| 964 | functions.extend(module.functions) |
| 965 | return functions |
| 966 | |
| 967 | def getAllInterfaces(self): |
| 968 | types = self.getAllTypes() |
| 969 | interfaces = [type for type in types if isinstance(type, Interface)] |
| 970 | for module in self.modules: |
| 971 | for interface in module.interfaces: |
| 972 | if interface not in interfaces: |
| 973 | interfaces.append(interface) |
| 974 | return interfaces |
| 975 | |
| 976 | def addModule(self, module): |
| 977 | self.modules.append(module) |
| 978 | |
| 979 | def getFunctionByName(self, name): |
| 980 | for module in self.modules: |
| 981 | for function in module.functions: |
| 982 | if function.name == name: |
| 983 | return function |
| 984 | return None |
| 985 | |
| 986 | |
José Fonseca | 280a176 | 2012-01-31 15:10:13 +0000 | [diff] [blame] | 987 | # C string (i.e., zero terminated) |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 988 | CString = String(Char) |
| 989 | WString = String(WChar, wide=True) |
| 990 | ConstCString = String(Const(Char)) |
| 991 | ConstWString = String(Const(WChar), wide=True) |