001 /*
002 * Copyright 2010-2014 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.jet.lang.resolve;
018
019 import com.google.common.collect.Lists;
020 import com.google.common.collect.Maps;
021 import com.google.common.collect.Sets;
022 import com.intellij.lang.ASTNode;
023 import com.intellij.openapi.util.Pair;
024 import com.intellij.psi.PsiElement;
025 import org.jetbrains.annotations.NotNull;
026 import org.jetbrains.annotations.Nullable;
027 import org.jetbrains.jet.lang.descriptors.*;
028 import org.jetbrains.jet.lang.descriptors.annotations.AnnotationDescriptor;
029 import org.jetbrains.jet.lang.diagnostics.Errors;
030 import org.jetbrains.jet.lang.psi.*;
031 import org.jetbrains.jet.lang.resolve.constants.*;
032 import org.jetbrains.jet.lang.resolve.name.FqName;
033 import org.jetbrains.jet.lang.resolve.name.Name;
034 import org.jetbrains.jet.lexer.JetModifierKeywordToken;
035
036 import java.util.Collection;
037 import java.util.Collections;
038 import java.util.Map;
039
040 import static org.jetbrains.jet.lang.diagnostics.Errors.*;
041 import static org.jetbrains.jet.lexer.JetTokens.*;
042
043 public class ModifiersChecker {
044 private static final Collection<JetModifierKeywordToken> MODALITY_MODIFIERS =
045 Lists.newArrayList(ABSTRACT_KEYWORD, OPEN_KEYWORD, FINAL_KEYWORD, OVERRIDE_KEYWORD);
046
047 private static final Collection<JetModifierKeywordToken> VISIBILITY_MODIFIERS =
048 Lists.newArrayList(PRIVATE_KEYWORD, PROTECTED_KEYWORD, PUBLIC_KEYWORD, INTERNAL_KEYWORD);
049
050 public static void reportIllegalModifiers(
051 @Nullable JetModifierList modifierList,
052 @NotNull Collection<JetModifierKeywordToken> illegalModifiers,
053 @NotNull BindingTrace trace
054 ) {
055 if (modifierList == null) return;
056
057 for (JetModifierKeywordToken modifierToken : illegalModifiers) {
058 if (modifierList.hasModifier(modifierToken)) {
059 PsiElement modifierPsi = modifierList.getModifier(modifierToken);
060 assert modifierPsi != null;
061 trace.report(ILLEGAL_MODIFIER.on(modifierPsi, modifierToken));
062 }
063 }
064 }
065
066 @NotNull
067 private final BindingTrace trace;
068
069 public ModifiersChecker(@NotNull BindingTrace trace) {
070 this.trace = trace;
071 }
072
073 public static ModifiersChecker create(@NotNull BindingTrace trace) {
074 return new ModifiersChecker(trace);
075 }
076
077 public void checkModifiersForDeclaration(@NotNull JetModifierListOwner modifierListOwner, @NotNull DeclarationDescriptor descriptor) {
078 JetModifierList modifierList = modifierListOwner.getModifierList();
079 checkModalityModifiers(modifierList);
080 checkVisibilityModifiers(modifierListOwner, descriptor);
081 checkInnerModifier(modifierListOwner, descriptor);
082 checkPlatformNameApplicability(descriptor);
083 }
084
085 public void checkModifiersForLocalDeclaration(@NotNull JetModifierListOwner modifierListOwner, @NotNull DeclarationDescriptor descriptor) {
086 checkIllegalModalityModifiers(modifierListOwner);
087 checkIllegalVisibilityModifiers(modifierListOwner);
088 checkPlatformNameApplicability(descriptor);
089 }
090
091 public void checkIllegalModalityModifiers(@NotNull JetModifierListOwner modifierListOwner) {
092 checkIllegalInThisContextModifiers(modifierListOwner.getModifierList(), MODALITY_MODIFIERS);
093 }
094
095 public void checkIllegalVisibilityModifiers(@NotNull JetModifierListOwner modifierListOwner) {
096 checkIllegalInThisContextModifiers(modifierListOwner.getModifierList(), VISIBILITY_MODIFIERS);
097 }
098
099 private void checkModalityModifiers(@Nullable JetModifierList modifierList) {
100 if (modifierList == null) return;
101 checkRedundantModifier(modifierList, Pair.create(OPEN_KEYWORD, ABSTRACT_KEYWORD), Pair.create(OPEN_KEYWORD, OVERRIDE_KEYWORD));
102
103 checkCompatibility(modifierList, Lists.newArrayList(ABSTRACT_KEYWORD, OPEN_KEYWORD, FINAL_KEYWORD),
104 Lists.newArrayList(ABSTRACT_KEYWORD, OPEN_KEYWORD));
105 }
106
107 private void checkVisibilityModifiers(@NotNull JetModifierListOwner modifierListOwner, @NotNull DeclarationDescriptor descriptor) {
108 JetModifierList modifierList = modifierListOwner.getModifierList();
109 if (modifierList == null) return;
110
111 DeclarationDescriptor containingDeclaration = descriptor.getContainingDeclaration();
112 if (containingDeclaration instanceof PackageFragmentDescriptor) {
113 if (modifierList.hasModifier(PROTECTED_KEYWORD)) {
114 trace.report(Errors.PACKAGE_MEMBER_CANNOT_BE_PROTECTED.on(modifierListOwner));
115 }
116 }
117
118 checkCompatibility(modifierList, VISIBILITY_MODIFIERS);
119 }
120
121 private void checkInnerModifier(@NotNull JetModifierListOwner modifierListOwner, @NotNull DeclarationDescriptor descriptor) {
122 if (modifierListOwner.hasModifier(INNER_KEYWORD)) {
123 if (isIllegalInner(descriptor)) {
124 checkIllegalInThisContextModifiers(modifierListOwner.getModifierList(), Collections.singletonList(INNER_KEYWORD));
125 }
126 return;
127 }
128 if (modifierListOwner instanceof JetClass && !(modifierListOwner instanceof JetEnumEntry)) {
129 JetClass aClass = (JetClass) modifierListOwner;
130 boolean localEnumError = aClass.isLocal() && aClass.isEnum();
131 if (!localEnumError && isIllegalNestedClass(descriptor)) {
132 trace.report(NESTED_CLASS_NOT_ALLOWED.on(aClass));
133 }
134 }
135 }
136
137 private static boolean isIllegalInner(@NotNull DeclarationDescriptor descriptor) {
138 if (!(descriptor instanceof ClassDescriptor)) return true;
139 ClassDescriptor classDescriptor = (ClassDescriptor) descriptor;
140 if (classDescriptor.getKind() != ClassKind.CLASS) return true;
141 DeclarationDescriptor containingDeclaration = classDescriptor.getContainingDeclaration();
142 if (!(containingDeclaration instanceof ClassDescriptor)) return true;
143 return ((ClassDescriptor) containingDeclaration).getKind() == ClassKind.TRAIT;
144 }
145
146 private static boolean isIllegalNestedClass(@NotNull DeclarationDescriptor descriptor) {
147 if (!(descriptor instanceof ClassDescriptor)) return false;
148 DeclarationDescriptor containingDeclaration = descriptor.getContainingDeclaration();
149 if (!(containingDeclaration instanceof ClassDescriptor)) return false;
150 ClassDescriptor containingClass = (ClassDescriptor) containingDeclaration;
151 return containingClass.isInner() || containingClass.getContainingDeclaration() instanceof FunctionDescriptor;
152 }
153
154 private void checkPlatformNameApplicability(@NotNull DeclarationDescriptor descriptor) {
155 if (descriptor instanceof PropertyDescriptor) {
156 PropertyDescriptor propertyDescriptor = (PropertyDescriptor) descriptor;
157 if (propertyDescriptor.getGetter() != null) {
158 checkPlatformNameApplicability(propertyDescriptor.getGetter());
159 }
160 if (propertyDescriptor.getSetter() != null) {
161 checkPlatformNameApplicability(propertyDescriptor.getSetter());
162 }
163 }
164
165 AnnotationDescriptor annotation = descriptor.getAnnotations().findAnnotation(new FqName("kotlin.platform.platformName"));
166 if (annotation == null) return;
167
168 JetAnnotationEntry annotationEntry = trace.get(BindingContext.ANNOTATION_DESCRIPTOR_TO_PSI_ELEMENT, annotation);
169 if (annotationEntry == null) return;
170
171 if (!DescriptorUtils.isTopLevelDeclaration(descriptor) || !(descriptor instanceof FunctionDescriptor)) {
172 trace.report(INAPPLICABLE_ANNOTATION.on(annotationEntry));
173 }
174
175 Collection<CompileTimeConstant<?>> values = annotation.getAllValueArguments().values();
176 if (!values.isEmpty()) {
177 CompileTimeConstant<?> name = values.iterator().next();
178 if (name instanceof StringValue) {
179 String value = ((StringValue) name).getValue();
180 if (value == null || !Name.isValidIdentifier(value)) {
181 trace.report(ILLEGAL_PLATFORM_NAME.on(annotationEntry, String.valueOf(value)));
182 }
183 }
184 }
185 }
186
187 private void checkCompatibility(@Nullable JetModifierList modifierList, Collection<JetModifierKeywordToken> availableModifiers, Collection<JetModifierKeywordToken>... availableCombinations) {
188 if (modifierList == null) return;
189 Collection<JetModifierKeywordToken> presentModifiers = Sets.newLinkedHashSet();
190 for (JetModifierKeywordToken modifier : availableModifiers) {
191 if (modifierList.hasModifier(modifier)) {
192 presentModifiers.add(modifier);
193 }
194 }
195 if (presentModifiers.size() == 1) {
196 return;
197 }
198 for (Collection<JetModifierKeywordToken> combination : availableCombinations) {
199 if (presentModifiers.containsAll(combination) && combination.containsAll(presentModifiers)) {
200 return;
201 }
202 }
203 for (JetModifierKeywordToken token : presentModifiers) {
204 trace.report(Errors.INCOMPATIBLE_MODIFIERS.on(modifierList.getModifierNode(token).getPsi(), presentModifiers));
205 }
206 }
207
208 private void checkRedundantModifier(@NotNull JetModifierList modifierList, Pair<JetModifierKeywordToken, JetModifierKeywordToken>... redundantBundles) {
209 for (Pair<JetModifierKeywordToken, JetModifierKeywordToken> tokenPair : redundantBundles) {
210 JetModifierKeywordToken redundantModifier = tokenPair.getFirst();
211 JetModifierKeywordToken sufficientModifier = tokenPair.getSecond();
212 if (modifierList.hasModifier(redundantModifier) && modifierList.hasModifier(sufficientModifier)) {
213 trace.report(Errors.REDUNDANT_MODIFIER.on(modifierList.getModifierNode(redundantModifier).getPsi(), redundantModifier, sufficientModifier));
214 }
215 }
216 }
217
218 public void checkIllegalInThisContextModifiers(
219 @Nullable JetModifierList modifierList,
220 @NotNull Collection<JetModifierKeywordToken> illegalModifiers
221 ) {
222 reportIllegalModifiers(modifierList, illegalModifiers, trace);
223 }
224
225 @NotNull
226 public static Map<JetModifierKeywordToken, ASTNode> getNodesCorrespondingToModifiers(@NotNull JetModifierList modifierList, @NotNull Collection<JetModifierKeywordToken> possibleModifiers) {
227 Map<JetModifierKeywordToken, ASTNode> nodes = Maps.newHashMap();
228 for (JetModifierKeywordToken modifier : possibleModifiers) {
229 if (modifierList.hasModifier(modifier)) {
230 nodes.put(modifier, modifierList.getModifierNode(modifier));
231 }
232 }
233 return nodes;
234 }
235
236 @NotNull
237 public static Modality resolveModalityFromModifiers(@NotNull JetModifierListOwner modifierListOwner, @NotNull Modality defaultModality) {
238 return resolveModalityFromModifiers(modifierListOwner.getModifierList(), defaultModality);
239 }
240
241 public static Modality resolveModalityFromModifiers(@Nullable JetModifierList modifierList, @NotNull Modality defaultModality) {
242 if (modifierList == null) return defaultModality;
243 boolean hasAbstractModifier = modifierList.hasModifier(ABSTRACT_KEYWORD);
244 boolean hasOverrideModifier = modifierList.hasModifier(OVERRIDE_KEYWORD);
245
246 if (modifierList.hasModifier(OPEN_KEYWORD)) {
247 if (hasAbstractModifier || defaultModality == Modality.ABSTRACT) {
248 return Modality.ABSTRACT;
249 }
250 return Modality.OPEN;
251 }
252 if (hasAbstractModifier) {
253 return Modality.ABSTRACT;
254 }
255 boolean hasFinalModifier = modifierList.hasModifier(FINAL_KEYWORD);
256 if (hasOverrideModifier && !hasFinalModifier && !(defaultModality == Modality.ABSTRACT)) {
257 return Modality.OPEN;
258 }
259 if (hasFinalModifier) {
260 return Modality.FINAL;
261 }
262 return defaultModality;
263 }
264
265 @NotNull
266 public static Visibility resolveVisibilityFromModifiers(@NotNull JetModifierListOwner modifierListOwner, @NotNull Visibility defaultVisibility) {
267 return resolveVisibilityFromModifiers(modifierListOwner.getModifierList(), defaultVisibility);
268 }
269
270 public static Visibility resolveVisibilityFromModifiers(@Nullable JetModifierList modifierList, @NotNull Visibility defaultVisibility) {
271 if (modifierList == null) return defaultVisibility;
272 if (modifierList.hasModifier(PRIVATE_KEYWORD)) return Visibilities.PRIVATE;
273 if (modifierList.hasModifier(PUBLIC_KEYWORD)) return Visibilities.PUBLIC;
274 if (modifierList.hasModifier(PROTECTED_KEYWORD)) return Visibilities.PROTECTED;
275 if (modifierList.hasModifier(INTERNAL_KEYWORD)) return Visibilities.INTERNAL;
276 return defaultVisibility;
277 }
278
279 public static boolean isInnerClass(@Nullable JetModifierList modifierList) {
280 return modifierList != null && modifierList.hasModifier(INNER_KEYWORD);
281 }
282
283 @NotNull
284 public static Visibility getDefaultClassVisibility(@NotNull ClassDescriptor descriptor) {
285 ClassKind kind = descriptor.getKind();
286 if (kind == ClassKind.ENUM_ENTRY) {
287 return Visibilities.PUBLIC;
288 }
289 if (kind == ClassKind.CLASS_OBJECT) {
290 return ((ClassDescriptor) descriptor.getContainingDeclaration()).getVisibility();
291 }
292 return Visibilities.INTERNAL;
293 }
294 }