Add is_struct() function (#63)

The documentation of is_struct and is_union was updated
A test for the is_struct function was added

Author: iMichka

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changes
 =======
 
+Version 1.8.1 (not yet released)
+--------------------------------
+
+* Added ```is_struct``` function to declarations package. It returns true if
+  a declaration is a struct.
+
 Version 1.8.0
 -------------
 

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/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

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)