xref_proto

package
v0.0.24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2016 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package xref_proto is a generated protocol buffer package.

It is generated from these files:

kythe/proto/xref.proto

It has these top-level messages:

NodesRequest
NodeInfo
NodesReply
EdgesRequest
EdgeSet
EdgesReply
Location
DecorationsRequest
DecorationsReply
CrossReferencesRequest
Anchor
CrossReferencesReply
CallersRequest
CallersReply
DocumentationRequest
DocumentationReply

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthXref = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowXref   = fmt.Errorf("proto: integer overflow")
)
View Source
var CallersReply_CallableDetail_Parameter_Kind_name = map[int32]string{
	0: "TERM",
	1: "TYPE",
}
View Source
var CallersReply_CallableDetail_Parameter_Kind_value = map[string]int32{
	"TERM": 0,
	"TYPE": 1,
}
View Source
var CrossReferencesRequest_DeclarationKind_name = map[int32]string{
	0: "NO_DECLARATIONS",
	1: "ALL_DECLARATIONS",
}
View Source
var CrossReferencesRequest_DeclarationKind_value = map[string]int32{
	"NO_DECLARATIONS":  0,
	"ALL_DECLARATIONS": 1,
}
View Source
var CrossReferencesRequest_DefinitionKind_name = map[int32]string{
	0: "NO_DEFINITIONS",
	1: "ALL_DEFINITIONS",
	2: "FULL_DEFINITIONS",
	3: "BINDING_DEFINITIONS",
}
View Source
var CrossReferencesRequest_DefinitionKind_value = map[string]int32{
	"NO_DEFINITIONS":      0,
	"ALL_DEFINITIONS":     1,
	"FULL_DEFINITIONS":    2,
	"BINDING_DEFINITIONS": 3,
}
View Source
var CrossReferencesRequest_DocumentationKind_name = map[int32]string{
	0: "NO_DOCUMENTATION",
	1: "ALL_DOCUMENTATION",
}
View Source
var CrossReferencesRequest_DocumentationKind_value = map[string]int32{
	"NO_DOCUMENTATION":  0,
	"ALL_DOCUMENTATION": 1,
}
View Source
var CrossReferencesRequest_ReferenceKind_name = map[int32]string{
	0: "NO_REFERENCES",
	1: "ALL_REFERENCES",
}
View Source
var CrossReferencesRequest_ReferenceKind_value = map[string]int32{
	"NO_REFERENCES":  0,
	"ALL_REFERENCES": 1,
}
View Source
var DecorationsRequest_SpanKind_name = map[int32]string{
	0: "WITHIN_SPAN",
	1: "AROUND_SPAN",
}
View Source
var DecorationsRequest_SpanKind_value = map[string]int32{
	"WITHIN_SPAN": 0,
	"AROUND_SPAN": 1,
}
View Source
var Location_Kind_name = map[int32]string{
	0: "FILE",
	1: "SPAN",
}
View Source
var Location_Kind_value = map[string]int32{
	"FILE": 0,
	"SPAN": 1,
}

Functions

func RegisterXRefServiceServer

func RegisterXRefServiceServer(s *grpc.Server, srv XRefServiceServer)

Types

type Anchor added in v0.0.13

type Anchor struct {
	// Ticket of the anchor node
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// Edge kind describing the anchor's relationship with its referenced node
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Parent ticket of the anchor; this is the file containing the anchor
	Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
	// Starting location of the anchor within its parent's text
	Start *Location_Point `protobuf:"bytes,4,opt,name=start" json:"start,omitempty"`
	// Ending location of the anchor within its parent's text
	End *Location_Point `protobuf:"bytes,5,opt,name=end" json:"end,omitempty"`
	// The anchor's spanning text within the anchor parent's text
	Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"`
	// User-readable snippet of the anchor parent's text at the location of this
	// anchor
	Snippet string `protobuf:"bytes,7,opt,name=snippet,proto3" json:"snippet,omitempty"`
	// Starting location of the anchor's snippet within its parent's text
	SnippetStart *Location_Point `protobuf:"bytes,8,opt,name=snippet_start" json:"snippet_start,omitempty"`
	// Ending location of the anchor's snippet within its parent's text
	SnippetEnd *Location_Point `protobuf:"bytes,9,opt,name=snippet_end" json:"snippet_end,omitempty"`
}

func (*Anchor) Descriptor added in v0.0.21

func (*Anchor) Descriptor() ([]byte, []int)

func (*Anchor) GetEnd added in v0.0.13

func (m *Anchor) GetEnd() *Location_Point

func (*Anchor) GetSnippetEnd added in v0.0.16

func (m *Anchor) GetSnippetEnd() *Location_Point

func (*Anchor) GetSnippetStart added in v0.0.16

func (m *Anchor) GetSnippetStart() *Location_Point

func (*Anchor) GetStart added in v0.0.13

func (m *Anchor) GetStart() *Location_Point

func (*Anchor) Marshal added in v0.0.17

func (m *Anchor) Marshal() (data []byte, err error)

func (*Anchor) MarshalTo added in v0.0.17

func (m *Anchor) MarshalTo(data []byte) (int, error)

func (*Anchor) ProtoMessage added in v0.0.13

func (*Anchor) ProtoMessage()

func (*Anchor) Reset added in v0.0.13

func (m *Anchor) Reset()

func (*Anchor) Size added in v0.0.17

func (m *Anchor) Size() (n int)

func (*Anchor) String added in v0.0.13

func (m *Anchor) String() string

func (*Anchor) Unmarshal added in v0.0.17

func (m *Anchor) Unmarshal(data []byte) error

type CallersReply added in v0.0.19

type CallersReply struct {
	// All objects that were blamed for making calls.
	Caller []*CallersReply_Caller `protobuf:"bytes,1,rep,name=caller" json:"caller,omitempty"`
	// Details for the semantic objects that were passed via a CallersRequest.
	Callee []*CallersReply_CallableDetail `protobuf:"bytes,2,rep,name=callee" json:"callee,omitempty"`
}

func (*CallersReply) Descriptor added in v0.0.21

func (*CallersReply) Descriptor() ([]byte, []int)

func (*CallersReply) GetCallee added in v0.0.19

func (m *CallersReply) GetCallee() []*CallersReply_CallableDetail

func (*CallersReply) GetCaller added in v0.0.19

func (m *CallersReply) GetCaller() []*CallersReply_Caller

func (*CallersReply) Marshal added in v0.0.19

func (m *CallersReply) Marshal() (data []byte, err error)

func (*CallersReply) MarshalTo added in v0.0.19

func (m *CallersReply) MarshalTo(data []byte) (int, error)

func (*CallersReply) ProtoMessage added in v0.0.19

func (*CallersReply) ProtoMessage()

func (*CallersReply) Reset added in v0.0.19

func (m *CallersReply) Reset()

func (*CallersReply) Size added in v0.0.19

func (m *CallersReply) Size() (n int)

func (*CallersReply) String added in v0.0.19

func (m *CallersReply) String() string

func (*CallersReply) Unmarshal added in v0.0.19

func (m *CallersReply) Unmarshal(data []byte) error

type CallersReply_CallableDetail added in v0.0.19

type CallersReply_CallableDetail struct {
	// The definition site of the object called or being blamed for a call.
	// This would be the "bar" in "void bar()" for calls blamed on bar above
	// and the "foo" in "void foo()" if it refers to foo as a callee.
	Definition *Anchor `protobuf:"bytes,1,opt,name=definition" json:"definition,omitempty"`
	// The ticket of the object that is `callableas` some C. This would refer
	// to the function node for "bar" or "foo". This object may be the target
	// of a `completes` edge (e.g., if the call was made to a definition
	// rather than a declaration).
	SemanticObject string `protobuf:"bytes,2,opt,name=semantic_object,proto3" json:"semantic_object,omitempty"`
	// The ticket of the callable C for semantic_object that was used to service
	// the query.
	SemanticObjectCallable string `protobuf:"bytes,3,opt,name=semantic_object_callable,proto3" json:"semantic_object_callable,omitempty"`
	// The unqualified identifier for this object ("bar" or "foo" above,
	// even if they were defined in some namespace or record). This field
	// should be human-readable and can be displayed in a UI.
	Identifier string `protobuf:"bytes,4,opt,name=identifier,proto3" json:"identifier,omitempty"`
	// An unambiguous (as possible) identifier for this object ("bar()" or
	// "foo()" above; if it was defined in a namespace, "ns::bar()";
	// if it took arguments, "ns::bar(int *, void *)"). This field should
	// be human-readable and can be displayed in a UI.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,proto3" json:"display_name,omitempty"`
	// The parameters bound by the object referred to by `definition` above.
	// There is no semantic meaning to the order of this array, but it should
	// be reasonable to surface the ordering in a UI (for example, term-level
	// parameters will not be capriciously reordered).
	Parameter []*CallersReply_CallableDetail_Parameter `protobuf:"bytes,6,rep,name=parameter" json:"parameter,omitempty"`
}

Details common to all objects that participate in the call graph.

func (*CallersReply_CallableDetail) Descriptor added in v0.0.21

func (*CallersReply_CallableDetail) Descriptor() ([]byte, []int)

func (*CallersReply_CallableDetail) GetDefinition added in v0.0.19

func (m *CallersReply_CallableDetail) GetDefinition() *Anchor

func (*CallersReply_CallableDetail) GetParameter added in v0.0.19

func (*CallersReply_CallableDetail) Marshal added in v0.0.19

func (m *CallersReply_CallableDetail) Marshal() (data []byte, err error)

func (*CallersReply_CallableDetail) MarshalTo added in v0.0.19

func (m *CallersReply_CallableDetail) MarshalTo(data []byte) (int, error)

func (*CallersReply_CallableDetail) ProtoMessage added in v0.0.19

func (*CallersReply_CallableDetail) ProtoMessage()

func (*CallersReply_CallableDetail) Reset added in v0.0.19

func (m *CallersReply_CallableDetail) Reset()

func (*CallersReply_CallableDetail) Size added in v0.0.19

func (m *CallersReply_CallableDetail) Size() (n int)

func (*CallersReply_CallableDetail) String added in v0.0.19

func (m *CallersReply_CallableDetail) String() string

func (*CallersReply_CallableDetail) Unmarshal added in v0.0.19

func (m *CallersReply_CallableDetail) Unmarshal(data []byte) error

type CallersReply_CallableDetail_Parameter added in v0.0.19

type CallersReply_CallableDetail_Parameter struct {
	// The parameter's kind.
	Kind CallersReply_CallableDetail_Parameter_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=kythe.proto.CallersReply_CallableDetail_Parameter_Kind" json:"kind,omitempty"`
	// The parameter's (unqualified) human-readable and displayable name.
	// May be empty. May also be non-unique; for example, the identifiers for
	// the (unnamed in the source language) parameters for the function
	// `void ignore_pair(int, int)` may be "int" and "int".
	Identifier string `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"`
	// The ticket that refers to the parameter.
	Ticket string `protobuf:"bytes,3,opt,name=ticket,proto3" json:"ticket,omitempty"`
}

A parameter bound by the object referred to by `definition` above.

func (*CallersReply_CallableDetail_Parameter) Descriptor added in v0.0.21

func (*CallersReply_CallableDetail_Parameter) Descriptor() ([]byte, []int)

func (*CallersReply_CallableDetail_Parameter) Marshal added in v0.0.19

func (m *CallersReply_CallableDetail_Parameter) Marshal() (data []byte, err error)

func (*CallersReply_CallableDetail_Parameter) MarshalTo added in v0.0.19

func (m *CallersReply_CallableDetail_Parameter) MarshalTo(data []byte) (int, error)

func (*CallersReply_CallableDetail_Parameter) ProtoMessage added in v0.0.19

func (*CallersReply_CallableDetail_Parameter) ProtoMessage()

func (*CallersReply_CallableDetail_Parameter) Reset added in v0.0.19

func (*CallersReply_CallableDetail_Parameter) Size added in v0.0.19

func (*CallersReply_CallableDetail_Parameter) String added in v0.0.19

func (*CallersReply_CallableDetail_Parameter) Unmarshal added in v0.0.19

func (m *CallersReply_CallableDetail_Parameter) Unmarshal(data []byte) error

type CallersReply_CallableDetail_Parameter_Kind added in v0.0.19

type CallersReply_CallableDetail_Parameter_Kind int32
const (
	// A term-level binding (like the `x` in `void foo(int x)`).
	CallersReply_CallableDetail_Parameter_TERM CallersReply_CallableDetail_Parameter_Kind = 0
	// A type-level binding (like the `T` in
	// `template <typename T> void foo()`).
	CallersReply_CallableDetail_Parameter_TYPE CallersReply_CallableDetail_Parameter_Kind = 1
)

func (CallersReply_CallableDetail_Parameter_Kind) EnumDescriptor added in v0.0.21

func (CallersReply_CallableDetail_Parameter_Kind) EnumDescriptor() ([]byte, []int)

func (CallersReply_CallableDetail_Parameter_Kind) String added in v0.0.19

type CallersReply_Caller added in v0.0.19

type CallersReply_Caller struct {
	// The object (e.g., a function) responsible for making a call.
	Detail   *CallersReply_CallableDetail    `protobuf:"bytes,1,opt,name=detail" json:"detail,omitempty"`
	CallSite []*CallersReply_Caller_CallSite `protobuf:"bytes,2,rep,name=call_site" json:"call_site,omitempty"`
}

An object that was blamed for making a call to an object in the set passed to Callers, along with the syntactic locations that caused that blame to be cast.

func (*CallersReply_Caller) Descriptor added in v0.0.21

func (*CallersReply_Caller) Descriptor() ([]byte, []int)

func (*CallersReply_Caller) GetCallSite added in v0.0.19

func (*CallersReply_Caller) GetDetail added in v0.0.19

func (*CallersReply_Caller) Marshal added in v0.0.19

func (m *CallersReply_Caller) Marshal() (data []byte, err error)

func (*CallersReply_Caller) MarshalTo added in v0.0.19

func (m *CallersReply_Caller) MarshalTo(data []byte) (int, error)

func (*CallersReply_Caller) ProtoMessage added in v0.0.19

func (*CallersReply_Caller) ProtoMessage()

func (*CallersReply_Caller) Reset added in v0.0.19

func (m *CallersReply_Caller) Reset()

func (*CallersReply_Caller) Size added in v0.0.19

func (m *CallersReply_Caller) Size() (n int)

func (*CallersReply_Caller) String added in v0.0.19

func (m *CallersReply_Caller) String() string

func (*CallersReply_Caller) Unmarshal added in v0.0.19

func (m *CallersReply_Caller) Unmarshal(data []byte) error

type CallersReply_Caller_CallSite added in v0.0.19

type CallersReply_Caller_CallSite struct {
	// The location where a call was found inside the blamed object.
	Anchor *Anchor `protobuf:"bytes,1,opt,name=anchor" json:"anchor,omitempty"`
	// This field will be set to true iff this call site was included in the
	// results because include_overrides was true in CallersRequest.
	CallToOverride bool `protobuf:"varint,2,opt,name=call_to_override,proto3" json:"call_to_override,omitempty"`
}

func (*CallersReply_Caller_CallSite) Descriptor added in v0.0.21

func (*CallersReply_Caller_CallSite) Descriptor() ([]byte, []int)

func (*CallersReply_Caller_CallSite) GetAnchor added in v0.0.19

func (m *CallersReply_Caller_CallSite) GetAnchor() *Anchor

func (*CallersReply_Caller_CallSite) Marshal added in v0.0.19

func (m *CallersReply_Caller_CallSite) Marshal() (data []byte, err error)

func (*CallersReply_Caller_CallSite) MarshalTo added in v0.0.19

func (m *CallersReply_Caller_CallSite) MarshalTo(data []byte) (int, error)

func (*CallersReply_Caller_CallSite) ProtoMessage added in v0.0.19

func (*CallersReply_Caller_CallSite) ProtoMessage()

func (*CallersReply_Caller_CallSite) Reset added in v0.0.19

func (m *CallersReply_Caller_CallSite) Reset()

func (*CallersReply_Caller_CallSite) Size added in v0.0.19

func (m *CallersReply_Caller_CallSite) Size() (n int)

func (*CallersReply_Caller_CallSite) String added in v0.0.19

func (*CallersReply_Caller_CallSite) Unmarshal added in v0.0.19

func (m *CallersReply_Caller_CallSite) Unmarshal(data []byte) error

type CallersRequest added in v0.0.19

type CallersRequest struct {
	// A set of semantic tickets. These may refer to nodes that are `callableas`
	// other nodes or they may refer to those specific `callable` nodes. This
	// means that you can use both the target nodes of `ref/call` edges and
	// more common reference or definition edges (like `ref` or
	// `defines/binding`).
	//
	// The Kythe data model defines a `callable` as something that can be the
	// target of a `ref/call` edge. A `callable` has its own identity in the
	// graph and is connected to the nodes it can be called through by a
	// `callableas` edge. A `function` is the most typical node kind that
	// participates in this `callableas` relationship. Other language-level
	// objects that may be sources of `callableas` edges include C++
	// struct/class types that define an operator(), Python classes that
	// define __call__, and so forth.
	//
	// A given node may be `callableas` several different `callable` nodes.
	// For example, if a struct S defines multiple overrides for
	// operator(), it will be `callableas` multiple nodes C0...CN. These
	// nodes will be distinguished by their type signatures. It's better to
	// use `callable` nodes in this set because they make the query more
	// specific.
	SemanticObject []string `protobuf:"bytes,1,rep,name=semantic_object" json:"semantic_object,omitempty"`
	// Expand the semantic_object set by including nodes that participate in
	// an `overrides` relationship (in either direction) with nodes in the set.
	//
	// In the program:
	//   struct A { virtual void f(); };
	//   struct B : public A { void f() override; };
	//   struct C : public B { void f() override; };
	//   void g(B* b) { b->f(); }
	//
	// we would return the following results (for queries on the singleton
	// semantic_object set containing A::f, B::f, or C::f):
	//
	// include_overrides  A::f  B::f  C::f
	//             false    {}   {g}    {}
	//              true   {g}   {g}   {g}
	IncludeOverrides bool `protobuf:"varint,2,opt,name=include_overrides,proto3" json:"include_overrides,omitempty"`
}

func (*CallersRequest) Descriptor added in v0.0.21

func (*CallersRequest) Descriptor() ([]byte, []int)

func (*CallersRequest) Marshal added in v0.0.19

func (m *CallersRequest) Marshal() (data []byte, err error)

func (*CallersRequest) MarshalTo added in v0.0.19

func (m *CallersRequest) MarshalTo(data []byte) (int, error)

func (*CallersRequest) ProtoMessage added in v0.0.19

func (*CallersRequest) ProtoMessage()

func (*CallersRequest) Reset added in v0.0.19

func (m *CallersRequest) Reset()

func (*CallersRequest) Size added in v0.0.19

func (m *CallersRequest) Size() (n int)

func (*CallersRequest) String added in v0.0.19

func (m *CallersRequest) String() string

func (*CallersRequest) Unmarshal added in v0.0.19

func (m *CallersRequest) Unmarshal(data []byte) error

type CrossReferencesReply added in v0.0.13

type CrossReferencesReply struct {
	// Total number of cross-references on all pages matching requested filters.
	TotalReferences int64 `protobuf:"varint,4,opt,name=total_references,proto3" json:"total_references,omitempty"`
	// Sets of cross-references for each requested node
	CrossReferences map[string]*CrossReferencesReply_CrossReferenceSet `` /* 159-byte string literal not displayed */
	// The facts left from the requested filters of the related node facts
	Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */
	// Map from the definition tickets referred to in each NodeInfo to their
	// Anchor.  This map will only be returned if the
	// CrossReferencesRequest.node_definitions switch is true.
	DefinitionLocations map[string]*Anchor `` /* 167-byte string literal not displayed */
	// If there are additional pages of cross-references after the ones returned
	// in this reply, next_page_token is the page token that may be passed to
	// fetch the next page in sequence after this one.  If there are no additional
	// cross-references, this field will be empty.
	NextPageToken string `protobuf:"bytes,10,opt,name=next_page_token,proto3" json:"next_page_token,omitempty"`
}

func (*CrossReferencesReply) Descriptor added in v0.0.21

func (*CrossReferencesReply) Descriptor() ([]byte, []int)

func (*CrossReferencesReply) GetCrossReferences added in v0.0.13

func (*CrossReferencesReply) GetDefinitionLocations added in v0.0.21

func (m *CrossReferencesReply) GetDefinitionLocations() map[string]*Anchor

func (*CrossReferencesReply) GetNodes added in v0.0.13

func (m *CrossReferencesReply) GetNodes() map[string]*NodeInfo

func (*CrossReferencesReply) Marshal added in v0.0.17

func (m *CrossReferencesReply) Marshal() (data []byte, err error)

func (*CrossReferencesReply) MarshalTo added in v0.0.17

func (m *CrossReferencesReply) MarshalTo(data []byte) (int, error)

func (*CrossReferencesReply) ProtoMessage added in v0.0.13

func (*CrossReferencesReply) ProtoMessage()

func (*CrossReferencesReply) Reset added in v0.0.13

func (m *CrossReferencesReply) Reset()

func (*CrossReferencesReply) Size added in v0.0.17

func (m *CrossReferencesReply) Size() (n int)

func (*CrossReferencesReply) String added in v0.0.13

func (m *CrossReferencesReply) String() string

func (*CrossReferencesReply) Unmarshal added in v0.0.17

func (m *CrossReferencesReply) Unmarshal(data []byte) error

type CrossReferencesReply_CrossReferenceSet added in v0.0.13

type CrossReferencesReply_CrossReferenceSet struct {
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// The set of definitions for the given node.
	Definition []*Anchor `protobuf:"bytes,2,rep,name=definition" json:"definition,omitempty"`
	// The set of declarations for the given node.
	Declaration []*Anchor `protobuf:"bytes,5,rep,name=declaration" json:"declaration,omitempty"`
	// The set of simple references for the given node.
	Reference []*Anchor `protobuf:"bytes,3,rep,name=reference" json:"reference,omitempty"`
	// The set of documentation for the given node.
	Documentation []*Anchor `protobuf:"bytes,4,rep,name=documentation" json:"documentation,omitempty"`
	// The set of related nodes to the given node.
	RelatedNode []*CrossReferencesReply_RelatedNode `protobuf:"bytes,10,rep,name=related_node" json:"related_node,omitempty"`
}

func (*CrossReferencesReply_CrossReferenceSet) Descriptor added in v0.0.21

func (*CrossReferencesReply_CrossReferenceSet) Descriptor() ([]byte, []int)

func (*CrossReferencesReply_CrossReferenceSet) GetDeclaration added in v0.0.21

func (m *CrossReferencesReply_CrossReferenceSet) GetDeclaration() []*Anchor

func (*CrossReferencesReply_CrossReferenceSet) GetDefinition added in v0.0.13

func (m *CrossReferencesReply_CrossReferenceSet) GetDefinition() []*Anchor

func (*CrossReferencesReply_CrossReferenceSet) GetDocumentation added in v0.0.13

func (m *CrossReferencesReply_CrossReferenceSet) GetDocumentation() []*Anchor

func (*CrossReferencesReply_CrossReferenceSet) GetReference added in v0.0.13

func (m *CrossReferencesReply_CrossReferenceSet) GetReference() []*Anchor

func (*CrossReferencesReply_CrossReferenceSet) GetRelatedNode added in v0.0.13

func (*CrossReferencesReply_CrossReferenceSet) Marshal added in v0.0.17

func (m *CrossReferencesReply_CrossReferenceSet) Marshal() (data []byte, err error)

func (*CrossReferencesReply_CrossReferenceSet) MarshalTo added in v0.0.17

func (m *CrossReferencesReply_CrossReferenceSet) MarshalTo(data []byte) (int, error)

func (*CrossReferencesReply_CrossReferenceSet) ProtoMessage added in v0.0.13

func (*CrossReferencesReply_CrossReferenceSet) Reset added in v0.0.13

func (*CrossReferencesReply_CrossReferenceSet) Size added in v0.0.17

func (*CrossReferencesReply_CrossReferenceSet) String added in v0.0.13

func (*CrossReferencesReply_CrossReferenceSet) Unmarshal added in v0.0.17

func (m *CrossReferencesReply_CrossReferenceSet) Unmarshal(data []byte) error

type CrossReferencesReply_RelatedNode added in v0.0.13

type CrossReferencesReply_RelatedNode struct {
	// Ticket of the node
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// Edge kind describing the node's relation
	RelationKind string `protobuf:"bytes,2,opt,name=relation_kind,proto3" json:"relation_kind,omitempty"`
	// Optional ordinal for edges of the same relation_kind.
	Ordinal int32 `protobuf:"varint,3,opt,name=ordinal,proto3" json:"ordinal,omitempty"`
}

func (*CrossReferencesReply_RelatedNode) Descriptor added in v0.0.21

func (*CrossReferencesReply_RelatedNode) Descriptor() ([]byte, []int)

func (*CrossReferencesReply_RelatedNode) Marshal added in v0.0.17

func (m *CrossReferencesReply_RelatedNode) Marshal() (data []byte, err error)

func (*CrossReferencesReply_RelatedNode) MarshalTo added in v0.0.17

func (m *CrossReferencesReply_RelatedNode) MarshalTo(data []byte) (int, error)

func (*CrossReferencesReply_RelatedNode) ProtoMessage added in v0.0.13

func (*CrossReferencesReply_RelatedNode) ProtoMessage()

func (*CrossReferencesReply_RelatedNode) Reset added in v0.0.13

func (*CrossReferencesReply_RelatedNode) Size added in v0.0.17

func (m *CrossReferencesReply_RelatedNode) Size() (n int)

func (*CrossReferencesReply_RelatedNode) String added in v0.0.13

func (*CrossReferencesReply_RelatedNode) Unmarshal added in v0.0.17

func (m *CrossReferencesReply_RelatedNode) Unmarshal(data []byte) error

type CrossReferencesRequest added in v0.0.13

type CrossReferencesRequest struct {
	// Set of nodes for which to return their cross-references.  Must be
	// non-empty.
	Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"`
	// Determines what kind of definition anchors, if any, should be returned in
	// the response.  See the documentation for each DefinitionKind for more
	// information.
	DefinitionKind CrossReferencesRequest_DefinitionKind `` /* 139-byte string literal not displayed */
	// Determines what kind of declaration anchors, if any, should be returned in
	// the response.  See the documentation for each DeclarationKind for more
	// information.
	DeclarationKind CrossReferencesRequest_DeclarationKind `` /* 142-byte string literal not displayed */
	// Determines what kind of reference anchors, if any, should be returned in
	// the response.  See the documentation for each ReferenceKind for more
	// information.
	ReferenceKind CrossReferencesRequest_ReferenceKind `` /* 136-byte string literal not displayed */
	// Determines what kind of documentation anchors, if any, should be returned
	// in the response.  See the documentation for each DocumentationKind for more
	// information.
	DocumentationKind CrossReferencesRequest_DocumentationKind `` /* 148-byte string literal not displayed */
	// Collection of filter globs that determines which facts will be returned for
	// the related nodes of each requested node.  If filter is empty or unset, no
	// node facts or related nodes are returned.  See EdgesRequest for the format
	// of the filter globs.
	Filter []string `protobuf:"bytes,5,rep,name=filter" json:"filter,omitempty"`
	// Determines whether each Anchor in the response should have its text field
	// populated.
	AnchorText bool `protobuf:"varint,6,opt,name=anchor_text,proto3" json:"anchor_text,omitempty"`
	// Determines whether each NodeInfo matching the above filters will have its
	// definition location populated, if known.
	NodeDefinitions bool `protobuf:"varint,8,opt,name=node_definitions,proto3" json:"node_definitions,omitempty"`
	// The cross-references matching a request are organized into logical pages.
	// The size of each page is a number of distinct cross-references
	// (definitions, references, documentation, and related nodes).
	//
	// If page_token is empty, cross-references will be returned starting at the
	// beginning of the sequence; otherwise the starting point named by the
	// page_token will be used.  Legal values of page_token are returned by the
	// server in the next_page_token field of the CrossReferencesReply.  A page
	// token should be treated as an opaque value by the client, and is valid only
	// relative to a particular CrossReferencesRequest.  If an invalid page token
	// is requested, the server will return an error.
	//
	// If page_size > 0, at most that number of cross-references will be returned
	// by the service for this request (see ReferenceSet and CrossReferencesReply
	// below).  If page_size = 0, the default, the server will assume a reasonable
	// default page size.  The server will return an error if page_size < 0.
	//
	// The server is allowed to return fewer cross-references than the requested
	// page_size, even if more are available, save that it must return at least 1
	// edge if any are available at all.
	PageSize  int32  `protobuf:"varint,10,opt,name=page_size,proto3" json:"page_size,omitempty"`
	PageToken string `protobuf:"bytes,11,opt,name=page_token,proto3" json:"page_token,omitempty"`
}

func (*CrossReferencesRequest) Descriptor added in v0.0.21

func (*CrossReferencesRequest) Descriptor() ([]byte, []int)

func (*CrossReferencesRequest) Marshal added in v0.0.17

func (m *CrossReferencesRequest) Marshal() (data []byte, err error)

func (*CrossReferencesRequest) MarshalTo added in v0.0.17

func (m *CrossReferencesRequest) MarshalTo(data []byte) (int, error)

func (*CrossReferencesRequest) ProtoMessage added in v0.0.13

func (*CrossReferencesRequest) ProtoMessage()

func (*CrossReferencesRequest) Reset added in v0.0.13

func (m *CrossReferencesRequest) Reset()

func (*CrossReferencesRequest) Size added in v0.0.17

func (m *CrossReferencesRequest) Size() (n int)

func (*CrossReferencesRequest) String added in v0.0.13

func (m *CrossReferencesRequest) String() string

func (*CrossReferencesRequest) Unmarshal added in v0.0.17

func (m *CrossReferencesRequest) Unmarshal(data []byte) error

type CrossReferencesRequest_DeclarationKind added in v0.0.21

type CrossReferencesRequest_DeclarationKind int32
const (
	// No declarations will be populated in the CrossDeclarationsReply.
	CrossReferencesRequest_NO_DECLARATIONS CrossReferencesRequest_DeclarationKind = 0
	// When the source node is incomplete, all known declaration anchors reached
	// by the "/kythe/edge/defines" edge kind (or its variants) will be
	// populated in the CrossDeclarationsReply.
	CrossReferencesRequest_ALL_DECLARATIONS CrossReferencesRequest_DeclarationKind = 1
)

func (CrossReferencesRequest_DeclarationKind) EnumDescriptor added in v0.0.21

func (CrossReferencesRequest_DeclarationKind) EnumDescriptor() ([]byte, []int)

func (CrossReferencesRequest_DeclarationKind) String added in v0.0.21

type CrossReferencesRequest_DefinitionKind added in v0.0.13

type CrossReferencesRequest_DefinitionKind int32
const (
	// No definitions will be populated in the CrossReferencesReply.
	CrossReferencesRequest_NO_DEFINITIONS CrossReferencesRequest_DefinitionKind = 0
	// All known definition anchors reached by the "/kythe/edge/defines" edge
	// kind (or its variants) will be populated in the CrossReferencesReply.
	CrossReferencesRequest_ALL_DEFINITIONS CrossReferencesRequest_DefinitionKind = 1
	// Only definition anchors reached by the "/kythe/edge/defines" edge kind
	// will be populated in the CrossReferencesReply.
	CrossReferencesRequest_FULL_DEFINITIONS CrossReferencesRequest_DefinitionKind = 2
	// Only definition anchors reached by the "/kythe/edge/defines/binding" edge
	// kind will be populated in the CrossReferencesReply.
	CrossReferencesRequest_BINDING_DEFINITIONS CrossReferencesRequest_DefinitionKind = 3
)

func (CrossReferencesRequest_DefinitionKind) EnumDescriptor added in v0.0.21

func (CrossReferencesRequest_DefinitionKind) EnumDescriptor() ([]byte, []int)

func (CrossReferencesRequest_DefinitionKind) String added in v0.0.13

type CrossReferencesRequest_DocumentationKind added in v0.0.13

type CrossReferencesRequest_DocumentationKind int32
const (
	// No documentation will be populated in the CrossReferencesReply.
	CrossReferencesRequest_NO_DOCUMENTATION CrossReferencesRequest_DocumentationKind = 0
	// All known documentation reached by the "/kythe/edge/documentation" edge
	// kind (or its variants) will be populated in the CrossReferencesReply.
	CrossReferencesRequest_ALL_DOCUMENTATION CrossReferencesRequest_DocumentationKind = 1
)

func (CrossReferencesRequest_DocumentationKind) EnumDescriptor added in v0.0.21

func (CrossReferencesRequest_DocumentationKind) EnumDescriptor() ([]byte, []int)

func (CrossReferencesRequest_DocumentationKind) String added in v0.0.13

type CrossReferencesRequest_ReferenceKind added in v0.0.13

type CrossReferencesRequest_ReferenceKind int32
const (
	// No references will be populated in the CrossReferencesReply.
	CrossReferencesRequest_NO_REFERENCES CrossReferencesRequest_ReferenceKind = 0
	// All known reference anchors reached by the "/kythe/edge/ref" edge kind
	// (or its variants) will be populated in the CrossReferencesReply.
	CrossReferencesRequest_ALL_REFERENCES CrossReferencesRequest_ReferenceKind = 1
)

func (CrossReferencesRequest_ReferenceKind) EnumDescriptor added in v0.0.21

func (CrossReferencesRequest_ReferenceKind) EnumDescriptor() ([]byte, []int)

func (CrossReferencesRequest_ReferenceKind) String added in v0.0.13

type DecorationsReply

type DecorationsReply struct {
	// The normalized location for which decorations are returned.
	Location *Location `protobuf:"bytes,1,opt,name=location" json:"location,omitempty"`
	// The encoded source text for the selected window.
	SourceText []byte `protobuf:"bytes,2,opt,name=source_text,proto3" json:"source_text,omitempty"`
	Encoding   string `protobuf:"bytes,3,opt,name=encoding,proto3" json:"encoding,omitempty"`
	// The reference edges located in the specified window.
	Reference []*DecorationsReply_Reference `protobuf:"bytes,4,rep,name=reference" json:"reference,omitempty"`
	// This field will contain one entry, keyed by ticket, for each distinct node
	// referenced by a reference edge that has at least 1 non-filtered fact.
	Nodes map[string]*NodeInfo `` /* 138-byte string literal not displayed */
	// Each anchor cited as a target definition in the references.  The map is
	// keyed by each anchor's ticket.
	DefinitionLocations map[string]*Anchor `` /* 168-byte string literal not displayed */
}

func (*DecorationsReply) Descriptor added in v0.0.21

func (*DecorationsReply) Descriptor() ([]byte, []int)

func (*DecorationsReply) GetDefinitionLocations added in v0.0.21

func (m *DecorationsReply) GetDefinitionLocations() map[string]*Anchor

func (*DecorationsReply) GetLocation

func (m *DecorationsReply) GetLocation() *Location

func (*DecorationsReply) GetNodes added in v0.0.22

func (m *DecorationsReply) GetNodes() map[string]*NodeInfo

func (*DecorationsReply) GetReference

func (m *DecorationsReply) GetReference() []*DecorationsReply_Reference

func (*DecorationsReply) Marshal added in v0.0.17

func (m *DecorationsReply) Marshal() (data []byte, err error)

func (*DecorationsReply) MarshalTo added in v0.0.17

func (m *DecorationsReply) MarshalTo(data []byte) (int, error)

func (*DecorationsReply) ProtoMessage

func (*DecorationsReply) ProtoMessage()

func (*DecorationsReply) Reset

func (m *DecorationsReply) Reset()

func (*DecorationsReply) Size added in v0.0.17

func (m *DecorationsReply) Size() (n int)

func (*DecorationsReply) String

func (m *DecorationsReply) String() string

func (*DecorationsReply) Unmarshal added in v0.0.17

func (m *DecorationsReply) Unmarshal(data []byte) error

type DecorationsReply_Reference

type DecorationsReply_Reference struct {
	SourceTicket string `protobuf:"bytes,1,opt,name=source_ticket,proto3" json:"source_ticket,omitempty"`
	TargetTicket string `protobuf:"bytes,2,opt,name=target_ticket,proto3" json:"target_ticket,omitempty"`
	Kind         string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// Starting byte offset of this references's anchor (source_ticket) span.
	AnchorStart *Location_Point `protobuf:"bytes,10,opt,name=anchor_start" json:"anchor_start,omitempty"`
	// Ending byte offset of this references's anchor (source_ticket) span.
	AnchorEnd *Location_Point `protobuf:"bytes,11,opt,name=anchor_end" json:"anchor_end,omitempty"`
	// Anchor ticket of the target's definition.  Populated only if
	// target_definitions is true in the DecorationsRequest and the target has
	// a single unambiguous definition.  For each ticket, an Anchor will be
	// populated in the top-level definition_locations map.
	TargetDefinition string `protobuf:"bytes,4,opt,name=target_definition,proto3" json:"target_definition,omitempty"`
}

Represents a reference edge source ---KIND---> target. Each source is an anchor within the requested source location.

func (*DecorationsReply_Reference) Descriptor added in v0.0.21

func (*DecorationsReply_Reference) Descriptor() ([]byte, []int)

func (*DecorationsReply_Reference) GetAnchorEnd added in v0.0.9

func (m *DecorationsReply_Reference) GetAnchorEnd() *Location_Point

func (*DecorationsReply_Reference) GetAnchorStart added in v0.0.9

func (m *DecorationsReply_Reference) GetAnchorStart() *Location_Point

func (*DecorationsReply_Reference) Marshal added in v0.0.17

func (m *DecorationsReply_Reference) Marshal() (data []byte, err error)

func (*DecorationsReply_Reference) MarshalTo added in v0.0.17

func (m *DecorationsReply_Reference) MarshalTo(data []byte) (int, error)

func (*DecorationsReply_Reference) ProtoMessage

func (*DecorationsReply_Reference) ProtoMessage()

func (*DecorationsReply_Reference) Reset

func (m *DecorationsReply_Reference) Reset()

func (*DecorationsReply_Reference) Size added in v0.0.17

func (m *DecorationsReply_Reference) Size() (n int)

func (*DecorationsReply_Reference) String

func (m *DecorationsReply_Reference) String() string

func (*DecorationsReply_Reference) Unmarshal added in v0.0.17

func (m *DecorationsReply_Reference) Unmarshal(data []byte) error

type DecorationsRequest

type DecorationsRequest struct {
	// The location of the file to fetch decorations for.  The ticket of location
	// must be non-empty.  It is an error in any case if location is invalid.
	Location *Location `protobuf:"bytes,1,opt,name=location" json:"location,omitempty"`
	// How to treat SPAN locations.
	SpanKind DecorationsRequest_SpanKind `protobuf:"varint,10,opt,name=span_kind,proto3,enum=kythe.proto.DecorationsRequest_SpanKind" json:"span_kind,omitempty"`
	// If dirty_buffer is non-empty, the results will be adjusted (patched) to
	// account for the regions of the specified file differing from the contents
	// of the dirty buffer.
	DirtyBuffer []byte `protobuf:"bytes,2,opt,name=dirty_buffer,proto3" json:"dirty_buffer,omitempty"`
	// If true, return the encoded source text for the selected window.  Source
	// text is not affected by patching.
	SourceText bool `protobuf:"varint,3,opt,name=source_text,proto3" json:"source_text,omitempty"`
	// If true, return reference edges whose source nodes are located in the
	// selected window.  References are affected by patching.
	References bool `protobuf:"varint,4,opt,name=references,proto3" json:"references,omitempty"`
	// If true, return definition locations, if possible, for each returned
	// reference target in the DecorationsReply.
	TargetDefinitions bool `protobuf:"varint,6,opt,name=target_definitions,proto3" json:"target_definitions,omitempty"`
	// A collection of filter globs that specify which facts (by name) should be
	// returned for each node.  If filter is empty or unset, no node facts are
	// returned.  The filter applies to ALL referenced nodes.  See EdgesRequest
	// for the format of the filter globs.
	Filter []string `protobuf:"bytes,5,rep,name=filter" json:"filter,omitempty"`
}

func (*DecorationsRequest) Descriptor added in v0.0.21

func (*DecorationsRequest) Descriptor() ([]byte, []int)

func (*DecorationsRequest) GetLocation

func (m *DecorationsRequest) GetLocation() *Location

func (*DecorationsRequest) Marshal added in v0.0.17

func (m *DecorationsRequest) Marshal() (data []byte, err error)

func (*DecorationsRequest) MarshalTo added in v0.0.17

func (m *DecorationsRequest) MarshalTo(data []byte) (int, error)

func (*DecorationsRequest) ProtoMessage

func (*DecorationsRequest) ProtoMessage()

func (*DecorationsRequest) Reset

func (m *DecorationsRequest) Reset()

func (*DecorationsRequest) Size added in v0.0.17

func (m *DecorationsRequest) Size() (n int)

func (*DecorationsRequest) String

func (m *DecorationsRequest) String() string

func (*DecorationsRequest) Unmarshal added in v0.0.17

func (m *DecorationsRequest) Unmarshal(data []byte) error

type DecorationsRequest_SpanKind added in v0.0.21

type DecorationsRequest_SpanKind int32
const (
	// If the location is a SPAN, only decorations contained within the
	// specified window of the file are returned.  This is the default behavior.
	DecorationsRequest_WITHIN_SPAN DecorationsRequest_SpanKind = 0
	// If the location is a SPAN, any decorations that surround it are returned.
	DecorationsRequest_AROUND_SPAN DecorationsRequest_SpanKind = 1
)

func (DecorationsRequest_SpanKind) EnumDescriptor added in v0.0.21

func (DecorationsRequest_SpanKind) EnumDescriptor() ([]byte, []int)

func (DecorationsRequest_SpanKind) String added in v0.0.21

type DocumentationReply added in v0.0.21

type DocumentationReply struct {
	Document []*DocumentationReply_Document `protobuf:"bytes,1,rep,name=document" json:"document,omitempty"`
}

func (*DocumentationReply) Descriptor added in v0.0.21

func (*DocumentationReply) Descriptor() ([]byte, []int)

func (*DocumentationReply) GetDocument added in v0.0.21

func (m *DocumentationReply) GetDocument() []*DocumentationReply_Document

func (*DocumentationReply) Marshal added in v0.0.21

func (m *DocumentationReply) Marshal() (data []byte, err error)

func (*DocumentationReply) MarshalTo added in v0.0.21

func (m *DocumentationReply) MarshalTo(data []byte) (int, error)

func (*DocumentationReply) ProtoMessage added in v0.0.21

func (*DocumentationReply) ProtoMessage()

func (*DocumentationReply) Reset added in v0.0.21

func (m *DocumentationReply) Reset()

func (*DocumentationReply) Size added in v0.0.21

func (m *DocumentationReply) Size() (n int)

func (*DocumentationReply) String added in v0.0.21

func (m *DocumentationReply) String() string

func (*DocumentationReply) Unmarshal added in v0.0.21

func (m *DocumentationReply) Unmarshal(data []byte) error

type DocumentationReply_Document added in v0.0.21

type DocumentationReply_Document struct {
	// The ticket to which this Document refers.
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// Documentation that can be displayed to the user.
	Text *DocumentationReply_Printable `protobuf:"bytes,2,opt,name=text" json:"text,omitempty"`
	// A signature that can be displayed to the user. For variables, this
	// may just be the variable name; for functions, this may be some version
	// of the function prototype.
	Signature *DocumentationReply_Printable `protobuf:"bytes,3,opt,name=signature" json:"signature,omitempty"`
	// The type as a signature that can be displayed to the user.
	Type *DocumentationReply_Printable `protobuf:"bytes,4,opt,name=type" json:"type,omitempty"`
	// The initialization value, if any.
	Initializer *DocumentationReply_Printable `protobuf:"bytes,5,opt,name=initializer" json:"initializer,omitempty"`
	// The semantic parent of this value.
	DefinedBy *DocumentationReply_Printable `protobuf:"bytes,6,opt,name=defined_by" json:"defined_by,omitempty"`
	// The node kind being defined.
	Kind string `protobuf:"bytes,7,opt,name=kind,proto3" json:"kind,omitempty"`
}

func (*DocumentationReply_Document) Descriptor added in v0.0.21

func (*DocumentationReply_Document) Descriptor() ([]byte, []int)

func (*DocumentationReply_Document) GetDefinedBy added in v0.0.21

func (*DocumentationReply_Document) GetInitializer added in v0.0.21

func (*DocumentationReply_Document) GetSignature added in v0.0.21

func (*DocumentationReply_Document) GetText added in v0.0.21

func (*DocumentationReply_Document) GetType added in v0.0.21

func (*DocumentationReply_Document) Marshal added in v0.0.21

func (m *DocumentationReply_Document) Marshal() (data []byte, err error)

func (*DocumentationReply_Document) MarshalTo added in v0.0.21

func (m *DocumentationReply_Document) MarshalTo(data []byte) (int, error)

func (*DocumentationReply_Document) ProtoMessage added in v0.0.21

func (*DocumentationReply_Document) ProtoMessage()

func (*DocumentationReply_Document) Reset added in v0.0.21

func (m *DocumentationReply_Document) Reset()

func (*DocumentationReply_Document) Size added in v0.0.21

func (m *DocumentationReply_Document) Size() (n int)

func (*DocumentationReply_Document) String added in v0.0.21

func (m *DocumentationReply_Document) String() string

func (*DocumentationReply_Document) Unmarshal added in v0.0.21

func (m *DocumentationReply_Document) Unmarshal(data []byte) error
type DocumentationReply_Link struct {
	// Definition sites found for some ticket.
	Definition []*Anchor `protobuf:"bytes,1,rep,name=definition" json:"definition,omitempty"`
}

func (*DocumentationReply_Link) Descriptor added in v0.0.21

func (*DocumentationReply_Link) Descriptor() ([]byte, []int)

func (*DocumentationReply_Link) GetDefinition added in v0.0.21

func (m *DocumentationReply_Link) GetDefinition() []*Anchor

func (*DocumentationReply_Link) Marshal added in v0.0.21

func (m *DocumentationReply_Link) Marshal() (data []byte, err error)

func (*DocumentationReply_Link) MarshalTo added in v0.0.21

func (m *DocumentationReply_Link) MarshalTo(data []byte) (int, error)

func (*DocumentationReply_Link) ProtoMessage added in v0.0.21

func (*DocumentationReply_Link) ProtoMessage()

func (*DocumentationReply_Link) Reset added in v0.0.21

func (m *DocumentationReply_Link) Reset()

func (*DocumentationReply_Link) Size added in v0.0.21

func (m *DocumentationReply_Link) Size() (n int)

func (*DocumentationReply_Link) String added in v0.0.21

func (m *DocumentationReply_Link) String() string

func (*DocumentationReply_Link) Unmarshal added in v0.0.21

func (m *DocumentationReply_Link) Unmarshal(data []byte) error

type DocumentationReply_Printable added in v0.0.21

type DocumentationReply_Printable struct {
	// Raw text that can be displayed to the user (but may also contain
	// markup that can be interpreted, like Doxygen comments). Links are
	// marked using []. \ is an escape character (where possible escape
	// sequences are \[, \], and \\).
	RawText string `protobuf:"bytes,1,opt,name=raw_text,proto3" json:"raw_text,omitempty"`
	// Destinations for links in raw_text. The ith Link corresponds to the link
	// starting at the ith [.
	Link []*DocumentationReply_Link `protobuf:"bytes,2,rep,name=link" json:"link,omitempty"`
}

func (*DocumentationReply_Printable) Descriptor added in v0.0.21

func (*DocumentationReply_Printable) Descriptor() ([]byte, []int)

func (*DocumentationReply_Printable) Marshal added in v0.0.21

func (m *DocumentationReply_Printable) Marshal() (data []byte, err error)

func (*DocumentationReply_Printable) MarshalTo added in v0.0.21

func (m *DocumentationReply_Printable) MarshalTo(data []byte) (int, error)

func (*DocumentationReply_Printable) ProtoMessage added in v0.0.21

func (*DocumentationReply_Printable) ProtoMessage()

func (*DocumentationReply_Printable) Reset added in v0.0.21

func (m *DocumentationReply_Printable) Reset()

func (*DocumentationReply_Printable) Size added in v0.0.21

func (m *DocumentationReply_Printable) Size() (n int)

func (*DocumentationReply_Printable) String added in v0.0.21

func (*DocumentationReply_Printable) Unmarshal added in v0.0.21

func (m *DocumentationReply_Printable) Unmarshal(data []byte) error

type DocumentationRequest added in v0.0.21

type DocumentationRequest struct {
	// Semantic tickets about which documentation is sought.
	Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"`
}

func (*DocumentationRequest) Descriptor added in v0.0.21

func (*DocumentationRequest) Descriptor() ([]byte, []int)

func (*DocumentationRequest) Marshal added in v0.0.21

func (m *DocumentationRequest) Marshal() (data []byte, err error)

func (*DocumentationRequest) MarshalTo added in v0.0.21

func (m *DocumentationRequest) MarshalTo(data []byte) (int, error)

func (*DocumentationRequest) ProtoMessage added in v0.0.21

func (*DocumentationRequest) ProtoMessage()

func (*DocumentationRequest) Reset added in v0.0.21

func (m *DocumentationRequest) Reset()

func (*DocumentationRequest) Size added in v0.0.21

func (m *DocumentationRequest) Size() (n int)

func (*DocumentationRequest) String added in v0.0.21

func (m *DocumentationRequest) String() string

func (*DocumentationRequest) Unmarshal added in v0.0.21

func (m *DocumentationRequest) Unmarshal(data []byte) error

type EdgeSet

type EdgeSet struct {
	// Each group is a collection of outbound edges from source node sharing a
	// given kind, the map's keys.  In a given EdgeSet, the server will not send
	// more than one group with the same kind label.
	Groups map[string]*EdgeSet_Group `` /* 139-byte string literal not displayed */
}

An EdgeSet represents a collection of edges outbound from a single node. The edges are organized into groups, each sharing a common edge kind.

The number of edges represented by an EdgeSet es, denoted len(es), is the sum of the lengths of the repeated edge fields for all the groups in the EdgeSet. This count is used to determine page size in a request.

func (*EdgeSet) Descriptor added in v0.0.21

func (*EdgeSet) Descriptor() ([]byte, []int)

func (*EdgeSet) GetGroups added in v0.0.22

func (m *EdgeSet) GetGroups() map[string]*EdgeSet_Group

func (*EdgeSet) Marshal added in v0.0.17

func (m *EdgeSet) Marshal() (data []byte, err error)

func (*EdgeSet) MarshalTo added in v0.0.17

func (m *EdgeSet) MarshalTo(data []byte) (int, error)

func (*EdgeSet) ProtoMessage

func (*EdgeSet) ProtoMessage()

func (*EdgeSet) Reset

func (m *EdgeSet) Reset()

func (*EdgeSet) Size added in v0.0.17

func (m *EdgeSet) Size() (n int)

func (*EdgeSet) String

func (m *EdgeSet) String() string

func (*EdgeSet) Unmarshal added in v0.0.17

func (m *EdgeSet) Unmarshal(data []byte) error

type EdgeSet_Group

type EdgeSet_Group struct {
	Edge []*EdgeSet_Group_Edge `protobuf:"bytes,2,rep,name=edge" json:"edge,omitempty"`
}

func (*EdgeSet_Group) Descriptor added in v0.0.21

func (*EdgeSet_Group) Descriptor() ([]byte, []int)

func (*EdgeSet_Group) GetEdge added in v0.0.21

func (m *EdgeSet_Group) GetEdge() []*EdgeSet_Group_Edge

func (*EdgeSet_Group) Marshal added in v0.0.17

func (m *EdgeSet_Group) Marshal() (data []byte, err error)

func (*EdgeSet_Group) MarshalTo added in v0.0.17

func (m *EdgeSet_Group) MarshalTo(data []byte) (int, error)

func (*EdgeSet_Group) ProtoMessage

func (*EdgeSet_Group) ProtoMessage()

func (*EdgeSet_Group) Reset

func (m *EdgeSet_Group) Reset()

func (*EdgeSet_Group) Size added in v0.0.17

func (m *EdgeSet_Group) Size() (n int)

func (*EdgeSet_Group) String

func (m *EdgeSet_Group) String() string

func (*EdgeSet_Group) Unmarshal added in v0.0.17

func (m *EdgeSet_Group) Unmarshal(data []byte) error

type EdgeSet_Group_Edge added in v0.0.21

type EdgeSet_Group_Edge struct {
	TargetTicket string `protobuf:"bytes,1,opt,name=target_ticket,proto3" json:"target_ticket,omitempty"`
	// An optional integer to give an ordering between multiple edges of same
	// source and kind to one or more targets.  See https://kythe.io/schema
	// for when ordinals are used for a given edge kind.
	Ordinal int32 `protobuf:"varint,2,opt,name=ordinal,proto3" json:"ordinal,omitempty"`
}

func (*EdgeSet_Group_Edge) Descriptor added in v0.0.21

func (*EdgeSet_Group_Edge) Descriptor() ([]byte, []int)

func (*EdgeSet_Group_Edge) Marshal added in v0.0.21

func (m *EdgeSet_Group_Edge) Marshal() (data []byte, err error)

func (*EdgeSet_Group_Edge) MarshalTo added in v0.0.21

func (m *EdgeSet_Group_Edge) MarshalTo(data []byte) (int, error)

func (*EdgeSet_Group_Edge) ProtoMessage added in v0.0.21

func (*EdgeSet_Group_Edge) ProtoMessage()

func (*EdgeSet_Group_Edge) Reset added in v0.0.21

func (m *EdgeSet_Group_Edge) Reset()

func (*EdgeSet_Group_Edge) Size added in v0.0.21

func (m *EdgeSet_Group_Edge) Size() (n int)

func (*EdgeSet_Group_Edge) String added in v0.0.21

func (m *EdgeSet_Group_Edge) String() string

func (*EdgeSet_Group_Edge) Unmarshal added in v0.0.21

func (m *EdgeSet_Group_Edge) Unmarshal(data []byte) error

type EdgesReply

type EdgesReply struct {
	// This field will contain one EdgeSet for each source node with one or more
	// matching outbound edges, keyed by the source node's ticket.  The number of
	// edges represented by an EdgesReply er, denoted len(er), is the sum of
	// len(es) for each es in edge_sets.  This count is used to determine the page
	// size.
	EdgeSets map[string]*EdgeSet `` /* 145-byte string literal not displayed */
	// This field will contain one entry, keyed by ticket, for each distinct node
	// referenced by some edge in edgesets, for which there is one or more
	// matching facts.
	//
	// Rationale: This prevents us from having to copy the data to all the end
	// nodes, but allows the client to have that information without making
	// additional requests.
	Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */
	// Total number of edges on all pages matching requested kinds.
	TotalEdges int64 `protobuf:"varint,3,opt,name=total_edges,proto3" json:"total_edges,omitempty"`
	// If there are additional pages of edges after the ones returned in this
	// reply, next_page_token is the page token that may be passed to fetch the
	// next page in sequence after this one.  If there are no additional edges,
	// this field will be empty.
	NextPageToken string `protobuf:"bytes,9,opt,name=next_page_token,proto3" json:"next_page_token,omitempty"`
}

func (*EdgesReply) Descriptor added in v0.0.21

func (*EdgesReply) Descriptor() ([]byte, []int)

func (*EdgesReply) GetEdgeSets added in v0.0.22

func (m *EdgesReply) GetEdgeSets() map[string]*EdgeSet

func (*EdgesReply) GetNodes added in v0.0.22

func (m *EdgesReply) GetNodes() map[string]*NodeInfo

func (*EdgesReply) Marshal added in v0.0.17

func (m *EdgesReply) Marshal() (data []byte, err error)

func (*EdgesReply) MarshalTo added in v0.0.17

func (m *EdgesReply) MarshalTo(data []byte) (int, error)

func (*EdgesReply) ProtoMessage

func (*EdgesReply) ProtoMessage()

func (*EdgesReply) Reset

func (m *EdgesReply) Reset()

func (*EdgesReply) Size added in v0.0.17

func (m *EdgesReply) Size() (n int)

func (*EdgesReply) String

func (m *EdgesReply) String() string

func (*EdgesReply) Unmarshal added in v0.0.17

func (m *EdgesReply) Unmarshal(data []byte) error

type EdgesRequest

type EdgesRequest struct {
	// The tickets of the source nodes for which edges are requested.
	// The service will return an error if no tickets are specified.
	Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"`
	// The kinds of outbound edges that should be returned for each matching
	// source node.  If empty, all available edge kinds are returned.
	Kind []string `protobuf:"bytes,2,rep,name=kind" json:"kind,omitempty"`
	// A collection of filter globs that specify which facts (by name) should be
	// returned for the target node of each matching edge.  If filter is empty,
	// no facts are returned.
	//
	// The supported glob operators are:
	//   *   zero or more non-slash characters ([^/]*)
	//   ?   any single non-slash character ([^/])
	//   **  zero or more of any character (.*)
	//
	// All other characters match literally, and the glob must consume the entire
	// name in order to match.  The facts returned are the union of those matched
	// by all the globs provided.
	Filter []string `protobuf:"bytes,3,rep,name=filter" json:"filter,omitempty"`
	// The edges matching a request are organized into logical pages.  The size
	// of each page is a number of distinct edges.  Notionally: All the matching
	// edges are ordered lexicographically by (start_ticket, kind, end_ticket);
	// the page_token determines where in the ordering to start, and page_size
	// determines how many edges should be returned.
	//
	// If page_token is empty, edges will be returned starting at the beginning
	// of the sequence; otherwise the starting point named by the page_token will
	// be used.  Legal values of page_token are returned by the server in the
	// next_page_token field of the EdgesReply.  A page token should be treated
	// as an opaque value by the client, and is valid only relative to a
	// particular set of tickets and kinds.  If an invalid page token is
	// requested, the server will return an error.
	//
	// If page_size > 0, at most that number of edges will be returned by the
	// service for this request (see EdgeSet and EdgesReply below).
	// If page_size = 0, the default, the server will assume a reasonable default
	// page size.  The server will return an error if page_size < 0.
	//
	// The server is allowed to return fewer edges than the requested page_size,
	// even if more are available, save that it must return at least 1 edge if
	// any are available at all.
	PageSize  int32  `protobuf:"varint,8,opt,name=page_size,proto3" json:"page_size,omitempty"`
	PageToken string `protobuf:"bytes,9,opt,name=page_token,proto3" json:"page_token,omitempty"`
}

func (*EdgesRequest) Descriptor added in v0.0.21

func (*EdgesRequest) Descriptor() ([]byte, []int)

func (*EdgesRequest) Marshal added in v0.0.17

func (m *EdgesRequest) Marshal() (data []byte, err error)

func (*EdgesRequest) MarshalTo added in v0.0.17

func (m *EdgesRequest) MarshalTo(data []byte) (int, error)

func (*EdgesRequest) ProtoMessage

func (*EdgesRequest) ProtoMessage()

func (*EdgesRequest) Reset

func (m *EdgesRequest) Reset()

func (*EdgesRequest) Size added in v0.0.17

func (m *EdgesRequest) Size() (n int)

func (*EdgesRequest) String

func (m *EdgesRequest) String() string

func (*EdgesRequest) Unmarshal added in v0.0.17

func (m *EdgesRequest) Unmarshal(data []byte) error

type Location

type Location struct {
	// The ticket of the file this location belongs to.  If the location
	// represents a memory buffer, the ticket should be omitted.
	Ticket string `protobuf:"bytes,1,opt,name=ticket,proto3" json:"ticket,omitempty"`
	// What kind of location this is.
	Kind Location_Kind `protobuf:"varint,2,opt,name=kind,proto3,enum=kythe.proto.Location_Kind" json:"kind,omitempty"`
	// The starting point of the location.
	Start *Location_Point `protobuf:"bytes,3,opt,name=start" json:"start,omitempty"`
	// The ending point of the location.
	End *Location_Point `protobuf:"bytes,4,opt,name=end" json:"end,omitempty"`
}

A Location represents a single span of zero or more contiguous bytes of a file or buffer. An empty LOCATION denotes the entirety of the referenced file or buffer.

func (*Location) Descriptor added in v0.0.21

func (*Location) Descriptor() ([]byte, []int)

func (*Location) GetEnd

func (m *Location) GetEnd() *Location_Point

func (*Location) GetStart

func (m *Location) GetStart() *Location_Point

func (*Location) Marshal added in v0.0.17

func (m *Location) Marshal() (data []byte, err error)

func (*Location) MarshalTo added in v0.0.17

func (m *Location) MarshalTo(data []byte) (int, error)

func (*Location) ProtoMessage

func (*Location) ProtoMessage()

func (*Location) Reset

func (m *Location) Reset()

func (*Location) Size added in v0.0.17

func (m *Location) Size() (n int)

func (*Location) String

func (m *Location) String() string

func (*Location) Unmarshal added in v0.0.17

func (m *Location) Unmarshal(data []byte) error

type Location_Kind

type Location_Kind int32
const (
	// The entire file; the start and end fields are ignored.
	Location_FILE Location_Kind = 0
	// The point or span of file subtended by start and end.
	Location_SPAN Location_Kind = 1
)

func (Location_Kind) EnumDescriptor added in v0.0.21

func (Location_Kind) EnumDescriptor() ([]byte, []int)

func (Location_Kind) String

func (x Location_Kind) String() string

type Location_Point

type Location_Point struct {
	// The offset in bytes from the beginning of the file.
	// Requires 0 ≤ byte_offset ≤ len(file).
	ByteOffset int32 `protobuf:"varint,1,opt,name=byte_offset,proto3" json:"byte_offset,omitempty"`
	// The line number containing the point, 1-based.
	LineNumber int32 `protobuf:"varint,2,opt,name=line_number,proto3" json:"line_number,omitempty"`
	// The byte offset of the point within its line.
	ColumnOffset int32 `protobuf:"varint,3,opt,name=column_offset,proto3" json:"column_offset,omitempty"`
}

A Point represents a location within a file or buffer.

If line_number ≤ 0, the line number and column offset are considered unknown and will be ignored.

A point with line_number > 0 is said to be _normalized_ if it satisfies the constraint 0 ≤ column_offset ≤ bytelen(line_number); that is, if the column_offset is within the actual range of the corresponding line. A point can be normalized by adjusting line_number and column_offset so that this constraint is satisfied. This may be impossible if the column offset exceeds the bounds of the file.

func (*Location_Point) Descriptor added in v0.0.21

func (*Location_Point) Descriptor() ([]byte, []int)

func (*Location_Point) Marshal added in v0.0.17

func (m *Location_Point) Marshal() (data []byte, err error)

func (*Location_Point) MarshalTo added in v0.0.17

func (m *Location_Point) MarshalTo(data []byte) (int, error)

func (*Location_Point) ProtoMessage

func (*Location_Point) ProtoMessage()

func (*Location_Point) Reset

func (m *Location_Point) Reset()

func (*Location_Point) Size added in v0.0.17

func (m *Location_Point) Size() (n int)

func (*Location_Point) String

func (m *Location_Point) String() string

func (*Location_Point) Unmarshal added in v0.0.17

func (m *Location_Point) Unmarshal(data []byte) error

type NodeInfo

type NodeInfo struct {
	// The matching facts known for that node, a map from fact name to value.
	Facts map[string][]byte `` /* 144-byte string literal not displayed */
	// If known and unambiguous, an anchor ticket for this node's definition
	// location.
	Definition string `protobuf:"bytes,5,opt,name=definition,proto3" json:"definition,omitempty"`
}

func (*NodeInfo) Descriptor added in v0.0.21

func (*NodeInfo) Descriptor() ([]byte, []int)

func (*NodeInfo) GetFacts added in v0.0.22

func (m *NodeInfo) GetFacts() map[string][]byte

func (*NodeInfo) Marshal added in v0.0.17

func (m *NodeInfo) Marshal() (data []byte, err error)

func (*NodeInfo) MarshalTo added in v0.0.17

func (m *NodeInfo) MarshalTo(data []byte) (int, error)

func (*NodeInfo) ProtoMessage

func (*NodeInfo) ProtoMessage()

func (*NodeInfo) Reset

func (m *NodeInfo) Reset()

func (*NodeInfo) Size added in v0.0.17

func (m *NodeInfo) Size() (n int)

func (*NodeInfo) String

func (m *NodeInfo) String() string

func (*NodeInfo) Unmarshal added in v0.0.17

func (m *NodeInfo) Unmarshal(data []byte) error

type NodesReply

type NodesReply struct {
	// One NodeInfo, keyed by its ticket, is returned for each requested node
	// that had a non-zero number of matching facts.  Each NodeInfo will not have
	// its ticket set since it would just be a copy of the map keys.
	Nodes map[string]*NodeInfo `` /* 137-byte string literal not displayed */
}

func (*NodesReply) Descriptor added in v0.0.21

func (*NodesReply) Descriptor() ([]byte, []int)

func (*NodesReply) GetNodes added in v0.0.22

func (m *NodesReply) GetNodes() map[string]*NodeInfo

func (*NodesReply) Marshal added in v0.0.17

func (m *NodesReply) Marshal() (data []byte, err error)

func (*NodesReply) MarshalTo added in v0.0.17

func (m *NodesReply) MarshalTo(data []byte) (int, error)

func (*NodesReply) ProtoMessage

func (*NodesReply) ProtoMessage()

func (*NodesReply) Reset

func (m *NodesReply) Reset()

func (*NodesReply) Size added in v0.0.17

func (m *NodesReply) Size() (n int)

func (*NodesReply) String

func (m *NodesReply) String() string

func (*NodesReply) Unmarshal added in v0.0.17

func (m *NodesReply) Unmarshal(data []byte) error

type NodesRequest

type NodesRequest struct {
	// The tickets of the nodes to be looked up.
	Ticket []string `protobuf:"bytes,1,rep,name=ticket" json:"ticket,omitempty"`
	// A collection of filter globs that specify which facts (by name) should be
	// returned for each node.  If filter is empty or unset, all available facts
	// are returned for each matching node.  The filter applies to ALL requested
	// nodes.  For different filters per node, the client must issue separate
	// requests.  See EdgesRequest for the format of the filter globs.
	Filter []string `protobuf:"bytes,2,rep,name=filter" json:"filter,omitempty"`
}

func (*NodesRequest) Descriptor added in v0.0.21

func (*NodesRequest) Descriptor() ([]byte, []int)

func (*NodesRequest) Marshal added in v0.0.17

func (m *NodesRequest) Marshal() (data []byte, err error)

func (*NodesRequest) MarshalTo added in v0.0.17

func (m *NodesRequest) MarshalTo(data []byte) (int, error)

func (*NodesRequest) ProtoMessage

func (*NodesRequest) ProtoMessage()

func (*NodesRequest) Reset

func (m *NodesRequest) Reset()

func (*NodesRequest) Size added in v0.0.17

func (m *NodesRequest) Size() (n int)

func (*NodesRequest) String

func (m *NodesRequest) String() string

func (*NodesRequest) Unmarshal added in v0.0.17

func (m *NodesRequest) Unmarshal(data []byte) error

type XRefServiceClient

type XRefServiceClient interface {
	// Nodes returns a subset of the facts for each of the requested nodes.
	Nodes(ctx context.Context, in *NodesRequest, opts ...grpc.CallOption) (*NodesReply, error)
	// Edges returns a subset of the outbound edges for each of a set of
	// requested nodes.
	Edges(ctx context.Context, in *EdgesRequest, opts ...grpc.CallOption) (*EdgesReply, error)
	// Decorations returns an index of the nodes and edges associated with a
	// particular file node.
	Decorations(ctx context.Context, in *DecorationsRequest, opts ...grpc.CallOption) (*DecorationsReply, error)
	// CrossReferences returns the global references, definitions, and
	// documentation of a set of requested nodes.
	CrossReferences(ctx context.Context, in *CrossReferencesRequest, opts ...grpc.CallOption) (*CrossReferencesReply, error)
	// Callers takes a set of tickets for semantic objects and returns the set
	// of places where those objects were called. For example, in the program
	//   void bar() { foo(); foo(); } void baz() { foo(); } void foo() { }
	// `Callers({foo})` would return:
	//   {(bar, {first-call-anchor, second-call-anchor}),
	//    (baz, {first-call-anchor})}
	// To walk further up the call graph, you can project the first field of
	// each tuple in the result set ({bar, baz}) and feed that set back in
	// to a new Callers request.
	//
	// The core of this query is specified in terms of graph operations in the
	// Kythe repository at //kythe/docs/schema/callgraph.txt.
	Callers(ctx context.Context, in *CallersRequest, opts ...grpc.CallOption) (*CallersReply, error)
	// Documentation takes a set of tickets for semantic objects and returns
	// documentation about them, including generated signatures and
	// user-provided text. The documentation may refer to tickets for other
	// nodes in the graph.
	Documentation(ctx context.Context, in *DocumentationRequest, opts ...grpc.CallOption) (*DocumentationReply, error)
}

func NewXRefServiceClient

func NewXRefServiceClient(cc *grpc.ClientConn) XRefServiceClient

type XRefServiceServer

type XRefServiceServer interface {
	// Nodes returns a subset of the facts for each of the requested nodes.
	Nodes(context.Context, *NodesRequest) (*NodesReply, error)
	// Edges returns a subset of the outbound edges for each of a set of
	// requested nodes.
	Edges(context.Context, *EdgesRequest) (*EdgesReply, error)
	// Decorations returns an index of the nodes and edges associated with a
	// particular file node.
	Decorations(context.Context, *DecorationsRequest) (*DecorationsReply, error)
	// CrossReferences returns the global references, definitions, and
	// documentation of a set of requested nodes.
	CrossReferences(context.Context, *CrossReferencesRequest) (*CrossReferencesReply, error)
	// Callers takes a set of tickets for semantic objects and returns the set
	// of places where those objects were called. For example, in the program
	//   void bar() { foo(); foo(); } void baz() { foo(); } void foo() { }
	// `Callers({foo})` would return:
	//   {(bar, {first-call-anchor, second-call-anchor}),
	//    (baz, {first-call-anchor})}
	// To walk further up the call graph, you can project the first field of
	// each tuple in the result set ({bar, baz}) and feed that set back in
	// to a new Callers request.
	//
	// The core of this query is specified in terms of graph operations in the
	// Kythe repository at //kythe/docs/schema/callgraph.txt.
	Callers(context.Context, *CallersRequest) (*CallersReply, error)
	// Documentation takes a set of tickets for semantic objects and returns
	// documentation about them, including generated signatures and
	// user-provided text. The documentation may refer to tickets for other
	// nodes in the graph.
	Documentation(context.Context, *DocumentationRequest) (*DocumentationReply, error)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL