Merge pull request #645 from m0sth8/builtin_types

mtoader · mtoader · commit 7b3637180f89 · 2014-03-27T09:36:04.000-07:00
Add inspections for builtin functions with Type arguments (fixes #480)
diff --git a/src/ro/redeul/google/go/lang/psi/expressions/primary/GoBuiltinCallExpression.java b/src/ro/redeul/google/go/lang/psi/expressions/primary/GoBuiltinCallExpression.java
@@ -1,5 +1,7 @@
 package ro.redeul.google.go.lang.psi.expressions.primary;
 
+import ro.redeul.google.go.lang.psi.types.GoPsiType;
+
 /**
  * Author: Toader Mihai Claudiu <mtoader@gmail.com>
  * <p/>
@@ -8,4 +10,5 @@
  */
 public interface GoBuiltinCallExpression extends GoCallOrConvExpression {
 
+    public GoPsiType[] getArgumentsType();
 }
diff --git a/src/ro/redeul/google/go/lang/psi/impl/expressions/primary/GoBuiltinCallExpressionImpl.java b/src/ro/redeul/google/go/lang/psi/impl/expressions/primary/GoBuiltinCallExpressionImpl.java
@@ -11,7 +11,11 @@
 import ro.redeul.google.go.lang.psi.toplevel.GoMethodDeclaration;
 import ro.redeul.google.go.lang.psi.toplevel.GoPackageDeclaration;
 import ro.redeul.google.go.lang.psi.types.GoPsiType;
+import ro.redeul.google.go.lang.psi.types.GoPsiTypeMap;
+import ro.redeul.google.go.lang.psi.types.GoPsiTypeSlice;
 import ro.redeul.google.go.lang.psi.typing.GoType;
+import ro.redeul.google.go.lang.psi.typing.GoTypeMap;
+import ro.redeul.google.go.lang.psi.typing.GoTypeSlice;
 import ro.redeul.google.go.lang.psi.typing.GoTypes;
 import ro.redeul.google.go.lang.psi.visitors.GoElementVisitor;
 import ro.redeul.google.go.lang.stubs.GoNamesCache;
@@ -71,6 +75,67 @@ protected GoType[] resolveTypes() {
         return GoType.EMPTY_ARRAY;
     }
 
+    @Override
+    public GoPsiType[] getArgumentsType() {
+        PsiElement reference = resolveSafely(getBaseExpression(),
+                PsiElement.class);
+
+        if (reference == null) {
+            return processArgumentsType(this.getBaseExpression().getText());
+        }
+
+        if (reference.getParent() instanceof GoFunctionDeclaration) {
+            GoFunctionDeclaration declaration =
+                    (GoFunctionDeclaration) reference.getParent();
+
+            if (BUILTIN_FUNCTION.accepts(declaration))
+                return processArgumentsType(declaration.getFunctionName());
+        }
+
+        return GoPsiType.EMPTY_ARRAY;
+    }
+
+    private GoPsiType[] processArgumentsType(String functionName) {
+        GoNamesCache namesCache = GoNamesCache.getInstance(getProject());
+
+        GoExpr[] args = getArguments();
+        GoPsiType typeArg = getTypeArgument();
+
+        if (functionName.equals("append")) {
+            if (args.length > 1) {
+                GoType[] types = args[0].getType();
+                if (types.length > 0 && types[0] instanceof GoTypeSlice) {
+                    GoPsiTypeSlice appendedSlice = ((GoTypeSlice) types[0]).getPsiType();
+                    GoPsiType[] result = new GoPsiType[args.length];
+                    result[0] = appendedSlice;
+                    GoPsiType elem = appendedSlice.getElementType();
+                    for (int i = 1; i < args.length; i++){
+                        result[i] = elem;
+                    }
+                    return result;
+                }
+            }
+        } else if (functionName.equals("copy")) {
+            if (args.length == 2) {
+                GoType[] types = args[0].getType();
+                if (types.length > 0 && types[0] instanceof GoTypeSlice) {
+                    GoPsiTypeSlice copiedSlice = ((GoTypeSlice) types[0]).getPsiType();
+                    return new GoPsiType[]{copiedSlice, copiedSlice};
+                }
+            }
+        } else if (functionName.equals("delete")) {
+            if (args.length == 2) {
+                GoType[] types = args[0].getType();
+                if (types.length > 0 && types[0] instanceof GoTypeMap) {
+                    GoPsiTypeMap map = ((GoTypeMap) types[0]).getPsiType();
+                    return new GoPsiType[]{map, map.getKeyType()};
+                }
+            }
+        }
+
+        return GoPsiType.EMPTY_ARRAY;
+    }
+
     private GoType[] processBuiltinFunction(String functionName) {
 
         GoNamesCache namesCache = GoNamesCache.getInstance(getProject());
@@ -120,7 +185,7 @@ private GoType[] processBuiltinFunction(String functionName) {
         } else if (functionName.equals("append")) {
             if (args.length > 1) {
                 GoType[] types = args[0].getType();
-                if (types.length > 1) {
+                if (types.length > 0) {
                     return new GoType[]{types[0]};
                 }
             }
diff --git a/src/ro/redeul/google/go/lang/psi/utils/GoExpressionUtils.java b/src/ro/redeul/google/go/lang/psi/utils/GoExpressionUtils.java
@@ -8,6 +8,7 @@
 import ro.redeul.google.go.lang.psi.GoPsiElement;
 import ro.redeul.google.go.lang.psi.expressions.GoPrimaryExpression;
 import ro.redeul.google.go.lang.psi.expressions.literals.GoLiteralIdentifier;
+import ro.redeul.google.go.lang.psi.expressions.primary.GoBuiltinCallExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoCallOrConvExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoLiteralExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoSelectorExpression;
@@ -17,6 +18,7 @@
 import static ro.redeul.google.go.lang.psi.utils.GoIdentifierUtils.getFunctionDeclaration;
 import static ro.redeul.google.go.lang.psi.utils.GoPsiUtils.findChildOfType;
 import static ro.redeul.google.go.lang.psi.utils.GoPsiUtils.findParentOfType;
+import static ro.redeul.google.go.lang.psi.utils.GoPsiUtils.resolveSafely;
 
 public class GoExpressionUtils {
     @Nullable
@@ -47,6 +49,13 @@ public static GoPsiElement getCallFunctionIdentifier(@Nullable GoCallOrConvExpre
      */
     @Nullable
     public static GoFunctionDeclaration resolveToFunctionDeclaration(@Nullable PsiElement element) {
+        if (element instanceof GoBuiltinCallExpression){
+            PsiElement reference = resolveSafely(((GoBuiltinCallExpression) element).getBaseExpression(),
+                    PsiElement.class);
+            if (reference != null && reference.getParent() instanceof GoFunctionDeclaration){
+                return (GoFunctionDeclaration) reference.getParent();
+            }
+        }
         GoCallOrConvExpression callExpr = findParentOfType(element, GoCallOrConvExpression.class);
         return getFunctionDeclaration(getCallFunctionIdentifier(callExpr));
     }
diff --git a/src/ro/redeul/google/go/util/GoTypeInspectUtil.java b/src/ro/redeul/google/go/util/GoTypeInspectUtil.java
@@ -14,6 +14,7 @@
 import ro.redeul.google.go.lang.psi.expressions.GoUnaryExpression;
 import ro.redeul.google.go.lang.psi.expressions.binary.GoBinaryExpression;
 import ro.redeul.google.go.lang.psi.expressions.literals.*;
+import ro.redeul.google.go.lang.psi.expressions.primary.GoBuiltinCallExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoCallOrConvExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoLiteralExpression;
 import ro.redeul.google.go.lang.psi.expressions.primary.GoParenthesisedExpression;
@@ -221,6 +222,24 @@ public static void checkFunctionTypeArguments(GoCallOrConvExpression call, Inspe
         if (goFunctionDeclaration == null)
             return;
 
+        if (call instanceof GoBuiltinCallExpression) {
+            GoPsiType[] builtinTypes = ((GoBuiltinCallExpression) call).getArgumentsType();
+            if (builtinTypes.length > 0 && goExprs.length == builtinTypes.length) {
+                for (; index < goExprs.length; index++) {
+                    GoExpr goExpr = goExprs[index];
+                    GoPsiType type = builtinTypes[index];
+                    if (!checkParametersExp(type, goExpr)){
+                        result.addProblem(
+                                goExpr,
+                                GoBundle.message("warning.functioncall.type.mismatch", type.getText()),
+                                ProblemHighlightType.GENERIC_ERROR_OR_WARNING, new CastTypeFix(goExpr, type));
+                        return;
+                    }
+                }
+            }
+            return;
+        }
+
         for (GoFunctionParameter functionParameter : goFunctionDeclaration.getParameters()) {
             if (index >= goExprs.length)
                 return;
diff --git a/test/ro/redeul/google/go/inspection/FunctionCallInspectionTest.java b/test/ro/redeul/google/go/inspection/FunctionCallInspectionTest.java
@@ -5,4 +5,8 @@ public class FunctionCallInspectionTest extends GoInspectionTestCase {
     public void testMake() throws Exception{ doTest(); }
     public void testNew() throws Exception{ doTest(); }
     public void testFuncCall() throws Exception{ doTest(); }
+    public void testBuiltinCall() throws Exception{
+        myFixture.addFileToProject("builtin.go", "package builtin\ntype Type int\ntype Type1 int\nfunc append(slice []Type, elems ...Type) []Type\nfunc copy(dst, src []Type) int\nfunc delete(m map[Type]Type1, key Type)\n");
+        doTest();
+    }
 }
diff --git a/test/ro/redeul/google/go/inspection/GoInspectionTestCase.java b/test/ro/redeul/google/go/inspection/GoInspectionTestCase.java
@@ -68,7 +68,7 @@ protected void doTest() throws Exception {
 
     @Override
     protected void tearDown() throws Exception {
-        removeContentRoots();
+//        removeContentRoots();
         super.tearDown();
     }
 
diff --git a/testdata/inspection/functionCall/builtinCall.go b/testdata/inspection/functionCall/builtinCall.go
@@ -0,0 +1,24 @@
+package main
+
+func main() {
+	// issue #480
+	arr1 := []int{}
+	arr2 := []string{}
+	arr3 := []byte{}
+	arr1 = append(arr1, 1)
+	arr1 = append(arr1, 1, 2, 3)
+	arr1 = append(arr1, /*begin*/1.2/*end.Expression type mismatch, the expected type is int|CastTypeFix*/)
+	arr1 = append(arr1, /*begin*/""/*end.Expression type mismatch, the expected type is int|CastTypeFix*/)
+
+	copy(arr1, arr1)
+	copy(arr1, /*begin*/arr2/*end.Expression type mismatch, the expected type is []int|CastTypeFix*/)
+
+	map1 := map[string]int{}
+	delete(map1, "key")
+	delete(map1, /*begin*/1/*end.Expression type mismatch, the expected type is string|CastTypeFix*/)
+
+	// This test will be broken when issue #609 is fixed
+	arr1 = append(arr1, /*begin*/arr1/*end.Expression type mismatch, the expected type is int|CastTypeFix*/...)
+	arr3 = append(arr3, /*begin*/"test"/*end.Expression type mismatch, the expected type is byte|CastTypeFix*/...)
+
+}
diff --git a/testdata/inspection/functionCall/funcCall.go b/testdata/inspection/functionCall/funcCall.go
@@ -464,6 +464,4 @@ func main() {
 	myNewFnForTest := func(a string, b string) (bool,bool,bool) {return false,false,false}
 	TestLiteralFunc(/*begin*/myNewFnForTest/*end.Expression type mismatch, the expected type is func(string,string)(bool,bool)|CastTypeFix*/)
 	TestLiteralFunc(func(a string,b string)(bool,bool) {return false,true})
-
-
 }

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,8 @@ public class FunctionCallInspectionTest extends GoInspectionTestCase {`
`5`	`5`	`public void testMake() throws Exception{ doTest(); }`
`6`	`6`	`public void testNew() throws Exception{ doTest(); }`
`7`	`7`	`public void testFuncCall() throws Exception{ doTest(); }`
	`8`	`+ public void testBuiltinCall() throws Exception{`
	`9`	`+ myFixture.addFileToProject("builtin.go", "package builtin\ntype Type int\ntype Type1 int\nfunc append(slice []Type, elems ...Type) []Type\nfunc copy(dst, src []Type) int\nfunc delete(m map[Type]Type1, key Type)\n");`
	`10`	`+ doTest();`
	`11`	`+ }`
`8`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ protected void doTest() throws Exception {`
`68`	`68`
`69`	`69`	`@Override`
`70`	`70`	`protected void tearDown() throws Exception {`
`71`		`- removeContentRoots();`
	`71`	`+// removeContentRoots();`
`72`	`72`	`super.tearDown();`
`73`	`73`	`}`
`74`	`74`
Original file line number	Diff line number	Diff line change
`@@ -464,6 +464,4 @@ func main() {`
`464`	`464`	`myNewFnForTest := func(a string, b string) (bool,bool,bool) {return false,false,false}`
`465`	`465`	`TestLiteralFunc(/begin/myNewFnForTest/end.Expression type mismatch, the expected type is func(string,string)(bool,bool)\|CastTypeFix/)`
`466`	`466`	`TestLiteralFunc(func(a string,b string)(bool,bool) {return false,true})`
`467`		`-`
`468`		`-`
`469`	`467`	`}`