Documentation ¶
Overview ¶
Package generator is deprecated.
This package is excluded from the Go protocol buffer compatibility guarantee and may be deleted at some point in the future.
Deprecated: Do not use.
Index ¶
- func CamelCase(s string) string
- func CamelCaseSlice(elem []string) string
- func RegisterPlugin(p Plugin)
- func RegisterUniquePackageName(pkg string, f *FileDescriptor) string
- type AnnotatedAtoms
- type Descriptor
- type EnumDescriptor
- type ExtensionDescriptor
- type FileDescriptor
- type Generator
- func (g *Generator) AddImport(importPath GoImportPath) GoPackageName
- func (g *Generator) BuildTypeNameMap()
- func (g *Generator) CommandLineParameters(parameter string)
- func (g *Generator) DefaultPackageName(obj Object) string
- func (g *Generator) Error(err error, msgs ...string)
- func (g *Generator) Fail(msgs ...string)
- func (g *Generator) GenerateAllFiles()
- func (g *Generator) GoPackageName(importPath GoImportPath) GoPackageName
- func (g *Generator) GoType(message *Descriptor, field *descriptor.FieldDescriptorProto) (typ string, wire string)
- func (g *Generator) In()
- func (g *Generator) ObjectNamed(typeName string) Object
- func (g *Generator) Out()
- func (g *Generator) P(str ...interface{})
- func (g *Generator) PrintComments(path string) bool
- func (g *Generator) RecordTypeUse(t string)
- func (g *Generator) SetPackageNames()
- func (g *Generator) TypeName(obj Object) string
- func (g *Generator) WrapTypes()
- type GoImportPath
- type GoPackageName
- type ImportedDescriptor
- type Object
- type Plugin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CamelCase ¶
CamelCase returns the CamelCased name. If there is an interior underscore followed by a lower case letter, drop the underscore and convert the letter to upper case. There is a remote possibility of this rewrite causing a name collision, but it's so remote we're prepared to pretend it's nonexistent - since the C++ generator lowercases names, it's extremely unlikely to have two fields with different capitalizations. In short, _my_field_name_2 becomes XMyFieldName_2.
func CamelCaseSlice ¶
CamelCaseSlice is like CamelCase, but the argument is a slice of strings to be joined with "_".
func RegisterPlugin ¶
func RegisterPlugin(p Plugin)
RegisterPlugin installs a (second-order) plugin to be run when the Go output is generated. It is typically called during initialization.
func RegisterUniquePackageName ¶
func RegisterUniquePackageName(pkg string, f *FileDescriptor) string
Create and remember a guaranteed unique package name. Pkg is the candidate name. The FileDescriptor parameter is unused.
Types ¶
type AnnotatedAtoms ¶ added in v1.1.0
type AnnotatedAtoms struct {
// contains filtered or unexported fields
}
AnnotatedAtoms is a list of atoms (as consumed by P) that records the file name and proto AST path from which they originated.
func Annotate ¶ added in v1.1.0
func Annotate(file *FileDescriptor, path string, atoms ...interface{}) *AnnotatedAtoms
Annotate records the file name and proto AST path of a list of atoms so that a later call to P can emit a link from each atom to its origin.
type Descriptor ¶
type Descriptor struct { *descriptor.DescriptorProto // contains filtered or unexported fields }
Descriptor represents a protocol buffer message.
func (*Descriptor) File ¶
func (c *Descriptor) File() *FileDescriptor
func (*Descriptor) GoImportPath ¶ added in v1.1.0
func (c *Descriptor) GoImportPath() GoImportPath
GoImportPath is the import path of the Go package containing the type.
func (*Descriptor) TypeName ¶
func (d *Descriptor) TypeName() []string
TypeName returns the elements of the dotted type name. The package name is not part of this name.
type EnumDescriptor ¶
type EnumDescriptor struct { *descriptor.EnumDescriptorProto // contains filtered or unexported fields }
EnumDescriptor describes an enum. If it's at top level, its parent will be nil. Otherwise it will be the descriptor of the message in which it is defined.
func (*EnumDescriptor) File ¶
func (c *EnumDescriptor) File() *FileDescriptor
func (*EnumDescriptor) GoImportPath ¶ added in v1.1.0
func (c *EnumDescriptor) GoImportPath() GoImportPath
GoImportPath is the import path of the Go package containing the type.
func (*EnumDescriptor) TypeName ¶
func (e *EnumDescriptor) TypeName() (s []string)
TypeName returns the elements of the dotted type name. The package name is not part of this name.
type ExtensionDescriptor ¶
type ExtensionDescriptor struct { *descriptor.FieldDescriptorProto // contains filtered or unexported fields }
ExtensionDescriptor describes an extension. If it's at top level, its parent will be nil. Otherwise it will be the descriptor of the message in which it is defined.
func (*ExtensionDescriptor) DescName ¶
func (e *ExtensionDescriptor) DescName() string
DescName returns the variable name used for the generated descriptor.
func (*ExtensionDescriptor) File ¶
func (c *ExtensionDescriptor) File() *FileDescriptor
func (*ExtensionDescriptor) GoImportPath ¶ added in v1.1.0
func (c *ExtensionDescriptor) GoImportPath() GoImportPath
GoImportPath is the import path of the Go package containing the type.
func (*ExtensionDescriptor) TypeName ¶
func (e *ExtensionDescriptor) TypeName() (s []string)
TypeName returns the elements of the dotted type name. The package name is not part of this name.
type FileDescriptor ¶
type FileDescriptor struct { *descriptor.FileDescriptorProto // contains filtered or unexported fields }
FileDescriptor describes an protocol buffer descriptor file (.proto). It includes slices of all the messages and enums defined within it. Those slices are constructed by WrapTypes.
func (*FileDescriptor) VarName ¶
func (d *FileDescriptor) VarName() string
VarName is the variable name we'll use in the generated code to refer to the compressed bytes of this descriptor. It is not exported, so it is only valid inside the generated package.
type Generator ¶
type Generator struct { *bytes.Buffer Request *plugin.CodeGeneratorRequest // The input. Response *plugin.CodeGeneratorResponse // The output. Param map[string]string // Command-line parameters. PackageImportPath string // Go import path of the package we're generating code for ImportPrefix string // String to prefix to imported package file names. ImportMap map[string]string // Mapping from .proto file name to import path Pkg map[string]string // The names under which we import support packages // contains filtered or unexported fields }
Generator is the type whose methods generate the output, stored in the associated response structure.
func New ¶
func New() *Generator
New creates a new generator and allocates the request and response protobufs.
func (*Generator) AddImport ¶ added in v1.3.0
func (g *Generator) AddImport(importPath GoImportPath) GoPackageName
AddImport adds a package to the generated file's import section. It returns the name used for the package.
func (*Generator) BuildTypeNameMap ¶
func (g *Generator) BuildTypeNameMap()
BuildTypeNameMap builds the map from fully qualified type names to objects. The key names for the map come from the input data, which puts a period at the beginning. It should be called after SetPackageNames and before GenerateAllFiles.
func (*Generator) CommandLineParameters ¶
CommandLineParameters breaks the comma-separated list of key=value pairs in the parameter (a member of the request protobuf) into a key/value map. It then sets file name mappings defined by those entries.
func (*Generator) DefaultPackageName ¶
DefaultPackageName returns the package name printed for the object. If its file is in a different package, it returns the package name we're using for this file, plus ".". Otherwise it returns the empty string.
func (*Generator) GenerateAllFiles ¶
func (g *Generator) GenerateAllFiles()
GenerateAllFiles generates the output for all the files we're outputting.
func (*Generator) GoPackageName ¶ added in v1.1.0
func (g *Generator) GoPackageName(importPath GoImportPath) GoPackageName
GoPackageName returns the name used for a package.
func (*Generator) GoType ¶
func (g *Generator) GoType(message *Descriptor, field *descriptor.FieldDescriptorProto) (typ string, wire string)
GoType returns a string representing the type name, and the wire type
func (*Generator) ObjectNamed ¶
ObjectNamed, given a fully-qualified input type name as it appears in the input data, returns the descriptor for the message or enum with that name.
func (*Generator) P ¶
func (g *Generator) P(str ...interface{})
P prints the arguments to the generated output. It handles strings and int32s, plus handling indirections because they may be *string, etc. Any inputs of type AnnotatedAtoms may emit annotations in a .meta file in addition to outputting the atoms themselves (if g.annotateCode is true).
func (*Generator) PrintComments ¶
PrintComments prints any comments from the source .proto file. The path is a comma-separated list of integers. It returns an indication of whether any comments were printed. See descriptor.proto for its format.
func (*Generator) RecordTypeUse ¶
func (*Generator) SetPackageNames ¶
func (g *Generator) SetPackageNames()
SetPackageNames sets the package name for this run. The package name must agree across all files being generated. It also defines unique package names for all imported files.
func (*Generator) TypeName ¶
TypeName is the printed name appropriate for an item. If the object is in the current file, TypeName drops the package name and underscores the rest. Otherwise the object is from another package; and the result is the underscored package name followed by the item name. The result always has an initial capital.
func (*Generator) WrapTypes ¶
func (g *Generator) WrapTypes()
WrapTypes walks the incoming data, wrapping DescriptorProtos, EnumDescriptorProtos and FileDescriptorProtos into file-referenced objects within the Generator. It also creates the list of files to generate and so should be called before GenerateAllFiles.
type GoImportPath ¶ added in v1.1.0
type GoImportPath string
A GoImportPath is the import path of a Go package. e.g., "google.golang.org/genproto/protobuf".
func (GoImportPath) String ¶ added in v1.1.0
func (p GoImportPath) String() string
type GoPackageName ¶ added in v1.1.0
type GoPackageName string
A GoPackageName is the name of a Go package. e.g., "protobuf".
type ImportedDescriptor ¶
type ImportedDescriptor struct {
// contains filtered or unexported fields
}
ImportedDescriptor describes a type that has been publicly imported from another file.
func (*ImportedDescriptor) File ¶
func (c *ImportedDescriptor) File() *FileDescriptor
func (*ImportedDescriptor) GoImportPath ¶ added in v1.1.0
func (c *ImportedDescriptor) GoImportPath() GoImportPath
GoImportPath is the import path of the Go package containing the type.
func (*ImportedDescriptor) TypeName ¶
func (id *ImportedDescriptor) TypeName() []string
type Object ¶
type Object interface { GoImportPath() GoImportPath TypeName() []string File() *FileDescriptor }
Object is an interface abstracting the abilities shared by enums, messages, extensions and imported objects.
type Plugin ¶
type Plugin interface { // Name identifies the plugin. Name() string // Init is called once after data structures are built but before // code generation begins. Init(g *Generator) // Generate produces the code generated by the plugin for this file, // except for the imports, by calling the generator's methods P, In, and Out. Generate(file *FileDescriptor) // GenerateImports produces the import declarations for this file. // It is called after Generate. GenerateImports(file *FileDescriptor) }
A Plugin provides functionality to add to the output during Go code generation, such as to produce RPC stubs.