1 // Code generated by "go test -run=Generate -write=all"; DO NOT EDIT.
3 // Copyright 2013 The Go Authors. All rights reserved.
4 // Use of this source code is governed by a BSD-style
5 // license that can be found in the LICENSE file.
18 // An Object describes a named language entity such as a package,
19 // constant, type, variable, function (incl. methods), or label.
20 // All objects implement the Object interface.
21 type Object interface {
22 Parent() *Scope // scope in which this object is declared; nil for methods and struct fields
23 Pos() token.Pos // position of object identifier in declaration
24 Pkg() *Package // package to which this object belongs; nil for labels and objects in the Universe scope
25 Name() string // package local object name
26 Type() Type // object type
27 Exported() bool // reports whether the name starts with a capital letter
28 Id() string // object name if exported, qualified name if not exported (see func Id)
30 // String returns a human-readable string of the object.
33 // order reflects a package-level object's source order: if object
34 // a is before object b in the source, then a.order() < b.order().
35 // order returns a value > 0 for package-level objects; it returns
36 // 0 for all other objects (including objects in file scopes).
39 // color returns the object's color.
42 // setType sets the type of the object.
45 // setOrder sets the order number of the object. It must be > 0.
48 // setColor sets the object's color. It must not be white.
51 // setParent sets the parent scope of the object.
54 // sameId reports whether obj.Id() and Id(pkg, name) are the same.
55 sameId(pkg *Package, name string) bool
57 // scopePos returns the start position of the scope of this Object
60 // setScopePos sets the start position of the scope for this Object.
61 setScopePos(pos token.Pos)
64 func isExported(name string) bool {
65 ch, _ := utf8.DecodeRuneInString(name)
66 return unicode.IsUpper(ch)
69 // Id returns name if it is exported, otherwise it
70 // returns the name qualified with the package path.
71 func Id(pkg *Package, name string) string {
75 // unexported names need the package path for differentiation
76 // (if there's no package, make sure we don't start with '.'
77 // as that may change the order of methods between a setup
78 // inside a package and outside a package - which breaks some
81 // pkg is nil for objects in Universe scope and possibly types
82 // introduced via Eval (see also comment in object.sameId)
83 if pkg != nil && pkg.path != "" {
86 return path + "." + name
89 // An object implements the common parts of an Object.
101 // color encodes the color of an object (see Checker.objDecl for details).
104 // An object may be painted in one of three colors.
105 // Color values other than white or black are considered grey.
109 grey // must be > white and black
112 func (c color) String() string {
123 // colorFor returns the (initial) color for an object depending on
124 // whether its type t is known or not.
125 func colorFor(t Type) color {
132 // Parent returns the scope in which the object is declared.
133 // The result is nil for methods and struct fields.
134 func (obj *object) Parent() *Scope { return obj.parent }
136 // Pos returns the declaration position of the object's identifier.
137 func (obj *object) Pos() token.Pos { return obj.pos }
139 // Pkg returns the package to which the object belongs.
140 // The result is nil for labels and objects in the Universe scope.
141 func (obj *object) Pkg() *Package { return obj.pkg }
143 // Name returns the object's (package-local, unqualified) name.
144 func (obj *object) Name() string { return obj.name }
146 // Type returns the object's type.
147 func (obj *object) Type() Type { return obj.typ }
149 // Exported reports whether the object is exported (starts with a capital letter).
150 // It doesn't take into account whether the object is in a local (function) scope
152 func (obj *object) Exported() bool { return isExported(obj.name) }
154 // Id is a wrapper for Id(obj.Pkg(), obj.Name()).
155 func (obj *object) Id() string { return Id(obj.pkg, obj.name) }
157 func (obj *object) String() string { panic("abstract") }
158 func (obj *object) order() uint32 { return obj.order_ }
159 func (obj *object) color() color { return obj.color_ }
160 func (obj *object) scopePos() token.Pos { return obj.scopePos_ }
162 func (obj *object) setParent(parent *Scope) { obj.parent = parent }
163 func (obj *object) setType(typ Type) { obj.typ = typ }
164 func (obj *object) setOrder(order uint32) { assert(order > 0); obj.order_ = order }
165 func (obj *object) setColor(color color) { assert(color != white); obj.color_ = color }
166 func (obj *object) setScopePos(pos token.Pos) { obj.scopePos_ = pos }
168 func (obj *object) sameId(pkg *Package, name string) bool {
170 // "Two identifiers are different if they are spelled differently,
171 // or if they appear in different packages and are not exported.
172 // Otherwise, they are the same."
173 if name != obj.name {
180 // not exported, so packages must be the same (pkg == nil for
181 // fields in Universe scope; this can only happen for types
182 // introduced via Eval)
183 if pkg == nil || obj.pkg == nil {
184 return pkg == obj.pkg
186 // pkg != nil && obj.pkg != nil
187 return pkg.path == obj.pkg.path
190 // less reports whether object a is ordered before object b.
192 // Objects are ordered nil before non-nil, exported before
193 // non-exported, then by name, and finally (for non-exported
194 // functions) by package path.
195 func (a *object) less(b *object) bool {
200 // Nil before non-nil.
208 // Exported functions before non-exported.
209 ea := isExported(a.name)
210 eb := isExported(b.name)
215 // Order by name and then (for non-exported names) by package.
216 if a.name != b.name {
217 return a.name < b.name
220 return a.pkg.path < b.pkg.path
226 // A PkgName represents an imported Go package.
227 // PkgNames don't have a type.
228 type PkgName struct {
231 used bool // set if the package was used
234 // NewPkgName returns a new PkgName object representing an imported package.
235 // The remaining arguments set the attributes found with all Objects.
236 func NewPkgName(pos token.Pos, pkg *Package, name string, imported *Package) *PkgName {
237 return &PkgName{object{nil, pos, pkg, name, Typ[Invalid], 0, black, nopos}, imported, false}
240 // Imported returns the package that was imported.
241 // It is distinct from Pkg(), which is the package containing the import statement.
242 func (obj *PkgName) Imported() *Package { return obj.imported }
244 // A Const represents a declared constant.
250 // NewConst returns a new constant with value val.
251 // The remaining arguments set the attributes found with all Objects.
252 func NewConst(pos token.Pos, pkg *Package, name string, typ Type, val constant.Value) *Const {
253 return &Const{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, val}
256 // Val returns the constant's value.
257 func (obj *Const) Val() constant.Value { return obj.val }
259 func (*Const) isDependency() {} // a constant may be a dependency of an initialization expression
261 // A TypeName represents a name for a (defined or alias) type.
262 type TypeName struct {
266 // NewTypeName returns a new type name denoting the given typ.
267 // The remaining arguments set the attributes found with all Objects.
269 // The typ argument may be a defined (Named) type or an alias type.
270 // It may also be nil such that the returned TypeName can be used as
271 // argument for NewNamed, which will set the TypeName's type as a side-
273 func NewTypeName(pos token.Pos, pkg *Package, name string, typ Type) *TypeName {
274 return &TypeName{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}}
277 // NewTypeNameLazy returns a new defined type like NewTypeName, but it
278 // lazily calls resolve to finish constructing the Named object.
279 func _NewTypeNameLazy(pos token.Pos, pkg *Package, name string, load func(named *Named) (tparams []*TypeParam, underlying Type, methods []*Func)) *TypeName {
280 obj := NewTypeName(pos, pkg, name, nil)
281 NewNamed(obj, nil, nil).loader = load
285 // IsAlias reports whether obj is an alias name for a type.
286 func (obj *TypeName) IsAlias() bool {
287 switch t := obj.typ.(type) {
291 // handled by default case
293 // unsafe.Pointer is not an alias.
294 if obj.pkg == Unsafe {
297 // Any user-defined type name for a basic type is an alias for a
298 // basic type (because basic types are pre-declared in the Universe
299 // scope, outside any package scope), and so is any type name with
300 // a different name than the name of the basic type it refers to.
301 // Additionally, we need to look for "byte" and "rune" because they
302 // are aliases but have the same names (for better error messages).
303 return obj.pkg != nil || t.name != obj.name || t == universeByte || t == universeRune
313 // A Variable represents a declared variable (including function parameters and results, and struct fields).
316 embedded bool // if set, the variable is an embedded struct field, and name is the type name
317 isField bool // var is struct field
318 used bool // set if the variable was used
319 origin *Var // if non-nil, the Var from which this one was instantiated
322 // NewVar returns a new variable.
323 // The arguments set the attributes found with all Objects.
324 func NewVar(pos token.Pos, pkg *Package, name string, typ Type) *Var {
325 return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}}
328 // NewParam returns a new variable representing a function parameter.
329 func NewParam(pos token.Pos, pkg *Package, name string, typ Type) *Var {
330 return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, used: true} // parameters are always 'used'
333 // NewField returns a new variable representing a struct field.
334 // For embedded fields, the name is the unqualified type name
335 // under which the field is accessible.
336 func NewField(pos token.Pos, pkg *Package, name string, typ Type, embedded bool) *Var {
337 return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, embedded: embedded, isField: true}
340 // Anonymous reports whether the variable is an embedded field.
341 // Same as Embedded; only present for backward-compatibility.
342 func (obj *Var) Anonymous() bool { return obj.embedded }
344 // Embedded reports whether the variable is an embedded field.
345 func (obj *Var) Embedded() bool { return obj.embedded }
347 // IsField reports whether the variable is a struct field.
348 func (obj *Var) IsField() bool { return obj.isField }
350 // Origin returns the canonical Var for its receiver, i.e. the Var object
351 // recorded in Info.Defs.
353 // For synthetic Vars created during instantiation (such as struct fields or
354 // function parameters that depend on type arguments), this will be the
355 // corresponding Var on the generic (uninstantiated) type. For all other Vars
356 // Origin returns the receiver.
357 func (obj *Var) Origin() *Var {
358 if obj.origin != nil {
364 func (*Var) isDependency() {} // a variable may be a dependency of an initialization expression
366 // A Func represents a declared function, concrete method, or abstract
367 // (interface) method. Its Type() is always a *Signature.
368 // An abstract method may belong to many interfaces due to embedding.
371 hasPtrRecv_ bool // only valid for methods that don't have a type yet; use hasPtrRecv() to read
372 origin *Func // if non-nil, the Func from which this one was instantiated
375 // NewFunc returns a new function with the given signature, representing
376 // the function's type.
377 func NewFunc(pos token.Pos, pkg *Package, name string, sig *Signature) *Func {
378 // don't store a (typed) nil signature
383 return &Func{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, false, nil}
386 // FullName returns the package- or receiver-type-qualified name of
387 // function or method obj.
388 func (obj *Func) FullName() string {
390 writeFuncName(&buf, obj, nil)
394 // Scope returns the scope of the function's body block.
395 // The result is nil for imported or instantiated functions and methods
396 // (but there is also no mechanism to get to an instantiated function).
397 func (obj *Func) Scope() *Scope { return obj.typ.(*Signature).scope }
399 // Origin returns the canonical Func for its receiver, i.e. the Func object
400 // recorded in Info.Defs.
402 // For synthetic functions created during instantiation (such as methods on an
403 // instantiated Named type or interface methods that depend on type arguments),
404 // this will be the corresponding Func on the generic (uninstantiated) type.
405 // For all other Funcs Origin returns the receiver.
406 func (obj *Func) Origin() *Func {
407 if obj.origin != nil {
413 // Pkg returns the package to which the function belongs.
415 // The result is nil for methods of types in the Universe scope,
416 // like method Error of the error built-in interface type.
417 func (obj *Func) Pkg() *Package { return obj.object.Pkg() }
419 // hasPtrRecv reports whether the receiver is of the form *T for the given method obj.
420 func (obj *Func) hasPtrRecv() bool {
421 // If a method's receiver type is set, use that as the source of truth for the receiver.
422 // Caution: Checker.funcDecl (decl.go) marks a function by setting its type to an empty
423 // signature. We may reach here before the signature is fully set up: we must explicitly
424 // check if the receiver is set (we cannot just look for non-nil obj.typ).
425 if sig, _ := obj.typ.(*Signature); sig != nil && sig.recv != nil {
426 _, isPtr := deref(sig.recv.typ)
430 // If a method's type is not set it may be a method/function that is:
431 // 1) client-supplied (via NewFunc with no signature), or
432 // 2) internally created but not yet type-checked.
433 // For case 1) we can't do anything; the client must know what they are doing.
434 // For case 2) we can use the information gathered by the resolver.
435 return obj.hasPtrRecv_
438 func (*Func) isDependency() {} // a function may be a dependency of an initialization expression
440 // A Label represents a declared label.
441 // Labels don't have a type.
444 used bool // set if the label was used
447 // NewLabel returns a new label.
448 func NewLabel(pos token.Pos, pkg *Package, name string) *Label {
449 return &Label{object{pos: pos, pkg: pkg, name: name, typ: Typ[Invalid], color_: black}, false}
452 // A Builtin represents a built-in function.
453 // Builtins don't have a valid type.
454 type Builtin struct {
459 func newBuiltin(id builtinId) *Builtin {
460 return &Builtin{object{name: predeclaredFuncs[id].name, typ: Typ[Invalid], color_: black}, id}
463 // Nil represents the predeclared value nil.
468 func writeObject(buf *bytes.Buffer, obj Object, qf Qualifier) {
472 switch obj := obj.(type) {
474 fmt.Fprintf(buf, "package %s", obj.Name())
475 if path := obj.imported.path; path != "" && path != obj.name {
476 fmt.Fprintf(buf, " (%q)", path)
481 buf.WriteString("const")
485 buf.WriteString("type")
486 if isTypeParam(typ) {
487 buf.WriteString(" parameter")
492 buf.WriteString("field")
494 buf.WriteString("var")
498 buf.WriteString("func ")
499 writeFuncName(buf, obj, qf)
501 WriteSignature(buf, typ.(*Signature), qf)
506 buf.WriteString("label")
510 buf.WriteString("builtin")
514 buf.WriteString("nil")
518 panic(fmt.Sprintf("writeObject(%T)", obj))
523 // For package-level objects, qualify the name.
524 if obj.Pkg() != nil && obj.Pkg().scope.Lookup(obj.Name()) == obj {
525 buf.WriteString(packagePrefix(obj.Pkg(), qf))
527 buf.WriteString(obj.Name())
534 switch t := typ.(type) {
536 // Don't print anything more for basic types since there's
537 // no more information.
540 if t.TypeParams().Len() > 0 {
541 newTypeWriter(buf, qf).tParamList(t.TypeParams().list())
545 buf.WriteString(" =")
546 } else if t, _ := typ.(*TypeParam); t != nil {
549 // TODO(gri) should this be fromRHS for *Named?
554 // Special handling for any: because WriteType will format 'any' as 'any',
555 // resulting in the object string `type any = any` rather than `type any =
556 // interface{}`. To avoid this, swap in a different empty interface.
557 if obj == universeAny {
558 assert(Identical(typ, &emptyInterface))
559 typ = &emptyInterface
563 WriteType(buf, typ, qf)
566 func packagePrefix(pkg *Package, qf Qualifier) string {
582 // ObjectString returns the string form of obj.
583 // The Qualifier controls the printing of
584 // package-level objects, and may be nil.
585 func ObjectString(obj Object, qf Qualifier) string {
587 writeObject(&buf, obj, qf)
591 func (obj *PkgName) String() string { return ObjectString(obj, nil) }
592 func (obj *Const) String() string { return ObjectString(obj, nil) }
593 func (obj *TypeName) String() string { return ObjectString(obj, nil) }
594 func (obj *Var) String() string { return ObjectString(obj, nil) }
595 func (obj *Func) String() string { return ObjectString(obj, nil) }
596 func (obj *Label) String() string { return ObjectString(obj, nil) }
597 func (obj *Builtin) String() string { return ObjectString(obj, nil) }
598 func (obj *Nil) String() string { return ObjectString(obj, nil) }
600 func writeFuncName(buf *bytes.Buffer, f *Func, qf Qualifier) {
602 sig := f.typ.(*Signature)
603 if recv := sig.Recv(); recv != nil {
605 if _, ok := recv.Type().(*Interface); ok {
606 // gcimporter creates abstract methods of
607 // named interfaces using the interface type
608 // (not the named type) as the receiver.
609 // Don't print it in full.
610 buf.WriteString("interface")
612 WriteType(buf, recv.Type(), qf)
616 } else if f.pkg != nil {
617 buf.WriteString(packagePrefix(f.pkg, qf))
620 buf.WriteString(f.name)