builtins_test.go

     1  // Copyright 2013 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package types_test
     6  
     7  import (
     8  	"fmt"
     9  	"go/ast"
    10  	"go/importer"
    11  	"go/parser"
    12  	"testing"
    13  
    14  	. "go/types"
    15  )
    16  
    17  var builtinCalls = []struct {
    18  	name, src, sig string
    19  }{
    20  	{"append", `var s []int; _ = append(s)`, `func([]int, ...int) []int`},
    21  	{"append", `var s []int; _ = append(s, 0)`, `func([]int, ...int) []int`},
    22  	{"append", `var s []int; _ = (append)(s, 0)`, `func([]int, ...int) []int`},
    23  	{"append", `var s []byte; _ = ((append))(s, 0)`, `func([]byte, ...byte) []byte`},
    24  	{"append", `var s []byte; _ = append(s, "foo"...)`, `func([]byte, string...) []byte`},
    25  	{"append", `type T []byte; var s T; var str string; _ = append(s, str...)`, `func(p.T, string...) p.T`},
    26  	{"append", `type T []byte; type U string; var s T; var str U; _ = append(s, str...)`, `func(p.T, p.U...) p.T`},
    27  
    28  	{"cap", `var s [10]int; _ = cap(s)`, `invalid type`},  // constant
    29  	{"cap", `var s [10]int; _ = cap(&s)`, `invalid type`}, // constant
    30  	{"cap", `var s []int64; _ = cap(s)`, `func([]int64) int`},
    31  	{"cap", `var c chan<-bool; _ = cap(c)`, `func(chan<- bool) int`},
    32  	{"cap", `type S []byte; var s S; _ = cap(s)`, `func(p.S) int`},
    33  	{"cap", `var s P; _ = cap(s)`, `func(P) int`},
    34  
    35  	{"len", `_ = len("foo")`, `invalid type`}, // constant
    36  	{"len", `var s string; _ = len(s)`, `func(string) int`},
    37  	{"len", `var s [10]int; _ = len(s)`, `invalid type`},  // constant
    38  	{"len", `var s [10]int; _ = len(&s)`, `invalid type`}, // constant
    39  	{"len", `var s []int64; _ = len(s)`, `func([]int64) int`},
    40  	{"len", `var c chan<-bool; _ = len(c)`, `func(chan<- bool) int`},
    41  	{"len", `var m map[string]float32; _ = len(m)`, `func(map[string]float32) int`},
    42  	{"len", `type S []byte; var s S; _ = len(s)`, `func(p.S) int`},
    43  	{"len", `var s P; _ = len(s)`, `func(P) int`},
    44  
    45  	{"close", `var c chan int; close(c)`, `func(chan int)`},
    46  	{"close", `var c chan<- chan string; close(c)`, `func(chan<- chan string)`},
    47  
    48  	{"complex", `_ = complex(1, 0)`, `invalid type`}, // constant
    49  	{"complex", `var re float32; _ = complex(re, 1.0)`, `func(float32, float32) complex64`},
    50  	{"complex", `var im float64; _ = complex(1, im)`, `func(float64, float64) complex128`},
    51  	{"complex", `type F32 float32; var re, im F32; _ = complex(re, im)`, `func(p.F32, p.F32) complex64`},
    52  	{"complex", `type F64 float64; var re, im F64; _ = complex(re, im)`, `func(p.F64, p.F64) complex128`},
    53  
    54  	{"copy", `var src, dst []byte; copy(dst, src)`, `func([]byte, []byte) int`},
    55  	{"copy", `type T [][]int; var src, dst T; _ = copy(dst, src)`, `func(p.T, p.T) int`},
    56  	{"copy", `var src string; var dst []byte; copy(dst, src)`, `func([]byte, string) int`},
    57  	{"copy", `type T string; type U []byte; var src T; var dst U; copy(dst, src)`, `func(p.U, p.T) int`},
    58  	{"copy", `var dst []byte; copy(dst, "hello")`, `func([]byte, string) int`},
    59  
    60  	{"delete", `var m map[string]bool; delete(m, "foo")`, `func(map[string]bool, string)`},
    61  	{"delete", `type (K string; V int); var m map[K]V; delete(m, "foo")`, `func(map[p.K]p.V, p.K)`},
    62  
    63  	{"imag", `_ = imag(1i)`, `invalid type`}, // constant
    64  	{"imag", `var c complex64; _ = imag(c)`, `func(complex64) float32`},
    65  	{"imag", `var c complex128; _ = imag(c)`, `func(complex128) float64`},
    66  	{"imag", `type C64 complex64; var c C64; _ = imag(c)`, `func(p.C64) float32`},
    67  	{"imag", `type C128 complex128; var c C128; _ = imag(c)`, `func(p.C128) float64`},
    68  
    69  	{"real", `_ = real(1i)`, `invalid type`}, // constant
    70  	{"real", `var c complex64; _ = real(c)`, `func(complex64) float32`},
    71  	{"real", `var c complex128; _ = real(c)`, `func(complex128) float64`},
    72  	{"real", `type C64 complex64; var c C64; _ = real(c)`, `func(p.C64) float32`},
    73  	{"real", `type C128 complex128; var c C128; _ = real(c)`, `func(p.C128) float64`},
    74  
    75  	{"make", `_ = make([]int, 10)`, `func([]int, int) []int`},
    76  	{"make", `type T []byte; _ = make(T, 10, 20)`, `func(p.T, int, int) p.T`},
    77  
    78  	// issue #37349
    79  	{"make", `              _ = make([]int, 0   )`, `func([]int, int) []int`},
    80  	{"make", `var l    int; _ = make([]int, l   )`, `func([]int, int) []int`},
    81  	{"make", `              _ = make([]int, 0, 0)`, `func([]int, int, int) []int`},
    82  	{"make", `var l    int; _ = make([]int, l, 0)`, `func([]int, int, int) []int`},
    83  	{"make", `var    c int; _ = make([]int, 0, c)`, `func([]int, int, int) []int`},
    84  	{"make", `var l, c int; _ = make([]int, l, c)`, `func([]int, int, int) []int`},
    85  
    86  	// issue #37393
    87  	{"make", `                _ = make([]int       , 0   )`, `func([]int, int) []int`},
    88  	{"make", `var l    byte ; _ = make([]int8      , l   )`, `func([]int8, byte) []int8`},
    89  	{"make", `                _ = make([]int16     , 0, 0)`, `func([]int16, int, int) []int16`},
    90  	{"make", `var l    int16; _ = make([]string    , l, 0)`, `func([]string, int16, int) []string`},
    91  	{"make", `var    c int32; _ = make([]float64   , 0, c)`, `func([]float64, int, int32) []float64`},
    92  	{"make", `var l, c uint ; _ = make([]complex128, l, c)`, `func([]complex128, uint, uint) []complex128`},
    93  
    94  	// issue #45667
    95  	{"make", `const l uint = 1; _ = make([]int, l)`, `func([]int, uint) []int`},
    96  
    97  	{"new", `_ = new(int)`, `func(int) *int`},
    98  	{"new", `type T struct{}; _ = new(T)`, `func(p.T) *p.T`},
    99  
   100  	{"panic", `panic(0)`, `func(interface{})`},
   101  	{"panic", `panic("foo")`, `func(interface{})`},
   102  
   103  	{"print", `print()`, `func()`},
   104  	{"print", `print(0)`, `func(int)`},
   105  	{"print", `print(1, 2.0, "foo", true)`, `func(int, float64, string, bool)`},
   106  
   107  	{"println", `println()`, `func()`},
   108  	{"println", `println(0)`, `func(int)`},
   109  	{"println", `println(1, 2.0, "foo", true)`, `func(int, float64, string, bool)`},
   110  
   111  	{"recover", `recover()`, `func() interface{}`},
   112  	{"recover", `_ = recover()`, `func() interface{}`},
   113  
   114  	{"Add", `var p unsafe.Pointer; _ = unsafe.Add(p, -1.0)`, `func(unsafe.Pointer, int) unsafe.Pointer`},
   115  	{"Add", `var p unsafe.Pointer; var n uintptr; _ = unsafe.Add(p, n)`, `func(unsafe.Pointer, uintptr) unsafe.Pointer`},
   116  	{"Add", `_ = unsafe.Add(nil, 0)`, `func(unsafe.Pointer, int) unsafe.Pointer`},
   117  
   118  	{"Alignof", `_ = unsafe.Alignof(0)`, `invalid type`},                 // constant
   119  	{"Alignof", `var x struct{}; _ = unsafe.Alignof(x)`, `invalid type`}, // constant
   120  	{"Alignof", `var x P; _ = unsafe.Alignof(x)`, `func(P) uintptr`},
   121  
   122  	{"Offsetof", `var x struct{f bool}; _ = unsafe.Offsetof(x.f)`, `invalid type`},           // constant
   123  	{"Offsetof", `var x struct{_ int; f bool}; _ = unsafe.Offsetof((&x).f)`, `invalid type`}, // constant
   124  	{"Offsetof", `var x struct{_ int; f P}; _ = unsafe.Offsetof((&x).f)`, `func(P) uintptr`},
   125  
   126  	{"Sizeof", `_ = unsafe.Sizeof(0)`, `invalid type`},                 // constant
   127  	{"Sizeof", `var x struct{}; _ = unsafe.Sizeof(x)`, `invalid type`}, // constant
   128  	{"Sizeof", `var x P; _ = unsafe.Sizeof(x)`, `func(P) uintptr`},
   129  
   130  	{"Slice", `var p *int; _ = unsafe.Slice(p, 1)`, `func(*int, int) []int`},
   131  	{"Slice", `var p *byte; var n uintptr; _ = unsafe.Slice(p, n)`, `func(*byte, uintptr) []byte`},
   132  
   133  	{"assert", `assert(true)`, `invalid type`},                                    // constant
   134  	{"assert", `type B bool; const pred B = 1 < 2; assert(pred)`, `invalid type`}, // constant
   135  
   136  	// no tests for trace since it produces output as a side-effect
   137  }
   138  
   139  func TestBuiltinSignatures(t *testing.T) {
   140  	DefPredeclaredTestFuncs()
   141  
   142  	seen := map[string]bool{"trace": true} // no test for trace built-in; add it manually
   143  	for _, call := range builtinCalls {
   144  		testBuiltinSignature(t, call.name, call.src, call.sig)
   145  		seen[call.name] = true
   146  	}
   147  
   148  	// make sure we didn't miss one
   149  	for _, name := range Universe.Names() {
   150  		if _, ok := Universe.Lookup(name).(*Builtin); ok && !seen[name] {
   151  			t.Errorf("missing test for %s", name)
   152  		}
   153  	}
   154  	for _, name := range Unsafe.Scope().Names() {
   155  		if _, ok := Unsafe.Scope().Lookup(name).(*Builtin); ok && !seen[name] {
   156  			t.Errorf("missing test for unsafe.%s", name)
   157  		}
   158  	}
   159  }
   160  
   161  // parseGenericSrc in types2 is not necessary. We can just parse in testBuiltinSignature below.
   162  
   163  func testBuiltinSignature(t *testing.T, name, src0, want string) {
   164  	src := fmt.Sprintf(`package p; import "unsafe"; type _ unsafe.Pointer /* use unsafe */; func _[P ~[]byte]() { %s }`, src0)
   165  	f, err := parser.ParseFile(fset, "", src, 0)
   166  	if err != nil {
   167  		t.Errorf("%s: %s", src0, err)
   168  		return
   169  	}
   170  
   171  	conf := Config{Importer: importer.Default()}
   172  	uses := make(map[*ast.Ident]Object)
   173  	types := make(map[ast.Expr]TypeAndValue)
   174  	_, err = conf.Check(f.Name.Name, fset, []*ast.File{f}, &Info{Uses: uses, Types: types})
   175  	if err != nil {
   176  		t.Errorf("%s: %s", src0, err)
   177  		return
   178  	}
   179  
   180  	// find called function
   181  	n := 0
   182  	var fun ast.Expr
   183  	for x := range types {
   184  		if call, _ := x.(*ast.CallExpr); call != nil {
   185  			fun = call.Fun
   186  			n++
   187  		}
   188  	}
   189  	if n != 1 {
   190  		t.Errorf("%s: got %d CallExprs; want 1", src0, n)
   191  		return
   192  	}
   193  
   194  	// check recorded types for fun and descendents (may be parenthesized)
   195  	for {
   196  		// the recorded type for the built-in must match the wanted signature
   197  		typ := types[fun].Type
   198  		if typ == nil {
   199  			t.Errorf("%s: no type recorded for %s", src0, ExprString(fun))
   200  			return
   201  		}
   202  		if got := typ.String(); got != want {
   203  			t.Errorf("%s: got type %s; want %s", src0, got, want)
   204  			return
   205  		}
   206  
   207  		// called function must be a (possibly parenthesized, qualified)
   208  		// identifier denoting the expected built-in
   209  		switch p := fun.(type) {
   210  		case *ast.Ident:
   211  			obj := uses[p]
   212  			if obj == nil {
   213  				t.Errorf("%s: no object found for %s", src0, p)
   214  				return
   215  			}
   216  			bin, _ := obj.(*Builtin)
   217  			if bin == nil {
   218  				t.Errorf("%s: %s does not denote a built-in", src0, p)
   219  				return
   220  			}
   221  			if bin.Name() != name {
   222  				t.Errorf("%s: got built-in %s; want %s", src0, bin.Name(), name)
   223  				return
   224  			}
   225  			return // we're done
   226  
   227  		case *ast.ParenExpr:
   228  			fun = p.X // unpack
   229  
   230  		case *ast.SelectorExpr:
   231  			// built-in from package unsafe - ignore details
   232  			return // we're done
   233  
   234  		default:
   235  			t.Errorf("%s: invalid function call", src0)
   236  			return
   237  		}
   238  	}
   239  }
   240
View as plain text