Add option to remove the __va_list_tag declaration from the tree when parsing with CastXML

This option is on by default.

The __va_list_tag declarations are internal declarations, which are probably
not needed. They are for example polluting the declarations tree when running
pyplusplus. The removal can still be re-enabled by setting the utils.remove__va_list_tag
option to False.

This fixes also the filter test, which has now the correct initial number of declarations
(the same as for gccxml). It also removes the hack in the hierarchy_travelling test.

Author: iMichka

pygccxml/parser/scanner.py

@@ -201,7 +201,17 @@ def startElement(self, name, attrs):
                 self.__inst = obj
             self.__read_access(attrs)
             element_id = attrs.get(XML_AN_ID, None)
+
+            # With CastXML and clang some __va_list_tag declarations are
+            # present in the tree: we do not want to have these in the tree.
+            # This option is set to True by default
+            remove_va_list_tag = utils.remove__va_list_tag
+
             if isinstance(obj, declarations.declaration_t):
+
+                if remove_va_list_tag and "__va_list_tag" in str(obj.name):
+                    return
+
                 # XML generator. Kept for retrocompatibily
                 obj.compiler = utils.xml_generator
 
@@ -217,11 +227,18 @@ def startElement(self, name, attrs):
                 self.__read_attributes(obj, attrs)
 
             elif isinstance(obj, declarations.type_t):
+
                 self.__types[element_id] = obj
                 self.__read_byte_size(obj, attrs)
                 self.__read_byte_align(obj, attrs)
+
             elif utils.is_str(obj):
+
+                if remove_va_list_tag and "__va_list_tag" in obj:
+                    return
+
                 self.__files[element_id] = obj
+
             else:
                 self.logger.warning(
                     'Unknown object type has been found.' +

pygccxml/utils/__init__.py

@@ -20,3 +20,7 @@
 
 # Version of xml generator which was used.
 xml_generator = None
+
+# With CastXML and clang some __va_list_tag declarations are present in the
+# tree. This options allows to remove them when parsing the xml file.
+remove__va_list_tag = True

unittests/filters_tester.py

@@ -39,14 +39,8 @@ def test_access_type(self):
         criteria = declarations.access_type_matcher_t(
             declarations.ACCESS_TYPES.PUBLIC)
         public_members = declarations.matcher.find(criteria, self.global_ns)
-        if "CastXML" in utils.xml_generator:
-            public_members = [d for d in public_members if not d.is_artificial]
-            self.assertTrue(21 == len(public_members))
-        if "0.9" in utils.xml_generator:
-            public_members = [d for d in public_members if not d.is_artificial]
-            self.assertTrue(17 == len(public_members))
-        else:
-            self.assertTrue(21 == len(public_members))
+        public_members = [d for d in public_members if not d.is_artificial]
+        self.assertTrue(17 == len(public_members))
 
     def test_or_matcher(self):
         criteria1 = declarations.regex_matcher_t(

unittests/hierarchy_traveling.py

@@ -9,7 +9,6 @@
 
 from pygccxml import parser
 from pygccxml import declarations
-from pygccxml import utils
 
 
 class tester_t(parser_test_case.parser_test_case_t):
@@ -53,11 +52,6 @@ def test_recursive_bases(self):
         classes = [
             inst for inst in decls if isinstance(inst, declarations.class_t)]
         for class_ in classes:
-            if "CastXML" in utils.xml_generator and \
-                    class_.name == "__va_list_tag":
-                # With CastXML; there is a __va_list_tag which is generated by
-                # clang. Do not run the tests for it.
-                continue
             self.assertTrue(class_.name in self.__recursive_bases)
             all_bases = class_.recursive_bases
             control_bases = self.__recursive_bases[class_.name]
@@ -73,11 +67,6 @@ def test_recursive_derived(self):
                 inst,
                 declarations.class_t)]
         for class_ in classes:
-            if "CastXML" in utils.xml_generator and \
-                    class_.name == "__va_list_tag":
-                # With CastXML; there is a __va_list_tag which is generated by
-                # clang. Do not run the tests for it.
-                continue
             self.assertTrue(class_.name in self.__recursive_derived)
             all_derived = class_.recursive_derived
             control_derived = self.__recursive_derived[class_.name]