org.stekikun.dolmen.syntax

Class PGrammarRule

java.lang.Object

org.stekikun.dolmen.syntax.PGrammarRule

public final class PGrammarRule
extends Object

Describes a (potentially parametric) grammar rule for a non-terminal in a parametric grammar description. The rule can be public or private which will impact the visibility of the corresponding generated method, it specifies the return type of the associated semantic actions and can have some formal arguments.

The rule can be ground or be parameterized by a number of formal parameters. A parameterized rule represents a generic rule from which ground rules can be obtained by simply instantiating the formal parameters with terminals or (instantiated) non-terminals of the grammar. A rule's parameter can be used in its production items, as a regular symbol of the grammar, and also as holes in semantic actions where they stand for the return type associated to the formal parameter. Public rules cannot be parametric as public rules act as monomorphic entry points allowing the monomorphization of a parametric grammar.

The relative order of productions for this grammar rule is the one from the original source but is not semantically relevant for the produced grammar.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PGrammarRule.Builder A builder class for grammar rules, where productions can be added incrementally

Field Summary

Fields

Modifier and Type	Field and Description
@Nullable PExtent	args The formal arguments for this rule, if any
Located<String>	name The name of this rule
List<Located<String>>	params The generic parameters of the rule
List<PProduction>	productions The productions for this rule
PExtent	returnType This rule's return type
boolean	visibility Whether this grammar rule is public or not

Constructor Summary

Constructors

Constructor and Description
PGrammarRule(boolean visibility, PExtent returnType, Located<String> name, List<Located<String>> params, @Nullable PExtent args, List<PProduction> productions) Builds a grammar rule from the given parameters

Method Summary

Modifier and Type	Method and Description
boolean	hasContinuation()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

visibility

public final boolean visibility

Whether this grammar rule is public or not

returnType

public final PExtent returnType

This rule's return type

name

public final Located<String> name

The name of this rule

params

public final List<Located<String>> params

The generic parameters of the rule

args

public final @Nullable PExtent args

The formal arguments for this rule, if any

productions

public final List<PProduction> productions

The productions for this rule

Constructor Detail

PGrammarRule

public PGrammarRule(boolean visibility,
                    PExtent returnType,
                    Located<String> name,
                    List<Located<String>> params,
                    @Nullable PExtent args,
                    List<PProduction> productions)

Builds a grammar rule from the given parameters

Parameters:

visibility -

returnType -

name -

params -

args -

productions -

Method Detail

hasContinuation

public boolean hasContinuation()

Returns:

true if one of the rule's productions at least has a continuation

toString

public String toString()

Overrides:

toString in class Object