generator

Documentation

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type ArgDef
• type FunctionDef
  • func (f *FunctionDef) BuildGodoc() ([]string, error)
  • func (f *FunctionDef) ReceiverString() string
  • func (f *FunctionDef) ReturnString() string
• type Generator
  • func (g *Generator) BuildDocs() bytes.Buffer
  • func (g *Generator) BuildSource() bytes.Buffer
  • func (g *Generator) ExtractFunctionList(yData []byte) map[string]*FunctionDef
  • func (g *Generator) ParseLibs()
  • func (g *Generator) ParseYAML(path string)
  • func (g *Generator) ResolveLibs() []string
• type Library
  • func (l *Library) ParseLibrary(g *Generator)
  • func (l *Library) WriteModifiedSource()
• type RetDef

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type ArgDef

type ArgDef struct {
	Name   string `yaml:"label"`
	GoType string `yaml:"gotype"`
}

type FunctionDef

type FunctionDef struct {
	Name                string   `yaml:"name"`
	Description         string   `yaml:"description"`
	Author              string   `yaml:"author"`
	Package             string   `yaml:"package"`
	ExpectedArgTypes    []ArgDef `yaml:"args"`
	ExpectedReturnTypes []RetDef `yaml:"returns"`
}

func (*FunctionDef) BuildGodoc

func (f *FunctionDef) BuildGodoc() ([]string, error)

func (*FunctionDef) ReceiverString

func (f *FunctionDef) ReceiverString() string

func (*FunctionDef) ReturnString

func (f *FunctionDef) ReturnString() string

type Generator

type Generator struct {
	Package string
	Logger  *logrus.Logger
	Libs    map[string]*Library
	Funcs   map[string]*FunctionDef
	Config  string
}

func (*Generator) BuildDocs

func (g *Generator) BuildDocs() bytes.Buffer

func (*Generator) BuildSource

func (g *Generator) BuildSource() bytes.Buffer

func (*Generator) ExtractFunctionList

func (g *Generator) ExtractFunctionList(yData []byte) map[string]*FunctionDef

func (*Generator) ParseLibs

func (g *Generator) ParseLibs()

func (*Generator) ParseYAML

func (g *Generator) ParseYAML(path string)

func (*Generator) ResolveLibs

func (g *Generator) ResolveLibs() []string

type Library

type Library struct {
	Name   string                  `yaml:"package"`
	Path   string                  `yaml:"path"`
	FSet   *token.FileSet          `yaml:"-"`
	AST    *ast.File               `yaml:"-"`
	Logger *logrus.Logger          `yaml:"-"`
	Funcs  map[string]*FunctionDef `yaml:"-"`
	Source []byte                  `yaml:"-"`
}

func (*Library) ParseLibrary

func (l *Library) ParseLibrary(g *Generator)

func (*Library) WriteModifiedSource

func (l *Library) WriteModifiedSource()

type RetDef

type RetDef struct {
	Name       string `yaml:"label"`
	GoType     string `yaml:"gotype"`
	ReturnToVM bool   `yaml:"return,omitempty"`
}