qapi: Tighten the regex on valid names
authorEric Blake <eblake@redhat.com>
Wed, 18 Nov 2015 08:52:56 +0000 (01:52 -0700)
committerMarkus Armbruster <armbru@redhat.com>
Thu, 17 Dec 2015 07:21:27 +0000 (08:21 +0100)
commit59a92feedc6927e0e1ff87fdaccfb4dd42ad4c84
treecd0b28944b4e37051feab55ce0b397a0f97348ea
parent5be5b7764f83cf9a535a22ecbd33710daf1fe210
qapi: Tighten the regex on valid names

We already documented that qapi names should match specific
patterns (such as starting with a letter unless it was an enum
value or a downstream extension).  Tighten that from a suggestion
into a hard requirement, which frees up names beginning with a
single underscore for qapi internal usage.

The tighter regex doesn't forbid everything insane that a user
could provide (for example, a user could name a type 'Foo-lookup'
to collide with the generated 'Foo_lookup[]' for an enum 'Foo'),
but does a good job at protecting the most obvious uses, and
also happens to reserve single leading underscore for later use.

The handling of enum values starting with a digit is tricky:
commit 9fb081e introduced a subtle bug by using c_name() on
a munged value, which would allow an enum to include the
member 'q-int' in spite of our reservation.  Furthermore,
munging with a leading '_' would fail our tighter regex.  So
fix it by only munging for leading digits (which are never
ticklish in c_name()) and by using a different prefix (I
picked 'D', although any letter should do).

Add new tests, reserved-member-underscore and reserved-enum-q,
to demonstrate the tighter checking.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-22-git-send-email-eblake@redhat.com>
Message-Id: <1447883135-18020-1-git-send-email-eblake@redhat.com>
[Eric's fixup squashed in]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/qapi-code-gen.txt
scripts/qapi.py
tests/Makefile
tests/qapi-schema/reserved-enum-q.err [new file with mode: 0644]
tests/qapi-schema/reserved-enum-q.exit [new file with mode: 0644]
tests/qapi-schema/reserved-enum-q.json [new file with mode: 0644]
tests/qapi-schema/reserved-enum-q.out [new file with mode: 0644]
tests/qapi-schema/reserved-member-underscore.err [new file with mode: 0644]
tests/qapi-schema/reserved-member-underscore.exit [new file with mode: 0644]
tests/qapi-schema/reserved-member-underscore.json [new file with mode: 0644]
tests/qapi-schema/reserved-member-underscore.out [new file with mode: 0644]