diff mbox

[RFC,02/19] qapi: Fix C identifiers generated for names containing '.'

Message ID 552315E7.3050308@redhat.com
State New
Headers show

Commit Message

Eric Blake April 6, 2015, 11:25 p.m. UTC 
On 04/02/2015 11:28 AM, Markus Armbruster wrote:
> c_fun() maps '.' to '_', c_var() doesn't.  Nothing prevents '.' in
> QAPI names that get passed to c_var().
> 
> Which QAPI names get passed to c_fun(), to c_var(), or to both is not
> obvious.  Names of command parameters and struct type members get
> passed to c_var().
> 
> c_var() strips a leading '*', but this cannot happen.  c_fun()
> doesn't.
> 
> Fix c_var() to work exactly like c_fun().
> 
> Perhaps they should be replaced by a single mapping function.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  scripts/qapi.py | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)

In order to test if we caught everything, I tried adding:


 [{'enum_name': 'EnumOne', 'enum_values': ['value1', 'value2', 'value3']},
+ {'enum_name': '__org.qemu_Enum', 'enum_values': ['__org.qemu_value']},
  {'enum_name': 'UserDefAlternateKind', 'enum_values': None},
- {'enum_name': 'UserDefNativeListUnionKind', 'enum_values': None}]
+ {'enum_name': 'UserDefNativeListUnionKind', 'enum_values': None},
+ {'enum_name': '__org.qemu_UnionKind', 'enum_values': None}]
 [OrderedDict([('struct', 'NestedEnumsOne'), ('data',
OrderedDict([('enum1', 'EnumOne'), ('*enum2', 'EnumOne'), ('enum3',
'EnumOne'), ('*enum4', 'EnumOne')]))]),
  OrderedDict([('struct', 'UserDefZero'), ('data',
OrderedDict([('integer', 'int')]))]),
  OrderedDict([('struct', 'UserDefOne'), ('base', 'UserDefZero'),
('data', OrderedDict([('string', 'str'), ('*enum1', 'EnumOne')]))]),
@@ -37,4 +44,5 @@
  OrderedDict([('struct', 'UserDefC'), ('data', OrderedDict([('string1',
'str'), ('string2', 'str')]))]),
  OrderedDict([('struct', 'UserDefUnionBase'), ('data',
OrderedDict([('string', 'str'), ('enum1', 'EnumOne')]))]),
  OrderedDict([('struct', 'UserDefOptions'), ('data',
OrderedDict([('*i64', ['int']), ('*u64', ['uint64']), ('*u16',
['uint16']), ('*i64x', 'int'), ('*u64x', 'uint64')]))]),
- OrderedDict([('struct', 'EventStructOne'), ('data',
OrderedDict([('struct1', 'UserDefOne'), ('string', 'str'), ('*enum2',
'EnumOne')]))])]
+ OrderedDict([('struct', 'EventStructOne'), ('data',
OrderedDict([('struct1', 'UserDefOne'), ('string', 'str'), ('*enum2',
'EnumOne')]))]),
+ OrderedDict([('struct', '__org.qemu_Struct'), ('data',
OrderedDict([('__org.qemu_member', 'str')]))])]


but that leads to a number of compilation errors, even with your patch
installed, starting with:

In file included from tests/test-qmp-output-visitor.c:17:0:
tests/test-qapi-types.h:388:21: error: expected identifier or ‘(’ before
‘.’ token
 typedef struct __org.qemu_Struct __org.qemu_Struct;

I'm still playing with it to see if I can find ALL of the culprit spots.

Comments

Eric Blake April 11, 2015, 6:36 p.m. UTC | #1 
On 04/06/2015 05:25 PM, Eric Blake wrote:
> On 04/02/2015 11:28 AM, Markus Armbruster wrote:
>> c_fun() maps '.' to '_', c_var() doesn't.  Nothing prevents '.' in
>> QAPI names that get passed to c_var().
>>
>> Which QAPI names get passed to c_fun(), to c_var(), or to both is not
>> obvious.  Names of command parameters and struct type members get
>> passed to c_var().
>>
>> c_var() strips a leading '*', but this cannot happen.  c_fun()
>> doesn't.
>>
>> Fix c_var() to work exactly like c_fun().
>>
>> Perhaps they should be replaced by a single mapping function.
>>
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>  scripts/qapi.py | 6 ++++--
>>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> In order to test if we caught everything, I tried adding:
> 

I took over this one patch, and turned it into a series:

https://lists.gnu.org/archive/html/qemu-devel/2015-04/msg01300.html
diff mbox

Patch

diff --git a/tests/qapi-schema/qapi-schema-test.json
b/tests/qapi-schema/qapi-schema-test.json
index 8193dc1..757250a 100644
--- a/tests/qapi-schema/qapi-schema-test.json
+++ b/tests/qapi-schema/qapi-schema-test.json
@@ -107,3 +107,11 @@ 
   'data': { '*a': 'int', '*b': 'UserDefOne', 'c': 'str' } }
 { 'event': 'EVENT_D',
   'data': { 'a' : 'EventStructOne', 'b' : 'str', '*c': 'str', '*enum3':
'EnumOne' } }
+
+# test that we correctly compile downstream extensions
+{ 'struct': '__org.qemu_Struct', 'data': { '__org.qemu_member': 'str' } }
+{ 'enum': '__org.qemu_Enum', 'data': [ '__org.qemu_value' ] }
+{ 'event': '__ORG.QEMU_EVENT', 'data': '__org.qemu_Struct' }
+{ 'command': '__org.qemu_command',
+  'data': { 'a': '__org.qemu_Enum', 'b': '__org.qemu_Struct' } }
+{ 'union': '__org.qemu_Union', 'data': { '__org.qemu_branch': 'str' } }
diff --git a/tests/qapi-schema/qapi-schema-test.out
b/tests/qapi-schema/qapi-schema-test.out
index 93c4963..2ba7730 100644
--- a/tests/qapi-schema/qapi-schema-test.out
+++ b/tests/qapi-schema/qapi-schema-test.out
@@ -22,10 +22,17 @@ 
  OrderedDict([('event', 'EVENT_A')]),
  OrderedDict([('event', 'EVENT_B'), ('data', OrderedDict())]),
  OrderedDict([('event', 'EVENT_C'), ('data', OrderedDict([('*a',
'int'), ('*b', 'UserDefOne'), ('c', 'str')]))]),
- OrderedDict([('event', 'EVENT_D'), ('data', OrderedDict([('a',
'EventStructOne'), ('b', 'str'), ('*c', 'str'), ('*enum3', 'EnumOne')]))])]
+ OrderedDict([('event', 'EVENT_D'), ('data', OrderedDict([('a',
'EventStructOne'), ('b', 'str'), ('*c', 'str'), ('*enum3', 'EnumOne')]))]),
+ OrderedDict([('struct', '__org.qemu_Struct'), ('data',
OrderedDict([('__org.qemu_member', 'str')]))]),
+ OrderedDict([('enum', '__org.qemu_Enum'), ('data',
['__org.qemu_value'])]),
+ OrderedDict([('event', '__ORG.QEMU_EVENT'), ('data',
'__org.qemu_Struct')]),
+ OrderedDict([('command', '__org.qemu_command'), ('data',
OrderedDict([('a', '__org.qemu_Enum'), ('b', '__org.qemu_Struct')]))]),
+ OrderedDict([('union', '__org.qemu_Union'), ('data',
OrderedDict([('__org.qemu_branch', 'str')]))])]