types

Documentation

Overview

Types infers source locations and types from Go expressions. and allows enumeration of the type's method or field members.

Index

• Variables
• func DeclPos(obj *ast.Object) token.Pos
• type Importer
  • func NewImporter(srcDir string) Importer
• type MultiValue
  • func (MultiValue) End() token.Pos
  • func (MultiValue) Pos() token.Pos
• type Type
  • func ExprType(e ast.Expr, importer Importer) (obj *ast.Object, typ Type)
  • func (t Type) Iter(importer Importer) <-chan *ast.Object
  • func (t Type) Member(name string, importer Importer) *ast.Object
  • func (t Type) String() string
  • func (typ Type) Underlying(all bool, importer Importer) Type

Variables

var Debug = false

When Debug is true, log messages will be printed.

var DefaultImporter = NewImporter("")

var FileSet = token.NewFileSet()

When _any_ Importer is called, it adds any files to FileSet.

var GoPath = []string{filepath.Join(os.Getenv("GOROOT"), "src", "pkg")}

GoPath is used by DefaultImporter to find packages.

var Panic = true

Functions

func DeclPos

func DeclPos(obj *ast.Object) token.Pos

DeclPos computes the source position of the declaration of an object name. The result may be an invalid position if it cannot be computed (obj.Decl may be nil or not correct). This should be called ast.Object.Pos.

Types

type Importer

type Importer func(path string) *ast.Package

func NewImporter

func NewImporter(srcDir string) Importer

The Importer looks for the package; if it finds it, it parses and returns it. If no package was found, it returns nil.

type MultiValue

type MultiValue struct {
	Types []ast.Expr
}

MultiValue represents a multiple valued Go expression - the result of a function that returns more than one value.

func (MultiValue) End

func (MultiValue) End() token.Pos

func (MultiValue) Pos

func (MultiValue) Pos() token.Pos

type Type

type Type struct {
	// Parse-tree representation of the expression's type.
	Node ast.Node

	// The kind of the expression.
	Kind ast.ObjKind

	// The path of the package that the type is relative to.
	Pkg string
}

Type represents the type of a Go expression. It can represent a Go package and a Go type as well as the usual expression types.

func ExprType

func ExprType(e ast.Expr, importer Importer) (obj *ast.Object, typ Type)

ExprType returns the type for the given expression, and the object that represents it, if there is one. All variables, methods, top level functions, packages, struct and interface members, and types have objects. The returned object can be used with DeclPos to find out the source location of the definition of the object.

func (Type) Iter

func (t Type) Iter(importer Importer) <-chan *ast.Object

Iter returns a channel, sends on it all the members of the type, then closes it. Members at a shallower depth will be sent first.

func (Type) Member

func (t Type) Member(name string, importer Importer) *ast.Object

Member looks for a member with the given name inside the type. For packages, the member can be any exported top level declaration inside the package.

func (Type) String

func (t Type) String() string

String is for debugging purposes.

func (Type) Underlying

func (typ Type) Underlying(all bool, importer Importer) Type

If typ represents a named type, Underlying returns the type that it was defined as. If all is true, it repeats this process until the type is not a named type.