4 # Copyright IBM, Corp. 2011
5 # Copyright (c) 2013-2018 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.
25 #: Magic string that gets removed along with all space to its right.
26 EATSPACE
= '\033EATSPACE.'
27 POINTER_SUFFIX
= ' *' + EATSPACE
30 def camel_to_upper(value
: str) -> str:
32 Converts CamelCase to CAMEL_CASE.
37 EnumName1 -> ENUM_NAME1
38 ENUM_NAME -> ENUM_NAME
39 ENUM_NAME1 -> ENUM_NAME1
40 ENUM_Name2 -> ENUM_NAME2
41 ENUM24_Name -> ENUM24_NAME
43 c_fun_str
= c_name(value
, False)
48 length
= len(c_fun_str
)
49 for i
in range(length
):
51 # When char is upper case and no '_' appears before, do more checks
52 if char
.isupper() and (i
> 0) and c_fun_str
[i
- 1] != '_':
53 if i
< length
- 1 and c_fun_str
[i
+ 1].islower():
55 elif c_fun_str
[i
- 1].isdigit():
58 return new_name
.lstrip('_').upper()
61 def c_enum_const(type_name
: str,
63 prefix
: Optional
[str] = None) -> str:
65 Generate a C enumeration constant name.
67 :param type_name: The name of the enumeration.
68 :param const_name: The name of this constant.
69 :param prefix: Optional, prefix that overrides the type_name.
71 if prefix
is not None:
73 return camel_to_upper(type_name
) + '_' + c_name(const_name
, False).upper()
76 def c_name(name
: str, protect
: bool = True) -> str:
78 Map ``name`` to a valid C identifier.
80 Used for converting 'name' from a 'name':'type' qapi definition
81 into a generated struct member, as well as converting type names
82 into substrings of a generated C function name.
84 '__a.b_c' -> '__a_b_c', 'x-foo' -> 'x_foo'
85 protect=True: 'int' -> 'q_int'; protect=False: 'int' -> 'int'
87 :param name: The name to map.
88 :param protect: If true, avoid returning certain ticklish identifiers
89 (like C keywords) by prepending ``q_``.
91 # ANSI X3J11/88-090, 3.1.1
92 c89_words
= set(['auto', 'break', 'case', 'char', 'const', 'continue',
93 'default', 'do', 'double', 'else', 'enum', 'extern',
94 'float', 'for', 'goto', 'if', 'int', 'long', 'register',
95 'return', 'short', 'signed', 'sizeof', 'static',
96 'struct', 'switch', 'typedef', 'union', 'unsigned',
97 'void', 'volatile', 'while'])
98 # ISO/IEC 9899:1999, 6.4.1
99 c99_words
= set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
100 # ISO/IEC 9899:2011, 6.4.1
101 c11_words
= set(['_Alignas', '_Alignof', '_Atomic', '_Generic',
102 '_Noreturn', '_Static_assert', '_Thread_local'])
103 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
105 gcc_words
= set(['asm', 'typeof'])
106 # C++ ISO/IEC 14882:2003 2.11
107 cpp_words
= set(['bool', 'catch', 'class', 'const_cast', 'delete',
108 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
109 'namespace', 'new', 'operator', 'private', 'protected',
110 'public', 'reinterpret_cast', 'static_cast', 'template',
111 'this', 'throw', 'true', 'try', 'typeid', 'typename',
112 'using', 'virtual', 'wchar_t',
113 # alternative representations
114 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
115 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
116 # namespace pollution:
117 polluted_words
= set(['unix', 'errno', 'mips', 'sparc', 'i386'])
118 name
= re
.sub(r
'[^A-Za-z0-9_]', '_', name
)
119 if protect
and (name
in (c89_words | c99_words | c11_words | gcc_words
120 | cpp_words | polluted_words
)
121 or name
[0].isdigit()):
128 Indentation level management.
130 :param initial: Initial number of spaces, default 0.
132 def __init__(self
, initial
: int = 0) -> None:
133 self
._level
= initial
135 def __repr__(self
) -> str:
136 return "{}({:d})".format(type(self
).__name
__, self
._level
)
138 def __str__(self
) -> str:
139 """Return the current indentation as a string of spaces."""
140 return ' ' * self
._level
142 def increase(self
, amount
: int = 4) -> None:
143 """Increase the indentation level by ``amount``, default 4."""
144 self
._level
+= amount
146 def decrease(self
, amount
: int = 4) -> None:
147 """Decrease the indentation level by ``amount``, default 4."""
148 assert amount
<= self
._level
149 self
._level
-= amount
152 #: Global, current indent level for code generation.
153 indent
= Indentation()
156 def cgen(code
: str, **kwds
: object) -> str:
158 Generate ``code`` with ``kwds`` interpolated.
160 Obey `indent`, and strip `EATSPACE`.
165 raw
= re
.sub(r
'^(?!(#|$))', pfx
, raw
, flags
=re
.MULTILINE
)
166 return re
.sub(re
.escape(EATSPACE
) + r
' *', '', raw
)
169 def mcgen(code
: str, **kwds
: object) -> str:
172 return cgen(code
, **kwds
)
175 def c_fname(filename
: str) -> str:
176 return re
.sub(r
'[^A-Za-z0-9_]', '_', filename
)
179 def guardstart(name
: str) -> str:
185 name
=c_fname(name
).upper())
188 def guardend(name
: str) -> str:
191 #endif /* %(name)s */
193 name
=c_fname(name
).upper())
196 def gen_ifcond(ifcond
: Optional
[Union
[str, Dict
[str, Any
]]],
197 cond_fmt
: str, not_fmt
: str,
198 all_operator
: str, any_operator
: str) -> str:
200 def do_gen(ifcond
: Union
[str, Dict
[str, Any
]],
201 need_parens
: bool) -> str:
202 if isinstance(ifcond
, str):
203 return cond_fmt
% ifcond
204 assert isinstance(ifcond
, dict) and len(ifcond
) == 1
206 return not_fmt
% do_gen(ifcond
['not'], True)
208 gen
= gen_infix(all_operator
, ifcond
['all'])
210 gen
= gen_infix(any_operator
, ifcond
['any'])
212 gen
= '(' + gen
+ ')'
215 def gen_infix(operator
: str, operands
: Sequence
[Any
]) -> str:
216 return operator
.join([do_gen(o
, True) for o
in operands
])
220 return do_gen(ifcond
, False)
223 def cgen_ifcond(ifcond
: Optional
[Union
[str, Dict
[str, Any
]]]) -> str:
224 return gen_ifcond(ifcond
, 'defined(%s)', '!%s', ' && ', ' || ')
227 def docgen_ifcond(ifcond
: Optional
[Union
[str, Dict
[str, Any
]]]) -> str:
228 # TODO Doc generated for conditions needs polish
229 return gen_ifcond(ifcond
, '%s', 'not %s', ' and ', ' or ')
232 def gen_if(cond
: str) -> str:
240 def gen_endif(cond
: str) -> str:
244 #endif /* %(cond)s */
248 def must_match(pattern
: str, string
: str) -> Match
[str]:
249 match
= re
.match(pattern
, string
)
250 assert match
is not None