functions: Add support for functions

[tmc]

WIP functions support

copilot:walkthrough

[progrium]

Based on current state:

• nice that ref structs are added too, I imagine they are maybe a common type used by functions
• is CName ever not ObjcName?
• those dot files intended to be included?
• still a lot of framework code for frameworks we don't have in main yet. tests will fail with this
• are the only examples of successfully generated functions the two coregraphics ones?

[tmc]

Based on current state:

• nice that ref structs are added too, I imagine they are maybe a common type used by functions
• is CName ever not ObjcName?

I have only really implemented it for RefType -- I defaulted to the objc impl but I can put in "not implemented" instead.

• those dot files intended to be included?

Ha, no are accidental.

• still a lot of framework code for frameworks we don't have in main yet. tests will fail with this

Suggestion for the short term?

• are the only examples of successfully generated functions the two coregraphics ones?

Yeah I have that rule in there constraining what is generated just for testing purposes, probably better to add in skipping when we know we'll fail but I need to explore more, any input on approach welcomed.

[progrium]

Use ./generate/tools/clobbergen.go on the frameworks that were generated by accident. Or, git reset the macos dir against upstream and then run ./generate/tools/regen.sh to only generate for the existing frameworks. This is all temporary because normally there wouldn't be so many framework stubs, but I started them all and haven't finished getting them working. Would have put them in a new branch but I thought I'd finish them sooner. Whatever ones I don't get working in this next pass I can take out and then this won't be a problem.

Since functions are simple symbol names, they could be added to the blacklist in ./generate/symbols.go to skip any that aren't working yet. For now, maybe make the function case in generate see if the framework is in an inline whitelist. Then try to get functions to mostly work in one framework at a time. You could use the lookup tool with a framework prefix and jq to just get the functions and see which frameworks we have have the fewest functions and work framework to framework taking care of new cases as you run into them. By the time you get to appkit or foundation, maybe it'll all just work!

Also maybe for now just have a mapping for C types or rules for what C type to use in your codegen or in ToFunction. Until you can see how many special cases there are that a CName function would help enough for.

[tmc]

OK I think this is ready for a review pass. This isn't complete work yet but I think might have enough of a bite for us to figure out what might go in.

Severely needs more testing.

[progrium]

can we have reasons for why these are skipped in comments?

[progrium]

Tried running generate on appkit and with a few fixes it generates but then compiling a program gives a lot of these warnings now:

# github.com/progrium/macdriver/macos/appkit
cgo-gcc-prolog:52:66: warning: incompatible pointer types passing 'struct NSString *' to parameter of type 'NSAccessibilityActionName' (aka 'NSString *') [-Wincompatible-pointer-types]
macos/appkit/functions.gen.go:60:69: note: passing argument to parameter 'action' here
cgo-gcc-prolog:106:44: warning: incompatible pointer types passing 'struct NSString *' to parameter of type 'NSAccessibilityNotificationName' (aka 'NSString *') [-Wincompatible-pointer-types]
macos/appkit/functions.gen.go:19:85: note: passing argument to parameter 'notification' here
cgo-gcc-prolog:120:56: warning: incompatible pointer types passing 'struct NSString *' to parameter of type 'NSAccessibilityNotificationName' (aka 'NSString *') [-Wincompatible-pointer-types]
...

But more importantly, these errors:

macos/appkit/functions.gen.go:88:14: cannot convert boundsRect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:91:14: cannot convert clipRect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:110:14: cannot convert rect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:132:27: cannot convert role (variable of type AccessibilityRole) to type _Ctype_NSAccessibilityRole
macos/appkit/functions.gen.go:135:30: cannot convert subrole (variable of type AccessibilitySubrole) to type _Ctype_NSAccessibilitySubrole
macos/appkit/functions.gen.go:138:16: cannot convert rv (variable of type *_Ctype_struct_NSString) to type string
macos/appkit/functions.gen.go:148:14: cannot convert rect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:193:14: cannot convert rect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:209:39: cannot convert notification (variable of type AccessibilityNotificationName) to type _Ctype_NSAccessibilityNotificationName
macos/appkit/functions.gen.go:220:14: cannot convert rect (variable of type coregraphics.Rect) to type _Ctype_struct_CGRect
macos/appkit/functions.gen.go:220:14: too many errors

Is this a known part of the process? Like is this something you know how to handle?

[tmc]

Sorry missed this comment, not a known part of the process, my hope/intent was that once we have the structs appropriately defined with the same memory layout that this is just a cast.