Merge branch 'FixBug27' into hotfix/v1.7.2

Author: iMichka

pygccxml/parser/declarations_cache.py

@@ -102,11 +102,13 @@ class record_t(object):
 
     def __init__(
             self,
+            xml_generator,
             source_signature,
             config_signature,
             included_files,
             included_files_signature,
             declarations):
+        self.__xml_generator = xml_generator
         self.__source_signature = source_signature
         self.__config_signature = config_signature
         self.__included_files = included_files
@@ -151,6 +153,10 @@ def included_files_signature(self):
     def declarations(self):
         return self.__declarations
 
+    @property
+    def xml_generator(self):
+        return self.__xml_generator
+
 
 class file_cache_t(cache_base_t):
 
@@ -174,6 +180,23 @@ def __init__(self, name):
             self.__cache)  # If empty then we need to flush
         for entry in self.__cache.values():  # Clear hit flags
             entry.was_hit = False
+            try:
+                # Make sure the xml_generator variable is defined, else it
+                # will stay None.
+                xml_generator = entry.xml_generator
+            except AttributeError:
+                msg = (
+                    "The %s cache file is not compatible with this version " +
+                    "of pygccxml. Please regenerate it.") % name
+                raise RuntimeError(msg)
+            if utils.xml_generator is None:
+                # Set the xml_generator to the one read in the cache file
+                utils.xml_generator = xml_generator
+            elif utils.xml_generator != xml_generator:
+                msg = (
+                    "The %s cache file was generated with a different xml " +
+                    "generator. Please regenerate it.") % name
+                raise RuntimeError(msg)
 
     @staticmethod
     def __load(file_name):
@@ -231,6 +254,7 @@ def update(self, source_file, configuration, declarations, included_files):
         """ Update a cached record with the current key and value contents. """
 
         record = record_t(
+            xml_generator=utils.xml_generator,
             source_signature=file_signature(source_file),
             config_signature=configuration_signature(configuration),
             included_files=included_files,

unittests/data/new_cache.cache

@@ -4,8 +4,10 @@
 # See http://www.boost.org/LICENSE_1_0.txt
 
 import os
+import sys
 import unittest
 import autoconfig
+import subprocess
 import parser_test_case
 from pygccxml import parser
 
@@ -78,6 +80,16 @@ def test_from_file(self):
             ("cached declarations and source declarations are different, " +
                 "after pickling"))
 
+    def test_reopen_cache(self):
+        """
+        Test opening cache files in a subprocess (with a clean environment).
+
+        """
+        p = subprocess.Popen(
+            [sys.executable, "unittests/reopen_cache_tester.py"],
+            stdout=subprocess.PIPE)
+        print(p.stdout.read())
+
 
 def create_suite():
     suite = unittest.TestSuite()

unittests/data/old_cache.cache

@@ -0,0 +1,50 @@
+# Copyright 2014-2015 Insight Software Consortium.
+# Copyright 2004-2008 Roman Yakovenko.
+# Distributed under the Boost Software License, Version 1.0.
+# See http://www.boost.org/LICENSE_1_0.txt
+
+import os
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+import autoconfig
+from pygccxml import parser
+from pygccxml import utils
+
+
+def test_re_opening_cache_file():
+    """
+    Test re-oping cache files.
+
+    This test is run by file_cache_tester.py in a subprocess.
+
+    """
+
+    data = autoconfig.data_directory
+
+    # xml_generator has not been set
+    if utils.xml_generator is not None:
+        raise Exception
+
+    # Try to reopen an old cache file and check if there is an exception
+    # These old files do not know about the xml generator; a RuntimeError
+    # should be thrown, asking to regenerate the cache file.
+    c_file = os.path.join(data, 'old_cache.cache')
+    error = False
+    try:
+        parser.file_cache_t(c_file)
+    except RuntimeError:
+        error = True
+    if error is False:
+        raise Exception
+
+    # This cache file knows about the xml generator, and was generated
+    # with CastXML. Loading the cache should set the utils.xml_generator.
+    c_file = os.path.join(data, 'new_cache.cache')
+    parser.file_cache_t(c_file)
+    if "CastXML" not in utils.xml_generator:
+        raise Exception
+
+if __name__ == "__main__":
+    test_re_opening_cache_file()