Initial code to generate service code.

v2alpha/cmd/goupnp2srvgen/main.go

@@ -6,14 +6,22 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"path/filepath"
+	"sort"
+	"strconv"
 	"strings"
+	"text/template"
 
+	"github.com/huin/goupnp/v2alpha/cmd/goupnp2srvgen/tmplfuncs"
 	"github.com/huin/goupnp/v2alpha/cmd/goupnp2srvgen/zipread"
 	"github.com/huin/goupnp/v2alpha/description/srvdesc"
+	"github.com/huin/goupnp/v2alpha/description/typedesc"
 	"github.com/huin/goupnp/v2alpha/description/xmlsrvdesc"
+	"github.com/huin/goupnp/v2alpha/soap/types"
 )
 
 var (
+	srvTemplate      = flag.String("srv_template", "", "Path to srv.gotemplate.")
 	upnpresourcesZip = flag.String("upnpresources_zip", "", "Path to upnpresources.zip.")
 )
 
@@ -29,6 +37,17 @@ func run() error {
 	if len(flag.Args()) > 0 {
 		return fmt.Errorf("unused arguments: %s", strings.Join(flag.Args(), " "))
 	}
+	if *srvTemplate == "" {
+		return errors.New("-srv_template is a required flag.")
+	}
+	tmpl, err := template.New(filepath.Base(*srvTemplate)).Funcs(template.FuncMap{
+		"args":  tmplfuncs.Args,
+		"quote": strconv.Quote,
+	}).ParseFiles(*srvTemplate)
+	if err != nil {
+		return fmt.Errorf("loading srv_template %q: %w", *srvTemplate, err)
+	}
+
 	if *upnpresourcesZip == "" {
 		return errors.New("-upnpresources_zip is a required flag.")
 	}
@@ -41,8 +60,13 @@ func run() error {
 	if err != nil {
 		return err
 	}
+
+	// Use default type map for now. Addtional types could be use instead or
+	// as well as necessary for extended types.
+	typeMap := types.TypeMap()
+
 	for _, m := range manifests {
-		if err := processDCP(upnpresources, m); err != nil {
+		if err := processDCP(upnpresources, m, typeMap, tmpl); err != nil {
 			return fmt.Errorf("processing DCP %s: %w", m.Path, err)
 		}
 	}
@@ -52,9 +76,17 @@ func run() error {
 var manifests = []*DCPSpecManifest{
 	{
 		Path: "standardizeddcps/Internet Gateway_2/UPnP-gw-IGD-TestFiles-20101210.zip",
-		Services: map[string]string{
-			"LANHostConfigManagement:1": "xml data files/service/LANHostConfigManagement1.xml",
-			"WANPPPConnection:1":        "xml data files/service/WANPPPConnection1.xml",
+		Services: []*ServiceManifest{
+			{
+				Package: "lanhostconfigmanagement1",
+				Type:    "urn:schemas-upnp-org:service:LANHostConfigManagement:1",
+				Path:    "xml data files/service/LANHostConfigManagement1.xml",
+			},
+			{
+				Package: "wanpppconnection1",
+				Type:    "urn:schemas-upnp-org:service:WANPPPConnection:1",
+				Path:    "xml data files/service/WANPPPConnection1.xml",
+			},
 		},
 	},
 }
@@ -62,14 +94,16 @@ var manifests = []*DCPSpecManifest{
 func processDCP(
 	upnpresources *zipread.ZipRead,
 	manifest *DCPSpecManifest,
+	typeMap typedesc.TypeMap,
+	tmpl *template.Template,
 ) error {
 	dcpSpecData, err := upnpresources.OpenZip(manifest.Path)
 	if err != nil {
 		return err
 	}
-	for name, path := range manifest.Services {
-		if err := processService(dcpSpecData, name, path); err != nil {
-			return fmt.Errorf("processing service %s: %w", name, err)
+	for _, srvManifest := range manifest.Services {
+		if err := processService(dcpSpecData, srvManifest, typeMap, tmpl); err != nil {
+			return fmt.Errorf("processing service %s: %w", srvManifest.Type, err)
 		}
 	}
 	return nil
@@ -77,11 +111,11 @@ func processDCP(
 
 func processService(
 	dcpSpecData *zipread.ZipRead,
-	name string,
-	path string,
+	srvManifest *ServiceManifest,
+	typeMap typedesc.TypeMap,
+	tmpl *template.Template,
 ) error {
-	fmt.Printf("%s\n", name)
-	f, err := dcpSpecData.Open(path)
+	f, err := dcpSpecData.Open(srvManifest.Path)
 	if err != nil {
 		return err
 	}
@@ -108,10 +142,24 @@ func processService(
 		}
 	}
 
-	_, err = srvdesc.FromXML(xmlSCPD)
+	sd, err := srvdesc.FromXML(xmlSCPD)
+	if err != nil {
+		return fmt.Errorf("transforming service description: %w", err)
+	}
+
+	imps, err := accumulateImports(sd, typeMap)
 	if err != nil {
 		return err
 	}
+
+	err = tmpl.ExecuteTemplate(os.Stdout, "service", tmplArgs{
+		Imps: imps,
+		SCPD: sd,
+	})
+	if err != nil {
+		return fmt.Errorf("executing srv_template: %w", err)
+	}
+
 	return nil
 }
 
@@ -120,5 +168,128 @@ type DCPSpecManifest struct {
 	Path string
 	// Services maps from a service name (e.g. "FooBar:1") to a path within the DCP spec ZIP file
 	// (e.g. "xml data files/service/FooBar1.xml").
-	Services map[string]string
+	Services []*ServiceManifest
+}
+
+type ServiceManifest struct {
+	// Package is the Go package name to generate e.g. "foo1".
+	Package string
+	// Type is the SOAP namespace and service type that identifes the service e.g.
+	// "urn:schemas-upnp-org:service:Foo:1"
+	Type string
+	// Path within the DCP spec ZIP file e.g. "xml data files/service/Foo1.xml".
+	Path string
+}
+
+type tmplArgs struct {
+	Imps *imports
+	SCPD *srvdesc.SCPD
+}
+
+type imports struct {
+	// Maps from a type name like "ui4" to the `alias.name` for the import.
+	TypeRefByTypeName map[string]string
+	// Each required import line, ordered by path.
+	ImportLines []importItem
+}
+
+type importItem struct {
+	Alias string
+	Path  string
+}
+
+func accumulateImports(srvDesc *srvdesc.SCPD, typeMap typedesc.TypeMap) (*imports, error) {
+	typeNames := make(map[string]bool)
+	err := visitTypesSCPD(srvDesc, func(typeName string) {
+		typeNames[typeName] = true
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	// Have sorted list of import package paths. Partly for aesthetics of generated code, but also
+	// to have stable-generated aliases.
+	paths := make(map[string]bool)
+	for typeName := range typeNames {
+		t, ok := typeMap[typeName]
+		if !ok {
+			return nil, fmt.Errorf("unknown type %q", typeName)
+		}
+		pkgPath := t.GoType.PkgPath()
+		if pkgPath == "" {
+			// Builtin type, ignore.
+			continue
+		}
+		paths[pkgPath] = true
+	}
+	sortedPaths := make([]string, 0, len(paths))
+	for path := range paths {
+		sortedPaths = append(sortedPaths, path)
+	}
+	sort.Strings(sortedPaths)
+
+	// Generate import aliases.
+	index := 1
+	aliasByPath := make(map[string]string, len(paths))
+	importLines := make([]importItem, 0, len(paths))
+	for _, path := range sortedPaths {
+		alias := fmt.Sprintf("pkg%d", index)
+		index++
+		importLines = append(importLines, importItem{
+			Alias: alias,
+			Path:  path,
+		})
+		aliasByPath[path] = alias
+	}
+
+	// Populate typeRefByTypeName.
+	typeRefByTypeName := make(map[string]string, len(typeNames))
+	for typeName := range typeNames {
+		goType := typeMap[typeName]
+		pkgPath := goType.GoType.PkgPath()
+		alias := aliasByPath[pkgPath]
+		if alias == "" {
+			// Builtin type.
+			typeRefByTypeName[typeName] = goType.GoType.Name()
+		} else {
+			typeRefByTypeName[typeName] = fmt.Sprintf(
+				"%s.%s", alias, goType.GoType.Name())
+		}
+	}
+
+	return &imports{
+		TypeRefByTypeName: typeRefByTypeName,
+		ImportLines:       importLines,
+	}, nil
+}
+
+type typeVisitor func(typeName string)
+
+// visitTypesSCPD calls `visitor` with each data type name (e.g. "ui4") referenced
+// by action arguments.`
+func visitTypesSCPD(scpd *srvdesc.SCPD, visitor typeVisitor) error {
+	for _, action := range scpd.ActionByName {
+		if err := visitTypesAction(action, visitor); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func visitTypesAction(action *srvdesc.Action, visitor typeVisitor) error {
+	for _, arg := range action.InArgs {
+		sv, err := arg.RelatedStateVariable()
+		if err != nil {
+			return err
+		}
+		visitor(sv.DataType)
+	}
+	for _, arg := range action.OutArgs {
+		sv, err := arg.RelatedStateVariable()
+		if err != nil {
+			return err
+		}
+		visitor(sv.DataType)
+	}
+	return nil
 }

v2alpha/cmd/goupnp2srvgen/tmplfuncs/tmplfuncs.go

@@ -0,0 +1,30 @@
+// Package tmplfuncs contains functions for injection into templates.
+package tmplfuncs
+
+import (
+	"errors"
+	"fmt"
+)
+
+// Args accepts pairs of string names and any values and constructs a map from them.
+// This is to help passing multiple arguments to a template from within a template.
+func Args(args ...any) (map[string]any, error) {
+	if len(args)%2 != 0 {
+		return nil, errors.New("args must have an even number of arguments")
+	}
+	res := make(map[string]any, len(args)/2)
+
+	for i := 0; i < len(args); i += 2 {
+		name, ok := args[i].(string)
+		if !ok {
+			return nil, fmt.Errorf("argument %d: want string, got %T", i, args[i])
+		}
+		value := args[i+1]
+		if _, exists := res[name]; exists {
+			return nil, fmt.Errorf("argument name %q occurs more than once", name)
+		}
+		res[name] = value
+	}
+
+	return res, nil
+}