generator

package
v5.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2019 License: MIT Imports: 8 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SetNamer added in v5.3.0

func SetNamer(n Namer)

SetNamer sets the generator's global namer

func ToPublicName

func ToPublicName(name string) string

ToPublicName returns a go-idiomatic public name by using the package's configured namer.

func ToPublicSimpleName added in v5.3.0

func ToPublicSimpleName(name string) string

ToPublicSimpleName returns a go-idiomatic public name. The Avro spec specifies names must start with [A-Za-z_] and contain [A-Za-z0-9_]. The golang spec says valid identifiers start with [A-Za-z_] and contain [A-Za-z0-9], but the first character must be [A-Z] for the field to be public.

func ToSnake

func ToSnake(in string) string

ToSnake makes filenames snake-case, taken from https://gist.github.com/elwinar/14e1e897fdbe4d3432e1

Types

type DefaultNamer added in v5.3.0

type DefaultNamer struct {
}

DefaultNamer implements the Namer interface with the backwards-compatible public name generator function.

func (*DefaultNamer) ToPublicName added in v5.3.0

func (d *DefaultNamer) ToPublicName(name string) string

ToPublicName implements the backwards-compatible name converter in DefaultNamer.

type File

type File struct {
	// contains filtered or unexported fields
}

File represents a Go source file in the output package

func NewFile

func NewFile(name string) *File

func (*File) Functions

func (f *File) Functions() []FunctionName

func (*File) Imports

func (f *File) Imports() []string

func (*File) Structs

func (f *File) Structs() []string

func (*File) WriteFile

func (f *File) WriteFile(pkgName, targetFile string) error

TODO: It'd be better to group funcs attached to a struct with the struct definition

type FunctionName

type FunctionName struct {
	// The target struct type, if there is one
	Str string
	// The function name
	Name string
}

type FunctionNameList

type FunctionNameList []FunctionName

FunctionNameList implements the Sortable interface for FunctionNames

func (FunctionNameList) Len

func (f FunctionNameList) Len() int

func (FunctionNameList) Less

func (f FunctionNameList) Less(i, j int) bool

Sort functions by the struct to which they're attached first, then the name of the method itself. If the function isn't attached to a struct, put it at the bottom

func (FunctionNameList) Swap

func (f FunctionNameList) Swap(i, j int)

type Namer added in v5.3.0

type Namer interface {
	// ToPublicName returns a go-idiomatic public name. The Avro spec
	// specifies names must start with [A-Za-z_] and contain [A-Za-z0-9_].
	// The golang spec says valid identifiers start with [A-Za-z_] and contain
	// [A-Za-z0-9], but the first character must be [A-Z] for the field to be
	// public.
	ToPublicName(name string) string
}

Namer is the interface defining a function for converting a name to a go-idiomatic public name.

type NamespaceNamer added in v5.3.0

type NamespaceNamer struct {
	// contains filtered or unexported fields
}

NamespaceNamer is like DefaultNamer but taking into account special tokens so namespaced names can be generated safely.

func NewNamespaceNamer added in v5.3.0

func NewNamespaceNamer(shortNames bool) *NamespaceNamer

NewNamespaceNamer returns a namespace-aware namer.

func (*NamespaceNamer) ToPublicName added in v5.3.0

func (n *NamespaceNamer) ToPublicName(name string) string

ToPublicName implements the go-idiomatic public name as in DefaultNamer's struct, but with additional treatment applied in order to remove possible invalid tokens from it. Final string is then converted to camel-case.

type Package

type Package struct {
	// contains filtered or unexported fields
}

Package represents the output package

func NewPackage

func NewPackage(name string) *Package

func (*Package) AddConstant

func (p *Package) AddConstant(file, name string, value interface{})

func (*Package) AddFunction

func (p *Package) AddFunction(file, str, name, def string)

func (*Package) AddHeader

func (p *Package) AddHeader(file, header string)

func (*Package) AddImport

func (p *Package) AddImport(file, name string)

func (*Package) AddStruct

func (p *Package) AddStruct(file, name, def string)

func (*Package) File

func (p *Package) File(name string) (*File, bool)

func (*Package) Files

func (p *Package) Files() []string

func (*Package) HasFunction

func (p *Package) HasFunction(file, str, name string) bool

func (*Package) HasImport

func (p *Package) HasImport(file, name string) bool

func (*Package) HasStruct

func (p *Package) HasStruct(file, name string) bool

func (*Package) WriteFiles

func (p *Package) WriteFiles(targetDir string) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL