/*
* Copyright 2000-2017 JetBrains s.r.o.
*
* 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.intellij.openapi.roots.ui.configuration.libraryEditor;
import com.intellij.codeInsight.ExternalAnnotationsManager;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.fileChooser.FileChooserDescriptor;
import com.intellij.openapi.fileChooser.FileElement;
import com.intellij.openapi.fileTypes.StdFileTypes;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.project.ProjectBundle;
import com.intellij.openapi.projectRoots.ui.Util;
import com.intellij.openapi.roots.AnnotationOrderRootType;
import com.intellij.openapi.roots.JavadocOrderRootType;
import com.intellij.openapi.roots.NativeLibraryOrderRootType;
import com.intellij.openapi.roots.OrderRootType;
import com.intellij.openapi.roots.libraries.ui.*;
import com.intellij.openapi.roots.ui.OrderRootTypeUIFactory;
import com.intellij.openapi.roots.ui.configuration.LibrarySourceRootDetectorUtil;
import com.intellij.openapi.util.Condition;
import com.intellij.openapi.util.io.FileUtil;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VfsUtilCore;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.vfs.VirtualFileVisitor;
import com.intellij.util.IconUtil;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.util.*;
/**
* @author nik
*/
public class DefaultLibraryRootsComponentDescriptor extends LibraryRootsComponentDescriptor {
private static final Set<String> NATIVE_LIBRARY_EXTENSIONS = ContainerUtil.newTroveSet(FileUtil.PATH_HASHING_STRATEGY, "dll", "so", "dylib");
public static final Condition<VirtualFile> LIBRARY_ROOT_CONDITION = file -> FileElement.isArchive(file) || isNativeLibrary(file);
@Override
public OrderRootTypePresentation getRootTypePresentation(@NotNull OrderRootType type) {
return getDefaultPresentation(type);
}
@NotNull
@Override
public List<? extends AttachRootButtonDescriptor> createAttachButtons() {
return Collections.singletonList(new AttachUrlJavadocDescriptor());
}
@NotNull
@Override
public List<? extends RootDetector> getRootDetectors() {
List<RootDetector> results = new ArrayList<>();
results.add(new FileTypeBasedRootFilter(OrderRootType.CLASSES, false, StdFileTypes.CLASS, "classes"));
results.add(new FileTypeBasedRootFilter(OrderRootType.CLASSES, true, StdFileTypes.CLASS, "jar directory"));
ContainerUtil.addAll(results, Extensions.getExtensions(LibrarySourceRootDetectorUtil.JAVA_SOURCE_ROOT_DETECTOR));
results.add(new FileTypeBasedRootFilter(OrderRootType.SOURCES, true, StdFileTypes.JAVA, "source archive directory"));
results.add(new JavadocRootDetector());
results.add(new AnnotationsRootFilter());
results.add(new NativeLibraryRootFilter());
return results;
}
private static boolean isNativeLibrary(VirtualFile file) {
String extension = file.getExtension();
return extension != null && NATIVE_LIBRARY_EXTENSIONS.contains(extension);
}
@NotNull
@Override
public FileChooserDescriptor createAttachFilesChooserDescriptor(@Nullable String libraryName) {
final FileChooserDescriptor descriptor = new FileChooserDescriptor(true, true, true, false, true, true).withFileFilter(LIBRARY_ROOT_CONDITION);
descriptor.setTitle(StringUtil.isEmpty(libraryName) ? ProjectBundle.message("library.attach.files.action")
: ProjectBundle.message("library.attach.files.to.library.action", libraryName));
descriptor.setDescription(ProjectBundle.message("library.java.attach.files.description"));
return descriptor;
}
public static OrderRootTypePresentation getDefaultPresentation(OrderRootType type) {
final OrderRootTypeUIFactory factory = OrderRootTypeUIFactory.FACTORY.getByKey(type);
return new OrderRootTypePresentation(factory.getNodeText(), factory.getIcon());
}
private static class JavadocRootDetector extends RootDetector {
private JavadocRootDetector() {
super(JavadocOrderRootType.getInstance(), false, "JavaDocs");
}
@NotNull
@Override
public Collection<VirtualFile> detectRoots(@NotNull VirtualFile rootCandidate, @NotNull ProgressIndicator progressIndicator) {
List<VirtualFile> result = new ArrayList<>();
collectJavadocRoots(rootCandidate, result, progressIndicator);
JavadocQuarantineStatusCleaner.cleanIfNeeded(VfsUtilCore.toVirtualFileArray(result));
return result;
}
private static void collectJavadocRoots(VirtualFile file, final List<VirtualFile> result, final ProgressIndicator progressIndicator) {
VfsUtilCore.visitChildrenRecursively(file, new VirtualFileVisitor() {
@Override
public boolean visitFile(@NotNull VirtualFile file) {
progressIndicator.checkCanceled();
//noinspection SpellCheckingInspection
if (file.isDirectory() && file.findChild("allclasses-frame.html") != null && file.findChild("allclasses-noframe.html") != null) {
result.add(file);
return false;
}
return true;
}
});
}
}
private static class AnnotationsRootFilter extends FileTypeBasedRootFilter {
private AnnotationsRootFilter() {
super(AnnotationOrderRootType.getInstance(), false, StdFileTypes.XML, "external annotations");
}
@Override
protected boolean isFileAccepted(VirtualFile virtualFile) {
return super.isFileAccepted(virtualFile) && virtualFile.getName().equals(ExternalAnnotationsManager.ANNOTATIONS_XML);
}
}
private static class NativeLibraryRootFilter extends RootDetector {
private NativeLibraryRootFilter() {
super(NativeLibraryOrderRootType.getInstance(), false, "native library location");
}
@NotNull
@Override
public Collection<VirtualFile> detectRoots(@NotNull VirtualFile rootCandidate, @NotNull ProgressIndicator progressIndicator) {
if (rootCandidate.isInLocalFileSystem()) {
if (rootCandidate.isDirectory()) {
for (VirtualFile file : rootCandidate.getChildren()) {
if (isNativeLibrary(file)) {
return Collections.singleton(rootCandidate);
}
}
}
else if (isNativeLibrary(rootCandidate)) {
return Collections.singleton(rootCandidate.getParent());
}
}
return Collections.emptyList();
}
}
private static class AttachUrlJavadocDescriptor extends AttachRootButtonDescriptor {
private AttachUrlJavadocDescriptor() {
super(JavadocOrderRootType.getInstance(), IconUtil.getAddLinkIcon(), ProjectBundle.message("module.libraries.javadoc.url.button"));
}
@Override
public VirtualFile[] selectFiles(@NotNull JComponent parent,
@Nullable VirtualFile initialSelection,
@Nullable Module contextModule,
@NotNull LibraryEditor libraryEditor) {
VirtualFile vFile = Util.showSpecifyJavadocUrlDialog(parent);
return vFile != null ? new VirtualFile[]{vFile} : VirtualFile.EMPTY_ARRAY;
}
}
}