coala-analyzer / coala

coalib/results/SourceRange.py

from os.path import relpath

from coalib.misc.Decorators import enforce_signature, get_public_members
from coalib.results.SourcePosition import SourcePosition
from coalib.results.TextRange import TextRange
from coalib.results.AbsolutePosition import AbsolutePosition


class SourceRange(TextRange):

The variable TextRange does not seem to be defined.

    @enforce_signature

The variable enforce_signature does not seem to be defined.

    def __init__(self,
                 start: SourcePosition,

The variable SourcePosition does not seem to be defined.

                 end: (SourcePosition, None)=None):
        """
        Creates a new SourceRange.

        :param start:       A SourcePosition indicating the start of the range.
        :param end:         A SourcePosition indicating the end of the range.
                            If ``None`` is given, the start object will be used
                            here. end must be in the same file and be greater
                            than start as negative ranges are not allowed.
        :raises TypeError:  Raised when
                            - start is no SourcePosition or None.
                            - end is no SourcePosition.
        :raises ValueError: Raised when file of start and end mismatch.
        """
        TextRange.__init__(self, start, end)

The variable start does not seem to be defined.

The variable end does not seem to be defined.

The variable self does not seem to be defined.

        if self.start.file != self.end.file:
            raise ValueError("File of start and end position do not match.")

    @classmethod

The variable classmethod does not seem to be defined.

    def from_values(cls,
                    file,
                    start_line=None,
                    start_column=None,
                    end_line=None,
                    end_column=None):
        start = SourcePosition(file, start_line, start_column)

The variable file does not seem to be defined.

The variable start_column does not seem to be defined.

The variable start_line does not seem to be defined.

        if end_line or (end_column and end_column > start_column):

The variable end_column does not seem to be defined.

The variable end_line does not seem to be defined.

            end = SourcePosition(file, end_line if end_line else start_line,
                                 end_column)
        else:
            end = None

        return cls(start, end)

The variable end does not seem to be defined.

The variable start does not seem to be defined.

    @classmethod

The variable classmethod does not seem to be defined.

    def from_clang_range(cls, range):
        """
        Creates a SourceRange from a clang SourceRange object.

        :param range: A cindex.SourceRange object.
        """
        return cls.from_values(range.start.file.name,

The variable range does not seem to be defined.

                               range.start.line,
                               range.start.column,
                               range.end.line,
                               range.end.column)

    @classmethod

The variable classmethod does not seem to be defined.

    @enforce_signature

The variable enforce_signature does not seem to be defined.

    def from_absolute_position(cls,
                               file: str,

The variable str does not seem to be defined.

                               position_start: AbsolutePosition,

The variable AbsolutePosition does not seem to be defined.

                               position_end: (AbsolutePosition, None)=None):
        """
        Creates a SourceRange from a start and end positions.

        :param file:           Name of the file.
        :param position_start: Start of range given by AbsolutePosition.
        :param position_end:   End of range given by AbsolutePosition or None.
        """
        start = SourcePosition(file, position_start.line, position_start.column)

The variable file does not seem to be defined.

The variable position_start does not seem to be defined.

        end = None
        if position_end:

The variable position_end does not seem to be defined.

            end = SourcePosition(file, position_end.line, position_end.column)
        return cls(start, end)

The variable end does not seem to be defined.

The variable start does not seem to be defined.

    @property

The variable property does not seem to be defined.

    def file(self):
        return self.start.file

The variable self does not seem to be defined.

    def expand(self, file_contents):
        """
        Passes a new SourceRange that covers the same area of a file as this
        one would. All values of None get replaced with absolute values.

        values of None will be interpreted as follows:
        self.start.line is None:   -> 1
        self.start.column is None: -> 1
        self.end.line is None:     -> last line of file
        self.end.column is None:   -> last column of self.end.line

        :param file_contents: File contents of the applicable file
        :return:              TextRange with absolute values
        """
        tr = TextRange.expand(self, file_contents)

The variable file_contents does not seem to be defined.

The variable self does not seem to be defined.

        return SourceRange.from_values(self.file,
                                       tr.start.line,

The variable tr does not seem to be defined.

                                       tr.start.column,
                                       tr.end.line,
                                       tr.end.column)

    def __json__(self, use_relpath=False):
        _dict = get_public_members(self)

The variable self does not seem to be defined.

        if use_relpath:

The variable use_relpath does not seem to be defined.

            _dict['file'] = relpath(_dict['file'])

The variable _dict does not seem to be defined.

        return _dict