Skip to content

feat: implement interface inheritance support in code generator #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zandercodes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: implement interface inheritance support in code generator #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
555 changes: 452 additions & 103 deletions internal/codegen/codegen.go
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions internal/codegen/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package codegen

import (
"embed"
"fmt"
"strings"
"text/template"

Expand Down Expand Up @@ -224,6 +225,20 @@ func funcs() template.FuncMap {
"toLower": func(s string) string {
return strings.ToLower(s[:1]) + s[1:]
},
"dict": func(values ...interface{}) (map[string]interface{}, error) {
if len(values)%2 != 0 {
return nil, fmt.Errorf("dict requires even number of arguments, got %d", len(values))
}
dict := make(map[string]interface{}, len(values)/2)
for i := 0; i < len(values); i += 2 {
key, ok := values[i].(string)
if !ok {
return nil, fmt.Errorf("dict keys must be strings, got %T", values[i])
}
dict[key] = values[i+1]
}
return dict, nil
},
}
}

Expand Down
36 changes: 1 addition & 35 deletions internal/codegen/templates/class.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,41 +18,7 @@ func New{{.Name}}() (*{{.Name}}, error) {

{{$owner := .Name}}
{{range .ImplInterfaces}}
{{range .Funcs}}
{{if not .Implement}}{{continue}}{{end}}
func (impl *{{$owner}}) {{funcName .}} (
{{- range .InParams -}}
{{/*do not include out parameters, they are used as return values*/ -}}
{{ if .IsOut }}{{continue}}{{ end -}}
{{.GoVarName}} {{template "variabletype.tmpl" . }},
{{- end -}}
)

{{- /* return params */ -}}

( {{range .InParams -}}
{{ if not .IsOut }}{{continue}}{{ end -}}
{{template "variabletype.tmpl" . }},{{end -}}
{{range .ReturnParams}}{{template "variabletype.tmpl" . }},{{end}} error )

{{- /* method body */ -}}

{
itf := impl.MustQueryInterface(ole.NewGUID({{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}GUID{{.InheritedFrom.Name}}))
defer itf.Release()
v := (*{{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}{{.InheritedFrom.Name}})(unsafe.Pointer(itf))
return v.{{funcName . -}}
(
{{- range .InParams -}}
{{if .IsOut -}}
{{continue -}}
{{end -}}
{{.GoVarName -}}
,
{{- end -}}
)
}
{{end}}
{{template "funcext.tmpl" (dict "Funcs" .Funcs "FuncOwner" $owner)}}
{{end}}

{{range .ExclusiveInterfaces}}
Expand Down
30 changes: 30 additions & 0 deletions internal/codegen/templates/funcext.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{{/* Template for inherited/extended methods */}}
{{range .Funcs}}
{{if not .Implement}}{{continue}}{{end}}
{{if not .InheritedFrom.Name}}{{continue}}{{end}}
func (impl *{{$.FuncOwner}}) {{funcName .}} (
{{- range .InParams -}}
{{/*do not include out parameters, they are used as return values*/ -}}
{{ if .IsOut }}{{continue}}{{ end -}}
{{.GoVarName}} {{template "variabletype.tmpl" . }},
{{- end -}}
)

{{- /* return params */ -}}

( {{range .InParams -}}
{{ if not .IsOut }}{{continue}}{{ end -}}
{{template "variabletype.tmpl" . }},{{end -}}
{{range .ReturnParams}}{{template "variabletype.tmpl" . }},{{end}} error )

{{- /* method body */ -}}

{
itf := impl.MustQueryInterface(ole.NewGUID({{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}GUID{{.InheritedFrom.Name}}))
defer itf.Release()
v := (*{{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}{{.InheritedFrom.Name}})(unsafe.Pointer(itf))
return v.{{funcName . -}}(
{{- template "paramforwarding.tmpl" . -}}
)
}
{{end}}
43 changes: 37 additions & 6 deletions internal/codegen/templates/funcimpl.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
{{if .RequiresActivation}}{{/*Activate class*/ -}}
{{if .InheritedFrom.Name}}{{/*Inherited method - use QueryInterface*/ -}}
itf := v.MustQueryInterface(ole.NewGUID({{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}GUID{{.InheritedFrom.Name}}))
defer itf.Release()
baseInterface := (*{{if .InheritedFrom.Namespace}}{{.InheritedFrom.Namespace}}.{{end}}{{.InheritedFrom.Name}})(unsafe.Pointer(itf))
return baseInterface.{{funcName . -}}(
{{- template "paramforwarding.tmpl" . -}}
)
{{- /* remove trailing white space*/ -}}
{{else if .RequiresActivation}}{{/*Activate class*/ -}}
inspectable, err := ole.RoGetActivationFactory("{{.ExclusiveTo}}", ole.NewGUID(GUID{{.FuncOwner}}))
if err != nil {
return {{range .ReturnParams -}}
Expand All @@ -7,13 +15,18 @@ if err != nil {
v := (*{{.FuncOwner}})(unsafe.Pointer(inspectable))

{{end -}}
{{if not .InheritedFrom.Name}}

{{- /* Declare out variables*/ -}}

{{range (concat .InParams .ReturnParams) -}}
{{ if not .IsOut}}{{continue}}{{end -}}
{{if eq .GoTypeName "string" -}}
var {{.GoVarName}}HStr ole.HString
{{if .Type.IsArray -}}
var {{.GoVarName}}HStr *ole.HString
{{else -}}
var {{.GoVarName}}HStr ole.HString
{{end -}}
{{ else -}}
var {{.GoVarName}} {{template "variabletype.tmpl" . -}}
{{if .Type.IsArray}} = make({{template "variabletype.tmpl" . -}}, {{.GoVarName}}Size){{end}}
Expand All @@ -37,8 +50,16 @@ hr, _, _ := syscall.SyscallN(
uintptr(unsafe.Pointer(v)), // this
{{range (concat .InParams .ReturnParams) -}}
{{if .Type.IsArray -}}
{{/* Arrays need to pass a pointer to their first element */ -}}
uintptr(unsafe.Pointer(&{{.GoVarName}}[0])), // {{if .IsOut}}out{{else}}in{{end}} {{.GoTypeName}}
{{if eq .GoTypeName "string" -}}
{{if .IsOut -}}
uintptr(unsafe.Pointer(&{{.GoVarName}}HStr)), // out string array
{{else -}}
uintptr(unsafe.Pointer(&{{.GoVarName}}[0])), // in string array
{{end -}}
{{else -}}
{{/* Non-string arrays pass pointer to first element */ -}}
uintptr(unsafe.Pointer(&{{.GoVarName}}[0])), // {{if .IsOut}}out{{else}}in{{end}} {{.GoTypeName}}
{{end -}}
{{else if .IsOut -}}
{{if (or .Type.IsPrimitive .Type.IsEnum) -}}
{{if eq .GoTypeName "string" -}}
Expand Down Expand Up @@ -75,12 +96,22 @@ if hr != 0 {
{{range (concat .InParams .ReturnParams) -}}
{{ if not .IsOut}}{{continue}}{{end -}}
{{if eq .GoTypeName "string" -}}
{{.GoVarName}} := {{.GoVarName}}HStr.String()
ole.DeleteHString({{.GoVarName}}HStr)
{{if .Type.IsArray -}}
{{.GoVarName}} := make([]string, {{.GoVarName}}Size)
hstrSlice := unsafe.Slice({{.GoVarName}}HStr, {{.GoVarName}}Size)
for i := range hstrSlice {
{{.GoVarName}}[i] = hstrSlice[i].String()
ole.DeleteHString(hstrSlice[i])
}
{{else -}}
{{.GoVarName}} := {{.GoVarName}}HStr.String()
ole.DeleteHString({{.GoVarName}}HStr)
{{end -}}
{{ end -}}
{{ end -}}


return {{range .InParams}}{{if .IsOut}}{{.GoVarName}}, {{end}}{{end -}}
{{range .ReturnParams }}{{.GoVarName}},{{end}} nil
{{- /* remove trailing white space*/ -}}
{{end}}
8 changes: 7 additions & 1 deletion internal/codegen/templates/interface.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ type {{.Name}}Vtbl struct {
ole.IInspectableVtbl

{{range .Funcs}}
{{funcName .}} uintptr
{{- if not .InheritedFrom.Name}}
{{funcName .}} uintptr
{{- end}}
{{- end}}
}

Expand All @@ -18,5 +20,9 @@ func (v *{{.Name}}) VTable() *{{.Name}}Vtbl {
}

{{range .Funcs}}
{{if not .InheritedFrom.Name}}
{{template "func.tmpl" .}}
{{end}}
{{end}}

{{template "funcext.tmpl" (dict "Funcs" .Funcs "FuncOwner" .Name)}}
8 changes: 8 additions & 0 deletions internal/codegen/templates/paramforwarding.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{{/* Template for forwarding input parameters to another function */}}
{{- range .InParams -}}
{{if .IsOut -}}
{{continue -}}
{{end -}}
{{.GoVarName -}}
,
{{- end -}}
Loading