Package com.intellij.spi.parsing

Class SPIParserDefinition

java.lang.Object

com.intellij.spi.parsing.SPIParserDefinition

All Implemented Interfaces:

ParserDefinition

public class SPIParserDefinition
extends java.lang.Object
implements ParserDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.lang.ParserDefinition

ParserDefinition.SpaceRequirements

Field Summary

Fields

Modifier and Type	Field and Description
static IFileElementType	SPI_FILE_ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
SPIParserDefinition()

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.
TokenSet	getWhitespaceTokens() Returns the set of token types which are treated as whitespace by the PSI builder.
static void	parseProvider(PsiBuilder builder)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.lang.ParserDefinition

spaceExistanceTypeBetweenTokens

Field Detail

SPI_FILE_ELEMENT_TYPE

public static final IFileElementType SPI_FILE_ELEMENT_TYPE

Constructor Detail

SPIParserDefinition

public SPIParserDefinition()

Method Detail

createLexer

public Lexer createLexer(Project project)

Description copied from interface: ParserDefinition

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.

Specified by:

createLexer in interface ParserDefinition

Parameters:

project - the project to which the lexer is connected.

Returns:

the lexer instance.

createParser

public PsiParser createParser(Project project)

Description copied from interface: ParserDefinition

Returns the parser for parsing files in the specified project.

Specified by:

createParser in interface ParserDefinition

Parameters:

project - the project to which the parser is connected.

Returns:

the parser instance.

getFileNodeType

public IFileElementType getFileNodeType()

Description copied from interface: ParserDefinition

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

Specified by:

getFileNodeType in interface ParserDefinition

Returns:

the file node element type.

getWhitespaceTokens

public TokenSet getWhitespaceTokens()

Description copied from interface: ParserDefinition

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

Specified by:

getWhitespaceTokens in interface ParserDefinition

Returns:

the set of whitespace token types.

getCommentTokens

public TokenSet getCommentTokens()

Description copied from interface: ParserDefinition

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).

Specified by:

getCommentTokens in interface ParserDefinition

Returns:

the set of comment token types.

getStringLiteralElements

public TokenSet getStringLiteralElements()

Description copied from interface: ParserDefinition

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.

Specified by:

getStringLiteralElements in interface ParserDefinition

Returns:

the set of string literal element types.

createElement

public PsiElement createElement(ASTNode node)

Description copied from interface: ParserDefinition

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);
   }
 

Specified by:

createElement in interface ParserDefinition

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

public PsiFile createFile(FileViewProvider viewProvider)

Description copied from interface: ParserDefinition

Creates a PSI element for the specified virtual file.

Specified by:

createFile in interface ParserDefinition

Parameters:

viewProvider - virtual file.

Returns:

the PSI file element.

spaceExistenceTypeBetweenTokens

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

Description copied from interface: ParserDefinition

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.

Specified by:

spaceExistenceTypeBetweenTokens in interface ParserDefinition

Parameters:

left - the first token to check.

right - the second token to check.

Returns:

the spacing requirements.

parseProvider

public static void parseProvider(PsiBuilder builder)