refactor(codegen): Add idl.Type return type

This is a better abstraction over types in IDL specs

Author: stroiman

internal/code-gen/script-wrappers/configuration/wrapper_type_spec.go

@@ -1,15 +1,12 @@
 package configuration
 
-import "github.com/gost-dom/webref/idl"
-
 // IdlInterfaceConfiguration contains information about how to generate
 // prototype objects for an interface in the IDL.
 //
 // All classes will be generated using a set of defaults. Data in this structure
 // will allow deviating from the defaults.
 type IdlInterfaceConfiguration struct {
 	DomSpec       *WebIdlConfiguration
-	IdlInterface  idl.Interface
 	TypeName      string
 	RunCustomCode bool
 	WrapperType   string

internal/code-gen/script-wrappers/constants.go

@@ -0,0 +1,5 @@
+package wrappers
+
+import "github.com/gost-dom/webref/idl"
+
+var IdlTypeUndefined = idl.Type{Name: "undefined", Kind: idl.KindSimple}

internal/code-gen/script-wrappers/es_wrapper_generator.go

@@ -21,44 +21,59 @@ func createData(
 	if !ok {
 		panic("Missing type")
 	}
+	// if interfaceConfig.IdlInterface.Name != interfaceConfig.TypeName {
+	// 	panic(
+	// 		fmt.Sprintf(
+	// 			"Type mismatch, %s = %s",
+	// 			interfaceConfig.IdlInterface.Name,
+	// 			interfaceConfig.TypeName,
+	// 		),
+	// 	)
+	// }
 	idlInterface := idlName.IdlInterface
 	wrappedTypeName := idlInterface.Name
+	if idlInterface.Name != interfaceConfig.TypeName {
+		panic(fmt.Sprintf("createData error: %s = %s", idlInterface.Name, interfaceConfig.TypeName))
+	}
 	return ESConstructorData{
 		Spec:             interfaceConfig,
 		IdlInterfaceName: wrappedTypeName,
 		RunCustomCode:    interfaceConfig.RunCustomCode,
 		Inheritance:      idlInterface.Inheritance,
 		IdlInterface:     idlInterface,
-		Constructor:      CreateConstructor(interfaceConfig, idlName),
-		Operations:       CreateInstanceMethods(interfaceConfig, idlName),
-		Attributes:       CreateAttributes(interfaceConfig, idlName),
+		Constructor:      CreateConstructor(idlInterface, interfaceConfig, idlName),
+		Operations:       CreateInstanceMethods(idlInterface, interfaceConfig, idlName),
+		Attributes:       CreateAttributes(idlInterface, interfaceConfig, idlName),
 	}
 }
 
 func CreateConstructor(
+	idlInterface idl.Interface,
 	interfaceConfig *configuration.IdlInterfaceConfiguration,
 	idlName idl.TypeSpec) *ESOperation {
 	if c, ok := idlName.Constructor(); ok {
 		fmt.Printf("Create constructor %s '%s'\n", interfaceConfig.TypeName, c.Name)
 		c.Name = "constructor"
-		result := createOperation(interfaceConfig, c)
+		result := createOperation(idlInterface, interfaceConfig, c)
 		return &result
 	} else {
 		return nil
 	}
 }
 
 func CreateInstanceMethods(
+	idlInterface idl.Interface,
 	interfaceConfig *configuration.IdlInterfaceConfiguration,
 	idlName idl.TypeSpec) (result []ESOperation) {
 	for instanceMethod := range idlName.InstanceMethods() {
-		op := createOperation(interfaceConfig, instanceMethod)
+		op := createOperation(idlInterface, interfaceConfig, instanceMethod)
 		result = append(result, op)
 	}
 	return
 }
 
 func CreateAttributes(
+	idlInterface idl.Interface,
 	interfaceConfig *configuration.IdlInterfaceConfiguration,
 	idlName idl.TypeSpec,
 ) (res []ESAttribute) {
@@ -71,16 +86,15 @@ func CreateAttributes(
 			getter *ESOperation
 			setter *ESOperation
 		)
-		// r := attribute.AttributeType()
-		// rtnType := r.TypeName
 		getter = &ESOperation{
 			Name:                 attribute.Name,
 			NotImplemented:       methodCustomization.NotImplemented,
 			CustomImplementation: methodCustomization.CustomImplementation,
-			RetType: idl.RetType{
+			LegacyRetType: idl.RetType{
 				TypeName: attribute.Type.Name,
 				Nullable: attribute.Type.Nullable,
 			},
+			RetType:             attribute.Type,
 			MethodCustomization: methodCustomization,
 		}
 		if !attribute.Readonly {
@@ -91,7 +105,8 @@ func CreateAttributes(
 			setter.NotImplemented = setter.NotImplemented || methodCustomization.NotImplemented
 			setter.CustomImplementation = setter.CustomImplementation ||
 				methodCustomization.CustomImplementation
-			setter.RetType = idl.NewRetTypeUndefined()
+			setter.LegacyRetType = idl.NewRetTypeUndefined()
+			setter.RetType = IdlTypeUndefined
 			setter.Arguments = []ESOperationArgument{{
 				Name:     "val",
 				Type:     IdlNameToGoName(attribute.Type.Name),
@@ -109,19 +124,22 @@ func CreateAttributes(
 }
 
 func createOperation(
+	idlInterface idl.Interface,
 	typeSpec *configuration.IdlInterfaceConfiguration,
 	member idl.MemberSpec,
 ) ESOperation {
 	specRules := customrules.GetSpecRules(typeSpec.DomSpec.Name)
 	intfRules := specRules[typeSpec.TypeName]
 	opRules := intfRules.Operations[member.Name]
-
 	methodCustomization := typeSpec.GetMethodCustomization(member.Name)
+	idlOperation, _ := idlInterface.GetOperation(member.Name)
+
 	op := ESOperation{
 		Name:                 member.Name,
 		NotImplemented:       methodCustomization.NotImplemented,
 		CustomImplementation: methodCustomization.CustomImplementation,
-		RetType:              member.ReturnType(),
+		LegacyRetType:        member.ReturnType(),
+		RetType:              idlOperation.ReturnType,
 		MethodCustomization:  methodCustomization,
 		HasError:             opRules.HasError,
 		Arguments:            []ESOperationArgument{},

internal/code-gen/script-wrappers/model/es_operation.go

@@ -8,7 +8,8 @@ import (
 type ESOperation struct {
 	Name                 string
 	NotImplemented       bool
-	RetType              idl.RetType
+	LegacyRetType        idl.RetType
+	RetType              idl.Type
 	HasError             bool
 	CustomImplementation bool
 	MethodCustomization  configuration.ESMethodWrapper
@@ -24,21 +25,21 @@ func (op ESOperation) GetHasError() bool {
 }
 
 func (op ESOperation) HasResult() bool {
-	return op.RetType.IsDefined()
+	return op.RetType.Name != "undefined"
 }
 
 func (o ESOperation) Encoder() string {
 	if e := o.MethodCustomization.Encoder; e != "" {
 		return e
 	}
 	converter := "to"
-	if o.RetType.Nullable {
+	if o.LegacyRetType.Nullable {
 		converter += "Nullable"
 	}
-	converter += IdlNameToGoName(o.RetType.TypeName)
+	converter += IdlNameToGoName(o.LegacyRetType.TypeName)
 	return converter
 }
 
 func (o ESOperation) RetTypeName() string {
-	return IdlNameToGoName(o.RetType.TypeName)
+	return IdlNameToGoName(o.LegacyRetType.TypeName)
 }

internal/code-gen/script-wrappers/model/functions.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	. "github.com/gost-dom/code-gen/internal"
+	"github.com/gost-dom/webref/idl"
 )
 
 func IdlNameToGoName(s string) string {
@@ -13,3 +14,5 @@ func IdlNameToGoName(s string) string {
 	}
 	return strings.Join(words, "")
 }
+
+func IsDefined(t idl.Type) bool { return t.Name != "undefined" }

internal/code-gen/script-wrappers/v8gen/generators.go

@@ -374,7 +374,7 @@ func (c V8InstanceInvocation) GetGenerator() V8InstanceInvocationResult {
 			list.Append(g.Return(g.Nil, g.Nil))
 		}
 	} else {
-		retType := c.Op.RetType
+		retType := c.Op.LegacyRetType
 		if retType.IsNode() {
 			genRes.RequireContext = true
 			valueReturn := (g.Return(g.Raw(jen.Id("ctx").Dot("getInstanceForNode").Call(jen.Id("result")))))