List of all members.
Detailed Description
Tracks line numbers for includes, and the order in which includes appear.
As a dict, an _IncludeState object serves as a mapping between include
filename and line number on which that file was included.
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.
Member Function Documentation
def cpplint::_IncludeState::CanonicalizeAlphabeticalOrder |
( |
|
self, |
|
|
|
header_path | |
|
) |
| | |
Returns a path canonicalized for alphabetical comparisson.
- replaces "-" with "_" so they both cmp the same.
- removes '-inl' since we don't require them to be after the main header.
- lowercase everything, just in case.
Args:
header_path: Path to be canonicalized.
Returns:
Canonicalized path.
def cpplint::_IncludeState::CanonicalizeAlphabeticalOrder |
( |
|
self, |
|
|
|
header_path | |
|
) |
| | |
Returns a path canonicalized for alphabetical comparisson.
- replaces "-" with "_" so they both cmp the same.
- removes '-inl' since we don't require them to be after the main header.
- lowercase everything, just in case.
Args:
header_path: Path to be canonicalized.
Returns:
Canonicalized path.
def cpplint::_IncludeState::CheckNextIncludeOrder |
( |
|
self, |
|
|
|
header_type | |
|
) |
| | |
Returns a non-empty error message if the next header is out of order.
This function also updates the internal state to be ready to check
the next include.
Args:
header_type: One of the _XXX_HEADER constants defined above.
Returns:
The empty string if the header is in the right order, or an
error message describing what's wrong.
def cpplint::_IncludeState::CheckNextIncludeOrder |
( |
|
self, |
|
|
|
header_type | |
|
) |
| | |
Returns a non-empty error message if the next header is out of order.
This function also updates the internal state to be ready to check
the next include.
Args:
header_type: One of the _XXX_HEADER constants defined above.
Returns:
The empty string if the header is in the right order, or an
error message describing what's wrong.
def cpplint::_IncludeState::IsInAlphabeticalOrder |
( |
|
self, |
|
|
|
header_path | |
|
) |
| | |
Check if a header is in alphabetical order with the previous header.
Args:
header_path: Header to be checked.
Returns:
Returns true if the header is in alphabetical order.
def cpplint::_IncludeState::IsInAlphabeticalOrder |
( |
|
self, |
|
|
|
header_path | |
|
) |
| | |
Check if a header is in alphabetical order with the previous header.
Args:
header_path: Header to be checked.
Returns:
Returns true if the header is in alphabetical order.
The documentation for this class was generated from the following files:
- C:/Users/anan/Desktop/zukeralgorithm/NussinovAlgorithm/cpplint.py
- C:/Users/anan/Desktop/zukeralgorithm/ZukerAlgorithm/cpplint.py