sphinx.util.cfamily.BaseParser

class documentation

class BaseParser: (source)

Known subclasses: sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

Method	`__init__`	Undocumented
Method	`assert_end`	Undocumented
Method	`fail`	Undocumented
Method	`match`	Undocumented
Method	`read_rest`	Undocumented
Method	`skip_string`	Undocumented
Method	`skip_string_and_ws`	Undocumented
Method	`skip_word`	Undocumented
Method	`skip_word_and_ws`	Undocumented
Method	`skip_ws`	Undocumented
Method	`status`	Undocumented
Method	`warn`	Undocumented
Instance Variable	`allowFallbackExpressionParsing`	Undocumented
Instance Variable	`config`	Undocumented
Instance Variable	`definition`	Undocumented
Instance Variable	`end`	Undocumented
Instance Variable	`last_match`	Undocumented
Instance Variable	`location`	Undocumented
Instance Variable	`otherErrors`	Undocumented
Instance Variable	`pos`	Undocumented
Property	`current_char`	Undocumented
Property	`eof`	Undocumented
Property	`id_attributes`	Undocumented
Property	`language`	Undocumented
Property	`matched_text`	Undocumented
Property	`paren_attributes`	Undocumented
Method	`_make_multi_error`	Undocumented
Method	`_parse_attribute`	Undocumented
Method	`_parse_attribute_list`	Undocumented
Method	`_parse_balanced_token_seq`	Undocumented
Method	`_parse_paren_expression_list`	Undocumented
Instance Variable	`_previous_state`	Undocumented

def __init__(self, definition, *, location, config): (source) ¶

Undocumented

Parameters
definition:`str`	Undocumented
location:`(nodes.Node\|tuple[str, int])\|str`	Undocumented
config:`Config`	Undocumented

def assert_end(self, *, allowSemicolon=False): (source) ¶

Undocumented

Parameters
allowSemicolon:`bool`	Undocumented

def fail(self, msg): (source) ¶

Undocumented

Parameters
msg:`str`	Undocumented

def match(self, regex): (source) ¶

Undocumented

Parameters
regex:`re.Pattern`	Undocumented
Returns
`bool`	Undocumented

def read_rest(self): (source) ¶

Undocumented

Returns
`str`	Undocumented

def skip_string(self, string): (source) ¶

Undocumented

Parameters
string:`str`	Undocumented
Returns
`bool`	Undocumented

def skip_string_and_ws(self, string): (source) ¶

Undocumented

Parameters
string:`str`	Undocumented
Returns
`bool`	Undocumented

def skip_word(self, word): (source) ¶

Undocumented

Parameters
word:`str`	Undocumented
Returns
`bool`	Undocumented

def skip_word_and_ws(self, word): (source) ¶

Undocumented

Parameters
word:`str`	Undocumented
Returns
`bool`	Undocumented

def skip_ws(self): (source) ¶

Undocumented

Returns
`bool`	Undocumented

def status(self, msg): (source) ¶

Undocumented

Parameters
msg:`str`	Undocumented

def warn(self, msg): (source) ¶

Undocumented

Parameters
msg:`str`	Undocumented

allowFallbackExpressionParsing: bool = (source) ¶

Undocumented

config = (source) ¶

Undocumented

definition = (source) ¶

Undocumented

end = (source) ¶

Undocumented

last_match = (source) ¶

Undocumented

location = (source) ¶

Undocumented

otherErrors: list = (source) ¶

Undocumented

pos = (source) ¶

overridden in sphinx.domains.cpp.DefinitionParser

Undocumented

@property
current_char: str = (source) ¶

Undocumented

@property
eof: bool = (source) ¶

Undocumented

@property
id_attributes = (source) ¶

overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

@property
language: str = (source) ¶

overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

@property
matched_text: str = (source) ¶

Undocumented

@property
paren_attributes = (source) ¶

overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

def _make_multi_error(self, errors, header): (source) ¶

Undocumented

Parameters
errors:`list[Any]`	Undocumented
header:`str`	Undocumented
Returns
`DefinitionError`	Undocumented

def _parse_attribute(self): (source) ¶

Undocumented

Returns
`ASTAttribute\|None`	Undocumented

def _parse_attribute_list(self): (source) ¶

Undocumented

Returns
`ASTAttributeList`	Undocumented

def _parse_balanced_token_seq(self, end): (source) ¶

Undocumented

Parameters
end:`list[str]`	Undocumented
Returns
`str`	Undocumented

def _parse_paren_expression_list(self): (source) ¶

overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

Returns
`ASTBaseParenExprList\|None`	Undocumented

_previous_state = (source) ¶

Undocumented