org.stekikun.dolmen.codegen

Class Config

java.lang.Object

org.stekikun.dolmen.codegen.Config

public final class Config
extends Object

Configuration description for Dolmen generation of both lexical and syntax analyzers.

Options can be configured in the grammar description using pairs of key-value descriptions. The set of supported keys is described in the enumeration Config.Keys. Configuration instances can then be built from such a list of key-value bindings (see ofOptions(Relevance, List, Reporter)).

Each option can be relevant to either solely lexer generation or parser generation, or to both.

For better declarative support, a configuration instance can also be built using a builder class with chained methods for each configurable option.

Finally, a DEFAULT configuration is available.

Author:

Stéphane Lescuyer

See Also:

ofOptions(Relevance, List, Reporter)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.Builder A builder class for configurations, which allows setting all options using method chaining.
static class	Config.Keys Enumeration of the keys for configurable options.
static class	Config.Relevance Enumeration representing the relevance of a configuration: it can be usable only within a lexer description, a parser description, or both.

Field Summary

Fields

Modifier and Type	Field and Description
String	classAnnotations Annotations which must be added to the generated parser or lexer class
static Config	DEFAULT The default configuration for grammar generation
boolean	positions Whether the parser should keep positions for non-terminal symbols as well as terminal symbols
String	tokenAnnotations Annotations which must be added to the generated token class in a generated parser

Constructor Summary

Constructors

Constructor and Description
Config(EnumMap<Config.Keys,Object> options) Builds a configuration from the given options.

Method Summary

Modifier and Type	Method and Description
static Config	ofGrammar(Grammar grammar, @Nullable Reporter reporter) Same as ofOptions(Relevance.PARSER, grammar.options, reporter).
static Config	ofLexer(Lexer lexer, @Nullable Reporter reporter) Same as ofOptions(Relevance.LEXER, grammar.options, reporter).
static Config	ofOptions(Config.Relevance relevance, List<Option> options, @Nullable Reporter reporter) This method never fails to build a valid configuration, but can report unexpected things such as illegal keys or values through the reporter.
static Config	ofPGrammar(PGrammar grammar, @Nullable Reporter reporter) Same as ofOptions(Relevance.PARSER, grammar.options, reporter).
static Config.Builder	start()

Methods inherited from class java.lang.Object

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

Field Detail

positions

public final boolean positions

Whether the parser should keep positions for non-terminal symbols as well as terminal symbols

classAnnotations

public final String classAnnotations

Annotations which must be added to the generated parser or lexer class

tokenAnnotations

public final String tokenAnnotations

Annotations which must be added to the generated token class in a generated parser

DEFAULT

public static final Config DEFAULT

The default configuration for grammar generation

Constructor Detail

Config

public Config(EnumMap<Config.Keys,Object> options)

Builds a configuration from the given options. Not all options need be configured in options, those that are unspecified will take on default values.

Parameters:

options -

Throws:

ClassCastException - if some options are associated to incompatible value types

Method Detail

ofOptions

public static Config ofOptions(Config.Relevance relevance,
                               List<Option> options,
                               @Nullable Reporter reporter)

This method never fails to build a valid configuration, but can report unexpected things such as illegal keys or values through the reporter. Only warnings are reported.

Parameters:

relevance - context where the configuration should be relevant

options -

reporter - can be null if no reporting is required

Returns:

the configuration that is implied by the option settings given in options

ofPGrammar

public static Config ofPGrammar(PGrammar grammar,
                                @Nullable Reporter reporter)

Same as ofOptions(Relevance.PARSER, grammar.options, reporter).

Parameters:

grammar -

reporter -

Returns:

the configuration that is implied from the options in grammar

ofGrammar

public static Config ofGrammar(Grammar grammar,
                               @Nullable Reporter reporter)

Same as ofOptions(Relevance.PARSER, grammar.options, reporter).

Parameters:

grammar -

reporter -

Returns:

the configuration that is implied from the options in grammar

ofLexer

public static Config ofLexer(Lexer lexer,
                             @Nullable Reporter reporter)

Same as ofOptions(Relevance.LEXER, grammar.options, reporter).

Parameters:

lexer -

reporter -

Returns:

the configuration that is implied from the options in lexer

start

public static Config.Builder start()

Returns:

a fresh configuration builder, initialized with default values for all options