internal

package
v0.15.4 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package internal exposes some cue internals to other packages.

A better name for this package would be technicaldebt.

Index

Constants

This section is empty.

Variables

View Source 
var BaseContext = Context{*apd.BaseContext.WithPrecision(34)}

BaseContext is used as CUE's default context for arbitrary-precision decimals.

Functions

func FileComments added in v0.12.0 

func FileComments(f *ast.File) (docs, rest []*ast.CommentGroup)

func GenPath added in v0.1.0 

func GenPath(root string) string

GenPath reports the directory in which to store generated files.

func IsDef added in v0.2.0 

func IsDef(s string) bool

func IsDefOrHidden added in v0.2.0 

func IsDefOrHidden(s string) bool

func IsDefinition added in v0.2.0 

func IsDefinition(label ast.Label) bool

func IsHidden added in v0.2.0 

func IsHidden(s string) bool

func IsRegularField added in v0.2.0 

func IsRegularField(f *ast.Field) bool

func NewComment added in v0.1.0 

func NewComment(isDoc bool, s string) *ast.CommentGroup

NewComment creates a new CommentGroup from the given text. Each line is prefixed with "//" and the last newline is removed. Useful for ASTs generated by code other than the CUE parser.

func Package added in v0.11.0 

func Package(f *ast.File) (*ast.Package, int)

Package finds the package declaration from the preamble of a file, returning it, and its index within the file's Decls.

func SetConstraint added in v0.6.0 

func SetConstraint(f *ast.Field, t token.Token)

SetConstraints sets both the main and deprecated fields of f according to the given constraint token.

func ToExpr added in v0.1.0 

func ToExpr(n ast.Node) ast.Expr

ToExpr converts a node to an expression. If it is a file, it will return it as a struct. If is an expression, it will return it as is. Otherwise it panics.

func ToFile added in v0.1.0 

func ToFile(n ast.Node) *ast.File

ToFile converts an expression to a file.

Adjusts the spacing of x when needed.

Types

type Attr added in v0.1.0 

type Attr struct {
	Name   string // e.g. "json" or "protobuf"
	Body   string
	Kind   AttrKind
	Fields []KeyValue
	Err    errors.Error
	Pos    token.Pos
}

Attr holds positional information for a single Attr.

func NewNonExisting added in v0.1.0 

func NewNonExisting(key string) Attr

NewNonExisting creates a non-existing attribute.

func ParseAttrBody added in v0.1.0 

func ParseAttrBody(pos token.Pos, s string) (a Attr)

func (*Attr) Flag added in v0.1.0 

func (a *Attr) Flag(pos int, key string) (bool, error)

Flag reports whether an entry with the given name exists at position pos or onwards or an error if the attribute is invalid or if the first pos-1 entries are not defined.

func (*Attr) Int added in v0.1.0 

func (a *Attr) Int(pos int) (int64, error)

Int reports the integer at the given position or an error if the attribute is invalid, the position does not exist, or the value at the given position is not an integer.

func (*Attr) Lookup added in v0.1.0 

func (a *Attr) Lookup(pos int, key string) (val string, found bool, err error)

Lookup searches for an entry of the form key=value from position pos onwards and reports the value if found. It reports an error if the attribute is invalid or if the first pos-1 entries are not defined.

func (*Attr) String added in v0.1.0 

func (a *Attr) String(pos int) (string, error)

String reports the possibly empty string value at the given position or an error the attribute is invalid or if the position does not exist.

type AttrKind added in v0.3.0 

type AttrKind uint8

AttrKind indicates the location of an attribute within CUE source. 

const (
	// FieldAttr indicates an attribute is a field attribute.
	// foo: bar @attr()
	FieldAttr AttrKind = 1 << iota

	// DeclAttr indicates an attribute was specified at a declaration position.
	// foo: {
	//     @attr()
	// }
	DeclAttr
)

type Context added in v0.6.0 

type Context struct {
	apd.Context
}

Context wraps apd.Context for CUE's custom logic.

Note that it avoids pointers to make it easier to make copies.

func (Context) Quo added in v0.6.0 

func (c Context) Quo(d, x, y *apd.Decimal) (apd.Condition, error)

func (Context) Sqrt added in v0.6.0 

func (c Context) Sqrt(d, x *apd.Decimal) (apd.Condition, error)

func (Context) WithPrecision added in v0.6.0 

func (c Context) WithPrecision(p uint32) Context

WithPrecision mirrors upstream, but returning our type without a pointer.

type Decimal added in v0.0.5 

type Decimal = apd.Decimal

A Decimal is an arbitrary-precision binary-coded decimal number.

Right now Decimal is aliased to apd.Decimal. This may change in the future.

type EvaluatorVersion added in v0.8.0 

type EvaluatorVersion int

EvaluatorVersion is declared here so it can be used everywhere without import cycles, but the canonical documentation lives at cuelang.org/go/cue/cuecontext.EvalVersion.

TODO(mvdan): rename to EvalVersion for consistency with cuecontext. 

const (
	// EvalVersionUnset is the zero value, which signals that no evaluator version is provided.
	EvalVersionUnset EvaluatorVersion = 0

	// DefaultVersion is a special value as it selects a version depending on the current
	// value of CUE_EXPERIMENT. It exists separately to [EvalVersionUnset], even though both
	// implement the same version selection logic, so that we can distinguish between
	// a user explicitly asking for the default version versus an entirely unset version.
	DefaultVersion EvaluatorVersion = -1 // TODO(mvdan): rename to EvalDefault for consistency with cuecontext

	EvalV2 EvaluatorVersion = 2
	EvalV3 EvaluatorVersion = 3

	StableVersion = EvalV3 // TODO(mvdan): rename to EvalStable for consistency with cuecontext
	DevVersion    = EvalV3 // TODO(mvdan): rename to EvalExperiment for consistency with cuecontext
)

type KeyValue added in v0.3.0 

type KeyValue struct {
	// contains filtered or unexported fields
}

func (*KeyValue) Key added in v0.3.0 

func (kv *KeyValue) Key() string

func (*KeyValue) Text added in v0.3.0 

func (kv *KeyValue) Text() string

func (*KeyValue) Value added in v0.3.0 

func (kv *KeyValue) Value() string

Source Files

View all Source files

Directories

Path Synopsis
Package anyunique provides canonicalization of values under a caller-defined equivalence relation.
 Package anyunique provides canonicalization of values under a caller-defined equivalence relation.
Package buildattr implements support for interpreting the @if build attributes in CUE files.
 Package buildattr implements support for interpreting the @if build attributes in CUE files.
ci
checks command
cmd
cue-ast command
cue-ast-print parses a CUE file and prints its syntax tree, for example:
 cue-ast-print parses a CUE file and prints its syntax tree, for example:
Package copy provides utilities to copy files and directories.
 Package copy provides utilities to copy files and directories.
core
adt
Package adt represents partially and fully evaluated CUE types.
 Package adt represents partially and fully evaluated CUE types.
compile
convert
Package convert allows converting to and from Go values and Types.
 Package convert allows converting to and from Go values and Types.
debug
Package debug prints a given ADT node.
 Package debug prints a given ADT node.
dep
Package dep analyzes dependencies between values.
 Package dep analyzes dependencies between values.
eval
export
format
Package format provides functionality for pretty-printing CUE values.
 Package format provides functionality for pretty-printing CUE values.
layer
path
Package path provides utilities for converting cue.Selectors and cue.Paths to internal equivalents.
 Package path provides utilities for converting cue.Selectors and cue.Paths to internal equivalents.
runtime
subsume
Package subsume defines various subsumption relations.
 Package subsume defines various subsumption relations.
toposort
walk
walk provides functions for visiting the nodes of an ADT tree.
 walk provides functions for visiting the nodes of an ADT tree.
Package cueconfig holds internal API relating to CUE configuration.
 Package cueconfig holds internal API relating to CUE configuration.
Package cueimports provides support for reading the import section of a CUE file without needing to read the rest of it.
 Package cueimports provides support for reading the import section of a CUE file without needing to read the rest of it.
Package testing is a helper package for test packages in the CUE project.
 Package testing is a helper package for test packages in the CUE project.
Package testing is a helper package for test packages in the CUE project.
 Package testing is a helper package for test packages in the CUE project.
Package cueversion provides access to the version of the cuelang.org/go module.
 Package cueversion provides access to the version of the cuelang.org/go module.
gotypes
json
yaml
internal
Package internal holds some internal parts of the filetypes package that need to be shared between the code generator and the package proper.
 Package internal holds some internal parts of the filetypes package that need to be shared between the code generator and the package proper.
internal/genfunc
internal/genstruct
Package genstruct provides support for simple compact struct representations.
 Package genstruct provides support for simple compact struct representations.
internal/opt
golangorgx
gopls/cmd
Package cmd handles the cuelsp command line.
 Package cmd handles the cuelsp command line.
gopls/file
gopls/hooks
Package hooks adds all the standard gopls implementations.
 Package hooks adds all the standard gopls implementations.
gopls/lsprpc
Package lsprpc implements a jsonrpc2.StreamServer that may be used to serve the LSP on a jsonrpc2 channel.
 Package lsprpc implements a jsonrpc2.StreamServer that may be used to serve the LSP on a jsonrpc2 channel.
gopls/progress
The progress package defines utilities for reporting the progress of long-running operations using features of the LSP client interface such as Progress and ShowMessage.
 The progress package defines utilities for reporting the progress of long-running operations using features of the LSP client interface such as Progress and ShowMessage.
gopls/protocol
Package protocol contains the structs that map directly to the request and response messages of the Language Server Protocol.
 Package protocol contains the structs that map directly to the request and response messages of the Language Server Protocol.
gopls/protocol/command
Package command defines the interface provided by gopls for the workspace/executeCommand LSP request.
 Package command defines the interface provided by gopls for the workspace/executeCommand LSP request.
gopls/protocol/semtok
The semtok package provides an encoder for LSP's semantic tokens.
 The semtok package provides an encoder for LSP's semantic tokens.
gopls/settings
gopls/test/integration
Package integration provides a framework for writing integration tests of gopls.
 Package integration provides a framework for writing integration tests of gopls.
gopls/test/integration/fake
Package fake provides a fake implementation of an LSP-enabled text editor, its LSP client plugin, and a Sandbox environment for use in integration tests.
 Package fake provides a fake implementation of an LSP-enabled text editor, its LSP client plugin, and a Sandbox environment for use in integration tests.
gopls/test/integration/fake/glob
Package glob implements an LSP-compliant glob pattern matcher for testing.
 Package glob implements an LSP-compliant glob pattern matcher for testing.
gopls/util/browser
Package browser provides utilities for interacting with users' browsers.
 Package browser provides utilities for interacting with users' browsers.
gopls/util/pathutil
gopls/util/safetoken
Package safetoken provides wrappers around methods in go/token, that return errors rather than panicking.
 Package safetoken provides wrappers around methods in go/token, that return errors rather than panicking.
tools/diff
Package diff computes differences between text files or strings.
 Package diff computes differences between text files or strings.
tools/diff/lcs
package lcs contains code to find longest-common-subsequences (and diffs)
 package lcs contains code to find longest-common-subsequences (and diffs)
tools/event
Package event provides a set of packages that cover the main concepts of telemetry in an implementation agnostic way.
 Package event provides a set of packages that cover the main concepts of telemetry in an implementation agnostic way.
tools/event/core
Package core provides support for event based telemetry.
 Package core provides support for event based telemetry.
tools/event/export
tools/event/export/metric
Package metric aggregates events into metrics that can be exported.
 Package metric aggregates events into metrics that can be exported.
tools/event/export/ocagent
Package ocagent adds the ability to export all telemetry to an ocagent.
 Package ocagent adds the ability to export all telemetry to an ocagent.
tools/event/export/ocagent/wire
tools/event/export/prometheus
tools/event/keys
tools/event/label
tools/event/tag
Package tag provides the labels used for telemetry throughout gopls.
 Package tag provides the labels used for telemetry throughout gopls.
tools/fakenet
tools/jsonrpc2
Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.
 Package jsonrpc2 is a minimal implementation of the JSON RPC 2 spec.
tools/jsonrpc2/servertest
Package servertest provides utilities for running tests against a remote LSP server.
 Package servertest provides utilities for running tests against a remote LSP server.
tools/tool
Package tool is a harness for writing Go tools.
 Package tool is a harness for writing Go tools.
lsp
cache
definitions
Definitions resolves paths to sets of ast.Node.
 Definitions resolves paths to sets of ast.Node.
fscache
rangeset
server
Package server defines gopls' implementation of the LSP server interface, protocol.Server.
 Package server defines gopls' implementation of the LSP server interface, protocol.Server.
mod
modfiledata
Package modfiledata holds the underlying module.cue file representation.
 Package modfiledata holds the underlying module.cue file representation.
modimports
modload
modpkgload
modrequirements
modresolve
mvs
Package mvs implements Minimal Version Selection.
 Package mvs implements Minimal Version Selection.
semver
Package semver implements comparison of semantic version strings.
 Package semver implements comparison of semantic version strings.
Package par implements parallel execution helpers.
 Package par implements parallel execution helpers.
This directory contains a copy of "golang.org/x/tools/internal/robustio", from the commit tagged with v0.34.0 (commit 578c1213983a83e6411536ddf6bbf3a1faf97aea)
 This directory contains a copy of "golang.org/x/tools/internal/robustio", from the commit tagged with v0.34.0 (commit 578c1213983a83e6411536ddf6bbf3a1faf97aea)
Package source contains utility functions that standardize reading source bytes across cue packages.
 Package source contains utility functions that standardize reading source bytes across cue packages.
Package task provides a registry for tasks to be used by commands.
 Package task provides a registry for tasks to be used by commands.
Package tdtest provides support for table-driven testing.
 Package tdtest provides support for table-driven testing.
Package value contains functions for converting values to internal types and various other Value-related utilities.
 Package value contains functions for converting values to internal types and various other Value-related utilities.
Package vcs provides access to operations on the version control systems supported by the source field in module.cue.
 Package vcs provides access to operations on the version control systems supported by the source field in module.cue.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.