sphinx.util.cfamily.BaseParser

class documentation

class BaseParser:

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

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method ​_make​_multi​_error Undocumented
Method ​_parse​_attribute Undocumented
Method ​_parse​_balanced​_token​_seq Undocumented
Method ​_parse​_paren​_expression​_list 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 ​_previous​_state Undocumented
Instance Variable allow​Fallback​Expression​Parsing Undocumented
Instance Variable config Undocumented
Instance Variable definition Undocumented
Instance Variable end Undocumented
Instance Variable last​_match Undocumented
Instance Variable location Undocumented
Instance Variable other​Errors 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
def __init__(self, definition, *, location, config):

Undocumented

Parameters
definition:strUndocumented
location:Union[nodes.Node, Tuple[str, int], str]Undocumented
config:ConfigUndocumented
def _make_multi_error(self, errors, header):

Undocumented

Parameters
errors:List[Any]Undocumented
header:strUndocumented
Returns
DefinitionErrorUndocumented
def _parse_attribute(self):

Undocumented

Returns
Optional[ASTAttribute]Undocumented
def _parse_balanced_token_seq(self, end):

Undocumented

Parameters
end:List[str]Undocumented
Returns
strUndocumented
def _parse_paren_expression_list(self):
overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

Returns
ASTBaseParenExprListUndocumented
def assert_end(self, *, allowSemicolon=False):

Undocumented

Parameters
allow​Semicolon:boolUndocumented
def fail(self, msg):

Undocumented

Parameters
msg:strUndocumented
def match(self, regex):

Undocumented

Parameters
regex:PatternUndocumented
Returns
boolUndocumented
def read_rest(self):

Undocumented

Returns
strUndocumented
def skip_string(self, string):

Undocumented

Parameters
string:strUndocumented
Returns
boolUndocumented
def skip_string_and_ws(self, string):

Undocumented

Parameters
string:strUndocumented
Returns
boolUndocumented
def skip_word(self, word):

Undocumented

Parameters
word:strUndocumented
Returns
boolUndocumented
def skip_word_and_ws(self, word):

Undocumented

Parameters
word:strUndocumented
Returns
boolUndocumented
def skip_ws(self):

Undocumented

Returns
boolUndocumented
def status(self, msg):

Undocumented

Parameters
msg:strUndocumented
def warn(self, msg):

Undocumented

Parameters
msg:strUndocumented
_previous_state =

Undocumented

allowFallbackExpressionParsing: bool =

Undocumented

config =

Undocumented

definition =

Undocumented

end =

Undocumented

last_match =

Undocumented

location =

Undocumented

otherErrors: list =

Undocumented

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

Undocumented

@property
current_char: str =

Undocumented

@property
eof: bool =

Undocumented

@property
id_attributes =
overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

@property
language: str =
overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented

@property
matched_text: str =

Undocumented

@property
paren_attributes =
overridden in sphinx.domains.c.DefinitionParser, sphinx.domains.cpp.DefinitionParser

Undocumented