9ec282a0492bafbe52910db77136b39cbff93272
[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.NotNull;
25
26 import java.io.File;
27 import java.util.List;
28
29 public abstract class JavaSourceRootDetector extends ProjectStructureDetector {
30   @NotNull
31   @Override
32   public DirectoryProcessingResult detectRoots(@NotNull File dir, File @NotNull [] children, @NotNull File base,
33                                                @NotNull List<DetectedProjectRoot> result) {
34     final String fileExtension = getFileExtension();
35     if (JavaFileType.DEFAULT_EXTENSION.equals(fileExtension)) {
36       for (File child : children) {
37         if (child.isFile() && "module-info.java".equals(child.getName())) {
38           JavaModuleSourceRoot sourceRoot = new JavaModuleSourceRoot(dir, getLanguageName(), true);
39           result.add(sourceRoot);
40           return DirectoryProcessingResult.SKIP_CHILDREN;
41         }
42       }
43     }
44
45     for (File child : children) {
46       if (child.isFile() && FileUtilRt.extensionEquals(child.getName(), fileExtension)) {
47         Pair<File, String> root = CommonSourceRootDetectionUtil.IO_FILE.suggestRootForFileWithPackageStatement(child, base,
48                                                                                                                getPackageNameFetcher(),
49                                                                                                                true);
50         if (root != null) {
51           JavaModuleSourceRoot sourceRoot = new JavaModuleSourceRoot(root.getFirst(), root.getSecond(), getLanguageName());
52           result.add(sourceRoot);
53           // sometimes java files from test data have package statement which includes names of all parent directories
54           // (e.g. files in jdk/test/java/awt/regtesthelpers in JDK sources have package 'test.java.awt.regtesthelpers')
55           // This check allows us to not skip searching for other java source roots when first such java file is found.
56           if (areLastRootsTheSame(result, sourceRoot, 20)) {
57             return DirectoryProcessingResult.skipChildrenAndParentsUpTo(root.getFirst());
58           }
59         }
60         return DirectoryProcessingResult.SKIP_CHILDREN;
61       }
62     }
63     return DirectoryProcessingResult.PROCESS_CHILDREN;
64   }
65
66   private static boolean areLastRootsTheSame(List<DetectedProjectRoot> result, JavaModuleSourceRoot root, int threshold) {
67     if (result.size() < threshold) return false;
68
69     List<DetectedProjectRoot> lastItems = result.subList(result.size() - threshold, result.size());
70     for (DetectedProjectRoot item : lastItems) {
71       if (!(item instanceof JavaModuleSourceRoot)) return false;
72       JavaModuleSourceRoot oldRoot = (JavaModuleSourceRoot)item;
73       if (!FileUtil.filesEqual(oldRoot.getDirectory(), root.getDirectory()) || !oldRoot.getPackagePrefix().equals(root.getPackagePrefix())
74           || !oldRoot.getRootTypeName().equals(root.getRootTypeName())) {
75         return false;
76       }
77     }
78     return true;
79   }
80
81   @Override
82   public String getDetectorId() {
83     return "Java";
84   }
85
86   @NotNull
87   protected abstract String getLanguageName();
88
89   @NotNull
90   protected abstract String getFileExtension();
91
92   @NotNull
93   protected abstract NullableFunction<CharSequence, String> getPackageNameFetcher();
94 }