Enhanced C#
Language of your choice: library documentation
Properties | Public Member Functions | List of all members
Loyc.Syntax.IParsingService Interface Reference

An interface that encapsulates the lexer and parser of a programming language, or a non-programming language that can be represented by Loyc trees. More...


Source file:
Inheritance diagram for Loyc.Syntax.IParsingService:
Loyc.Ecs.EcsLanguageService Loyc.Syntax.Les.Les2LanguageService Loyc.Syntax.Les.Les3LanguageService Loyc.Syntax.Les.LesLanguageService

Remarks

An interface that encapsulates the lexer and parser of a programming language, or a non-programming language that can be represented by Loyc trees.

The simplest way to parse code is with the extension method Parse(string, IMessageSink msgs = null, Symbol inputType = null). The simplest way to print is with Print(LNode, IMessageSink)

The ToString() method should return a string that indicates the programming language represented by this object, e.g. "Enhanced C#".

See also
ParsingService

Properties

IEnumerable< string > FileExtensions [get]
 Standard file extensions for this language, without leading dots, with the first one being the most common. More...
 
bool HasTokenizer [get]
 Returns true if the Tokenize method is available. More...
 
bool CanPreserveComments [get]
 Returns true if the parser supports preserving comments. More...
 

Public Member Functions

ILexer< TokenTokenize (ICharSource text, string fileName, IMessageSink msgs)
 Returns a lexer that is configured to begin reading the specified file. More...
 
IListSource< LNodeParse (ICharSource text, string fileName, IMessageSink msgs=null, ParsingMode mode=null, bool preserveComments=true)
 Parses a source file into one or more Loyc trees. More...
 
IListSource< LNodeParse (ILexer< Token > input, IMessageSink msgs=null, ParsingMode mode=null, bool preserveComments=true)
 If HasTokenizer is true, this method accepts a lexer returned by Tokenize() and begins parsing. More...
 
IListSource< LNodeParse (IListSource< Token > tokens, ISourceFile file, IMessageSink msgs, ParsingMode inputType)
 Parses a token tree, such as one that came from a token literal. More...
 

Member Function Documentation

IListSource<LNode> Loyc.Syntax.IParsingService.Parse ( ICharSource  text,
string  fileName,
IMessageSink  msgs = null,
ParsingMode  mode = null,
bool  preserveComments = true 
)

Parses a source file into one or more Loyc trees.

Parameters
textinput file or string.
fileNameA file name to associate with errors, warnings, and output nodes.
msgsError and warning messages are sent to this object.
modeIndicates the kind of input, e.g. File (an entire source file), FormalArguments (function parameter list), etc. null is a synonym for File.
preserveCommentsWhether to preserve comments and newlines by attaching trivia attributes to the output. If the property CanPreserveComments is false, this parameter will not work.

Implemented in Loyc.Ecs.EcsLanguageService, Loyc.Syntax.Les.Les3LanguageService, and Loyc.Syntax.Les.Les2LanguageService.

Referenced by Loyc.Syntax.ParsingService.Parse(), and Loyc.Syntax.ParsingService.ParseSingle().

IListSource<LNode> Loyc.Syntax.IParsingService.Parse ( ILexer< Token input,
IMessageSink  msgs = null,
ParsingMode  mode = null,
bool  preserveComments = true 
)

If HasTokenizer is true, this method accepts a lexer returned by Tokenize() and begins parsing.

Parameters
inputA source of tokens.
msgsError and warning messages are sent to this object. If this parameter is null, messages should be sent to MessageSink.Current.
modeIndicates how the input should be parsed. null is a synonym for ParsingMode.File
preserveCommentsWhether to preserve comments and newlines by attaching trivia attributes to the output. If the property CanPreserveComments is false, this parameter will not work.
Exceptions
NotSupportedExceptionHasTokenizer is false.

This method adds any preprocessing steps to the lexer (tree-ification or token preprocessing) that are required by this language before it sends the results to the parser. If possible, the output is computed lazily.

Implemented in Loyc.Ecs.EcsLanguageService, Loyc.Syntax.Les.Les3LanguageService, and Loyc.Syntax.Les.Les2LanguageService.

IListSource<LNode> Loyc.Syntax.IParsingService.Parse ( IListSource< Token tokens,
ISourceFile  file,
IMessageSink  msgs,
ParsingMode  inputType 
)

Parses a token tree, such as one that came from a token literal.

Parameters
tokensList of tokens
fileA source file to associate with errors, warnings, and output nodes.
msgsError and warning messages are sent to this object. If this parameter is null, messages should be sent to MessageSink.Current.
inputTypeIndicates how the input should be parsed.

Some languages may offer token literals, which are stored as token trees that can be processed by "macros" or compiler plugins. A macro may wish to parse some of the token literal using the host language's parser (e.g. LLLPG needs to do this), so this method is provided for that purpose.

Exceptions
NotSupportedExceptionThis feature is not supported by this parsing service.

Implemented in Loyc.Ecs.EcsLanguageService, Loyc.Syntax.Les.Les3LanguageService, and Loyc.Syntax.Les.Les2LanguageService.

ILexer<Token> Loyc.Syntax.IParsingService.Tokenize ( ICharSource  text,
string  fileName,
IMessageSink  msgs 
)

Returns a lexer that is configured to begin reading the specified file.

Parameters
textText to be tokenized (e.g. UString)
fileNameFile name to be associated with any errors that occur.
msgsError messages are sent to this object.

The returned lexer should be a "simple" tokenizer. If the language uses tree lexing (in which tokens are grouped by parentheses and braces), the returned lexer should NOT include the grouping process.

It is recommended that the implementation of this method filter out spaces (for best performance) but not comments or newlines. If there is a preprocessor, it should not run.

Implemented in Loyc.Ecs.EcsLanguageService, Loyc.Syntax.Les.Les3LanguageService, and Loyc.Syntax.Les.Les2LanguageService.

Referenced by Loyc.Syntax.ParsingService.Tokenize().

Property Documentation

bool Loyc.Syntax.IParsingService.CanPreserveComments
get

Returns true if the parser supports preserving comments.

IEnumerable<string> Loyc.Syntax.IParsingService.FileExtensions
get

Standard file extensions for this language, without leading dots, with the first one being the most common.

Referenced by Loyc.Syntax.ParsingService.Register(), and Loyc.Syntax.ParsingService.Unregister().

bool Loyc.Syntax.IParsingService.HasTokenizer
get

Returns true if the Tokenize method is available.