Add additional properties to comment.

Add the additional properties from CastXML.
Add location as a proper property
Add type checks for the non-int properties.

Author: josephsnyder

pygccxml/declarations/comment.py

@@ -10,6 +10,7 @@
 
 
 from . import declaration
+from . import location as pygccxml_location
 
 
 class comment_t(declaration.declaration_t):
@@ -22,31 +23,110 @@ def __init__(self, name='', declarations=None):
 
         """
         declaration.declaration_t.__init__(self, name)
-        self.location = {}
-        self._start_line = 0
+        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 start_line(self):
-        return self._start_line
+    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
 
-    @start_line.setter
-    def start_line(self, start_line):
-        self._start_line = int(start_line)
+    @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 which corresponds to the
+        line of the file where the comment begins
+        @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
+        line 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 which corresponds to the
+        line of the file where the comment ends
+        @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
+        coloumn 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):
+        """An 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/parser/scanner.py

@@ -20,14 +20,19 @@
 XML_AN_ATTRIBUTES = "attributes"
 XML_AN_BASE_TYPE = "basetype"
 XML_AN_BASES = "bases"
+XML_AN_BEGIN_COLUMN = "begin_column"
+XML_AN_BEGIN_LINE = "begin_line"
+XML_AN_BEGIN_OFFSET = "begin_offset"
 XML_AN_BITS = "bits"
 XML_AN_COMMENT = "comment"
 XML_AN_CONST = "const"
 XML_AN_CONTEXT = "context"
 XML_AN_CVS_REVISION = "cvs_revision"
 XML_AN_CASTXML_FORMAT = "format"
 XML_AN_DEFAULT = "default"
+XML_AN_END_COLUMN = "end_column"
 XML_AN_END_LINE = "end_line"
+XML_AN_END_OFFSET = "end_offset"
 XML_AN_EXPLICIT = "explicit"
 XML_AN_EXTERN = "extern"
 XML_AN_FILE = "file"
@@ -36,7 +41,6 @@
 XML_AN_INIT = "init"
 XML_AN_INLINE = "inline"
 XML_AN_LINE = "line"
-XML_AN_BEGIN_LINE = "begin_line"
 XML_AN_MANGLED = "mangled"
 XML_AN_MAX = "max"
 XML_AN_MEMBERS = "members"
@@ -618,8 +622,12 @@ def __read_casting_operator(self, attrs):
 
     def __read_comment(self, attrs):
         comment = self.__decl_factory.create_comment()
-        comment._start_line = int(attrs.get(XML_AN_BEGIN_LINE))
-        comment._end_line = int(attrs.get(XML_AN_END_LINE))
+        comment.begin_line = int(attrs.get(XML_AN_BEGIN_LINE))
+        comment.end_line = int(attrs.get(XML_AN_END_LINE))
+        comment.begin_offset = int(attrs.get(XML_AN_BEGIN_OFFSET))
+        comment.end_offset = int(attrs.get(XML_AN_END_OFFSET))
+        comment.begin_column = int(attrs.get(XML_AN_BEGIN_COLUMN))
+        comment.end_column = int(attrs.get(XML_AN_END_COLUMN))
         self.__read_location(comment, attrs, self.__name_attrs_to_skip)
         return comment