Class _IncludeState

tools/cpplint.py:1252–1426

Tracks line numbers for includes, and the order in which includes appear. include_list contains list of lists of (header, line number) pairs. It's a lists of lists rather than just one flat list to make it easier to update across preprocessor boundaries. Call CheckNextIncludeOrder(

class _IncludeState:
    """Tracks line numbers for includes, and the order in which includes appear.

    include_list contains list of lists of (header, line number) pairs.
    It's a lists of lists rather than just one flat list to make it
    easier to update across preprocessor boundaries.

    Call CheckNextIncludeOrder() once for each header in the file, passing
    in the type constants defined above. Calls in an illegal order will
    raise an _IncludeError with an appropriate error message.

    """

    # self._section will move monotonically through this set. If it ever
    # needs to move backwards, CheckNextIncludeOrder will raise an error.
    _INITIAL_SECTION = 0
    _MY_H_SECTION = 1
    _OTHER_H_SECTION = 2
    _C_SECTION = 3
    _CPP_SECTION = 4
    _OTHER_SYS_SECTION = 5

    _TYPE_NAMES = {
        _C_SYS_HEADER: "C system header",
        _CPP_SYS_HEADER: "C++ system header",
        _OTHER_SYS_HEADER: "other system header",
        _LIKELY_MY_HEADER: "header this file implements",
        _POSSIBLE_MY_HEADER: "header this file may implement",
        _OTHER_HEADER: "other header",
    }
    _SECTION_NAMES = {
        _INITIAL_SECTION: "... nothing. (This can't be an error.)",
        _MY_H_SECTION: "a header this file implements",
        _OTHER_H_SECTION: "other header",
        _C_SECTION: "C system header",
        _CPP_SECTION: "C++ system header",
        _OTHER_SYS_SECTION: "other system header",
    }

    def __init__(self):
        self.include_list = [[]]
        self._section = None
        self._last_header = None
        self.ResetSection("")

    def FindHeader(self, header):
        """Check if a header has already been included.

        Args:
          header: header to check.
        Returns:
          Line number of previous occurrence, or -1 if the header has not
          been seen before.
        """
        for section_list in self.include_list:
            for f in section_list:
                if f[0] == header:
                    return f[1]