Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

// Protocol Buffers for Go with Gadgets // // Copyright (c) 2015, The GoGo Authors. All rights reserved. // http://github.com/gogo/protobuf // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package main

import ( “github.com/gogo/protobuf/vanity” “github.com/gogo/protobuf/vanity/command” )

func main() { req := command.Read() files := req.GetProtoFile() files = vanity.FilterFiles(files, vanity.NotGoogleProtobufDescriptorProto)

vanity.ForEachFile(files, vanity.TurnOnMarshalerAll)
          vanity.ForEachFile(files, vanity.TurnOnSizerAll)
          vanity.ForEachFile(files, vanity.TurnOnUnmarshalerAll)
          
          vanity.ForEachFieldInFilesExcludingExtensions(vanity.OnlyProto2(files), vanity.TurnOffNullableForNativeTypesWithoutDefaultsOnly)
          vanity.ForEachFile(files, vanity.TurnOffGoUnrecognizedAll)
          vanity.ForEachFile(files, vanity.TurnOffGoUnkeyedAll)
          vanity.ForEachFile(files, vanity.TurnOffGoSizecacheAll)
          resp := command.Generate(req)
          command.Write(resp)

}

Explanation

This code is the entry point for the protoc-gen-gogofaster plugin, a Protobuf compiler plugin used to generate Go code for faster Protobuf message processing. It enhances the default Protobuf Go generation process by incorporating optimizations for performance.

Here’s a breakdown of the code:

Import Statements:

github.com/gogo/protobuf/vanity: This imports the “vanity” package, which provides a set of utility functions to manipulate Protobuf files and generate Go code.
github.com/gogo/protobuf/vanity/command: This imports the “command” sub-package, responsible for handling the communication with the Protobuf compiler.

Main Function:

req := command.Read(): Reads the Protobuf compiler request, which contains the Protobuf file definitions.
files := req.GetProtoFile(): Extracts the Protobuf file definitions from the request.
files = vanity.FilterFiles(files, vanity.NotGoogleProtobufDescriptorProto): Filters the Protobuf files, removing any files related to the google.protobuf.DescriptorProto type, as these are not required for the Go code generation.
Go Code Generation with Optimization:
vanity.ForEachFile(files, vanity.TurnOnMarshalerAll): For each Protobuf file, generates efficient Marshal() methods for serializing Protobuf messages into binary form.
vanity.ForEachFile(files, vanity.TurnOnSizerAll): Generates efficient Size() methods to calculate the size of Protobuf messages in bytes.
vanity.ForEachFile(files, vanity.TurnOnUnmarshalerAll): Generates efficient Unmarshal() methods to deserialize Protobuf messages from binary form.
vanity.ForEachFieldInFilesExcludingExtensions(vanity.OnlyProto2(files), vanity.TurnOffNullableForNativeTypesWithoutDefaultsOnly): For Proto2 files, disables the default nullable behavior for fields with native types and no default values. This optimizes memory usage and improves performance.
vanity.ForEachFile(files, vanity.TurnOffGoUnrecognizedAll): Disables the generation of code for handling unrecognized fields, reducing code complexity and improving performance.
vanity.ForEachFile(files, vanity.TurnOffGoUnkeyedAll): Disables the generation of code for handling unkeyed fields, further reducing code complexity and improving performance.
vanity.ForEachFile(files, vanity.TurnOffGoSizecacheAll): Disables the generation of a size cache, which can reduce memory usage in some cases.
resp := command.Generate(req): Generates the optimized Go code based on the modified Protobuf files.
command.Write(resp): Sends the generated Go code back to the Protobuf compiler.

In essence, the code uses the vanity package to enhance the default Protobuf Go code generation by adding optimizations for serialization, deserialization, and size calculation. The generated code is expected to be more efficient and performant than the standard Go code generated by the Protobuf compiler.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.