cpplint.NestingState Class Reference

Inheritance diagram for cpplint.NestingState:

Collaboration diagram for cpplint.NestingState:

Public Member Functions
def	__init__ (self)
def	SeenOpenBrace (self)
def	InNamespaceBody (self)
def	InExternC (self)
def	InClassDeclaration (self)
def	InAsmBlock (self)
def	InTemplateArgumentList (self, clean_lines, linenum, pos)
def	UpdatePreprocessor (self, line)
def	Update (self, filename, clean_lines, linenum, error)
def	InnermostClass (self)
def	CheckCompletedBlocks (self, filename, error)

Public Attributes
	stack
	previous_stack_top
	pp_stack

Detailed Description

Holds states related to parsing braces.

Definition at line 2515 of file cpplint.py.

Constructor & Destructor Documentation

__init__()

def cpplint.NestingState.__init__

(

self

)

Definition at line 2518 of file cpplint.py.

Member Function Documentation

CheckCompletedBlocks()

def cpplint.NestingState.CheckCompletedBlocks	(		self,
			filename,
			error
	)

Checks that all classes and namespaces have been completely parsed.

Call this when all lines in a file have been processed.
Args:
  filename: The name of the current file.
  error: The function to call with any errors found.

Definition at line 2867 of file cpplint.py.

InAsmBlock()

def cpplint.NestingState.InAsmBlock

(

self

)

Check if we are currently one level inside an inline ASM block.

Returns:
  True if the top of the stack is a block containing inline ASM.

Definition at line 2574 of file cpplint.py.

InClassDeclaration()

def cpplint.NestingState.InClassDeclaration

(

self

)

Check if we are currently one level inside a class or struct declaration.

Returns:
  True if top of the stack is a class/struct, False otherwise.

Definition at line 2566 of file cpplint.py.

InExternC()

def cpplint.NestingState.InExternC

(

self

)

Check if we are currently one level inside an 'extern "C"' block.

Returns:
  True if top of the stack is an extern block, False otherwise.

Definition at line 2558 of file cpplint.py.

InNamespaceBody()

def cpplint.NestingState.InNamespaceBody

(

self

)

Check if we are currently one level inside a namespace body.

Returns:
  True if top of the stack is a namespace block, False otherwise.

Definition at line 2550 of file cpplint.py.

InnermostClass()

def cpplint.NestingState.InnermostClass

(

self

)

Get class info on the top of the stack.

Returns:
  A _ClassInfo object if we are inside a class, or None otherwise.

Definition at line 2855 of file cpplint.py.

InTemplateArgumentList()

def cpplint.NestingState.InTemplateArgumentList	(		self,
			clean_lines,
			linenum,
			pos
	)

Check if current position is inside template argument list.

Args:
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  pos: position just after the suspected template argument.
Returns:
  True if (linenum, pos) is inside template arguments.

Definition at line 2582 of file cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

SeenOpenBrace()

def cpplint.NestingState.SeenOpenBrace

(

self

)

Check if we have seen the opening brace for the innermost block.

Returns:
  True if we have seen the opening brace, False if the innermost
  block is still expecting an opening brace.

Definition at line 2541 of file cpplint.py.

Here is the caller graph for this function:

Update()

def cpplint.NestingState.Update	(		self,
			filename,
			clean_lines,
			linenum,
			error
	)

Update nesting state with current line.

Args:
  filename: The name of the current file.
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  error: The function to call with any errors found.

Definition at line 2691 of file cpplint.py.

Here is the call graph for this function:

UpdatePreprocessor()

def cpplint.NestingState.UpdatePreprocessor	(		self,
			line
	)

Update preprocessor stack.

We need to handle preprocessors due to classes like this:
  #ifdef SWIG
  struct ResultDetailsPageElementExtensionPoint {
  #else
  struct ResultDetailsPageElementExtensionPoint : public Extension {
  #endif

We make the following assumptions (good enough for most files):
- Preprocessor condition evaluates to true from #if up to first
  #else/#elif/#endif.

- Preprocessor condition evaluates to false from #else/#elif up
  to #endif.  We still perform lint checks on these lines, but
  these do not affect nesting stack.

Args:
  line: current line to check.

Definition at line 2634 of file cpplint.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

pp_stack

cpplint.NestingState.pp_stack

Definition at line 2539 of file cpplint.py.

previous_stack_top

cpplint.NestingState.previous_stack_top

Definition at line 2536 of file cpplint.py.

stack

cpplint.NestingState.stack

Definition at line 2525 of file cpplint.py.

---

The documentation for this class was generated from the following file:

• cpplint.py