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