[Lldb-commits] [PATCH] D58172: Embed swig version into lldb.py in a different way

[Pavel Labath via Phabricator via lldb-commits]

labath created this revision.
labath added reviewers: zturner, jingham.
Herald added a reviewer: serge-sans-paille.
Herald added a subscriber: jdoerfert.

Instead of doing string chopping on the resulting python file, get swig
to output the version for us. The two things which make slightly
non-trivial are:

- in order to get swig to expand SWIG_VERSION for us, we cannot use %pythoncode directly, but we have to go through an intermediate macro.
- SWIG_VERSION is a hex number, but it's components are supposed to be interpreted decimally, so there is a bit of integer magic needed to get the right number to come out.

I've tested that this approach works both with the latest (3.0.12) and
oldest (1.3.40) supported swig.


https://reviews.llvm.org/D58172

Files:
  scripts/Python/modify-python-lldb.py
  scripts/lldb.swig


Index: scripts/lldb.swig
===================================================================
--- scripts/lldb.swig
+++ scripts/lldb.swig
@@ -66,6 +66,21 @@
 
 import six
 %}
+
+// Include the version of swig that was used to generate this interface.
+%define EMBED_VERSION(VERSION)
+%pythoncode%{
+# SWIG_VERSION is written as a single hex number, but the components of it are
+# meant to be interpreted in decimal. So, 0x030012 is swig 3.0.12, and not
+# 3.0.18.
+def _to_int(hex):
+    return hex // 0x10 % 0x10 * 10 + hex % 0x10
+swig_version = (_to_int(VERSION // 0x10000), _to_int(VERSION // 0x100), _to_int(VERSION))
+del _to_int
+%}
+%enddef
+EMBED_VERSION(SWIG_VERSION)
+
 %include "./Python/python-typemaps.swig"
 
 /* C++ headers to be included. */
Index: scripts/Python/modify-python-lldb.py
===================================================================
--- scripts/Python/modify-python-lldb.py
+++ scripts/Python/modify-python-lldb.py
@@ -44,11 +44,6 @@
 
 # print "output_name is '" + output_name + "'"
 
-#
-# Version string
-#
-version_line = "swig_version = %s"
-
 #
 # Residues to be removed.
 #
@@ -338,7 +333,6 @@
 isvalid_pattern = re.compile("^    def IsValid\(")
 
 # These define the states of our finite state machine.
-EXPECTING_VERSION = 0
 NORMAL = 1
 DEFINING_ITERATOR = 2
 DEFINING_EQUALITY = 4
@@ -364,9 +358,8 @@
 # The FSM, in all possible states, also checks the current input for IsValid()
 # definition, and inserts a __nonzero__() method definition to implement truth
 # value testing and the built-in operation bool().
-state = EXPECTING_VERSION
+state = NORMAL
 
-swig_version_tuple = None
 for line in content.splitlines():
     # Handle the state transition into CLEANUP_DOCSTRING state as it is possible
     # to enter this state from either NORMAL or DEFINING_ITERATOR/EQUALITY.
@@ -383,20 +376,6 @@
         else:
             state |= CLEANUP_DOCSTRING
 
-    if state == EXPECTING_VERSION:
-        # We haven't read the version yet, read it now.
-        if swig_version_tuple is None:
-            match = version_pattern.search(line)
-            if match:
-                v = match.group(1)
-                swig_version_tuple = tuple(map(int, (v.split("."))))
-        elif not line.startswith('#'):
-            # This is the first non-comment line after the header.  Inject the
-            # version
-            new_line = version_line % str(swig_version_tuple)
-            new_content.add_line(new_line)
-            state = NORMAL
-
     if state == NORMAL:
         match = class_pattern.search(line)
         # Inserts lldb_helpers and the lldb_iter() definition before the first


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D58172.186623.patch
Type: text/x-patch
Size: 2647 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20190213/ebb06681/attachment.bin>