Documentation
¶
Overview ¶
Package args has common command-line flags for generation programs.
Index ¶
- func DefaultSourceTree() string
- type GeneratorArgs
- func (g *GeneratorArgs) AddFlags(fs *pflag.FlagSet)
- func (g *GeneratorArgs) Execute(nameSystems namer.NameSystems, defaultSystem string, ...) error
- func (g *GeneratorArgs) InputIncludes(p *types.Package) bool
- func (g *GeneratorArgs) LoadGoBoilerplate() ([]byte, error)
- func (g *GeneratorArgs) NewBuilder() (*parser.Builder, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultSourceTree ¶
func DefaultSourceTree() string
DefaultSourceTree returns the /src directory of the first entry in $GOPATH. If $GOPATH is empty, it returns "./". Useful as a default output location.
Types ¶
type GeneratorArgs ¶
type GeneratorArgs struct {
// Which directories to parse.
InputDirs []string
// If true, recurse into all children of InputDirs
Recursive bool
// Source tree to write results to.
OutputBase string
// Package path within the source tree.
OutputPackagePath string
// Where to get copyright header text.
GoHeaderFilePath string
// If true, only verify, don't write anything.
VerifyOnly bool
// Any custom arguments go here
CustomArgs interface{}
}
GeneratorArgs has arguments that are passed to generators.
func Default ¶
func Default() *GeneratorArgs
Default returns a defaulted GeneratorArgs. You may change the defaults before calling AddFlags.
func (*GeneratorArgs) Execute ¶
func (g *GeneratorArgs) Execute(nameSystems namer.NameSystems, defaultSystem string, pkgs func(*generator.Context, *GeneratorArgs) generator.Packages) error
Execute implements main(). If you don't need any non-default behavior, use as: args.Default().Execute(...)
func (*GeneratorArgs) InputIncludes ¶
func (g *GeneratorArgs) InputIncludes(p *types.Package) bool
InputIncludes returns true if the given package is a (sub) package of one of the InputDirs.
func (*GeneratorArgs) LoadGoBoilerplate ¶
func (g *GeneratorArgs) LoadGoBoilerplate() ([]byte, error)
LoadGoBoilerplate loads the boilerplate file passed to --go-header-file.
func (*GeneratorArgs) NewBuilder ¶
func (g *GeneratorArgs) NewBuilder() (*parser.Builder, error)
NewBuilder makes a new parser.Builder and populates it with the input directories.
Source Files