webkitpy.style.checkers.cpp._FunctionState Class Reference

Inheritance diagram for webkitpy.style.checkers.cpp._FunctionState:

Public Member Functions
def	__init__ (self, min_confidence)
def	begin (self, function_name, function_name_start_position, body_start_position, end_position, parameter_start_position, parameter_end_position, clean_lines)
def	modifiers_and_return_type (self)
def	is_virtual (self)
def	parameter_list (self)
def	count (self, line_number)
def	check (self, error, line_number)
def	end (self)

Public Attributes
	min_confidence
	current_function
	in_a_function
	lines_in_function
	body_start_position
	end_position
	function_name_start_position
	is_declaration
	parameter_start_position
	parameter_end_position
	is_final
	is_override
	is_pure

Detailed Description

Tracks current function name and the number of lines in its body.

Attributes:
  min_confidence: The minimum confidence level to use while checking style.

Constructor & Destructor Documentation

__init__()

def webkitpy.style.checkers.cpp._FunctionState.__init__	(		self,
			min_confidence
	)

Member Function Documentation

begin()

def webkitpy.style.checkers.cpp._FunctionState.begin	(		self,
			function_name,
			function_name_start_position,
			body_start_position,
			end_position,
			parameter_start_position,
			parameter_end_position,
			clean_lines
	)

Start analyzing function body.

Args:
    function_name: The name of the function being tracked.
    function_name_start_position: Position in elided where the function name starts.
    body_start_position: Position in elided of the { or the ; for a prototype.
    end_position: Position in elided just after the final } (or ; is.
    parameter_start_position: Position in elided of the '(' for the parameters.
    parameter_end_position: Position in elided just after the ')' for the parameters.
    clean_lines: A CleansedLines instance containing the file.

check()

def webkitpy.style.checkers.cpp._FunctionState.check	(		self,
			error,
			line_number
	)

Report if too many lines in function body.

Args:
  error: The function to call with any errors found.
  line_number: The number of the line to check.

count()

def webkitpy.style.checkers.cpp._FunctionState.count	(		self,
			line_number
	)

Count line in current function body.

end()

def webkitpy.style.checkers.cpp._FunctionState.end

(

self

)

Stop analyzing function body.

is_virtual()

def webkitpy.style.checkers.cpp._FunctionState.is_virtual

(

self

)

modifiers_and_return_type()

def webkitpy.style.checkers.cpp._FunctionState.modifiers_and_return_type

(

self

)

Returns the modifiers and the return type.

parameter_list()

def webkitpy.style.checkers.cpp._FunctionState.parameter_list

(

self

)

Member Data Documentation

body_start_position

webkitpy.style.checkers.cpp._FunctionState.body_start_position

current_function

webkitpy.style.checkers.cpp._FunctionState.current_function

end_position

webkitpy.style.checkers.cpp._FunctionState.end_position

function_name_start_position

webkitpy.style.checkers.cpp._FunctionState.function_name_start_position

in_a_function

webkitpy.style.checkers.cpp._FunctionState.in_a_function

is_declaration

webkitpy.style.checkers.cpp._FunctionState.is_declaration

is_final

webkitpy.style.checkers.cpp._FunctionState.is_final

is_override

webkitpy.style.checkers.cpp._FunctionState.is_override

is_pure

webkitpy.style.checkers.cpp._FunctionState.is_pure

lines_in_function

webkitpy.style.checkers.cpp._FunctionState.lines_in_function

min_confidence

webkitpy.style.checkers.cpp._FunctionState.min_confidence

parameter_end_position

webkitpy.style.checkers.cpp._FunctionState.parameter_end_position

parameter_start_position

webkitpy.style.checkers.cpp._FunctionState.parameter_start_position

---

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

• Tools/Scripts/webkitpy/style/checkers/cpp.py