Package com.intellij.lang

Interface ParserDefinition

All Known Implementing Classes:

BuildoutCfgParserDefinition, CommandLineParserDefinition, DTDParserDefinition, EcmaScriptRegexpParserDefinition, EcmaScriptUnicodeRegexpParserDefinition, GroovyParserDefinition, HTMLParserDefinition, IgnoreParserDefinition, JavaParserDefinition, JqlParserDefinition, JShellParserDefinition, Json5ParserDefinition, JsonParserDefinition, ManifestParserDefinition, MarkdownParserDefinition, PlainTextParserDefinition, PropertiesParserDefinition, PyDocstringParserDefinition, PyFunctionTypeAnnotationParserDefinition, PyiParserDefinition, PythonParserDefinition, PythonRegexpParserDefinition, PythonVerboseRegexpParserDefinition, RegExpParserDefinition, RestParserDefinition, RncParserDefinition, ShParserDefinition, SPIParserDefinition, TextMateParserDefinition, XHTMLParserDefinition, XMLParserDefinition, XPath2ParserDefinition, XPathParserDefinition, XsdRegExpParserDefinition, YAMLParserDefinition, YouTrackParserDefinition

public interface ParserDefinition

Defines the implementation of a parser for a custom language.

See Also:

LanguageExtension.forLanguage(Language)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParserDefinition.SpaceRequirements Requirements for spacing between tokens.

Method Summary

Modifier and Type	Method and Description
PsiElement	createElement(ASTNode node) Creates a PSI element for the specified AST node.
PsiFile	createFile(FileViewProvider viewProvider) Creates a PSI element for the specified virtual file.
Lexer	createLexer(Project project) Returns the lexer for lexing files in the specified project.
PsiParser	createParser(Project project) Returns the parser for parsing files in the specified project.
TokenSet	getCommentTokens() Returns the set of token types which are treated as comments by the PSI builder.
IFileElementType	getFileNodeType() Returns the element type of the node describing a file in the specified language.
TokenSet	getStringLiteralElements() Returns the set of element types which are treated as string literals.
default TokenSet	getWhitespaceTokens() Returns the set of token types which are treated as whitespace by the PSI builder.
default ParserDefinition.SpaceRequirements	spaceExistanceTypeBetweenTokens(ASTNode left, ASTNode right) Deprecated. Override spaceExistenceTypeBetweenTokens(ASTNode, ASTNode) instead
default ParserDefinition.SpaceRequirements	spaceExistenceTypeBetweenTokens(ASTNode left, ASTNode right) Checks if the specified two token types need to be separated by a space according to the language grammar.

Method Detail

createLexer

Lexer createLexer(Project project)

Returns the lexer for lexing files in the specified project. This lexer does not need to support incremental relexing - it is always called for the entire file.

Parameters:

project - the project to which the lexer is connected.

Returns:

the lexer instance.

createParser

PsiParser createParser(Project project)

Returns the parser for parsing files in the specified project.

Parameters:

project - the project to which the parser is connected.

Returns:

the parser instance.

getFileNodeType

IFileElementType getFileNodeType()

Returns the element type of the node describing a file in the specified language.

Returns:

the file node element type.

getWhitespaceTokens

default TokenSet getWhitespaceTokens()

Returns the set of token types which are treated as whitespace by the PSI builder. Tokens of those types are automatically skipped by PsiBuilder. Whitespace elements on the bounds of nodes built by PsiBuilder are automatically excluded from the text range of the nodes.

It is strongly advised you return TokenSet that only contains TokenType.WHITE_SPACE, which is suitable for all the languages unless you really need to use special whitespace token

Returns:

the set of whitespace token types.

getCommentTokens

TokenSet getCommentTokens()

Returns the set of token types which are treated as comments by the PSI builder. Tokens of those types are automatically skipped by PsiBuilder. Also, To Do patterns are searched in the text of tokens of those types. For composite comment elements it should contain only the root element type (for example JavaDocElementType.DOC_COMMENT).

Returns:

the set of comment token types.

getStringLiteralElements

TokenSet getStringLiteralElements()

Returns the set of element types which are treated as string literals. "Search in strings" option in refactorings is applied to the contents of such tokens.

Returns:

the set of string literal element types.

createElement

PsiElement createElement(ASTNode node)

Creates a PSI element for the specified AST node. The AST tree is a simple, semantic-free tree of AST nodes which is built during the PsiBuilder parsing pass. The PSI tree is built over the AST tree and includes elements of different types for different language constructs. !!!WARNING!!! PSI element types should be unambiguously determined by AST node element types. You can not produce different PSI elements from AST nodes of the same types (e.g. based on AST node content). Typically, your code should be as simple as that:

   if (node.getElementType == MY_ELEMENT_TYPE) {
     return new MyPsiElement(node);
   }
 

Parameters:

node - the node for which the PSI element should be returned.

Returns:

the PSI element matching the element type of the AST node.

createFile

PsiFile createFile(FileViewProvider viewProvider)

Creates a PSI element for the specified virtual file.

Parameters:

viewProvider - virtual file.

Returns:

the PSI file element.

spaceExistenceTypeBetweenTokens

default ParserDefinition.SpaceRequirements spaceExistenceTypeBetweenTokens(ASTNode left,
                                                                           ASTNode right)

Checks if the specified two token types need to be separated by a space according to the language grammar. For example, in Java two keywords are always separated by a space; a keyword and an opening parenthesis may be separated or not separated. This is used for automatic whitespace insertion during AST modification operations.

Parameters:

left - the first token to check.

right - the second token to check.

Returns:

the spacing requirements.

spaceExistanceTypeBetweenTokens

@Deprecated
default ParserDefinition.SpaceRequirements spaceExistanceTypeBetweenTokens(ASTNode left,
                                                                           ASTNode right)

Deprecated. Override spaceExistenceTypeBetweenTokens(ASTNode, ASTNode) instead