github.com/mh-cbon/go@v0.0.0-20160603070303-9e112a3fe4c0/src/cmd/vet/testdata/print.go (about)

     1  // Copyright 2010 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  // This file contains tests for the printf checker.
     6  
     7  package testdata
     8  
     9  import (
    10  	"fmt"
    11  	"io"
    12  	"math"
    13  	"os"
    14  	"unsafe" // just for test case printing unsafe.Pointer
    15  
    16  	// For testing printf-like functions from external package.
    17  	"github.com/foobar/externalprintf"
    18  )
    19  
    20  func UnsafePointerPrintfTest() {
    21  	var up unsafe.Pointer
    22  	fmt.Printf("%p, %x %X", up, up, up)
    23  }
    24  
    25  // Error methods that do not satisfy the Error interface and should be checked.
    26  type errorTest1 int
    27  
    28  func (errorTest1) Error(...interface{}) string {
    29  	return "hi"
    30  }
    31  
    32  type errorTest2 int // Analogous to testing's *T type.
    33  func (errorTest2) Error(...interface{}) {
    34  }
    35  
    36  type errorTest3 int
    37  
    38  func (errorTest3) Error() { // No return value.
    39  }
    40  
    41  type errorTest4 int
    42  
    43  func (errorTest4) Error() int { // Different return type.
    44  	return 3
    45  }
    46  
    47  type errorTest5 int
    48  
    49  func (errorTest5) error() { // niladic; don't complain if no args (was bug)
    50  }
    51  
    52  // This function never executes, but it serves as a simple test for the program.
    53  // Test with make test.
    54  func PrintfTests() {
    55  	var b bool
    56  	var i int
    57  	var r rune
    58  	var s string
    59  	var x float64
    60  	var p *int
    61  	var imap map[int]int
    62  	var fslice []float64
    63  	var c complex64
    64  	// Some good format/argtypes
    65  	fmt.Printf("")
    66  	fmt.Printf("%b %b %b", 3, i, x)
    67  	fmt.Printf("%c %c %c %c", 3, i, 'x', r)
    68  	fmt.Printf("%d %d %d", 3, i, imap)
    69  	fmt.Printf("%e %e %e %e", 3e9, x, fslice, c)
    70  	fmt.Printf("%E %E %E %E", 3e9, x, fslice, c)
    71  	fmt.Printf("%f %f %f %f", 3e9, x, fslice, c)
    72  	fmt.Printf("%F %F %F %F", 3e9, x, fslice, c)
    73  	fmt.Printf("%g %g %g %g", 3e9, x, fslice, c)
    74  	fmt.Printf("%G %G %G %G", 3e9, x, fslice, c)
    75  	fmt.Printf("%b %b %b %b", 3e9, x, fslice, c)
    76  	fmt.Printf("%o %o", 3, i)
    77  	fmt.Printf("%p %p", p, nil)
    78  	fmt.Printf("%q %q %q %q", 3, i, 'x', r)
    79  	fmt.Printf("%s %s %s", "hi", s, []byte{65})
    80  	fmt.Printf("%t %t", true, b)
    81  	fmt.Printf("%T %T", 3, i)
    82  	fmt.Printf("%U %U", 3, i)
    83  	fmt.Printf("%v %v", 3, i)
    84  	fmt.Printf("%x %x %x %x", 3, i, "hi", s)
    85  	fmt.Printf("%X %X %X %X", 3, i, "hi", s)
    86  	fmt.Printf("%.*s %d %g", 3, "hi", 23, 2.3)
    87  	fmt.Printf("%s", &stringerv)
    88  	fmt.Printf("%v", &stringerv)
    89  	fmt.Printf("%T", &stringerv)
    90  	fmt.Printf("%v", notstringerv)
    91  	fmt.Printf("%T", notstringerv)
    92  	fmt.Printf("%q", stringerarrayv)
    93  	fmt.Printf("%v", stringerarrayv)
    94  	fmt.Printf("%s", stringerarrayv)
    95  	fmt.Printf("%v", notstringerarrayv)
    96  	fmt.Printf("%T", notstringerarrayv)
    97  	fmt.Printf("%d", new(Formatter))
    98  	fmt.Printf("%*%", 2)               // Ridiculous but allowed.
    99  	fmt.Printf("%s", interface{}(nil)) // Nothing useful we can say.
   100  
   101  	fmt.Printf("%g", 1+2i)
   102  	// Some bad format/argTypes
   103  	fmt.Printf("%b", "hi")                     // ERROR "arg .hi. for printf verb %b of wrong type"
   104  	fmt.Printf("%t", c)                        // ERROR "arg c for printf verb %t of wrong type"
   105  	fmt.Printf("%t", 1+2i)                     // ERROR "arg 1 \+ 2i for printf verb %t of wrong type"
   106  	fmt.Printf("%c", 2.3)                      // ERROR "arg 2.3 for printf verb %c of wrong type"
   107  	fmt.Printf("%d", 2.3)                      // ERROR "arg 2.3 for printf verb %d of wrong type"
   108  	fmt.Printf("%e", "hi")                     // ERROR "arg .hi. for printf verb %e of wrong type"
   109  	fmt.Printf("%E", true)                     // ERROR "arg true for printf verb %E of wrong type"
   110  	fmt.Printf("%f", "hi")                     // ERROR "arg .hi. for printf verb %f of wrong type"
   111  	fmt.Printf("%F", 'x')                      // ERROR "arg 'x' for printf verb %F of wrong type"
   112  	fmt.Printf("%g", "hi")                     // ERROR "arg .hi. for printf verb %g of wrong type"
   113  	fmt.Printf("%g", imap)                     // ERROR "arg imap for printf verb %g of wrong type"
   114  	fmt.Printf("%G", i)                        // ERROR "arg i for printf verb %G of wrong type"
   115  	fmt.Printf("%o", x)                        // ERROR "arg x for printf verb %o of wrong type"
   116  	fmt.Printf("%p", 23)                       // ERROR "arg 23 for printf verb %p of wrong type"
   117  	fmt.Printf("%q", x)                        // ERROR "arg x for printf verb %q of wrong type"
   118  	fmt.Printf("%s", b)                        // ERROR "arg b for printf verb %s of wrong type"
   119  	fmt.Printf("%s", byte(65))                 // ERROR "arg byte\(65\) for printf verb %s of wrong type"
   120  	fmt.Printf("%t", 23)                       // ERROR "arg 23 for printf verb %t of wrong type"
   121  	fmt.Printf("%U", x)                        // ERROR "arg x for printf verb %U of wrong type"
   122  	fmt.Printf("%x", nil)                      // ERROR "arg nil for printf verb %x of wrong type"
   123  	fmt.Printf("%X", 2.3)                      // ERROR "arg 2.3 for printf verb %X of wrong type"
   124  	fmt.Printf("%s", stringerv)                // ERROR "arg stringerv for printf verb %s of wrong type"
   125  	fmt.Printf("%t", stringerv)                // ERROR "arg stringerv for printf verb %t of wrong type"
   126  	fmt.Printf("%q", notstringerv)             // ERROR "arg notstringerv for printf verb %q of wrong type"
   127  	fmt.Printf("%t", notstringerv)             // ERROR "arg notstringerv for printf verb %t of wrong type"
   128  	fmt.Printf("%t", stringerarrayv)           // ERROR "arg stringerarrayv for printf verb %t of wrong type"
   129  	fmt.Printf("%t", notstringerarrayv)        // ERROR "arg notstringerarrayv for printf verb %t of wrong type"
   130  	fmt.Printf("%q", notstringerarrayv)        // ERROR "arg notstringerarrayv for printf verb %q of wrong type"
   131  	fmt.Printf("%d", Formatter(true))          // correct (the type is responsible for formatting)
   132  	fmt.Printf("%s", nonemptyinterface)        // correct (the dynamic type of nonemptyinterface may be a stringer)
   133  	fmt.Printf("%.*s %d %g", 3, "hi", 23, 'x') // ERROR "arg 'x' for printf verb %g of wrong type"
   134  	fmt.Println()                              // not an error
   135  	fmt.Println("%s", "hi")                    // ERROR "possible formatting directive in Println call"
   136  	fmt.Printf("%s", "hi", 3)                  // ERROR "wrong number of args for format in Printf call"
   137  	_ = fmt.Sprintf("%"+("s"), "hi", 3)        // ERROR "wrong number of args for format in Sprintf call"
   138  	fmt.Printf("%s%%%d", "hi", 3)              // correct
   139  	fmt.Printf("%08s", "woo")                  // correct
   140  	fmt.Printf("% 8s", "woo")                  // correct
   141  	fmt.Printf("%.*d", 3, 3)                   // correct
   142  	fmt.Printf("%.*d", 3, 3, 3, 3)             // ERROR "wrong number of args for format in Printf call.*4 args"
   143  	fmt.Printf("%.*d", "hi", 3)                // ERROR "arg .hi. for \* in printf format not of type int"
   144  	fmt.Printf("%.*d", i, 3)                   // correct
   145  	fmt.Printf("%.*d", s, 3)                   // ERROR "arg s for \* in printf format not of type int"
   146  	fmt.Printf("%*%", 0.22)                    // ERROR "arg 0.22 for \* in printf format not of type int"
   147  	fmt.Printf("%q %q", multi()...)            // ok
   148  	fmt.Printf("%#q", `blah`)                  // ok
   149  	printf("now is the time", "buddy")         // ERROR "no formatting directive"
   150  	Printf("now is the time", "buddy")         // ERROR "no formatting directive"
   151  	Printf("hi")                               // ok
   152  	const format = "%s %s\n"
   153  	Printf(format, "hi", "there")
   154  	Printf(format, "hi")              // ERROR "missing argument for Printf..%s..: format reads arg 2, have only 1"
   155  	Printf("%s %d %.3v %q", "str", 4) // ERROR "missing argument for Printf..%.3v..: format reads arg 3, have only 2"
   156  	f := new(stringer)
   157  	f.Warn(0, "%s", "hello", 3)  // ERROR "possible formatting directive in Warn call"
   158  	f.Warnf(0, "%s", "hello", 3) // ERROR "wrong number of args for format in Warnf call"
   159  	f.Warnf(0, "%r", "hello")    // ERROR "unrecognized printf verb"
   160  	f.Warnf(0, "%#s", "hello")   // ERROR "unrecognized printf flag"
   161  	Printf("d%", 2)              // ERROR "missing verb at end of format string in Printf call"
   162  	Printf("%d", percentDV)
   163  	Printf("%d", &percentDV)
   164  	Printf("%d", notPercentDV)  // ERROR "arg notPercentDV for printf verb %d of wrong type"
   165  	Printf("%d", &notPercentDV) // ERROR "arg &notPercentDV for printf verb %d of wrong type"
   166  	Printf("%p", &notPercentDV) // Works regardless: we print it as a pointer.
   167  	Printf("%s", percentSV)
   168  	Printf("%s", &percentSV)
   169  	// Good argument reorderings.
   170  	Printf("%[1]d", 3)
   171  	Printf("%[1]*d", 3, 1)
   172  	Printf("%[2]*[1]d", 1, 3)
   173  	Printf("%[2]*.[1]*[3]d", 2, 3, 4)
   174  	fmt.Fprintf(os.Stderr, "%[2]*.[1]*[3]d", 2, 3, 4) // Use Fprintf to make sure we count arguments correctly.
   175  	// Bad argument reorderings.
   176  	Printf("%[xd", 3)                    // ERROR "illegal syntax for printf argument index"
   177  	Printf("%[x]d", 3)                   // ERROR "illegal syntax for printf argument index"
   178  	Printf("%[3]*s", "hi", 2)            // ERROR "missing argument for Printf.* reads arg 3, have only 2"
   179  	_ = fmt.Sprintf("%[3]d", 2)          // ERROR "missing argument for Sprintf.* reads arg 3, have only 1"
   180  	Printf("%[2]*.[1]*[3]d", 2, "hi", 4) // ERROR "arg .hi. for \* in printf format not of type int"
   181  	Printf("%[0]s", "arg1")              // ERROR "index value \[0\] for Printf.*; indexes start at 1"
   182  	Printf("%[0]d", 1)                   // ERROR "index value \[0\] for Printf.*; indexes start at 1"
   183  	// Something that satisfies the error interface.
   184  	var e error
   185  	fmt.Println(e.Error()) // ok
   186  	// Something that looks like an error interface but isn't, such as the (*T).Error method
   187  	// in the testing package.
   188  	var et1 errorTest1
   189  	fmt.Println(et1.Error())        // ok
   190  	fmt.Println(et1.Error("hi"))    // ok
   191  	fmt.Println(et1.Error("%d", 3)) // ERROR "possible formatting directive in Error call"
   192  	var et2 errorTest2
   193  	et2.Error()        // ok
   194  	et2.Error("hi")    // ok, not an error method.
   195  	et2.Error("%d", 3) // ERROR "possible formatting directive in Error call"
   196  	var et3 errorTest3
   197  	et3.Error() // ok, not an error method.
   198  	var et4 errorTest4
   199  	et4.Error() // ok, not an error method.
   200  	var et5 errorTest5
   201  	et5.error() // ok, not an error method.
   202  	// Can't print a function.
   203  	Printf("%d", someFunction) // ERROR "arg someFunction in printf call is a function value, not a function call"
   204  	Printf("%v", someFunction) // ERROR "arg someFunction in printf call is a function value, not a function call"
   205  	Println(someFunction)      // ERROR "arg someFunction in Println call is a function value, not a function call"
   206  	Printf("%p", someFunction) // ok: maybe someone wants to see the pointer
   207  	Printf("%T", someFunction) // ok: maybe someone wants to see the type
   208  	// Bug: used to recur forever.
   209  	Printf("%p %x", recursiveStructV, recursiveStructV.next)
   210  	Printf("%p %x", recursiveStruct1V, recursiveStruct1V.next)
   211  	Printf("%p %x", recursiveSliceV, recursiveSliceV)
   212  	Printf("%p %x", recursiveMapV, recursiveMapV)
   213  	// Special handling for Log.
   214  	math.Log(3)  // OK
   215  	Log(3)       // OK
   216  	Log("%d", 3) // ERROR "possible formatting directive in Log call"
   217  	Logf("%d", 3)
   218  	Logf("%d", "hi") // ERROR "arg .hi. for printf verb %d of wrong type: string"
   219  
   220  	Errorf(1, "%d", 3)    // OK
   221  	Errorf(1, "%d", "hi") // ERROR "arg .hi. for printf verb %d of wrong type: string"
   222  
   223  	// Multiple string arguments before variadic args
   224  	errorf("WARNING", "foobar")            // OK
   225  	errorf("INFO", "s=%s, n=%d", "foo", 1) // OK
   226  	errorf("ERROR", "%d")                  // ERROR "format reads arg 1, have only 0 args"
   227  
   228  	// Printf from external package
   229  	externalprintf.Printf("%d", 42) // OK
   230  	externalprintf.Printf("foobar") // OK
   231  	level := 123
   232  	externalprintf.Logf(level, "%d", 42)                        // OK
   233  	externalprintf.Errorf(level, level, "foo %q bar", "foobar") // OK
   234  	externalprintf.Logf(level, "%d")                            // ERROR "format reads arg 1, have only 0 args"
   235  
   236  	// user-defined Println-like functions
   237  	ss := &someStruct{}
   238  	ss.Log(someFunction, "foo")          // OK
   239  	ss.Error(someFunction, someFunction) // OK
   240  	ss.Println()                         // OK
   241  	ss.Println(1.234, "foo")             // OK
   242  	ss.Println(1, someFunction)          // ERROR "arg someFunction in Println call is a function value, not a function call"
   243  	ss.log(someFunction)                 // OK
   244  	ss.log(someFunction, "bar", 1.33)    // OK
   245  	ss.log(someFunction, someFunction)   // ERROR "arg someFunction in log call is a function value, not a function call"
   246  }
   247  
   248  type someStruct struct{}
   249  
   250  // Log is non-variadic user-define Println-like function.
   251  // Calls to this func must be skipped when checking
   252  // for Println-like arguments.
   253  func (ss *someStruct) Log(f func(), s string) {}
   254  
   255  // Error is variadic user-define Println-like function.
   256  // Calls to this func mustn't be checked for Println-like arguments,
   257  // since variadic arguments type isn't interface{}.
   258  func (ss *someStruct) Error(args ...func()) {}
   259  
   260  // Println is variadic user-defined Println-like function.
   261  // Calls to this func must be checked for Println-like arguments.
   262  func (ss *someStruct) Println(args ...interface{}) {}
   263  
   264  // log is variadic user-defined Println-like function.
   265  // Calls to this func must be checked for Println-like arguments.
   266  func (ss *someStruct) log(f func(), args ...interface{}) {}
   267  
   268  // A function we use as a function value; it has no other purpose.
   269  func someFunction() {}
   270  
   271  // Printf is used by the test so we must declare it.
   272  func Printf(format string, args ...interface{}) {
   273  	panic("don't call - testing only")
   274  }
   275  
   276  // Println is used by the test so we must declare it.
   277  func Println(args ...interface{}) {
   278  	panic("don't call - testing only")
   279  }
   280  
   281  // Logf is used by the test so we must declare it.
   282  func Logf(format string, args ...interface{}) {
   283  	panic("don't call - testing only")
   284  }
   285  
   286  // Log is used by the test so we must declare it.
   287  func Log(args ...interface{}) {
   288  	panic("don't call - testing only")
   289  }
   290  
   291  // printf is used by the test so we must declare it.
   292  func printf(format string, args ...interface{}) {
   293  	panic("don't call - testing only")
   294  }
   295  
   296  // Errorf is used by the test for a case in which the first parameter
   297  // is not a format string.
   298  func Errorf(i int, format string, args ...interface{}) {
   299  	panic("don't call - testing only")
   300  }
   301  
   302  // errorf is used by the test for a case in which the function accepts multiple
   303  // string parameters before variadic arguments
   304  func errorf(level, format string, args ...interface{}) {
   305  	panic("don't call - testing only")
   306  }
   307  
   308  // multi is used by the test.
   309  func multi() []interface{} {
   310  	panic("don't call - testing only")
   311  }
   312  
   313  type stringer float64
   314  
   315  var stringerv stringer
   316  
   317  func (*stringer) String() string {
   318  	return "string"
   319  }
   320  
   321  func (*stringer) Warn(int, ...interface{}) string {
   322  	return "warn"
   323  }
   324  
   325  func (*stringer) Warnf(int, string, ...interface{}) string {
   326  	return "warnf"
   327  }
   328  
   329  type notstringer struct {
   330  	f float64
   331  }
   332  
   333  var notstringerv notstringer
   334  
   335  type stringerarray [4]float64
   336  
   337  func (stringerarray) String() string {
   338  	return "string"
   339  }
   340  
   341  var stringerarrayv stringerarray
   342  
   343  type notstringerarray [4]float64
   344  
   345  var notstringerarrayv notstringerarray
   346  
   347  var nonemptyinterface = interface {
   348  	f()
   349  }(nil)
   350  
   351  // A data type we can print with "%d".
   352  type percentDStruct struct {
   353  	a int
   354  	b []byte
   355  	c *float64
   356  }
   357  
   358  var percentDV percentDStruct
   359  
   360  // A data type we cannot print correctly with "%d".
   361  type notPercentDStruct struct {
   362  	a int
   363  	b []byte
   364  	c bool
   365  }
   366  
   367  var notPercentDV notPercentDStruct
   368  
   369  // A data type we can print with "%s".
   370  type percentSStruct struct {
   371  	a string
   372  	b []byte
   373  	c stringerarray
   374  }
   375  
   376  var percentSV percentSStruct
   377  
   378  type recursiveStringer int
   379  
   380  func (s recursiveStringer) String() string {
   381  	_ = fmt.Sprintf("%d", s)
   382  	_ = fmt.Sprintf("%#v", s)
   383  	_ = fmt.Sprintf("%v", s)  // ERROR "arg s for printf causes recursive call to String method"
   384  	_ = fmt.Sprintf("%v", &s) // ERROR "arg &s for printf causes recursive call to String method"
   385  	_ = fmt.Sprintf("%T", s)  // ok; does not recursively call String
   386  	return fmt.Sprintln(s)    // ERROR "arg s in Sprintln call causes recursive call to String method"
   387  }
   388  
   389  type recursivePtrStringer int
   390  
   391  func (p *recursivePtrStringer) String() string {
   392  	_ = fmt.Sprintf("%v", *p)
   393  	return fmt.Sprintln(p) // ERROR "arg p in Sprintln call causes recursive call to String method"
   394  }
   395  
   396  type Formatter bool
   397  
   398  func (*Formatter) Format(fmt.State, rune) {
   399  }
   400  
   401  type RecursiveSlice []RecursiveSlice
   402  
   403  var recursiveSliceV = &RecursiveSlice{}
   404  
   405  type RecursiveMap map[int]RecursiveMap
   406  
   407  var recursiveMapV = make(RecursiveMap)
   408  
   409  type RecursiveStruct struct {
   410  	next *RecursiveStruct
   411  }
   412  
   413  var recursiveStructV = &RecursiveStruct{}
   414  
   415  type RecursiveStruct1 struct {
   416  	next *Recursive2Struct
   417  }
   418  
   419  type RecursiveStruct2 struct {
   420  	next *Recursive1Struct
   421  }
   422  
   423  var recursiveStruct1V = &RecursiveStruct1{}
   424  
   425  // Fix for issue 7149: Missing return type on String method caused fault.
   426  func (int) String() {
   427  	return ""
   428  }
   429  
   430  func (s *unknownStruct) Fprintln(w io.Writer, s string) {}
   431  
   432  func UnknownStructFprintln() {
   433  	s := unknownStruct{}
   434  	s.Fprintln(os.Stdout, "hello, world!") // OK
   435  }