Skip to content

Commit b649b3a

Browse files
smolcodersmolcoder
committed
"Import directive overrides auto-imported BIF" inspection
1 parent b81c64a commit b649b3a

10 files changed

+118
-2
lines changed

‎resources/inspectionDescriptions/ErlangImportDirectiveOverridesAutoimportedBif.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
~ Copyright 2012-2014 Sergey Ignatov
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+
17+
<html>
18+
<body>
19+
Import directive overrides pre R14 auto-imported BIF.
20+
</body>
21+
</html>

‎src/META-INF/plugin.xml

+3
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@
181181
<localInspection language="Erlang" shortName="ErlangAmbiguousCallOfAutoimportedFunction" displayName="Ambiguous call of auto-imported BIF"
182182
groupName="Erlang" enabledByDefault="true" level="ERROR"
183183
implementationClass="org.intellij.erlang.inspection.ErlangAmbiguousCallOfAutoimportedFunctionInspection"/>
184+
<localInspection language="Erlang" shortName="ErlangImportDirectiveOverridesAutoimportedBif" displayName="Import overrides auto-imported BIF"
185+
groupName="Erlang" enabledByDefault="true" level="ERROR"
186+
implementationClass="org.intellij.erlang.inspection.ErlangImportDirectiveOverridesAutoimportedBifInspection"/>
184187

185188
<!--warnings-->
186189
<localInspection language="Erlang" shortName="ErlangUnresolvedFunction" displayName="Unresolved function"

‎src/org/intellij/erlang/inspection/ErlangImportDirectiveOverridesAutoimportedBifInspection.java

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright 2012-2014 Sergey Ignatov
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+
17+
package org.intellij.erlang.inspection;
18+
19+
import com.intellij.codeInspection.ProblemHighlightType;
20+
import com.intellij.codeInspection.ProblemsHolder;
21+
import org.intellij.erlang.bif.ErlangBifDescriptor;
22+
import org.intellij.erlang.bif.ErlangBifTable;
23+
import org.intellij.erlang.psi.ErlangFile;
24+
import org.intellij.erlang.psi.ErlangImportFunction;
25+
import org.intellij.erlang.psi.impl.ErlangPsiImplUtil;
26+
import org.intellij.erlang.quickfixes.ErlangRemoveFunctionFromImportFixBase;
27+
import org.intellij.erlang.sdk.ErlangSdkRelease;
28+
import org.intellij.erlang.sdk.ErlangSdkType;
29+
import org.jetbrains.annotations.NotNull;
30+
31+
public class ErlangImportDirectiveOverridesAutoimportedBifInspection extends ErlangInspectionBase {
32+
@Override
33+
protected boolean canRunOn(@NotNull ErlangFile file) {
34+
ErlangSdkRelease release = ErlangSdkType.getRelease(file);
35+
return release == null || release.isNewerThan(ErlangSdkRelease.V_R14A);
36+
}
37+
38+
protected void checkFile(@NotNull ErlangFile file, @NotNull ProblemsHolder problemsHolder) {
39+
for (ErlangImportFunction importFunction : file.getImportedFunctions()) {
40+
ErlangBifDescriptor bifDescriptor = ErlangBifTable.getBif(
41+
"erlang",
42+
ErlangPsiImplUtil.getName(importFunction.getQAtom()),
43+
ErlangPsiImplUtil.getArity(importFunction.getInteger()));
44+
if (bifDescriptor == null || !bifDescriptor.isAutoImported()) continue;
45+
problemsHolder.registerProblem(importFunction,
46+
"Import directive overrides pre R14 auto-imported BIF '" + ErlangPsiImplUtil.createFunctionPresentation(importFunction) + "'",
47+
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
48+
new ErlangRemoveFunctionFromImportFixBase.ErlangRemoveFunctionFromImportFix());
49+
}
50+
}
51+
52+
}

‎src/org/intellij/erlang/quickfixes/ErlangRemoveFunctionFromImportFixBase.java

+15
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,19 @@ protected Collection<? extends ErlangAttribute> getAttributesForProcessing(@NotN
109109
return ((ErlangFile) descriptorElement.getContainingFile()).getAttributes();
110110
}
111111
}
112+
113+
public static class ErlangRemoveFunctionFromImportFix extends ErlangRemoveFunctionFromImportFixBase {
114+
@Nullable
115+
@Override
116+
protected String getSignature(@NotNull PsiElement function) {
117+
ErlangImportFunction f = PsiTreeUtil.getParentOfType(function, ErlangImportFunction.class, false);
118+
return f != null ? ErlangPsiImplUtil.createFunctionPresentation(f) : null;
119+
}
120+
121+
@NotNull
122+
@Override
123+
protected Collection<? extends ErlangAttribute> getAttributesForProcessing(@NotNull PsiElement descriptorElement) {
124+
return ContainerUtil.createMaybeSingletonList(PsiTreeUtil.getParentOfType(descriptorElement, ErlangAttribute.class));
125+
}
126+
}
112127
}

‎testData/highlighting/ImportAutoimported.erl

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
-import(incl, [dt_get_tag/0, crc32/1, <error>abs/1</error>]).
2+
-export([foo/0]).
3+
foo() -> ok.

‎testData/quickfixes/import/importAutoimported-after.erl

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
-import(incl, [dt_get_tag/0, crc32/1]).

‎testData/quickfixes/import/importAutoimported.erl

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
-import(incl, [dt_get_tag/0, crc32/1, abs<caret> / 1]).

‎tests/org/intellij/erlang/highlighting/ErlangHighlightingTest.java

+15
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,21 @@ public class ErlangHighlightingTest extends ErlangHighlightingTestBase {
7777
public void testNoAutoImport4() { doTest(); }
7878
public void testNoAutoImport5() { doTest(); }
7979

80+
private void doTestWithInclude() {
81+
myFixture.configureByText("incl.erl",
82+
"-module(incl).\n" +
83+
"-export([crc32/1, abs/1, dt_get_tag/0, bar/0, abs/0]).\n" +
84+
"\n" +
85+
"crc32(Data) -> Data.\n" +
86+
"abs(D) -> D.\n" +
87+
"abs() -> zero.\n" +
88+
"dt_get_tag() -> ok.\n" +
89+
"bar() -> ok.");
90+
doTest();
91+
}
92+
93+
public void testImportAutoimported() { doTestWithInclude(); }
94+
8095
public void testErlang17SyntaxError() {
8196
enableErlang17SyntaxInspection();
8297
doTest();

‎tests/org/intellij/erlang/highlighting/ErlangHighlightingTestBase.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ public static void setUpInspections(@NotNull CodeInsightTestFixture fixture) {
8282
ErlangIoFormatInspection.class,
8383
ErlangDuplicateFunctionExportInspection.class,
8484
ErlangDefiningImportedFunctionInspection.class,
85-
ErlangAmbiguousCallOfAutoimportedFunctionInspection.class
85+
ErlangAmbiguousCallOfAutoimportedFunctionInspection.class,
86+
ErlangImportDirectiveOverridesAutoimportedBifInspection.class
8687
);
8788
}
8889

‎tests/org/intellij/erlang/quickfixes/ErlangImportFixTest.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,17 @@
1717
package org.intellij.erlang.quickfixes;
1818

1919
import org.intellij.erlang.inspection.ErlangDefiningImportedFunctionInspection;
20+
import org.intellij.erlang.inspection.ErlangImportDirectiveOverridesAutoimportedBifInspection;
2021

2122
public class ErlangImportFixTest extends ErlangQuickFixTestBase {
2223
@Override
2324
protected void setUp() throws Exception {
2425
super.setUp();
2526
//noinspection unchecked
26-
myFixture.enableInspections(ErlangDefiningImportedFunctionInspection.class);
27+
myFixture.enableInspections(
28+
ErlangDefiningImportedFunctionInspection.class,
29+
ErlangImportDirectiveOverridesAutoimportedBifInspection.class
30+
);
2731
}
2832

2933
@Override

0 commit comments

Comments
 (0)