cpp.ast.Function Class Reference

Inheritance diagram for cpp.ast.Function:

Public Member Functions
def	__init__ (self, start, end, name, return_type, parameters, modifiers, templated_types, body, namespace)
def	IsDeclaration (self)
def	IsDefinition (self)
def	IsExportable (self)
def	Requires (self, node)
def	__str__ (self)
Public Member Functions inherited from cpp.ast._GenericDeclaration
def	__init__ (self, start, end, name, namespace)
def	FullName (self)
Public Member Functions inherited from cpp.ast.Node
def	__init__ (self, start, end)
def	IsDeclaration (self)
def	IsDefinition (self)
def	IsExportable (self)
def	Requires (self, node)
def	XXX__str__ (self)
def	__repr__ (self)

Public Attributes
	return_type
	parameters
	modifiers
	body
	templated_types
Public Attributes inherited from cpp.ast._GenericDeclaration
	name
	namespace
Public Attributes inherited from cpp.ast.Node
	start
	end

Detailed Description

Definition at line 358 of file ast.py.

Constructor & Destructor Documentation

__init__()

def cpp.ast.Function.__init__	(		self,
			start,
			end,
			name,
			return_type,
			parameters,
			modifiers,
			templated_types,
			body,
			namespace
	)

Reimplemented from cpp.ast._GenericDeclaration.

Reimplemented in cpp.ast.Method.

Definition at line 359 of file ast.py.

               modifiers, templated_types, body, namespace):
    _GenericDeclaration.__init__(self, start, end, name, namespace)
    converter = TypeConverter(namespace)
    self.return_type = converter.CreateReturnType(return_type)
    self.parameters = converter.ToParameters(parameters)
    self.modifiers = modifiers
    self.body = body
    self.templated_types = templated_types
 

Member Function Documentation

__str__()

def cpp.ast.Function.__str__

(

self

)

Definition at line 389 of file ast.py.

  def __str__(self):
    # TODO(nnorwitz): add templated_types.
    suffix = ('%s %s(%s), 0x%02x, %s' %
              (self.return_type, self.name, self.parameters,
               self.modifiers, self.body))
    return self._TypeStringHelper(suffix)
 
 

IsDeclaration()

def cpp.ast.Function.IsDeclaration

(

self

)

Returns bool if this node is a declaration.

Reimplemented from cpp.ast.Node.

Definition at line 369 of file ast.py.

  def IsDeclaration(self):
    return self.body is None
 

IsDefinition()

def cpp.ast.Function.IsDefinition

(

self

)

Returns bool if this node is a definition.

Reimplemented from cpp.ast.Node.

Definition at line 372 of file ast.py.

  def IsDefinition(self):
    return self.body is not None
 

IsExportable()

def cpp.ast.Function.IsExportable

(

self

)

Returns bool if this node exportable from a header file.

Reimplemented from cpp.ast.Node.

Definition at line 375 of file ast.py.

  def IsExportable(self):
    if self.return_type and 'static' in self.return_type.modifiers:
      return False
    return None not in self.namespace
 

Requires()

def cpp.ast.Function.Requires	(		self,
			node
	)

Does this AST node require the definition of the node passed in?

Reimplemented from cpp.ast.Node.

Definition at line 380 of file ast.py.

  def Requires(self, node):
    if self.parameters:
      # TODO(nnorwitz): parameters are tokens, do name comparison.
      for p in self.parameters:
        if p.name == node.name:
          return True
    # TODO(nnorwitz): search in body too.
    return False
 

Member Data Documentation

body

cpp.ast.Function.body

Definition at line 366 of file ast.py.

modifiers

cpp.ast.Function.modifiers

Definition at line 365 of file ast.py.

parameters

cpp.ast.Function.parameters

Definition at line 364 of file ast.py.

return_type

cpp.ast.Function.return_type

Definition at line 363 of file ast.py.

templated_types

cpp.ast.Function.templated_types

Definition at line 367 of file ast.py.

---

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

• /media/home/debian/src/github/tesseract-ocr/tesseract/unittest/third_party/googletest/googlemock/scripts/generator/cpp/ast.py