initial commit for leaf setters

generator/generator.go

@@ -71,6 +71,7 @@ var (
 	generateGetters     = flag.Bool("generate_getters", false, "If set to true, getter methdos that retrieve or create an element are generated for YANG container (Go struct pointer) or list (Go map) fields within the generated code.")
 	generateDelete      = flag.Bool("generate_delete", false, "If set to true, delete methods are generated for YANG lists (Go maps) within the Go code.")
 	generateLeafGetters = flag.Bool("generate_leaf_getters", false, "If set to true, getters for YANG leaves are generated within the Go code. Caution should be exercised when using leaf getters, since values that are explicitly set to the Go default/zero value are not distinguishable from those that are unset when retrieved via the GetXXX method.")
+	generateLeafSetters = flag.Bool("generate_leaf_setters", false, "If set to true, setters for YANG leaves are generated within the Go code.")
 	includeModelData    = flag.Bool("include_model_data", false, "If set to true, a slice of gNMI ModelData messages are included in the generated Go code containing the details of the input schemas from which the code was generated.")
 )
 
@@ -251,6 +252,7 @@ func main() {
 			GenerateDeleteMethod: *generateDelete,
 			GenerateAppendMethod: *generateAppend,
 			GenerateLeafGetters:  *generateLeafGetters,
+			GenerateLeafSetters:  *generateLeafSetters,
 			IncludeModelData:     *includeModelData,
 		},
 		ExcludeState: *excludeState,

ygen/codegen.go

@@ -135,6 +135,9 @@ type GoOpts struct {
 	// whether a field has been explicitly set to the zero value (i.e., an integer
 	// field is set to 0), or whether the field was actually unset.
 	GenerateLeafGetters bool
+	// GenerateLeafSetters specifies whether Set* methods should be created for
+	// leaf fields of a struct.
+	GenerateLeafSetters bool
 	// GNMIProtoPath specifies the path to the generated gNMI protobuf, which
 	// is used to store the catalogue entries for generated modules.
 	GNMIProtoPath string

ygen/gogen.go

@@ -310,6 +310,26 @@ type generatedLeafGetter struct {
 	Receiver string
 }
 
+// generatedLeafSetter is used to represent the parameters required to generate a
+// setter for a leaf within the generated Go code.
+type generatedLeafSetter struct {
+	// Name is the name of the field. It is used as a suffix to Get to generate
+	// the getter.
+	Name string
+	// Type is the type of the field, returned by the generated method.
+	Type string
+	// Zero is the value that should be returned if the field is set to nil.
+	Zero string
+	// Default is the default value specified in the YANG schema for the type
+	// or leaf.
+	Default *string
+	// IsPtr stores whether the value is a pointer, such that it can be checked
+	// against nil, or against the zero value.
+	IsPtr bool
+	// Receiver is the name of the receiver for the getter method.
+	Receiver string
+}
+
 var (
 	// goCommonHeaderTemplate is populated and output at the top of the generated code package
 	goCommonHeaderTemplate = `
@@ -730,6 +750,19 @@ func (t *{{ .Receiver }}) Get{{ .Name }}() {{ .Type }} {
 	}
 	return {{ if .IsPtr -}} * {{- end -}} t.{{ .Name }}
 }
+`
+
+	// goLeafSetterTemplate defines a template for a function that, for a
+	// particular leaf, generates a setter method.
+	goLeafSetterTemplate = `
+// Set{{ .Name }} sets the value of the leaf {{ .Name }} from the {{ .Receiver }}
+// struct. 
+func (t *{{ .Receiver }}) Set{{ .Name }}(val string) {
+	if t == nil || val == "" {
+		return
+	}
+	t.{{ .Name }} = ygot.String(val)
+}
 `
 
 	// goDeleteListTemplate defines a template for a function that, for a
@@ -1031,6 +1064,7 @@ func (t *{{ .ParentReceiver }}) To_{{ .Name }}(i interface{}) ({{ .Name }}, erro
 		"getList":             makeTemplate("getList", goListGetterTemplate),
 		"getContainer":        makeTemplate("getContainer", goContainerGetterTemplate),
 		"getLeaf":             makeTemplate("getLeaf", goLeafGetterTemplate),
+		"setLeaf":             makeTemplate("setLeaf", goLeafSetterTemplate),
 	}
 
 	// templateHelperFunctions specifies a set of functions that are supplied as
@@ -1190,6 +1224,11 @@ func writeGoStruct(targetStruct *yangDirectory, goStructElements map[string]*yan
 	// is set to true.
 	var associatedLeafGetters []*generatedLeafGetter
 
+	// associatedLeafSetters is a slice of structs which define the set of leaf setters
+	// to generated for the struct. It is only populated if the GenerateLeafSetters option
+	// is set to true.
+	var associatedLeafSetters []*generatedLeafSetter
+
 	// Sort the list of fields into alphabetical order to ensure determinstic output of code,
 	// and minimise diffs.
 	var fieldNames []string
@@ -1388,6 +1427,20 @@ func writeGoStruct(targetStruct *yangDirectory, goStructElements map[string]*yan
 				})
 			}
 
+			if goOpts.GenerateLeafSetters {
+				// If we are generating leaf setters, then append the relevant information
+				// to the associatedLeafSetters slice to be generated along with other
+				// associated methods.
+				associatedLeafSetters = append(associatedLeafSetters, &generatedLeafSetter{
+					Name:     fieldName,
+					Type:     fType,
+					Zero:     zeroValue,
+					IsPtr:    scalarField,
+					Receiver: targetStruct.name,
+					Default:  defaultValue,
+				})
+			}
+
 			fieldDef = &goStructField{
 				Name:          fieldName,
 				Type:          fType,
@@ -1518,6 +1571,12 @@ func writeGoStruct(targetStruct *yangDirectory, goStructElements map[string]*yan
 		}
 	}
 
+	if goOpts.GenerateLeafSetters {
+		if err := generateLeafSetters(&methodBuf, associatedLeafSetters); err != nil {
+			errs = append(errs, err)
+		}
+	}
+
 	if err := generateGetListKey(&methodBuf, targetStruct, definedNameMap); err != nil {
 		errs = append(errs, err)
 	}
@@ -1653,6 +1712,18 @@ func generateLeafGetters(buf *bytes.Buffer, leaves []*generatedLeafGetter) error
 	return errs.Err()
 }
 
+// generateLeafSetters generates SetXXX methods for the leaf fields described by
+// the supplied slice of generatedLeafSetter structs.
+func generateLeafSetters(buf *bytes.Buffer, leaves []*generatedLeafSetter) error {
+	var errs errlist.List
+	for _, l := range leaves {
+		if err := goTemplates["setLeaf"].Execute(buf, l); err != nil {
+			errs.Add(err)
+		}
+	}
+	return errs.Err()
+}
+
 // generateGetOrCreateList generates a getter function similar to that created
 // by the generateGetOrCreateStruct function for maps within the generated Go
 // code (which represent YANG lists). It handles both simple and composite key