feat(gofile): use templates to generate the Go file (#1666)

Author: alexandre-daubois

internal/extgen/arginfo.go

@@ -41,7 +41,7 @@ func (ag *arginfoGenerator) fixArginfoFile(stubFile string) error {
 		return fmt.Errorf("reading arginfo file: %w", err)
 	}
 
-	// TODO: Fix the zend_register_internal_class_with_flags issue
+	// FIXME: the script generate "zend_register_internal_class_with_flags" but it is not recognized by the compiler
 	fixedContent := strings.ReplaceAll(content,
 		"zend_register_internal_class_with_flags(&ce, NULL, 0)",
 		"zend_register_internal_class(&ce)")

internal/extgen/classparser.go

@@ -155,13 +155,13 @@ func (cp *classParser) parseStructField(fieldName string, field *ast.Field) phpC
 	// check if field is a pointer (nullable)
 	if starExpr, isPointer := field.Type.(*ast.StarExpr); isPointer {
 		prop.IsNullable = true
-		prop.goType = cp.typeToString(starExpr.X)
+		prop.GoType = cp.typeToString(starExpr.X)
 	} else {
 		prop.IsNullable = false
-		prop.goType = cp.typeToString(field.Type)
+		prop.GoType = cp.typeToString(field.Type)
 	}
 
-	prop.PhpType = cp.goTypeToPHPType(prop.goType)
+	prop.PhpType = cp.goTypeToPHPType(prop.GoType)
 
 	return prop
 }
@@ -260,13 +260,13 @@ func (cp *classParser) parseMethods(filename string) (methods []phpClassMethod,
 				return nil, fmt.Errorf("extracting Go method function: %w", err)
 			}
 
-			currentMethod.goFunction = goFunc
+			currentMethod.GoFunction = goFunc
 
 			validator := Validator{}
 			phpFunc := phpFunction{
 				Name:             currentMethod.Name,
 				Signature:        currentMethod.Signature,
-				goFunction:       currentMethod.goFunction,
+				GoFunction:       currentMethod.GoFunction,
 				Params:           currentMethod.Params,
 				ReturnType:       currentMethod.ReturnType,
 				IsReturnNullable: currentMethod.isReturnNullable,

internal/extgen/funcparser.go

@@ -74,7 +74,7 @@ func (fp *FuncParser) parse(filename string) (functions []phpFunction, err error
 				return nil, fmt.Errorf("extracting Go function: %w", err)
 			}
 
-			currentPHPFunc.goFunction = goFunc
+			currentPHPFunc.GoFunction = goFunc
 
 			if err := validator.validateGoFunctionSignatureWithOptions(*currentPHPFunc, false); err != nil {
 				fmt.Printf("Warning: Go function signature mismatch for %q: %v\n", currentPHPFunc.Name, err)

internal/extgen/gofile.go

@@ -1,15 +1,33 @@
 package extgen
 
 import (
+	"bytes"
+	_ "embed"
 	"fmt"
 	"path/filepath"
 	"strings"
+	"text/template"
+
+	"github.com/Masterminds/sprig/v3"
 )
 
+//go:embed templates/extension.go.tpl
+var goFileContent string
+
 type GoFileGenerator struct {
 	generator *Generator
 }
 
+type goTemplateData struct {
+	PackageName       string
+	BaseName          string
+	Imports           []string
+	Constants         []phpConstant
+	InternalFunctions []string
+	Functions         []phpFunction
+	Classes           []phpClass
+}
+
 func (gg *GoFileGenerator) generate() error {
 	filename := filepath.Join(gg.generator.BuildDir, gg.generator.BaseName+".go")
 	content, err := gg.buildContent()
@@ -27,104 +45,47 @@ func (gg *GoFileGenerator) buildContent() (string, error) {
 		return "", fmt.Errorf("analyzing source file: %w", err)
 	}
 
-	var builder strings.Builder
-
-	cleanPackageName := SanitizePackageName(gg.generator.BaseName)
-	builder.WriteString(fmt.Sprintf(`package %s
-
-/*
-#include <stdlib.h>
-#include "%s.h"
-*/
-import "C"
-import "runtime/cgo"
-`, cleanPackageName, gg.generator.BaseName))
-
+	filteredImports := make([]string, 0, len(imports))
 	for _, imp := range imports {
-		if imp == `"C"` {
-			continue
+		if imp != `"C"` {
+			filteredImports = append(filteredImports, imp)
 		}
-
-		builder.WriteString(fmt.Sprintf("import %s\n", imp))
 	}
 
-	builder.WriteString(`
-func init() {
-	frankenphp.RegisterExtension(unsafe.Pointer(&C.ext_module_entry))
-}
-`)
-
-	for _, constant := range gg.generator.Constants {
-		builder.WriteString(fmt.Sprintf("const %s = %s\n", constant.Name, constant.Value))
-	}
-
-	if len(gg.generator.Constants) > 0 {
-		builder.WriteString("\n")
-	}
-
-	for _, internalFunc := range internalFunctions {
-		builder.WriteString(internalFunc + "\n\n")
-	}
-
-	for _, fn := range gg.generator.Functions {
-		builder.WriteString(fmt.Sprintf("//export %s\n%s\n", fn.Name, fn.goFunction))
-	}
-
-	for _, class := range gg.generator.Classes {
-		builder.WriteString(fmt.Sprintf("type %s struct {\n", class.GoStruct))
-		for _, prop := range class.Properties {
-			builder.WriteString(fmt.Sprintf("	%s %s\n", prop.Name, prop.goType))
+	classes := make([]phpClass, len(gg.generator.Classes))
+	copy(classes, gg.generator.Classes)
+	for i, class := range classes {
+		for j, method := range class.Methods {
+			classes[i].Methods[j].Wrapper = gg.generateMethodWrapper(method, class)
 		}
-		builder.WriteString("}\n\n")
 	}
 
-	if len(gg.generator.Classes) > 0 {
-		builder.WriteString(`
-//export registerGoObject
-func registerGoObject(obj interface{}) C.uintptr_t {
-	handle := cgo.NewHandle(obj)
-	return C.uintptr_t(handle)
-}
-
-//export getGoObject
-func getGoObject(handle C.uintptr_t) interface{} {
-	h := cgo.Handle(handle)
-	return h.value()
-}
-
-//export removeGoObject
-func removeGoObject(handle C.uintptr_t) {
-	h := cgo.Handle(handle)
-	h.Delete()
-}
+	templateContent, err := gg.getTemplateContent(goTemplateData{
+		PackageName:       SanitizePackageName(gg.generator.BaseName),
+		BaseName:          gg.generator.BaseName,
+		Imports:           filteredImports,
+		Constants:         gg.generator.Constants,
+		InternalFunctions: internalFunctions,
+		Functions:         gg.generator.Functions,
+		Classes:           classes,
+	})
 
-`)
+	if err != nil {
+		return "", fmt.Errorf("executing template: %w", err)
 	}
 
-	for _, class := range gg.generator.Classes {
-		builder.WriteString(fmt.Sprintf(`//export create_%s_object
-func create_%s_object() C.uintptr_t {
-	obj := &%s{}
-	return registerGoObject(obj)
+	return templateContent, nil
 }
 
-`, class.GoStruct, class.GoStruct, class.GoStruct))
+func (gg *GoFileGenerator) getTemplateContent(data goTemplateData) (string, error) {
+	tmpl := template.Must(template.New("gofile").Funcs(sprig.FuncMap()).Parse(goFileContent))
 
-		for _, method := range class.Methods {
-			if method.goFunction != "" {
-				builder.WriteString(method.goFunction)
-				builder.WriteString("\n\n")
-			}
-		}
-
-		for _, method := range class.Methods {
-			builder.WriteString(fmt.Sprintf("//export %s_wrapper\n", method.Name))
-			builder.WriteString(gg.generateMethodWrapper(method, class))
-			builder.WriteString("\n")
-		}
+	var buf bytes.Buffer
+	if err := tmpl.Execute(&buf, data); err != nil {
+		return "", err
 	}
 
-	return builder.String(), nil
+	return buf.String(), nil
 }
 
 func (gg *GoFileGenerator) generateMethodWrapper(method phpClassMethod, class phpClass) string {

internal/extgen/gofile_test.go

@@ -51,14 +51,14 @@ func anotherHelper() {
 			{
 				Name:       "greet",
 				ReturnType: "string",
-				goFunction: `func greet(name *go_string) *go_value {
+				GoFunction: `func greet(name *go_string) *go_value {
 	return types.String("Hello " + CStringToGoString(name))
 }`,
 			},
 			{
 				Name:       "calculate",
 				ReturnType: "int",
-				goFunction: `func calculate(a long, b long) *go_value {
+				GoFunction: `func calculate(a long, b long) *go_value {
 	result := a + b
 	return types.Int(result)
 }`,
@@ -103,7 +103,7 @@ func test() {
 				{
 					Name:       "test",
 					ReturnType: "void",
-					goFunction: "func test() {\n\t// simple function\n}",
+					GoFunction: "func test() {\n\t// simple function\n}",
 				},
 			},
 			contains: []string{
@@ -136,7 +136,7 @@ func process(data *go_string) *go_value {
 				{
 					Name:       "process",
 					ReturnType: "string",
-					goFunction: `func process(data *go_string) *go_value {
+					GoFunction: `func process(data *go_string) *go_value {
 	return String(fmt.Sprintf("processed: %s", CStringToGoString(data)))
 }`,
 				},
@@ -169,7 +169,7 @@ func internalFunc2(data string) {
 				{
 					Name:       "publicFunc",
 					ReturnType: "void",
-					goFunction: "func publicFunc() {}",
+					GoFunction: "func publicFunc() {}",
 				},
 			},
 			contains: []string{
@@ -219,7 +219,7 @@ func TestGoFileGenerator_PackageNameSanitization(t *testing.T) {
 				BaseName:   tt.baseName,
 				SourceFile: sourceFile,
 				Functions: []phpFunction{
-					{Name: "test", ReturnType: "void", goFunction: "func test() {}"},
+					{Name: "test", ReturnType: "void", GoFunction: "func test() {}"},
 				},
 			}
 
@@ -296,7 +296,7 @@ func test() {}`
 		BaseName:   "importtest",
 		SourceFile: sourceFile,
 		Functions: []phpFunction{
-			{Name: "test", ReturnType: "void", goFunction: "func test() {}"},
+			{Name: "test", ReturnType: "void", GoFunction: "func test() {}"},
 		},
 	}
 
@@ -372,7 +372,7 @@ func debugPrint(msg string) {
 		{
 			Name:       "processData",
 			ReturnType: "array",
-			goFunction: `func processData(input *go_string, options *go_nullable) *go_value {
+			GoFunction: `func processData(input *go_string, options *go_nullable) *go_value {
 	data := CStringToGoString(input)
 	processed := internalProcess(data)
 	return Array([]interface{}{processed})
@@ -381,7 +381,7 @@ func debugPrint(msg string) {
 		{
 			Name:       "validateInput",
 			ReturnType: "bool",
-			goFunction: `func validateInput(data *go_string) *go_value {
+			GoFunction: `func validateInput(data *go_string) *go_value {
 	input := CStringToGoString(data)
 	isValid := len(input) > 0 && validateFormat(input)
 	return Bool(isValid)
@@ -459,7 +459,7 @@ func (ts *TestStruct) ProcessData(name string, count *int64, enabled *bool) stri
 				{Name: "count", PhpType: "int", IsNullable: true},
 				{Name: "enabled", PhpType: "bool", IsNullable: true},
 			},
-			goFunction: `func (ts *TestStruct) ProcessData(name string, count *int64, enabled *bool) string {
+			GoFunction: `func (ts *TestStruct) ProcessData(name string, count *int64, enabled *bool) string {
 	result := fmt.Sprintf("name=%s", name)
 	if count != nil {
 		result += fmt.Sprintf(", count=%d", *count)

internal/extgen/nodes.go

@@ -8,7 +8,7 @@ import (
 type phpFunction struct {
 	Name             string
 	Signature        string
-	goFunction       string
+	GoFunction       string
 	Params           []phpParameter
 	ReturnType       string
 	IsReturnNullable bool
@@ -34,7 +34,8 @@ type phpClassMethod struct {
 	Name             string
 	PhpName          string
 	Signature        string
-	goFunction       string
+	GoFunction       string
+	Wrapper          string
 	Params           []phpParameter
 	ReturnType       string
 	isReturnNullable bool
@@ -45,7 +46,7 @@ type phpClassMethod struct {
 type phpClassProperty struct {
 	Name       string
 	PhpType    string
-	goType     string
+	GoType     string
 	IsNullable bool
 }
 

internal/extgen/stub.go

@@ -46,6 +46,6 @@ func getPhpTypeAnnotation(goType string) string {
 	case "string", "bool", "float", "int":
 		return goType
 	default:
-		return "int" // fallback
+		return "int"
 	}
 }