schema

Documentation

Overview

Package schema defines constants used in the Kythe schema.

Index

• Constants
• func Canonicalize(kind string) string
• func IsAnchorEdge(kind string) bool
• func IsEdgeVariant(k1, k2 string) bool
• func MirrorEdge(kind string) string
• func ParseOrdinal(edgeKind string) (kind string, ordinal int, hasOrdinal bool)
• type EdgeDir
  • func EdgeDirection(kind string) EdgeDir

Constants

const (
	NodeKindFact = "/kythe/node/kind"
	SubkindFact  = "/kythe/subkind"

	AnchorStartFact = "/kythe/loc/start"
	AnchorEndFact   = "/kythe/loc/end"

	SnippetStartFact = "/kythe/snippet/start"
	SnippetEndFact   = "/kythe/snippet/end"

	TextFact         = "/kythe/text"
	TextEncodingFact = "/kythe/text/encoding"

	CompleteFact = "/kythe/complete"

	FormatFact = "/kythe/format"
)

Kythe node fact labels

const (
	AnchorKind = "anchor"
	FileKind   = "file"
	NameKind   = "name"

	DocKind      = "doc"
	EnumKind     = "enum"
	FunctionKind = "function"
	PackageKind  = "package"
	RecordKind   = "record"
	TAppKind     = "tapp"
	VariableKind = "variable"
)

Kythe node kinds

const (
	ClassSubkind     = "class"
	EnumClassSubkind = "enumClass"
	ImplicitSubkind  = "implicit"
)

Kythe node subkinds

const (
	CallableAsEdge = EdgePrefix + "callableas"
	ChildOfEdge    = EdgePrefix + "childof"
	NamedEdge      = EdgePrefix + "named"
	OverridesEdge  = EdgePrefix + "overrides"
	ParamEdge      = EdgePrefix + "param"
	TypedEdge      = EdgePrefix + "typed"
)

Kythe edge kinds

const (
	CompletesEdge         = EdgePrefix + "completes"
	CompletesUniquelyEdge = EdgePrefix + "completes/uniquely"
	DefinesEdge           = EdgePrefix + "defines"
	DefinesBindingEdge    = EdgePrefix + "defines/binding"
	DocumentsEdge         = EdgePrefix + "documents"
	RefEdge               = EdgePrefix + "ref"
	RefCallEdge           = EdgePrefix + "ref/call"
)

Kythe edge kinds associated with anchors

const (
	// AnchorLocFilter is a fact filter for anchor locations
	AnchorLocFilter = "/kythe/loc/*"

	// SnippetLocFilter is a fact filter for snippet locations
	SnippetLocFilter = "/kythe/snippet/*"
)

const DefaultTextEncoding = "UTF-8"

DefaultTextEncoding is the assumed value of the TextEncodingFact if it is empty or missing from a node with a TextFact.

const EdgePrefix = "/kythe/edge/"

EdgePrefix is the standard Kythe prefix for all edge kinds.

Functions

func Canonicalize

func Canonicalize(kind string) string

Canonicalize will return the canonical, forward version of an edge kind.

func IsAnchorEdge

func IsAnchorEdge(kind string) bool

IsAnchorEdge returns if the given edge kind is associated with anchors.

func IsEdgeVariant

func IsEdgeVariant(k1, k2 string) bool

IsEdgeVariant returns if k1 is the same edge kind as k2 or a more specific variant (i.e. IsEdgeVariant("/kythe/edge/defines/binding", "/kythe/edge/defines") == true). Note that IsEdgeVariant(k1, k2) == IsEdgeVariant(MirrorEdge(k1), MirrorEdge(k2)).

func MirrorEdge

func MirrorEdge(kind string) string

MirrorEdge returns the reverse edge kind for a given forward edge kind and returns the forward edge kind for a given reverse edge kind.

func ParseOrdinal

func ParseOrdinal(edgeKind string) (kind string, ordinal int, hasOrdinal bool)

ParseOrdinal removes an edge kind's `\.[0-9]+` ordinal suffix.

Types

type EdgeDir

type EdgeDir bool

EdgeDir represents the inherent direction of an edge kind.

const (
	Forward EdgeDir = true
	Reverse EdgeDir = false
)

Forward edges are generally dependency edges and ensure that each node has a small out-degree in the Kythe graph. Reverse edges are the opposite.

func EdgeDirection

func EdgeDirection(kind string) EdgeDir

EdgeDirection returns the edge direction of the given edge kind