blob: 3ce8c3321b2deb4c9d9fe25112c5a6ab233aac40 [file] [log] [blame]
Michael Roth0f923be2011-07-19 14:50:39 -05001#
2# QAPI helper library
3#
4# Copyright IBM, Corp. 2011
Eric Blakefe2a9302015-05-04 09:05:02 -06005# Copyright (c) 2013-2015 Red Hat Inc.
Michael Roth0f923be2011-07-19 14:50:39 -05006#
7# Authors:
8# Anthony Liguori <aliguori@us.ibm.com>
Markus Armbrusterc7a3f252013-07-27 17:41:55 +02009# Markus Armbruster <armbru@redhat.com>
Michael Roth0f923be2011-07-19 14:50:39 -050010#
Markus Armbruster678e48a2014-03-01 08:40:34 +010011# This work is licensed under the terms of the GNU GPL, version 2.
12# See the COPYING file in the top-level directory.
Michael Roth0f923be2011-07-19 14:50:39 -050013
Lluís Vilanovaa719a272014-05-07 20:46:15 +020014import re
Michael Roth0f923be2011-07-19 14:50:39 -050015from ordereddict import OrderedDict
Lluís Vilanova33aaad52014-05-02 15:52:35 +020016import os
Markus Armbruster2caba362013-07-27 17:41:56 +020017import sys
Michael Roth0f923be2011-07-19 14:50:39 -050018
Eric Blakeb52c4b92015-05-04 09:05:00 -060019builtin_types = {
Kevin Wolf69dd62d2013-07-08 16:14:21 +020020 'str': 'QTYPE_QSTRING',
21 'int': 'QTYPE_QINT',
22 'number': 'QTYPE_QFLOAT',
23 'bool': 'QTYPE_QBOOL',
24 'int8': 'QTYPE_QINT',
25 'int16': 'QTYPE_QINT',
26 'int32': 'QTYPE_QINT',
27 'int64': 'QTYPE_QINT',
28 'uint8': 'QTYPE_QINT',
29 'uint16': 'QTYPE_QINT',
30 'uint32': 'QTYPE_QINT',
31 'uint64': 'QTYPE_QINT',
Eric Blakecb17f792015-05-04 09:05:01 -060032 'size': 'QTYPE_QINT',
Kevin Wolf69dd62d2013-07-08 16:14:21 +020033}
34
Lluís Vilanovaa719a272014-05-07 20:46:15 +020035def error_path(parent):
36 res = ""
37 while parent:
38 res = ("In file included from %s:%d:\n" % (parent['file'],
39 parent['line'])) + res
40 parent = parent['parent']
41 return res
42
Markus Armbruster2caba362013-07-27 17:41:56 +020043class QAPISchemaError(Exception):
44 def __init__(self, schema, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020045 self.input_file = schema.input_file
Markus Armbruster2caba362013-07-27 17:41:56 +020046 self.msg = msg
Wenchao Xia515b9432014-03-04 18:44:33 -080047 self.col = 1
48 self.line = schema.line
49 for ch in schema.src[schema.line_pos:schema.pos]:
50 if ch == '\t':
Markus Armbruster2caba362013-07-27 17:41:56 +020051 self.col = (self.col + 7) % 8 + 1
52 else:
53 self.col += 1
Lluís Vilanovaa719a272014-05-07 20:46:15 +020054 self.info = schema.parent_info
Markus Armbruster2caba362013-07-27 17:41:56 +020055
56 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020057 return error_path(self.info) + \
58 "%s:%d:%d: %s" % (self.input_file, self.line, self.col, self.msg)
Markus Armbruster2caba362013-07-27 17:41:56 +020059
Wenchao Xiab86b05e2014-03-04 18:44:34 -080060class QAPIExprError(Exception):
61 def __init__(self, expr_info, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020062 self.info = expr_info
Wenchao Xiab86b05e2014-03-04 18:44:34 -080063 self.msg = msg
64
65 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020066 return error_path(self.info['parent']) + \
67 "%s:%d: %s" % (self.info['file'], self.info['line'], self.msg)
Wenchao Xiab86b05e2014-03-04 18:44:34 -080068
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020069class QAPISchema:
Michael Roth0f923be2011-07-19 14:50:39 -050070
Benoît Canet24fd8482014-05-16 12:51:56 +020071 def __init__(self, fp, input_relname=None, include_hist=[],
72 previously_included=[], parent_info=None):
73 """ include_hist is a stack used to detect inclusion cycles
74 previously_included is a global state used to avoid multiple
75 inclusions of the same file"""
Lluís Vilanovaa719a272014-05-07 20:46:15 +020076 input_fname = os.path.abspath(fp.name)
77 if input_relname is None:
78 input_relname = fp.name
79 self.input_dir = os.path.dirname(input_fname)
80 self.input_file = input_relname
81 self.include_hist = include_hist + [(input_relname, input_fname)]
Benoît Canet24fd8482014-05-16 12:51:56 +020082 previously_included.append(input_fname)
Lluís Vilanovaa719a272014-05-07 20:46:15 +020083 self.parent_info = parent_info
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020084 self.src = fp.read()
85 if self.src == '' or self.src[-1] != '\n':
86 self.src += '\n'
87 self.cursor = 0
Wenchao Xia515b9432014-03-04 18:44:33 -080088 self.line = 1
89 self.line_pos = 0
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020090 self.exprs = []
91 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -050092
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020093 while self.tok != None:
Lluís Vilanovaa719a272014-05-07 20:46:15 +020094 expr_info = {'file': input_relname, 'line': self.line, 'parent': self.parent_info}
95 expr = self.get_expr(False)
96 if isinstance(expr, dict) and "include" in expr:
97 if len(expr) != 1:
98 raise QAPIExprError(expr_info, "Invalid 'include' directive")
99 include = expr["include"]
100 if not isinstance(include, str):
101 raise QAPIExprError(expr_info,
102 'Expected a file name (string), got: %s'
103 % include)
104 include_path = os.path.join(self.input_dir, include)
Stefan Hajnoczi7ac9a9d2014-08-27 12:08:51 +0100105 for elem in self.include_hist:
106 if include_path == elem[1]:
107 raise QAPIExprError(expr_info, "Inclusion loop for %s"
108 % include)
Benoît Canet24fd8482014-05-16 12:51:56 +0200109 # skip multiple include of the same file
110 if include_path in previously_included:
111 continue
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200112 try:
113 fobj = open(include_path, 'r')
Luiz Capitulino34788812014-05-20 13:50:19 -0400114 except IOError, e:
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200115 raise QAPIExprError(expr_info,
116 '%s: %s' % (e.strerror, include))
Benoît Canet24fd8482014-05-16 12:51:56 +0200117 exprs_include = QAPISchema(fobj, include, self.include_hist,
118 previously_included, expr_info)
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200119 self.exprs.extend(exprs_include.exprs)
120 else:
121 expr_elem = {'expr': expr,
122 'info': expr_info}
123 self.exprs.append(expr_elem)
Michael Roth0f923be2011-07-19 14:50:39 -0500124
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200125 def accept(self):
126 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200127 self.tok = self.src[self.cursor]
Markus Armbruster2caba362013-07-27 17:41:56 +0200128 self.pos = self.cursor
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200129 self.cursor += 1
130 self.val = None
Michael Roth0f923be2011-07-19 14:50:39 -0500131
Markus Armbrusterf1a145e2013-07-27 17:42:01 +0200132 if self.tok == '#':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200133 self.cursor = self.src.find('\n', self.cursor)
134 elif self.tok in ['{', '}', ':', ',', '[', ']']:
135 return
136 elif self.tok == "'":
137 string = ''
138 esc = False
139 while True:
140 ch = self.src[self.cursor]
141 self.cursor += 1
142 if ch == '\n':
Markus Armbruster2caba362013-07-27 17:41:56 +0200143 raise QAPISchemaError(self,
144 'Missing terminating "\'"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200145 if esc:
146 string += ch
147 esc = False
148 elif ch == "\\":
149 esc = True
150 elif ch == "'":
151 self.val = string
152 return
153 else:
154 string += ch
155 elif self.tok == '\n':
156 if self.cursor == len(self.src):
157 self.tok = None
158 return
Wenchao Xia515b9432014-03-04 18:44:33 -0800159 self.line += 1
160 self.line_pos = self.cursor
Markus Armbruster9213aa52013-07-27 17:41:57 +0200161 elif not self.tok.isspace():
162 raise QAPISchemaError(self, 'Stray "%s"' % self.tok)
Michael Roth0f923be2011-07-19 14:50:39 -0500163
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200164 def get_members(self):
165 expr = OrderedDict()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200166 if self.tok == '}':
167 self.accept()
168 return expr
169 if self.tok != "'":
170 raise QAPISchemaError(self, 'Expected string or "}"')
171 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200172 key = self.val
173 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200174 if self.tok != ':':
175 raise QAPISchemaError(self, 'Expected ":"')
176 self.accept()
Wenchao Xia4b359912014-03-04 18:44:32 -0800177 if key in expr:
178 raise QAPISchemaError(self, 'Duplicate key "%s"' % key)
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200179 expr[key] = self.get_expr(True)
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200180 if self.tok == '}':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200181 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200182 return expr
183 if self.tok != ',':
184 raise QAPISchemaError(self, 'Expected "," or "}"')
185 self.accept()
186 if self.tok != "'":
187 raise QAPISchemaError(self, 'Expected string')
Michael Roth0f923be2011-07-19 14:50:39 -0500188
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200189 def get_values(self):
190 expr = []
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200191 if self.tok == ']':
192 self.accept()
193 return expr
194 if not self.tok in [ '{', '[', "'" ]:
195 raise QAPISchemaError(self, 'Expected "{", "[", "]" or string')
196 while True:
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200197 expr.append(self.get_expr(True))
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200198 if self.tok == ']':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200199 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200200 return expr
201 if self.tok != ',':
202 raise QAPISchemaError(self, 'Expected "," or "]"')
203 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -0500204
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200205 def get_expr(self, nested):
206 if self.tok != '{' and not nested:
207 raise QAPISchemaError(self, 'Expected "{"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200208 if self.tok == '{':
209 self.accept()
210 expr = self.get_members()
211 elif self.tok == '[':
212 self.accept()
213 expr = self.get_values()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200214 elif self.tok == "'":
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200215 expr = self.val
216 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200217 else:
218 raise QAPISchemaError(self, 'Expected "{", "[" or string')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200219 return expr
Kevin Wolfbd9927f2013-07-01 16:31:50 +0200220
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800221def find_base_fields(base):
222 base_struct_define = find_struct(base)
223 if not base_struct_define:
224 return None
225 return base_struct_define['data']
226
Wenchao Xiabceae762014-03-06 17:08:56 -0800227# Return the discriminator enum define if discriminator is specified as an
228# enum type, otherwise return None.
229def discriminator_find_enum_define(expr):
230 base = expr.get('base')
231 discriminator = expr.get('discriminator')
232
233 if not (discriminator and base):
234 return None
235
236 base_fields = find_base_fields(base)
237 if not base_fields:
238 return None
239
240 discriminator_type = base_fields.get(discriminator)
241 if not discriminator_type:
242 return None
243
244 return find_enum(discriminator_type)
245
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200246def check_event(expr, expr_info):
247 params = expr.get('data')
248 if params:
249 for argname, argentry, optional, structured in parse_args(params):
250 if structured:
251 raise QAPIExprError(expr_info,
252 "Nested structure define in event is not "
Wenchao Xiad6f9c822014-06-24 16:33:59 -0700253 "supported, event '%s', argname '%s'"
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200254 % (expr['event'], argname))
255
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800256def check_union(expr, expr_info):
257 name = expr['union']
258 base = expr.get('base')
259 discriminator = expr.get('discriminator')
260 members = expr['data']
261
262 # If the object has a member 'base', its value must name a complex type.
263 if base:
264 base_fields = find_base_fields(base)
265 if not base_fields:
266 raise QAPIExprError(expr_info,
267 "Base '%s' is not a valid type"
268 % base)
269
270 # If the union object has no member 'discriminator', it's an
271 # ordinary union.
272 if not discriminator:
273 enum_define = None
274
275 # Else if the value of member 'discriminator' is {}, it's an
276 # anonymous union.
277 elif discriminator == {}:
278 enum_define = None
279
280 # Else, it's a flat union.
281 else:
282 # The object must have a member 'base'.
283 if not base:
284 raise QAPIExprError(expr_info,
285 "Flat union '%s' must have a base field"
286 % name)
287 # The value of member 'discriminator' must name a member of the
288 # base type.
289 discriminator_type = base_fields.get(discriminator)
290 if not discriminator_type:
291 raise QAPIExprError(expr_info,
292 "Discriminator '%s' is not a member of base "
293 "type '%s'"
294 % (discriminator, base))
295 enum_define = find_enum(discriminator_type)
Wenchao Xia52230702014-03-04 18:44:39 -0800296 # Do not allow string discriminator
297 if not enum_define:
298 raise QAPIExprError(expr_info,
299 "Discriminator '%s' must be of enumeration "
300 "type" % discriminator)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800301
302 # Check every branch
303 for (key, value) in members.items():
304 # If this named member's value names an enum type, then all members
305 # of 'data' must also be members of the enum type.
306 if enum_define and not key in enum_define['enum_values']:
307 raise QAPIExprError(expr_info,
308 "Discriminator value '%s' is not found in "
309 "enum '%s'" %
310 (key, enum_define["enum_name"]))
311 # Todo: add checking for values. Key is checked as above, value can be
312 # also checked here, but we need more functions to handle array case.
313
Eric Blakecf393592015-05-04 09:05:04 -0600314def check_enum(expr, expr_info):
315 name = expr['enum']
316 members = expr.get('data')
317 values = { 'MAX': '(automatic)' }
318
319 if not isinstance(members, list):
320 raise QAPIExprError(expr_info,
321 "Enum '%s' requires an array for 'data'" % name)
322 for member in members:
323 if not isinstance(member, str):
324 raise QAPIExprError(expr_info,
325 "Enum '%s' member '%s' is not a string"
326 % (name, member))
327 key = _generate_enum_string(member)
328 if key in values:
329 raise QAPIExprError(expr_info,
330 "Enum '%s' member '%s' clashes with '%s'"
331 % (name, member, values[key]))
332 values[key] = member
333
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800334def check_exprs(schema):
335 for expr_elem in schema.exprs:
336 expr = expr_elem['expr']
Eric Blakecf393592015-05-04 09:05:04 -0600337 info = expr_elem['info']
338
339 if expr.has_key('enum'):
340 check_enum(expr, info)
341 elif expr.has_key('union'):
342 check_union(expr, info)
343 elif expr.has_key('event'):
344 check_event(expr, info)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800345
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200346def parse_schema(input_file):
Markus Armbruster2caba362013-07-27 17:41:56 +0200347 try:
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200348 schema = QAPISchema(open(input_file, "r"))
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200349 except (QAPISchemaError, QAPIExprError), e:
Markus Armbruster2caba362013-07-27 17:41:56 +0200350 print >>sys.stderr, e
351 exit(1)
352
Kevin Wolfbd9927f2013-07-01 16:31:50 +0200353 exprs = []
354
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800355 for expr_elem in schema.exprs:
356 expr = expr_elem['expr']
Markus Armbruster28b8bd42013-07-27 17:42:00 +0200357 if expr.has_key('enum'):
Eric Blakecf393592015-05-04 09:05:04 -0600358 add_enum(expr['enum'], expr.get('data'))
Markus Armbruster28b8bd42013-07-27 17:42:00 +0200359 elif expr.has_key('union'):
360 add_union(expr)
Markus Armbruster28b8bd42013-07-27 17:42:00 +0200361 elif expr.has_key('type'):
362 add_struct(expr)
363 exprs.append(expr)
Michael Roth0f923be2011-07-19 14:50:39 -0500364
Wenchao Xiabceae762014-03-06 17:08:56 -0800365 # Try again for hidden UnionKind enum
366 for expr_elem in schema.exprs:
367 expr = expr_elem['expr']
368 if expr.has_key('union'):
369 if not discriminator_find_enum_define(expr):
370 add_enum('%sKind' % expr['union'])
371
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800372 try:
373 check_exprs(schema)
374 except QAPIExprError, e:
375 print >>sys.stderr, e
376 exit(1)
377
Michael Roth0f923be2011-07-19 14:50:39 -0500378 return exprs
379
380def parse_args(typeinfo):
Eric Blakefe2a9302015-05-04 09:05:02 -0600381 if isinstance(typeinfo, str):
Kevin Wolfb35284e2013-07-01 16:31:51 +0200382 struct = find_struct(typeinfo)
383 assert struct != None
384 typeinfo = struct['data']
385
Michael Roth0f923be2011-07-19 14:50:39 -0500386 for member in typeinfo:
387 argname = member
388 argentry = typeinfo[member]
389 optional = False
390 structured = False
391 if member.startswith('*'):
392 argname = member[1:]
393 optional = True
394 if isinstance(argentry, OrderedDict):
395 structured = True
396 yield (argname, argentry, optional, structured)
397
398def de_camel_case(name):
399 new_name = ''
400 for ch in name:
401 if ch.isupper() and new_name:
402 new_name += '_'
403 if ch == '-':
404 new_name += '_'
405 else:
406 new_name += ch.lower()
407 return new_name
408
409def camel_case(name):
410 new_name = ''
411 first = True
412 for ch in name:
413 if ch in ['_', '-']:
414 first = True
415 elif first:
416 new_name += ch.upper()
417 first = False
418 else:
419 new_name += ch.lower()
420 return new_name
421
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200422def c_var(name, protect=True):
Blue Swirl427a1a22012-07-30 15:46:55 +0000423 # ANSI X3J11/88-090, 3.1.1
424 c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
425 'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
426 'for', 'goto', 'if', 'int', 'long', 'register', 'return',
427 'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
428 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
429 # ISO/IEC 9899:1999, 6.4.1
430 c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
431 # ISO/IEC 9899:2011, 6.4.1
432 c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
433 '_Static_assert', '_Thread_local'])
434 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
435 # excluding _.*
436 gcc_words = set(['asm', 'typeof'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400437 # C++ ISO/IEC 14882:2003 2.11
438 cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete',
439 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
440 'namespace', 'new', 'operator', 'private', 'protected',
441 'public', 'reinterpret_cast', 'static_cast', 'template',
442 'this', 'throw', 'true', 'try', 'typeid', 'typename',
443 'using', 'virtual', 'wchar_t',
444 # alternative representations
445 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
446 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
Paolo Bonzini10577252012-09-19 16:31:07 +0200447 # namespace pollution:
Max Reitz8592a542013-12-20 19:28:18 +0100448 polluted_words = set(['unix', 'errno'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400449 if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words):
Blue Swirl427a1a22012-07-30 15:46:55 +0000450 return "q_" + name
Federico Simoncellic9da2282012-03-20 13:54:35 +0000451 return name.replace('-', '_').lstrip("*")
452
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200453def c_fun(name, protect=True):
454 return c_var(name, protect).replace('.', '_')
Michael Roth0f923be2011-07-19 14:50:39 -0500455
456def c_list_type(name):
457 return '%sList' % name
458
459def type_name(name):
460 if type(name) == list:
461 return c_list_type(name[0])
462 return name
463
464enum_types = []
Kevin Wolfb35284e2013-07-01 16:31:51 +0200465struct_types = []
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200466union_types = []
Kevin Wolfb35284e2013-07-01 16:31:51 +0200467
468def add_struct(definition):
469 global struct_types
470 struct_types.append(definition)
471
472def find_struct(name):
473 global struct_types
474 for struct in struct_types:
475 if struct['type'] == name:
476 return struct
477 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500478
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200479def add_union(definition):
480 global union_types
481 union_types.append(definition)
482
483def find_union(name):
484 global union_types
485 for union in union_types:
486 if union['union'] == name:
487 return union
488 return None
489
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800490def add_enum(name, enum_values = None):
Michael Roth0f923be2011-07-19 14:50:39 -0500491 global enum_types
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800492 enum_types.append({"enum_name": name, "enum_values": enum_values})
493
494def find_enum(name):
495 global enum_types
496 for enum in enum_types:
497 if enum['enum_name'] == name:
498 return enum
499 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500500
501def is_enum(name):
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800502 return find_enum(name) != None
Michael Roth0f923be2011-07-19 14:50:39 -0500503
Amos Kong05dfb262014-06-10 19:25:53 +0800504eatspace = '\033EATSPACE.'
505
506# A special suffix is added in c_type() for pointer types, and it's
507# stripped in mcgen(). So please notice this when you check the return
508# value of c_type() outside mcgen().
Amos Kong0d14eeb2014-06-10 19:25:52 +0800509def c_type(name, is_param=False):
Michael Roth0f923be2011-07-19 14:50:39 -0500510 if name == 'str':
Amos Kong0d14eeb2014-06-10 19:25:52 +0800511 if is_param:
Amos Kong05dfb262014-06-10 19:25:53 +0800512 return 'const char *' + eatspace
513 return 'char *' + eatspace
514
Michael Roth0f923be2011-07-19 14:50:39 -0500515 elif name == 'int':
516 return 'int64_t'
Laszlo Ersekc46f18c2012-07-17 16:17:06 +0200517 elif (name == 'int8' or name == 'int16' or name == 'int32' or
518 name == 'int64' or name == 'uint8' or name == 'uint16' or
519 name == 'uint32' or name == 'uint64'):
520 return name + '_t'
Laszlo Ersek092705d2012-07-17 16:17:07 +0200521 elif name == 'size':
522 return 'uint64_t'
Michael Roth0f923be2011-07-19 14:50:39 -0500523 elif name == 'bool':
524 return 'bool'
525 elif name == 'number':
526 return 'double'
527 elif type(name) == list:
Amos Kong05dfb262014-06-10 19:25:53 +0800528 return '%s *%s' % (c_list_type(name[0]), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500529 elif is_enum(name):
530 return name
531 elif name == None or len(name) == 0:
532 return 'void'
533 elif name == name.upper():
Amos Kong05dfb262014-06-10 19:25:53 +0800534 return '%sEvent *%s' % (camel_case(name), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500535 else:
Amos Kong05dfb262014-06-10 19:25:53 +0800536 return '%s *%s' % (name, eatspace)
537
538def is_c_ptr(name):
539 suffix = "*" + eatspace
540 return c_type(name).endswith(suffix)
Michael Roth0f923be2011-07-19 14:50:39 -0500541
542def genindent(count):
543 ret = ""
544 for i in range(count):
545 ret += " "
546 return ret
547
548indent_level = 0
549
550def push_indent(indent_amount=4):
551 global indent_level
552 indent_level += indent_amount
553
554def pop_indent(indent_amount=4):
555 global indent_level
556 indent_level -= indent_amount
557
558def cgen(code, **kwds):
559 indent = genindent(indent_level)
560 lines = code.split('\n')
561 lines = map(lambda x: indent + x, lines)
562 return '\n'.join(lines) % kwds + '\n'
563
564def mcgen(code, **kwds):
Amos Kong05dfb262014-06-10 19:25:53 +0800565 raw = cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
566 return re.sub(re.escape(eatspace) + ' *', '', raw)
Michael Roth0f923be2011-07-19 14:50:39 -0500567
568def basename(filename):
569 return filename.split("/")[-1]
570
571def guardname(filename):
Michael Rothd8e1f212011-11-29 16:47:48 -0600572 guard = basename(filename).rsplit(".", 1)[0]
573 for substr in [".", " ", "-"]:
574 guard = guard.replace(substr, "_")
575 return guard.upper() + '_H'
Michael Rothc0afa9c2013-05-10 17:46:00 -0500576
577def guardstart(name):
578 return mcgen('''
579
580#ifndef %(name)s
581#define %(name)s
582
583''',
584 name=guardname(name))
585
586def guardend(name):
587 return mcgen('''
588
589#endif /* %(name)s */
590
591''',
592 name=guardname(name))
Wenchao Xia62996592014-03-04 18:44:35 -0800593
Wenchao Xia5d371f42014-03-04 18:44:40 -0800594# ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1
595# ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2
596# ENUM24_Name -> ENUM24_NAME
597def _generate_enum_string(value):
598 c_fun_str = c_fun(value, False)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800599 if value.isupper():
Wenchao Xia5d371f42014-03-04 18:44:40 -0800600 return c_fun_str
601
Wenchao Xia62996592014-03-04 18:44:35 -0800602 new_name = ''
Wenchao Xia5d371f42014-03-04 18:44:40 -0800603 l = len(c_fun_str)
604 for i in range(l):
605 c = c_fun_str[i]
606 # When c is upper and no "_" appears before, do more checks
607 if c.isupper() and (i > 0) and c_fun_str[i - 1] != "_":
608 # Case 1: next string is lower
609 # Case 2: previous string is digit
610 if (i < (l - 1) and c_fun_str[i + 1].islower()) or \
611 c_fun_str[i - 1].isdigit():
612 new_name += '_'
Wenchao Xia62996592014-03-04 18:44:35 -0800613 new_name += c
614 return new_name.lstrip('_').upper()
Wenchao Xiab0b58192014-03-04 18:44:36 -0800615
616def generate_enum_full_value(enum_name, enum_value):
Wenchao Xia5d371f42014-03-04 18:44:40 -0800617 abbrev_string = _generate_enum_string(enum_name)
618 value_string = _generate_enum_string(enum_value)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800619 return "%s_%s" % (abbrev_string, value_string)