github.com/miolini/go@v0.0.0-20160405192216-fca68c8cb408/src/go/types/package.go (about)

     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
     6  
     7  import (
     8  	"fmt"
     9  	"go/token"
    10  )
    11  
    12  // A Package describes a Go package.
    13  type Package struct {
    14  	path     string
    15  	name     string
    16  	scope    *Scope
    17  	complete bool
    18  	imports  []*Package
    19  	fake     bool // scope lookup errors are silently dropped if package is fake (internal use only)
    20  }
    21  
    22  // NewPackage returns a new Package for the given package path and name;
    23  // the name must not be the blank identifier.
    24  // The package is not complete and contains no explicit imports.
    25  func NewPackage(path, name string) *Package {
    26  	if name == "_" {
    27  		panic("invalid package name _")
    28  	}
    29  	scope := NewScope(Universe, token.NoPos, token.NoPos, fmt.Sprintf("package %q", path))
    30  	return &Package{path: path, name: name, scope: scope}
    31  }
    32  
    33  // Path returns the package path.
    34  func (pkg *Package) Path() string { return pkg.path }
    35  
    36  // Name returns the package name.
    37  func (pkg *Package) Name() string { return pkg.name }
    38  
    39  // SetName sets the package name.
    40  func (pkg *Package) SetName(name string) { pkg.name = name }
    41  
    42  // Scope returns the (complete or incomplete) package scope
    43  // holding the objects declared at package level (TypeNames,
    44  // Consts, Vars, and Funcs).
    45  func (pkg *Package) Scope() *Scope { return pkg.scope }
    46  
    47  // A package is complete if its scope contains (at least) all
    48  // exported objects; otherwise it is incomplete.
    49  func (pkg *Package) Complete() bool { return pkg.complete }
    50  
    51  // MarkComplete marks a package as complete.
    52  func (pkg *Package) MarkComplete() { pkg.complete = true }
    53  
    54  // Imports returns the list of packages directly imported by
    55  // pkg; the list is in source order. Package unsafe is excluded.
    56  //
    57  // If pkg was loaded from export data, Imports includes packages that
    58  // provide package-level objects referenced by pkg. This may be more or
    59  // less than the set of packages directly imported by pkg's source code.
    60  func (pkg *Package) Imports() []*Package { return pkg.imports }
    61  
    62  // SetImports sets the list of explicitly imported packages to list.
    63  // It is the caller's responsibility to make sure list elements are unique.
    64  func (pkg *Package) SetImports(list []*Package) { pkg.imports = list }
    65  
    66  func (pkg *Package) String() string {
    67  	return fmt.Sprintf("package %s (%q)", pkg.name, pkg.path)
    68  }