sphinx.domains.c.Symbol

class documentation

class Symbol: (source)

Undocumented

Static Method	`debug_print`	Undocumented
Method	`__copy__`	Undocumented
Method	`__deepcopy__`	Undocumented
Method	`__init__`	Undocumented
Method	`__setattr__`	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	`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	`declaration`	Undocumented
Instance Variable	`docname`	Undocumented
Instance Variable	`ident`	Undocumented
Instance Variable	`isRedeclaration`	Undocumented
Instance Variable	`line`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`siblingAbove`	Undocumented
Instance Variable	`siblingBelow`	Undocumented
Property	`children`	Undocumented
Property	`children_recurse_anon`	Undocumented
Method	`_add_function_params`	Undocumented
Method	`_add_symbols`	Undocumented
Method	`_assert_invariants`	Undocumented
Method	`_fill_empty`	Undocumented
Method	`_find_first_named_symbol`	Undocumented
Method	`_find_named_symbols`	Undocumented
Method	`_symbol_lookup`	Undocumented
Instance Variable	`_anonChildren`	Undocumented
Instance Variable	`_children`	Undocumented

@staticmethod
def debug_print(*args): (source) ¶

Undocumented

Parameters
*args:`Any`	Undocumented

def __copy__(self): (source) ¶

Undocumented

def __deepcopy__(self, memo): (source) ¶

Undocumented

def __init__(self, parent, ident, declaration, docname, line): (source) ¶

Undocumented

Parameters
parent:`Symbol`	Undocumented
ident:`ASTIdentifier`	Undocumented
declaration:`ASTDeclaration\|None`	Undocumented
docname:`str\|None`	Undocumented
line:`int\|None`	Undocumented

def __setattr__(self, key, value): (source) ¶

Undocumented

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

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

Undocumented

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

def add_name(self, nestedName): (source) ¶

Undocumented

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

def clear_doc(self, docname): (source) ¶

Undocumented

Parameters
docname:`str`	Undocumented

def direct_lookup(self, key): (source) ¶

Undocumented

Parameters
key:`LookupKey`	Undocumented
Returns
`Symbol\|None`	Undocumented

def dump(self, indent): (source) ¶

Undocumented

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

def find_declaration(self, nestedName, typ, matchSelf, recurseInAnon): (source) ¶

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
typ:`str`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
Returns
`Symbol\|None`	Undocumented

def find_identifier(self, ident, matchSelf, recurseInAnon, searchInSiblings): (source) ¶

Undocumented

Parameters
ident:`ASTIdentifier`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`Symbol\|None`	Undocumented

def get_all_symbols(self): (source) ¶

Undocumented

Returns
`Iterator[Symbol]`	Undocumented

def get_full_nested_name(self): (source) ¶

Undocumented

Returns
`ASTNestedName`	Undocumented

def get_lookup_key(self): (source) ¶

Undocumented

Returns
`LookupKey`	Undocumented

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

Undocumented

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

def remove(self): (source) ¶

Undocumented

def to_string(self, indent): (source) ¶

Undocumented

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

debug_indent: int = (source) ¶

Undocumented

debug_indent_string: str = (source) ¶

Undocumented

debug_lookup: bool = (source) ¶

Undocumented

debug_show_tree: bool = (source) ¶

Undocumented

declaration = (source) ¶

Undocumented

docname = (source) ¶

Undocumented

ident = (source) ¶

Undocumented

isRedeclaration: bool = (source) ¶

Undocumented

line = (source) ¶

Undocumented

parent = (source) ¶

Undocumented

siblingAbove: Symbol = (source) ¶

Undocumented

siblingBelow: Symbol = (source) ¶

Undocumented

@property
children: Iterator[Symbol] = (source) ¶

Undocumented

@property
children_recurse_anon: Iterator[Symbol] = (source) ¶

Undocumented

def _add_function_params(self): (source) ¶

Undocumented

def _add_symbols(self, nestedName, declaration, docname, line): (source) ¶

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
declaration:`ASTDeclaration\|None`	Undocumented
docname:`str\|None`	Undocumented
line:`int\|None`	Undocumented
Returns
`Symbol`	Undocumented

def _assert_invariants(self): (source) ¶

Undocumented

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

Undocumented

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

def _find_first_named_symbol(self, ident, matchSelf, recurseInAnon): (source) ¶

Undocumented

Parameters
ident:`ASTIdentifier`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
Returns
`Symbol\|None`	Undocumented

def _find_named_symbols(self, ident, matchSelf, recurseInAnon, searchInSiblings): (source) ¶

Undocumented

Parameters
ident:`ASTIdentifier`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`Iterator[Symbol]`	Undocumented

def _symbol_lookup(self, nestedName, onMissingQualifiedSymbol, ancestorLookupType, matchSelf, recurseInAnon, searchInSiblings): (source) ¶

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
onMissingQualifiedSymbol:`Callable[[Symbol, ASTIdentifier], Symbol\|None]`	Undocumented
ancestorLookupType:`str\|None`	Undocumented
matchSelf:`bool`	Undocumented
recurseInAnon:`bool`	Undocumented
searchInSiblings:`bool`	Undocumented
Returns
`SymbolLookupResult\|None`	Undocumented

_anonChildren: list[Symbol] = (source) ¶

Undocumented

_children: list[Symbol] = (source) ¶

Undocumented