Directories ¶
Path | Synopsis |
---|---|
extractors
|
|
bazel
Package bazel implements the internal plumbing of a configurable Bazel compilation unit extractor.
|
Package bazel implements the internal plumbing of a configurable Bazel compilation unit extractor. |
cmd/bazel/bazel_go_extractor
bazel_go_extractor is a Bazel extra action that extracts Go compilations.
|
bazel_go_extractor is a Bazel extra action that extracts Go compilations. |
cmd/bazel/extract_kindex
Program extract_kindex implements a Bazel extra action that captures a Kythe compilation record for a "spawn" action.
|
Program extract_kindex implements a Bazel extra action that captures a Kythe compilation record for a "spawn" action. |
cmd/gotool
Binary gotool extracts Kythe compilation information for Go packages named by import path on the command line.
|
Binary gotool extracts Kythe compilation information for Go packages named by import path on the command line. |
config
Package config defines configuration settings for extracting compilation records from a repository using a non-bazel build system.
|
Package config defines configuration settings for extracting compilation records from a repository using a non-bazel build system. |
config/default/mvn
Package mvn defines a default kythe.proto.ExtractionConfiguration for Java using Maven.
|
Package mvn defines a default kythe.proto.ExtractionConfiguration for Java using Maven. |
config/smoke
Package smoke is a basic harness for testing the validity of config.ExtractRepo output.
|
Package smoke is a basic harness for testing the validity of config.ExtractRepo output. |
golang
Package golang produces Kythe compilation units for each Go import path specified.
|
Package golang produces Kythe compilation units for each Go import path specified. |
govname
Package govname supports the creation of VName protobuf messages for Go packages and other entities.
|
Package govname supports the creation of VName protobuf messages for Go packages and other entities. |
Package indexer implements a Kythe indexer for the Go language.
|
Package indexer implements a Kythe indexer for the Go language. |
cmd/go_example
Program go_example runs the Kythe Go indexer on a single package consisting of files named on the command line, for use in verifying schema examples.
|
Program go_example runs the Kythe Go indexer on a single package consisting of files named on the command line, for use in verifying schema examples. |
cmd/go_indexer
Program go_indexer implements a Kythe indexer for the Go language.
|
Program go_indexer implements a Kythe indexer for the Go language. |
Package languageserver provides an implementation of the Language Server Protocol v3.0 (https://github.com/Microsoft/language-server-protocol) This server implements the following capabilities: textDocumentSync (full) referenceProvider
|
Package languageserver provides an implementation of the Language Server Protocol v3.0 (https://github.com/Microsoft/language-server-protocol) This server implements the following capabilities: textDocumentSync (full) referenceProvider |
bin
Binary kythe_languageserver provides a Language Server Protocol v3 implementation for Kythe indexes that communicates via JSONRPC2.0 over stdio
|
Binary kythe_languageserver provides a Language Server Protocol v3 implementation for Kythe indexes that communicates via JSONRPC2.0 over stdio |
pathmap
Package pathmap provides utilities for matching and generating paths based on a pattern string.
|
Package pathmap provides utilities for matching and generating paths based on a pattern string. |
platform
|
|
analysis
Package analysis defines interfaces used to locate and analyze compilation units and their inputs.
|
Package analysis defines interfaces used to locate and analyze compilation units and their inputs. |
analysis/driver
Package driver contains a Driver implementation that sends analyses to a CompilationAnalyzer based on a Queue of compilations.
|
Package driver contains a Driver implementation that sends analyses to a CompilationAnalyzer based on a Queue of compilations. |
analysis/local
Package local implements CompilationAnalyzer utilities for local analyses.
|
Package local implements CompilationAnalyzer utilities for local analyses. |
analysis/proxy
Package proxy implements a wrapper that proxies an analysis request to a Kythe indexer that does not speak protocol buffers or RPCs.
|
Package proxy implements a wrapper that proxies an analysis request to a Kythe indexer that does not speak protocol buffers or RPCs. |
cache
Package cache implements a simple in-memory file cache and provides a simple Fetcher wrapper that uses the cache for its Fetch operations.
|
Package cache implements a simple in-memory file cache and provides a simple Fetcher wrapper that uses the cache for its Fetch operations. |
delimited
Package delimited implements a reader and writer for simple streams of length-delimited byte records.
|
Package delimited implements a reader and writer for simple streams of length-delimited byte records. |
delimited/dedup
Package dedup implements a duplication-reducing reader for streams of length-delimited byte records.
|
Package dedup implements a duplication-reducing reader for streams of length-delimited byte records. |
indexpack
Package indexpack provides an interface to a collection of compilation units stored in an "index pack" directory structure.
|
Package indexpack provides an interface to a collection of compilation units stored in an "index pack" directory structure. |
kcd
Package kcd defines an interface and utility functions for the implementation of a Kythe compilation database.
|
Package kcd defines an interface and utility functions for the implementation of a Kythe compilation database. |
kcd/kythe
Package kythe implements the kcd.Unit interface for Kythe compilations.
|
Package kythe implements the kcd.Unit interface for Kythe compilations. |
kcd/kzipdb
Package kzipdb implements kcd.Reader using a kzip file as its backing store.
|
Package kzipdb implements kcd.Reader using a kzip file as its backing store. |
kcd/locked
Package locked implements a delegating wrapper that protects each method of the resulting kcd.Reader or kcd.ReadWriter with a mutex, so that the result is safe for concurrent use by multiple goroutines.
|
Package locked implements a delegating wrapper that protects each method of the resulting kcd.Reader or kcd.ReadWriter with a mutex, so that the result is safe for concurrent use by multiple goroutines. |
kcd/memdb
Package memdb implements kcd.ReadWriter with an in-memory representation, suitable for testing or ephemeral service-based collections.
|
Package memdb implements kcd.ReadWriter with an in-memory representation, suitable for testing or ephemeral service-based collections. |
kcd/packdb
Package packdb implements kcd.ReadWriter using an index pack as its backing store.
|
Package packdb implements kcd.ReadWriter using an index pack as its backing store. |
kcd/testutil
Package testutil provides support functions for unit testing implementations of the kcd.ReadWriter interface.
|
Package testutil provides support functions for unit testing implementations of the kcd.ReadWriter interface. |
kindex
Package kindex implements an interface to compilation index files which are standalone CompilationUnits with all of their required inputs.
|
Package kindex implements an interface to compilation index files which are standalone CompilationUnits with all of their required inputs. |
kzip
Package kzip implements the kzip compilation storage file format.
|
Package kzip implements the kzip compilation storage file format. |
tools/dedup_stream
Binary dedup_stream reads a delimited stream from stdin and writes a delimited stream to stdout.
|
Binary dedup_stream reads a delimited stream from stdin and writes a delimited stream to stdout. |
tools/entrystream
Binary entrystream provides tools to manipulate a stream of delimited Entry messages.
|
Binary entrystream provides tools to manipulate a stream of delimited Entry messages. |
tools/extraction/extractrepo
Binary extractrepo provides a tool to run a Kythe extraction on a specified repository.
|
Binary extractrepo provides a tool to run a Kythe extraction on a specified repository. |
tools/extraction/repotester
Binary repotester tests the high level validity of repo extraction.
|
Binary repotester tests the high level validity of repo extraction. |
tools/indexpack
Binary indexpack is a utility to transfer compilations units in .kindex files to/from indexpack archives.
|
Binary indexpack is a utility to transfer compilations units in .kindex files to/from indexpack archives. |
tools/kindex_file_generator
Binary kindex_file_generator generates a kindex index file for a given source input file.
|
Binary kindex_file_generator generates a kindex index file for a given source input file. |
tools/ktags
Binary ktags emits ctags-formatted lines for the definitions in the given files.
|
Binary ktags emits ctags-formatted lines for the definitions in the given files. |
tools/pack2kzip
Binary pack2kzip converts an indexpack directory to a kzip file.
|
Binary pack2kzip converts an indexpack directory to a kzip file. |
tools/shasum_tool
Binary shasum_tool calcuates the sha256 sum of the specified file.
|
Binary shasum_tool calcuates the sha256 sum of the specified file. |
tools/viewindex
Binary viewindex prints a .kindex as JSON to stdout.
|
Binary viewindex prints a .kindex as JSON to stdout. |
vfs
Package vfs defines a generic file system interface commonly used by Kythe libraries.
|
Package vfs defines a generic file system interface commonly used by Kythe libraries. |
vfs/zip
Package zip defines a VFS implementation that understands a zip archive as an isolated, read-only file system.
|
Package zip defines a VFS implementation that understands a zip archive as an isolated, read-only file system. |
services
|
|
cli
Package cli exposes a CLI interface to the Kythe services.
|
Package cli exposes a CLI interface to the Kythe services. |
explore
Package explore defines the ExploreService interface.
|
Package explore defines the ExploreService interface. |
filetree
Package filetree defines the filetree Service interface and a simple in-memory implementation.
|
Package filetree defines the filetree Service interface and a simple in-memory implementation. |
graph
Package graph defines the graph Service interface and some useful utility functions.
|
Package graph defines the graph Service interface and some useful utility functions. |
graphstore
Package graphstore defines the Service and Sharded interfaces, and provides some useful utility functions.
|
Package graphstore defines the Service and Sharded interfaces, and provides some useful utility functions. |
graphstore/proxy
Package proxy defines a proxy graphstore.Service that delegates requests to other service implementations.
|
Package proxy defines a proxy graphstore.Service that delegates requests to other service implementations. |
link
Package link implements the link resolver service.
|
Package link implements the link resolver service. |
web
Package web defines utility functions for exposing services over HTTP.
|
Package web defines utility functions for exposing services over HTTP. |
xrefs
Package xrefs defines the xrefs Service interface and some useful utility functions.
|
Package xrefs defines the xrefs Service interface and some useful utility functions. |
serving
|
|
api
Package api provides a union of the filetree, xrefs, and graph interfaces and a command-line flag parser.
|
Package api provides a union of the filetree, xrefs, and graph interfaces and a command-line flag parser. |
explore
Package explore provides a high-performance table-based implementation of the ExploreService defined in kythe/proto/explore.proto.
|
Package explore provides a high-performance table-based implementation of the ExploreService defined in kythe/proto/explore.proto. |
filetree
Package filetree implements a lookup table for files in a tree structure.
|
Package filetree implements a lookup table for files in a tree structure. |
graph
Package graph provides a high-performance table-based implementation of the graph.Service.
|
Package graph provides a high-performance table-based implementation of the graph.Service. |
identifiers
Package identifiers provides a high-performance table-based implementation of the identifiers.Service.
|
Package identifiers provides a high-performance table-based implementation of the identifiers.Service. |
pipeline
Package pipeline implements an in-process pipeline to create a combined filetree and xrefs serving table from a stream of GraphStore-ordered entries.
|
Package pipeline implements an in-process pipeline to create a combined filetree and xrefs serving table from a stream of GraphStore-ordered entries. |
pipeline/beamtest
Package beamtest contains utilities to test Apache Beam pipelines.
|
Package beamtest contains utilities to test Apache Beam pipelines. |
pipeline/nodes
Package nodes provides Beam transformations over *ppb.Nodes.
|
Package nodes provides Beam transformations over *ppb.Nodes. |
pipeline/paths
Package paths specializes the util/reduce interfaces for Kythe *ipb.Paths.
|
Package paths specializes the util/reduce interfaces for Kythe *ipb.Paths. |
tools/http_server
Binary http_server exposes HTTP interfaces for the xrefs and filetree services backed by a combined serving table.
|
Binary http_server exposes HTTP interfaces for the xrefs and filetree services backed by a combined serving table. |
tools/kwazthis
Binary kwazthis (K, what's this?) determines what references are located at a particular offset (or line and column) within a file.
|
Binary kwazthis (K, what's this?) determines what references are located at a particular offset (or line and column) within a file. |
tools/kythe
Binary kythe exposes a CLI interface to the xrefs and filetree services backed by a combined serving table.
|
Binary kythe exposes a CLI interface to the xrefs and filetree services backed by a combined serving table. |
tools/write_tables
Binary write_tables creates a combined xrefs/filetree/search serving table based on a given GraphStore.
|
Binary write_tables creates a combined xrefs/filetree/search serving table based on a given GraphStore. |
xrefs
Package xrefs provides a high-performance table-based implementation of the xrefs.Service.
|
Package xrefs provides a high-performance table-based implementation of the xrefs.Service. |
xrefs/assemble
Package assemble provides functions to build the various components (nodes, edges, and decorations) of an xrefs serving table.
|
Package assemble provides functions to build the various components (nodes, edges, and decorations) of an xrefs serving table. |
storage
|
|
entryset
Package entryset implements a compact representation for sets of Kythe entry messages in the format emitted by indexers.
|
Package entryset implements a compact representation for sets of Kythe entry messages in the format emitted by indexers. |
gsutil
Package gsutil is collection of helper functions for storage tools.
|
Package gsutil is collection of helper functions for storage tools. |
inmemory
Package inmemory provides a in-memory implementation of graphstore.Service.
|
Package inmemory provides a in-memory implementation of graphstore.Service. |
keyvalue
Package keyvalue implements a generic GraphStore for anything that implements the DB interface.
|
Package keyvalue implements a generic GraphStore for anything that implements the DB interface. |
leveldb
Package leveldb implements a graphstore.Service using a LevelDB backend database.
|
Package leveldb implements a graphstore.Service using a LevelDB backend database. |
stream
Package stream provides utility functions to consume Entry streams.
|
Package stream provides utility functions to consume Entry streams. |
table
Package table implements lookup table interfaces for protobufs.
|
Package table implements lookup table interfaces for protobufs. |
tools/directory_indexer
Binary directory_indexer produces a set of Entry protos representing the files in the given directories.
|
Binary directory_indexer produces a set of Entry protos representing the files in the given directories. |
tools/read_entries
Binary read_entries scans the entries from a specified GraphStore and emits them to stdout as a delimited stream.
|
Binary read_entries scans the entries from a specified GraphStore and emits them to stdout as a delimited stream. |
tools/triples
Binary triples implements a converter from an Entry stream to a stream of triples.
|
Binary triples implements a converter from an Entry stream to a stream of triples. |
tools/write_entries
Binary write_entries reads a stream of protobuf entries on os.Stdin and writes each to a graphstore server.
|
Binary write_entries reads a stream of protobuf entries on os.Stdin and writes each to a graphstore server. |
test
|
|
services/graphstore
Package graphstore contains common utilities for testing GraphStore implementations.
|
Package graphstore contains common utilities for testing GraphStore implementations. |
services/xrefs
Package xrefs provides test utilities for the xrefs.Service.
|
Package xrefs provides test utilities for the xrefs.Service. |
storage/keyvalue
Package keyvalue contains utilities to test keyvalue DB implementations.
|
Package keyvalue contains utilities to test keyvalue DB implementations. |
testutil
Package testutil contains common utilities to test Kythe libraries.
|
Package testutil contains common utilities to test Kythe libraries. |
tools/http_server
Binary http_server exposes an HTTP interface for testing the xrefs and filetree services backed by a combined serving table.
|
Binary http_server exposes an HTTP interface for testing the xrefs and filetree services backed by a combined serving table. |
tools/xrefs_atomizer
Each non-flag argument is a file ticket that will be used in a DecorationsRequest to the --api service.
|
Each non-flag argument is a file ticket that will be used in a DecorationsRequest to the --api service. |
util
|
|
archive
Package archive provides support for reading the contents of archives such as .zip and .tar files.
|
Package archive provides support for reading the contents of archives such as .zip and .tar files. |
build
Package build provides information about how a given binary was built and in what context.
|
Package build provides information about how a given binary was built and in what context. |
cmdutil
Package cmdutil exports shared logic for implementing command-line subcommands using the github.com/google/subcommands package.
|
Package cmdutil exports shared logic for implementing command-line subcommands using the github.com/google/subcommands package. |
compare
Package compare implements comparisons between Kythe values.
|
Package compare implements comparisons between Kythe values. |
datasize
Package datasize implements a type representing data sizes in bytes.
|
Package datasize implements a type representing data sizes in bytes. |
dedup
Package dedup implements a utility to determine if a record has not been seen before (whether it's unique).
|
Package dedup implements a utility to determine if a record has not been seen before (whether it's unique). |
disksort
Package disksort implements sorting algorithms for sets of data too large to fit fully in-memory.
|
Package disksort implements sorting algorithms for sets of data too large to fit fully in-memory. |
encoding/rdf
Package rdf implements encoding of RDF triples, as described in http://www.w3.org/TR/2014/REC-n-triples-20140225/.
|
Package rdf implements encoding of RDF triples, as described in http://www.w3.org/TR/2014/REC-n-triples-20140225/. |
encoding/text
Package text contains utilities dealing with the encoding of source text.
|
Package text contains utilities dealing with the encoding of source text. |
flagutil
Package flagutil is a collection of helper functions for Kythe binaries using the flag package.
|
Package flagutil is a collection of helper functions for Kythe binaries using the flag package. |
html
Package html is a set of utilities for manipulating html Nodes.
|
Package html is a set of utilities for manipulating html Nodes. |
httpencoding
Package httpencoding provides functions to transparently encode/decode HTTP bodies
|
Package httpencoding provides functions to transparently encode/decode HTTP bodies |
kytheuri
Package kytheuri provides a type to represent Kythe URIs.
|
Package kytheuri provides a type to represent Kythe URIs. |
markedsource
Package markedsource defines functions for rendering MarkedSource.
|
Package markedsource defines functions for rendering MarkedSource. |
metadata
Package metadata provides support code for processing Kythe metadata records, of the type generated by instrumented code generators for cross-language linkage.
|
Package metadata provides support code for processing Kythe metadata records, of the type generated by instrumented code generators for cross-language linkage. |
netutil
Package netutil provides network utility functions.
|
Package netutil provides network utility functions. |
pager
Package pager implements a generic SetPager that splits a stream of Groups into a single Set and one-or-more associated Pages.
|
Package pager implements a generic SetPager that splits a stream of Groups into a single Set and one-or-more associated Pages. |
process
Package process contains an implementation of a callback-based asynchronous process.
|
Package process contains an implementation of a callback-based asynchronous process. |
profile
Package profile provides a simple method for exposing profile information through a --cpu_profile flag.
|
Package profile provides a simple method for exposing profile information through a --cpu_profile flag. |
ptypes
Package ptypes is a thin wrapper around the golang.org/protobuf/ptypes package that adds support for Kythe message types, and handles some type format conversions.
|
Package ptypes is a thin wrapper around the golang.org/protobuf/ptypes package that adds support for Kythe message types, and handles some type format conversions. |
reduce
Package reduce provides a simple interface for transforming a stream of inputs.
|
Package reduce provides a simple interface for transforming a stream of inputs. |
riegeli
Package riegeli implements a Reader and Writer for the Riegeli records format.
|
Package riegeli implements a Reader and Writer for the Riegeli records format. |
schema
Package schema defines constants used in the Kythe schema.
|
Package schema defines constants used in the Kythe schema. |
schema/edges
Package edges defines constants for Kythe edges.
|
Package edges defines constants for Kythe edges. |
schema/facts
Package facts defines constants for Kythe facts.
|
Package facts defines constants for Kythe facts. |
schema/mkdata
Program mkdata converts a text protobuf containing Kythe schema descriptors into a Go source file that can be compiled into the schema package.
|
Program mkdata converts a text protobuf containing Kythe schema descriptors into a Go source file that can be compiled into the schema package. |
schema/nodes
Package nodes defines constants for Kythe nodes.
|
Package nodes defines constants for Kythe nodes. |
schema/tickets
Package tickets defines functions for manipulating Kythe tickets.
|
Package tickets defines functions for manipulating Kythe tickets. |
sortutil
Package sortutil implements utilities for sorting.
|
Package sortutil implements utilities for sorting. |
tools/extractschema
Binary extract_schema extracts a machine-readable representation of the Kythe schema from the schema documentation.
|
Binary extract_schema extracts a machine-readable representation of the Kythe schema from the schema documentation. |
tools/print_extra_action
Binary print_extra_action takes a single argument that is a path to file with an protobuf wire-encoding of a Bazel ExtraActionInfo and prints it as JSON to stdout.
|
Binary print_extra_action takes a single argument that is a path to file with an protobuf wire-encoding of a Bazel ExtraActionInfo and prints it as JSON to stdout. |
tools/print_test_status
Binary print_test_status takes a single argument that is a path to file with an protobuf wire-encoding of a Bazel TestResultData and prints it as JSON to stdout.
|
Binary print_test_status takes a single argument that is a path to file with an protobuf wire-encoding of a Bazel TestResultData and prints it as JSON to stdout. |
tools/scan_leveldb
Binary scan_leveldb is the cat command for LevelDB.
|
Binary scan_leveldb is the cat command for LevelDB. |
vnameutil
Package vnameutil provides utilities for generating consistent VNames from common path-like values (e.g., filenames, import paths).
|
Package vnameutil provides utilities for generating consistent VNames from common path-like values (e.g., filenames, import paths). |
vnameutil/test
Program test_vname_rules verifies that a set of vname mapping rules behave as expected.
|
Program test_vname_rules verifies that a set of vname mapping rules behave as expected. |
Click to show internal directories.
Click to hide internal directories.