sphinx.domains.cpp.DefinitionParser

class documentation

class DefinitionParser(BaseParser): (source)

Undocumented

Method	`parse_declaration`	Undocumented
Method	`parse_expression`	Undocumented
Method	`parse_namespace_object`	Undocumented
Method	`parse_xref_object`	Undocumented
Instance Variable	`pos`	Undocumented
Property	`id_attributes`	Undocumented
Property	`language`	Undocumented
Property	`paren_attributes`	Undocumented
Method	`_check_template_consistency`	Undocumented
Method	`_parse_assignment_expression`	Undocumented
Method	`_parse_braced_init_list`	Undocumented
Method	`_parse_cast_expression`	Undocumented
Method	`_parse_class`	Undocumented
Method	`_parse_concept`	Undocumented
Method	`_parse_conditional_expression_tail`	Undocumented
Method	`_parse_constant_expression`	Undocumented
Method	`_parse_decl_specs`	Undocumented
Method	`_parse_decl_specs_simple`	Just parse the simple ones.
Method	`_parse_declarator`	Undocumented
Method	`_parse_declarator_name_suffix`	Undocumented
Method	`_parse_enum`	Undocumented
Method	`_parse_enumerator`	Undocumented
Method	`_parse_expression`	Undocumented
Method	`_parse_expression_fallback`	Undocumented
Method	`_parse_expression_list_or_braced_init_list`	Undocumented
Method	`_parse_fold_or_paren_expression`	Undocumented
Method	`_parse_initializer`	Undocumented
Method	`_parse_initializer_clause`	Undocumented
Method	`_parse_initializer_list`	Undocumented
Method	`_parse_literal`	Undocumented
Method	`_parse_logical_or_expression`	Undocumented
Method	`_parse_nested_name`	Undocumented
Method	`_parse_operator`	Undocumented
Method	`_parse_parameters_and_qualifiers`	Undocumented
Method	`_parse_paren_expression_list`	Undocumented
Method	`_parse_postfix_expression`	Undocumented
Method	`_parse_primary_expression`	Undocumented
Method	`_parse_requires_clause`	Undocumented
Method	`_parse_simple_type_specifiers`	Undocumented
Method	`_parse_string`	Undocumented
Method	`_parse_template_argument_list`	Undocumented
Method	`_parse_template_declaration_prefix`	Undocumented
Method	`_parse_template_introduction`	Undocumented
Method	`_parse_template_parameter`	Undocumented
Method	`_parse_template_parameter_list`	Undocumented
Method	`_parse_trailing_type_spec`	Undocumented
Method	`_parse_type`	named=False\|'maybe'\|True: 'maybe' is e.g., for function objects which doesn't need to name the arguments
Method	`_parse_type_using`	Undocumented
Method	`_parse_type_with_init`	Undocumented
Method	`_parse_unary_expression`	Undocumented
Method	`_parse_union`	Undocumented

Inherited from BaseParser:

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
Property	`current_char`	Undocumented
Property	`eof`	Undocumented
Property	`matched_text`	Undocumented
Method	`_make_multi_error`	Undocumented
Method	`_parse_attribute`	Undocumented
Method	`_parse_attribute_list`	Undocumented
Method	`_parse_balanced_token_seq`	Undocumented
Instance Variable	`_previous_state`	Undocumented

def parse_declaration(self, objectType, directiveType): (source) ¶

Undocumented

Parameters
objectType:`str`	Undocumented
directiveType:`str`	Undocumented
Returns
`ASTDeclaration`	Undocumented

def parse_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression\|ASTType`	Undocumented

def parse_namespace_object(self): (source) ¶

Undocumented

Returns
`ASTNamespace`	Undocumented

def parse_xref_object(self): (source) ¶

Undocumented

Returns
`tuple[ASTNamespace\|ASTDeclaration, bool]`	Undocumented

pos = (source) ¶

overrides sphinx.util.cfamily.BaseParser.pos

Undocumented

@property
id_attributes = (source) ¶

overrides sphinx.util.cfamily.BaseParser.id_attributes

Undocumented

@property
language: str = (source) ¶

overrides sphinx.util.cfamily.BaseParser.language

Undocumented

@property
paren_attributes = (source) ¶

overrides sphinx.util.cfamily.BaseParser.paren_attributes

Undocumented

def _check_template_consistency(self, nestedName, templatePrefix, fullSpecShorthand, isMember=False): (source) ¶

Undocumented

Parameters
nestedName:`ASTNestedName`	Undocumented
templatePrefix:`ASTTemplateDeclarationPrefix`	Undocumented
fullSpecShorthand:`bool`	Undocumented
isMember:`bool`	Undocumented
Returns
`ASTTemplateDeclarationPrefix`	Undocumented

def _parse_assignment_expression(self, inTemplate): (source) ¶

Undocumented

Parameters
inTemplate:`bool`	Undocumented
Returns
`ASTExpression`	Undocumented

def _parse_braced_init_list(self): (source) ¶

Undocumented

Returns
`ASTBracedInitList`	Undocumented

def _parse_cast_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression`	Undocumented

def _parse_class(self): (source) ¶

Undocumented

Returns
`ASTClass`	Undocumented

def _parse_concept(self): (source) ¶

Undocumented

Returns
`ASTConcept`	Undocumented

def _parse_conditional_expression_tail(self, orExprHead, inTemplate): (source) ¶

Undocumented

Parameters
orExprHead:`ASTExpression`	Undocumented
inTemplate:`bool`	Undocumented
Returns
`ASTConditionalExpr\|None`	Undocumented

def _parse_constant_expression(self, inTemplate): (source) ¶

Undocumented

Parameters
inTemplate:`bool`	Undocumented
Returns
`ASTExpression`	Undocumented

def _parse_decl_specs(self, outer, typed=True): (source) ¶

Undocumented

Parameters
outer:`str`	Undocumented
typed:`bool`	Undocumented
Returns
`ASTDeclSpecs`	Undocumented

def _parse_decl_specs_simple(self, outer, typed): (source) ¶

Just parse the simple ones.

Parameters
outer:`str`	Undocumented
typed:`bool`	Undocumented
Returns
`ASTDeclSpecsSimple`	Undocumented

def _parse_declarator(self, named, paramMode, typed=True): (source) ¶

Undocumented

Parameters
named:`bool\|str`	Undocumented
paramMode:`str`	Undocumented
typed:`bool`	Undocumented
Returns
`ASTDeclarator`	Undocumented

def _parse_declarator_name_suffix(self, named, paramMode, typed): (source) ¶

Undocumented

Parameters
named:`bool\|str`	Undocumented
paramMode:`str`	Undocumented
typed:`bool`	Undocumented
Returns
`ASTDeclaratorNameParamQual\|ASTDeclaratorNameBitField`	Undocumented

def _parse_enum(self): (source) ¶

Undocumented

Returns
`ASTEnum`	Undocumented

def _parse_enumerator(self): (source) ¶

Undocumented

Returns
`ASTEnumerator`	Undocumented

def _parse_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression`	Undocumented

def _parse_expression_fallback(self, end, parser, allow=True): (source) ¶

Undocumented

Parameters
end:`list[str]`	Undocumented
parser:`Callable[[], ASTExpression]`	Undocumented
allow:`bool`	Undocumented
Returns
`ASTExpression`	Undocumented

def _parse_expression_list_or_braced_init_list(self): (source) ¶

Undocumented

Returns
`ASTParenExprList\|ASTBracedInitList`	Undocumented

def _parse_fold_or_paren_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression`	Undocumented

def _parse_initializer(self, outer=None, allowFallback=True): (source) ¶

Undocumented

Parameters
outer:`str`	Undocumented
allowFallback:`bool`	Undocumented
Returns
`ASTInitializer`	Undocumented

def _parse_initializer_clause(self): (source) ¶

Undocumented

Returns
`ASTExpression\|ASTBracedInitList`	Undocumented

def _parse_initializer_list(self, name, open, close): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
open:`str`	Undocumented
close:`str`	Undocumented
Returns
`tuple[list[ASTExpression\|ASTBracedInitList], bool]`	Undocumented

def _parse_literal(self): (source) ¶

Undocumented

Returns
`ASTLiteral`	Undocumented

def _parse_logical_or_expression(self, inTemplate): (source) ¶

Undocumented

Parameters
inTemplate:`bool`	Undocumented
Returns
`ASTExpression`	Undocumented

def _parse_nested_name(self, memberPointer=False): (source) ¶

Undocumented

Parameters
memberPointer:`bool`	Undocumented
Returns
`ASTNestedName`	Undocumented

def _parse_operator(self): (source) ¶

Undocumented

Returns
`ASTOperator`	Undocumented

def _parse_parameters_and_qualifiers(self, paramMode): (source) ¶

Undocumented

Parameters
paramMode:`str`	Undocumented
Returns
`ASTParametersQualifiers`	Undocumented

def _parse_paren_expression_list(self): (source) ¶

overrides sphinx.util.cfamily.BaseParser._parse_paren_expression_list

Undocumented

Returns
`ASTParenExprList`	Undocumented

def _parse_postfix_expression(self): (source) ¶

Undocumented

Returns
`ASTPostfixExpr`	Undocumented

def _parse_primary_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression`	Undocumented

def _parse_requires_clause(self): (source) ¶

Undocumented

Returns
`ASTRequiresClause\|None`	Undocumented

def _parse_simple_type_specifiers(self): (source) ¶

Undocumented

Returns
`ASTTrailingTypeSpecFundamental`	Undocumented

def _parse_string(self): (source) ¶

Undocumented

Returns
`str`	Undocumented

def _parse_template_argument_list(self): (source) ¶

Undocumented

Returns
`ASTTemplateArgs`	Undocumented

def _parse_template_declaration_prefix(self, objectType): (source) ¶

Undocumented

Parameters
objectType:`str`	Undocumented
Returns
`ASTTemplateDeclarationPrefix\|None`	Undocumented

def _parse_template_introduction(self): (source) ¶

Undocumented

Returns
`ASTTemplateIntroduction`	Undocumented

def _parse_template_parameter(self): (source) ¶

Undocumented

Returns
`ASTTemplateParam`	Undocumented

def _parse_template_parameter_list(self): (source) ¶

Undocumented

Returns
`ASTTemplateParams`	Undocumented

def _parse_trailing_type_spec(self): (source) ¶

Undocumented

Returns
`ASTTrailingTypeSpec`	Undocumented

def _parse_type(self, named, outer=None): (source) ¶

named=False|'maybe'|True: 'maybe' is e.g., for function objects which doesn't need to name the arguments outer == operatorCast: annoying case, we should not take the params

Parameters
named:`bool\|str`	Undocumented
outer:`str`	Undocumented
Returns
`ASTType`	Undocumented

def _parse_type_using(self): (source) ¶

Undocumented

Returns
`ASTTypeUsing`	Undocumented

def _parse_type_with_init(self, named, outer): (source) ¶

Undocumented

Parameters
named:`bool\|str`	Undocumented
outer:`str`	Undocumented
Returns
`ASTTypeWithInit\|ASTTemplateParamConstrainedTypeWithInit`	Undocumented

def _parse_unary_expression(self): (source) ¶

Undocumented

Returns
`ASTExpression`	Undocumented

def _parse_union(self): (source) ¶

Undocumented

Returns
`ASTUnion`	Undocumented