1 // Copyright 2012 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.
5 // Package types declares the data types and implements
6 // the algorithms for type-checking of Go packages. Use
7 // Config.Check to invoke the type checker for a package.
8 // Alternatively, create a new type checker with NewChecker
9 // and invoke it incrementally by calling Checker.Files.
11 // Type-checking consists of several interdependent phases:
13 // Name resolution maps each identifier (ast.Ident) in the program to the
14 // language object (Object) it denotes.
15 // Use Info.{Defs,Uses,Implicits} for the results of name resolution.
17 // Constant folding computes the exact constant value (constant.Value)
18 // for every expression (ast.Expr) that is a compile-time constant.
19 // Use Info.Types[expr].Value for the results of constant folding.
21 // Type inference computes the type (Type) of every expression (ast.Expr)
22 // and checks for compliance with the language specification.
23 // Use Info.Types[expr].Type for the results of type inference.
25 // For a tutorial, see https://golang.org/s/types-tutorial.
37 // An Error describes a type-checking error; it implements the error interface.
38 // A "soft" error is an error that still permits a valid interpretation of a
39 // package (such as "unused variable"); "hard" errors may lead to unpredictable
40 // behavior if ignored.
42 Fset *token.FileSet // file set for interpretation of Pos
43 Pos token.Pos // error position
44 Msg string // error message
45 Soft bool // if set, error is "soft"
47 // go116code is a future API, unexported as the set of error codes is large
48 // and likely to change significantly during experimentation. Tools wishing
49 // to preview this feature may read go116code using reflection (see
50 // errorcodes_test.go), but beware that there is no guarantee of future
57 // Error returns an error string formatted as follows:
58 // filename:line:column: message
59 func (err Error) Error() string {
60 return fmt.Sprintf("%s: %s", err.Fset.Position(err.Pos), err.Msg)
63 // An ArgumentError holds an error associated with an argument index.
64 type ArgumentError struct {
69 func (e *ArgumentError) Error() string { return e.Err.Error() }
70 func (e *ArgumentError) Unwrap() error { return e.Err }
72 // An Importer resolves import paths to Packages.
74 // CAUTION: This interface does not support the import of locally
75 // vendored packages. See https://golang.org/s/go15vendor.
76 // If possible, external implementations should implement ImporterFrom.
77 type Importer interface {
78 // Import returns the imported package for the given import path.
79 // The semantics is like for ImporterFrom.ImportFrom except that
80 // dir and mode are ignored (since they are not present).
81 Import(path string) (*Package, error)
84 // ImportMode is reserved for future use.
87 // An ImporterFrom resolves import paths to packages; it
88 // supports vendoring per https://golang.org/s/go15vendor.
89 // Use go/importer to obtain an ImporterFrom implementation.
90 type ImporterFrom interface {
91 // Importer is present for backward-compatibility. Calling
92 // Import(path) is the same as calling ImportFrom(path, "", 0);
93 // i.e., locally vendored packages may not be found.
94 // The types package does not call Import if an ImporterFrom
98 // ImportFrom returns the imported package for the given import
99 // path when imported by a package file located in dir.
100 // If the import failed, besides returning an error, ImportFrom
101 // is encouraged to cache and return a package anyway, if one
102 // was created. This will reduce package inconsistencies and
103 // follow-on type checker errors due to the missing package.
104 // The mode value must be 0; it is reserved for future use.
105 // Two calls to ImportFrom with the same path and dir must
106 // return the same package.
107 ImportFrom(path, dir string, mode ImportMode) (*Package, error)
110 // A Config specifies the configuration for type checking.
111 // The zero value for Config is a ready-to-use default configuration.
113 // Context is the context used for resolving global identifiers. If nil, the
114 // type checker will initialize this field with a newly created context.
117 // GoVersion describes the accepted Go language version. The string
118 // must follow the format "go%d.%d" (e.g. "go1.12") or it must be
119 // empty; an empty string indicates the latest language version.
120 // If the format is invalid, invoking the type checker will cause a
124 // If IgnoreFuncBodies is set, function bodies are not
126 IgnoreFuncBodies bool
128 // If FakeImportC is set, `import "C"` (for packages requiring Cgo)
129 // declares an empty "C" package and errors are omitted for qualified
130 // identifiers referring to package C (which won't find an object).
131 // This feature is intended for the standard library cmd/api tool.
133 // Caution: Effects may be unpredictable due to follow-on errors.
134 // Do not use casually!
137 // If go115UsesCgo is set, the type checker expects the
138 // _cgo_gotypes.go file generated by running cmd/cgo to be
139 // provided as a package source file. Qualified identifiers
140 // referring to package C will be resolved to cgo-provided
141 // declarations within _cgo_gotypes.go.
143 // It is an error to set both FakeImportC and go115UsesCgo.
146 // If Error != nil, it is called with each error found
147 // during type checking; err has dynamic type Error.
148 // Secondary errors (for instance, to enumerate all types
149 // involved in an invalid recursive type declaration) have
150 // error strings that start with a '\t' character.
151 // If Error == nil, type-checking stops with the first
153 Error func(err error)
155 // An importer is used to import packages referred to from
156 // import declarations.
157 // If the installed importer implements ImporterFrom, the type
158 // checker calls ImportFrom instead of Import.
159 // The type checker reports an error if an importer is needed
160 // but none was installed.
163 // If Sizes != nil, it provides the sizing functions for package unsafe.
164 // Otherwise SizesFor("gc", "amd64") is used instead.
167 // If DisableUnusedImportCheck is set, packages are not checked
168 // for unused imports.
169 DisableUnusedImportCheck bool
172 func srcimporter_setUsesCgo(conf *Config) {
173 conf.go115UsesCgo = true
176 // Info holds result type information for a type-checked package.
177 // Only the information for which a map is provided is collected.
178 // If the package has type errors, the collected information may
181 // Types maps expressions to their types, and for constant
182 // expressions, also their values. Invalid expressions are
185 // For (possibly parenthesized) identifiers denoting built-in
186 // functions, the recorded signatures are call-site specific:
187 // if the call result is not a constant, the recorded type is
188 // an argument-specific signature. Otherwise, the recorded type
191 // The Types map does not record the type of every identifier,
192 // only those that appear where an arbitrary expression is
193 // permitted. For instance, the identifier f in a selector
194 // expression x.f is found only in the Selections map, the
195 // identifier z in a variable declaration 'var z int' is found
196 // only in the Defs map, and identifiers denoting packages in
197 // qualified identifiers are collected in the Uses map.
198 Types map[ast.Expr]TypeAndValue
200 // Instances maps identifiers denoting generic types or functions to their
201 // type arguments and instantiated type.
203 // For example, Instances will map the identifier for 'T' in the type
204 // instantiation T[int, string] to the type arguments [int, string] and
205 // resulting instantiated *Named type. Given a generic function
206 // func F[A any](A), Instances will map the identifier for 'F' in the call
207 // expression F(int(1)) to the inferred type arguments [int], and resulting
208 // instantiated *Signature.
210 // Invariant: Instantiating Uses[id].Type() with Instances[id].TypeArgs
211 // results in an equivalent of Instances[id].Type.
212 Instances map[*ast.Ident]Instance
214 // Defs maps identifiers to the objects they define (including
215 // package names, dots "." of dot-imports, and blank "_" identifiers).
216 // For identifiers that do not denote objects (e.g., the package name
217 // in package clauses, or symbolic variables t in t := x.(type) of
218 // type switch headers), the corresponding objects are nil.
220 // For an embedded field, Defs returns the field *Var it defines.
222 // Invariant: Defs[id] == nil || Defs[id].Pos() == id.Pos()
223 Defs map[*ast.Ident]Object
225 // Uses maps identifiers to the objects they denote.
227 // For an embedded field, Uses returns the *TypeName it denotes.
229 // Invariant: Uses[id].Pos() != id.Pos()
230 Uses map[*ast.Ident]Object
232 // Implicits maps nodes to their implicitly declared objects, if any.
233 // The following node and object types may appear:
235 // node declared object
237 // *ast.ImportSpec *PkgName for imports without renames
238 // *ast.CaseClause type-specific *Var for each type switch case clause (incl. default)
239 // *ast.Field anonymous parameter *Var (incl. unnamed results)
241 Implicits map[ast.Node]Object
243 // Selections maps selector expressions (excluding qualified identifiers)
244 // to their corresponding selections.
245 Selections map[*ast.SelectorExpr]*Selection
247 // Scopes maps ast.Nodes to the scopes they define. Package scopes are not
248 // associated with a specific node but with all files belonging to a package.
249 // Thus, the package scope can be found in the type-checked Package object.
250 // Scopes nest, with the Universe scope being the outermost scope, enclosing
251 // the package scope, which contains (one or more) files scopes, which enclose
252 // function scopes which in turn enclose statement and function literal scopes.
253 // Note that even though package-level functions are declared in the package
254 // scope, the function scopes are embedded in the file scope of the file
255 // containing the function declaration.
257 // The following node types may appear in Scopes:
265 // *ast.TypeSwitchStmt
271 Scopes map[ast.Node]*Scope
273 // InitOrder is the list of package-level initializers in the order in which
274 // they must be executed. Initializers referring to variables related by an
275 // initialization dependency appear in topological order, the others appear
276 // in source order. Variables without an initialization expression do not
277 // appear in this list.
278 InitOrder []*Initializer
281 // TypeOf returns the type of expression e, or nil if not found.
282 // Precondition: the Types, Uses and Defs maps are populated.
283 func (info *Info) TypeOf(e ast.Expr) Type {
284 if t, ok := info.Types[e]; ok {
287 if id, _ := e.(*ast.Ident); id != nil {
288 if obj := info.ObjectOf(id); obj != nil {
295 // ObjectOf returns the object denoted by the specified id,
296 // or nil if not found.
298 // If id is an embedded struct field, ObjectOf returns the field (*Var)
299 // it defines, not the type (*TypeName) it uses.
301 // Precondition: the Uses and Defs maps are populated.
302 func (info *Info) ObjectOf(id *ast.Ident) Object {
303 if obj := info.Defs[id]; obj != nil {
309 // TypeAndValue reports the type and value (for constants)
310 // of the corresponding expression.
311 type TypeAndValue struct {
317 // IsVoid reports whether the corresponding expression
318 // is a function call without results.
319 func (tv TypeAndValue) IsVoid() bool {
320 return tv.mode == novalue
323 // IsType reports whether the corresponding expression specifies a type.
324 func (tv TypeAndValue) IsType() bool {
325 return tv.mode == typexpr
328 // IsBuiltin reports whether the corresponding expression denotes
329 // a (possibly parenthesized) built-in function.
330 func (tv TypeAndValue) IsBuiltin() bool {
331 return tv.mode == builtin
334 // IsValue reports whether the corresponding expression is a value.
335 // Builtins are not considered values. Constant values have a non-
337 func (tv TypeAndValue) IsValue() bool {
339 case constant_, variable, mapindex, value, commaok, commaerr:
345 // IsNil reports whether the corresponding expression denotes the
346 // predeclared value nil.
347 func (tv TypeAndValue) IsNil() bool {
348 return tv.mode == value && tv.Type == Typ[UntypedNil]
351 // Addressable reports whether the corresponding expression
352 // is addressable (https://golang.org/ref/spec#Address_operators).
353 func (tv TypeAndValue) Addressable() bool {
354 return tv.mode == variable
357 // Assignable reports whether the corresponding expression
358 // is assignable to (provided a value of the right type).
359 func (tv TypeAndValue) Assignable() bool {
360 return tv.mode == variable || tv.mode == mapindex
363 // HasOk reports whether the corresponding expression may be
364 // used on the rhs of a comma-ok assignment.
365 func (tv TypeAndValue) HasOk() bool {
366 return tv.mode == commaok || tv.mode == mapindex
369 // Instance reports the type arguments and instantiated type for type and
370 // function instantiations. For type instantiations, Type will be of dynamic
371 // type *Named. For function instantiations, Type will be of dynamic type
373 type Instance struct {
378 // An Initializer describes a package-level variable, or a list of variables in case
379 // of a multi-valued initialization expression, and the corresponding initialization
381 type Initializer struct {
382 Lhs []*Var // var Lhs = Rhs
386 func (init *Initializer) String() string {
388 for i, lhs := range init.Lhs {
390 buf.WriteString(", ")
392 buf.WriteString(lhs.Name())
394 buf.WriteString(" = ")
395 WriteExpr(&buf, init.Rhs)
399 // Check type-checks a package and returns the resulting package object and
400 // the first error if any. Additionally, if info != nil, Check populates each
401 // of the non-nil maps in the Info struct.
403 // The package is marked as complete if no errors occurred, otherwise it is
404 // incomplete. See Config.Error for controlling behavior in the presence of
407 // The package is specified by a list of *ast.Files and corresponding
408 // file set, and the package path the package is identified with.
409 // The clean path must not be empty or dot (".").
410 func (conf *Config) Check(path string, fset *token.FileSet, files []*ast.File, info *Info) (*Package, error) {
411 pkg := NewPackage(path, "")
412 return pkg, NewChecker(conf, fset, pkg, info).Files(files)
415 // AssertableTo reports whether a value of type V can be asserted to have type T.
417 // The behavior of AssertableTo is undefined in two cases:
418 // - if V is a generalized interface; i.e., an interface that may only be used
419 // as a type constraint in Go code
420 // - if T is an uninstantiated generic type
421 func AssertableTo(V *Interface, T Type) bool {
422 // Checker.newAssertableTo suppresses errors for invalid types, so we need special
424 if T.Underlying() == Typ[Invalid] {
427 return (*Checker)(nil).newAssertableTo(V, T) == nil
430 // AssignableTo reports whether a value of type V is assignable to a variable
433 // The behavior of AssignableTo is undefined if V or T is an uninstantiated
435 func AssignableTo(V, T Type) bool {
436 x := operand{mode: value, typ: V}
437 ok, _ := x.assignableTo(nil, T, nil) // check not needed for non-constant x
441 // ConvertibleTo reports whether a value of type V is convertible to a value of
444 // The behavior of ConvertibleTo is undefined if V or T is an uninstantiated
446 func ConvertibleTo(V, T Type) bool {
447 x := operand{mode: value, typ: V}
448 return x.convertibleTo(nil, T, nil) // check not needed for non-constant x
451 // Implements reports whether type V implements interface T.
453 // The behavior of Implements is undefined if V is an uninstantiated generic
455 func Implements(V Type, T *Interface) bool {
457 // All types (even Typ[Invalid]) implement the empty interface.
460 // Checker.implements suppresses errors for invalid types, so we need special
462 if V.Underlying() == Typ[Invalid] {
465 return (*Checker)(nil).implements(V, T) == nil
468 // Identical reports whether x and y are identical types.
469 // Receivers of Signature types are ignored.
470 func Identical(x, y Type) bool {
471 return identical(x, y, true, nil)
474 // IdenticalIgnoreTags reports whether x and y are identical types if tags are ignored.
475 // Receivers of Signature types are ignored.
476 func IdenticalIgnoreTags(x, y Type) bool {
477 return identical(x, y, false, nil)