go_protobuf

Documentation

Index

• Variables
• func GenCodeForDefineST(pSet *generator.PrototypeSet, df *generator.DefineST) (string, error)
• func GenCodeForMessage(pSet *generator.PrototypeSet, dm *generator.Message) (string, error)
• func GenFileForMessage(pSet *generator.PrototypeSet, origFn string) error
• func GenFileForSet(pSet *generator.PrototypeSet) error
• type Generator
  • func (g *Generator) Generate(oc generator.GeneratorConfig, pSet *generator.PrototypeSet) error
  • func (g *Generator) Lang() string
  • func (g *Generator) NewConfig() generator.GeneratorConfig
  • func (g *Generator) Proto() string
• type GeneratorConfig
• type TmplDefineSTData
• type TmplDefineSTDataField
• type TmplMessageData
• type TmplProtoFileData

Variables

var TmplDefineST = &generator.TemplateHeader{
	Name:     "go_protobuf_define_st",
	Filepath: "go_protobuf_define_st.tmpl",

	BuiltinTemplateText: `
func (st *{{.Name}}) Name() string {
	return "{{.Name}}"
}
func (st *{{.Name}}) NewST() DefineST {
	return New{{.Name}}()
}
func (st *{{.Name}}) Encode() ([]byte, error) {
	return pb_proto.Marshal(st)
}
func (st *{{.Name}}) Decode(bs []byte) error {
	return pb_proto.Unmarshal(bs, st)
}

{{.DocComment}}
func New{{.Name}}() *{{.Name}} {
	return &{{.Name}}{ {{range .Fields}}{{if (ne .ShouldInitCustomType "")}}
	    {{.Name}}: New{{.ShouldInitCustomType}}(),
{{end}}{{end}}
	}
}
`,
}

var TmplMessage = &generator.TemplateHeader{
	Name:     "go_protobuf_message",
	Filepath: "go_protobuf_message.tmpl",

	BuiltinTemplateText: `func (st *{{.Name}}) ProtoID() uint32 {
	return {{.ProtoIDName}}
}
func (st *{{.Name}}) New() Message {
	return New{{.Name}}()
}
`,
}

var TmplProtoFile = &generator.TemplateHeader{
	Name:     "go_protobuf_proto_file",
	Filepath: "go_protobuf_proto_file.tmpl",

	BuiltinTemplateText: `package {{.PackageName}}

import (
	pb_proto "google.golang.org/protobuf/proto"{{if (len .Import | ne 0)}}{{range .Import}}
	{{.}}{{end}}{{end}}
)

func init() { {{range .DefineSTName}}
RegMessageDef(New{{.}}()){{end}}
}
`,
}

Functions

func GenCodeForDefineST

func GenCodeForDefineST(pSet *generator.PrototypeSet, df *generator.DefineST) (string, error)

func GenCodeForMessage

func GenCodeForMessage(pSet *generator.PrototypeSet, dm *generator.Message) (string, error)

func GenFileForMessage

func GenFileForMessage(pSet *generator.PrototypeSet, origFn string) error

func GenFileForSet

func GenFileForSet(pSet *generator.PrototypeSet) error

Types

type Generator

type Generator struct {
}

func (*Generator) Generate

func (g *Generator) Generate(oc generator.GeneratorConfig, pSet *generator.PrototypeSet) error

func (*Generator) Lang

func (g *Generator) Lang() string

func (*Generator) NewConfig

func (g *Generator) NewConfig() generator.GeneratorConfig

func (*Generator) Proto

func (g *Generator) Proto() string

type GeneratorConfig

type GeneratorConfig struct {
	Dir         string `json:"dir,omitempty"`
	PackageName string `json:"package_name,omitempty"`

	ProtoDir string `json:"proto_dir,omitempty"`

	MessageFilename string `json:"message_filename,omitempty"`
	ConstFilename   string `json:"const_filename,omitempty"`

	Plugins []string `json:"plugins,omitempty"`
}

type TmplDefineSTData

type TmplDefineSTData struct {
	Name       string
	DocComment string
	Fields     []*TmplDefineSTDataField

	Plugins map[string]interface{}
}

type TmplDefineSTDataField

type TmplDefineSTDataField struct {
	Name string

	ShouldInitCustomType string

	Plugins map[string]interface{}
}

type TmplMessageData

type TmplMessageData struct {
	Name        string
	ProtoIDName string

	Plugins map[string]interface{}
}

type TmplProtoFileData

type TmplProtoFileData struct {
	Import      []string
	PackageName string

	DefineSTName []string

	Plugins map[string]interface{}
}