[libvirt] [PATCH 1/3] docs: Teach apibuild to deal with (1U << 31) too

Michal Privoznik mprivozn at redhat.com
Mon May 30 07:31:00 UTC 2016

The apibuild script is a terrifying beast that parses some source
files of ours and produces an XML representation of them. When it
comes to parsing enums we have in some header files, it tries to
be clever and detect a value that an enum member has (or if it is
an alias for a different member). Whilst doing that it has to
deal with values we give to the members in many formats. At some
places we just pass the value in decimal:


in other places, we use the aliasing:


and in other places bitwise shifts are used:

    VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1 << 31, /* enforce requested stats */

The script tries to parse all of these resulting in the following
tokens: "1", "VIR_CONNECT_LIST_DOMAINS_ACTIVE", "1<<31"; Then, the
script tries to turn these into integers using python's eval()
function. This function succeeds on the first and the last
tokens. But, if we were to modify the last example so that it's
of the following form:

    VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1U << 31, /* enforce requested stats */

the token representing enum's member value will then be "1U<<31".
So our parsing is good. Unfortunately, python is not aware of the
difference between signed and unsigned C types, therefore eval()
fails over this token and the parser falls back thinking it's an
alias to another enum member. Well it's not.

The solution is to transform [0-9]U into [0-9] as for our
purposes here it's the same thing.

Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
 docs/apibuild.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/apibuild.py b/docs/apibuild.py
index 7e4a526..712b8b9 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -1398,7 +1398,8 @@ class CParser:
                     token = self.token()
                     while token[0] != "sep" or (token[1] != ',' and
                           token[1] != '}'):
-                        value = value + token[1]
+                        # We might be dealing with '1U << 12' here
+                        value = value + re.sub("(\d+)U","\\1", token[1])
                         token = self.token()

More information about the libvir-list mailing list