class documentation

class Symbol:

View In Hierarchy

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 _anon​Children Undocumented
Instance Variable ​_children Undocumented
Instance Variable declaration Undocumented
Instance Variable docname Undocumented
Instance Variable ident​Or​Op Undocumented
Instance Variable is​Redeclaration Undocumented
Instance Variable line Undocumented
Instance Variable parent Undocumented
Instance Variable sibling​Above Undocumented
Instance Variable sibling​Below Undocumented
Instance Variable template​Args Undocumented
Instance Variable template​Params Undocumented
Property children​_recurse​_anon Undocumented
@staticmethod
def debug_print(*args):

Undocumented

Parameters
*args:AnyUndocumented
def __copy__(self):

Undocumented

def __deepcopy__(self, memo):

Undocumented

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

Undocumented

Parameters
parent:SymbolUndocumented
ident​Or​Op:Union[ASTIdentifier, ASTOperator]Undocumented
template​Params:Union[ASTTemplateParams, ASTTemplateIntroduction]Undocumented
template​Args:AnyUndocumented
declaration:ASTDeclarationUndocumented
docname:strUndocumented
line:intUndocumented
def __setattr__(self, key, value):

Undocumented

Parameters
key:strUndocumented
value:AnyUndocumented
def _add_symbols(self, nestedName, templateDecls, declaration, docname, line):

Undocumented

Parameters
nested​Name:ASTNestedNameUndocumented
template​Decls:List[Any]Undocumented
declaration:ASTDeclarationUndocumented
docname:strUndocumented
line:intUndocumented
Returns
SymbolUndocumented
def _add_template_and_function_params(self):

Undocumented

def _assert_invariants(self):

Undocumented

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

Undocumented

Parameters
declaration:ASTDeclarationUndocumented
docname:strUndocumented
line:intUndocumented
def _find_first_named_symbol(self, identOrOp, templateParams, templateArgs, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs):

Undocumented

Parameters
ident​Or​Op:Union[ASTIdentifier, ASTOperator]Undocumented
template​Params:AnyUndocumented
template​Args:ASTTemplateArgsUndocumented
template​Shorthand:boolUndocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
correct​Primary​Template​Args:boolUndocumented
Returns
SymbolUndocumented
def _find_named_symbols(self, identOrOp, templateParams, templateArgs, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs, searchInSiblings):

Undocumented

Parameters
ident​Or​Op:Union[ASTIdentifier, ASTOperator]Undocumented
template​Params:AnyUndocumented
template​Args:ASTTemplateArgsUndocumented
template​Shorthand:boolUndocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
correct​Primary​Template​Args:boolUndocumented
search​In​Siblings:boolUndocumented
Returns
Iterator[Symbol]Undocumented
def _symbol_lookup(self, nestedName, templateDecls, onMissingQualifiedSymbol, strictTemplateParamArgLists, ancestorLookupType, templateShorthand, matchSelf, recurseInAnon, correctPrimaryTemplateArgs, searchInSiblings):

Undocumented

Parameters
nested​Name:ASTNestedNameUndocumented
template​Decls:List[Any]Undocumented
on​Missing​Qualified​Symbol:Callable[[Symbol, Union[ASTIdentifier, ASTOperator], Any, ASTTemplateArgs], Symbol]Undocumented
strict​Template​Param​Arg​Lists:boolUndocumented
ancestor​Lookup​Type:strUndocumented
template​Shorthand:boolUndocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
correct​Primary​Template​Args:boolUndocumented
search​In​Siblings:boolUndocumented
Returns
SymbolLookupResultUndocumented
def add_declaration(self, declaration, docname, line):

Undocumented

Parameters
declaration:ASTDeclarationUndocumented
docname:strUndocumented
line:intUndocumented
Returns
SymbolUndocumented
def add_name(self, nestedName, templatePrefix=None):

Undocumented

Parameters
nested​Name:ASTNestedNameUndocumented
template​Prefix:ASTTemplateDeclarationPrefixUndocumented
Returns
SymbolUndocumented
def clear_doc(self, docname):

Undocumented

Parameters
docname:strUndocumented
def direct_lookup(self, key):

Undocumented

Parameters
key:LookupKeyUndocumented
Returns
SymbolUndocumented
def dump(self, indent):

Undocumented

Parameters
indent:intUndocumented
Returns
strUndocumented
def find_declaration(self, declaration, typ, templateShorthand, matchSelf, recurseInAnon):

Undocumented

Parameters
declaration:ASTDeclarationUndocumented
typ:strUndocumented
template​Shorthand:boolUndocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
Returns
SymbolUndocumented
def find_identifier(self, identOrOp, matchSelf, recurseInAnon, searchInSiblings):

Undocumented

Parameters
ident​Or​Op:Union[ASTIdentifier, ASTOperator]Undocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
search​In​Siblings:boolUndocumented
Returns
SymbolUndocumented
def find_name(self, nestedName, templateDecls, typ, templateShorthand, matchSelf, recurseInAnon, searchInSiblings):

Undocumented

Parameters
nested​Name:ASTNestedNameUndocumented
template​Decls:List[Any]Undocumented
typ:strUndocumented
template​Shorthand:boolUndocumented
match​Self:boolUndocumented
recurse​In​Anon:boolUndocumented
search​In​Siblings:boolUndocumented
Returns
Tuple[List[Symbol], str]Undocumented
def get_all_symbols(self):

Undocumented

Returns
Iterator[Any]Undocumented
def get_full_nested_name(self):

Undocumented

Returns
ASTNestedNameUndocumented
def get_lookup_key(self):

Undocumented

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

Undocumented

Parameters
other:SymbolUndocumented
docnames:List[str]Undocumented
env:BuildEnvironmentUndocumented
def remove(self):

Undocumented

def to_string(self, indent):

Undocumented

Parameters
indent:intUndocumented
Returns
strUndocumented
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