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