Fix for differences in nesting of cv-qual types between GCCXML/CastXML

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.

Change-Id: I17c1e1b034c38cee213a527e0eaae9c334f20440

Author: praetorian20

pygccxml/declarations/type_traits.py

@@ -293,26 +293,37 @@ def is_const(type):
     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:
-                base_type = nake_type.base.base.base
+                result_type = nake_type.base.base.base
             else:
-                base_type = nake_type.base.base
-            result_type = base_type
+                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
 
 

unittests/data/type_traits.hpp

@@ -420,20 +420,19 @@ namespace no{
 
 namespace remove_const{
 namespace before{
-
     typedef const void x1;
     typedef const incomplete_type x2;
     typedef int* const x3;
     typedef int* volatile x4;
     typedef void const * x5;
+    typedef int volatile const x6;
+    typedef int const volatile x7;
 
     typedef char arr_42[42];
     typedef char const arr_c_42[42];
     typedef char volatile arr_v_42[42];
-#ifdef __castxml__
     typedef char const volatile arr_cv_42[42];
     typedef char volatile const arr_vc_42[42];
-#endif
 }
 
 namespace after{
@@ -442,14 +441,14 @@ namespace after{
     typedef int* x3;
     typedef int* volatile x4;
     typedef void const * x5;
+    typedef int volatile x6;
+    typedef int volatile x7;
 
     typedef char arr_42[42];
     typedef char arr_c_42[42];
     typedef char volatile arr_v_42[42];
-#ifdef __castxml__
     typedef char volatile arr_cv_42[42];
     typedef char volatile arr_vc_42[42];
-#endif
 } }
 
 namespace is_volatile{
@@ -480,6 +479,8 @@ namespace before{
     typedef volatile int x2;
     typedef int* x3;
     typedef void volatile * x4;
+    typedef int volatile const x5;
+    typedef int const volatile x6;
 
     typedef char arr_42[42];
     typedef char const arr_c_42[42];
@@ -493,6 +494,8 @@ namespace after{
     typedef int x2;
     typedef int* x3;
     typedef void volatile * x4;
+    typedef int const x5;
+    typedef int const x6;
 
     typedef char arr_42[42];
     typedef char const arr_c_42[42];

unittests/type_traits_tester.py

@@ -94,8 +94,11 @@ def __test_type_transformation(self, ns_name, transformer):
                 declarations.is_same(
                     transformed,
                     tafter),
-                ("there is a difference between expected type and result. " +
-                 "typedef name: %s") % tbefore.decl_string)
+                ("there is a difference between expected type({0}) " +
+                 "and result({1}). typedef name: {2}").format(
+                    declarations.remove_declarated(tafter).decl_string,
+                    declarations.remove_declarated(transformed).decl_string,
+                    tbefore.decl_string))
 
     def test_is_enum(self):
         self.__test_type_category('is_enum', declarations.is_enum)