blob: 6a9aa24a6c0bff354c3b1f9c582ce3543c23e4d5 [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
Eric Blake10d4d992015-05-04 09:05:23 -060035# Whitelist of commands allowed to return a non-dictionary
36returns_whitelist = [
37 # From QMP:
38 'human-monitor-command',
39 'query-migrate-cache-size',
40 'query-tpm-models',
41 'query-tpm-types',
42 'ringbuf-read',
43
44 # From QGA:
45 'guest-file-open',
46 'guest-fsfreeze-freeze',
47 'guest-fsfreeze-freeze-list',
48 'guest-fsfreeze-status',
49 'guest-fsfreeze-thaw',
50 'guest-get-time',
51 'guest-set-vcpus',
52 'guest-sync',
53 'guest-sync-delimited',
54
55 # From qapi-schema-test:
56 'user_def_cmd3',
57]
58
Eric Blake4dc2e692015-05-04 09:05:17 -060059enum_types = []
60struct_types = []
61union_types = []
62events = []
63all_names = {}
64
Lluís Vilanovaa719a272014-05-07 20:46:15 +020065def error_path(parent):
66 res = ""
67 while parent:
68 res = ("In file included from %s:%d:\n" % (parent['file'],
69 parent['line'])) + res
70 parent = parent['parent']
71 return res
72
Markus Armbruster2caba362013-07-27 17:41:56 +020073class QAPISchemaError(Exception):
74 def __init__(self, schema, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020075 self.input_file = schema.input_file
Markus Armbruster2caba362013-07-27 17:41:56 +020076 self.msg = msg
Wenchao Xia515b9432014-03-04 18:44:33 -080077 self.col = 1
78 self.line = schema.line
79 for ch in schema.src[schema.line_pos:schema.pos]:
80 if ch == '\t':
Markus Armbruster2caba362013-07-27 17:41:56 +020081 self.col = (self.col + 7) % 8 + 1
82 else:
83 self.col += 1
Lluís Vilanovaa719a272014-05-07 20:46:15 +020084 self.info = schema.parent_info
Markus Armbruster2caba362013-07-27 17:41:56 +020085
86 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020087 return error_path(self.info) + \
88 "%s:%d:%d: %s" % (self.input_file, self.line, self.col, self.msg)
Markus Armbruster2caba362013-07-27 17:41:56 +020089
Wenchao Xiab86b05e2014-03-04 18:44:34 -080090class QAPIExprError(Exception):
91 def __init__(self, expr_info, msg):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020092 self.info = expr_info
Wenchao Xiab86b05e2014-03-04 18:44:34 -080093 self.msg = msg
94
95 def __str__(self):
Lluís Vilanovaa719a272014-05-07 20:46:15 +020096 return error_path(self.info['parent']) + \
97 "%s:%d: %s" % (self.info['file'], self.info['line'], self.msg)
Wenchao Xiab86b05e2014-03-04 18:44:34 -080098
Markus Armbrusterc7a3f252013-07-27 17:41:55 +020099class QAPISchema:
Michael Roth0f923be2011-07-19 14:50:39 -0500100
Benoît Canet24fd8482014-05-16 12:51:56 +0200101 def __init__(self, fp, input_relname=None, include_hist=[],
102 previously_included=[], parent_info=None):
103 """ include_hist is a stack used to detect inclusion cycles
104 previously_included is a global state used to avoid multiple
105 inclusions of the same file"""
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200106 input_fname = os.path.abspath(fp.name)
107 if input_relname is None:
108 input_relname = fp.name
109 self.input_dir = os.path.dirname(input_fname)
110 self.input_file = input_relname
111 self.include_hist = include_hist + [(input_relname, input_fname)]
Benoît Canet24fd8482014-05-16 12:51:56 +0200112 previously_included.append(input_fname)
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200113 self.parent_info = parent_info
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200114 self.src = fp.read()
115 if self.src == '' or self.src[-1] != '\n':
116 self.src += '\n'
117 self.cursor = 0
Wenchao Xia515b9432014-03-04 18:44:33 -0800118 self.line = 1
119 self.line_pos = 0
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200120 self.exprs = []
121 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -0500122
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200123 while self.tok != None:
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200124 expr_info = {'file': input_relname, 'line': self.line, 'parent': self.parent_info}
125 expr = self.get_expr(False)
126 if isinstance(expr, dict) and "include" in expr:
127 if len(expr) != 1:
128 raise QAPIExprError(expr_info, "Invalid 'include' directive")
129 include = expr["include"]
130 if not isinstance(include, str):
131 raise QAPIExprError(expr_info,
132 'Expected a file name (string), got: %s'
133 % include)
134 include_path = os.path.join(self.input_dir, include)
Stefan Hajnoczi7ac9a9d2014-08-27 12:08:51 +0100135 for elem in self.include_hist:
136 if include_path == elem[1]:
137 raise QAPIExprError(expr_info, "Inclusion loop for %s"
138 % include)
Benoît Canet24fd8482014-05-16 12:51:56 +0200139 # skip multiple include of the same file
140 if include_path in previously_included:
141 continue
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200142 try:
143 fobj = open(include_path, 'r')
Luiz Capitulino34788812014-05-20 13:50:19 -0400144 except IOError, e:
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200145 raise QAPIExprError(expr_info,
146 '%s: %s' % (e.strerror, include))
Benoît Canet24fd8482014-05-16 12:51:56 +0200147 exprs_include = QAPISchema(fobj, include, self.include_hist,
148 previously_included, expr_info)
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200149 self.exprs.extend(exprs_include.exprs)
150 else:
151 expr_elem = {'expr': expr,
152 'info': expr_info}
153 self.exprs.append(expr_elem)
Michael Roth0f923be2011-07-19 14:50:39 -0500154
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200155 def accept(self):
156 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200157 self.tok = self.src[self.cursor]
Markus Armbruster2caba362013-07-27 17:41:56 +0200158 self.pos = self.cursor
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200159 self.cursor += 1
160 self.val = None
Michael Roth0f923be2011-07-19 14:50:39 -0500161
Markus Armbrusterf1a145e2013-07-27 17:42:01 +0200162 if self.tok == '#':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200163 self.cursor = self.src.find('\n', self.cursor)
164 elif self.tok in ['{', '}', ':', ',', '[', ']']:
165 return
166 elif self.tok == "'":
167 string = ''
168 esc = False
169 while True:
170 ch = self.src[self.cursor]
171 self.cursor += 1
172 if ch == '\n':
Markus Armbruster2caba362013-07-27 17:41:56 +0200173 raise QAPISchemaError(self,
174 'Missing terminating "\'"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200175 if esc:
Eric Blakea7f59662015-05-04 09:05:36 -0600176 if ch == 'b':
177 string += '\b'
178 elif ch == 'f':
179 string += '\f'
180 elif ch == 'n':
181 string += '\n'
182 elif ch == 'r':
183 string += '\r'
184 elif ch == 't':
185 string += '\t'
186 elif ch == 'u':
187 value = 0
188 for x in range(0, 4):
189 ch = self.src[self.cursor]
190 self.cursor += 1
191 if ch not in "0123456789abcdefABCDEF":
192 raise QAPISchemaError(self,
193 '\\u escape needs 4 '
194 'hex digits')
195 value = (value << 4) + int(ch, 16)
196 # If Python 2 and 3 didn't disagree so much on
197 # how to handle Unicode, then we could allow
198 # Unicode string defaults. But most of QAPI is
199 # ASCII-only, so we aren't losing much for now.
200 if not value or value > 0x7f:
201 raise QAPISchemaError(self,
202 'For now, \\u escape '
203 'only supports non-zero '
204 'values up to \\u007f')
205 string += chr(value)
206 elif ch in "\\/'\"":
207 string += ch
208 else:
209 raise QAPISchemaError(self,
210 "Unknown escape \\%s" %ch)
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200211 esc = False
212 elif ch == "\\":
213 esc = True
214 elif ch == "'":
215 self.val = string
216 return
217 else:
218 string += ch
Fam Zhenge53188a2015-05-04 09:05:18 -0600219 elif self.tok in "tfn":
220 val = self.src[self.cursor - 1:]
221 if val.startswith("true"):
222 self.val = True
223 self.cursor += 3
224 return
225 elif val.startswith("false"):
226 self.val = False
227 self.cursor += 4
228 return
229 elif val.startswith("null"):
230 self.val = None
231 self.cursor += 3
232 return
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200233 elif self.tok == '\n':
234 if self.cursor == len(self.src):
235 self.tok = None
236 return
Wenchao Xia515b9432014-03-04 18:44:33 -0800237 self.line += 1
238 self.line_pos = self.cursor
Markus Armbruster9213aa52013-07-27 17:41:57 +0200239 elif not self.tok.isspace():
240 raise QAPISchemaError(self, 'Stray "%s"' % self.tok)
Michael Roth0f923be2011-07-19 14:50:39 -0500241
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200242 def get_members(self):
243 expr = OrderedDict()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200244 if self.tok == '}':
245 self.accept()
246 return expr
247 if self.tok != "'":
248 raise QAPISchemaError(self, 'Expected string or "}"')
249 while True:
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200250 key = self.val
251 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200252 if self.tok != ':':
253 raise QAPISchemaError(self, 'Expected ":"')
254 self.accept()
Wenchao Xia4b359912014-03-04 18:44:32 -0800255 if key in expr:
256 raise QAPISchemaError(self, 'Duplicate key "%s"' % key)
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200257 expr[key] = self.get_expr(True)
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200258 if self.tok == '}':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200259 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200260 return expr
261 if self.tok != ',':
262 raise QAPISchemaError(self, 'Expected "," or "}"')
263 self.accept()
264 if self.tok != "'":
265 raise QAPISchemaError(self, 'Expected string')
Michael Roth0f923be2011-07-19 14:50:39 -0500266
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200267 def get_values(self):
268 expr = []
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200269 if self.tok == ']':
270 self.accept()
271 return expr
Fam Zhenge53188a2015-05-04 09:05:18 -0600272 if not self.tok in "{['tfn":
273 raise QAPISchemaError(self, 'Expected "{", "[", "]", string, '
274 'boolean or "null"')
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200275 while True:
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200276 expr.append(self.get_expr(True))
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200277 if self.tok == ']':
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200278 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200279 return expr
280 if self.tok != ',':
281 raise QAPISchemaError(self, 'Expected "," or "]"')
282 self.accept()
Michael Roth0f923be2011-07-19 14:50:39 -0500283
Markus Armbruster5f3cd2b2013-07-27 17:41:59 +0200284 def get_expr(self, nested):
285 if self.tok != '{' and not nested:
286 raise QAPISchemaError(self, 'Expected "{"')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200287 if self.tok == '{':
288 self.accept()
289 expr = self.get_members()
290 elif self.tok == '[':
291 self.accept()
292 expr = self.get_values()
Fam Zhenge53188a2015-05-04 09:05:18 -0600293 elif self.tok in "'tfn":
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200294 expr = self.val
295 self.accept()
Markus Armbruster6974ccd2013-07-27 17:41:58 +0200296 else:
297 raise QAPISchemaError(self, 'Expected "{", "[" or string')
Markus Armbrusterc7a3f252013-07-27 17:41:55 +0200298 return expr
Kevin Wolfbd9927f2013-07-01 16:31:50 +0200299
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800300def find_base_fields(base):
301 base_struct_define = find_struct(base)
302 if not base_struct_define:
303 return None
304 return base_struct_define['data']
305
Eric Blake811d04f2015-05-04 09:05:10 -0600306# Return the qtype of an alternate branch, or None on error.
307def find_alternate_member_qtype(qapi_type):
Eric Blake44bd1272015-05-04 09:05:08 -0600308 if builtin_types.has_key(qapi_type):
309 return builtin_types[qapi_type]
310 elif find_struct(qapi_type):
311 return "QTYPE_QDICT"
312 elif find_enum(qapi_type):
313 return "QTYPE_QSTRING"
Eric Blake811d04f2015-05-04 09:05:10 -0600314 elif find_union(qapi_type):
315 return "QTYPE_QDICT"
Eric Blake44bd1272015-05-04 09:05:08 -0600316 return None
317
Wenchao Xiabceae762014-03-06 17:08:56 -0800318# Return the discriminator enum define if discriminator is specified as an
319# enum type, otherwise return None.
320def discriminator_find_enum_define(expr):
321 base = expr.get('base')
322 discriminator = expr.get('discriminator')
323
324 if not (discriminator and base):
325 return None
326
327 base_fields = find_base_fields(base)
328 if not base_fields:
329 return None
330
331 discriminator_type = base_fields.get(discriminator)
332 if not discriminator_type:
333 return None
334
335 return find_enum(discriminator_type)
336
Eric Blakec9e0a792015-05-04 09:05:22 -0600337valid_name = re.compile('^[a-zA-Z_][a-zA-Z0-9_.-]*$')
338def check_name(expr_info, source, name, allow_optional = False,
339 enum_member = False):
340 global valid_name
341 membername = name
342
343 if not isinstance(name, str):
344 raise QAPIExprError(expr_info,
345 "%s requires a string name" % source)
346 if name.startswith('*'):
347 membername = name[1:]
348 if not allow_optional:
349 raise QAPIExprError(expr_info,
350 "%s does not allow optional name '%s'"
351 % (source, name))
352 # Enum members can start with a digit, because the generated C
353 # code always prefixes it with the enum name
354 if enum_member:
355 membername = '_' + membername
356 if not valid_name.match(membername):
357 raise QAPIExprError(expr_info,
358 "%s uses invalid name '%s'" % (source, name))
359
Eric Blakedd883c62015-05-04 09:05:21 -0600360def check_type(expr_info, source, value, allow_array = False,
Eric Blake2cbf0992015-05-04 09:05:24 -0600361 allow_dict = False, allow_optional = False,
362 allow_star = False, allow_metas = []):
Eric Blakedd883c62015-05-04 09:05:21 -0600363 global all_names
364 orig_value = value
365
366 if value is None:
367 return
368
Eric Blake2cbf0992015-05-04 09:05:24 -0600369 if allow_star and value == '**':
Eric Blakedd883c62015-05-04 09:05:21 -0600370 return
371
372 # Check if array type for value is okay
373 if isinstance(value, list):
374 if not allow_array:
375 raise QAPIExprError(expr_info,
376 "%s cannot be an array" % source)
377 if len(value) != 1 or not isinstance(value[0], str):
378 raise QAPIExprError(expr_info,
379 "%s: array type must contain single type name"
380 % source)
381 value = value[0]
382 orig_value = "array of %s" %value
383
384 # Check if type name for value is okay
385 if isinstance(value, str):
Eric Blake2cbf0992015-05-04 09:05:24 -0600386 if value == '**':
387 raise QAPIExprError(expr_info,
388 "%s uses '**' but did not request 'gen':false"
389 % source)
Eric Blakedd883c62015-05-04 09:05:21 -0600390 if not value in all_names:
391 raise QAPIExprError(expr_info,
392 "%s uses unknown type '%s'"
393 % (source, orig_value))
394 if not all_names[value] in allow_metas:
395 raise QAPIExprError(expr_info,
396 "%s cannot use %s type '%s'"
397 % (source, all_names[value], orig_value))
398 return
399
400 # value is a dictionary, check that each member is okay
401 if not isinstance(value, OrderedDict):
402 raise QAPIExprError(expr_info,
403 "%s should be a dictionary" % source)
404 if not allow_dict:
405 raise QAPIExprError(expr_info,
406 "%s should be a type name" % source)
407 for (key, arg) in value.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600408 check_name(expr_info, "Member of %s" % source, key,
409 allow_optional=allow_optional)
Eric Blake6b5abc72015-05-04 09:05:33 -0600410 # Todo: allow dictionaries to represent default values of
411 # an optional argument.
Eric Blakedd883c62015-05-04 09:05:21 -0600412 check_type(expr_info, "Member '%s' of %s" % (key, source), arg,
Eric Blake6b5abc72015-05-04 09:05:33 -0600413 allow_array=True, allow_star=allow_star,
Eric Blakedd883c62015-05-04 09:05:21 -0600414 allow_metas=['built-in', 'union', 'alternate', 'struct',
Eric Blake6b5abc72015-05-04 09:05:33 -0600415 'enum'])
Eric Blakedd883c62015-05-04 09:05:21 -0600416
417def check_command(expr, expr_info):
418 name = expr['command']
Eric Blake2cbf0992015-05-04 09:05:24 -0600419 allow_star = expr.has_key('gen')
420
Eric Blakedd883c62015-05-04 09:05:21 -0600421 check_type(expr_info, "'data' for command '%s'" % name,
Eric Blakec9e0a792015-05-04 09:05:22 -0600422 expr.get('data'), allow_dict=True, allow_optional=True,
Eric Blake2cbf0992015-05-04 09:05:24 -0600423 allow_metas=['union', 'struct'], allow_star=allow_star)
Eric Blake10d4d992015-05-04 09:05:23 -0600424 returns_meta = ['union', 'struct']
425 if name in returns_whitelist:
426 returns_meta += ['built-in', 'alternate', 'enum']
Eric Blakedd883c62015-05-04 09:05:21 -0600427 check_type(expr_info, "'returns' for command '%s'" % name,
428 expr.get('returns'), allow_array=True, allow_dict=True,
Eric Blake2cbf0992015-05-04 09:05:24 -0600429 allow_optional=True, allow_metas=returns_meta,
430 allow_star=allow_star)
Eric Blakedd883c62015-05-04 09:05:21 -0600431
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200432def check_event(expr, expr_info):
Eric Blake4dc2e692015-05-04 09:05:17 -0600433 global events
434 name = expr['event']
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200435 params = expr.get('data')
Eric Blake4dc2e692015-05-04 09:05:17 -0600436
437 if name.upper() == 'MAX':
438 raise QAPIExprError(expr_info, "Event name 'MAX' cannot be created")
439 events.append(name)
Eric Blakedd883c62015-05-04 09:05:21 -0600440 check_type(expr_info, "'data' for event '%s'" % name,
Eric Blakec9e0a792015-05-04 09:05:22 -0600441 expr.get('data'), allow_dict=True, allow_optional=True,
Eric Blakedd883c62015-05-04 09:05:21 -0600442 allow_metas=['union', 'struct'])
Wenchao Xia21cd70d2014-06-18 08:43:28 +0200443
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800444def check_union(expr, expr_info):
445 name = expr['union']
446 base = expr.get('base')
447 discriminator = expr.get('discriminator')
448 members = expr['data']
Eric Blake44bd1272015-05-04 09:05:08 -0600449 values = { 'MAX': '(automatic)' }
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800450
Eric Blakefd41dd42015-05-04 09:05:25 -0600451 # If the object has a member 'base', its value must name a struct,
Eric Blakea8d4a2e2015-05-04 09:05:07 -0600452 # and there must be a discriminator.
453 if base is not None:
454 if discriminator is None:
455 raise QAPIExprError(expr_info,
456 "Union '%s' requires a discriminator to go "
457 "along with base" %name)
Eric Blake44bd1272015-05-04 09:05:08 -0600458
Eric Blake811d04f2015-05-04 09:05:10 -0600459 # Two types of unions, determined by discriminator.
Eric Blake811d04f2015-05-04 09:05:10 -0600460
461 # With no discriminator it is a simple union.
462 if discriminator is None:
Eric Blake44bd1272015-05-04 09:05:08 -0600463 enum_define = None
Eric Blakedd883c62015-05-04 09:05:21 -0600464 allow_metas=['built-in', 'union', 'alternate', 'struct', 'enum']
Eric Blake44bd1272015-05-04 09:05:08 -0600465 if base is not None:
466 raise QAPIExprError(expr_info,
Eric Blake811d04f2015-05-04 09:05:10 -0600467 "Simple union '%s' must not have a base"
Eric Blake44bd1272015-05-04 09:05:08 -0600468 % name)
469
470 # Else, it's a flat union.
471 else:
472 # The object must have a string member 'base'.
473 if not isinstance(base, str):
474 raise QAPIExprError(expr_info,
475 "Flat union '%s' must have a string base field"
476 % name)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800477 base_fields = find_base_fields(base)
478 if not base_fields:
479 raise QAPIExprError(expr_info,
Eric Blakefd41dd42015-05-04 09:05:25 -0600480 "Base '%s' is not a valid struct"
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800481 % base)
482
Eric Blakec9e0a792015-05-04 09:05:22 -0600483 # The value of member 'discriminator' must name a non-optional
Eric Blakefd41dd42015-05-04 09:05:25 -0600484 # member of the base struct.
Eric Blakec9e0a792015-05-04 09:05:22 -0600485 check_name(expr_info, "Discriminator of flat union '%s'" % name,
486 discriminator)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800487 discriminator_type = base_fields.get(discriminator)
488 if not discriminator_type:
489 raise QAPIExprError(expr_info,
490 "Discriminator '%s' is not a member of base "
Eric Blakefd41dd42015-05-04 09:05:25 -0600491 "struct '%s'"
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800492 % (discriminator, base))
493 enum_define = find_enum(discriminator_type)
Eric Blakedd883c62015-05-04 09:05:21 -0600494 allow_metas=['struct']
Wenchao Xia52230702014-03-04 18:44:39 -0800495 # Do not allow string discriminator
496 if not enum_define:
497 raise QAPIExprError(expr_info,
498 "Discriminator '%s' must be of enumeration "
499 "type" % discriminator)
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800500
501 # Check every branch
502 for (key, value) in members.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600503 check_name(expr_info, "Member of union '%s'" % name, key)
504
Eric Blakedd883c62015-05-04 09:05:21 -0600505 # Each value must name a known type; furthermore, in flat unions,
506 # branches must be a struct
507 check_type(expr_info, "Member '%s' of union '%s'" % (key, name),
508 value, allow_array=True, allow_metas=allow_metas)
509
Eric Blake44bd1272015-05-04 09:05:08 -0600510 # If the discriminator names an enum type, then all members
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800511 # of 'data' must also be members of the enum type.
Eric Blake44bd1272015-05-04 09:05:08 -0600512 if enum_define:
513 if not key in enum_define['enum_values']:
514 raise QAPIExprError(expr_info,
515 "Discriminator value '%s' is not found in "
516 "enum '%s'" %
517 (key, enum_define["enum_name"]))
518
519 # Otherwise, check for conflicts in the generated enum
520 else:
521 c_key = _generate_enum_string(key)
522 if c_key in values:
523 raise QAPIExprError(expr_info,
524 "Union '%s' member '%s' clashes with '%s'"
525 % (name, key, values[c_key]))
526 values[c_key] = key
527
Eric Blake811d04f2015-05-04 09:05:10 -0600528def check_alternate(expr, expr_info):
Eric Blakeab916fa2015-05-04 09:05:13 -0600529 name = expr['alternate']
Eric Blake811d04f2015-05-04 09:05:10 -0600530 members = expr['data']
531 values = { 'MAX': '(automatic)' }
532 types_seen = {}
Eric Blake44bd1272015-05-04 09:05:08 -0600533
Eric Blake811d04f2015-05-04 09:05:10 -0600534 # Check every branch
535 for (key, value) in members.items():
Eric Blakec9e0a792015-05-04 09:05:22 -0600536 check_name(expr_info, "Member of alternate '%s'" % name, key)
537
Eric Blake811d04f2015-05-04 09:05:10 -0600538 # Check for conflicts in the generated enum
539 c_key = _generate_enum_string(key)
540 if c_key in values:
541 raise QAPIExprError(expr_info,
Eric Blakeab916fa2015-05-04 09:05:13 -0600542 "Alternate '%s' member '%s' clashes with '%s'"
543 % (name, key, values[c_key]))
Eric Blake811d04f2015-05-04 09:05:10 -0600544 values[c_key] = key
545
546 # Ensure alternates have no type conflicts.
Eric Blakedd883c62015-05-04 09:05:21 -0600547 check_type(expr_info, "Member '%s' of alternate '%s'" % (key, name),
548 value,
549 allow_metas=['built-in', 'union', 'struct', 'enum'])
Eric Blake811d04f2015-05-04 09:05:10 -0600550 qtype = find_alternate_member_qtype(value)
Eric Blakedd883c62015-05-04 09:05:21 -0600551 assert qtype
Eric Blake811d04f2015-05-04 09:05:10 -0600552 if qtype in types_seen:
553 raise QAPIExprError(expr_info,
Eric Blakeab916fa2015-05-04 09:05:13 -0600554 "Alternate '%s' member '%s' can't "
Eric Blake811d04f2015-05-04 09:05:10 -0600555 "be distinguished from member '%s'"
556 % (name, key, types_seen[qtype]))
557 types_seen[qtype] = key
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800558
Eric Blakecf393592015-05-04 09:05:04 -0600559def check_enum(expr, expr_info):
560 name = expr['enum']
561 members = expr.get('data')
562 values = { 'MAX': '(automatic)' }
563
564 if not isinstance(members, list):
565 raise QAPIExprError(expr_info,
566 "Enum '%s' requires an array for 'data'" % name)
567 for member in members:
Eric Blakec9e0a792015-05-04 09:05:22 -0600568 check_name(expr_info, "Member of enum '%s'" %name, member,
569 enum_member=True)
Eric Blakecf393592015-05-04 09:05:04 -0600570 key = _generate_enum_string(member)
571 if key in values:
572 raise QAPIExprError(expr_info,
573 "Enum '%s' member '%s' clashes with '%s'"
574 % (name, member, values[key]))
575 values[key] = member
576
Eric Blakedd883c62015-05-04 09:05:21 -0600577def check_struct(expr, expr_info):
Eric Blakefd41dd42015-05-04 09:05:25 -0600578 name = expr['struct']
Eric Blakedd883c62015-05-04 09:05:21 -0600579 members = expr['data']
580
Eric Blakefd41dd42015-05-04 09:05:25 -0600581 check_type(expr_info, "'data' for struct '%s'" % name, members,
Eric Blakec9e0a792015-05-04 09:05:22 -0600582 allow_dict=True, allow_optional=True)
Eric Blakefd41dd42015-05-04 09:05:25 -0600583 check_type(expr_info, "'base' for struct '%s'" % name, expr.get('base'),
Eric Blakedd883c62015-05-04 09:05:21 -0600584 allow_metas=['struct'])
585
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800586def check_exprs(schema):
587 for expr_elem in schema.exprs:
588 expr = expr_elem['expr']
Eric Blakecf393592015-05-04 09:05:04 -0600589 info = expr_elem['info']
590
591 if expr.has_key('enum'):
592 check_enum(expr, info)
593 elif expr.has_key('union'):
Eric Blakeab916fa2015-05-04 09:05:13 -0600594 check_union(expr, info)
595 elif expr.has_key('alternate'):
596 check_alternate(expr, info)
Eric Blakefd41dd42015-05-04 09:05:25 -0600597 elif expr.has_key('struct'):
Eric Blakedd883c62015-05-04 09:05:21 -0600598 check_struct(expr, info)
599 elif expr.has_key('command'):
600 check_command(expr, info)
Eric Blakecf393592015-05-04 09:05:04 -0600601 elif expr.has_key('event'):
602 check_event(expr, info)
Eric Blakedd883c62015-05-04 09:05:21 -0600603 else:
604 assert False, 'unexpected meta type'
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800605
Eric Blake0545f6b2015-05-04 09:05:15 -0600606def check_keys(expr_elem, meta, required, optional=[]):
607 expr = expr_elem['expr']
608 info = expr_elem['info']
609 name = expr[meta]
610 if not isinstance(name, str):
611 raise QAPIExprError(info,
612 "'%s' key must have a string value" % meta)
613 required = required + [ meta ]
614 for (key, value) in expr.items():
615 if not key in required and not key in optional:
616 raise QAPIExprError(info,
617 "Unknown key '%s' in %s '%s'"
618 % (key, meta, name))
Eric Blake2cbf0992015-05-04 09:05:24 -0600619 if (key == 'gen' or key == 'success-response') and value != False:
620 raise QAPIExprError(info,
621 "'%s' of %s '%s' should only use false value"
622 % (key, meta, name))
Eric Blake0545f6b2015-05-04 09:05:15 -0600623 for key in required:
624 if not expr.has_key(key):
625 raise QAPIExprError(info,
626 "Key '%s' is missing from %s '%s'"
627 % (key, meta, name))
628
629
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200630def parse_schema(input_file):
Eric Blake4dc2e692015-05-04 09:05:17 -0600631 global all_names
632 exprs = []
633
Eric Blake268a1c52015-05-04 09:05:09 -0600634 # First pass: read entire file into memory
Markus Armbruster2caba362013-07-27 17:41:56 +0200635 try:
Lluís Vilanova33aaad52014-05-02 15:52:35 +0200636 schema = QAPISchema(open(input_file, "r"))
Lluís Vilanovaa719a272014-05-07 20:46:15 +0200637 except (QAPISchemaError, QAPIExprError), e:
Markus Armbruster2caba362013-07-27 17:41:56 +0200638 print >>sys.stderr, e
639 exit(1)
640
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800641 try:
Eric Blake0545f6b2015-05-04 09:05:15 -0600642 # Next pass: learn the types and check for valid expression keys. At
643 # this point, top-level 'include' has already been flattened.
Eric Blake4dc2e692015-05-04 09:05:17 -0600644 for builtin in builtin_types.keys():
645 all_names[builtin] = 'built-in'
Eric Blake268a1c52015-05-04 09:05:09 -0600646 for expr_elem in schema.exprs:
647 expr = expr_elem['expr']
Eric Blake4dc2e692015-05-04 09:05:17 -0600648 info = expr_elem['info']
Eric Blake268a1c52015-05-04 09:05:09 -0600649 if expr.has_key('enum'):
Eric Blake0545f6b2015-05-04 09:05:15 -0600650 check_keys(expr_elem, 'enum', ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600651 add_enum(expr['enum'], info, expr['data'])
Eric Blake268a1c52015-05-04 09:05:09 -0600652 elif expr.has_key('union'):
Eric Blake0545f6b2015-05-04 09:05:15 -0600653 check_keys(expr_elem, 'union', ['data'],
654 ['base', 'discriminator'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600655 add_union(expr, info)
Eric Blake0545f6b2015-05-04 09:05:15 -0600656 elif expr.has_key('alternate'):
657 check_keys(expr_elem, 'alternate', ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600658 add_name(expr['alternate'], info, 'alternate')
Eric Blakefd41dd42015-05-04 09:05:25 -0600659 elif expr.has_key('struct'):
660 check_keys(expr_elem, 'struct', ['data'], ['base'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600661 add_struct(expr, info)
Eric Blake0545f6b2015-05-04 09:05:15 -0600662 elif expr.has_key('command'):
663 check_keys(expr_elem, 'command', [],
664 ['data', 'returns', 'gen', 'success-response'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600665 add_name(expr['command'], info, 'command')
Eric Blake0545f6b2015-05-04 09:05:15 -0600666 elif expr.has_key('event'):
667 check_keys(expr_elem, 'event', [], ['data'])
Eric Blake4dc2e692015-05-04 09:05:17 -0600668 add_name(expr['event'], info, 'event')
Eric Blake0545f6b2015-05-04 09:05:15 -0600669 else:
670 raise QAPIExprError(expr_elem['info'],
671 "Expression is missing metatype")
Eric Blake268a1c52015-05-04 09:05:09 -0600672 exprs.append(expr)
673
674 # Try again for hidden UnionKind enum
675 for expr_elem in schema.exprs:
676 expr = expr_elem['expr']
677 if expr.has_key('union'):
678 if not discriminator_find_enum_define(expr):
Eric Blake4dc2e692015-05-04 09:05:17 -0600679 add_enum('%sKind' % expr['union'], expr_elem['info'],
680 implicit=True)
Eric Blakeab916fa2015-05-04 09:05:13 -0600681 elif expr.has_key('alternate'):
Eric Blake4dc2e692015-05-04 09:05:17 -0600682 add_enum('%sKind' % expr['alternate'], expr_elem['info'],
683 implicit=True)
Eric Blake268a1c52015-05-04 09:05:09 -0600684
685 # Final pass - validate that exprs make sense
Wenchao Xiab86b05e2014-03-04 18:44:34 -0800686 check_exprs(schema)
687 except QAPIExprError, e:
688 print >>sys.stderr, e
689 exit(1)
690
Michael Roth0f923be2011-07-19 14:50:39 -0500691 return exprs
692
693def parse_args(typeinfo):
Eric Blakefe2a9302015-05-04 09:05:02 -0600694 if isinstance(typeinfo, str):
Kevin Wolfb35284e2013-07-01 16:31:51 +0200695 struct = find_struct(typeinfo)
696 assert struct != None
697 typeinfo = struct['data']
698
Michael Roth0f923be2011-07-19 14:50:39 -0500699 for member in typeinfo:
700 argname = member
701 argentry = typeinfo[member]
702 optional = False
Michael Roth0f923be2011-07-19 14:50:39 -0500703 if member.startswith('*'):
704 argname = member[1:]
705 optional = True
Eric Blake6b5abc72015-05-04 09:05:33 -0600706 # Todo: allow argentry to be OrderedDict, for providing the
707 # value of an optional argument.
708 yield (argname, argentry, optional)
Michael Roth0f923be2011-07-19 14:50:39 -0500709
710def de_camel_case(name):
711 new_name = ''
712 for ch in name:
713 if ch.isupper() and new_name:
714 new_name += '_'
715 if ch == '-':
716 new_name += '_'
717 else:
718 new_name += ch.lower()
719 return new_name
720
721def camel_case(name):
722 new_name = ''
723 first = True
724 for ch in name:
725 if ch in ['_', '-']:
726 first = True
727 elif first:
728 new_name += ch.upper()
729 first = False
730 else:
731 new_name += ch.lower()
732 return new_name
733
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200734def c_var(name, protect=True):
Blue Swirl427a1a22012-07-30 15:46:55 +0000735 # ANSI X3J11/88-090, 3.1.1
736 c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
737 'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
738 'for', 'goto', 'if', 'int', 'long', 'register', 'return',
739 'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
740 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
741 # ISO/IEC 9899:1999, 6.4.1
742 c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
743 # ISO/IEC 9899:2011, 6.4.1
744 c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
745 '_Static_assert', '_Thread_local'])
746 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
747 # excluding _.*
748 gcc_words = set(['asm', 'typeof'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400749 # C++ ISO/IEC 14882:2003 2.11
750 cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete',
751 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
752 'namespace', 'new', 'operator', 'private', 'protected',
753 'public', 'reinterpret_cast', 'static_cast', 'template',
754 'this', 'throw', 'true', 'try', 'typeid', 'typename',
755 'using', 'virtual', 'wchar_t',
756 # alternative representations
757 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
758 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
Paolo Bonzini10577252012-09-19 16:31:07 +0200759 # namespace pollution:
Max Reitz8592a542013-12-20 19:28:18 +0100760 polluted_words = set(['unix', 'errno'])
Tomoki Sekiyama6f880092013-08-07 11:39:43 -0400761 if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words):
Blue Swirl427a1a22012-07-30 15:46:55 +0000762 return "q_" + name
Federico Simoncellic9da2282012-03-20 13:54:35 +0000763 return name.replace('-', '_').lstrip("*")
764
Paolo Bonzinieda50a62012-09-19 16:31:06 +0200765def c_fun(name, protect=True):
766 return c_var(name, protect).replace('.', '_')
Michael Roth0f923be2011-07-19 14:50:39 -0500767
768def c_list_type(name):
769 return '%sList' % name
770
771def type_name(name):
772 if type(name) == list:
773 return c_list_type(name[0])
774 return name
775
Eric Blakefd41dd42015-05-04 09:05:25 -0600776def add_name(name, info, meta, implicit = False):
Eric Blake4dc2e692015-05-04 09:05:17 -0600777 global all_names
Eric Blakefd41dd42015-05-04 09:05:25 -0600778 check_name(info, "'%s'" % meta, name)
Eric Blake4dc2e692015-05-04 09:05:17 -0600779 if name in all_names:
780 raise QAPIExprError(info,
781 "%s '%s' is already defined"
782 % (all_names[name], name))
783 if not implicit and name[-4:] == 'Kind':
784 raise QAPIExprError(info,
785 "%s '%s' should not end in 'Kind'"
786 % (meta, name))
787 all_names[name] = meta
Kevin Wolfb35284e2013-07-01 16:31:51 +0200788
Eric Blake4dc2e692015-05-04 09:05:17 -0600789def add_struct(definition, info):
Kevin Wolfb35284e2013-07-01 16:31:51 +0200790 global struct_types
Eric Blakefd41dd42015-05-04 09:05:25 -0600791 name = definition['struct']
792 add_name(name, info, 'struct')
Kevin Wolfb35284e2013-07-01 16:31:51 +0200793 struct_types.append(definition)
794
795def find_struct(name):
796 global struct_types
797 for struct in struct_types:
Eric Blakefd41dd42015-05-04 09:05:25 -0600798 if struct['struct'] == name:
Kevin Wolfb35284e2013-07-01 16:31:51 +0200799 return struct
800 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500801
Eric Blake4dc2e692015-05-04 09:05:17 -0600802def add_union(definition, info):
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200803 global union_types
Eric Blake4dc2e692015-05-04 09:05:17 -0600804 name = definition['union']
805 add_name(name, info, 'union')
Eric Blakeab916fa2015-05-04 09:05:13 -0600806 union_types.append(definition)
Kevin Wolfea66c6d2013-07-16 10:49:41 +0200807
808def find_union(name):
809 global union_types
810 for union in union_types:
811 if union['union'] == name:
812 return union
813 return None
814
Eric Blake4dc2e692015-05-04 09:05:17 -0600815def add_enum(name, info, enum_values = None, implicit = False):
Michael Roth0f923be2011-07-19 14:50:39 -0500816 global enum_types
Eric Blake4dc2e692015-05-04 09:05:17 -0600817 add_name(name, info, 'enum', implicit)
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800818 enum_types.append({"enum_name": name, "enum_values": enum_values})
819
820def find_enum(name):
821 global enum_types
822 for enum in enum_types:
823 if enum['enum_name'] == name:
824 return enum
825 return None
Michael Roth0f923be2011-07-19 14:50:39 -0500826
827def is_enum(name):
Wenchao Xiadad1fca2014-03-04 18:44:31 -0800828 return find_enum(name) != None
Michael Roth0f923be2011-07-19 14:50:39 -0500829
Amos Kong05dfb262014-06-10 19:25:53 +0800830eatspace = '\033EATSPACE.'
831
832# A special suffix is added in c_type() for pointer types, and it's
833# stripped in mcgen(). So please notice this when you check the return
834# value of c_type() outside mcgen().
Amos Kong0d14eeb2014-06-10 19:25:52 +0800835def c_type(name, is_param=False):
Michael Roth0f923be2011-07-19 14:50:39 -0500836 if name == 'str':
Amos Kong0d14eeb2014-06-10 19:25:52 +0800837 if is_param:
Amos Kong05dfb262014-06-10 19:25:53 +0800838 return 'const char *' + eatspace
839 return 'char *' + eatspace
840
Michael Roth0f923be2011-07-19 14:50:39 -0500841 elif name == 'int':
842 return 'int64_t'
Laszlo Ersekc46f18c2012-07-17 16:17:06 +0200843 elif (name == 'int8' or name == 'int16' or name == 'int32' or
844 name == 'int64' or name == 'uint8' or name == 'uint16' or
845 name == 'uint32' or name == 'uint64'):
846 return name + '_t'
Laszlo Ersek092705d2012-07-17 16:17:07 +0200847 elif name == 'size':
848 return 'uint64_t'
Michael Roth0f923be2011-07-19 14:50:39 -0500849 elif name == 'bool':
850 return 'bool'
851 elif name == 'number':
852 return 'double'
853 elif type(name) == list:
Amos Kong05dfb262014-06-10 19:25:53 +0800854 return '%s *%s' % (c_list_type(name[0]), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500855 elif is_enum(name):
856 return name
857 elif name == None or len(name) == 0:
858 return 'void'
Eric Blake4dc2e692015-05-04 09:05:17 -0600859 elif name in events:
Amos Kong05dfb262014-06-10 19:25:53 +0800860 return '%sEvent *%s' % (camel_case(name), eatspace)
Michael Roth0f923be2011-07-19 14:50:39 -0500861 else:
Amos Kong05dfb262014-06-10 19:25:53 +0800862 return '%s *%s' % (name, eatspace)
863
864def is_c_ptr(name):
865 suffix = "*" + eatspace
866 return c_type(name).endswith(suffix)
Michael Roth0f923be2011-07-19 14:50:39 -0500867
868def genindent(count):
869 ret = ""
870 for i in range(count):
871 ret += " "
872 return ret
873
874indent_level = 0
875
876def push_indent(indent_amount=4):
877 global indent_level
878 indent_level += indent_amount
879
880def pop_indent(indent_amount=4):
881 global indent_level
882 indent_level -= indent_amount
883
884def cgen(code, **kwds):
885 indent = genindent(indent_level)
886 lines = code.split('\n')
887 lines = map(lambda x: indent + x, lines)
888 return '\n'.join(lines) % kwds + '\n'
889
890def mcgen(code, **kwds):
Amos Kong05dfb262014-06-10 19:25:53 +0800891 raw = cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
892 return re.sub(re.escape(eatspace) + ' *', '', raw)
Michael Roth0f923be2011-07-19 14:50:39 -0500893
894def basename(filename):
895 return filename.split("/")[-1]
896
897def guardname(filename):
Michael Rothd8e1f212011-11-29 16:47:48 -0600898 guard = basename(filename).rsplit(".", 1)[0]
899 for substr in [".", " ", "-"]:
900 guard = guard.replace(substr, "_")
901 return guard.upper() + '_H'
Michael Rothc0afa9c2013-05-10 17:46:00 -0500902
903def guardstart(name):
904 return mcgen('''
905
906#ifndef %(name)s
907#define %(name)s
908
909''',
910 name=guardname(name))
911
912def guardend(name):
913 return mcgen('''
914
915#endif /* %(name)s */
916
917''',
918 name=guardname(name))
Wenchao Xia62996592014-03-04 18:44:35 -0800919
Wenchao Xia5d371f42014-03-04 18:44:40 -0800920# ENUMName -> ENUM_NAME, EnumName1 -> ENUM_NAME1
921# ENUM_NAME -> ENUM_NAME, ENUM_NAME1 -> ENUM_NAME1, ENUM_Name2 -> ENUM_NAME2
922# ENUM24_Name -> ENUM24_NAME
923def _generate_enum_string(value):
924 c_fun_str = c_fun(value, False)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800925 if value.isupper():
Wenchao Xia5d371f42014-03-04 18:44:40 -0800926 return c_fun_str
927
Wenchao Xia62996592014-03-04 18:44:35 -0800928 new_name = ''
Wenchao Xia5d371f42014-03-04 18:44:40 -0800929 l = len(c_fun_str)
930 for i in range(l):
931 c = c_fun_str[i]
932 # When c is upper and no "_" appears before, do more checks
933 if c.isupper() and (i > 0) and c_fun_str[i - 1] != "_":
934 # Case 1: next string is lower
935 # Case 2: previous string is digit
936 if (i < (l - 1) and c_fun_str[i + 1].islower()) or \
937 c_fun_str[i - 1].isdigit():
938 new_name += '_'
Wenchao Xia62996592014-03-04 18:44:35 -0800939 new_name += c
940 return new_name.lstrip('_').upper()
Wenchao Xiab0b58192014-03-04 18:44:36 -0800941
942def generate_enum_full_value(enum_name, enum_value):
Wenchao Xia5d371f42014-03-04 18:44:40 -0800943 abbrev_string = _generate_enum_string(enum_name)
944 value_string = _generate_enum_string(enum_value)
Wenchao Xiab0b58192014-03-04 18:44:36 -0800945 return "%s_%s" % (abbrev_string, value_string)