src/cmd/compile/internal/types2/object.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 types2
   6
   7 import (
   8         "bytes"
   9         "cmd/compile/internal/syntax"
  10         "fmt"
  11         "go/constant"
  12         "unicode"
  13         "unicode/utf8"
  14 )
  15
  16 // An Object describes a named language entity such as a package,
  17 // constant, type, variable, function (incl. methods), or label.
  18 // All objects implement the Object interface.
  19 //
  20 type Object interface {
  21         Parent() *Scope  // scope in which this object is declared; nil for methods and struct fields
  22         Pos() syntax.Pos // position of object identifier in declaration
  23         Pkg() *Package   // package to which this object belongs; nil for labels and objects in the Universe scope
  24         Name() string    // package local object name
  25         Type() Type      // object type
  26         Exported() bool  // reports whether the name starts with a capital letter
  27         Id() string      // object name if exported, qualified name if not exported (see func Id)
  28
  29         // String returns a human-readable string of the object.
  30         String() string
  31
  32         // order reflects a package-level object's source order: if object
  33         // a is before object b in the source, then a.order() < b.order().
  34         // order returns a value > 0 for package-level objects; it returns
  35         // 0 for all other objects (including objects in file scopes).
  36         order() uint32
  37
  38         // color returns the object's color.
  39         color() color
  40
  41         // setType sets the type of the object.
  42         setType(Type)
  43
  44         // setOrder sets the order number of the object. It must be > 0.
  45         setOrder(uint32)
  46
  47         // setColor sets the object's color. It must not be white.
  48         setColor(color color)
  49
  50         // setParent sets the parent scope of the object.
  51         setParent(*Scope)
  52
  53         // sameId reports whether obj.Id() and Id(pkg, name) are the same.
  54         sameId(pkg *Package, name string) bool
  55
  56         // scopePos returns the start position of the scope of this Object
  57         scopePos() syntax.Pos
  58
  59         // setScopePos sets the start position of the scope for this Object.
  60         setScopePos(pos syntax.Pos)
  61 }
  62
  63 func isExported(name string) bool {
  64         ch, _ := utf8.DecodeRuneInString(name)
  65         return unicode.IsUpper(ch)
  66 }
  67
  68 // Id returns name if it is exported, otherwise it
  69 // returns the name qualified with the package path.
  70 func Id(pkg *Package, name string) string {
  71         if isExported(name) {
  72                 return name
  73         }
  74         // unexported names need the package path for differentiation
  75         // (if there's no package, make sure we don't start with '.'
  76         // as that may change the order of methods between a setup
  77         // inside a package and outside a package - which breaks some
  78         // tests)
  79         path := "_"
  80         // pkg is nil for objects in Universe scope and possibly types
  81         // introduced via Eval (see also comment in object.sameId)
  82         if pkg != nil && pkg.path != "" {
  83                 path = pkg.path
  84         }
  85         return path + "." + name
  86 }
  87
  88 // An object implements the common parts of an Object.
  89 type object struct {
  90         parent    *Scope
  91         pos       syntax.Pos
  92         pkg       *Package
  93         name      string
  94         typ       Type
  95         order_    uint32
  96         color_    color
  97         scopePos_ syntax.Pos
  98 }
  99
 100 // color encodes the color of an object (see Checker.objDecl for details).
 101 type color uint32
 102
 103 // An object may be painted in one of three colors.
 104 // Color values other than white or black are considered grey.
 105 const (
 106         white color = iota
 107         black
 108         grey // must be > white and black
 109 )
 110
 111 func (c color) String() string {
 112         switch c {
 113         case white:
 114                 return "white"
 115         case black:
 116                 return "black"
 117         default:
 118                 return "grey"
 119         }
 120 }
 121
 122 // colorFor returns the (initial) color for an object depending on
 123 // whether its type t is known or not.
 124 func colorFor(t Type) color {
 125         if t != nil {
 126                 return black
 127         }
 128         return white
 129 }
 130
 131 // Parent returns the scope in which the object is declared.
 132 // The result is nil for methods and struct fields.
 133 func (obj *object) Parent() *Scope { return obj.parent }
 134
 135 // Pos returns the declaration position of the object's identifier.
 136 func (obj *object) Pos() syntax.Pos { return obj.pos }
 137
 138 // Pkg returns the package to which the object belongs.
 139 // The result is nil for labels and objects in the Universe scope.
 140 func (obj *object) Pkg() *Package { return obj.pkg }
 141
 142 // Name returns the object's (package-local, unqualified) name.
 143 func (obj *object) Name() string { return obj.name }
 144
 145 // Type returns the object's type.
 146 func (obj *object) Type() Type { return obj.typ }
 147
 148 // Exported reports whether the object is exported (starts with a capital letter).
 149 // It doesn't take into account whether the object is in a local (function) scope
 150 // or not.
 151 func (obj *object) Exported() bool { return isExported(obj.name) }
 152
 153 // Id is a wrapper for Id(obj.Pkg(), obj.Name()).
 154 func (obj *object) Id() string { return Id(obj.pkg, obj.name) }
 155
 156 func (obj *object) String() string       { panic("abstract") }
 157 func (obj *object) order() uint32        { return obj.order_ }
 158 func (obj *object) color() color         { return obj.color_ }
 159 func (obj *object) scopePos() syntax.Pos { return obj.scopePos_ }
 160
 161 func (obj *object) setParent(parent *Scope)    { obj.parent = parent }
 162 func (obj *object) setType(typ Type)           { obj.typ = typ }
 163 func (obj *object) setOrder(order uint32)      { assert(order > 0); obj.order_ = order }
 164 func (obj *object) setColor(color color)       { assert(color != white); obj.color_ = color }
 165 func (obj *object) setScopePos(pos syntax.Pos) { obj.scopePos_ = pos }
 166
 167 func (obj *object) sameId(pkg *Package, name string) bool {
 168         // spec:
 169         // "Two identifiers are different if they are spelled differently,
 170         // or if they appear in different packages and are not exported.
 171         // Otherwise, they are the same."
 172         if name != obj.name {
 173                 return false
 174         }
 175         // obj.Name == name
 176         if obj.Exported() {
 177                 return true
 178         }
 179         // not exported, so packages must be the same (pkg == nil for
 180         // fields in Universe scope; this can only happen for types
 181         // introduced via Eval)
 182         if pkg == nil || obj.pkg == nil {
 183                 return pkg == obj.pkg
 184         }
 185         // pkg != nil && obj.pkg != nil
 186         return pkg.path == obj.pkg.path
 187 }
 188
 189 // less reports whether object a is ordered before object b.
 190 //
 191 // Objects are ordered nil before non-nil, exported before
 192 // non-exported, then by name, and finally (for non-exported
 193 // functions) by package height and path.
 194 func (a *object) less(b *object) bool {
 195         if a == b {
 196                 return false
 197         }
 198
 199         // Nil before non-nil.
 200         if a == nil {
 201                 return true
 202         }
 203         if b == nil {
 204                 return false
 205         }
 206
 207         // Exported functions before non-exported.
 208         ea := isExported(a.name)
 209         eb := isExported(b.name)
 210         if ea != eb {
 211                 return ea
 212         }
 213
 214         // Order by name and then (for non-exported names) by package.
 215         if a.name != b.name {
 216                 return a.name < b.name
 217         }
 218         if !ea {
 219                 if a.pkg.height != b.pkg.height {
 220                         return a.pkg.height < b.pkg.height
 221                 }
 222                 return a.pkg.path < b.pkg.path
 223         }
 224
 225         return false
 226 }
 227
 228 // A PkgName represents an imported Go package.
 229 // PkgNames don't have a type.
 230 type PkgName struct {
 231         object
 232         imported *Package
 233         used     bool // set if the package was used
 234 }
 235
 236 // NewPkgName returns a new PkgName object representing an imported package.
 237 // The remaining arguments set the attributes found with all Objects.
 238 func NewPkgName(pos syntax.Pos, pkg *Package, name string, imported *Package) *PkgName {
 239         return &PkgName{object{nil, pos, pkg, name, Typ[Invalid], 0, black, nopos}, imported, false}
 240 }
 241
 242 // Imported returns the package that was imported.
 243 // It is distinct from Pkg(), which is the package containing the import statement.
 244 func (obj *PkgName) Imported() *Package { return obj.imported }
 245
 246 // A Const represents a declared constant.
 247 type Const struct {
 248         object
 249         val constant.Value
 250 }
 251
 252 // NewConst returns a new constant with value val.
 253 // The remaining arguments set the attributes found with all Objects.
 254 func NewConst(pos syntax.Pos, pkg *Package, name string, typ Type, val constant.Value) *Const {
 255         return &Const{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, val}
 256 }
 257
 258 // Val returns the constant's value.
 259 func (obj *Const) Val() constant.Value { return obj.val }
 260
 261 func (*Const) isDependency() {} // a constant may be a dependency of an initialization expression
 262
 263 // A TypeName represents a name for a (defined or alias) type.
 264 type TypeName struct {
 265         object
 266 }
 267
 268 // NewTypeName returns a new type name denoting the given typ.
 269 // The remaining arguments set the attributes found with all Objects.
 270 //
 271 // The typ argument may be a defined (Named) type or an alias type.
 272 // It may also be nil such that the returned TypeName can be used as
 273 // argument for NewNamed, which will set the TypeName's type as a side-
 274 // effect.
 275 func NewTypeName(pos syntax.Pos, pkg *Package, name string, typ Type) *TypeName {
 276         return &TypeName{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}}
 277 }
 278
 279 // NewTypeNameLazy returns a new defined type like NewTypeName, but it
 280 // lazily calls resolve to finish constructing the Named object.
 281 func NewTypeNameLazy(pos syntax.Pos, pkg *Package, name string, resolve func(named *Named) (tparams []*TypeName, underlying Type, methods []*Func)) *TypeName {
 282         obj := NewTypeName(pos, pkg, name, nil)
 283         NewNamed(obj, nil, nil).resolve = resolve
 284         return obj
 285 }
 286
 287 // IsAlias reports whether obj is an alias name for a type.
 288 func (obj *TypeName) IsAlias() bool {
 289         switch t := obj.typ.(type) {
 290         case nil:
 291                 return false
 292         case *Basic:
 293                 // unsafe.Pointer is not an alias.
 294                 if obj.pkg == Unsafe {
 295                         return false
 296                 }
 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
 304         case *Named:
 305                 return obj != t.obj
 306         default:
 307                 return true
 308         }
 309 }
 310
 311 // A Variable represents a declared variable (including function parameters and results, and struct fields).
 312 type Var struct {
 313         object
 314         embedded bool // if set, the variable is an embedded struct field, and name is the type name
 315         isField  bool // var is struct field
 316         used     bool // set if the variable was used
 317 }
 318
 319 // NewVar returns a new variable.
 320 // The arguments set the attributes found with all Objects.
 321 func NewVar(pos syntax.Pos, pkg *Package, name string, typ Type) *Var {
 322         return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}}
 323 }
 324
 325 // NewParam returns a new variable representing a function parameter.
 326 func NewParam(pos syntax.Pos, pkg *Package, name string, typ Type) *Var {
 327         return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, used: true} // parameters are always 'used'
 328 }
 329
 330 // NewField returns a new variable representing a struct field.
 331 // For embedded fields, the name is the unqualified type name
 332 /// under which the field is accessible.
 333 func NewField(pos syntax.Pos, pkg *Package, name string, typ Type, embedded bool) *Var {
 334         return &Var{object: object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, embedded: embedded, isField: true}
 335 }
 336
 337 // Anonymous reports whether the variable is an embedded field.
 338 // Same as Embedded; only present for backward-compatibility.
 339 func (obj *Var) Anonymous() bool { return obj.embedded }
 340
 341 // Embedded reports whether the variable is an embedded field.
 342 func (obj *Var) Embedded() bool { return obj.embedded }
 343
 344 // IsField reports whether the variable is a struct field.
 345 func (obj *Var) IsField() bool { return obj.isField }
 346
 347 func (*Var) isDependency() {} // a variable may be a dependency of an initialization expression
 348
 349 // A Func represents a declared function, concrete method, or abstract
 350 // (interface) method. Its Type() is always a *Signature.
 351 // An abstract method may belong to many interfaces due to embedding.
 352 type Func struct {
 353         object
 354         hasPtrRecv bool // only valid for methods that don't have a type yet
 355 }
 356
 357 // NewFunc returns a new function with the given signature, representing
 358 // the function's type.
 359 func NewFunc(pos syntax.Pos, pkg *Package, name string, sig *Signature) *Func {
 360         // don't store a (typed) nil signature
 361         var typ Type
 362         if sig != nil {
 363                 typ = sig
 364         }
 365         return &Func{object{nil, pos, pkg, name, typ, 0, colorFor(typ), nopos}, false}
 366 }
 367
 368 // FullName returns the package- or receiver-type-qualified name of
 369 // function or method obj.
 370 func (obj *Func) FullName() string {
 371         var buf bytes.Buffer
 372         writeFuncName(&buf, obj, nil)
 373         return buf.String()
 374 }
 375
 376 // Scope returns the scope of the function's body block.
 377 func (obj *Func) Scope() *Scope { return obj.typ.(*Signature).scope }
 378
 379 func (*Func) isDependency() {} // a function may be a dependency of an initialization expression
 380
 381 // A Label represents a declared label.
 382 // Labels don't have a type.
 383 type Label struct {
 384         object
 385         used bool // set if the label was used
 386 }
 387
 388 // NewLabel returns a new label.
 389 func NewLabel(pos syntax.Pos, pkg *Package, name string) *Label {
 390         return &Label{object{pos: pos, pkg: pkg, name: name, typ: Typ[Invalid], color_: black}, false}
 391 }
 392
 393 // A Builtin represents a built-in function.
 394 // Builtins don't have a valid type.
 395 type Builtin struct {
 396         object
 397         id builtinId
 398 }
 399
 400 func newBuiltin(id builtinId) *Builtin {
 401         return &Builtin{object{name: predeclaredFuncs[id].name, typ: Typ[Invalid], color_: black}, id}
 402 }
 403
 404 // Nil represents the predeclared value nil.
 405 type Nil struct {
 406         object
 407 }
 408
 409 func writeObject(buf *bytes.Buffer, obj Object, qf Qualifier) {
 410         var tname *TypeName
 411         typ := obj.Type()
 412
 413         switch obj := obj.(type) {
 414         case *PkgName:
 415                 fmt.Fprintf(buf, "package %s", obj.Name())
 416                 if path := obj.imported.path; path != "" && path != obj.name {
 417                         fmt.Fprintf(buf, " (%q)", path)
 418                 }
 419                 return
 420
 421         case *Const:
 422                 buf.WriteString("const")
 423
 424         case *TypeName:
 425                 tname = obj
 426                 buf.WriteString("type")
 427
 428         case *Var:
 429                 if obj.isField {
 430                         buf.WriteString("field")
 431                 } else {
 432                         buf.WriteString("var")
 433                 }
 434
 435         case *Func:
 436                 buf.WriteString("func ")
 437                 writeFuncName(buf, obj, qf)
 438                 if typ != nil {
 439                         WriteSignature(buf, typ.(*Signature), qf)
 440                 }
 441                 return
 442
 443         case *Label:
 444                 buf.WriteString("label")
 445                 typ = nil
 446
 447         case *Builtin:
 448                 buf.WriteString("builtin")
 449                 typ = nil
 450
 451         case *Nil:
 452                 buf.WriteString("nil")
 453                 return
 454
 455         default:
 456                 panic(fmt.Sprintf("writeObject(%T)", obj))
 457         }
 458
 459         buf.WriteByte(' ')
 460
 461         // For package-level objects, qualify the name.
 462         if obj.Pkg() != nil && obj.Pkg().scope.Lookup(obj.Name()) == obj {
 463                 writePackage(buf, obj.Pkg(), qf)
 464         }
 465         buf.WriteString(obj.Name())
 466
 467         if typ == nil {
 468                 return
 469         }
 470
 471         if tname != nil {
 472                 // We have a type object: Don't print anything more for
 473                 // basic types since there's no more information (names
 474                 // are the same; see also comment in TypeName.IsAlias).
 475                 if _, ok := typ.(*Basic); ok {
 476                         return
 477                 }
 478                 if tname.IsAlias() {
 479                         buf.WriteString(" =")
 480                 } else {
 481                         typ = under(typ)
 482                 }
 483         }
 484
 485         buf.WriteByte(' ')
 486         WriteType(buf, typ, qf)
 487 }
 488
 489 func writePackage(buf *bytes.Buffer, pkg *Package, qf Qualifier) {
 490         if pkg == nil {
 491                 return
 492         }
 493         var s string
 494         if qf != nil {
 495                 s = qf(pkg)
 496         } else {
 497                 s = pkg.Path()
 498         }
 499         if s != "" {
 500                 buf.WriteString(s)
 501                 buf.WriteByte('.')
 502         }
 503 }
 504
 505 // ObjectString returns the string form of obj.
 506 // The Qualifier controls the printing of
 507 // package-level objects, and may be nil.
 508 func ObjectString(obj Object, qf Qualifier) string {
 509         var buf bytes.Buffer
 510         writeObject(&buf, obj, qf)
 511         return buf.String()
 512 }
 513
 514 func (obj *PkgName) String() string  { return ObjectString(obj, nil) }
 515 func (obj *Const) String() string    { return ObjectString(obj, nil) }
 516 func (obj *TypeName) String() string { return ObjectString(obj, nil) }
 517 func (obj *Var) String() string      { return ObjectString(obj, nil) }
 518 func (obj *Func) String() string     { return ObjectString(obj, nil) }
 519 func (obj *Label) String() string    { return ObjectString(obj, nil) }
 520 func (obj *Builtin) String() string  { return ObjectString(obj, nil) }
 521 func (obj *Nil) String() string      { return ObjectString(obj, nil) }
 522
 523 func writeFuncName(buf *bytes.Buffer, f *Func, qf Qualifier) {
 524         if f.typ != nil {
 525                 sig := f.typ.(*Signature)
 526                 if recv := sig.Recv(); recv != nil {
 527                         buf.WriteByte('(')
 528                         if _, ok := recv.Type().(*Interface); ok {
 529                                 // gcimporter creates abstract methods of
 530                                 // named interfaces using the interface type
 531                                 // (not the named type) as the receiver.
 532                                 // Don't print it in full.
 533                                 buf.WriteString("interface")
 534                         } else {
 535                                 WriteType(buf, recv.Type(), qf)
 536                         }
 537                         buf.WriteByte(')')
 538                         buf.WriteByte('.')
 539                 } else if f.pkg != nil {
 540                         writePackage(buf, f.pkg, qf)
 541                 }
 542         }
 543         buf.WriteString(f.name)
 544 }