Merge branch 'hotfix/v1.7.4'

Author: iMichka

README.rst

@@ -7,8 +7,8 @@ pygccxml
 .. image:: https://coveralls.io/repos/gccxml/pygccxml/badge.svg?branch=master
     :target: https://coveralls.io/r/gccxml/pygccxml?branch=master
     :alt: Code coverage status
-.. image:: https://readthedocs.org/projects/pygccxml/badge/?version=master
-    :target: https://readthedocs.org/projects/pygccxml/?badge=master
+.. image:: https://readthedocs.io/projects/pygccxml/badge/?version=master
+    :target: https://readthedocs.io/projects/pygccxml/?badge=master
     :alt: Documentation status
 .. image:: https://www.quantifiedcode.com/api/v1/project/117af14ef32a455fb7b3762e21083fb3/snapshot/origin:master:HEAD/badge.svg
     :target: https://www.quantifiedcode.com/app/project/117af14ef32a455fb7b3762e21083fb3?branch=origin%2Fmaster&tab=basics
@@ -37,7 +37,7 @@ For issues with pygccxml you can open an issue here: https://github.com/gccxml/p
 Documentation
 -------------
 
-For examples and tutorials see the documentation: http://pygccxml.readthedocs.org
+For examples and tutorials see the documentation: http://pygccxml.readthedocs.io
 
 Branches
 --------

docs/conf.py

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

docs/history.rst

@@ -11,6 +11,26 @@ 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.4
+-------------
+
+1. CV-qualified arrays were not being handled correctly by type traits
+   manipulations functions. For instance, 'int const[N]' would not be
+   detected as 'const'. Similar problems existed for volatile qualified
+   arrays too. See #35 for more details. A newer version of CastXML is
+   recommended (xml output version >= 1.138)
+
+2. Close subprocess stdout stream once value has been read.
+   Fixes some warnings under python3.
+
+3. Since this release, pyggcxml's version numbers do not contain the ``v``
+   prefix anymore. This was breaking distribution on PyPI (pypi.python.org).
+
+4. The documentation is now at http://pygccxml.readthedocs.io/
+
+Thanks to the following people for their contribution to this release:
+Ashish Sadanandan
+
 Version 1.7.3
 -------------
 

pygccxml/__init__.py

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

pygccxml/declarations/type_traits.py

@@ -284,19 +284,46 @@ def remove_reference(type):
 def is_const(type):
     """returns True, if type represents C++ const type, False otherwise"""
     nake_type = remove_alias(type)
-    return isinstance(nake_type, cpptypes.const_t)
+    if isinstance(nake_type, cpptypes.const_t):
+        return True
+    elif isinstance(nake_type, cpptypes.volatile_t):
+        return is_const(nake_type.base)
+    elif isinstance(nake_type, cpptypes.array_t):
+        return is_const(nake_type.base)
+    return False
 
 
-def remove_const(type):
+def remove_const(type_):
     """removes const from the type definition
 
     If type is not const type, it will be returned as is
     """
 
-    nake_type = remove_alias(type)
+    nake_type = remove_alias(type_)
     if not is_const(nake_type):
-        return type
+        return type_
     else:
+        # Handling for const and volatile qualified types. There is a
+        # difference in behavior between GCCXML and CastXML for cv-qual arrays.
+        # GCCXML produces the following nesting of types:
+        #       ->  volatile_t(const_t(array_t))
+        # while CastXML produces the following nesting:
+        #       ->  array_t(volatile_t(const_t))
+        # For both cases, we must unwrap the types, remove const_t, and add
+        # back the outer layers
+        if isinstance(nake_type, cpptypes.array_t):
+            is_v = is_volatile(nake_type)
+            if is_v:
+                result_type = nake_type.base.base.base
+            else:
+                result_type = nake_type.base.base
+            if is_v:
+                result_type = cpptypes.volatile_t(result_type)
+            return cpptypes.array_t(result_type, nake_type.size)
+
+        elif isinstance(nake_type, cpptypes.volatile_t):
+            return cpptypes.volatile_t(nake_type.base.base)
+
         return nake_type.base
 
 
@@ -322,7 +349,13 @@ def is_same(type1, type2):
 def is_volatile(type):
     """returns True, if type represents C++ volatile type, False otherwise"""
     nake_type = remove_alias(type)
-    return isinstance(nake_type, cpptypes.volatile_t)
+    if isinstance(nake_type, cpptypes.volatile_t):
+        return True
+    elif isinstance(nake_type, cpptypes.const_t):
+        return is_volatile(nake_type.base)
+    elif isinstance(nake_type, cpptypes.array_t):
+        return is_volatile(nake_type.base)
+    return False
 
 
 def remove_volatile(type):
@@ -334,6 +367,16 @@ def remove_volatile(type):
     if not is_volatile(nake_type):
         return type
     else:
+        if isinstance(nake_type, cpptypes.array_t):
+            is_c = is_const(nake_type)
+            if is_c:
+                base_type = nake_type.base.base.base
+            else:
+                base_type = nake_type.base.base
+            result_type = base_type
+            if is_c:
+                result_type = cpptypes.const_t(result_type)
+            return cpptypes.array_t(result_type, nake_type.size)
         return nake_type.base
 
 
@@ -344,12 +387,12 @@ def remove_cv(type):
     if not is_const(nake_type) and not is_volatile(nake_type):
         return type
     result = nake_type
-    if is_const(nake_type):
-        result = nake_type.base
+    if is_const(result):
+        result = remove_const(result)
     if is_volatile(result):
-        result = result.base
+        result = remove_volatile(result)
     if is_const(result):
-        result = result.base
+        result = remove_const(result)
     return result
 
 

pygccxml/parser/config.py

@@ -452,6 +452,7 @@ def create_compiler_path(xml_generator, compiler_path):
             p = subprocess.Popen(
                 ['which', 'clang++'], stdout=subprocess.PIPE)
             compiler_path = p.stdout.read().decode("utf-8").rstrip()
+            p.stdout.close()
             # No clang found; use gcc
             if compiler_path == '':
                 compiler_path = '/usr/bin/c++'

pygccxml/utils/utils.py

@@ -50,13 +50,16 @@ def find_xml_generator(name=None):
         name = "gccxml"
         p = subprocess.Popen([command, name], stdout=subprocess.PIPE)
         path = p.stdout.read().decode("utf-8")
+        p.stdout.close()
         if path == "":
             name = "castxml"
             p = subprocess.Popen([command, name], stdout=subprocess.PIPE)
             path = p.stdout.read().decode("utf-8")
+            p.stdout.close()
     else:
         p = subprocess.Popen([command, name], stdout=subprocess.PIPE)
         path = p.stdout.read().decode("utf-8")
+        p.stdout.close()
     if path == "":
         raise(Exception(
             "No c++ parser found. Please install castxml or gccxml."))

setup.py

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

unittests/array_bug_tester.py

@@ -55,6 +55,65 @@ def test4(self):
             '::xyz[2][3]' == aaaa_type.decl_string,
             aaaa_type.decl_string)
 
+    def test5(self):
+        code = 'char const arr[4] = {};'
+        src_reader = parser.source_reader_t(self.config)
+        global_ns = declarations.get_global_namespace(
+            src_reader.read_string(code))
+        arr_type = global_ns.variable('arr').type
+        if self.config.xml_generator == "gccxml":
+            self.assertTrue(
+                'char[4] const' == arr_type.decl_string,
+                arr_type.decl_string)
+        else:
+            self.assertTrue(
+                'char const[4]' == arr_type.decl_string,
+                arr_type.decl_string)
+        self.assertTrue(
+            declarations.is_array(arr_type))
+        self.assertTrue(
+            declarations.is_const(arr_type))
+
+    def test6(self):
+        code = 'char volatile arr[4] = {};'
+        src_reader = parser.source_reader_t(self.config)
+        global_ns = declarations.get_global_namespace(
+            src_reader.read_string(code))
+        arr_type = global_ns.variable('arr').type
+        if self.config.xml_generator == "gccxml":
+            self.assertTrue(
+                'char[4] volatile' == arr_type.decl_string,
+                arr_type.decl_string)
+        else:
+            self.assertTrue(
+                'char volatile[4]' == arr_type.decl_string,
+                arr_type.decl_string)
+        self.assertTrue(
+            declarations.is_array(arr_type))
+        self.assertTrue(
+            declarations.is_volatile(arr_type))
+
+    def test7(self):
+        code = 'char const volatile arr[4] = {};'
+        src_reader = parser.source_reader_t(self.config)
+        global_ns = declarations.get_global_namespace(
+            src_reader.read_string(code))
+        arr_type = global_ns.variable('arr').type
+        if self.config.xml_generator == "gccxml":
+            self.assertTrue(
+                'char[4] const volatile' == arr_type.decl_string,
+                arr_type.decl_string)
+        else:
+            self.assertTrue(
+                'char const volatile[4]' == arr_type.decl_string,
+                arr_type.decl_string)
+        self.assertTrue(
+            declarations.is_array(arr_type))
+        self.assertTrue(
+            declarations.is_const(arr_type))
+        self.assertTrue(
+            declarations.is_volatile(arr_type))
+
 
 def create_suite():
     suite = unittest.TestSuite()