001    /*
002     * Copyright 2010-2013 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.base.Function;
020    import com.google.common.base.Predicate;
021    import com.google.common.collect.*;
022    import com.intellij.openapi.util.Pair;
023    import com.intellij.psi.PsiElement;
024    import com.intellij.util.containers.ContainerUtil;
025    import kotlin.Function1;
026    import kotlin.KotlinPackage;
027    import org.jetbrains.annotations.NotNull;
028    import org.jetbrains.annotations.Nullable;
029    import org.jetbrains.jet.lang.descriptors.*;
030    import org.jetbrains.jet.lang.descriptors.impl.MutableClassDescriptor;
031    import org.jetbrains.jet.lang.descriptors.impl.MutablePackageFragmentDescriptor;
032    import org.jetbrains.jet.lang.descriptors.impl.PackageLikeBuilder;
033    import org.jetbrains.jet.lang.diagnostics.Errors;
034    import org.jetbrains.jet.lang.psi.*;
035    import org.jetbrains.jet.lang.resolve.lazy.KotlinCodeAnalyzer;
036    import org.jetbrains.jet.lang.resolve.lazy.descriptors.LazyPackageDescriptor;
037    import org.jetbrains.jet.lang.resolve.name.FqName;
038    import org.jetbrains.jet.lang.resolve.name.Name;
039    import org.jetbrains.jet.lang.resolve.scopes.JetScope;
040    import org.jetbrains.jet.lang.resolve.scopes.WritableScope;
041    import org.jetbrains.jet.lang.types.lang.KotlinBuiltIns;
042    import org.jetbrains.jet.renderer.DescriptorRenderer;
043    
044    import javax.inject.Inject;
045    import java.util.*;
046    
047    import static org.jetbrains.jet.lang.diagnostics.Errors.REDECLARATION;
048    
049    public class DeclarationResolver {
050        @NotNull
051        private AnnotationResolver annotationResolver;
052        @NotNull
053        private ImportsResolver importsResolver;
054        @NotNull
055        private DescriptorResolver descriptorResolver;
056        @NotNull
057        private ScriptHeaderResolver scriptHeaderResolver;
058        @NotNull
059        private BindingTrace trace;
060    
061    
062        @Inject
063        public void setAnnotationResolver(@NotNull AnnotationResolver annotationResolver) {
064            this.annotationResolver = annotationResolver;
065        }
066    
067        @Inject
068        public void setImportsResolver(@NotNull ImportsResolver importsResolver) {
069            this.importsResolver = importsResolver;
070        }
071    
072        @Inject
073        public void setDescriptorResolver(@NotNull DescriptorResolver descriptorResolver) {
074            this.descriptorResolver = descriptorResolver;
075        }
076    
077        @Inject
078        public void setTrace(@NotNull BindingTrace trace) {
079            this.trace = trace;
080        }
081    
082        // SCRIPT: inject script header resolver
083        @Inject
084        public void setScriptHeaderResolver(@NotNull ScriptHeaderResolver scriptHeaderResolver) {
085            this.scriptHeaderResolver = scriptHeaderResolver;
086        }
087    
088    
089    
090        public void process(@NotNull TopDownAnalysisContext c) {
091            resolveAnnotationConstructors(c);
092            resolveConstructorHeaders(c);
093            resolveAnnotationStubsOnClassesAndConstructors(c);
094            resolveFunctionAndPropertyHeaders(c);
095    
096            // SCRIPT: Resolve script declarations
097            scriptHeaderResolver.resolveScriptDeclarations(c);
098    
099            createFunctionsForDataClasses(c);
100            importsResolver.processMembersImports(c);
101            checkRedeclarationsInPackages(c);
102            checkRedeclarationsInInnerClassNames(c);
103        }
104    
105        private void resolveAnnotationConstructors(@NotNull TopDownAnalysisContext c) {
106            for (Map.Entry<JetClassOrObject, ClassDescriptorWithResolutionScopes> entry : c.getDeclaredClasses().entrySet()) {
107                JetClassOrObject classOrObject = entry.getKey();
108                MutableClassDescriptor classDescriptor = (MutableClassDescriptor) entry.getValue();
109    
110                if (classOrObject instanceof JetClass && DescriptorUtils.isAnnotationClass(classDescriptor)) {
111                    processPrimaryConstructor(c, classDescriptor, (JetClass) classOrObject);
112                }
113            }
114        }
115    
116        private void resolveConstructorHeaders(@NotNull TopDownAnalysisContext c) {
117            for (Map.Entry<JetClassOrObject, ClassDescriptorWithResolutionScopes> entry : c.getDeclaredClasses().entrySet()) {
118                JetClassOrObject classOrObject = entry.getKey();
119                MutableClassDescriptor classDescriptor = (MutableClassDescriptor) entry.getValue();
120    
121                if (classOrObject instanceof JetClass && !DescriptorUtils.isAnnotationClass(classDescriptor)) {
122                    processPrimaryConstructor(c, classDescriptor, (JetClass) classOrObject);
123                }
124            }
125        }
126    
127        private void resolveAnnotationStubsOnClassesAndConstructors(@NotNull TopDownAnalysisContext c) {
128            for (Map.Entry<JetClassOrObject, ClassDescriptorWithResolutionScopes> entry : c.getDeclaredClasses().entrySet()) {
129                JetModifierList modifierList = entry.getKey().getModifierList();
130                if (modifierList != null) {
131                    MutableClassDescriptor descriptor = (MutableClassDescriptor) entry.getValue();
132                    descriptor.addAnnotations(annotationResolver.resolveAnnotationsWithoutArguments(
133                            descriptor.getScopeForClassHeaderResolution(), modifierList, trace));
134                }
135            }
136        }
137    
138        private void resolveFunctionAndPropertyHeaders(@NotNull TopDownAnalysisContext c) {
139            for (Map.Entry<JetFile, WritableScope> entry : c.getFileScopes().entrySet()) {
140                JetFile file = entry.getKey();
141                WritableScope fileScope = entry.getValue();
142                PackageLikeBuilder packageBuilder = c.getPackageFragments().get(file).getBuilder();
143    
144                resolveFunctionAndPropertyHeaders(c, file.getDeclarations(), fileScope, fileScope, fileScope, packageBuilder);
145            }
146            for (Map.Entry<JetClassOrObject, ClassDescriptorWithResolutionScopes> entry : c.getDeclaredClasses().entrySet()) {
147                JetClassOrObject classOrObject = entry.getKey();
148                MutableClassDescriptor classDescriptor = (MutableClassDescriptor) entry.getValue();
149    
150                resolveFunctionAndPropertyHeaders(
151                        c,
152                        classOrObject.getDeclarations(), classDescriptor.getScopeForMemberDeclarationResolution(),
153                        classDescriptor.getScopeForInitializerResolution(), classDescriptor.getScopeForMemberDeclarationResolution(),
154                        classDescriptor.getBuilder());
155            }
156    
157            // TODO : Extensions
158        }
159    
160        private void resolveFunctionAndPropertyHeaders(
161                @NotNull final TopDownAnalysisContext c,
162                @NotNull List<JetDeclaration> declarations,
163                @NotNull final JetScope scopeForFunctions,
164                @NotNull final JetScope scopeForPropertyInitializers,
165                @NotNull final JetScope scopeForPropertyAccessors,
166                @NotNull final PackageLikeBuilder packageLike)
167        {
168            for (JetDeclaration declaration : declarations) {
169                declaration.accept(new JetVisitorVoid() {
170                    @Override
171                    public void visitNamedFunction(@NotNull JetNamedFunction function) {
172                        SimpleFunctionDescriptor functionDescriptor = descriptorResolver.resolveFunctionDescriptor(
173                                packageLike.getOwnerForChildren(),
174                                scopeForFunctions,
175                                function,
176                                trace,
177                                c.getOuterDataFlowInfo()
178                        );
179                        packageLike.addFunctionDescriptor(functionDescriptor);
180                        c.getFunctions().put(function, functionDescriptor);
181                        c.registerDeclaringScope(function, scopeForFunctions);
182                    }
183    
184                    @Override
185                    public void visitProperty(@NotNull JetProperty property) {
186                        PropertyDescriptor propertyDescriptor = descriptorResolver.resolvePropertyDescriptor(
187                                packageLike.getOwnerForChildren(),
188                                scopeForPropertyInitializers,
189                                property,
190                                trace,
191                                c.getOuterDataFlowInfo());
192                        packageLike.addPropertyDescriptor(propertyDescriptor);
193                        c.getProperties().put(property, propertyDescriptor);
194                        c.registerDeclaringScope(property, scopeForPropertyInitializers);
195                        JetPropertyAccessor getter = property.getGetter();
196                        if (getter != null) {
197                            c.registerDeclaringScope(getter, scopeForPropertyAccessors);
198                        }
199                        JetPropertyAccessor setter = property.getSetter();
200                        if (setter != null) {
201                            c.registerDeclaringScope(setter, scopeForPropertyAccessors);
202                        }
203                    }
204                });
205            }
206        }
207    
208        private void createFunctionsForDataClasses(@NotNull TopDownAnalysisContext c) {
209            for (Map.Entry<JetClassOrObject, ClassDescriptorWithResolutionScopes> entry : c.getDeclaredClasses().entrySet()) {
210                JetClassOrObject klass = entry.getKey();
211                MutableClassDescriptor classDescriptor = (MutableClassDescriptor) entry.getValue();
212    
213                if (klass instanceof JetClass && klass.hasPrimaryConstructor() && KotlinBuiltIns.getInstance().isData(classDescriptor)) {
214                    ConstructorDescriptor constructor = DescriptorUtils.getConstructorOfDataClass(classDescriptor);
215                    createComponentFunctions(classDescriptor, constructor);
216                    createCopyFunction(classDescriptor, constructor);
217                }
218            }
219        }
220    
221        private void createComponentFunctions(@NotNull MutableClassDescriptor classDescriptor, @NotNull ConstructorDescriptor constructorDescriptor) {
222            int parameterIndex = 0;
223            for (ValueParameterDescriptor parameter : constructorDescriptor.getValueParameters()) {
224                if (!parameter.getType().isError()) {
225                    PropertyDescriptor property = trace.get(BindingContext.VALUE_PARAMETER_AS_PROPERTY, parameter);
226                    if (property != null) {
227                        ++parameterIndex;
228    
229                        SimpleFunctionDescriptor functionDescriptor =
230                                DescriptorResolver.createComponentFunctionDescriptor(parameterIndex, property, parameter, classDescriptor, trace);
231    
232                        classDescriptor.getBuilder().addFunctionDescriptor(functionDescriptor);
233                    }
234                }
235            }
236        }
237    
238        private void createCopyFunction(@NotNull MutableClassDescriptor classDescriptor, @NotNull ConstructorDescriptor constructorDescriptor) {
239            SimpleFunctionDescriptor functionDescriptor = DescriptorResolver.createCopyFunctionDescriptor(
240                    constructorDescriptor.getValueParameters(), classDescriptor, trace);
241    
242            classDescriptor.getBuilder().addFunctionDescriptor(functionDescriptor);
243        }
244    
245        private void processPrimaryConstructor(
246                @NotNull TopDownAnalysisContext c,
247                @NotNull MutableClassDescriptor classDescriptor,
248                @NotNull JetClass klass
249        ) {
250            // TODO : not all the parameters are real properties
251            JetScope memberScope = classDescriptor.getScopeForClassHeaderResolution();
252            ConstructorDescriptor constructorDescriptor = descriptorResolver.resolvePrimaryConstructorDescriptor(memberScope, classDescriptor, klass, trace);
253            if (constructorDescriptor != null) {
254                List<ValueParameterDescriptor> valueParameterDescriptors = constructorDescriptor.getValueParameters();
255                List<JetParameter> primaryConstructorParameters = klass.getPrimaryConstructorParameters();
256                assert valueParameterDescriptors.size() == primaryConstructorParameters.size();
257                List<ValueParameterDescriptor> notProperties = new ArrayList<ValueParameterDescriptor>();
258                for (ValueParameterDescriptor valueParameterDescriptor : valueParameterDescriptors) {
259                    JetParameter parameter = primaryConstructorParameters.get(valueParameterDescriptor.getIndex());
260                    if (parameter.getValOrVarNode() != null) {
261                        PropertyDescriptor propertyDescriptor = descriptorResolver.resolvePrimaryConstructorParameterToAProperty(
262                                classDescriptor,
263                                valueParameterDescriptor,
264                                memberScope,
265                                parameter, trace
266                        );
267                        classDescriptor.getBuilder().addPropertyDescriptor(propertyDescriptor);
268                        c.getPrimaryConstructorParameterProperties().put(parameter, propertyDescriptor);
269                    }
270                    else {
271                        notProperties.add(valueParameterDescriptor);
272                    }
273                }
274    
275                if (classDescriptor.getKind() != ClassKind.TRAIT) {
276                    classDescriptor.setPrimaryConstructor(constructorDescriptor);
277                    classDescriptor.addConstructorParametersToInitializersScope(notProperties);
278                }
279            }
280        }
281    
282        private void checkRedeclarationsInPackages(@NotNull TopDownAnalysisContext c) {
283            for (MutablePackageFragmentDescriptor packageFragment : Sets.newHashSet(c.getPackageFragments().values())) {
284                PackageViewDescriptor packageView = packageFragment.getContainingDeclaration().getPackage(packageFragment.getFqName());
285                JetScope packageViewScope = packageView.getMemberScope();
286                Multimap<Name, DeclarationDescriptor> simpleNameDescriptors = packageFragment.getMemberScope().getDeclaredDescriptorsAccessibleBySimpleName();
287                for (Name name : simpleNameDescriptors.keySet()) {
288                    // Keep only properties with no receiver
289                    Collection<DeclarationDescriptor> descriptors = Collections2.filter(simpleNameDescriptors.get(name), new Predicate<DeclarationDescriptor>() {
290                        @Override
291                        public boolean apply(@Nullable DeclarationDescriptor descriptor) {
292                            if (descriptor instanceof PropertyDescriptor) {
293                                PropertyDescriptor propertyDescriptor = (PropertyDescriptor)descriptor;
294                                return propertyDescriptor.getReceiverParameter() == null;
295                            }
296                            return true;
297                        }
298                    });
299                    ContainerUtil.addIfNotNull(descriptors, packageViewScope.getPackage(name));
300    
301                    if (descriptors.size() > 1) {
302                        for (DeclarationDescriptor declarationDescriptor : descriptors) {
303                            for (PsiElement declaration : getDeclarationsByDescriptor(declarationDescriptor)) {
304                                assert declaration != null : "Null declaration for descriptor: " + declarationDescriptor + " " +
305                                                             (declarationDescriptor != null ? DescriptorRenderer.FQ_NAMES_IN_TYPES.render(declarationDescriptor) : "");
306                                trace.report(REDECLARATION.on(declaration, declarationDescriptor.getName().asString()));
307                            }
308                        }
309                    }
310                }
311            }
312        }
313    
314        @NotNull
315        private Collection<PsiElement> getDeclarationsByDescriptor(@NotNull DeclarationDescriptor declarationDescriptor) {
316            Collection<PsiElement> declarations;
317            if (declarationDescriptor instanceof PackageViewDescriptor) {
318                final PackageViewDescriptor aPackage = (PackageViewDescriptor)declarationDescriptor;
319                Collection<JetFile> files = trace.get(BindingContext.PACKAGE_TO_FILES, aPackage.getFqName());
320    
321                if (files == null) {
322                    return Collections.emptyList(); // package can be defined out of Kotlin sources, e. g. in library or Java code
323                }
324    
325                declarations = Collections2.transform(files, new Function<JetFile, PsiElement>() {
326                    @Override
327                    public PsiElement apply(@Nullable JetFile file) {
328                        assert file != null : "File is null for aPackage " + aPackage;
329                        return file.getPackageDirective().getNameIdentifier();
330                    }
331                });
332            }
333            else {
334                declarations = Collections.singletonList(BindingContextUtils.descriptorToDeclaration(trace.getBindingContext(), declarationDescriptor));
335            }
336            return declarations;
337        }
338    
339        public void checkRedeclarationsInInnerClassNames(@NotNull TopDownAnalysisContext c) {
340            for (ClassDescriptorWithResolutionScopes classDescriptor : c.getDeclaredClasses().values()) {
341                if (classDescriptor.getKind() == ClassKind.CLASS_OBJECT) {
342                    // Class objects should be considered during analysing redeclarations in classes
343                    continue;
344                }
345    
346                Collection<DeclarationDescriptor> allDescriptors = classDescriptor.getScopeForMemberLookup().getOwnDeclaredDescriptors();
347    
348                ClassDescriptorWithResolutionScopes classObj = classDescriptor.getClassObjectDescriptor();
349                if (classObj != null) {
350                    Collection<DeclarationDescriptor> classObjDescriptors = classObj.getScopeForMemberLookup().getOwnDeclaredDescriptors();
351                    if (!classObjDescriptors.isEmpty()) {
352                        allDescriptors = Lists.newArrayList(allDescriptors);
353                        allDescriptors.addAll(classObjDescriptors);
354                    }
355                }
356    
357                Multimap<Name, DeclarationDescriptor> descriptorMap = HashMultimap.create();
358                for (DeclarationDescriptor desc : allDescriptors) {
359                    if (desc instanceof ClassDescriptor || desc instanceof PropertyDescriptor) {
360                        descriptorMap.put(desc.getName(), desc);
361                    }
362                }
363    
364                reportRedeclarations(descriptorMap);
365            }
366        }
367    
368        private void reportRedeclarations(@NotNull Multimap<Name, DeclarationDescriptor> descriptorMap) {
369            Set<Pair<PsiElement, Name>> redeclarations = Sets.newHashSet();
370            for (Name name : descriptorMap.keySet()) {
371                Collection<DeclarationDescriptor> descriptors = descriptorMap.get(name);
372                if (descriptors.size() > 1) {
373                    // We mustn't compare PropertyDescriptor with PropertyDescriptor because we do this at OverloadResolver
374                    for (DeclarationDescriptor descriptor : descriptors) {
375                        if (descriptor instanceof ClassDescriptor) {
376                            for (DeclarationDescriptor descriptor2 : descriptors) {
377                                if (descriptor == descriptor2) {
378                                    continue;
379                                }
380    
381                                redeclarations.add(Pair.create(
382                                        BindingContextUtils.classDescriptorToDeclaration(trace.getBindingContext(), (ClassDescriptor) descriptor),
383                                        descriptor.getName()));
384                                if (descriptor2 instanceof PropertyDescriptor) {
385                                    redeclarations.add(Pair.create(
386                                            BindingContextUtils.descriptorToDeclaration(trace.getBindingContext(), descriptor2),
387                                            descriptor2.getName()));
388                                }
389                            }
390                        }
391                    }
392                }
393            }
394            for (Pair<PsiElement, Name> redeclaration : redeclarations) {
395                trace.report(REDECLARATION.on(redeclaration.getFirst(), redeclaration.getSecond().asString()));
396            }
397        }
398    
399        public void checkRedeclarationsInPackages(@NotNull KotlinCodeAnalyzer resolveSession, @NotNull Multimap<FqName, JetElement> topLevelFqNames) {
400            for (Map.Entry<FqName, Collection<JetElement>> entry : topLevelFqNames.asMap().entrySet()) {
401                FqName fqName = entry.getKey();
402                Collection<JetElement> declarationsOrPackageDirectives = entry.getValue();
403    
404                if (fqName.isRoot()) continue;
405    
406                Set<DeclarationDescriptor> descriptors = getTopLevelDescriptorsByFqName(resolveSession, fqName);
407    
408                if (descriptors.size() > 1) {
409                    for (JetElement declarationOrPackageDirective : declarationsOrPackageDirectives) {
410                        PsiElement reportAt = declarationOrPackageDirective instanceof JetNamedDeclaration
411                                              ? declarationOrPackageDirective
412                                              : ((JetPackageDirective) declarationOrPackageDirective).getNameIdentifier();
413                        trace.report(Errors.REDECLARATION.on(reportAt, fqName.shortName().asString()));
414                    }
415                }
416            }
417        }
418    
419        @NotNull
420        private static Set<DeclarationDescriptor> getTopLevelDescriptorsByFqName(@NotNull KotlinCodeAnalyzer resolveSession, @NotNull FqName fqName) {
421            FqName parentFqName = fqName.parent();
422    
423            Set<DeclarationDescriptor> descriptors = new HashSet<DeclarationDescriptor>();
424    
425            LazyPackageDescriptor parentFragment = resolveSession.getPackageFragment(parentFqName);
426            if (parentFragment != null) {
427                // Filter out extension properties
428                descriptors.addAll(
429                        KotlinPackage.filter(
430                                parentFragment.getMemberScope().getProperties(fqName.shortName()),
431                                new Function1<VariableDescriptor, Boolean>() {
432                                    @Override
433                                    public Boolean invoke(VariableDescriptor descriptor) {
434                                        return descriptor.getReceiverParameter() == null;
435                                    }
436                                }
437                        )
438                );
439            }
440    
441            ContainerUtil.addIfNotNull(descriptors, resolveSession.getPackageFragment(fqName));
442    
443            descriptors.addAll(resolveSession.getTopLevelClassDescriptors(fqName));
444            return descriptors;
445        }
446    
447    
448    }