generator

package

v0.3.12 Latest Latest Go to latest Published: Apr 30, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cloudwego/thriftgo

Links

Open Source Insights

Documentation ¶

Overview ¶

Package generator contains the generator implementation that manages backends. New backend must implement the backend.Backend interface and be registered into the Generator instance before using.

Index ¶

type Arguments
type FileManager
- func NewFileManager(log backend.LogFunc) *FileManager
- func (fm *FileManager) BuildResponse() *plugin.Response
- func (fm *FileManager) Feed(src string, files []*plugin.Generated) error
type Generator
type LangSpec

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Arguments ¶

type Arguments struct {
	Out *LangSpec
	Req *plugin.Request
	Log backend.LogFunc
}

Arguments contains arguments for generator's Generate method.

type FileManager ¶

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

FileManager manages in-memory files that used during the code generation process.

func NewFileManager ¶

func NewFileManager(log backend.LogFunc) *FileManager

NewFileManager creates a new FileManager.

func (*FileManager) BuildResponse ¶

func (fm *FileManager) BuildResponse() *plugin.Response

BuildResponse creates a plugin.Response containing all files that the FileManager manages. All insertion points will be removed after the response is built.

func (*FileManager) Feed ¶

func (fm *FileManager) Feed(src string, files []*plugin.Generated) error

Feed adds files to the FileManager.

type Generator ¶

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

Generator controls the code generation. The zero value of Generator is ready for use.

func (*Generator) AllBackend ¶

func (g *Generator) AllBackend() []backend.Backend

AllBackend returns all registered backends.

func (*Generator) Generate ¶

func (g *Generator) Generate(args *Arguments) (res *plugin.Response)

Generate generates codes for the target language and executes plugins specified.

func (*Generator) GetBackend ¶

func (g *Generator) GetBackend(name string) backend.Backend

GetBackend returns a backend of the language.

func (*Generator) Name ¶

func (g *Generator) Name() string

Name returns "thriftgo".

func (*Generator) Persist ¶

func (g *Generator) Persist(res *plugin.Response) error

Persist writes generated files into the disk. Each files in the Contents slice must have a legal name.

func (*Generator) RegisterBackend ¶

func (g *Generator) RegisterBackend(b backend.Backend) error

RegisterBackend adds a backend to the generator.

type LangSpec ¶

type LangSpec struct {
	Language    string
	Options     []plugin.Option
	UsedPlugins []*plugin.Desc
}

LangSpec is the parameter to specify which language to generate codes for and what plugins should be used.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
backend Package backend defines the Backend interface for generators.	Package backend defines the Backend interface for generators.
golang Package golang is the generator backend for golang.	Package golang is the generator backend for golang.
common
extension/meta
extension/unknown Package unknown .	Package unknown .
streaming
styles
templates Package templates defines templates for generating golang codes.	Package templates defines templates for generating golang codes.
templates/raw_struct
templates/ref
templates/reflection
templates/slim

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