Merge branch 'hotfix/v1.8.1'

Author: iMichka

.gitignore

@@ -4,6 +4,7 @@
 docs/_build
 unittests/temp
 unittests/data/pygccxml.cache
+unittests/data/directory_cache_test
 .idea
 dist
 build
@@ -12,3 +13,4 @@ pygccxml.egg-info
 .coverage*
 docs/examples/caching/example.hpp.xml
 test_cost.log
+docs/apidocs

.travis.yml

@@ -90,13 +90,13 @@ matrix:
             # gcc 5.3.0
             - g++-5
     - os: osx
-      osx_image: xcode7.2
+      osx_image: xcode7.3
       language: generic
       env:
         - XML_GENERATOR="castxml"
         - TRAVIS_PYTHON_VERSION="2"
     - os: osx
-      osx_image: xcode7.2
+      osx_image: xcode7.3
       language: generic
       env:
         - XML_GENERATOR="castxml"
@@ -106,7 +106,6 @@ matrix:
 before_install:
  # OS X
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then travis_retry brew update; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]] && [[ $TRAVIS_PYTHON_VERSION == 2 ]]; then brew install python; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]] && [[ $TRAVIS_PYTHON_VERSION == 3 ]]; then brew install python3; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]] && [[ $TRAVIS_PYTHON_VERSION == 3 ]]; then sudo ln -sf /usr/local/bin/pip3 /usr/local/bin/pip; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]] && [[ $TRAVIS_PYTHON_VERSION == 3 ]]; then sudo ln -sf /usr/local/bin/python3 /usr/local/bin/python; fi

CHANGELOG.md

@@ -1,6 +1,19 @@
 Changes
 =======
 
+Version 1.8.1
+-------------
+
+1. Added ```is_struct``` function to declarations package. It returns true if
+  a declaration is a struct.
+
+2. Removed * from decl_string when type is a function pointer (#61)
+
+3. Update travis.yml for newer OS X images. Update CastXML binaries for Travis.
+
+4. Fix regression in directory_cache, which was crashing due an unset variable.
+  Add support for python3 in directory_cache.
+
 Version 1.8.0
 -------------
 

docs/conf.py

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.8.0'
+version = '1.8.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.8.0'
+release = '1.8.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/examples/function-pointer/example.py

@@ -29,22 +29,26 @@
 decls = parser.parse([filename], xml_generator_config)
 global_namespace = declarations.get_global_namespace(decls)
 
-function = global_namespace.variables()[0]
+function_ptr = global_namespace.variables()[0]
 
 # Print the name of the function pointer
-print(function.name)
+print(function_ptr.name)
 # > myFuncPointer
 
-# Print the type of the declaration (it's just a pointer)
-print(type(function.decl_type))
+# Print the type of the declaration
+print(function_ptr.decl_type)
+# > void (*)( int,double )
+
+# Print the real type of the declaration (it's just a pointer)
+print(type(function_ptr.decl_type))
 # > <class 'pygccxml.declarations.cpptypes.pointer_t'>
 
 # Check if this is a function pointer
-print(declarations.is_calldef_pointer(function.decl_type))
+print(declarations.is_calldef_pointer(function_ptr.decl_type))
 # > True
 
 # Remove the pointer part, to access the function's type
-f_type = declarations.remove_pointer(function.decl_type)
+f_type = declarations.remove_pointer(function_ptr.decl_type)
 
 # Print the type
 print(type(f_type))

pygccxml/__init__.py

@@ -40,4 +40,4 @@
 # TODO:
 # 1. Add "explicit" property for constructors
 
-__version__ = '1.8.0'
+__version__ = '1.8.1'

pygccxml/declarations/__init__.py

@@ -167,6 +167,7 @@
 from .type_traits_classes import is_noncopyable
 from .type_traits_classes import is_copy_constructor
 from .type_traits_classes import is_trivial_constructor
+from .type_traits_classes import is_struct
 from .type_traits_classes import is_union
 
 from .type_traits_classes import is_unary_operator

pygccxml/declarations/cpptypes.py

@@ -574,7 +574,12 @@ def __init__(self, base):
         compound_t.__init__(self, base)
 
     def build_decl_string(self, with_defaults=True):
-        return self.base.build_decl_string(with_defaults) + ' *'
+        decl_string = self.base.build_decl_string(with_defaults)
+        if isinstance(self.base, calldef_type_t):
+            # This is a function pointer. Do not add supplementary *
+            return decl_string
+        else:
+            return decl_string + " *"
 
     def _clone_impl(self):
         return pointer_t(self.base.clone())

pygccxml/declarations/type_traits_classes.py

@@ -15,14 +15,38 @@
 from .. import utils
 
 
-def is_union(type_):
-    """returns True if type represents a C++ union"""
-    if not is_class(type_):
+def is_union(declaration):
+    """
+    Returns True if declaration represents a C++ union
+
+    Args:
+        declaration (declaration_t): the declaration to be checked.
+
+    Returns:
+        bool: True if declaration represents a C++ union
+    """
+    if not is_class(declaration):
         return False
-    decl = class_traits.get_declaration(type_)
+    decl = class_traits.get_declaration(declaration)
     return decl.class_type == class_declaration.CLASS_TYPES.UNION
 
 
+def is_struct(declaration):
+    """
+    Returns True if declaration represents a C++ struct
+
+    Args:
+        declaration (declaration_t): the declaration to be checked.
+
+    Returns:
+        bool: True if declaration represents a C++ struct
+    """
+    if not is_class(declaration):
+        return False
+    decl = class_traits.get_declaration(declaration)
+    return decl.class_type == class_declaration.CLASS_TYPES.STRUCT
+
+
 class declaration_xxx_traits(object):
     """this class implements the functionality needed for convenient work with
     declaration classes

pygccxml/parser/directory_cache.py

@@ -24,7 +24,9 @@
     import cPickle as pickle
 except ImportError:
     import pickle
+
 from . import declarations_cache
+from .. import utils
 
 
 class index_entry_t(object):
@@ -238,6 +240,10 @@ def _load(self):
             self.__index = {}
             self.__filename_rep = filename_repository_t(self.__sha1_sigs)
 
+        # Read the xml generator from the cache and set it
+        with open(os.path.join(self.__dir, "gen.dat"), "r") as gen_file:
+            utils.xml_generator = gen_file.read()
+
         self.__modified_flag = False
 
     def _save(self):
@@ -255,6 +261,11 @@ def _save(self):
                 indexfilename,
                 (self.__index,
                  self.__filename_rep))
+
+            # Read the xml generator from the cache and set it
+            with open(os.path.join(self.__dir, "gen.dat"), "w") as gen_file:
+                gen_file.write(utils.xml_generator)
+
             self.__modified_flag = False
 
     def _read_file(self, filename):
@@ -366,15 +377,15 @@ def _create_config_signature(config):
         :rtype: str
         """
         m = hashlib.sha1()
-        m.update(config.working_directory)
+        m.update(config.working_directory.encode("utf-8"))
         for p in config.include_paths:
-            m.update(p)
+            m.update(p.encode("utf-8"))
         for p in config.define_symbols:
-            m.update(p)
+            m.update(p.encode("utf-8"))
         for p in config.undefine_symbols:
-            m.update(p)
+            m.update(p.encode("utf-8"))
         for p in config.cflags:
-            m.update(p)
+            m.update(p.encode("utf-8"))
         return m.digest()
 
 
@@ -531,13 +542,13 @@ def _get_signature(self, entry):
             if not os.path.exists(entry.filename):
                 return None
             try:
-                f = open(entry.filename)
+                f = open(entry.filename, "r")
             except IOError as e:
                 print("Cannot determine sha1 digest:", e)
                 return None
             data = f.read()
             f.close()
-            return hashlib.sha1(data).digest()
+            return hashlib.sha1(data.encode("utf-8")).digest()
         else:
             # return file modification date...
             try:

setup.py

@@ -7,14 +7,14 @@
 from setuptools import setup
 
 setup(name="pygccxml",
-      version="1.8.0",
+      version="1.8.1",
       author="Roman Yakovenko",
       author_email="roman yakovenko at gmail com",
       maintainer="Michka Popoff and the Insight Software Consortium",
       maintainer_email="castxml@public.kitware.com",
       description="Python package for easy C++ declarations navigation.",
       url="https://github.com/gccxml/pygccxml",
-      download_url="https://github.com/gccxml/pygccxml/archive/v1.8.0.tar.gz",
+      download_url="https://github.com/gccxml/pygccxml/archive/v1.8.1.tar.gz",
       license="Boost",
       keywords="C++, declaration parser, CastXML, gccxml",
       packages=["pygccxml",

unittests/test_all.py

@@ -74,6 +74,7 @@
 import test_smart_pointer
 import test_pattern_parser
 import test_function_pointer
+import test_directory_cache
 
 testers = [
     # , demangled_tester # failing right now
@@ -140,7 +141,8 @@
     test_argument_without_name,
     test_smart_pointer,
     test_pattern_parser,
-    test_function_pointer
+    test_function_pointer,
+    test_directory_cache
 ]
 
 if 'posix' in os.name:

unittests/test_directory_cache.py

@@ -0,0 +1,42 @@
+# Copyright 2014-2016 Insight Software Consortium.
+# Copyright 2004-2009 Roman Yakovenko.
+# Distributed under the Boost Software License, Version 1.0.
+# See http://www.boost.org/LICENSE_1_0.txt
+
+import unittest
+import parser_test_case
+
+from pygccxml import parser
+
+
+class Test(parser_test_case.parser_test_case_t):
+
+    def __init__(self, *args):
+        parser_test_case.parser_test_case_t.__init__(self, *args)
+        self.header = "core_cache.hpp"
+
+    def test_directory_cache(self):
+        """
+        Test the directory cache
+
+        """
+
+        cache = parser.directory_cache_t(
+            dir="unittests/data/directory_cache_test")
+        # Generate a cache on first read
+        parser.parse([self.header], self.config, cache=cache)
+        # Read from the cache the second time
+        parser.parse([self.header], self.config, cache=cache)
+
+
+def create_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(Test))
+    return suite
+
+
+def run_suite():
+    unittest.TextTestRunner(verbosity=2).run(create_suite())
+
+if __name__ == "__main__":
+    run_suite()

unittests/test_function_pointer.py

@@ -33,7 +33,7 @@ def test_function_pointer(self):
         self.assertTrue(
             isinstance(variables[0].decl_type, declarations.pointer_t))
         self.assertTrue(
-            str(variables[0].decl_type) == "void (*)( int,double ) *")
+            str(variables[0].decl_type) == "void (*)( int,double )")
         self.assertTrue(
             declarations.is_calldef_pointer(variables[0].decl_type))
         self.assertTrue(

unittests/unnamed_classes_tester.py

@@ -32,11 +32,13 @@ def validate_bitfields(self, parent, bitfields):
     def do_union_test(self, union_name, bitfields):
         s2 = self.global_ns.class_('S2')
         self.assertFalse(declarations.is_union(s2))
+        self.assertTrue(declarations.is_struct(s2))
         self.assertEqual(s2.parent.name, 'S1')
         self.assertFalse(declarations.is_union(s2.parent))
 
         union = s2.variable(union_name)
         self.assertTrue(declarations.is_union(union.decl_type))
+        self.assertFalse(declarations.is_struct(union.decl_type))
 
         union_type = type_traits.remove_declarated(union.decl_type)
         self.validate_bitfields(union_type, bitfields)