lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lang: ast, interfaces, interpret: Table should be a well-known type

Browse Source 
We use this in enough places, that it's nice to have it as a well-known
alias.
This commit is contained in:
James Shubin
2025-07-07 20:46:13 -04:00
parent 73e641120f
commit d113fcb6d7
4 changed files with 21 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
lang/ast/structs.go
View File

@@ -364,7 +364,7 @@ func (obj *StmtBind) privateGraph(env *interfaces.Env) (*pgraph.Graph, interface
// Output for the bind statement produces no output. Any values of interest come // Output for the bind statement produces no output. Any values of interest come
// from the use of the var which this binds the expression to. // from the use of the var which this binds the expression to.
func (obj *StmtBind) Output(map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtBind) Output(interfaces.Table) (*interfaces.Output, error) {
return interfaces.EmptyOutput(), nil return interfaces.EmptyOutput(), nil
} }
@@ -796,7 +796,7 @@ func (obj *StmtRes) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// analogous function for expressions is Value. Those Value functions might get // analogous function for expressions is Value. Those Value functions might get
// called by this Output function if they are needed to produce the output. In // called by this Output function if they are needed to produce the output. In
// the case of this resource statement, this is definitely the case. // the case of this resource statement, this is definitely the case.
func (obj *StmtRes) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtRes) Output(table interfaces.Table) (*interfaces.Output, error) {
if obj.namePtr == nil { if obj.namePtr == nil {
return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj) return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj)
} }
@@ -939,7 +939,7 @@ func (obj *StmtRes) Output(table map[interfaces.Func]types.Value) (*interfaces.O
} }
// collect is a helper function to pull out the collected resource data. // collect is a helper function to pull out the collected resource data.
func (obj *StmtRes) collect(table map[interfaces.Func]types.Value) (map[string]map[string]string, error) { func (obj *StmtRes) collect(table interfaces.Table) (map[string]map[string]string, error) {
if !obj.Collect { if !obj.Collect {
return nil, nil // nothing to do return nil, nil // nothing to do
} }
@@ -1034,7 +1034,7 @@ func (obj *StmtRes) collect(table map[interfaces.Func]types.Value) (map[string]m
// resource is a helper function to generate the res that comes from this. // resource is a helper function to generate the res that comes from this.
// TODO: it could memoize some of the work to avoid re-computation when looped // TODO: it could memoize some of the work to avoid re-computation when looped
func (obj *StmtRes) resource(table map[interfaces.Func]types.Value, resName, data string) (engine.Res, error) { func (obj *StmtRes) resource(table interfaces.Table, resName, data string) (engine.Res, error) {
res, err := engine.NewNamedResource(obj.Kind, resName) res, err := engine.NewNamedResource(obj.Kind, resName)
if err != nil { if err != nil {
return nil, errwrap.Wrapf(err, "cannot create resource kind `%s` with named `%s`", obj.Kind, resName) return nil, errwrap.Wrapf(err, "cannot create resource kind `%s` with named `%s`", obj.Kind, resName)
@@ -1145,7 +1145,7 @@ func (obj *StmtRes) resource(table map[interfaces.Func]types.Value, resName, dat
} }
// edges is a helper function to generate the edges that come from the resource. // edges is a helper function to generate the edges that come from the resource.
func (obj *StmtRes) edges(table map[interfaces.Func]types.Value, resName string) ([]*interfaces.Edge, error) { func (obj *StmtRes) edges(table interfaces.Table, resName string) ([]*interfaces.Edge, error) {
edges := []*interfaces.Edge{} edges := []*interfaces.Edge{}
// to and from self, map of kind, name, notify // to and from self, map of kind, name, notify
@@ -1279,7 +1279,7 @@ func (obj *StmtRes) edges(table map[interfaces.Func]types.Value, resName string)
// metaparams is a helper function to get the metaparams that come from the // metaparams is a helper function to get the metaparams that come from the
// resource AST so we can eventually set them on the individual resource. // resource AST so we can eventually set them on the individual resource.
func (obj *StmtRes) metaparams(table map[interfaces.Func]types.Value) (func(engine.Res), error) { func (obj *StmtRes) metaparams(table interfaces.Table) (func(engine.Res), error) {
apply := []func(engine.Res){} apply := []func(engine.Res){}
for _, line := range obj.Contents { for _, line := range obj.Contents {
@@ -2949,7 +2949,7 @@ func (obj *StmtEdge) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// called by this Output function if they are needed to produce the output. In // called by this Output function if they are needed to produce the output. In
// the case of this edge statement, this is definitely the case. This edge stmt // the case of this edge statement, this is definitely the case. This edge stmt
// returns output consisting of edges. // returns output consisting of edges.
func (obj *StmtEdge) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtEdge) Output(table interfaces.Table) (*interfaces.Output, error) {
edges := []*interfaces.Edge{} edges := []*interfaces.Edge{}
// EdgeHalfList goes in a chain, so we increment like i++ and not i+=2. // EdgeHalfList goes in a chain, so we increment like i++ and not i+=2.
@@ -3538,7 +3538,7 @@ func (obj *StmtIf) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// is used to build the output graph. This only exists for statements. The // is used to build the output graph. This only exists for statements. The
// analogous function for expressions is Value. Those Value functions might get // analogous function for expressions is Value. Those Value functions might get
// called by this Output function if they are needed to produce the output. // called by this Output function if they are needed to produce the output.
func (obj *StmtIf) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtIf) Output(table interfaces.Table) (*interfaces.Output, error) {
if obj.conditionPtr == nil { if obj.conditionPtr == nil {
return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj) return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj)
} }
@@ -4050,7 +4050,7 @@ func (obj *StmtFor) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// is used to build the output graph. This only exists for statements. The // is used to build the output graph. This only exists for statements. The
// analogous function for expressions is Value. Those Value functions might get // analogous function for expressions is Value. Those Value functions might get
// called by this Output function if they are needed to produce the output. // called by this Output function if they are needed to produce the output.
func (obj *StmtFor) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtFor) Output(table interfaces.Table) (*interfaces.Output, error) {
if obj.exprPtr == nil { if obj.exprPtr == nil {
return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj) return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj)
} }
@@ -4552,7 +4552,7 @@ func (obj *StmtForKV) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// is used to build the output graph. This only exists for statements. The // is used to build the output graph. This only exists for statements. The
// analogous function for expressions is Value. Those Value functions might get // analogous function for expressions is Value. Those Value functions might get
// called by this Output function if they are needed to produce the output. // called by this Output function if they are needed to produce the output.
func (obj *StmtForKV) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtForKV) Output(table interfaces.Table) (*interfaces.Output, error) {
if obj.exprPtr == nil { if obj.exprPtr == nil {
return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj) return nil, fmt.Errorf("%w: %T", ErrFuncPointerNil, obj)
} }
@@ -6127,7 +6127,7 @@ func (obj *StmtProg) updateEnv(env *interfaces.Env) (*pgraph.Graph, *interfaces.
// is used to build the output graph. This only exists for statements. The // is used to build the output graph. This only exists for statements. The
// analogous function for expressions is Value. Those Value functions might get // analogous function for expressions is Value. Those Value functions might get
// called by this Output function if they are needed to produce the output. // called by this Output function if they are needed to produce the output.
func (obj *StmtProg) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtProg) Output(table interfaces.Table) (*interfaces.Output, error) {
resources := []engine.Res{} resources := []engine.Res{}
edges := []*interfaces.Edge{} edges := []*interfaces.Edge{}
@@ -6402,7 +6402,7 @@ func (obj *StmtFunc) Graph(*interfaces.Env) (*pgraph.Graph, error) {
// Output for the func statement produces no output. Any values of interest come // Output for the func statement produces no output. Any values of interest come
// from the use of the func which this binds the function to. // from the use of the func which this binds the function to.
func (obj *StmtFunc) Output(map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtFunc) Output(interfaces.Table) (*interfaces.Output, error) {
return interfaces.EmptyOutput(), nil return interfaces.EmptyOutput(), nil
} }
@@ -6614,7 +6614,7 @@ func (obj *StmtClass) Graph(env *interfaces.Env) (*pgraph.Graph, error) {
// come from the use of the include which this binds the statements to. This is // come from the use of the include which this binds the statements to. This is
// usually called from the parent in StmtProg, but it skips running it so that // usually called from the parent in StmtProg, but it skips running it so that
// it can be called from the StmtInclude Output method. // it can be called from the StmtInclude Output method.
func (obj *StmtClass) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtClass) Output(table interfaces.Table) (*interfaces.Output, error) {
return obj.Body.Output(table) return obj.Body.Output(table)
} }
@@ -7112,7 +7112,7 @@ func (obj *StmtInclude) updateEnv(env *interfaces.Env) (*pgraph.Graph, *interfac
// called by this Output function if they are needed to produce the output. The // called by this Output function if they are needed to produce the output. The
// ultimate source of this output comes from the previously defined StmtClass // ultimate source of this output comes from the previously defined StmtClass
// which should be found in our scope. // which should be found in our scope.
func (obj *StmtInclude) Output(table map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtInclude) Output(table interfaces.Table) (*interfaces.Output, error) {
return obj.class.Output(table) return obj.class.Output(table)
} }
@@ -7222,7 +7222,7 @@ func (obj *StmtImport) Graph(*interfaces.Env) (*pgraph.Graph, error) {
// called by this Output function if they are needed to produce the output. This // called by this Output function if they are needed to produce the output. This
// import statement itself produces no output, as it is only used to populate // import statement itself produces no output, as it is only used to populate
// the scope so that others can use that to produce values and output. // the scope so that others can use that to produce values and output.
func (obj *StmtImport) Output(map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtImport) Output(interfaces.Table) (*interfaces.Output, error) {
return interfaces.EmptyOutput(), nil return interfaces.EmptyOutput(), nil
} }
@@ -7309,7 +7309,7 @@ func (obj *StmtComment) Graph(*interfaces.Env) (*pgraph.Graph, error) {
} }
// Output for the comment statement produces no output. // Output for the comment statement produces no output.
func (obj *StmtComment) Output(map[interfaces.Func]types.Value) (*interfaces.Output, error) { func (obj *StmtComment) Output(interfaces.Table) (*interfaces.Output, error) {
return interfaces.EmptyOutput(), nil return interfaces.EmptyOutput(), nil
} }

2
lang/interfaces/ast.go
View File

@@ -94,7 +94,7 @@ type Stmt interface {
// Output returns the output that this "program" produces. This output // Output returns the output that this "program" produces. This output
// is what is used to build the output graph. It requires the input // is what is used to build the output graph. It requires the input
// table of values that are used to populate each function. // table of values that are used to populate each function.
Output(map[Func]types.Value) (*Output, error) Output(Table) (*Output, error)
} }
// Expr represents an expression in the language. Expr implementations must have // Expr represents an expression in the language. Expr implementations must have

3
lang/interfaces/func.go
View File

@@ -44,6 +44,9 @@ import (
// FuncSig is the simple signature that is used throughout our implementations. // FuncSig is the simple signature that is used throughout our implementations.
type FuncSig = func(context.Context, []types.Value) (types.Value, error) type FuncSig = func(context.Context, []types.Value) (types.Value, error)
// Table is the type of language table fields.
type Table = map[Func]types.Value
// GraphSig is the simple signature that is used throughout our implementations. // GraphSig is the simple signature that is used throughout our implementations.
// TODO: Rename this? // TODO: Rename this?
type GraphSig = func(Txn, []Func) (Func, error) type GraphSig = func(Txn, []Func) (Func, error)

3
lang/interpret/interpret.go
View File

@@ -37,7 +37,6 @@ import (
"github.com/purpleidea/mgmt/engine" "github.com/purpleidea/mgmt/engine"
engineUtil "github.com/purpleidea/mgmt/engine/util" engineUtil "github.com/purpleidea/mgmt/engine/util"
"github.com/purpleidea/mgmt/lang/interfaces" "github.com/purpleidea/mgmt/lang/interfaces"
"github.com/purpleidea/mgmt/lang/types"
"github.com/purpleidea/mgmt/pgraph" "github.com/purpleidea/mgmt/pgraph"
"github.com/purpleidea/mgmt/util/errwrap" "github.com/purpleidea/mgmt/util/errwrap"
) )
@@ -74,7 +73,7 @@ type Interpreter struct {
// requires an AST, and the table of values required to populate that AST. Type // requires an AST, and the table of values required to populate that AST. Type
// unification, and earlier steps should obviously be run first so that you can // unification, and earlier steps should obviously be run first so that you can
// actually get a useful resource graph out of this instead of an error! // actually get a useful resource graph out of this instead of an error!
func (obj *Interpreter) Interpret(ast interfaces.Stmt, table map[interfaces.Func]types.Value) (*pgraph.Graph, error) { func (obj *Interpreter) Interpret(ast interfaces.Stmt, table interfaces.Table) (*pgraph.Graph, error) {
// build the kind,name -> res mapping // build the kind,name -> res mapping
obj.lookup = make(map[engine.ResPtrUID]engine.Res) obj.lookup = make(map[engine.ResPtrUID]engine.Res)