protoplugin

Documentation

Overview

Package protoplugin provides utilities for protoc plugins.

The only functions that should be called as of now is Main. The rest are not guaranteed to stay here.

This was HEAVILY adapted from github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway.

Eventually, a rewrite of this to be simplier for what we need would be nice, but this was available to get us here, especially with handling go imports.

Note that "FQMN", "FQSN", etc stand for "Fully Qualified Message Name", "Fully Qualified Service Name", etc, which denotes the package and object name together.

Index

• func Run(tmpl *template.Template, templateInfoChecker func(*TemplateInfo) error, ...) error
• type Enum
  • func (e *Enum) FQEN() string
• type Field
• type FieldPath
  • func (p FieldPath) IsNestedProto3() bool
  • func (p FieldPath) RHS(msgExpr string) string
  • func (p FieldPath) String() string
• type FieldPathComponent
  • func (c *FieldPathComponent) LHS() string
  • func (c *FieldPathComponent) RHS() string
• type File
  • func (f *File) IsProto2() bool
• type GoPackage
  • func (g *GoPackage) Standard() bool
  • func (g *GoPackage) String() string
• type Message
  • func (m *Message) FQMN() string
  • func (m *Message) GoType(currentPackage string) string
• type Method
• type Service
  • func (s *Service) FQSN() string
• type TemplateInfo

Functions

func Run

func Run(
	tmpl *template.Template,
	templateInfoChecker func(*TemplateInfo) error,
	baseImports []string,
	fileSuffix string,
) error

Run is the main function for a protobuf plugin to call.

Types

type Enum

type Enum struct {
	*descriptor.EnumDescriptorProto
	File *File
	// Outers is a list of outer messages if this enum is a nested type.
	Outers []string
	Index  int
}

Enum describes a protocol buffer enum type.

func (*Enum) FQEN

func (e *Enum) FQEN() string

FQEN returns a fully qualified enum name of this enum.

type Field

type Field struct {
	*descriptor.FieldDescriptorProto
	// Message is the message type which this field belongs to.
	Message *Message
	// FieldMessage is the message type of the field.
	FieldMessage *Message
}

Field wraps descriptor.FieldDescriptorProto for richer features.

type FieldPath

type FieldPath []*FieldPathComponent

FieldPath is a path to a field from a request message.

func (FieldPath) IsNestedProto3

func (p FieldPath) IsNestedProto3() bool

IsNestedProto3 indicates whether the FieldPath is a nested Proto3 path.

func (FieldPath) RHS

func (p FieldPath) RHS(msgExpr string) string

RHS is a right-hand-side expression in go to be used to assign a value to the target field. It starts with "msgExpr", which is the go expression of the method request object.

func (FieldPath) String

func (p FieldPath) String() string

String returns a string representation of the field path.

type FieldPathComponent

type FieldPathComponent struct {
	// Name is a name of the proto field which this component corresponds to.
	Name string
	// Target is the proto field which this component corresponds to.
	Target *Field
}

FieldPathComponent is a path component in FieldPath

func (*FieldPathComponent) LHS

func (c *FieldPathComponent) LHS() string

LHS returns a left-hand-side expression in go for this field.

func (*FieldPathComponent) RHS

func (c *FieldPathComponent) RHS() string

RHS returns a right-hand-side expression in go for this field.

type File

type File struct {
	*descriptor.FileDescriptorProto
	GoPackage *GoPackage
	Messages  []*Message
	Enums     []*Enum
	Services  []*Service
}

File wraps descriptor.FileDescriptorProto for richer features.

func (*File) IsProto2

func (f *File) IsProto2() bool

IsProto2 determines if the syntax of the file is proto2.

type GoPackage

type GoPackage struct {
	Path string
	Name string
	// Alias is an alias of the package unique within the current invocation of the generator.
	Alias string
}

GoPackage represents a golang package.

func (*GoPackage) Standard

func (g *GoPackage) Standard() bool

Standard returns whether the import is a golang standard package.

func (*GoPackage) String

func (g *GoPackage) String() string

String returns a string representation of this package in the form of import line in golang.

type Message

type Message struct {
	*descriptor.DescriptorProto
	File *File
	// Outers is a list of outer messages if this message is a nested type.
	Outers []string
	Fields []*Field
	// Index is proto path index of this message in File.
	Index int
}

Message describes a protocol buffer message types.

func (*Message) FQMN

func (m *Message) FQMN() string

FQMN returns a fully qualified message name of this message.

func (*Message) GoType

func (m *Message) GoType(currentPackage string) string

GoType returns a go type name for the message type. It prefixes the type name with the package alias if its belonging package is not "currentPackage".

type Method

type Method struct {
	*descriptor.MethodDescriptorProto
	Service      *Service
	RequestType  *Message
	ResponseType *Message
}

Method wraps descriptor.MethodDescriptorProto for richer features.

type Service

type Service struct {
	*descriptor.ServiceDescriptorProto
	File    *File
	Methods []*Method
}

Service wraps descriptor.ServiceDescriptorProto for richer features.

func (*Service) FQSN

func (s *Service) FQSN() string

FQSN returns a fully qualified service name of this service.

type TemplateInfo

type TemplateInfo struct {
	*File
	Imports []*GoPackage
}

TemplateInfo is the info passed to a template.