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.
15 from typing
import Match
, Optional
, Sequence
18 #: Magic string that gets removed along with all space to its right.
19 EATSPACE
= '\033EATSPACE.'
20 POINTER_SUFFIX
= ' *' + EATSPACE
23 def camel_to_upper(value
: str) -> str:
25 Converts CamelCase to CAMEL_CASE.
30 EnumName1 -> ENUM_NAME1
31 ENUM_NAME -> ENUM_NAME
32 ENUM_NAME1 -> ENUM_NAME1
33 ENUM_Name2 -> ENUM_NAME2
34 ENUM24_Name -> ENUM24_NAME
36 c_fun_str
= c_name(value
, False)
41 length
= len(c_fun_str
)
42 for i
in range(length
):
44 # When char is upper case and no '_' appears before, do more checks
45 if char
.isupper() and (i
> 0) and c_fun_str
[i
- 1] != '_':
46 if i
< length
- 1 and c_fun_str
[i
+ 1].islower():
48 elif c_fun_str
[i
- 1].isdigit():
51 return new_name
.lstrip('_').upper()
54 def c_enum_const(type_name
: str,
56 prefix
: Optional
[str] = None) -> str:
58 Generate a C enumeration constant name.
60 :param type_name: The name of the enumeration.
61 :param const_name: The name of this constant.
62 :param prefix: Optional, prefix that overrides the type_name.
64 if prefix
is not None:
66 return camel_to_upper(type_name
) + '_' + c_name(const_name
, False).upper()
69 def c_name(name
: str, protect
: bool = True) -> str:
71 Map ``name`` to a valid C identifier.
73 Used for converting 'name' from a 'name':'type' qapi definition
74 into a generated struct member, as well as converting type names
75 into substrings of a generated C function name.
77 '__a.b_c' -> '__a_b_c', 'x-foo' -> 'x_foo'
78 protect=True: 'int' -> 'q_int'; protect=False: 'int' -> 'int'
80 :param name: The name to map.
81 :param protect: If true, avoid returning certain ticklish identifiers
82 (like C keywords) by prepending ``q_``.
84 # ANSI X3J11/88-090, 3.1.1
85 c89_words
= set(['auto', 'break', 'case', 'char', 'const', 'continue',
86 'default', 'do', 'double', 'else', 'enum', 'extern',
87 'float', 'for', 'goto', 'if', 'int', 'long', 'register',
88 'return', 'short', 'signed', 'sizeof', 'static',
89 'struct', 'switch', 'typedef', 'union', 'unsigned',
90 'void', 'volatile', 'while'])
91 # ISO/IEC 9899:1999, 6.4.1
92 c99_words
= set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
93 # ISO/IEC 9899:2011, 6.4.1
94 c11_words
= set(['_Alignas', '_Alignof', '_Atomic', '_Generic',
95 '_Noreturn', '_Static_assert', '_Thread_local'])
96 # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
98 gcc_words
= set(['asm', 'typeof'])
99 # C++ ISO/IEC 14882:2003 2.11
100 cpp_words
= set(['bool', 'catch', 'class', 'const_cast', 'delete',
101 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
102 'namespace', 'new', 'operator', 'private', 'protected',
103 'public', 'reinterpret_cast', 'static_cast', 'template',
104 'this', 'throw', 'true', 'try', 'typeid', 'typename',
105 'using', 'virtual', 'wchar_t',
106 # alternative representations
107 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
108 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
109 # namespace pollution:
110 polluted_words
= set(['unix', 'errno', 'mips', 'sparc', 'i386'])
111 name
= re
.sub(r
'[^A-Za-z0-9_]', '_', name
)
112 if protect
and (name
in (c89_words | c99_words | c11_words | gcc_words
113 | cpp_words | polluted_words
)
114 or name
[0].isdigit()):
121 Indentation level management.
123 :param initial: Initial number of spaces, default 0.
125 def __init__(self
, initial
: int = 0) -> None:
126 self
._level
= initial
128 def __int__(self
) -> int:
131 def __repr__(self
) -> str:
132 return "{}({:d})".format(type(self
).__name
__, self
._level
)
134 def __str__(self
) -> str:
135 """Return the current indentation as a string of spaces."""
136 return ' ' * self
._level
138 def __bool__(self
) -> bool:
139 """True when there is a non-zero indentation."""
140 return bool(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 if self
._level
< amount
:
149 raise ArithmeticError(
150 f
"Can't remove {amount:d} spaces from {self!r}")
151 self
._level
-= amount
154 #: Global, current indent level for code generation.
155 indent
= Indentation()
158 def cgen(code
: str, **kwds
: object) -> str:
160 Generate ``code`` with ``kwds`` interpolated.
162 Obey `indent`, and strip `EATSPACE`.
166 raw
= re
.sub(r
'^(?!(#|$))', str(indent
), raw
, flags
=re
.MULTILINE
)
167 return re
.sub(re
.escape(EATSPACE
) + r
' *', '', raw
)
170 def mcgen(code
: str, **kwds
: object) -> str:
173 return cgen(code
, **kwds
)
176 def c_fname(filename
: str) -> str:
177 return re
.sub(r
'[^A-Za-z0-9_]', '_', filename
)
180 def guardstart(name
: str) -> str:
186 name
=c_fname(name
).upper())
189 def guardend(name
: str) -> str:
192 #endif /* %(name)s */
194 name
=c_fname(name
).upper())
197 def gen_if(ifcond
: Sequence
[str]) -> str:
206 def gen_endif(ifcond
: Sequence
[str]) -> str:
208 for ifc
in reversed(ifcond
):
210 #endif /* %(cond)s */
215 def must_match(pattern
: str, string
: str) -> Match
[str]:
216 match
= re
.match(pattern
, string
)
217 assert match
is not None