query

type CheckData struct {
	Name   string
	Domain string
	Aff    affine.Affinity
	Prog   []byte // a serialized rt.Execute_Slice
	Value  []byte // a serialized literal.Value
}

type FieldData struct {
	Name     string
	Affinity affine.Affinity
	Class    string
}

type NotImplemented string

type NounInfo struct {
	Domain, Id, Kind string // id is the string identifier for the noun, unique within the domain.
}

type Query interface {
	IsDomainActive(name string) (bool, error)
	ActivateDomains(name string) (prev, next []string, err error)
	ReadChecks(actuallyJustThisOne string) ([]CheckData, error)
	// every field exclusive to the passed kind
	FieldsOf(kind string) ([]FieldData, error)
	// given a plural or singular kind
	// return the names of the ancestors, ending with the kind itself
	KindOfAncestors(kind string) ([]string, error)
	KindValues(id string) ([]ValueData, error)
	NounInfo(name string) (NounInfo, error)
	NounName(id string) (string, error)
	NounNames(id string) ([]string, error)
	// a single field can contain a set of recursive spare values;
	// so this returns pairs of path, value.
	NounValues(id, field string) ([]ValueData, error)
	NounsByKind(kind string) ([]string, error)
	PluralToSingular(plural string) (string, error)
	PluralFromSingular(singular string) (string, error)
	// includes the parameters, followed by the result
	// the result can be a blank string for execute statements
	PatternLabels(pat string) ([]string, error)
	RulesFor(pat string) ([]RuleData, error)
	ReciprocalsOf(rel, id string) ([]string, error)
	RelativesOf(rel, id string) ([]string, error)
	Relate(rel, noun, otherNoun string) error
}

type QueryNone string

type RuleData struct {
	Name    string
	Stop    bool
	Jump    int
	Updates bool
	Prog    []byte // a serialized rt.Execute_Slice
}

type ValueData struct {
	Field string
	Path  string
	Value []byte // a serialized assignment or literal
}