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
017package org.jetbrains.jet.asJava;
018
019import com.intellij.openapi.components.ServiceManager;
020import com.intellij.openapi.project.Project;
021import com.intellij.psi.PsiClass;
022import com.intellij.psi.search.GlobalSearchScope;
023import org.jetbrains.annotations.NotNull;
024import org.jetbrains.annotations.Nullable;
025import org.jetbrains.jet.lang.psi.JetClassOrObject;
026import org.jetbrains.jet.lang.psi.JetFile;
027import org.jetbrains.jet.lang.resolve.name.FqName;
028
029import java.util.Collection;
030
031public abstract class LightClassGenerationSupport {
032
033    @NotNull
034    public static LightClassGenerationSupport getInstance(@NotNull Project project) {
035        return ServiceManager.getService(project, LightClassGenerationSupport.class);
036    }
037
038    @NotNull
039    public abstract LightClassConstructionContext analyzeRelevantCode(@NotNull Collection<JetFile> files);
040
041    @NotNull
042    public abstract Collection<JetClassOrObject> findClassOrObjectDeclarations(@NotNull FqName fqName, @NotNull GlobalSearchScope searchScope);
043
044    /*
045     * Finds files whose package declaration is exactly {@code fqName}. For example, if a file declares
046     *     package a.b.c
047     * it will not be returned for fqName "a.b"
048     *
049     * If the resulting collection is empty, it means that this package has not other declarations than sub-packages
050     */
051    @NotNull
052    public abstract Collection<JetFile> findFilesForPackage(@NotNull FqName fqName, @NotNull GlobalSearchScope searchScope);
053
054    // Returns only immediately declared classes/objects, package classes are not included (they have no declarations)
055    @NotNull
056    public abstract Collection<JetClassOrObject> findClassOrObjectDeclarationsInPackage(
057            @NotNull FqName packageFqName,
058            @NotNull GlobalSearchScope searchScope
059    );
060
061    public abstract boolean packageExists(@NotNull FqName fqName, @NotNull GlobalSearchScope scope);
062
063    @NotNull
064    public abstract Collection<FqName> getSubPackages(@NotNull FqName fqn, @NotNull GlobalSearchScope scope);
065
066    @Nullable
067    public abstract PsiClass getPsiClass(@NotNull JetClassOrObject classOrObject);
068}