literal

package
v0.24.7 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2024 License: BSD-3-Clause Imports: 10 Imported by: 1

Documentation

Overview

Supply constant values to runtime evaluations. ( ie. a specific number when a [NumEval] is required. )

Tell files support "shortcuts" which turn primitive values into literal commands. For instance, the number '5' in a .tell file is automatically transformed into the command "Num value: 5" whenever that's needed.

Index

Constants

This section is empty.

Variables

View Source 
var Z_Types = typeinfo.TypeSet{
	Name: "literal",
	Comment: []string{
		"Supply constant values to runtime evaluations.",
		"( ie. a specific number when a [NumEval] is required. )",
		"",
		"Tell files support \"shortcuts\" which turn primitive values into literal commands. For instance, the number '5' in a .tell file is automatically transformed into the command \"Num value: 5\" whenever that's needed.",
	},

	Slot:       z_slot_list,
	Flow:       z_flow_list,
	Signatures: z_signatures,
}

package listing of type data

View Source 
var Zt_BoolValue typeinfo.Flow

bool_value, a type of flow.

View Source 
var Zt_FieldList typeinfo.Flow

field_list, a type of flow.

View Source 
var Zt_FieldValue typeinfo.Flow

field_value, a type of flow.

View Source 
var Zt_LiteralValue = typeinfo.Slot{
	Name: "literal_value",
	Markup: map[string]any{
		"blockly-color": "MATH_HUE",
		"comment":       "A slot to identify constant values.",
	},
}

literal_value, a type of slot.

View Source 
var Zt_NumList typeinfo.Flow

num_list, a type of flow.

View Source 
var Zt_NumValue typeinfo.Flow

num_value, a type of flow.

View Source 
var Zt_RecordList typeinfo.Flow

record_list, a type of flow.

View Source 
var Zt_RecordValue typeinfo.Flow

record_value, a type of flow.

View Source 
var Zt_TextList typeinfo.Flow

text_list, a type of flow.

View Source 
var Zt_TextValue typeinfo.Flow

text_value, a type of flow.

Functions

func CustomDecoder 

func CustomDecoder(_ *decode.Decoder, slot *typeinfo.Slot, body any) (typeinfo.Instance, error)

func CustomEncoder 

func CustomEncoder(enc *encode.Encoder, op typeinfo.Instance) (ret any, err error)

Write literal commands as plain values. ex. BoolValue becomes a bool (true or false) in the output data.

note: TextValues and NumValues of containing a single value and serialized as that single value ( [6]-> 6 ) because, in theory, that can help simply the specification for authors.

func DecodeLiteral 

func DecodeLiteral(slot *typeinfo.Slot, body any) (ret typeinfo.Instance, err error)

func GetAffinity 

func GetAffinity(a LiteralValue) (ret affine.Affinity)

func Register added in v0.24.7 

func Register(reg func(any))

gob like registration

Types

type BoolValue 

type BoolValue struct {
	Value  bool
	Markup map[string]any `json:",omitempty"`
}

Specify an explicit true or false.

func B 

func B(b bool) *BoolValue

func (*BoolValue) GetBool 

func (op *BoolValue) GetBool(run rt.Runtime) (rt.Value, error)

GetBool implements rt.BoolEval; providing the dl with a boolean literal.

func (*BoolValue) GetLiteralValue 

func (op *BoolValue) GetLiteralValue(rt.Kinds) (ret rt.Value, _ error)

func (*BoolValue) GetMarkup 

func (op *BoolValue) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*BoolValue) String 

func (op *BoolValue) String() string

String uses strconv.FormatBool.

func (*BoolValue) TypeInfo 

func (*BoolValue) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type BoolValue_Slice 

type BoolValue_Slice []BoolValue

Holds a slice of type BoolValue.

func (*BoolValue_Slice) Repeats 

func (op *BoolValue_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of BoolValue.

func (*BoolValue_Slice) TypeInfo 

func (*BoolValue_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of BoolValue.

type FieldList 

type FieldList struct {
	Fields []FieldValue
	Markup map[string]any `json:",omitempty"`
}

A series of values used to build a record.

func (*FieldList) GetLiteralValue 

func (op *FieldList) GetLiteralValue(rt.Kinds) (rt.Value, error)

unimplemented: panics.

func (*FieldList) GetMarkup 

func (op *FieldList) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*FieldList) String 

func (op *FieldList) String() (ret string)

unimplemented: panics.

func (*FieldList) TypeInfo 

func (*FieldList) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type FieldList_Slice 

type FieldList_Slice []FieldList

Holds a slice of type FieldList.

func (*FieldList_Slice) Repeats 

func (op *FieldList_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of FieldList.

func (*FieldList_Slice) TypeInfo 

func (*FieldList_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of FieldList.

type FieldValue 

type FieldValue struct {
	FieldName string
	Value     LiteralValue
	Markup    map[string]any `json:",omitempty"`
}

The name and value of a field used for initializing a literal record.

func (*FieldValue) GetMarkup 

func (op *FieldValue) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*FieldValue) TypeInfo 

func (*FieldValue) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type FieldValue_Slice 

type FieldValue_Slice []FieldValue

Holds a slice of type FieldValue.

func (*FieldValue_Slice) Repeats 

func (op *FieldValue_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of FieldValue.

func (*FieldValue_Slice) TypeInfo 

func (*FieldValue_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of FieldValue.

type LiteralValue 

type LiteralValue interface {
	GetLiteralValue(rt.Kinds) (rt.Value, error)
}

LiteralValue marks script constants.

func ReadLiteral 

func ReadLiteral(aff affine.Affinity, kind string, val any) (ret LiteralValue, err error)

type LiteralValue_Slot 

type LiteralValue_Slot struct{ Value LiteralValue }

Holds a single slot.

func (*LiteralValue_Slot) TypeInfo 

func (*LiteralValue_Slot) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a single slot.

type LiteralValue_Slots 

type LiteralValue_Slots []LiteralValue

Holds a slice of slots.

func (*LiteralValue_Slots) Repeats 

func (op *LiteralValue_Slots) Repeats() bool

Implements typeinfo.Repeats for a slice of slots.

func (*LiteralValue_Slots) TypeInfo 

func (*LiteralValue_Slots) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of slots.

type NumList added in v0.24.6 

type NumList struct {
	Values []float64
	Markup map[string]any `json:",omitempty"`
}

Specify a list of literal numbers.

func (*NumList) GetLiteralValue added in v0.24.6 

func (op *NumList) GetLiteralValue(rt.Kinds) (ret rt.Value, _ error)

func (*NumList) GetMarkup added in v0.24.6 

func (op *NumList) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*NumList) GetNumList added in v0.24.6 

func (op *NumList) GetNumList(run rt.Runtime) (rt.Value, error)

GetNumList implements rt.NumListEval providing the dl with a literal list of numbers.

func (*NumList) TypeInfo added in v0.24.6 

func (*NumList) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type NumList_Slice added in v0.24.6 

type NumList_Slice []NumList

Holds a slice of type NumList.

func (*NumList_Slice) Repeats added in v0.24.6 

func (op *NumList_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of NumList.

func (*NumList_Slice) TypeInfo added in v0.24.6 

func (*NumList_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of NumList.

type NumValue 

type NumValue struct {
	Value  float64
	Markup map[string]any `json:",omitempty"`
}

Specify a particular number.

func F 

func F(n float64) *NumValue

func I 

func I(n int) *NumValue

func (*NumValue) Float 

func (op *NumValue) Float() float64

Float converts to native float.

func (*NumValue) GetLiteralValue 

func (op *NumValue) GetLiteralValue(rt.Kinds) (ret rt.Value, _ error)

func (*NumValue) GetMarkup 

func (op *NumValue) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*NumValue) GetNum added in v0.24.6 

func (op *NumValue) GetNum(run rt.Runtime) (rt.Value, error)

GetNum implements rt.NumEval providing the dl with a number literal.

func (*NumValue) Int 

func (op *NumValue) Int() int

Int converts to native int.

func (*NumValue) String 

func (op *NumValue) String() string

String returns a nicely formatted float, with no decimal point when possible.

func (*NumValue) TypeInfo 

func (*NumValue) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type NumValue_Slice 

type NumValue_Slice []NumValue

Holds a slice of type NumValue.

func (*NumValue_Slice) Repeats 

func (op *NumValue_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of NumValue.

func (*NumValue_Slice) TypeInfo 

func (*NumValue_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of NumValue.

type RecordCache 

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

func (*RecordCache) GetRecord 

func (rc *RecordCache) GetRecord(kinds rt.Kinds, kind string, fields []FieldValue) (ret rt.Value, err error)

type RecordList 

type RecordList struct {
	KindName string
	Records  []FieldList

	Markup map[string]any `json:",omitempty"`
	// contains filtered or unexported fields
}

Specify a series of records, all of the same kind.

func (*RecordList) GetLiteralValue 

func (op *RecordList) GetLiteralValue(kinds rt.Kinds) (rt.Value, error)

func (*RecordList) GetMarkup 

func (op *RecordList) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*RecordList) GetRecordList 

func (op *RecordList) GetRecordList(run rt.Runtime) (ret rt.Value, _ error)

GetNumList implements rt.RecordListEval providing the dl with a literal list of records.

func (*RecordList) TypeInfo 

func (*RecordList) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type RecordList_Slice 

type RecordList_Slice []RecordList

Holds a slice of type RecordList.

func (*RecordList_Slice) Repeats 

func (op *RecordList_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of RecordList.

func (*RecordList_Slice) TypeInfo 

func (*RecordList_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of RecordList.

type RecordValue 

type RecordValue struct {
	KindName string
	Fields   []FieldValue

	Markup map[string]any `json:",omitempty"`
	// contains filtered or unexported fields
}

Specify a record composed of literal values.

func (*RecordValue) GetLiteralValue 

func (op *RecordValue) GetLiteralValue(kinds rt.Kinds) (ret rt.Value, err error)

func (*RecordValue) GetMarkup 

func (op *RecordValue) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*RecordValue) GetRecord 

func (op *RecordValue) GetRecord(run rt.Runtime) (rt.Value, error)

GetRecord implements interface rt.RecordEval providing the dl with a structured literal.

func (*RecordValue) TypeInfo 

func (*RecordValue) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type RecordValue_Slice 

type RecordValue_Slice []RecordValue

Holds a slice of type RecordValue.

func (*RecordValue_Slice) Repeats 

func (op *RecordValue_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of RecordValue.

func (*RecordValue_Slice) TypeInfo 

func (*RecordValue_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of RecordValue.

type RecordsCache 

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

func (*RecordsCache) GetRecords 

func (rc *RecordsCache) GetRecords(kinds rt.Kinds, kind string, els []FieldList) (ret rt.Value, err error)

type TextList added in v0.24.6 

type TextList struct {
	KindName string
	Values   []string
	Markup   map[string]any `json:",omitempty"`
}

Specify a list of literal text values.

func Ts 

func Ts(s ...string) *TextList

func (*TextList) GetLiteralValue added in v0.24.6 

func (op *TextList) GetLiteralValue(rt.Kinds) (ret rt.Value, _ error)

func (*TextList) GetMarkup added in v0.24.6 

func (op *TextList) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*TextList) GetTextList added in v0.24.6 

func (op *TextList) GetTextList(run rt.Runtime) (ret rt.Value, _ error)

GetTextList implements rt.TextListEval providing the dl with a literal list of text.

func (*TextList) TypeInfo added in v0.24.6 

func (*TextList) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type TextList_Slice added in v0.24.6 

type TextList_Slice []TextList

Holds a slice of type TextList.

func (*TextList_Slice) Repeats added in v0.24.6 

func (op *TextList_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of TextList.

func (*TextList_Slice) TypeInfo added in v0.24.6 

func (*TextList_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of TextList.

type TextValue 

type TextValue struct {
	KindName string
	Value    string
	Markup   map[string]any `json:",omitempty"`
}

Specify some constant text.

func T 

func T(s string) *TextValue

func (*TextValue) GetLiteralValue 

func (op *TextValue) GetLiteralValue(rt.Kinds) (ret rt.Value, _ error)

func (*TextValue) GetMarkup 

func (op *TextValue) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*TextValue) GetText 

func (op *TextValue) GetText(run rt.Runtime) (rt.Value, error)

GetText implements interface rt.TextEval providing the dl with a text literal.

func (*TextValue) String 

func (op *TextValue) String() string

String returns the text.

func (*TextValue) TypeInfo 

func (*TextValue) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type TextValue_Slice 

type TextValue_Slice []TextValue

Holds a slice of type TextValue.

func (*TextValue_Slice) Repeats 

func (op *TextValue_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of TextValue.

func (*TextValue_Slice) TypeInfo 

func (*TextValue_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of TextValue.

Source Files

View all Source files

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.