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 KtToken AS_SAFE = KtKeywordToken.keyword("AS_SAFE");//new KtToken("as?");
081
082 KtToken IDENTIFIER = new KtToken("IDENTIFIER");
083
084 KtToken FIELD_IDENTIFIER = new KtToken("FIELD_IDENTIFIER");
085 KtSingleValueToken LBRACKET = new KtSingleValueToken("LBRACKET", "[");
086 KtSingleValueToken RBRACKET = new KtSingleValueToken("RBRACKET", "]");
087 KtSingleValueToken LBRACE = new KtSingleValueToken("LBRACE", "{");
088 KtSingleValueToken RBRACE = new KtSingleValueToken("RBRACE", "}");
089 KtSingleValueToken LPAR = new KtSingleValueToken("LPAR", "(");
090 KtSingleValueToken RPAR = new KtSingleValueToken("RPAR", ")");
091 KtSingleValueToken DOT = new KtSingleValueToken("DOT", ".");
092 KtSingleValueToken PLUSPLUS = new KtSingleValueToken("PLUSPLUS", "++");
093 KtSingleValueToken MINUSMINUS = new KtSingleValueToken("MINUSMINUS", "--");
094 KtSingleValueToken MUL = new KtSingleValueToken("MUL", "*");
095 KtSingleValueToken PLUS = new KtSingleValueToken("PLUS", "+");
096 KtSingleValueToken MINUS = new KtSingleValueToken("MINUS", "-");
097 KtSingleValueToken EXCL = new KtSingleValueToken("EXCL", "!");
098 KtSingleValueToken DIV = new KtSingleValueToken("DIV", "/");
099 KtSingleValueToken PERC = new KtSingleValueToken("PERC", "%");
100 KtSingleValueToken LT = new KtSingleValueToken("LT", "<");
101 KtSingleValueToken GT = new KtSingleValueToken("GT", ">");
102 KtSingleValueToken LTEQ = new KtSingleValueToken("LTEQ", "<=");
103 KtSingleValueToken GTEQ = new KtSingleValueToken("GTEQ", ">=");
104 KtSingleValueToken EQEQEQ = new KtSingleValueToken("EQEQEQ", "===");
105 KtSingleValueToken ARROW = new KtSingleValueToken("ARROW", "->");
106 KtSingleValueToken DOUBLE_ARROW = new KtSingleValueToken("DOUBLE_ARROW", "=>");
107 KtSingleValueToken EXCLEQEQEQ = new KtSingleValueToken("EXCLEQEQEQ", "!==");
108 KtSingleValueToken EQEQ = new KtSingleValueToken("EQEQ", "==");
109 KtSingleValueToken EXCLEQ = new KtSingleValueToken("EXCLEQ", "!=");
110 KtSingleValueToken EXCLEXCL = new KtSingleValueToken("EXCLEXCL", "!!");
111 KtSingleValueToken ANDAND = new KtSingleValueToken("ANDAND", "&&");
112 KtSingleValueToken OROR = new KtSingleValueToken("OROR", "||");
113 KtSingleValueToken SAFE_ACCESS = new KtSingleValueToken("SAFE_ACCESS", "?.");
114 KtSingleValueToken ELVIS = new KtSingleValueToken("ELVIS", "?:");
115 KtSingleValueToken QUEST = new KtSingleValueToken("QUEST", "?");
116 KtSingleValueToken COLONCOLON = new KtSingleValueToken("COLONCOLON", "::");
117 KtSingleValueToken COLON = new KtSingleValueToken("COLON", ":");
118 KtSingleValueToken SEMICOLON = new KtSingleValueToken("SEMICOLON", ";");
119 KtSingleValueToken DOUBLE_SEMICOLON = new KtSingleValueToken("DOUBLE_SEMICOLON", ";;");
120 KtSingleValueToken RANGE = new KtSingleValueToken("RANGE", "..");
121 KtSingleValueToken EQ = new KtSingleValueToken("EQ", "=");
122 KtSingleValueToken MULTEQ = new KtSingleValueToken("MULTEQ", "*=");
123 KtSingleValueToken DIVEQ = new KtSingleValueToken("DIVEQ", "/=");
124 KtSingleValueToken PERCEQ = new KtSingleValueToken("PERCEQ", "%=");
125 KtSingleValueToken PLUSEQ = new KtSingleValueToken("PLUSEQ", "+=");
126 KtSingleValueToken MINUSEQ = new KtSingleValueToken("MINUSEQ", "-=");
127 KtKeywordToken NOT_IN = KtKeywordToken.keyword("NOT_IN", "!in");
128 KtKeywordToken NOT_IS = KtKeywordToken.keyword("NOT_IS", "!is");
129 KtSingleValueToken HASH = new KtSingleValueToken("HASH", "#");
130 KtSingleValueToken AT = new KtSingleValueToken("AT", "@");
131
132 KtSingleValueToken COMMA = new KtSingleValueToken("COMMA", ",");
133
134 KtToken EOL_OR_SEMICOLON = new KtToken("EOL_OR_SEMICOLON");
135 KtKeywordToken FILE_KEYWORD = KtKeywordToken.softKeyword("file");
136 KtKeywordToken FIELD_KEYWORD = KtKeywordToken.softKeyword("field");
137 KtKeywordToken PROPERTY_KEYWORD = KtKeywordToken.softKeyword("property");
138 KtKeywordToken RECEIVER_KEYWORD = KtKeywordToken.softKeyword("receiver");
139 KtKeywordToken PARAM_KEYWORD = KtKeywordToken.softKeyword("param");
140 KtKeywordToken SETPARAM_KEYWORD = KtKeywordToken.softKeyword("setparam");
141 KtKeywordToken IMPORT_KEYWORD = KtKeywordToken.softKeyword("import");
142 KtKeywordToken WHERE_KEYWORD = KtKeywordToken.softKeyword("where");
143 KtKeywordToken BY_KEYWORD = KtKeywordToken.softKeyword("by");
144 KtKeywordToken GET_KEYWORD = KtKeywordToken.softKeyword("get");
145 KtKeywordToken SET_KEYWORD = KtKeywordToken.softKeyword("set");
146 KtKeywordToken CONSTRUCTOR_KEYWORD = KtKeywordToken.softKeyword("constructor");
147 KtKeywordToken INIT_KEYWORD = KtKeywordToken.softKeyword("init");
148
149 KtModifierKeywordToken ABSTRACT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("abstract");
150 KtModifierKeywordToken ENUM_KEYWORD = KtModifierKeywordToken.softKeywordModifier("enum");
151 KtModifierKeywordToken OPEN_KEYWORD = KtModifierKeywordToken.softKeywordModifier("open");
152 KtModifierKeywordToken INNER_KEYWORD = KtModifierKeywordToken.softKeywordModifier("inner");
153 KtModifierKeywordToken OVERRIDE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("override");
154 KtModifierKeywordToken PRIVATE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("private");
155 KtModifierKeywordToken PUBLIC_KEYWORD = KtModifierKeywordToken.softKeywordModifier("public");
156 KtModifierKeywordToken INTERNAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("internal");
157 KtModifierKeywordToken PROTECTED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("protected");
158 KtKeywordToken CATCH_KEYWORD = KtKeywordToken.softKeyword("catch");
159 KtModifierKeywordToken OUT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("out");
160 KtModifierKeywordToken VARARG_KEYWORD = KtModifierKeywordToken.softKeywordModifier("vararg");
161 KtModifierKeywordToken REIFIED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("reified");
162 KtKeywordToken DYNAMIC_KEYWORD = KtKeywordToken.softKeyword("dynamic");
163 KtModifierKeywordToken COMPANION_KEYWORD = KtModifierKeywordToken.softKeywordModifier("companion");
164 KtModifierKeywordToken SEALED_KEYWORD = KtModifierKeywordToken.softKeywordModifier("sealed");
165
166 KtModifierKeywordToken DEFAULT_VISIBILITY_KEYWORD = PUBLIC_KEYWORD;
167
168 KtKeywordToken FINALLY_KEYWORD = KtKeywordToken.softKeyword("finally");
169 KtModifierKeywordToken FINAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("final");
170
171 KtModifierKeywordToken LATEINIT_KEYWORD = KtModifierKeywordToken.softKeywordModifier("lateinit");
172
173 KtModifierKeywordToken DATA_KEYWORD = KtModifierKeywordToken.softKeywordModifier("data");
174 KtModifierKeywordToken INLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("inline");
175 KtModifierKeywordToken NOINLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("noinline");
176 KtModifierKeywordToken TAILREC_KEYWORD = KtModifierKeywordToken.softKeywordModifier("tailrec");
177 KtModifierKeywordToken EXTERNAL_KEYWORD = KtModifierKeywordToken.softKeywordModifier("external");
178 KtModifierKeywordToken ANNOTATION_KEYWORD = KtModifierKeywordToken.softKeywordModifier("annotation");
179 KtModifierKeywordToken CROSSINLINE_KEYWORD = KtModifierKeywordToken.softKeywordModifier("crossinline");
180 KtModifierKeywordToken OPERATOR_KEYWORD = KtModifierKeywordToken.softKeywordModifier("operator");
181 KtModifierKeywordToken INFIX_KEYWORD = KtModifierKeywordToken.softKeywordModifier("infix");
182
183 KtModifierKeywordToken CONST_KEYWORD = KtModifierKeywordToken.softKeywordModifier("const");
184
185 TokenSet KEYWORDS = TokenSet.create(PACKAGE_KEYWORD, AS_KEYWORD, TYPE_ALIAS_KEYWORD, CLASS_KEYWORD, INTERFACE_KEYWORD,
186 THIS_KEYWORD, SUPER_KEYWORD, VAL_KEYWORD, VAR_KEYWORD, FUN_KEYWORD, FOR_KEYWORD,
187 NULL_KEYWORD,
188 TRUE_KEYWORD, FALSE_KEYWORD, IS_KEYWORD,
189 IN_KEYWORD, THROW_KEYWORD, RETURN_KEYWORD, BREAK_KEYWORD, CONTINUE_KEYWORD, OBJECT_KEYWORD, IF_KEYWORD,
190 ELSE_KEYWORD, WHILE_KEYWORD, DO_KEYWORD, TRY_KEYWORD, WHEN_KEYWORD,
191 NOT_IN, NOT_IS, AS_SAFE
192 );
193
194 TokenSet SOFT_KEYWORDS = TokenSet.create(FILE_KEYWORD, IMPORT_KEYWORD, WHERE_KEYWORD, BY_KEYWORD, GET_KEYWORD,
195 SET_KEYWORD, ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD,
196 OVERRIDE_KEYWORD, PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD,
197 CATCH_KEYWORD, FINALLY_KEYWORD, OUT_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD, REIFIED_KEYWORD,
198 DYNAMIC_KEYWORD, COMPANION_KEYWORD, CONSTRUCTOR_KEYWORD, INIT_KEYWORD, SEALED_KEYWORD,
199 FIELD_KEYWORD, PROPERTY_KEYWORD, RECEIVER_KEYWORD, PARAM_KEYWORD, SETPARAM_KEYWORD,
200 LATEINIT_KEYWORD,
201 DATA_KEYWORD, INLINE_KEYWORD, NOINLINE_KEYWORD, TAILREC_KEYWORD, EXTERNAL_KEYWORD,
202 ANNOTATION_KEYWORD, CROSSINLINE_KEYWORD, CONST_KEYWORD, OPERATOR_KEYWORD, INFIX_KEYWORD
203 );
204
205 /*
206 This array is used in stub serialization:
207 1. Do not change order.
208 2. If you add an entry or change order, increase stub version.
209 */
210 KtModifierKeywordToken[] MODIFIER_KEYWORDS_ARRAY =
211 new KtModifierKeywordToken[] {
212 ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD, OVERRIDE_KEYWORD, PRIVATE_KEYWORD,
213 PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD, OUT_KEYWORD, IN_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD,
214 REIFIED_KEYWORD, COMPANION_KEYWORD, SEALED_KEYWORD, LATEINIT_KEYWORD,
215 DATA_KEYWORD, INLINE_KEYWORD, NOINLINE_KEYWORD, TAILREC_KEYWORD, EXTERNAL_KEYWORD, ANNOTATION_KEYWORD, CROSSINLINE_KEYWORD,
216 CONST_KEYWORD, OPERATOR_KEYWORD, INFIX_KEYWORD
217 };
218
219 TokenSet MODIFIER_KEYWORDS = TokenSet.create(MODIFIER_KEYWORDS_ARRAY);
220
221 TokenSet VISIBILITY_MODIFIERS = TokenSet.create(PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD);
222
223 TokenSet WHITESPACES = TokenSet.create(TokenType.WHITE_SPACE);
224
225 /**
226 * Don't add KDocTokens to COMMENTS TokenSet, because it is used in KotlinParserDefinition.getCommentTokens(),
227 * and therefor all COMMENTS tokens will be ignored by PsiBuilder.
228 *
229 * @see KtPsiUtil#isInComment(com.intellij.psi.PsiElement)
230 */
231 TokenSet COMMENTS = TokenSet.create(EOL_COMMENT, BLOCK_COMMENT, DOC_COMMENT, SHEBANG_COMMENT);
232 TokenSet WHITE_SPACE_OR_COMMENT_BIT_SET = TokenSet.orSet(COMMENTS, TokenSet.create(WHITE_SPACE));
233
234 TokenSet STRINGS = TokenSet.create(CHARACTER_LITERAL, REGULAR_STRING_PART);
235 TokenSet OPERATIONS = TokenSet.create(AS_KEYWORD, AS_SAFE, IS_KEYWORD, IN_KEYWORD, DOT, PLUSPLUS, MINUSMINUS, EXCLEXCL, MUL, PLUS,
236 MINUS, EXCL, DIV, PERC, LT, GT, LTEQ, GTEQ, EQEQEQ, EXCLEQEQEQ, EQEQ, EXCLEQ, ANDAND, OROR,
237 SAFE_ACCESS, ELVIS,
238 // MAP, FILTER,
239 RANGE, EQ, MULTEQ, DIVEQ, PERCEQ, PLUSEQ, MINUSEQ,
240 NOT_IN, NOT_IS,
241 IDENTIFIER);
242
243 TokenSet AUGMENTED_ASSIGNMENTS = TokenSet.create(PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
244 TokenSet ALL_ASSIGNMENTS = TokenSet.create(EQ, PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
245 }