Merge pull request #130 from josephsnyder/add_castxml_commenting

Add comment parsing from CastXML.

Author: iMichka

.github/workflows/tests.yml

@@ -75,11 +75,11 @@ jobs:
       - name: Setup castxml for Linux
         if: matrix.os == 'ubuntu-18.04' && matrix.castxml == 'castxml'
         run: |
-          wget -q -O - https://data.kitware.com/api/v1/file/hashsum/sha512/f43ef30267c850872cf1e8ea8594c5dc6a1beb7c343d63875662ee7c648dac4f9214c915499ef2e1148f2b5f866e4c518ca1a21fb5055baba7d62f4f69097ba0/download | tar zxf - -C ~/
+          wget -q -O - https://data.kitware.com/api/v1/file/hashsum/sha512/b580374e48d4df68f8ebef6d0e71cd8cc3f2dfa28f0090e07cc043d11cee308aeea480092fe2e93f2d4c58f822a5c013c1c7121964372d28ee4069949a378b4c/download | tar zxf - -C ~/
       - name: Setup castxml for Mac
         if: matrix.os == 'macos-latest'
         run: |
-          wget -q -O - https://data.kitware.com/api/v1/file/hashsum/sha512/88c9b5954ca7417f7b519f3006dc6fe4bd194af0837168edc30007a41eaae6d4eee97cef2a72747432af14941c7f60333b77c25e208b2540dcde2d61e0d0e6f3/download | tar zxf - -C ~/
+          wget -q -O - https://data.kitware.com/api/v1/file/hashsum/sha512/e5962372508abd295f8a8110a20142bcbd93c235f72afba34b0abb3918a623f27465a7674b5532320e770f56fddb99019f5c47b254cea9f862a2df35630c2879/download | tar zxf - -C ~/
       - name: Setup castxml config
         if: matrix.compiler == 'gcc' && matrix.version == '7'
         run: mv unittests/configs/gcc7.cfg unittests/xml_generator.cfg;

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

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

pygccxml/declarations/decl_visitor.py

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

pygccxml/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,7 @@ def __init__(
         self._cache = algorithms_cache.declaration_algs_cache_t()
         self._partial_name = None
         self._decorated_name = None
+        self._comment = comment.comment_t()
 
     def __str__(self):
         """
@@ -338,3 +340,11 @@ 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

pygccxml/parser/linker.py

@@ -107,6 +107,9 @@ def visit_destructor(self):
     def visit_member_operator(self):
         self.__link_calldef()
 
+    def visit_comment(self):
+        pass
+
     def visit_casting_operator(self):
         self.__link_calldef()
         # FIXME: is the patch still needed as the demangled name support has