a4c76cb5b57bd57138bb23d8ae58647d9c9823a4
[idea/community.git] / java / idea-ui / src / com / intellij / ide / util / projectWizard / importSources / JavaSourceRootDetector.java
1 /*
2  * Copyright 2000-2011 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.ide.util.projectWizard.importSources;
17
18 import com.intellij.ide.highlighter.JavaFileType;
19 import com.intellij.ide.util.projectWizard.importSources.util.CommonSourceRootDetectionUtil;
20 import com.intellij.openapi.util.Pair;
21 import com.intellij.openapi.util.io.FileUtil;
22 import com.intellij.openapi.util.io.FileUtilRt;
23 import com.intellij.util.NullableFunction;
24 import org.jetbrains.annotations.Nls;
25 import org.jetbrains.annotations.NotNull;
26
27 import java.io.File;
28 import java.util.List;
29
30 public abstract class JavaSourceRootDetector extends ProjectStructureDetector {
31   @NotNull
32   @Override
33   public DirectoryProcessingResult detectRoots(@NotNull File dir, File @NotNull [] children, @NotNull File base,
34                                                @NotNull List<DetectedProjectRoot> result) {
35     final String fileExtension = getFileExtension();
36     if (JavaFileType.DEFAULT_EXTENSION.equals(fileExtension)) {
37       for (File child : children) {
38         if (child.isFile() && "module-info.java".equals(child.getName())) {
39           JavaModuleSourceRoot sourceRoot = new JavaModuleSourceRoot(dir, getLanguageName(), true);
40           result.add(sourceRoot);
41           return DirectoryProcessingResult.SKIP_CHILDREN;
42         }
43       }
44     }
45
46     for (File child : children) {
47       if (child.isFile() && FileUtilRt.extensionEquals(child.getName(), fileExtension)) {
48         Pair<File, String> root = CommonSourceRootDetectionUtil.IO_FILE.suggestRootForFileWithPackageStatement(child, base,
49                                                                                                                getPackageNameFetcher(),
50                                                                                                                true);
51         if (root != null) {
52           JavaModuleSourceRoot sourceRoot = new JavaModuleSourceRoot(root.getFirst(), root.getSecond(), getLanguageName());
53           result.add(sourceRoot);
54           // sometimes java files from test data have package statement which includes names of all parent directories
55           // (e.g. files in jdk/test/java/awt/regtesthelpers in JDK sources have package 'test.java.awt.regtesthelpers')
56           // This check allows us to not skip searching for other java source roots when first such java file is found.
57           if (areLastRootsTheSame(result, sourceRoot, 20)) {
58             return DirectoryProcessingResult.skipChildrenAndParentsUpTo(root.getFirst());
59           }
60         }
61         return DirectoryProcessingResult.SKIP_CHILDREN;
62       }
63     }
64     return DirectoryProcessingResult.PROCESS_CHILDREN;
65   }
66
67   private static boolean areLastRootsTheSame(List<DetectedProjectRoot> result, JavaModuleSourceRoot root, int threshold) {
68     if (result.size() < threshold) return false;
69
70     List<DetectedProjectRoot> lastItems = result.subList(result.size() - threshold, result.size());
71     for (DetectedProjectRoot item : lastItems) {
72       if (!(item instanceof JavaModuleSourceRoot)) return false;
73       JavaModuleSourceRoot oldRoot = (JavaModuleSourceRoot)item;
74       if (!FileUtil.filesEqual(oldRoot.getDirectory(), root.getDirectory()) || !oldRoot.getPackagePrefix().equals(root.getPackagePrefix())
75           || !oldRoot.getRootTypeName().equals(root.getRootTypeName())) {
76         return false;
77       }
78     }
79     return true;
80   }
81
82   @Override
83   public String getDetectorId() {
84     return "Java";
85   }
86
87   @NotNull
88   protected abstract @Nls(capitalization = Nls.Capitalization.Sentence) String getLanguageName();
89
90   @NotNull
91   protected abstract String getFileExtension();
92
93   @NotNull
94   protected abstract NullableFunction<CharSequence, String> getPackageNameFetcher();
95 }