confgen

Documentation

Index

• Constants
• func AppVersion() string
• func GetOneofFieldByNumber(od protoreflect.OneofDescriptor, n int32) protoreflect.FieldDescriptor
• func IsUnion(md protoreflect.MessageDescriptor) bool
• func IsUnionField(fd protoreflect.FieldDescriptor) bool
• func NewSheetExporter(outputDir string, output *options.ConfOutputOption) *sheetExporter
• func NewSheetParser(protoPackage, locationName string, opts *tableaupb.WorksheetOptions) *sheetParser
• func ParseFileOptions(fd protoreflect.FileDescriptor) (string, *tableaupb.WorkbookOptions)
• func ParseMessage(info *SheetInfo, importers ...importer.Importer) (proto.Message, error)
• func ParseMessageOptions(md protoreflect.MessageDescriptor) (string, *tableaupb.WorksheetOptions)
• func PrintPerfStats(gen *Generator)
• type Field
• type Generator
  • func NewGenerator(protoPackage, indir, outdir string, setters ...options.Option) *Generator
  • func NewGeneratorWithOptions(protoPackage, indir, outdir string, opts *options.Options) *Generator
  • func (gen *Generator) GenAll() error
  • func (gen *Generator) GenOneWorkbook(relWorkbookPath string, worksheetName string) (err error)
  • func (gen *Generator) GenWorkbook(relWorkbookPaths ...string) error
  • func (gen *Generator) Generate(relWorkbookPaths ...string) (err error)
• type SheetInfo
  • func NewSheetInfo(protoPackage, locationName string, md protoreflect.MessageDescriptor, ...) *SheetInfo
  • func (si *SheetInfo) HasMerger() bool
  • func (si *SheetInfo) HasScatter() bool
• type UnionDescriptor
  • func ExtractUnionDescriptor(md protoreflect.MessageDescriptor) *UnionDescriptor
  • func (u UnionDescriptor) GetValueByNumber(n int32) protoreflect.FieldDescriptor
  • func (u UnionDescriptor) TypeName() string
  • func (u UnionDescriptor) ValueFieldName() string

Constants

const (
	App     = "confgen"
	Version = "0.5.0"
)

Functions

func AppVersion

func AppVersion() string

func GetOneofFieldByNumber

func GetOneofFieldByNumber(od protoreflect.OneofDescriptor, n int32) protoreflect.FieldDescriptor

GetOneofFieldByNumber returns the FieldDescriptor for a field numbered n. It returns nil if not found.

func IsUnion

func IsUnion(md protoreflect.MessageDescriptor) bool

func IsUnionField

func IsUnionField(fd protoreflect.FieldDescriptor) bool

func NewSheetExporter

func NewSheetExporter(outputDir string, output *options.ConfOutputOption) *sheetExporter

func NewSheetParser

func NewSheetParser(protoPackage, locationName string, opts *tableaupb.WorksheetOptions) *sheetParser

NewSheetParser create a new sheet parser without Generator.

func ParseFileOptions

func ParseFileOptions(fd protoreflect.FileDescriptor) (string, *tableaupb.WorkbookOptions)

ParseFileOptions parse the options of a protobuf definition file.

func ParseMessage

func ParseMessage(info *SheetInfo, importers ...importer.Importer) (proto.Message, error)

func ParseMessageOptions

func ParseMessageOptions(md protoreflect.MessageDescriptor) (string, *tableaupb.WorksheetOptions)

ParseMessageOptions parse the options of a protobuf message.

func PrintPerfStats

func PrintPerfStats(gen *Generator)

Types

type Field

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

type Generator

type Generator struct {
	ProtoPackage string // protobuf package name.
	InputDir     string // input dir of workbooks.
	OutputDir    string // output dir of generated files.

	LocationName string                    // TZ location name.
	InputOpt     *options.ConfInputOption  // Input settings.
	OutputOpt    *options.ConfOutputOption // output settings.

	// Performace stats
	PerfStats sync.Map
	// contains filtered or unexported fields
}

func NewGenerator

func NewGenerator(protoPackage, indir, outdir string, setters ...options.Option) *Generator

func NewGeneratorWithOptions

func NewGeneratorWithOptions(protoPackage, indir, outdir string, opts *options.Options) *Generator

func (*Generator) GenAll

func (gen *Generator) GenAll() error

func (*Generator) GenOneWorkbook

func (gen *Generator) GenOneWorkbook(relWorkbookPath string, worksheetName string) (err error)

func (*Generator) GenWorkbook

func (gen *Generator) GenWorkbook(relWorkbookPaths ...string) error

func (*Generator) Generate

func (gen *Generator) Generate(relWorkbookPaths ...string) (err error)

type SheetInfo

type SheetInfo struct {
	ProtoPackage string
	LocationName string

	MD   protoreflect.MessageDescriptor
	Opts *tableaupb.WorksheetOptions
	// contains filtered or unexported fields
}

func NewSheetInfo

func NewSheetInfo(protoPackage, locationName string, md protoreflect.MessageDescriptor, opts *tableaupb.WorksheetOptions) *SheetInfo

func (*SheetInfo) HasMerger

func (si *SheetInfo) HasMerger() bool

func (*SheetInfo) HasScatter

func (si *SheetInfo) HasScatter() bool

type UnionDescriptor

type UnionDescriptor struct {
	Type  protoreflect.FieldDescriptor
	Value protoreflect.OneofDescriptor
}

func ExtractUnionDescriptor

func ExtractUnionDescriptor(md protoreflect.MessageDescriptor) *UnionDescriptor

func (UnionDescriptor) GetValueByNumber

func (u UnionDescriptor) GetValueByNumber(n int32) protoreflect.FieldDescriptor

GetValueByNumber returns the FieldDescriptor for a field numbered n. It returns nil if not found.

func (UnionDescriptor) TypeName

func (u UnionDescriptor) TypeName() string

TypeName returns the type field name. It returns CameCase style of proto field name if not set explicitly in field extension.

func (UnionDescriptor) ValueFieldName

func (u UnionDescriptor) ValueFieldName() string

ValueFieldName returns the value field name. It returns "Field" if not set explicitly in oneof extension.