MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

Docs and the base class for Python token set contributors

Browse Source
This commit is contained in:
Andrey Vlasovskikh
2013-09-17 19:26:10 +04:00
parent 4f4ea89327
commit a2b76b7735
5 changed files with 141 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/psi-api/src/com/jetbrains/python/PythonDialectsTokenSetContributor.java
+42
View File
@@ -2,19 +2,61 @@ package com.jetbrains.python;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.psi.tree.TokenSet;
import org.jetbrains.annotations.NotNull;
/**
* Contributes element types of various kinds specific for a particular Python dialect.
*
* @author vlan
*/
public interface PythonDialectsTokenSetContributor {
ExtensionPointName<PythonDialectsTokenSetContributor> EP_NAME = ExtensionPointName.create("Pythonid.dialectsTokenSetContributor");
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.PyStatement}.
*/
@NotNull
TokenSet getStatementTokens();
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.PyExpression}.
*/
@NotNull
TokenSet getExpressionTokens();
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.NameDefiner}.
*/
@NotNull
TokenSet getNameDefinerTokens();
/**
* Returns element types that are language keywords.
*/
@NotNull
TokenSet getKeywordTokens();
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.PyParameter}.
*/
@NotNull
TokenSet getParameterTokens();
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.PyFunction}.
*/
@NotNull
TokenSet getFunctionDeclarationTokens();
/**
* Returns element types that can be used as unbalanced braces recovery tokens in the lexer.
*/
@NotNull
TokenSet getUnbalancedBracesRecoveryTokens();
/**
* Returns element types that are subclasses of {@link com.jetbrains.python.psi.PyReferenceExpression}.
*/
@NotNull
TokenSet getReferenceExpressionTokens();
}
python/psi-api/src/com/jetbrains/python/PythonDialectsTokenSetContributorBase.java
+57
View File
@@ -0,0 +1,57 @@
package com.jetbrains.python;
import com.intellij.psi.tree.TokenSet;
import org.jetbrains.annotations.NotNull;
/**
* @author vlan
*/
public abstract class PythonDialectsTokenSetContributorBase implements PythonDialectsTokenSetContributor {
@NotNull
@Override
public TokenSet getStatementTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getExpressionTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getNameDefinerTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getKeywordTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getParameterTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getFunctionDeclarationTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getUnbalancedBracesRecoveryTokens() {
return TokenSet.EMPTY;
}
@NotNull
@Override
public TokenSet getReferenceExpressionTokens() {
return TokenSet.EMPTY;
}
}
python/src/com/jetbrains/python/PythonDialectsTokenSetProvider.java
+26
View File
@@ -4,6 +4,8 @@ import com.intellij.openapi.extensions.Extensions;
import com.intellij.psi.tree.TokenSet;
/**
* Provides element types of various kinds for known Python dialects.
*
* @author vlan
*/
public class PythonDialectsTokenSetProvider {
@@ -47,34 +49,58 @@ public class PythonDialectsTokenSetProvider {
myReferenceExpressionTokens = referenceExpressions;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.PyStatement}.
*/
public TokenSet getStatementTokens() {
return myStatementTokens;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.PyExpression}.
*/
public TokenSet getExpressionTokens() {
return myExpressionTokens;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.NameDefiner}.
*/
public TokenSet getNameDefinerTokens() {
return myNameDefinerTokens;
}
/**
* Returns all element types of Python dialects that are language keywords.
*/
public TokenSet getKeywordTokens() {
return myKeywordTokens;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.PyParameter}.
*/
public TokenSet getParameterTokens() {
return myParameterTokens;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.PyFunction}.
*/
public TokenSet getFunctionDeclarationTokens() {
return myFunctionDeclarationTokens;
}
/**
* Returns all element types of Python dialects that can be used as unbalanced braces recovery tokens in the lexer.
*/
public TokenSet getUnbalancedBracesRecoveryTokens() {
return myUnbalancedBracesRecoveryTokens;
}
/**
* Returns all element types of Python dialects that are subclasses of {@link com.jetbrains.python.psi.PyReferenceExpression}.
*/
public TokenSet getReferenceExpressionTokens() {
return myReferenceExpressionTokens;
}
python/src/com/jetbrains/python/PythonTokenSetContributor.java
+11 -1
View File
@@ -1,13 +1,16 @@
package com.jetbrains.python;
import com.intellij.psi.tree.TokenSet;
import org.jetbrains.annotations.NotNull;
import static com.jetbrains.python.PyElementTypes.*;
import static com.jetbrains.python.PyTokenTypes.*;
/**
* @author vlan
*/
public class PythonTokenSetContributor implements PythonDialectsTokenSetContributor {
public class PythonTokenSetContributor extends PythonDialectsTokenSetContributorBase {
@NotNull
@Override
public TokenSet getStatementTokens() {
return TokenSet.create(EXPRESSION_STATEMENT, ASSIGNMENT_STATEMENT, AUG_ASSIGNMENT_STATEMENT, ASSERT_STATEMENT,
@@ -17,6 +20,7 @@ public class PythonTokenSetContributor implements PythonDialectsTokenSetContribu
WHILE_STATEMENT, NONLOCAL_STATEMENT, CLASS_DECLARATION, FUNCTION_DECLARATION);
}
@NotNull
@Override
public TokenSet getExpressionTokens() {
return TokenSet.create(EMPTY_EXPRESSION, REFERENCE_EXPRESSION, INTEGER_LITERAL_EXPRESSION, FLOAT_LITERAL_EXPRESSION,
@@ -29,6 +33,7 @@ public class PythonTokenSetContributor implements PythonDialectsTokenSetContribu
SET_LITERAL_EXPRESSION, SET_COMP_EXPRESSION, DICT_COMP_EXPRESSION, STAR_EXPRESSION);
}
@NotNull
@Override
public TokenSet getNameDefinerTokens() {
// FROM_IMPORT_STATEMENT is not exactly a NameDefiner but needed anyway in mypackage/__init__.py, 'from mypackage.foo import bar' makes
@@ -41,6 +46,7 @@ public class PythonTokenSetContributor implements PythonDialectsTokenSetContribu
FROM_IMPORT_STATEMENT);
}
@NotNull
@Override
public TokenSet getKeywordTokens() {
return TokenSet.create(
@@ -55,22 +61,26 @@ public class PythonTokenSetContributor implements PythonDialectsTokenSetContribu
NONE_KEYWORD, TRUE_KEYWORD, FALSE_KEYWORD, NONLOCAL_KEYWORD, DEBUG_KEYWORD);
}
@NotNull
@Override
public TokenSet getParameterTokens() {
return TokenSet.create(NAMED_PARAMETER, TUPLE_PARAMETER, SINGLE_STAR_PARAMETER);
}
@NotNull
@Override
public TokenSet getFunctionDeclarationTokens() {
return TokenSet.create(FUNCTION_DECLARATION);
}
@NotNull
@Override
public TokenSet getUnbalancedBracesRecoveryTokens() {
return TokenSet.create(DEF_KEYWORD, CLASS_KEYWORD, RETURN_KEYWORD, WITH_KEYWORD, WHILE_KEYWORD, BREAK_KEYWORD, CONTINUE_KEYWORD,
RAISE_KEYWORD, TRY_KEYWORD, EXCEPT_KEYWORD, FINALLY_KEYWORD);
}
@NotNull
@Override
public TokenSet getReferenceExpressionTokens() {
return TokenSet.create(REFERENCE_EXPRESSION);
python/src/com/jetbrains/python/documentation/doctest/PyDocstringTokenSetContributor.java
+5 -2
View File
@@ -1,19 +1,22 @@
package com.jetbrains.python.documentation.doctest;
import com.intellij.psi.tree.TokenSet;
import com.jetbrains.python.PythonTokenSetContributor;
import com.jetbrains.python.PythonDialectsTokenSetContributorBase;
import org.jetbrains.annotations.NotNull;
/**
* User : ktisha
*/
public class PyDocstringTokenSetContributor extends PythonTokenSetContributor {
public class PyDocstringTokenSetContributor extends PythonDialectsTokenSetContributorBase {
public static final TokenSet DOCSTRING_REFERENCE_EXPRESSIONS = TokenSet.create(PyDocstringTokenTypes.DOC_REFERENCE);
@NotNull
@Override
public TokenSet getExpressionTokens() {
return DOCSTRING_REFERENCE_EXPRESSIONS;
}
@NotNull
@Override
public TokenSet getReferenceExpressionTokens() {
return DOCSTRING_REFERENCE_EXPRESSIONS;