inline_value.gen.go

// Copyright 2026 The Go Language Server Authors
// SPDX-License-Identifier: BSD-3-Clause

// Code generated by internal/genlsp from metaModel.json; DO NOT EDIT.

package protocol

// InlineValueParams A parameter literal used in inline value requests.
//
// Since: 3.17.0
type InlineValueParams struct {
	WorkDoneProgressParams

	// TextDocument The text document.
	TextDocument TextDocumentIdentifier `json:"textDocument"`

	// Range The document range for which inline values information will be returned.
	Range Range `json:"range"`

	// Context Additional information about the context in which inline values information was
	// requested.	 */
	Context InlineValueContext `json:"context"`
}

// InlineValueRegistrationOptions Inline value options used during static or dynamic registration.
//
// Since: 3.17.0
type InlineValueRegistrationOptions struct {
	InlineValueOptions
	TextDocumentRegistrationOptions
	StaticRegistrationOptions
}

// InlineValueContext is defined by the LSP specification.
//
// Since: 3.17.0
type InlineValueContext struct {
	// FrameID The stack frame (as a DAP Id) where the execution has stopped.
	FrameID int32 `json:"frameId"`

	// StoppedLocation The document range where execution has stopped.
	// Typically the end position of the range denotes the line where the inline values are shown.
	StoppedLocation Range `json:"stoppedLocation"`
}

// InlineValueText Returns inline value information as the complete text to be shown.
//
// Since: 3.17.0
type InlineValueText struct {
	// Range The document range for which the inline value applies.
	Range Range `json:"range"`

	// Text The text of the inline value.
	Text string `json:"text"`
}

// InlineValueVariableLookup To compute inline value through a variable lookup.
//
// If only a range is specified, the variable name should
// be extracted from the underlying document.
//
// An optional variable name could be used to lookup instead
// of the extracted name.
//
// Since: 3.17.0
type InlineValueVariableLookup struct {
	// Range The document range for which the inline value applies.
	//
	// The range could be used to extract the variable name
	// from the underlying document.
	Range Range `json:"range"`

	// VariableName If specified the name of the variable to look up.
	VariableName *string `json:"variableName,omitzero"`

	// CaseSensitiveLookup How to perform the lookup.
	CaseSensitiveLookup bool `json:"caseSensitiveLookup"`
}

// InlineValueEvaluatableExpression To compute an inline value through an expression evaluation.
//
// If only a range is specified, the expression should be
// extracted from the underlying document.
//
// An optional expression could be evaluated instead of
// the extracted expression.
//
// Since: 3.17.0
type InlineValueEvaluatableExpression struct {
	// Range The document range for which the inline value applies.
	//
	// The range could be used to extract the evaluatable expression
	// from the underlying document.
	Range Range `json:"range"`

	// Expression If specified the expression could be evaluated instead.
	Expression *string `json:"expression,omitzero"`
}

// InlineValueOptions Inline value options used during static registration.
//
// Since: 3.17.0
type InlineValueOptions struct {
	WorkDoneProgressOptions
}

// InlineValueWorkspaceClientCapabilities Client workspace capabilities specific to inline values.
//
// Since: 3.17.0
type InlineValueWorkspaceClientCapabilities struct {
	// RefreshSupport Whether the client implementation supports a refresh request sent from the
	// server to the client.
	//
	// Note that this event is global and will force the client to refresh all
	// inline values currently shown. It should be used with absolute care and is
	// useful for situation where a server for example detects a project wide
	// change that requires such a calculation.
	RefreshSupport *bool `json:"refreshSupport,omitzero"`
}

// InlineValueClientCapabilities Client capabilities specific to inline values.
//
// Since: 3.17.0
type InlineValueClientCapabilities struct {
	// DynamicRegistration Whether implementation supports dynamic registration for inline value providers.
	DynamicRegistration *bool `json:"dynamicRegistration,omitzero"`
}