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 // TODO: Discuss "This" keyword
077 JetKeywordToken CAPITALIZED_THIS_KEYWORD = JetKeywordToken.keyword("This");
078
079
080 JetToken AS_SAFE = JetKeywordToken.keyword("AS_SAFE");//new JetToken("as?");
081
082 JetToken IDENTIFIER = new JetToken("IDENTIFIER");
083 JetToken LABEL_IDENTIFIER = new JetToken("LABEL_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
131 JetSingleValueToken COMMA = new JetSingleValueToken("COMMA", ",");
132
133 JetToken EOL_OR_SEMICOLON = new JetToken("EOL_OR_SEMICOLON");
134 JetKeywordToken FILE_KEYWORD = JetKeywordToken.softKeyword("file");
135 JetKeywordToken IMPORT_KEYWORD = JetKeywordToken.softKeyword("import");
136 JetKeywordToken WHERE_KEYWORD = JetKeywordToken.softKeyword("where");
137 JetKeywordToken BY_KEYWORD = JetKeywordToken.softKeyword("by");
138 JetKeywordToken GET_KEYWORD = JetKeywordToken.softKeyword("get");
139 JetKeywordToken SET_KEYWORD = JetKeywordToken.softKeyword("set");
140 JetModifierKeywordToken ABSTRACT_KEYWORD = JetModifierKeywordToken.softKeywordModifier("abstract");
141 JetModifierKeywordToken ENUM_KEYWORD = JetModifierKeywordToken.softKeywordModifier("enum");
142 JetModifierKeywordToken OPEN_KEYWORD = JetModifierKeywordToken.softKeywordModifier("open");
143 JetModifierKeywordToken INNER_KEYWORD = JetModifierKeywordToken.softKeywordModifier("inner");
144 JetModifierKeywordToken ANNOTATION_KEYWORD = JetModifierKeywordToken.softKeywordModifier("annotation");
145 JetModifierKeywordToken OVERRIDE_KEYWORD = JetModifierKeywordToken.softKeywordModifier("override");
146 JetModifierKeywordToken PRIVATE_KEYWORD = JetModifierKeywordToken.softKeywordModifier("private");
147 JetModifierKeywordToken PUBLIC_KEYWORD = JetModifierKeywordToken.softKeywordModifier("public");
148 JetModifierKeywordToken INTERNAL_KEYWORD = JetModifierKeywordToken.softKeywordModifier("internal");
149 JetModifierKeywordToken PROTECTED_KEYWORD = JetModifierKeywordToken.softKeywordModifier("protected");
150 JetKeywordToken CATCH_KEYWORD = JetKeywordToken.softKeyword("catch");
151 JetModifierKeywordToken OUT_KEYWORD = JetModifierKeywordToken.softKeywordModifier("out");
152 JetModifierKeywordToken VARARG_KEYWORD = JetModifierKeywordToken.softKeywordModifier("vararg");
153 JetModifierKeywordToken REIFIED_KEYWORD = JetModifierKeywordToken.softKeywordModifier("reified");
154 JetModifierKeywordToken DYNAMIC_KEYWORD = JetModifierKeywordToken.softKeywordModifier("dynamic");
155 JetModifierKeywordToken DEFAULT_KEYWORD = JetModifierKeywordToken.softKeywordModifier("default");
156
157 JetKeywordToken FINALLY_KEYWORD = JetKeywordToken.softKeyword("finally");
158 JetModifierKeywordToken FINAL_KEYWORD = JetModifierKeywordToken.softKeywordModifier("final");
159
160 TokenSet KEYWORDS = TokenSet.create(PACKAGE_KEYWORD, AS_KEYWORD, TYPE_ALIAS_KEYWORD, CLASS_KEYWORD, TRAIT_KEYWORD,
161 THIS_KEYWORD, SUPER_KEYWORD, VAL_KEYWORD, VAR_KEYWORD, FUN_KEYWORD, FOR_KEYWORD,
162 NULL_KEYWORD,
163 TRUE_KEYWORD, FALSE_KEYWORD, IS_KEYWORD,
164 IN_KEYWORD, THROW_KEYWORD, RETURN_KEYWORD, BREAK_KEYWORD, CONTINUE_KEYWORD, OBJECT_KEYWORD, IF_KEYWORD,
165 ELSE_KEYWORD, WHILE_KEYWORD, DO_KEYWORD, TRY_KEYWORD, WHEN_KEYWORD,
166 NOT_IN, NOT_IS, CAPITALIZED_THIS_KEYWORD, AS_SAFE
167 );
168
169 TokenSet SOFT_KEYWORDS = TokenSet.create(FILE_KEYWORD, IMPORT_KEYWORD, WHERE_KEYWORD, BY_KEYWORD, GET_KEYWORD,
170 SET_KEYWORD, ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD, ANNOTATION_KEYWORD,
171 OVERRIDE_KEYWORD, PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD,
172 CATCH_KEYWORD, FINALLY_KEYWORD, OUT_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD, REIFIED_KEYWORD,
173 DYNAMIC_KEYWORD, DEFAULT_KEYWORD
174 );
175
176 /*
177 This array is used in stub serialization:
178 1. Do not change order.
179 2. If you add an entry or change order, increase stub version.
180 */
181 JetModifierKeywordToken[] MODIFIER_KEYWORDS_ARRAY =
182 new JetModifierKeywordToken[] {
183 ABSTRACT_KEYWORD, ENUM_KEYWORD, OPEN_KEYWORD, INNER_KEYWORD, ANNOTATION_KEYWORD, OVERRIDE_KEYWORD, PRIVATE_KEYWORD,
184 PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD, OUT_KEYWORD, IN_KEYWORD, FINAL_KEYWORD, VARARG_KEYWORD,
185 REIFIED_KEYWORD, DEFAULT_KEYWORD
186 };
187
188 TokenSet MODIFIER_KEYWORDS = TokenSet.create(MODIFIER_KEYWORDS_ARRAY);
189
190 TokenSet VISIBILITY_MODIFIERS = TokenSet.create(PRIVATE_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD, PROTECTED_KEYWORD);
191
192 TokenSet WHITESPACES = TokenSet.create(TokenType.WHITE_SPACE);
193
194 /**
195 * Don't add KDocTokens to COMMENTS TokenSet, because it is used in JetParserDefinition.getCommentTokens(),
196 * and therefor all COMMENTS tokens will be ignored by PsiBuilder.
197 *
198 * @see org.jetbrains.kotlin.psi.JetPsiUtil#isInComment(com.intellij.psi.PsiElement)
199 */
200 TokenSet COMMENTS = TokenSet.create(EOL_COMMENT, BLOCK_COMMENT, DOC_COMMENT, SHEBANG_COMMENT);
201 TokenSet WHITE_SPACE_OR_COMMENT_BIT_SET = TokenSet.orSet(COMMENTS, TokenSet.create(WHITE_SPACE));
202
203 TokenSet STRINGS = TokenSet.create(CHARACTER_LITERAL, REGULAR_STRING_PART);
204 TokenSet OPERATIONS = TokenSet.create(AS_KEYWORD, AS_SAFE, IS_KEYWORD, IN_KEYWORD, DOT, PLUSPLUS, MINUSMINUS, EXCLEXCL, MUL, PLUS,
205 MINUS, EXCL, DIV, PERC, LT, GT, LTEQ, GTEQ, EQEQEQ, EXCLEQEQEQ, EQEQ, EXCLEQ, ANDAND, OROR,
206 SAFE_ACCESS, ELVIS,
207 // MAP, FILTER,
208 COLON,
209 RANGE, EQ, MULTEQ, DIVEQ, PERCEQ, PLUSEQ, MINUSEQ,
210 NOT_IN, NOT_IS,
211 IDENTIFIER, LABEL_IDENTIFIER);
212
213 TokenSet AUGMENTED_ASSIGNMENTS = TokenSet.create(PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
214 TokenSet ALL_ASSIGNMENTS = TokenSet.create(EQ, PLUSEQ, MINUSEQ, MULTEQ, PERCEQ, DIVEQ);
215 }