]> git.ipfire.org Git - thirdparty/libvirt.git/commit
apibuild.py: Handle enum comments properly
authorMichal Privoznik <mprivozn@redhat.com>
Sat, 22 Jul 2017 06:05:12 +0000 (08:05 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Mon, 24 Jul 2017 10:03:33 +0000 (12:03 +0200)
commit6efdd94dbc23e6caf76109a559f7cadbb0cdcb98
tree8212b8c0a732d73dbf66d3d73d6566e4572642f1
parent97ea8da183171e5f5847b1a2372d23136efd30a9
apibuild.py: Handle enum comments properly

After f4cb85c6aff7c1d90 we only have two options for placing enum
values descriptions. It's either:

    typedef enum {
        /* Some long description. Therefore it's placed before
         * the value. */
        VIR_ENUM_A_VAL = 1,
    } virEnumA;

or:

    typedef enum {
        VIR_ENUM_B_VAL = 1, /* Some short description */
    } virEnumB;

However, our apibuild.py script is not able to deal with the
former one. It messes up comments. To fix this couple of things
needs to be done:

a) DO NOT reset self.comment in parseEnumBlock(). This is a
result from our tokenizer. Upon calling token() if it finds a
comment block it stores it in self.comment and returns the next
token (which is not comment). Therefore, if we reset self.comment
we might lose the first comment in the enum block.

b) we need a variable to track if the current enum block uses
value descriptions before or after values. That is if it's type
virEnumA or virEnumB. Depending on that, it we're dealing with
virEnumA type and the current token is a comma ',' we can add the
value into the list as we already have everything needed:
comment, name and value.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
docs/apibuild.py