Fix problem with argument without names when building declaration string (#55)

When passing an object without name to a templated function,
pygcxxml was failing when building the declaration string of the function.

This is now fixed by displaying no name in the generated declaration string.

Author: iMichka

pygccxml/declarations/algorithm.py

@@ -124,13 +124,24 @@ def full_name(decl, with_defaults=True):
         raise RuntimeError("Unable to generate full name for None object!")
     if with_defaults:
         if not decl.cache.full_name:
-            decl.cache.full_name = full_name_from_declaration_path(
-                declaration_path(decl))
+            path = declaration_path(decl)
+            if path == [""]:
+                # Declarations without names are allowed (for examples class
+                # or struct instances). In this case set an empty name..
+                decl.cache.full_name = ""
+            else:
+                decl.cache.full_name = full_name_from_declaration_path(path)
         return decl.cache.full_name
     else:
         if not decl.cache.full_partial_name:
-            decl.cache.full_partial_name = full_name_from_declaration_path(
-                partial_declaration_path(decl))
+            path = partial_declaration_path(decl)
+            if path == [""]:
+                # Declarations without names are allowed (for examples class
+                # or struct instances). In this case set an empty name.
+                decl.cache.full_partial_name = ""
+            else:
+                decl.cache.full_partial_name = \
+                    full_name_from_declaration_path(path)
         return decl.cache.full_partial_name
 
 

unittests/data/test_argument_without_name.hpp

@@ -0,0 +1,18 @@
+// 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
+
+// Demonstrate some code where a struct without name is passed to a
+// templated function. See bug #55
+
+template <typename type>
+void
+function(type &var) {};
+
+int main()
+{
+    // Create foo, a struct with no name
+    struct { } foo;
+    function(foo);
+}

unittests/test_all.py

@@ -71,6 +71,7 @@
 import test_cpp_standards
 import unnamed_classes_tester
 import test_map_gcc5
+import test_argument_without_name
 
 testers = [
     # , demangled_tester # failing right now
@@ -134,7 +135,8 @@
     test_copy_constructor,
     test_cpp_standards,
     unnamed_classes_tester,
-    test_map_gcc5
+    test_map_gcc5,
+    test_argument_without_name
 ]
 
 if 'posix' in os.name:

unittests/test_argument_without_name.py

@@ -0,0 +1,56 @@
+# 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
+from pygccxml import declarations
+
+
+class tester_t(parser_test_case.parser_test_case_t):
+
+    def __init__(self, *args):
+        parser_test_case.parser_test_case_t.__init__(self, *args)
+        self.header = "test_argument_without_name.hpp"
+        self.config.cflags = "-std=c++11"
+
+    def test_argument_without_name(self):
+
+        """
+        Test passing an object without name to a templated function.
+
+        The test was failing when building the declaration string.
+        The declaration string will be 'void (*)(  & )'. If the passed
+        object had a name the result would then be 'void (*)(Name & )'.
+
+        See bug #55
+
+        """
+
+        if self.config.xml_generator == "gccxml":
+            return
+
+        decls = parser.parse([self.header], self.config)
+        global_ns = declarations.get_global_namespace(decls)
+
+        criteria = declarations.calldef_matcher(name="function")
+        free_funcs = declarations.matcher.find(criteria, global_ns)
+        for free_func in free_funcs:
+            decl_string = free_func.create_decl_string(with_defaults=False)
+            self.assertEqual(decl_string, "void (*)(  & )")
+
+
+def create_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(tester_t))
+    return suite
+
+
+def run_suite():
+    unittest.TextTestRunner(verbosity=2).run(create_suite())
+
+if __name__ == "__main__":
+    run_suite()

unittests/test_map_gcc5.py

@@ -1,4 +1,5 @@
 # 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
 
@@ -35,12 +36,15 @@ def test_map_gcc5(self):
 
         # This calldef is defined with gcc > 4.9 (maybe earlier, not tested)
         # and -std=c++11. Calling create_decl_string is failing with gcc.
-        # With clang the calldef does not exist so the matche
+        # With clang the calldef does not exist so the matcher
         # will just return an empty list, letting the test pass.
+        # See the test_argument_without_name.py for an equivalent test,
+        # which is not depending on the presence of the _M_clone_node
+        # method in the stl_tree.h file.
         criteria = declarations.calldef_matcher(name="_M_clone_node")
         free_funcs = declarations.matcher.find(criteria, global_ns)
         for free_funcs in free_funcs:
-            print(free_funcs.create_decl_string(with_defaults=False))
+            free_funcs.create_decl_string(with_defaults=False)
 
 
 def create_suite():