Documentation
¶
Overview ¶
Code generated by Tapestry; edit at your own risk.
Index ¶
- Variables
- func CmdError(op typeinfo.Instance, err error) error
- func CmdErrorCtx(op typeinfo.Instance, ctx string, err error) error
- func CustomEncoder(enc *encode.Encoder, op typeinfo.Instance) (ret any, err error)
- func ExpandArgs(run rt.Runtime, args []Arg) (retKeys []string, retVals []g.Value, err error)
- func GetAffinity(a rt.Assignment) (ret affine.Affinity)
- func Literal(v literal.LiteralValue) (ret rt.Assignment)
- type Address
- type Address_Slot
- type Address_Slots
- type Arg
- type Arg_Slice
- type AtField
- type AtField_Slice
- type AtIndex
- type AtIndex_Slice
- type CallPattern
- func (op *CallPattern) Execute(run rt.Runtime) error
- func (op *CallPattern) GetBool(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetMarkup(ensure bool) map[string]any
- func (op *CallPattern) GetNumList(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetNumber(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetRecord(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetRecordList(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetText(run rt.Runtime) (g.Value, error)
- func (op *CallPattern) GetTextList(run rt.Runtime) (g.Value, error)
- func (*CallPattern) TypeInfo() typeinfo.T
- type CallPattern_Slice
- type CommandError
- type CopyValue
- type CopyValue_Slice
- type Dot
- type DotField
- type DotIndex
- type Dot_Slot
- type Dot_Slots
- type Dotted
- type DottedPath
- type FromBool
- type FromBool_Slice
- type FromExe
- type FromExe_Slice
- type FromNumList
- type FromNumList_Slice
- type FromNumber
- type FromNumber_Slice
- type FromRecord
- type FromRecordList
- type FromRecordList_Slice
- type FromRecord_Slice
- type FromText
- type FromTextList
- type FromTextList_Slice
- type FromText_Slice
- type ObjectRef
- func (op *ObjectRef) GetBool(run rt.Runtime) (ret g.Value, err error)
- func (op *ObjectRef) GetFieldName(run rt.Runtime) (ret string, err error)
- func (op *ObjectRef) GetMarkup(ensure bool) map[string]any
- func (op *ObjectRef) GetNumList(run rt.Runtime) (g.Value, error)
- func (op *ObjectRef) GetNumber(run rt.Runtime) (g.Value, error)
- func (op *ObjectRef) GetObjectName(run rt.Runtime) (ret string, err error)
- func (op *ObjectRef) GetPath() []Dot
- func (op *ObjectRef) GetRecord(run rt.Runtime) (g.Value, error)
- func (op *ObjectRef) GetRecordList(run rt.Runtime) (g.Value, error)
- func (op *ObjectRef) GetText(run rt.Runtime) (g.Value, error)
- func (op *ObjectRef) GetTextList(run rt.Runtime) (g.Value, error)
- func (*ObjectRef) TypeInfo() typeinfo.T
- type ObjectRef_Slice
- type RefValue
- type RootValue
- type SetTrait
- type SetTrait_Slice
- type SetValue
- type SetValue_Slice
- type VariableRef
- func (op *VariableRef) GetBool(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetFieldName(run rt.Runtime) (ret string, err error)
- func (op *VariableRef) GetMarkup(ensure bool) map[string]any
- func (op *VariableRef) GetNumList(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetNumber(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetObjectName(run rt.Runtime) (string, error)
- func (op *VariableRef) GetPath() []Dot
- func (op *VariableRef) GetRecord(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetRecordList(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetText(run rt.Runtime) (ret g.Value, err error)
- func (op *VariableRef) GetTextList(run rt.Runtime) (ret g.Value, err error)
- func (*VariableRef) TypeInfo() typeinfo.T
- type VariableRef_Slice
Constants ¶
This section is empty.
Variables ¶
var Z_Types = typeinfo.TypeSet{
Name: "assign",
Slot: z_slot_list,
Flow: z_flow_list,
Signatures: z_signatures,
}
package listing of type data
var Zt_Address = typeinfo.Slot{ Name: "address", Markup: map[string]any{ "comment": []interface{}{"Identifies some particular object field, local variable, or pattern argument.", "Addresses can be read from or written to.", "That is to say, addresses implement all of the rt evals,", "and all commands which read from objects or variables should use the methods the address interface provides."}, }, }
address, a type of slot.
var Zt_Arg typeinfo.Flow
arg, a type of flow.
var Zt_AtField typeinfo.Flow
at_field, a type of flow.
var Zt_AtIndex typeinfo.Flow
at_index, a type of flow.
var Zt_CallPattern typeinfo.Flow
call_pattern, a type of flow.
var Zt_CopyValue typeinfo.Flow
copy_value, a type of flow.
var Zt_Dot = typeinfo.Slot{ Name: "dot", Markup: map[string]any{ "blockly-color": "MATH_HUE", "comment": "Picks values from types containing other values.", }, }
dot, a type of slot.
var Zt_FromBool typeinfo.Flow
from_bool, a type of flow.
var Zt_FromExe typeinfo.Flow
from_exe, a type of flow.
var Zt_FromNumList typeinfo.Flow
from_num_list, a type of flow.
var Zt_FromNumber typeinfo.Flow
from_number, a type of flow.
var Zt_FromRecord typeinfo.Flow
from_record, a type of flow.
var Zt_FromRecordList typeinfo.Flow
from_record_list, a type of flow.
var Zt_FromText typeinfo.Flow
from_text, a type of flow.
var Zt_FromTextList typeinfo.Flow
from_text_list, a type of flow.
var Zt_ObjectRef typeinfo.Flow
object_ref, a type of flow.
var Zt_SetTrait typeinfo.Flow
set_trait, a type of flow.
var Zt_SetValue typeinfo.Flow
set_value, a type of flow.
var Zt_VariableRef typeinfo.Flow
variable_ref, a type of flow.
Functions ¶
func CustomEncoder ¶
func ExpandArgs ¶
func GetAffinity ¶
func GetAffinity(a rt.Assignment) (ret affine.Affinity)
func Literal ¶
func Literal(v literal.LiteralValue) (ret rt.Assignment)
turn a literal into an assignment ( whats's the right package for this function? )
Types ¶
type Address ¶
type Address interface { // returns the object name, meta.Variables, or an error GetObjectName(rt.Runtime) (string, error) // returns the targeted field in the named object, the targeted variable, or an error GetFieldName(rt.Runtime) (string, error) // path within the value identified by this reference GetPath() []Dot }
uniform access to objects and variables implemented by the members of Address
type Address_Slot ¶
type Address_Slot struct{ Value Address }
holds a single slot.
func (*Address_Slot) TypeInfo ¶
func (*Address_Slot) TypeInfo() typeinfo.T
implements typeinfo.Instance for a single slot.
type Address_Slots ¶
type Address_Slots []Address
holds a slice of slots.
func (*Address_Slots) TypeInfo ¶
func (*Address_Slots) TypeInfo() typeinfo.T
implements typeinfo.Instance for a series of slots.
type Arg ¶
type Arg struct { Name string Value rtti.Assignment Markup map[string]any }
Runtime version of argument.
type AtField_Slice ¶
type AtField_Slice []AtField
holds a slice of type at_field
func (*AtField_Slice) TypeInfo ¶
func (*AtField_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type AtIndex ¶
type AtIndex struct { Index rtti.NumberEval Markup map[string]any }
type AtIndex_Slice ¶
type AtIndex_Slice []AtIndex
holds a slice of type at_index
func (*AtIndex_Slice) TypeInfo ¶
func (*AtIndex_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type CallPattern ¶
Executes a pattern, and potentially returns a value.
func (*CallPattern) GetMarkup ¶
func (op *CallPattern) GetMarkup(ensure bool) map[string]any
implements typeinfo.Markup
func (*CallPattern) GetNumList ¶
func (*CallPattern) GetRecordList ¶
func (*CallPattern) GetTextList ¶
func (*CallPattern) TypeInfo ¶
func (*CallPattern) TypeInfo() typeinfo.T
implements typeinfo.Instance
type CallPattern_Slice ¶
type CallPattern_Slice []CallPattern
holds a slice of type call_pattern
func (*CallPattern_Slice) Repeats ¶
func (op *CallPattern_Slice) Repeats() bool
implements typeinfo.Repeats
func (*CallPattern_Slice) TypeInfo ¶
func (*CallPattern_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type CommandError ¶
func (CommandError) Error ¶
func (e CommandError) Error() string
type CopyValue ¶
Copy from one stored value to another. Requires that the type of the two values match exactly
type CopyValue_Slice ¶
type CopyValue_Slice []CopyValue
holds a slice of type copy_value
func (*CopyValue_Slice) Repeats ¶
func (op *CopyValue_Slice) Repeats() bool
implements typeinfo.Repeats
func (*CopyValue_Slice) TypeInfo ¶
func (*CopyValue_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type Dotted ¶
type Dotted interface { Peek(rt.Runtime, g.Value) (g.Value, error) Poke(run rt.Runtime, target, value g.Value) error // contains filtered or unexported methods }
Dotted is an intermediate stage in picking values
type DottedPath ¶
type DottedPath []Dotted
func ResolvePath ¶
func ResolvePath(run rt.Runtime, dots []Dot) (ret DottedPath, err error)
Resolving is somewhat superfluous: while it could happen during peek and poke having all of the elements resolved ahead of time is better for debugging.
func (DottedPath) String ¶
func (dl DottedPath) String() string
type FromBool ¶
Calculates a boolean value.
func (*FromBool) GetAssignedValue ¶
type FromBool_Slice ¶
type FromBool_Slice []FromBool
holds a slice of type from_bool
func (*FromBool_Slice) Repeats ¶
func (op *FromBool_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromBool_Slice) TypeInfo ¶
func (*FromBool_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromExe ¶
Adapts an execute statement to an assignment. Used internally for package shuttle.
func (*FromExe) GetAssignedValue ¶
type FromExe_Slice ¶
type FromExe_Slice []FromExe
holds a slice of type from_exe
func (*FromExe_Slice) TypeInfo ¶
func (*FromExe_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromNumList ¶
type FromNumList struct { Value rtti.NumListEval Markup map[string]any }
Calculates a list of numbers.
func (*FromNumList) GetAssignedValue ¶
func (*FromNumList) GetMarkup ¶
func (op *FromNumList) GetMarkup(ensure bool) map[string]any
implements typeinfo.Markup
func (*FromNumList) TypeInfo ¶
func (*FromNumList) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromNumList_Slice ¶
type FromNumList_Slice []FromNumList
holds a slice of type from_num_list
func (*FromNumList_Slice) Repeats ¶
func (op *FromNumList_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromNumList_Slice) TypeInfo ¶
func (*FromNumList_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromNumber ¶
type FromNumber struct { Value rtti.NumberEval Markup map[string]any }
Calculates a number.
func (*FromNumber) GetAssignedValue ¶
type FromNumber_Slice ¶
type FromNumber_Slice []FromNumber
holds a slice of type from_number
func (*FromNumber_Slice) Repeats ¶
func (op *FromNumber_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromNumber_Slice) TypeInfo ¶
func (*FromNumber_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromRecord ¶
type FromRecord struct { Value rtti.RecordEval Markup map[string]any }
Calculates a record.
func (*FromRecord) GetAssignedValue ¶
type FromRecordList ¶
type FromRecordList struct { Value rtti.RecordListEval Markup map[string]any }
Calculates a list of records.
func (*FromRecordList) GetAssignedValue ¶
func (*FromRecordList) GetMarkup ¶
func (op *FromRecordList) GetMarkup(ensure bool) map[string]any
implements typeinfo.Markup
func (*FromRecordList) TypeInfo ¶
func (*FromRecordList) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromRecordList_Slice ¶
type FromRecordList_Slice []FromRecordList
holds a slice of type from_record_list
func (*FromRecordList_Slice) Repeats ¶
func (op *FromRecordList_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromRecordList_Slice) TypeInfo ¶
func (*FromRecordList_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromRecord_Slice ¶
type FromRecord_Slice []FromRecord
holds a slice of type from_record
func (*FromRecord_Slice) Repeats ¶
func (op *FromRecord_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromRecord_Slice) TypeInfo ¶
func (*FromRecord_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromText ¶
Calculates a text string.
func (*FromText) GetAssignedValue ¶
type FromTextList ¶
type FromTextList struct { Value rtti.TextListEval Markup map[string]any }
Calculates a list of text strings.
func (*FromTextList) GetAssignedValue ¶
func (*FromTextList) GetMarkup ¶
func (op *FromTextList) GetMarkup(ensure bool) map[string]any
implements typeinfo.Markup
func (*FromTextList) TypeInfo ¶
func (*FromTextList) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromTextList_Slice ¶
type FromTextList_Slice []FromTextList
holds a slice of type from_text_list
func (*FromTextList_Slice) Repeats ¶
func (op *FromTextList_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromTextList_Slice) TypeInfo ¶
func (*FromTextList_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type FromText_Slice ¶
type FromText_Slice []FromText
holds a slice of type from_text
func (*FromText_Slice) Repeats ¶
func (op *FromText_Slice) Repeats() bool
implements typeinfo.Repeats
func (*FromText_Slice) TypeInfo ¶
func (*FromText_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type ObjectRef ¶
func (*ObjectRef) GetFieldName ¶
func (*ObjectRef) GetObjectName ¶
func (*ObjectRef) GetRecordList ¶
type ObjectRef_Slice ¶
type ObjectRef_Slice []ObjectRef
holds a slice of type object_ref
func (*ObjectRef_Slice) Repeats ¶
func (op *ObjectRef_Slice) Repeats() bool
implements typeinfo.Repeats
func (*ObjectRef_Slice) TypeInfo ¶
func (*ObjectRef_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type RefValue ¶
type RefValue struct {
Object, Field string
Path DottedPath
}
the location of a value in the runtime.
func GetReference ¶
determine the location of a value
func (*RefValue) GetRootValue ¶
pull the object.field value from the runtime
func (*RefValue) SetDirty ¶
let an object know if its inner contents has changed ( not needed if SetValue got called directly )
type RootValue ¶
a value and its location pulled from an object in the runtime. path indicates a further as yet examined value that can be extracted from the root value.
func GetRootValue ¶
pull the object.field value from the runtime ( without expanding its path )
func ResolveName ¶
note: currently templates can't analyze the context they're being called in, so: if the command is being used to get an object value and no variable can be found in the current context of the requested name, see if the requested name is an object instead.
func (*RootValue) ConvertValue ¶
FIX: convert and warn instead of error on field affinity checks
func (*RootValue) GetCheckedValue ¶
type SetTrait_Slice ¶
type SetTrait_Slice []SetTrait
holds a slice of type set_trait
func (*SetTrait_Slice) Repeats ¶
func (op *SetTrait_Slice) Repeats() bool
implements typeinfo.Repeats
func (*SetTrait_Slice) TypeInfo ¶
func (*SetTrait_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type SetValue ¶
type SetValue struct { Target Address Value rtti.Assignment Markup map[string]any }
Store a value into a variable or object.
type SetValue_Slice ¶
type SetValue_Slice []SetValue
holds a slice of type set_value
func (*SetValue_Slice) Repeats ¶
func (op *SetValue_Slice) Repeats() bool
implements typeinfo.Repeats
func (*SetValue_Slice) TypeInfo ¶
func (*SetValue_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance
type VariableRef ¶
func (*VariableRef) GetFieldName ¶
func (op *VariableRef) GetFieldName(run rt.Runtime) (ret string, err error)
func (*VariableRef) GetMarkup ¶
func (op *VariableRef) GetMarkup(ensure bool) map[string]any
implements typeinfo.Markup
func (*VariableRef) GetNumList ¶
func (*VariableRef) GetObjectName ¶
func (op *VariableRef) GetObjectName(run rt.Runtime) (string, error)
always returns meta.Variables as its object
func (*VariableRef) GetPath ¶
func (op *VariableRef) GetPath() []Dot
func (*VariableRef) GetRecordList ¶
func (*VariableRef) GetTextList ¶
func (*VariableRef) TypeInfo ¶
func (*VariableRef) TypeInfo() typeinfo.T
implements typeinfo.Instance
type VariableRef_Slice ¶
type VariableRef_Slice []VariableRef
holds a slice of type variable_ref
func (*VariableRef_Slice) Repeats ¶
func (op *VariableRef_Slice) Repeats() bool
implements typeinfo.Repeats
func (*VariableRef_Slice) TypeInfo ¶
func (*VariableRef_Slice) TypeInfo() typeinfo.T
implements typeinfo.Instance