Class QuoteRule

Namespace

NMF.AnyText.Rules

Assembly

NMF.AnyText.Core.dll

Denotes a rule that delegates to an inner rule without changes

public class QuoteRule : Rule

Inheritance

object

Rule

QuoteRule

Derived

AnyMetaGrammar.BoundsRule

AnyMetaGrammar.DocumentationRule

AnyMetaGrammar.ImportsRule

AnyTextGrammar.FormattingInstructionFragmentRule

AnyTextGrammar.RuleTypeFragmentRule

AddAssignRule<TSemanticElement, TProperty>

AssignRule<TSemanticElement, TProperty>

ExistsAssignRule<TSemanticElement>

ResolveRule<TSemanticElement, TReference>

Inherited Members

Rule.Name

Rule.ToString()

Rule.OnActivate(RuleApplication, ParseContext, bool)

Rule.OnDeactivate(RuleApplication, ParseContext)

Rule.OnValueChange(RuleApplication, ParseContext, RuleApplication)

Rule.IsLiteral

Rule.IsComment

Rule.IsFoldable()

Rule.IsImports()

Rule.HasFoldingKind(out string)

Rule.TrailingWhitespaces

Rule.Initialize(GrammarContext)

Rule.PostInitialize(GrammarContext)

Rule.TokenType

Rule.IsDefinition

Rule.IsReference

Rule.IsIdentifier

Rule.SymbolKind

Rule.SymbolTags(RuleApplication)

Rule.PassAlongDocumentSymbols

Rule.Invalidate(RuleApplication, ParseContext)

Rule.IsLeftRecursive

Rule.Continuations

Rule.CanSynthesize(object, ParseContext)

Rule.Synthesize(object, ParseContext, string)

Rule.Synthesize(object, ParseContext, TextWriter, string)

Rule.IsEpsilonAllowed()

Rule.CreateEpsilonRuleApplication(RuleApplication)

Rule.CanStartWith(Rule)

Rule.TokenModifiers

Rule.GetInlayHintText(RuleApplication, ParseContext)

Rule.SuggestCompletions(ParseContext, RuleApplication, string, ParsePosition)

Rule.TokenTypeIndex

Rule.TokenModifierIndex

Rule.GetHoverText(RuleApplication, Parser, ParsePosition)

Rule.RegisterSymbolKind(Dictionary<Type, SymbolKind>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

FormattingInstructions

Gets or sets formatting instructions

public FormattingInstruction[] FormattingInstructions { get; set; }

Property Value

FormattingInstruction[]

Inner

Gets or sets the inner rule

public FormattedRule Inner { get; set; }

Property Value

FormattedRule

InnerRule

Gets or sets the inner rule

public Rule InnerRule { get; set; }

Property Value

Rule

Methods

AddLeftRecursionRules(List<Rule>, List<RecursiveContinuation>)

Adds rules to the given left recursion trace

protected override void AddLeftRecursionRules(List<Rule> trace, List<RecursiveContinuation> continuations)

Parameters

trace List<Rule>

the trace

continuations List<RecursiveContinuation>

a collection of recursion continuations

CanStartWith(Rule, List<Rule>)

Indicates whether the rule could start with the given other rule

protected override bool CanStartWith(Rule rule, List<Rule> trace)

Parameters

rule Rule

the other rule

trace List<Rule>

a list of rules visited so far

Returns

bool

true, if the rule could start with the given other rule, otherwise false

CanSynthesize(object, ParseContext, SynthesisPlan)

Determines whether the current rule can synthesize rule applications for the given semantic element

public override bool CanSynthesize(object semanticElement, ParseContext context, SynthesisPlan synthesisPlan)

Parameters

semanticElement object

the semantic element

context ParseContext

the context in which the rule is synthesized

synthesisPlan SynthesisPlan

the plan of the synthesis

Returns

bool

true, if a rule application can be synthesized, otherwise false

CreateRuleApplication(RuleApplication, ParseContext, object)

Creates the rule application for this rule

protected virtual RuleApplication CreateRuleApplication(RuleApplication app, ParseContext context, object semanticElement = null)

Parameters

app RuleApplication

the inner rule application

context ParseContext

the parse context

semanticElement object

the semantic element for which the rule application is created or null, if not yet known

Returns

RuleApplication

the new rule application

CreateSynthesisRequirements()

Creates a collection of requirements for synthesis

public override IEnumerable<SynthesisRequirement> CreateSynthesisRequirements()

Returns

IEnumerable<SynthesisRequirement>

A collection of synthesis requirements

IsEpsilonAllowed(List<Rule>)

Determines whether the rule could capture empty input

protected override bool IsEpsilonAllowed(List<Rule> trace)

Parameters

trace List<Rule>

Returns

bool

true, if the rule can be expanded to an empty string, otherwise false

Match(ParseContext, RecursionContext, ref ParsePosition)

Matches the the context at the provided position

public override RuleApplication Match(ParseContext context, RecursionContext recursionContext, ref ParsePosition position)

Parameters

context ParseContext

the context in which the rule is matched

recursionContext RecursionContext

the recursion context of the matching

position ParsePosition

the position in the input

Returns

RuleApplication

the rule application for the provided position

Recover(RuleApplication, RuleApplication, RuleApplication, ParseContext, out ParsePosition)

Recovers from the given inner failed rule application

protected override RuleApplication Recover(RuleApplication ruleApplication, RuleApplication failedRuleApplication, RuleApplication currentRoot, ParseContext context, out ParsePosition position)

Parameters

ruleApplication RuleApplication

the rule application that should be recovered

failedRuleApplication RuleApplication

the inner rule application that caused the failure

currentRoot RuleApplication

the current root rule application

context ParseContext

the parse context in which the rule application is recovered

position ParsePosition

the position after the recovery

Returns

RuleApplication

the recovered rule application if the recovery was successful or the old rule application if not

Synthesize(object, ParsePosition, ParseContext)

Synthesizes a rule application for the given semantic element

public override RuleApplication Synthesize(object semanticElement, ParsePosition position, ParseContext context)

Parameters

semanticElement object

position ParsePosition

the parse position at which the element should be synthesized

context ParseContext

the parse context

Returns

RuleApplication

a rule application