import "gopkg.in/bblfsh/sdk.v3/protocol"
const (
// DefaultGRPCMaxMessageBytes is maximum msg size for gRPC.
DefaultGRPCMaxMessageBytes = 100 * mb
)var (
ErrInvalidLengthDriver = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowDriver = fmt.Errorf("proto: integer overflow")
)var DevelopmentStatus_name = map[int32]string{ 0: "DEV_INACTIVE", 1: "DEV_PLANNING", 2: "DEV_PREALPHA", 3: "DEV_ALPHA", 4: "DEV_BETA", 5: "DEV_STABLE", 6: "DEV_MATURE", }
var DevelopmentStatus_value = map[string]int32{ "DEV_INACTIVE": 0, "DEV_PLANNING": 1, "DEV_PREALPHA": 2, "DEV_ALPHA": 3, "DEV_BETA": 4, "DEV_STABLE": 5, "DEV_MATURE": 6, }
var Mode_name = map[int32]string{ 0: "DEFAULT_MODE", 1: "NATIVE", 2: "PREPROCESSED", 4: "ANNOTATED", 8: "SEMANTIC", }
var Mode_value = map[string]int32{ "DEFAULT_MODE": 0, "NATIVE": 1, "PREPROCESSED": 2, "ANNOTATED": 4, "SEMANTIC": 8, }
func AsDriver(cc *grpc.ClientConn) driver.Driver
AsDriver creates a v2 driver client for a given gRPC client.
func DialOptions() []grpc.DialOption
DialOptions returns a set of common options that should be used when dialing bblfsh server.
It automatically enables OpenTrace if a global tracer is set.
RegisterDriver registers a v2 driver server on a given gRPC server.
func RegisterDriverHostServer(s *grpc.Server, srv DriverHostServer)
func RegisterDriverServer(s *grpc.Server, srv DriverServer)
func ServerOptions() []grpc.ServerOption
ServerOptions returns a set of common options that should be used in bblfsh server.
It automatically enables OpenTrace if a global tracer is set.
const (
DevelopmentStatus_Inactive DevelopmentStatus = 0
DevelopmentStatus_Planning DevelopmentStatus = 1
DevelopmentStatus_PreAlpha DevelopmentStatus = 2
DevelopmentStatus_Alpha DevelopmentStatus = 3
DevelopmentStatus_Beta DevelopmentStatus = 4
DevelopmentStatus_Stable DevelopmentStatus = 5
DevelopmentStatus_Mature DevelopmentStatus = 6
)func (DevelopmentStatus) EnumDescriptor() ([]byte, []int)
func (x DevelopmentStatus) String() string
type DriverClient interface {
// Parse returns an UAST for a given source file.
Parse(ctx context.Context, in *ParseRequest, opts ...grpc.CallOption) (*ParseResponse, error)
}DriverClient is the client API for Driver service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDriverClient(cc *grpc.ClientConn) DriverClient
type DriverHostClient interface {
// ServerVersion returns version information of this server.
ServerVersion(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error)
// SupportedLanguages returns a list of languages supported by the server.
SupportedLanguages(ctx context.Context, in *SupportedLanguagesRequest, opts ...grpc.CallOption) (*SupportedLanguagesResponse, error)
}DriverHostClient is the client API for DriverHost service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDriverHostClient(cc *grpc.ClientConn) DriverHostClient
type DriverHostServer interface {
// ServerVersion returns version information of this server.
ServerVersion(context.Context, *VersionRequest) (*VersionResponse, error)
// SupportedLanguages returns a list of languages supported by the server.
SupportedLanguages(context.Context, *SupportedLanguagesRequest) (*SupportedLanguagesResponse, error)
}DriverHostServer is the server API for DriverHost service.
type DriverServer interface {
// Parse returns an UAST for a given source file.
Parse(context.Context, *ParseRequest) (*ParseResponse, error)
}DriverServer is the server API for Driver service.
type ErrorDetails struct {
// Types that are valid to be assigned to Reason:
// *ErrorDetails_InvalidFileEncoding
// *ErrorDetails_UnsupportedLanguage
// *ErrorDetails_CannotDetectLanguage
// *ErrorDetails_UnsupportedTransformMode
// *ErrorDetails_TransformFailure
// *ErrorDetails_DriverFailure
Reason isErrorDetails_Reason `protobuf_oneof:"reason"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}ErrorDetails adds bblfsh-specific information to gRPC errors (google.rpc.Status).
func (*ErrorDetails) Descriptor() ([]byte, []int)
func (m *ErrorDetails) GetCannotDetectLanguage() bool
func (m *ErrorDetails) GetDriverFailure() bool
func (m *ErrorDetails) GetInvalidFileEncoding() bool
func (m *ErrorDetails) GetReason() isErrorDetails_Reason
func (m *ErrorDetails) GetTransformFailure() bool
func (m *ErrorDetails) GetUnsupportedLanguage() string
func (m *ErrorDetails) GetUnsupportedTransformMode() bool
func (m *ErrorDetails) Marshal() (dAtA []byte, err error)
func (m *ErrorDetails) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ErrorDetails) ProtoMessage()
func (m *ErrorDetails) ProtoSize() (n int)
func (m *ErrorDetails) Reset()
func (m *ErrorDetails) String() string
func (m *ErrorDetails) Unmarshal(dAtA []byte) error
func (m *ErrorDetails) XXX_DiscardUnknown()
func (m *ErrorDetails) XXX_Merge(src proto.Message)
func (*ErrorDetails) XXX_MessageName() string
func (*ErrorDetails) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
func (m *ErrorDetails) XXX_Size() int
func (m *ErrorDetails) XXX_Unmarshal(b []byte) error
type ErrorDetails_CannotDetectLanguage struct {
CannotDetectLanguage bool `protobuf:"varint,3,opt,name=cannot_detect_language,json=cannotDetectLanguage,proto3,oneof"`
}func (m *ErrorDetails_CannotDetectLanguage) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_CannotDetectLanguage) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_CannotDetectLanguage) ProtoSize() (n int)
type ErrorDetails_DriverFailure struct {
DriverFailure bool `protobuf:"varint,6,opt,name=driver_failure,json=driverFailure,proto3,oneof"`
}func (m *ErrorDetails_DriverFailure) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_DriverFailure) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_DriverFailure) ProtoSize() (n int)
type ErrorDetails_InvalidFileEncoding struct {
InvalidFileEncoding bool `protobuf:"varint,1,opt,name=invalid_file_encoding,json=invalidFileEncoding,proto3,oneof"`
}func (m *ErrorDetails_InvalidFileEncoding) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_InvalidFileEncoding) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_InvalidFileEncoding) ProtoSize() (n int)
type ErrorDetails_TransformFailure struct {
TransformFailure bool `protobuf:"varint,5,opt,name=transform_failure,json=transformFailure,proto3,oneof"`
}func (m *ErrorDetails_TransformFailure) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_TransformFailure) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_TransformFailure) ProtoSize() (n int)
type ErrorDetails_UnsupportedLanguage struct {
UnsupportedLanguage string `protobuf:"bytes,2,opt,name=unsupported_language,json=unsupportedLanguage,proto3,oneof"`
}func (m *ErrorDetails_UnsupportedLanguage) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_UnsupportedLanguage) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_UnsupportedLanguage) ProtoSize() (n int)
type ErrorDetails_UnsupportedTransformMode struct {
UnsupportedTransformMode bool `protobuf:"varint,4,opt,name=unsupported_transform_mode,json=unsupportedTransformMode,proto3,oneof"`
}func (m *ErrorDetails_UnsupportedTransformMode) MarshalTo(dAtA []byte) (int, error)
func (m *ErrorDetails_UnsupportedTransformMode) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ErrorDetails_UnsupportedTransformMode) ProtoSize() (n int)
type Manifest struct {
// Name is a human-readable language or driver name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Language is a Babelfish language identifier.
Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
// Aliases is a list of alternative language identifiers from Enry/Linguist.
Aliases []string `protobuf:"bytes,3,rep,name=aliases,proto3" json:"aliases,omitempty"`
// Version of the language driver.
Version *Version `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
// Status of the driver development.
Status DevelopmentStatus `protobuf:"varint,5,opt,name=status,proto3,enum=gopkg.in.bblfsh.sdk.v2.protocol.DevelopmentStatus" json:"status,omitempty"`
// Features this driver supports.
Features []string `protobuf:"bytes,6,rep,name=features,proto3" json:"features,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}NewManifest converts driver manifest to the corresponding protocol message.
ToNative converts the manifest message to the driver manifest used by the SDK.
const (
// DefaultMode selects the transformation mode that is considered to produce UAST of the best quality.
Mode_DefaultMode Mode = 0
// Native disables any UAST transformations and emits a native language AST as returned by the parser.
Mode_Native Mode = 1
// Preprocessed runs only basic transformation over native AST (normalize positional info, type fields).
Mode_Preprocessed Mode = 2
// Annotated UAST is based on native AST, but provides role annotations for nodes.
Mode_Annotated Mode = 4
// Semantic UAST normalizes native AST nodes to a unified structure where possible.
Mode_Semantic Mode = 8
)type ParseError struct {
// Text is an error message.
Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}func (*ParseError) Descriptor() ([]byte, []int)
func (m *ParseError) Marshal() (dAtA []byte, err error)
func (m *ParseError) MarshalTo(dAtA []byte) (int, error)
func (m *ParseError) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ParseError) ProtoMessage()
func (m *ParseError) ProtoSize() (n int)
func (m *ParseError) Reset()
func (m *ParseError) String() string
func (m *ParseError) Unmarshal(dAtA []byte) error
func (m *ParseError) XXX_DiscardUnknown()
func (m *ParseError) XXX_Merge(src proto.Message)
func (m *ParseError) XXX_Size() int
func (m *ParseError) XXX_Unmarshal(b []byte) error
type ParseRequest struct {
// Content stores the content of a source file. Required.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// Language can be set optionally to disable automatic language detection.
Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
// Filename can be set optionally to assist automatic language detection.
Filename string `protobuf:"bytes,3,opt,name=filename,proto3" json:"filename,omitempty"`
// Mode sets a transformation pipeline used for UAST.
Mode Mode `protobuf:"varint,4,opt,name=mode,proto3,enum=gopkg.in.bblfsh.sdk.v2.protocol.Mode" json:"mode,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}ParseRequest is a request to parse a file and get its UAST.
func (*ParseRequest) Descriptor() ([]byte, []int)
func (m *ParseRequest) Marshal() (dAtA []byte, err error)
func (m *ParseRequest) MarshalTo(dAtA []byte) (int, error)
func (m *ParseRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ParseRequest) ProtoMessage()
func (m *ParseRequest) ProtoSize() (n int)
func (m *ParseRequest) Reset()
func (m *ParseRequest) String() string
func (m *ParseRequest) Unmarshal(dAtA []byte) error
func (m *ParseRequest) XXX_DiscardUnknown()
func (m *ParseRequest) XXX_Merge(src proto.Message)
func (m *ParseRequest) XXX_Size() int
func (m *ParseRequest) XXX_Unmarshal(b []byte) error
type ParseResponse struct {
// UAST is a binary encoding of the resulting UAST.
Uast []byte `protobuf:"bytes,1,opt,name=uast,proto3" json:"uast,omitempty"`
// Language that was automatically detected.
Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
// Errors is a list of parsing errors.
// Only set if parser was able to return a response. Otherwise gRPC error codes are used.
Errors []*ParseError `protobuf:"bytes,3,rep,name=errors,proto3" json:"errors,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}ParseResponse is the reply to ParseRequest.
func (*ParseResponse) Descriptor() ([]byte, []int)
func (m *ParseResponse) Marshal() (dAtA []byte, err error)
func (m *ParseResponse) MarshalTo(dAtA []byte) (int, error)
func (m *ParseResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (m *ParseResponse) Nodes() (nodes.Node, error)
func (*ParseResponse) ProtoMessage()
func (m *ParseResponse) ProtoSize() (n int)
func (m *ParseResponse) Reset()
func (m *ParseResponse) String() string
func (m *ParseResponse) Unmarshal(dAtA []byte) error
func (m *ParseResponse) XXX_DiscardUnknown()
func (m *ParseResponse) XXX_Merge(src proto.Message)
func (m *ParseResponse) XXX_Size() int
func (m *ParseResponse) XXX_Unmarshal(b []byte) error
type SupportedLanguagesRequest struct {
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}func (*SupportedLanguagesRequest) Descriptor() ([]byte, []int)
func (m *SupportedLanguagesRequest) Marshal() (dAtA []byte, err error)
func (m *SupportedLanguagesRequest) MarshalTo(dAtA []byte) (int, error)
func (m *SupportedLanguagesRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*SupportedLanguagesRequest) ProtoMessage()
func (m *SupportedLanguagesRequest) ProtoSize() (n int)
func (m *SupportedLanguagesRequest) Reset()
func (m *SupportedLanguagesRequest) String() string
func (m *SupportedLanguagesRequest) Unmarshal(dAtA []byte) error
func (m *SupportedLanguagesRequest) XXX_DiscardUnknown()
func (m *SupportedLanguagesRequest) XXX_Merge(src proto.Message)
func (m *SupportedLanguagesRequest) XXX_Size() int
func (m *SupportedLanguagesRequest) XXX_Unmarshal(b []byte) error
type SupportedLanguagesResponse struct {
// Languages is a list of driver manifests for each language supported by the server.
Languages []*Manifest `protobuf:"bytes,1,rep,name=languages,proto3" json:"languages,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}func (*SupportedLanguagesResponse) Descriptor() ([]byte, []int)
func (m *SupportedLanguagesResponse) Marshal() (dAtA []byte, err error)
func (m *SupportedLanguagesResponse) MarshalTo(dAtA []byte) (int, error)
func (m *SupportedLanguagesResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*SupportedLanguagesResponse) ProtoMessage()
func (m *SupportedLanguagesResponse) ProtoSize() (n int)
func (m *SupportedLanguagesResponse) Reset()
func (m *SupportedLanguagesResponse) String() string
func (m *SupportedLanguagesResponse) Unmarshal(dAtA []byte) error
func (m *SupportedLanguagesResponse) XXX_DiscardUnknown()
func (m *SupportedLanguagesResponse) XXX_Merge(src proto.Message)
func (m *SupportedLanguagesResponse) XXX_Size() int
func (m *SupportedLanguagesResponse) XXX_Unmarshal(b []byte) error
type UnimplementedDriverHostServer struct {
}UnimplementedDriverHostServer can be embedded to have forward compatible implementations.
func (*UnimplementedDriverHostServer) ServerVersion(ctx context.Context, req *VersionRequest) (*VersionResponse, error)
func (*UnimplementedDriverHostServer) SupportedLanguages(ctx context.Context, req *SupportedLanguagesRequest) (*SupportedLanguagesResponse, error)
type UnimplementedDriverServer struct {
}UnimplementedDriverServer can be embedded to have forward compatible implementations.
func (*UnimplementedDriverServer) Parse(ctx context.Context, req *ParseRequest) (*ParseResponse, error)
type Version struct {
Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
Build time.Time `protobuf:"bytes,2,opt,name=build,proto3,stdtime" json:"build"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}type VersionRequest struct {
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}func (*VersionRequest) Descriptor() ([]byte, []int)
func (m *VersionRequest) Marshal() (dAtA []byte, err error)
func (m *VersionRequest) MarshalTo(dAtA []byte) (int, error)
func (m *VersionRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*VersionRequest) ProtoMessage()
func (m *VersionRequest) ProtoSize() (n int)
func (m *VersionRequest) Reset()
func (m *VersionRequest) String() string
func (m *VersionRequest) Unmarshal(dAtA []byte) error
func (m *VersionRequest) XXX_DiscardUnknown()
func (m *VersionRequest) XXX_Merge(src proto.Message)
func (m *VersionRequest) XXX_Size() int
func (m *VersionRequest) XXX_Unmarshal(b []byte) error
type VersionResponse struct {
Version *Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}func (*VersionResponse) Descriptor() ([]byte, []int)
func (m *VersionResponse) Marshal() (dAtA []byte, err error)
func (m *VersionResponse) MarshalTo(dAtA []byte) (int, error)
func (m *VersionResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*VersionResponse) ProtoMessage()
func (m *VersionResponse) ProtoSize() (n int)
func (m *VersionResponse) Reset()
func (m *VersionResponse) String() string
func (m *VersionResponse) Unmarshal(dAtA []byte) error
func (m *VersionResponse) XXX_DiscardUnknown()
func (m *VersionResponse) XXX_Merge(src proto.Message)
func (m *VersionResponse) XXX_Size() int
func (m *VersionResponse) XXX_Unmarshal(b []byte) error
| Path | Synopsis |
|---|---|
| v1 |
Package protocol imports 25 packages (graph). Updated 2019-10-16. Refresh now. Tools for package owners.