001 /*
002 * Copyright 2010-2015 JetBrains s.r.o.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017 package org.jetbrains.kotlin.lexer;
018
019 import com.intellij.psi.TokenType;
020 import com.intellij.psi.tree.IElementType;
021 import com.intellij.psi.tree.TokenSet;
022 import org.jetbrains.kotlin.kdoc.lexer.KDocTokens;
023 import org.jetbrains.kotlin.psi.KtPsiUtil;
024
025 public interface KtTokens {
026 KtToken EOF = new KtToken("EOF");
027
028 KtToken BLOCK_COMMENT = new KtToken("BLOCK_COMMENT");
029 KtToken EOL_COMMENT = new KtToken("EOL_COMMENT");
030 KtToken SHEBANG_COMMENT = new KtToken("SHEBANG_COMMENT");
031
032 //KtToken DOC_COMMENT = new KtToken("DOC_COMMENT");
033 IElementType DOC_COMMENT = KDocTokens.KDOC;
034
035 IElementType WHITE_SPACE = TokenType.WHITE_SPACE;
036
037 KtToken INTEGER_LITERAL = new KtToken("INTEGER_LITERAL");
038 KtToken FLOAT_LITERAL = new KtToken("FLOAT_CONSTANT");
039 KtToken CHARACTER_LITERAL = new KtToken("CHARACTER_LITERAL");
040
041 KtToken CLOSING_QUOTE = new KtToken("CLOSING_QUOTE");
042 KtToken OPEN_QUOTE = new KtToken("OPEN_QUOTE");
043 KtToken REGULAR_STRING_PART = new KtToken("REGULAR_STRING_PART");
044 KtToken ESCAPE_SEQUENCE = new KtToken("ESCAPE_SEQUENCE");
045 KtToken SHORT_TEMPLATE_ENTRY_START = new KtToken("SHORT_TEMPLATE_ENTRY_START");
046 KtToken LONG_TEMPLATE_ENTRY_START = new KtToken("LONG_TEMPLATE_ENTRY_START");
047 KtToken LONG_TEMPLATE_ENTRY_END = new KtToken("LONG_TEMPLATE_ENTRY_END");
048 KtToken DANGLING_NEWLINE = new KtToken("DANGLING_NEWLINE");
049
050 KtKeywordToken PACKAGE_KEYWORD = KtKeywordToken.keyword("package");
051 KtKeywordToken AS_KEYWORD = KtKeywordToken.keyword("as");
052 KtKeywordToken TYPE_ALIAS_KEYWORD = KtKeywordToken.keyword("typealias");
053 KtKeywordToken CLASS_KEYWORD = KtKeywordToken.keyword("class");
054 KtKeywordToken THIS_KEYWORD = KtKeywordToken.keyword("this");
055 KtKeywordToken SUPER_KEYWORD = KtKeywordToken.keyword("super");
056 KtKeywordToken VAL_KEYWORD = KtKeywordToken.keyword("val");
057 KtKeywordToken VAR_KEYWORD = KtKeywordToken.keyword("var");
058 KtKeywordToken FUN_KEYWORD = KtKeywordToken.keyword("fun");
059 KtKeywordToken FOR_KEYWORD = KtKeywordToken.keyword("for");
060 KtKeywordToken NULL_KEYWORD = KtKeywordToken.keyword("null");
061 KtKeywordToken TRUE_KEYWORD = KtKeywordToken.keyword("true");
062 KtKeywordToken FALSE_KEYWORD = KtKeywordToken.keyword("false");
063 KtKeywordToken IS_KEYWORD = KtKeywordToken.keyword("is");
064 KtModifierKeywordToken IN_KEYWORD = KtModifierKeywordToken.keywordModifier("in");
065 KtKeywordToken THROW_KEYWORD = KtKeywordToken.keyword("throw");
066 KtKeywordToken RETURN_KEYWORD = KtKeywordToken.keyword("return");
067 KtKeywordToken BREAK_KEYWORD = KtKeywordToken.keyword("break");
068 KtKeywordToken CONTINUE_KEYWORD = KtKeywordToken.keyword("continue");
069 KtKeywordToken OBJECT_KEYWORD = KtKeywordToken.keyword("object");
070 KtKeywordToken IF_KEYWORD = KtKeywordToken.keyword("if");
071 KtKeywordToken TRY_KEYWORD = KtKeywordToken.keyword("try");
072 KtKeywordToken ELSE_KEYWORD = KtKeywordToken.keyword("else");
073 KtKeywordToken WHILE_KEYWORD = KtKeywordToken.keyword("while");
074 KtKeywordToken DO_KEYWORD = KtKeywordToken.keyword("do");
075 KtKeywordToken WHEN_KEYWORD = KtKeywordToken.keyword("when");
076 KtKeywordToken INTERFACE_KEYWORD = KtKeywordToken.keyword("interface");
077 // TODO: Discuss "This" keyword
078 KtKeywordToken CAPITALIZED_THIS_KEYWORD = KtKeywordToken.keyword("This");
079
080
081 KtToken AS_SAFE = KtKeywordToken.keyword("AS_SAFE");//new KtToken("as?");
082
083 KtToken IDENTIFIER = new KtToken("IDENTIFIER");
084
085 KtToken FIELD_IDENTIFIER = new KtToken("FIELD_IDENTIFIER");
086 KtSingleValueToken LBRACKET = new KtSingleValueToken("LBRACKET", "[");
087 KtSingleValueToken RBRACKET = new KtSingleValueToken("RBRACKET", "]");
088 KtSingleValueToken LBRACE = new KtSingleValueToken("LBRACE", "{");
089 KtSingleValueToken RBRACE = new KtSingleValueToken("RBRACE", "}");
090 KtSingleValueToken LPAR = new KtSingleValueToken("LPAR", "(");
091 KtSingleValueToken RPAR = new KtSingleValueToken("RPAR", ")");
092 KtSingleValueToken DOT = new KtSingleValueToken("DOT", ".");
093 KtSingleValueToken PLUSPLUS = new KtSingleValueToken("PLUSPLUS", "++");
094 KtSingleValueToken MINUSMINUS = new KtSingleValueToken("MINUSMINUS", "--");
095 KtSingleValueToken MUL = new KtSingleValueToken("MUL", "*");
096 KtSingleValueToken PLUS = new KtSingleValueToken("PLUS", "+");
097 KtSingleValueToken MINUS = new KtSingleValueToken("MINUS", "-");
098 KtSingleValueToken EXCL = new KtSingleValueToken("EXCL", "!");
099 KtSingleValueToken DIV = new KtSingleValueToken("DIV", "/");
100 KtSingleValueToken PERC = new KtSingleValueToken("PERC", "%");
101 KtSingleValueToken LT = new KtSingleValueToken("LT", "<");
102 KtSingleValueToken GT = new KtSingleValueToken("GT", ">");
103 KtSingleValueToken LTEQ = new KtSingleValueToken("LTEQ", "<=");
104 KtSingleValueToken GTEQ = new KtSingleValueToken("GTEQ", ">=");
105 KtSingleValueToken EQEQEQ = new KtSingleValueToken("EQEQEQ", "===");
106 KtSingleValueToken ARROW = new KtSingleValueToken("ARROW", "->");
107 KtSingleValueToken DOUBLE_ARROW = new KtSingleValueToken("DOUBLE_ARROW", "=>");
108 KtSingleValueToken EXCLEQEQEQ = new KtSingleValueToken("EXCLEQEQEQ", "!==");
109 KtSingleValueToken EQEQ = new KtSingleValueToken("EQEQ", "==");
110 KtSingleValueToken EXCLEQ = new KtSingleValueToken("EXCLEQ", "!=");
111 KtSingleValueToken EXCLEXCL = new KtSingleValueToken("EXCLEXCL", "!!");
112 KtSingleValueToken ANDAND = new KtSingleValueToken("ANDAND", "&&");
113 KtSingleValueToken OROR = new KtSingleValueToken("OROR", "||");
114 KtSingleValueToken SAFE_ACCESS = new KtSingleValueToken("SAFE_ACCESS", "?.");
115 KtSingleValueToken ELVIS = new KtSingleValueToken("ELVIS", "?:");
116 KtSingleValueToken QUEST = new KtSingleValueToken("QUEST", "?");
117 KtSingleValueToken COLONCOLON = new KtSingleValueToken("COLONCOLON", "::");
118 KtSingleValueToken COLON = new KtSingleValueToken("COLON", ":");
119 KtSingleValueToken SEMICOLON = new KtSingleValueToken("SEMICOLON", ";");
120 KtSingleValueToken DOUBLE_SEMICOLON = new KtSingleValueToken("DOUBLE_SEMICOLON", ";;");
121 KtSingleValueToken RANGE = new KtSingleValueToken("RANGE", "..");
122 KtSingleValueToken EQ = new KtSingleValueToken("EQ", "=");
123 KtSingleValueToken MULTEQ = new KtSingleValueToken("MULTEQ", "*=");
124 KtSingleValueToken DIVEQ = new KtSingleValueToken("DIVEQ", "/=");
125 KtSingleValueToken PERCEQ = new KtSingleValueToken("PERCEQ", "%=");
126 KtSingleValueToken PLUSEQ = new KtSingleValueToken("PLUSEQ", "+=");
127 KtSingleValueToken MINUSEQ = new KtSingleValueToken("MINUSEQ", "-=");
128 KtKeywordToken NOT_IN = KtKeywordToken.keyword("NOT_IN", "!in");
129 KtKeywordToken NOT_IS = KtKeywordToken.keyword("NOT_IS", "!is");
130 KtSingleValueToken HASH = new KtSingleValueToken("HASH", "#");
131 KtSingleValueToken AT = new KtSingleValueToken("AT", "@");
132
133 KtSingleValueToken COMMA = new KtSingleValueToken("COMMA", ",");
134
135 KtToken EOL_OR_SEMICOLON = new KtToken("EOL_OR_SEMICOLON");
136 KtKeywordToken FILE_KEYWORD = KtKeywordToken.softKeyword("file");
137 KtKeywordToken FIELD_KEYWORD = KtKeywordToken.softKeyword("field");
138 KtKeywordToken PROPERTY_KEYWORD = KtKeywordToken.softKeyword("property");
139 KtKeywordToken RECEIVER_KEYWORD = KtKeywordToken.softKeyword("receiver");
140 KtKeywordToken PARAM_KEYWORD = KtKeywordToken.softKeyword("param");
141 KtKeywordToken SETPARAM_KEYWORD = KtKeywordToken.softKeyword("setparam");
142 KtKeywordToken IMPORT_KEYWORD = KtKeywordToken.softKeyword("import");
143 KtKeywordToken WHERE_KEYWORD = KtKeywordToken.softKeyword("where");
144 KtKeywordToken BY_KEYWORD = KtKeywordToken.softKeyword("by");
145 KtKeywordToken GET_KEYWORD = KtKeywordToken.softKeyword("get");
146 KtKeywordToken SET_KEYWORD = KtKeywordToken.softKeyword("set");
147 KtKeywordToken CONSTRUCTOR_KEYWORD = KtKeywordToken.softKeyword("constructor");
148 KtKeywordToken INIT_KEYWORD = KtKeywordToken.softKeyword("init");
149
150 KtModifierKeywordToken ABSTRACT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("abstract");
151 KtModifierKeywordToken ENUM_KEYWORD = KtModifierKeywordToken.softKeywordModifier("enum");
152 KtModifierKeywordToken OPEN_KEYWORD = KtModifierKeywordToken.softKeywordModifier("open");
153 KtModifierKeywordToken INNER_KEYWORD = KtModifierKeywordToken.softKeywordModifier("inner");
154 KtModifierKeywordToken OVERRIDE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("override");
155 KtModifierKeywordToken PRIVATE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("private");
156 KtModifierKeywordToken PUBLIC_KEYWORD = KtModifierKeywordToken.softKeywordModifier("public");
157 KtModifierKeywordToken INTERNAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("internal");
158 KtModifierKeywordToken PROTECTED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("protected");
159 KtKeywordToken CATCH_KEYWORD = KtKeywordToken.softKeyword("catch");
160 KtModifierKeywordToken OUT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("out");
161 KtModifierKeywordToken VARARG_KEYWORD = KtModifierKeywordToken.softKeywordModifier("vararg");
162 KtModifierKeywordToken REIFIED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("reified");
163 KtKeywordToken DYNAMIC_KEYWORD = KtKeywordToken.softKeyword("dynamic");
164 KtModifierKeywordToken COMPANION_KEYWORD = KtModifierKeywordToken.softKeywordModifier("companion");
165 KtModifierKeywordToken SEALED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("sealed");
166
167 KtModifierKeywordToken DEFAULT_VISIBILITY_KEYWORD = PUBLIC_KEYWORD;
168
169 KtKeywordToken FINALLY_KEYWORD = KtKeywordToken.softKeyword("finally");
170 KtModifierKeywordToken FINAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("final");
171
172 KtModifierKeywordToken LATEINIT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("lateinit");
173
174 KtModifierKeywordToken DATA_KEYWORD = KtModifierKeywordToken.softKeywordModifier("data");
175 KtModifierKeywordToken INLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("inline");
176 KtModifierKeywordToken NOINLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("noinline");
177 KtModifierKeywordToken TAILREC_KEYWORD = KtModifierKeywordToken.softKeywordModifier("tailrec");
178 KtModifierKeywordToken EXTERNAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("external");
179 KtModifierKeywordToken ANNOTATION_KEYWORD = KtModifierKeywordToken.softKeywordModifier("annotation");
180 KtModifierKeywordToken CROSSINLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("crossinline");
181 KtModifierKeywordToken OPERATOR_KEYWORD = KtModifierKeywordToken.softKeywordModifier("operator");
182 KtModifierKeywordToken INFIX_KEYWORD = KtModifierKeywordToken.softKeywordModifier("infix");
183
184 KtModifierKeywordToken CONST_KEYWORD = KtModifierKeywordToken.softKeywordModifier("const");
185
186 TokenSet KEYWORDS = TokenSet.create(PACKAGE_KEYWORD, AS_KEYWORD, TYPE_ALIAS_KEYWORD, CLASS_KEYWORD, INTERFACE_KEYWORD,
187 THIS_KEYWORD, SUPER_KEYWORD, VAL_KEYWORD, VAR_KEYWORD, FUN_KEYWORD, FOR_KEYWORD,
188 NULL_KEYWORD,
189 TRUE_KEYWORD, FALSE_KEYWORD, IS_KEYWORD,
190 IN_KEYWORD, THROW_KEYWORD, RETURN_KEYWORD, BREAK_KEYWORD, CONTINUE_KEYWORD, OBJECT_KEYWORD, IF_KEYWORD,
191 ELSE_KEYWORD, WHILE_KEYWORD, DO_KEYWORD, TRY_KEYWORD, WHEN_KEYWORD,
192 NOT_IN, NOT_IS, CAPITALIZED_THIS_KEYWORD, AS_SAFE
193 );
194
195 TokenSet SOFT_KEYWORDS = TokenSet.create(FILE_KEYWORD, IMPORT_KEYWORD, WHERE_KEYWORD, BY_KEYWORD, GET_KEYWORD,
196 SET_KEYWORD, ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD,
197 OVERRIDE_KEYWORD, PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD,
198 CATCH_KEYWORD, FINALLY_KEYWORD, OUT_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD, REIFIED_KEYWORD,
199 DYNAMIC_KEYWORD, COMPANION_KEYWORD, CONSTRUCTOR_KEYWORD, INIT_KEYWORD, SEALED_KEYWORD,
200 FIELD_KEYWORD, PROPERTY_KEYWORD, RECEIVER_KEYWORD, PARAM_KEYWORD, SETPARAM_KEYWORD,
201 LATEINIT_KEYWORD,
202 DATA_KEYWORD, INLINE_KEYWORD, NOINLINE_KEYWORD, TAILREC_KEYWORD, EXTERNAL_KEYWORD,
203 ANNOTATION_KEYWORD, CROSSINLINE_KEYWORD, CONST_KEYWORD, OPERATOR_KEYWORD, INFIX_KEYWORD
204 );
205
206 /*
207 This array is used in stub serialization:
208 1. Do not change order.
209 2. If you add an entry or change order, increase stub version.
210 */
211 KtModifierKeywordToken[] MODIFIER_KEYWORDS_ARRAY =
212 new KtModifierKeywordToken[] {
213 ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD, OVERRIDE_KEYWORD, PRIVATE_KEYWORD,
214 PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD, OUT_KEYWORD, IN_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD,
215 REIFIED_KEYWORD, COMPANION_KEYWORD, SEALED_KEYWORD, LATEINIT_KEYWORD,
216 DATA_KEYWORD, INLINE_KEYWORD, NOINLINE_KEYWORD, TAILREC_KEYWORD, EXTERNAL_KEYWORD, ANNOTATION_KEYWORD, CROSSINLINE_KEYWORD,
217 CONST_KEYWORD, OPERATOR_KEYWORD, INFIX_KEYWORD
218 };
219
220 TokenSet MODIFIER_KEYWORDS = TokenSet.create(MODIFIER_KEYWORDS_ARRAY);
221
222 TokenSet VISIBILITY_MODIFIERS = TokenSet.create(PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD);
223
224 TokenSet WHITESPACES = TokenSet.create(TokenType.WHITE_SPACE);
225
226 /**
227 * Don't add KDocTokens to COMMENTS TokenSet, because it is used in JetParserDefinition.getCommentTokens(),
228 * and therefor all COMMENTS tokens will be ignored by PsiBuilder.
229 *
230 * @see KtPsiUtil#isInComment(com.intellij.psi.PsiElement)
231 */
232 TokenSet COMMENTS = TokenSet.create(EOL_COMMENT, BLOCK_COMMENT, DOC_COMMENT, SHEBANG_COMMENT);
233 TokenSet WHITE_SPACE_OR_COMMENT_BIT_SET = TokenSet.orSet(COMMENTS, TokenSet.create(WHITE_SPACE));
234
235 TokenSet STRINGS = TokenSet.create(CHARACTER_LITERAL, REGULAR_STRING_PART);
236 TokenSet OPERATIONS = TokenSet.create(AS_KEYWORD, AS_SAFE, IS_KEYWORD, IN_KEYWORD, DOT, PLUSPLUS, MINUSMINUS, EXCLEXCL, MUL, PLUS,
237 MINUS, EXCL, DIV, PERC, LT, GT, LTEQ, GTEQ, EQEQEQ, EXCLEQEQEQ, EQEQ, EXCLEQ, ANDAND, OROR,
238 SAFE_ACCESS, ELVIS,
239 // MAP, FILTER,
240 RANGE, EQ, MULTEQ, DIVEQ, PERCEQ, PLUSEQ, MINUSEQ,
241 NOT_IN, NOT_IS,
242 IDENTIFIER);
243
244 TokenSet AUGMENTED_ASSIGNMENTS = TokenSet.create(PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
245 TokenSet ALL_ASSIGNMENTS = TokenSet.create(EQ, PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
246 }