Merge branch 'hotfix/v1.7.2'

iMichka · iMichka · commit a7d0a2a1301f · 2016-02-17T23:08:06.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 *.pyc
+*.pyo
 *~
 docs/_build
 unittests/temp
diff --git a/docs/conf.py b/docs/conf.py
@@ -53,9 +53,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = 'v1.7.1'
+version = 'v1.7.2'
 # The full version, including alpha/beta/rc tags.
-release = 'v1.7.1'
+release = 'v1.7.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/docs/history.rst b/docs/history.rst
@@ -11,6 +11,24 @@ to python 3 (keeping it compatible with python 2).
 In Mai 2014, Michka Popoff and the Insight Software Consortium revived pygccxml
 by setting up a git repositery on github, hosted along with gccxml.
 
+Version 1.7.2
+-------------
+
+1. Fix exception in is_copy_constructor when the constructor's argument was
+   a typedef. is_copy_constructor will now return False instead of failing.
+   See issue #27.
+
+2. Fix bug with utils.xml_generator being unset when reading cached file.
+   This could for example happen when reading a cached file from a second
+   python interpreter (e.g. in a subprocess or by calling pygccxml
+   multiple times from a script). See issue #27.
+
+3. SafeConfigParser is throwing a deprecation warning in python 3.2 and newer.
+   Use ConfigParser instead. Thanks to Mark Moll for the patch.
+
+4. Add support for cflags property in config files.
+   Thanks to Mark Moll for the patch.
+
 Version 1.7.1
 -------------
 
diff --git a/pygccxml/__init__.py b/pygccxml/__init__.py
@@ -40,4 +40,4 @@
 # TODO:
 # 1. Add "explicit" property for constructors
 
-__version__ = 'v1.7.1'
+__version__ = 'v1.7.2'
diff --git a/pygccxml/declarations/calldef.py b/pygccxml/declarations/calldef.py
@@ -736,22 +736,54 @@ def __str__(self):
 
     @property
     def is_copy_constructor(self):
-        """returns True if described declaration is copy constructor,
-        otherwise False"""
+        """
+        Returns True if described declaration is copy constructor,
+        otherwise False.
+
+        """
+
         from . import type_traits
+
         args = self.arguments
-        if 1 != len(args):
+
+        # A copy constructor has only one argument
+        if len(args) != 1:
             return False
+
+        # We have only one argument, get it
         arg = args[0]
+
+        if not isinstance(arg.type, cpptypes.compound_t):
+            # An argument of type declarated_t (a typedef) could be passed to
+            # the constructor; and it could be a reference.
+            # But in c++ you can NOT write :
+            #    "typedef class MyClass { MyClass(const MyClass & arg) {} }"
+            # If the argument is a typedef, this is not a copy constructor.
+            # See the hierarchy of declarated_t and coumpound_t. They both
+            # inherit from type_t but are not related so we can discriminate
+            # between them.
+            return False
+
+        # The argument needs to be passed by reference in a copy constructor
         if not type_traits.is_reference(arg.type):
             return False
+
+        # The argument needs to be const for a copy constructor
         if not type_traits.is_const(arg.type.base):
             return False
-        unaliased = type_traits.remove_alias(arg.type.base)
-        # unaliased now refers to const_t instance
-        if not isinstance(unaliased.base, cpptypes.declarated_t):
+
+        un_aliased = type_traits.remove_alias(arg.type.base)
+        # un_aliased now refers to const_t instance
+        if not isinstance(un_aliased.base, cpptypes.declarated_t):
+            # We are looking for a declaration
+            # If "class MyClass { MyClass(const int & arg) {} }" is used,
+            # this is not copy constructor, so we return False here.
+            # -> un_aliased.base == cpptypes.int_t (!= cpptypes.declarated_t)
             return False
-        return id(unaliased.base.declaration) == id(self.parent)
+
+        # Final check: compare the parent (the class declaration for example)
+        # with the declaration of the type passed as argument.
+        return id(un_aliased.base.declaration) == id(self.parent)
 
     @property
     def is_trivial_constructor(self):
diff --git a/pygccxml/parser/config.py b/pygccxml/parser/config.py
@@ -343,11 +343,11 @@ def load_xml_generator_configuration(configuration, **defaults):
     """
     loads CastXML or GCC-XML configuration from an `.ini` file or any other
     file class
-    :class:`ConfigParser.SafeConfigParser` is able to parse.
+    :class:`configparser.ConfigParser` is able to parse.
 
     :param configuration: configuration could be
                           string(configuration file path) or instance
-                          of :class:`ConfigParser.SafeConfigParser` class
+                          of :class:`configparser.ConfigParser` class
 
     :rtype: :class:`.xml_generator_configuration_t`
 
@@ -381,10 +381,10 @@ def load_xml_generator_configuration(configuration, **defaults):
     parser = configuration
     if utils.is_str(configuration):
         try:
-            from configparser import SafeConfigParser
+            from configparser import ConfigParser
         except ImportError:
-            from ConfigParser import SafeConfigParser
-        parser = SafeConfigParser()
+            from ConfigParser import SafeConfigParser as ConfigParser
+        parser = ConfigParser()
         parser.read(configuration)
 
     # Create a new empty configuration
@@ -419,6 +419,8 @@ def load_xml_generator_configuration(configuration, **defaults):
             cfg.xml_generator = value
         elif name == 'keep_xml':
             cfg.keep_xml = value
+        elif name == 'cflags':
+            cfg.cflags = value
         elif name == 'flags':
             cfg.flags = value
         elif name == 'compiler_path':
diff --git a/pygccxml/parser/declarations_cache.py b/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,
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 from setuptools import setup
 
 setup(name="pygccxml",
-      version="v1.7.1",
+      version="v1.7.2",
       author="Roman Yakovenko",
       author_email="roman yakovenko at gmail com",
       maintainer="Michka Popoff and the Insight Software Consortium",
diff --git a/unittests/data/new_cache.cache b/unittests/data/new_cache.cache
diff --git a/unittests/data/old_cache.cache b/unittests/data/old_cache.cache
diff --git a/unittests/data/test_copy_constructor.hpp b/unittests/data/test_copy_constructor.hpp
@@ -0,0 +1,21 @@
+// Copyright 2014-2016 Insight Software Consortium.
+// Distributed under the Boost Software License, Version 1.0.
+// See http://www.boost.org/LICENSE_1_0.txt
+
+typedef const int & myvar;
+
+class test
+{
+    public:
+        // The copy constructor
+        test(const test & t0){};
+
+        // A constructor
+        test(const float & t0){};
+
+        // A constructor with a typedef
+        test(myvar t0){};
+};
+
+// An empty class; C++ will automatically create a copy constructor
+class test2 {};
diff --git a/unittests/file_cache_tester.py b/unittests/file_cache_tester.py
@@ -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()
diff --git a/unittests/reopen_cache_tester.py b/unittests/reopen_cache_tester.py
@@ -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()
diff --git a/unittests/test_all.py b/unittests/test_all.py
@@ -67,6 +67,7 @@
 import example_tester
 import test_utils
 import test_va_list_tag_removal
+import test_copy_constructor
 
 testers = [
     # , demangled_tester # failing right now
@@ -126,7 +127,8 @@
     pep8_tester,
     example_tester,
     test_utils,
-    test_va_list_tag_removal
+    test_va_list_tag_removal,
+    test_copy_constructor
 ]
 
 if 'posix' in os.name:
diff --git a/unittests/test_copy_constructor.py b/unittests/test_copy_constructor.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`*.pyc`
	`2`	`+*.pyo`
`2`	`3`	`*~`
`3`	`4`	`docs/_build`
`4`	`5`	`unittests/temp`