ENH: pygccxml v2.4.0 (reduced)

This corresponds to commit hash
  ce011e1bc57248d205cfda60dd51b3182acbe106
from upstream repository
  https://github.com/CastXML/pygccxml

Author: pygccxml Upstream

__init__.py

@@ -3,11 +3,11 @@
 # Distributed under the Boost Software License, Version 1.0.
 # See http://www.boost.org/LICENSE_1_0.txt
 
-"""Python CastXML or GCC-XML front end.
+"""Python CastXML front end.
 
 This package provides functionality to extract and inspect
 declarations from C/C++ header files. This is accomplished
-by invoking an external tool like CastXML or GCC-XML,
+by invoking an external tool like CastXML,
 which parses a header file and dumps the declarations as a
 XML file. This XML file is then read by pygccxml and the contents
 are made available as appropriate Python objects.
@@ -26,6 +26,7 @@
 
 """
 
+import sys
 import warnings
 
 from . import declarations
@@ -38,7 +39,16 @@
 # to know what is deprecated.
 warnings.simplefilter("always", DeprecationWarning)
 
-# TODO:
-# 1. Add "explicit" property for constructors
+version = sys.version_info
 
-__version__ = '2.0.1'
+if version < (3, 8):
+    import importlib_metadata as metadata
+elif version < (3, 9, 10) or (3, 10, 0) <= version < (3, 10, 2):
+    try:
+        import importlib_metadata as metadata
+    except ModuleNotFoundError:
+        from importlib import metadata
+else:
+    from importlib import metadata
+
+__version__ = metadata.version("pygccxml")

declarations/calldef.py

@@ -165,6 +165,7 @@ def __init__(
         self._calling_convention = None
         self._has_inline = None
         self._mangled = mangled
+        self._overrides = None
 
     def _get__cmp__call_items(self):
         """
@@ -242,6 +243,16 @@ def optional_args(self):
         value"""
         return self.arguments[len(self.required_args):]
 
+    @property
+    def overrides(self):
+        """If a function is marked as an overrides, contains
+        the declaration which this function overrides."""
+        return self._overrides
+
+    @overrides.setter
+    def overrides(self, overrides):
+        self._overrides = overrides
+
     @property
     def does_throw(self):
         """If False, than function does not throw any exception.

declarations/comment.py

@@ -0,0 +1,131 @@
+# Copyright 2014-2017 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
+
+"""
+Describe a C++ comment declaration.
+
+"""
+
+from . import location as pygccxml_location
+
+
+class comment_t(object):
+
+    def __init__(self, name='', declarations=None):
+        """
+        Creates an object that describes a C++ comment declaration.
+
+        Args:
+
+        """
+        self._location = {}
+        self._begin_line = 0
+        self._begin_column = 0
+        self._begin_offset = 0
+        self._end_line = 0
+        self._end_column = 0
+        self._end_offset = 0
+        self._text = ""
+
+    @property
+    def location(self):
+        """An instance of the location_t class
+        which contains the file where the
+        comment can be found.
+        @type: location_t """
+        return self._location
+
+    @location.setter
+    def location(self, location):
+        if not isinstance(location, pygccxml_location.location_t):
+            raise ValueError(
+                "'location' must be a location_t (got a %s instead)" %
+                type(location).__name__)
+        self._location = location
+
+    @property
+    def begin_line(self):
+        """An integer value which corresponds to the
+        line of the file where the comment begins
+        @type: int """
+        return self._begin_line
+
+    @begin_line.setter
+    def begin_line(self, begin_line):
+        self._begin_line = int(begin_line)
+
+    @property
+    def begin_offset(self):
+        """An integer value representing the
+        number of bytes from the beginning of the
+        file to the start of the comment
+        @type: int """
+        return self._begin_offset
+
+    @begin_offset.setter
+    def begin_offset(self, begin_offset):
+        self._begin_offset = int(begin_offset)
+
+    @property
+    def begin_column(self):
+        """An integer value which corresponds to the
+        column of the file where the comment begins
+        @type: int """
+        return self._begin_column
+
+    @begin_column.setter
+    def begin_column(self, begin_column):
+        self._begin_column = int(begin_column)
+
+    @property
+    def end_line(self):
+        """An integer value which corresponds to the
+        line of the file where the comment ends
+        @type: int """
+        return self._end_line
+
+    @end_line.setter
+    def end_line(self, end_line):
+        self._end_line = int(end_line)
+
+    @property
+    def end_offset(self):
+        """An integer value representing the
+        number of bytes from the beginning of the
+        file to the end of the comment
+        @type: int """
+        return self._end_offset
+
+    @end_offset.setter
+    def end_offset(self, end_offset):
+        self._end_offset = int(end_offset)
+
+    @property
+    def end_column(self):
+        """An integer value which corresponds to the
+        column of character in a line of the file
+        where the comment ends
+        @type: int """
+        return self._end_column
+
+    @end_column.setter
+    def end_column(self, end_column):
+        self._end_column = int(end_column)
+
+    @property
+    def text(self):
+        """A list of strings where each entry in the list
+        is one line of the comment. These comments will not
+        end in a newline
+        @type: list """
+        return self._text
+
+    @text.setter
+    def text(self, text):
+        if not isinstance(text, list):
+            raise ValueError(
+                "'text' must be a list (got a %s instead)" %
+                type(text).__name__)
+        self._text = text

declarations/decl_factory.py

@@ -12,6 +12,7 @@
 from .calldef_members import destructor_t
 from .calldef_members import member_operator_t
 from .calldef_members import casting_operator_t
+from .comment import comment_t
 from .free_calldef import free_function_t
 from .free_calldef import free_operator_t
 from .enumeration import enumeration_t
@@ -89,3 +90,7 @@ def create_typedef(self, *arguments, **keywords):
     def create_variable(self, *arguments, **keywords):
         """creates instance of class that describes variable declaration"""
         return variable_t(*arguments, **keywords)
+
+    def create_comment(self, *arguments, **keywords):
+        """creates instance of class that describes variable declaration"""
+        return comment_t(*arguments, **keywords)

declarations/decl_visitor.py

@@ -57,3 +57,6 @@ def visit_typedef(self):
 
     def visit_variable(self):
         raise NotImplementedError()
+
+    def visit_comment(self):
+        raise NotImplementedError()

declarations/declaration.py

@@ -13,6 +13,7 @@
 
 from . import declaration_utils
 from . import algorithms_cache
+from . import comment
 
 
 class declaration_t(object):
@@ -37,6 +38,8 @@ def __init__(
         self._cache = algorithms_cache.declaration_algs_cache_t()
         self._partial_name = None
         self._decorated_name = None
+        self._comment = comment.comment_t()
+        self._deprecation = None
 
     def __str__(self):
         """
@@ -338,3 +341,19 @@ def _warn_deprecated():
             "Please use the declarations.get_dependencies_from_decl()" +
             "function instead.\n",
             DeprecationWarning)
+
+    @property
+    def comment(self):
+        return self._comment
+
+    @comment.setter
+    def comment(self, comment):
+        self._comment = comment
+
+    @property
+    def deprecation(self):
+        return self._deprecation
+
+    @deprecation.setter
+    def deprecation(self, deprecation):
+        self._deprecation = deprecation

declarations/type_traits.py

@@ -483,29 +483,21 @@ def is_fundamental(type_):
 string_equivalences = [
     (
         '::std::basic_string<char,std::char_traits<char>,'
-        'std::allocator<char> >'),
-    (
-        '::std::basic_string<char, std::char_traits<char>, '
-        'std::allocator<char> >'),
+        'std::allocator<char>>'),
     '::std::basic_string<char>', '::std::string']
 
 wstring_equivalences = [
     (
         '::std::basic_string<wchar_t,std::char_traits<wchar_t>,' +
-        'std::allocator<wchar_t> >'),
-    (
-        '::std::basic_string<wchar_t, std::char_traits<wchar_t>, ' +
-        'std::allocator<wchar_t> >'),
+        'std::allocator<wchar_t>>'),
     '::std::basic_string<wchar_t>', '::std::wstring']
 
 ostream_equivalences = [
-    '::std::basic_ostream<char, std::char_traits<char> >',
-    '::std::basic_ostream<char,std::char_traits<char> >',
+    '::std::basic_ostream<char,std::char_traits<char>>',
     '::std::basic_ostream<char>', '::std::ostream']
 
 wostream_equivalences = [
-    '::std::basic_ostream<wchar_t, std::char_traits<wchar_t> >',
-    '::std::basic_ostream<wchar_t,std::char_traits<wchar_t> >',
+    '::std::basic_ostream<wchar_t,std::char_traits<wchar_t>>',
     '::std::basic_ostream<wchar_t>', '::std::wostream']
 
 
@@ -521,7 +513,7 @@ def is_std_string(type_):
     type_ = remove_alias(type_)
     type_ = remove_reference(type_)
     type_ = remove_cv(type_)
-    return type_.decl_string in string_equivalences
+    return type_.decl_string.replace(' ', '') in string_equivalences
 
 
 def is_std_wstring(type_):
@@ -536,7 +528,7 @@ def is_std_wstring(type_):
     type_ = remove_alias(type_)
     type_ = remove_reference(type_)
     type_ = remove_cv(type_)
-    return type_.decl_string in wstring_equivalences
+    return type_.decl_string.replace(' ', '') in wstring_equivalences
 
 
 def is_std_ostream(type_):
@@ -551,7 +543,7 @@ def is_std_ostream(type_):
     type_ = remove_alias(type_)
     type_ = remove_reference(type_)
     type_ = remove_cv(type_)
-    return type_.decl_string in ostream_equivalences
+    return type_.decl_string.replace(' ', '') in ostream_equivalences
 
 
 def is_std_wostream(type_):
@@ -566,4 +558,4 @@ def is_std_wostream(type_):
     type_ = remove_alias(type_)
     type_ = remove_reference(type_)
     type_ = remove_cv(type_)
-    return type_.decl_string in wostream_equivalences
+    return type_.decl_string.replace(' ', '') in wostream_equivalences