com.google.idea.blaze.java.sync.projectstructure.JavaSourceFolderProvider.java Source code

Introduction

Here is the source code for com.google.idea.blaze.java.sync.projectstructure.JavaSourceFolderProvider.java

Source

/*
 * Copyright 2016 The Bazel Authors. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.idea.blaze.java.sync.projectstructure;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import com.google.idea.blaze.base.sync.SourceFolderProvider;
import com.google.idea.blaze.java.sync.model.BlazeContentEntry;
import com.google.idea.blaze.java.sync.model.BlazeJavaSyncData;
import com.google.idea.blaze.java.sync.model.BlazeSourceDirectory;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.roots.ContentEntry;
import com.intellij.openapi.roots.SourceFolder;
import com.intellij.openapi.util.io.FileUtil;
import com.intellij.openapi.vfs.LocalFileSystem;
import com.intellij.openapi.vfs.VfsUtilCore;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.vfs.VirtualFileManager;
import com.intellij.openapi.vfs.VirtualFileSystem;
import com.intellij.openapi.vfs.ex.temp.TempFileSystem;
import com.intellij.util.io.URLUtil;
import java.io.File;
import javax.annotation.Nullable;
import org.jetbrains.jps.model.JpsElement;
import org.jetbrains.jps.model.java.JavaResourceRootType;
import org.jetbrains.jps.model.java.JavaSourceRootProperties;
import org.jetbrains.jps.model.module.JpsModuleSourceRoot;

/** Edits source folders in IntelliJ content entries */
public class JavaSourceFolderProvider implements SourceFolderProvider {
    private static final Logger logger = Logger.getInstance(JavaSourceFolderProvider.class);

    private final ImmutableMap<File, BlazeContentEntry> blazeContentEntries;

    public JavaSourceFolderProvider(@Nullable BlazeJavaSyncData syncData) {
        this.blazeContentEntries = blazeContentEntries(syncData);
    }

    private static ImmutableMap<File, BlazeContentEntry> blazeContentEntries(@Nullable BlazeJavaSyncData syncData) {
        if (syncData == null) {
            return ImmutableMap.of();
        }
        ImmutableMap.Builder<File, BlazeContentEntry> builder = ImmutableMap.builder();
        for (BlazeContentEntry blazeContentEntry : syncData.importResult.contentEntries) {
            builder.put(blazeContentEntry.contentRoot, blazeContentEntry);
        }
        return builder.build();
    }

    @Override
    public ImmutableMap<VirtualFile, SourceFolder> initializeSourceFolders(ContentEntry contentEntry) {
        ImmutableMap.Builder<VirtualFile, SourceFolder> output = ImmutableMap.builder();
        VirtualFile virtualFile = contentEntry.getFile();
        if (virtualFile == null) {
            return output.build();
        }

        File contentRoot = new File(virtualFile.getPath());
        BlazeContentEntry javaContentEntry = blazeContentEntries.get(contentRoot);
        if (javaContentEntry != null) {
            for (BlazeSourceDirectory sourceDirectory : javaContentEntry.sources) {
                SourceFolder sourceFolder = addSourceFolderToContentEntry(contentEntry, sourceDirectory);
                output.put(sourceFolder.getFile(), sourceFolder);
            }
        }
        return output.build();
    }

    @Override
    public SourceFolder setSourceFolderForLocation(ContentEntry contentEntry, SourceFolder parentFolder,
            VirtualFile file, boolean isTestSource) {
        SourceFolder sourceFolder;
        if (isResource(parentFolder)) {
            JavaResourceRootType resourceRootType = isTestSource ? JavaResourceRootType.TEST_RESOURCE
                    : JavaResourceRootType.RESOURCE;
            sourceFolder = contentEntry.addSourceFolder(pathToUrl(file.getPath()), resourceRootType);
        } else {
            sourceFolder = contentEntry.addSourceFolder(pathToUrl(file.getPath()), isTestSource);
        }
        sourceFolder.setPackagePrefix(derivePackagePrefix(file, parentFolder));
        JpsModuleSourceRoot sourceRoot = sourceFolder.getJpsElement();
        JpsElement properties = sourceRoot.getProperties();
        if (properties instanceof JavaSourceRootProperties) {
            ((JavaSourceRootProperties) properties).setForGeneratedSources(isGenerated(parentFolder));
        }
        return sourceFolder;
    }

    private static String derivePackagePrefix(VirtualFile file, SourceFolder parentFolder) {
        String parentPackagePrefix = parentFolder.getPackagePrefix();
        logger.assertTrue(parentFolder.getFile() != null);
        String relativePath = VfsUtilCore.getRelativePath(file, parentFolder.getFile(), '.');
        if (Strings.isNullOrEmpty(relativePath)) {
            return parentPackagePrefix;
        }
        return parentPackagePrefix + "." + relativePath;
    }

    @VisibleForTesting
    static boolean isResource(SourceFolder folder) {
        return folder.getRootType() instanceof JavaResourceRootType;
    }

    @VisibleForTesting
    static boolean isGenerated(SourceFolder folder) {
        JpsElement properties = folder.getJpsElement().getProperties();
        return properties instanceof JavaSourceRootProperties
                && ((JavaSourceRootProperties) properties).isForGeneratedSources();
    }

    private static SourceFolder addSourceFolderToContentEntry(ContentEntry contentEntry,
            BlazeSourceDirectory sourceDirectory) {
        File sourceDir = sourceDirectory.getDirectory();

        // Create the source folder
        SourceFolder sourceFolder;
        if (sourceDirectory.getIsResource()) {
            sourceFolder = contentEntry.addSourceFolder(pathToUrl(sourceDir.getPath()),
                    JavaResourceRootType.RESOURCE);
        } else {
            sourceFolder = contentEntry.addSourceFolder(pathToUrl(sourceDir.getPath()), false);
        }
        JpsModuleSourceRoot sourceRoot = sourceFolder.getJpsElement();
        JpsElement properties = sourceRoot.getProperties();
        if (properties instanceof JavaSourceRootProperties) {
            JavaSourceRootProperties rootProperties = (JavaSourceRootProperties) properties;
            if (sourceDirectory.getIsGenerated()) {
                rootProperties.setForGeneratedSources(true);
            }
        }
        String packagePrefix = sourceDirectory.getPackagePrefix();
        if (!Strings.isNullOrEmpty(packagePrefix)) {
            sourceFolder.setPackagePrefix(packagePrefix);
        }
        return sourceFolder;
    }

    private static String pathToUrl(String filePath) {
        filePath = FileUtil.toSystemIndependentName(filePath);
        if (filePath.endsWith(".srcjar") || filePath.endsWith(".jar")) {
            return URLUtil.JAR_PROTOCOL + URLUtil.SCHEME_SEPARATOR + filePath + URLUtil.JAR_SEPARATOR;
        } else if (filePath.contains("src.jar!")) {
            return URLUtil.JAR_PROTOCOL + URLUtil.SCHEME_SEPARATOR + filePath;
        } else {
            return VirtualFileManager.constructUrl(defaultFileSystem().getProtocol(), filePath);
        }
    }

    private static VirtualFileSystem defaultFileSystem() {
        if (ApplicationManager.getApplication().isUnitTestMode()) {
            return TempFileSystem.getInstance();
        }
        return LocalFileSystem.getInstance();
    }
}