backend

Documentation

Overview

Package backend defines the Backend interface for generators.

Index

• type Backend
• type LogFunc
  • func DummyLogFunc() LogFunc
• type PostProcessor

Types

type Backend

type Backend interface {
	// The name of this backend.
	Name() string

	// Lang returns the target language that this backend supports.
	Lang() string

	// Generate generates codes.
	Generate(req *plugin.Request, log LogFunc) (res *plugin.Response)

	// Options returns the available options with their descriptions.
	Options() []plugin.Option

	// BuiltinPlugins returns a list of built-in plugins of the backend.
	BuiltinPlugins() []*plugin.Desc

	// GetPlugin returns a plugin that match the description or nil.
	GetPlugin(desc *plugin.Desc) plugin.Plugin
}

Backend handles the code generation for a language.

type LogFunc

type LogFunc struct {
	Info      func(v ...interface{})
	Infof     func(fmt string, v ...interface{})
	Warn      func(v ...interface{})
	Warnf     func(fmt string, v ...interface{})
	MultiWarn func(warns []string)
}

LogFunc defines a set of log functions.

func DummyLogFunc

func DummyLogFunc() LogFunc

DummyLogFunc returns a set of log functions that does nothing.

type PostProcessor

type PostProcessor interface {
	PostProcess(path string, content []byte) ([]byte, error)
}

PostProcessor is an optional extension for the Backend interface if it requires a process phase after codes generation and before code persistence.