detached c2a1f08

Core: Migrate to requiring function pointers for all callback arguments

This lets us correctly track the identity of callbacks.

BREAKING CHANGE: All callback-based APIs now require function pointers.
commit
c2a1f08c9dfcefe178d91f8c7070caf219ff662b
author
Peter Fern · · 2024-01-06 06:48 UTC
committer
Jeroen Wijenbergh · · 2024-03-05 11:56 UTC
parent
cd00a46
signature
unsigned
4 files · +25 -16
Split
UnifiedSplit
M internal/gir/types/template.go +1 -0
@@ -43,6 +43,7 @@ func (f *funcArgsTemplate) AddAPI(t string, n string, k Kind, ns string) {
4343 switch k {
4444 case CallbackType:
4545 c = fmt.Sprintf("%sNewCallback(%s)", glibNs, n)
46+ t = "*" + t
4647 case ClassesType:
4748 if stars == 0 {
4849 c = n
@@ -43,6 +43,7 @@ func (f *funcArgsTemplate) AddAPI(t string, n string, k Kind, ns string) {
43 switch k {43 switch k {
44 case CallbackType:44 case CallbackType:
45 c = fmt.Sprintf("%sNewCallback(%s)", glibNs, n)45 c = fmt.Sprintf("%sNewCallback(%s)", glibNs, n)
46+ t = "*" + t
46 case ClassesType:47 case ClassesType:
47 if stars == 0 {48 if stars == 0 {
48 c = n49 c = n
M templates/glib +13 -6
@@ -34,23 +34,30 @@ func SaveCallback(cbPtr uintptr, refPtr uintptr) {
3434 }
3535
3636 // UnrefCallbackValue unreferences the provided callback by reflect.value to free a purego slot
37-func UnrefCallback(fn interface{}) error {
38- cbPtr := reflect.ValueOf(fn).Pointer()
37+func UnrefCallback(fnPtr interface{}) error {
38+ val := reflect.ValueOf(fnPtr)
39+ if val.IsNil() {
40+ return fmt.Errorf("function pointer must not be nil")
41+ }
42+ if val.Kind() != reflect.Ptr || val.Elem().Kind() != reflect.Func {
43+ return fmt.Errorf("type must be a function pointer")
44+ }
45+ cbPtr := reflect.ValueOf(fnPtr).Pointer()
3946 refPtr, ok := GetCallback(cbPtr)
4047 if !ok {
41- return purego.UnrefCallback(fn)
48+ return purego.UnrefCallbackFnPtr(fnPtr)
4249 }
4350 defer func() {
4451 callbacks.Lock()
4552 delete(callbacks.refs, cbPtr)
4653 callbacks.Unlock()
4754 }()
48- return purego.UnrefCallbackPtr(refPtr)
55+ return purego.UnrefCallback(refPtr)
4956 }
5057
5158 // NewCallback is an alias to purego.NewCallback
52-func NewCallback(fn interface{}) uintptr {
53- return purego.NewCallback(fn)
59+func NewCallback(fnPtr interface{}) uintptr {
60+ return purego.NewCallbackFnPtr(fnPtr)
5461 }
5562
5663 func (e *Error) Error() string {
@@ -34,23 +34,30 @@ func SaveCallback(cbPtr uintptr, refPtr uintptr) {
34 }34 }
35 35
36 // UnrefCallbackValue unreferences the provided callback by reflect.value to free a purego slot36 // UnrefCallbackValue unreferences the provided callback by reflect.value to free a purego slot
37-func UnrefCallback(fn interface{}) error {37+func UnrefCallback(fnPtr interface{}) error {
38- cbPtr := reflect.ValueOf(fn).Pointer()38+ val := reflect.ValueOf(fnPtr)
39+ if val.IsNil() {
40+ return fmt.Errorf("function pointer must not be nil")
41+ }
42+ if val.Kind() != reflect.Ptr || val.Elem().Kind() != reflect.Func {
43+ return fmt.Errorf("type must be a function pointer")
44+ }
45+ cbPtr := reflect.ValueOf(fnPtr).Pointer()
39 refPtr, ok := GetCallback(cbPtr)46 refPtr, ok := GetCallback(cbPtr)
40 if !ok {47 if !ok {
41- return purego.UnrefCallback(fn)48+ return purego.UnrefCallbackFnPtr(fnPtr)
42 }49 }
43 defer func() {50 defer func() {
44 callbacks.Lock()51 callbacks.Lock()
45 delete(callbacks.refs, cbPtr)52 delete(callbacks.refs, cbPtr)
46 callbacks.Unlock()53 callbacks.Unlock()
47 }()54 }()
48- return purego.UnrefCallbackPtr(refPtr)55+ return purego.UnrefCallback(refPtr)
49 }56 }
50 57
51 // NewCallback is an alias to purego.NewCallback58 // NewCallback is an alias to purego.NewCallback
52-func NewCallback(fn interface{}) uintptr {59+func NewCallback(fnPtr interface{}) uintptr {
53- return purego.NewCallback(fn)60+ return purego.NewCallbackFnPtr(fnPtr)
54 }61 }
55 62
56 func (e *Error) Error() string {63 func (e *Error) Error() string {
M templates/go +6 -5
@@ -184,20 +184,21 @@ func (c *{{.Name}}) SetGoPointer(ptr uintptr) {
184184 {{range .Signals -}}
185185
186186 {{.Doc}}
187-func (x *{{$outer.Name}}) Connect{{.Name}}(cb func({{$outer.Name}} {{convc .Args.API.Types}}) {{.Ret.Value}}) uint32 {
188- cbPtr := reflect.ValueOf(cb).Pointer()
187+func (x *{{$outer.Name}}) Connect{{.Name}}(cb *func({{$outer.Name}} {{convc .Args.API.Types}}) {{.Ret.Value}}) uint32 {
188+ cbPtr := uintptr(unsafe.Pointer(cb))
189189 cbRefPtr, ok := {{if $NotGLib}}glib.{{end}}GetCallback(cbPtr)
190190 if !ok {
191191 fcb := func(clsPtr uintptr {{convc .Args.Pure.Full}}) {{.Ret.Raw}} {
192192 fa := {{$outer.Name}}{}
193193 fa.Ptr = clsPtr
194+ cbFn := *cb
194195 {{if .Ret.Class}}
195- {{.Name}}Cls := cb(fa {{convc .Args.Pure.Call}})
196+ {{.Name}}Cls := cbFn(fa {{convc .Args.Pure.Call}})
196197 return {{.Name}}Cls.Ptr
197198 {{else if .Ret.Value}}
198- return cb(fa {{convc .Args.Pure.Call}})
199+ return cbFn(fa {{convc .Args.Pure.Call}})
199200 {{else}}
200- cb(fa {{convc .Args.Pure.Call}})
201+ cbFn(fa {{convc .Args.Pure.Call}})
201202 {{end}}
202203 }
203204 cbRefPtr = purego.NewCallback(fcb)
@@ -184,20 +184,21 @@ func (c *{{.Name}}) SetGoPointer(ptr uintptr) {
184 {{range .Signals -}}184 {{range .Signals -}}
185 185
186 {{.Doc}}186 {{.Doc}}
187-func (x *{{$outer.Name}}) Connect{{.Name}}(cb func({{$outer.Name}} {{convc .Args.API.Types}}) {{.Ret.Value}}) uint32 {187+func (x *{{$outer.Name}}) Connect{{.Name}}(cb *func({{$outer.Name}} {{convc .Args.API.Types}}) {{.Ret.Value}}) uint32 {
188- cbPtr := reflect.ValueOf(cb).Pointer()188+ cbPtr := uintptr(unsafe.Pointer(cb))
189 cbRefPtr, ok := {{if $NotGLib}}glib.{{end}}GetCallback(cbPtr)189 cbRefPtr, ok := {{if $NotGLib}}glib.{{end}}GetCallback(cbPtr)
190 if !ok {190 if !ok {
191 fcb := func(clsPtr uintptr {{convc .Args.Pure.Full}}) {{.Ret.Raw}} {191 fcb := func(clsPtr uintptr {{convc .Args.Pure.Full}}) {{.Ret.Raw}} {
192 fa := {{$outer.Name}}{}192 fa := {{$outer.Name}}{}
193 fa.Ptr = clsPtr193 fa.Ptr = clsPtr
194+ cbFn := *cb
194 {{if .Ret.Class}}195 {{if .Ret.Class}}
195- {{.Name}}Cls := cb(fa {{convc .Args.Pure.Call}})196+ {{.Name}}Cls := cbFn(fa {{convc .Args.Pure.Call}})
196 return {{.Name}}Cls.Ptr197 return {{.Name}}Cls.Ptr
197 {{else if .Ret.Value}}198 {{else if .Ret.Value}}
198- return cb(fa {{convc .Args.Pure.Call}})199+ return cbFn(fa {{convc .Args.Pure.Call}})
199 {{else}}200 {{else}}
200- cb(fa {{convc .Args.Pure.Call}})201+ cbFn(fa {{convc .Args.Pure.Call}})
201 {{end}}202 {{end}}
202 }203 }
203 cbRefPtr = purego.NewCallback(fcb)204 cbRefPtr = purego.NewCallback(fcb)
M templates/gobject +5 -5
@@ -37,17 +37,17 @@ func (o Object) Cast(v Ptr) {
3737 v.SetGoPointer(o.GoPointer())
3838 }
3939
40-func (o Object) ConnectSignal(signal string, cb func()) uint32 {
41- return SignalConnect(o.GoPointer(), signal, purego.NewCallback(cb))
40+func (o Object) ConnectSignal(signal string, cb *func()) uint32 {
41+ return SignalConnect(o.GoPointer(), signal, glib.NewCallback(cb))
4242 }
4343
4444 func (o Object) DisconnectSignal(handler uint32) {
4545 SignalHandlerDisconnect(&o, handler)
4646 }
4747
48-// NewCallback is an alias to purego.NewCallback
49-func NewCallback(fn interface{}) uintptr {
50- return glib.NewCallback(fn)
48+// NewCallback is an alias to glib.NewCallback
49+func NewCallback(fnPtr interface{}) uintptr {
50+ return glib.NewCallback(fnPtr)
5151 }
5252
5353 // types
@@ -37,17 +37,17 @@ func (o Object) Cast(v Ptr) {
37 v.SetGoPointer(o.GoPointer())37 v.SetGoPointer(o.GoPointer())
38 }38 }
39 39
40-func (o Object) ConnectSignal(signal string, cb func()) uint32 {40+func (o Object) ConnectSignal(signal string, cb *func()) uint32 {
41- return SignalConnect(o.GoPointer(), signal, purego.NewCallback(cb))41+ return SignalConnect(o.GoPointer(), signal, glib.NewCallback(cb))
42 }42 }
43 43
44 func (o Object) DisconnectSignal(handler uint32) {44 func (o Object) DisconnectSignal(handler uint32) {
45 SignalHandlerDisconnect(&o, handler)45 SignalHandlerDisconnect(&o, handler)
46 }46 }
47 47
48-// NewCallback is an alias to purego.NewCallback48+// NewCallback is an alias to glib.NewCallback
49-func NewCallback(fn interface{}) uintptr {49+func NewCallback(fnPtr interface{}) uintptr {
50- return glib.NewCallback(fn)50+ return glib.NewCallback(fnPtr)
51 }51 }
52 52
53 // types53 // types

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 102

↑↓ moveenter openesc close