4 # Copyright IBM, Corp. 2011
5 # Copyright (c) 2013 Red Hat Inc.
8 # Anthony Liguori <aliguori@us.ibm.com>
9 # Markus Armbruster <armbru@redhat.com>
11 # This work is licensed under the terms of the GNU GPL, version 2.
12 # See the COPYING file in the top-level directory.
14 from ordereddict
import OrderedDict
18 'str', 'int', 'number', 'bool',
19 'int8', 'int16', 'int32', 'int64',
20 'uint8', 'uint16', 'uint32', 'uint64'
23 builtin_type_qtypes
= {
24 'str': 'QTYPE_QSTRING',
26 'number': 'QTYPE_QFLOAT',
27 'bool': 'QTYPE_QBOOL',
29 'int16': 'QTYPE_QINT',
30 'int32': 'QTYPE_QINT',
31 'int64': 'QTYPE_QINT',
32 'uint8': 'QTYPE_QINT',
33 'uint16': 'QTYPE_QINT',
34 'uint32': 'QTYPE_QINT',
35 'uint64': 'QTYPE_QINT',
38 class QAPISchemaError(Exception):
39 def __init__(self
, schema
, msg
):
43 self
.line
= schema
.line
44 for ch
in schema
.src
[schema
.line_pos
:schema
.pos
]:
46 self
.col
= (self
.col
+ 7) % 8 + 1
51 return "%s:%s:%s: %s" % (self
.fp
.name
, self
.line
, self
.col
, self
.msg
)
53 class QAPIExprError(Exception):
54 def __init__(self
, expr_info
, msg
):
55 self
.fp
= expr_info
['fp']
56 self
.line
= expr_info
['line']
60 return "%s:%s: %s" % (self
.fp
.name
, self
.line
, self
.msg
)
64 def __init__(self
, fp
):
67 if self
.src
== '' or self
.src
[-1] != '\n':
75 while self
.tok
!= None:
76 expr_info
= {'fp': fp
, 'line': self
.line
}
77 expr_elem
= {'expr': self
.get_expr(False),
79 self
.exprs
.append(expr_elem
)
83 self
.tok
= self
.src
[self
.cursor
]
84 self
.pos
= self
.cursor
89 self
.cursor
= self
.src
.find('\n', self
.cursor
)
90 elif self
.tok
in ['{', '}', ':', ',', '[', ']']:
96 ch
= self
.src
[self
.cursor
]
99 raise QAPISchemaError(self
,
100 'Missing terminating "\'"')
111 elif self
.tok
== '\n':
112 if self
.cursor
== len(self
.src
):
116 self
.line_pos
= self
.cursor
117 elif not self
.tok
.isspace():
118 raise QAPISchemaError(self
, 'Stray "%s"' % self
.tok
)
120 def get_members(self
):
126 raise QAPISchemaError(self
, 'Expected string or "}"')
131 raise QAPISchemaError(self
, 'Expected ":"')
134 raise QAPISchemaError(self
, 'Duplicate key "%s"' % key
)
135 expr
[key
] = self
.get_expr(True)
140 raise QAPISchemaError(self
, 'Expected "," or "}"')
143 raise QAPISchemaError(self
, 'Expected string')
145 def get_values(self
):
150 if not self
.tok
in [ '{', '[', "'" ]:
151 raise QAPISchemaError(self
, 'Expected "{", "[", "]" or string')
153 expr
.append(self
.get_expr(True))
158 raise QAPISchemaError(self
, 'Expected "," or "]"')
161 def get_expr(self
, nested
):
162 if self
.tok
!= '{' and not nested
:
163 raise QAPISchemaError(self
, 'Expected "{"')
166 expr
= self
.get_members()
167 elif self
.tok
== '[':
169 expr
= self
.get_values()
170 elif self
.tok
== "'":
174 raise QAPISchemaError(self
, 'Expected "{", "[" or string')
177 def find_base_fields(base
):
178 base_struct_define
= find_struct(base
)
179 if not base_struct_define
:
181 return base_struct_define
['data']
183 def check_union(expr
, expr_info
):
185 base
= expr
.get('base')
186 discriminator
= expr
.get('discriminator')
187 members
= expr
['data']
189 # If the object has a member 'base', its value must name a complex type.
191 base_fields
= find_base_fields(base
)
193 raise QAPIExprError(expr_info
,
194 "Base '%s' is not a valid type"
197 # If the union object has no member 'discriminator', it's an
199 if not discriminator
:
202 # Else if the value of member 'discriminator' is {}, it's an
204 elif discriminator
== {}:
207 # Else, it's a flat union.
209 # The object must have a member 'base'.
211 raise QAPIExprError(expr_info
,
212 "Flat union '%s' must have a base field"
214 # The value of member 'discriminator' must name a member of the
216 discriminator_type
= base_fields
.get(discriminator
)
217 if not discriminator_type
:
218 raise QAPIExprError(expr_info
,
219 "Discriminator '%s' is not a member of base "
221 % (discriminator
, base
))
222 enum_define
= find_enum(discriminator_type
)
225 for (key
, value
) in members
.items():
226 # If this named member's value names an enum type, then all members
227 # of 'data' must also be members of the enum type.
228 if enum_define
and not key
in enum_define
['enum_values']:
229 raise QAPIExprError(expr_info
,
230 "Discriminator value '%s' is not found in "
232 (key
, enum_define
["enum_name"]))
233 # Todo: add checking for values. Key is checked as above, value can be
234 # also checked here, but we need more functions to handle array case.
236 def check_exprs(schema
):
237 for expr_elem
in schema
.exprs
:
238 expr
= expr_elem
['expr']
239 if expr
.has_key('union'):
240 check_union(expr
, expr_elem
['info'])
242 def parse_schema(fp
):
244 schema
= QAPISchema(fp
)
245 except QAPISchemaError
, e
:
246 print >>sys
.stderr
, e
251 for expr_elem
in schema
.exprs
:
252 expr
= expr_elem
['expr']
253 if expr
.has_key('enum'):
254 add_enum(expr
['enum'], expr
['data'])
255 elif expr
.has_key('union'):
257 add_enum('%sKind' % expr
['union'])
258 elif expr
.has_key('type'):
264 except QAPIExprError
, e
:
265 print >>sys
.stderr
, e
270 def parse_args(typeinfo
):
271 if isinstance(typeinfo
, basestring
):
272 struct
= find_struct(typeinfo
)
273 assert struct
!= None
274 typeinfo
= struct
['data']
276 for member
in typeinfo
:
278 argentry
= typeinfo
[member
]
281 if member
.startswith('*'):
284 if isinstance(argentry
, OrderedDict
):
286 yield (argname
, argentry
, optional
, structured
)
288 def de_camel_case(name
):
291 if ch
.isupper() and new_name
:
296 new_name
+= ch
.lower()
299 def camel_case(name
):
306 new_name
+= ch
.upper()
309 new_name
+= ch
.lower()
312 def c_var(name
, protect
=True):
313 # ANSI X3J11/88-090, 3.1.1
314 c89_words
= set(['auto', 'break', 'case', 'char', 'const', 'continue',
315 'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
316 'for', 'goto', 'if', 'int', 'long', 'register', 'return',
317 'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
318 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
319 # ISO/IEC 9899:1999, 6.4.1
320 c99_words
= set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
321 # ISO/IEC 9899:2011, 6.4.1
322 c11_words
= set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
323 '_Static_assert', '_Thread_local'])
324 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
326 gcc_words
= set(['asm', 'typeof'])
327 # C++ ISO/IEC 14882:2003 2.11
328 cpp_words
= set(['bool', 'catch', 'class', 'const_cast', 'delete',
329 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
330 'namespace', 'new', 'operator', 'private', 'protected',
331 'public', 'reinterpret_cast', 'static_cast', 'template',
332 'this', 'throw', 'true', 'try', 'typeid', 'typename',
333 'using', 'virtual', 'wchar_t',
334 # alternative representations
335 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
336 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
337 # namespace pollution:
338 polluted_words
= set(['unix', 'errno'])
339 if protect
and (name
in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words
):
341 return name
.replace('-', '_').lstrip("*")
343 def c_fun(name
, protect
=True):
344 return c_var(name
, protect
).replace('.', '_')
346 def c_list_type(name
):
347 return '%sList' % name
350 if type(name
) == list:
351 return c_list_type(name
[0])
358 def add_struct(definition
):
360 struct_types
.append(definition
)
362 def find_struct(name
):
364 for struct
in struct_types
:
365 if struct
['type'] == name
:
369 def add_union(definition
):
371 union_types
.append(definition
)
373 def find_union(name
):
375 for union
in union_types
:
376 if union
['union'] == name
:
380 def add_enum(name
, enum_values
= None):
382 enum_types
.append({"enum_name": name
, "enum_values": enum_values
})
386 for enum
in enum_types
:
387 if enum
['enum_name'] == name
:
392 return find_enum(name
) != None
399 elif (name
== 'int8' or name
== 'int16' or name
== 'int32' or
400 name
== 'int64' or name
== 'uint8' or name
== 'uint16' or
401 name
== 'uint32' or name
== 'uint64'):
407 elif name
== 'number':
409 elif type(name
) == list:
410 return '%s *' % c_list_type(name
[0])
413 elif name
== None or len(name
) == 0:
415 elif name
== name
.upper():
416 return '%sEvent *' % camel_case(name
)
420 def genindent(count
):
422 for i
in range(count
):
428 def push_indent(indent_amount
=4):
430 indent_level
+= indent_amount
432 def pop_indent(indent_amount
=4):
434 indent_level
-= indent_amount
436 def cgen(code
, **kwds
):
437 indent
= genindent(indent_level
)
438 lines
= code
.split('\n')
439 lines
= map(lambda x
: indent
+ x
, lines
)
440 return '\n'.join(lines
) % kwds
+ '\n'
442 def mcgen(code
, **kwds
):
443 return cgen('\n'.join(code
.split('\n')[1:-1]), **kwds
)
445 def basename(filename
):
446 return filename
.split("/")[-1]
448 def guardname(filename
):
449 guard
= basename(filename
).rsplit(".", 1)[0]
450 for substr
in [".", " ", "-"]:
451 guard
= guard
.replace(substr
, "_")
452 return guard
.upper() + '_H'
454 def guardstart(name
):
461 name
=guardname(name
))
466 #endif /* %(name)s */
469 name
=guardname(name
))