sphinx.domains.cpp.Symbol

class documentation

class Symbol:

Undocumented

Static Method	`debug_print`	Undocumented
Method	`__copy__`	Undocumented
Method	`__deepcopy__`	Undocumented
Method	`__init__`	Undocumented
Method	`__setattr__`	Undocumented
Method	`_add_symbols`	Undocumented
Method	`_add_template_and_function_params`	Undocumented
Method	`_assert_invariants`	Undocumented
Method	`_fill_empty`	Undocumented
Method	`_find_first_named_symbol`	Undocumented
Method	`_find_named_symbols`	Undocumented
Method	`_symbol_lookup`	Undocumented
Method	`add_declaration`	Undocumented
Method	`add_name`	Undocumented
Method	`clear_doc`	Undocumented
Method	`direct_lookup`	Undocumented
Method	`dump`	Undocumented
Method	`find_declaration`	Undocumented
Method	`find_identifier`	Undocumented
Method	`find_name`	Undocumented
Method	`get_all_symbols`	Undocumented
Method	`get_full_nested_name`	Undocumented
Method	`get_lookup_key`	Undocumented
Method	`merge_with`	Undocumented
Method	`remove`	Undocumented
Method	`to_string`	Undocumented
Class Variable	`debug_indent`	Undocumented
Class Variable	`debug_indent_string`	Undocumented
Class Variable	`debug_lookup`	Undocumented
Class Variable	`debug_show_tree`	Undocumented
Instance Variable	`_anonChildren`	Undocumented
Instance Variable	`_children`	Undocumented
Instance Variable	`declaration`	Undocumented
Instance Variable	`docname`	Undocumented
Instance Variable	`identOrOp`	Undocumented
Instance Variable	`isRedeclaration`	Undocumented
Instance Variable	`line`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`siblingAbove`	Undocumented
Instance Variable	`siblingBelow`	Undocumented
Instance Variable	`templateArgs`	Undocumented
Instance Variable	`templateParams`	Undocumented
Property	`children_recurse_anon`	Undocumented

@staticmethod
def debug_print(*args):

Undocumented

Parameters
*args:`Any`	Undocumented

def __copy__(self):

Undocumented

def __deepcopy__(self, memo):

Undocumented

def __init__(self, parent, identOrOp, templateParams, templateArgs, declaration, docname, line):

Undocumented

Parameters
parent:`Symbol`	Undocumented
identOrOp:`Union[ASTIdentifier, ASTOperator]`	Undocumented
templateParams:`Union[ASTTemplateParams, ASTTemplateIntroduction]`	Undocumented
templateArgs:`Any`	Undocumented
declaration:`ASTDeclaration`	Undocumented
docname:`str`	Undocumented
line:`int`	Undocumented

def __setattr__(self, key, value):

Undocumented

Parameters
key:`str`	Undocumented
value:`Any`	Undocumented

def _add_symbols(self, nestedName, templateDecls, declaration, docname, line):

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
templateDecls:`List[Any]`	Undocumented
declaration:`ASTDeclaration`	Undocumented
docname:`str`	Undocumented
line:`int`	Undocumented
Returns
`Symbol`	Undocumented

def _add_template_and_function_params(self):

Undocumented

def _assert_invariants(self):

Undocumented

def _fill_empty(self, declaration, docname, line):

Undocumented

Parameters
declaration:`ASTDeclaration`	Undocumented
docname:`str`	Undocumented
line:`int`	Undocumented

def _find_first_named_symbol(self, identOrOp, templateParams, templateArgs, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs):

Undocumented

Parameters
identOrOp:`Union[ASTIdentifier, ASTOperator]`	Undocumented
templateParams:`Any`	Undocumented
templateArgs:`ASTTemplateArgs`	Undocumented
templateShorthand:`bool`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
correctPrimaryTemplateArgs:`bool`	Undocumented
Returns
`Symbol`	Undocumented

def _find_named_symbols(self, identOrOp, templateParams, templateArgs, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs, searchInSiblings):

Undocumented

Parameters
identOrOp:`Union[ASTIdentifier, ASTOperator]`	Undocumented
templateParams:`Any`	Undocumented
templateArgs:`ASTTemplateArgs`	Undocumented
templateShorthand:`bool`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
correctPrimaryTemplateArgs:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`Iterator[Symbol]`	Undocumented

def _symbol_lookup(self, nestedName, templateDecls, onMissingQualifiedSymbol, strictTemplateParamArgLists, ancestorLookupType, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs, searchInSiblings):

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
templateDecls:`List[Any]`	Undocumented
onMissingQualifiedSymbol:`Callable[[Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs], Symbol]`	Undocumented
strictTemplateParamArgLists:`bool`	Undocumented
ancestorLookupType:`str`	Undocumented
templateShorthand:`bool`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
correctPrimaryTemplateArgs:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`SymbolLookupResult`	Undocumented

def add_declaration(self, declaration, docname, line):

Undocumented

Parameters
declaration:`ASTDeclaration`	Undocumented
docname:`str`	Undocumented
line:`int`	Undocumented
Returns
`Symbol`	Undocumented

def add_name(self, nestedName, templatePrefix=None):

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
templatePrefix:`ASTTemplateDeclarationPrefix`	Undocumented
Returns
`Symbol`	Undocumented

def clear_doc(self, docname):

Undocumented

Parameters
docname:`str`	Undocumented

def direct_lookup(self, key):

Undocumented

Parameters
key:`LookupKey`	Undocumented
Returns
`Symbol`	Undocumented

def dump(self, indent):

Undocumented

Parameters
indent:`int`	Undocumented
Returns
`str`	Undocumented

def find_declaration(self, declaration, typ, templateShorthand, matchSelf, recurseInAnon):

Undocumented

Parameters
declaration:`ASTDeclaration`	Undocumented
typ:`str`	Undocumented
templateShorthand:`bool`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
Returns
`Symbol`	Undocumented

def find_identifier(self, identOrOp, matchSelf, recurseInAnon, searchInSiblings):

Undocumented

Parameters
identOrOp:`Union[ASTIdentifier, ASTOperator]`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`Symbol`	Undocumented

def find_name(self, nestedName, templateDecls, typ, templateShorthand, matchSelf, recurseInAnon, searchInSiblings):

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
templateDecls:`List[Any]`	Undocumented
typ:`str`	Undocumented
templateShorthand:`bool`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`Tuple[List[Symbol], str]`	Undocumented

def get_all_symbols(self):

Undocumented

Returns
`Iterator[Any]`	Undocumented

def get_full_nested_name(self):

Undocumented

Returns
`ASTNestedName`	Undocumented

def get_lookup_key(self):

Undocumented

Returns
`LookupKey`	Undocumented

def merge_with(self, other, docnames, env):

Undocumented

Parameters
other:`Symbol`	Undocumented
docnames:`List[str]`	Undocumented
env:`BuildEnvironment`	Undocumented

def remove(self):

Undocumented

def to_string(self, indent):

Undocumented

Parameters
indent:`int`	Undocumented
Returns
`str`	Undocumented

debug_indent: int =

Undocumented

debug_indent_string: str =

Undocumented

debug_lookup: bool =

Undocumented

debug_show_tree: bool =

Undocumented

_anonChildren: List[Symbol] =

Undocumented

_children =

Undocumented

declaration =

Undocumented

docname =

Undocumented

identOrOp =

Undocumented

isRedeclaration: bool =

Undocumented

line =

Undocumented

parent =

Undocumented

siblingAbove: Symbol =

Undocumented

siblingBelow: Symbol =

Undocumented

templateArgs =

Undocumented

templateParams =

Undocumented

@property
children_recurse_anon: Generator[Symbol, None, None] =

Undocumented