New symbols, plus fixes (progrium#213)

* generate: update symbol and symbol declaration parsing for new symbolsdb

* generate: use "Apple Documentation" for modules instead of "Full Documentation"

* * update symbolsdb
* use conventional generated file banner
* protocols live in files with _protocol in the filename
* dropped convenience alloc functions
* renamed type for protocol wrapper to end with Object instead of Wrapper
* ensure protocol wrappers implement the protocol interface
* constants with same name as their enum name get K prefix
* globbergen finds files by filename now

* macos: regenerated

* Makefile: update symbolsdb

Author: progrium

Makefile

@@ -17,4 +17,4 @@ example:
 .PHONY: example
 
 generate/symbols.zip:
-	cd generate && wget https://github.com/mactypes/symbolsdb/releases/download/1.0/symbols.zip
+	cd generate && wget https://github.com/mactypes/symbolsdb/releases/download/1.1/symbols.zip

generate/class.go

@@ -40,7 +40,7 @@ func (db *Generator) ToClassGen(sym Symbol) *codegen.Class {
 		DocURL:      sym.DocURL(),
 	}
 
-	st, err := sym.Parse()
+	st, err := sym.Parse(db.Platform)
 	if err != nil {
 		panic(err)
 	}

generate/codegen/codegen.go

@@ -2,7 +2,7 @@ package codegen
 
 import "github.com/progrium/macdriver/internal/set"
 
-var AutoGeneratedMark = "// AUTO-GENERATED CODE, DO NOT MODIFY\n"
+var AutoGeneratedMark = "// Code generated by DarwinKit. DO NOT EDIT.\n"
 
 // CodeGen is interface for Class/Protocol code Gen
 type CodeGen interface {

generate/codegen/filewriter.go

@@ -3,6 +3,7 @@ package codegen
 import (
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/progrium/macdriver/generate/modules"
 	"github.com/progrium/macdriver/internal/set"
@@ -57,6 +58,9 @@ func (w *FileWriter) WriteCode() {
 }
 
 func (w *FileWriter) goFilePath() string {
+	if strings.Contains(w.Name, "Delegate") {
+		w.Name = strings.Replace(w.Name, "Protocol", "", -1)
+	}
 	name := stringx.CamelToSnake(modules.TrimPrefix(w.Name))
 	return w.PlatformDir + "/" + w.Module.Package + "/" + name + ".gen.go"
 }

generate/codegen/gen_class.go

@@ -223,7 +223,7 @@ func (c *Class) writeGoStruct(w *CodeWriter) {
 			w.UnIndent()
 			w.WriteLine("}")
 		}
-		if (im.InitMethod || im.ClassMethod) && im.Name != "new" && im.Name != "init" {
+		if (im.InitMethod || im.ClassMethod) && im.Name != "new" && im.Name != "init" && im.Name != "alloc" {
 			//add a convenient custom init method function
 			w.WriteLine("")
 			if m.DocURL != "" {

generate/codegen/gen_method.go

@@ -26,6 +26,7 @@ type Method struct {
 	Variadic     bool
 	Description  string
 	DocURL       string
+	Protocol     bool
 
 	goFuncName string
 	identifier string
@@ -72,6 +73,7 @@ func (m *Method) NormalizeInstanceTypeMethod(returnType *typing.ClassType) *Meth
 		goFuncName:  m.goFuncName,
 		Suffix:      m.Suffix,
 		Variadic:    m.Variadic,
+		Protocol:    m.Protocol,
 	}
 	return nm
 }
@@ -172,7 +174,7 @@ func (m *Method) WriteGoInterfaceCode(currentModule *modules.Module, classType *
 func (m *Method) GoFuncDeclare(currentModule *modules.Module, goTypeName string) string {
 	var paramStrs []string
 	for _, p := range m.Params {
-		paramStrs = append(paramStrs, p.GoDeclare(currentModule, false))
+		paramStrs = append(paramStrs, p.GoDeclare(currentModule, m.Protocol))
 	}
 	if m.Variadic {
 		paramStrs = append(paramStrs, "args ...any")
@@ -216,7 +218,7 @@ func (m *Method) ProtocolGoFuncFieldType(currentModule *modules.Module) string {
 		paramStrs = append(paramStrs, "args ...any")
 	}
 
-	return "(" + strings.Join(paramStrs, ", ") + ")" + " " + m.ReturnType.GoName(currentModule, false)
+	return "(" + strings.Join(paramStrs, ", ") + ")" + " " + m.ReturnType.GoName(currentModule, true)
 }
 
 // ProtocolGoFuncName return go protocol func name
@@ -292,5 +294,6 @@ func (m *Method) ToProtocolParamAsObjectMethod() *Method {
 		Description:  m.Description,
 		DocURL:       m.DocURL,
 		Variadic:     m.Variadic,
+		Protocol:     m.Protocol,
 	}
 }

generate/codegen/gen_protocol.go

@@ -226,7 +226,10 @@ func (p *Protocol) writeDelegateStruct(w *CodeWriter) {
 
 func (p *Protocol) writeProtocolWrapperStruct(w *CodeWriter) {
 	typeName := p.Type.GoWrapperName()
-	w.WriteLine(fmt.Sprintf("// A concrete type wrapper for the [%s] protocol.", p.Type.GoInterfaceName()))
+	w.WriteLine("// ensure impl type implements protocol interface")
+	w.WriteLine(fmt.Sprintf("var _ %s = (*%s)(nil)", p.Type.GoInterfaceName(), typeName))
+	w.WriteLine("")
+	w.WriteLine(fmt.Sprintf("// A concrete type for the [%s] protocol.", p.Type.GoInterfaceName()))
 	w.WriteLine("type " + typeName + " struct {")
 	w.Indent()
 	if len(p.Supers) == 0 {
@@ -276,5 +279,8 @@ func (p *Protocol) allMethods() []*Method {
 
 		allMethods = append(allMethods, (*Method)(pp.getter()))
 	}
+	for idx := range allMethods {
+		allMethods[idx].Protocol = true
+	}
 	return allMethods
 }

generate/codegen/modulewriter.go

@@ -98,7 +98,9 @@ func (m *ModuleWriter) WriteEnumAliases() {
 		return
 	}
 	armVals := false
+	imports := set.New[string]()
 	for _, e := range enums {
+		imports.AddSet(e.Type.GoImports())
 		for _, v := range e.Values {
 			if v.Arm64Value != "" {
 				armVals = true
@@ -145,6 +147,16 @@ func (m *ModuleWriter) WriteEnumAliases() {
 	amd64cw.WriteLine(AutoGeneratedMark)
 	amd64cw.WriteLine("package " + m.Module.Package)
 
+	cw.WriteLine("import (")
+	cw.Indent()
+	imports.ForEach(func(value string) {
+		if value != "github.com/progrium/macdriver/macos/objc" {
+			cw.WriteLine("\"" + value + "\"")
+		}
+	})
+	cw.UnIndent()
+	cw.WriteLine(")")
+
 	for _, ei := range enums {
 		primitiveType := ei.Type.GoName(&m.Module, false)
 		if ei.Module.Name == m.Module.Name {
@@ -206,6 +218,9 @@ func (m *ModuleWriter) WriteEnumAliases() {
 				log.Println("enum ", v.Name, " requires a value")
 				continue
 			}
+			if v.GoName == ei.GoName(&m.Module, false) {
+				v.GoName = "K" + v.GoName
+			}
 			if v.Arm64Value != "" {
 				if !ei.IsString() {
 					amd64cw.WriteLine(fmt.Sprintf("\t%s %s = %s", v.GoName, ei.GoName(&m.Module, false), v.Value))
@@ -245,8 +260,8 @@ func (m *ModuleWriter) WriteDocFile() {
 		cw.WriteLine(AutoGeneratedMark)
 		cw.WriteLineF("// %s", m.Description)
 		cw.WriteLine("//")
-		cw.WriteLine("// [Full Documentation]")
-		cw.WriteLineF("//\n// [Full Documentation]: %s", m.DocURL)
+		cw.WriteLine("// [Apple Documentation]")
+		cw.WriteLineF("//\n// [Apple Documentation]: %s", m.DocURL)
 		cw.WriteLineF("package %s", m.Module.Package)
 	}
 }

generate/enums.go

@@ -16,7 +16,7 @@ func (db *Generator) ToEnumInfo(fw string, sym Symbol) *codegen.AliasInfo {
 	}
 	var enumValues []*codegen.EnumValue
 	for _, ev := range db.EnumValues(fw) {
-		st, _ := ev.Parse()
+		st, _ := ev.Parse(db.Platform)
 		if st.Variable.Type.Name != sym.Name && ev.Parent != sym.Name {
 			continue
 		}
@@ -129,7 +129,7 @@ func (db *Generator) AllowedEnumAlias(s Symbol) bool {
 		"UInt32",
 		"UInt64",
 	}
-	st, err := s.Parse()
+	st, err := s.Parse(db.Platform)
 	if err != nil {
 		return false
 	}

generate/generator.go

@@ -88,7 +88,7 @@ func (db *Generator) Generate(platform string, version int, rootDir string, fram
 			}
 			protocolGen.Init()
 			fw := &codegen.FileWriter{
-				Name:        s.Name,
+				Name:        s.Name + "Protocol",
 				Module:      *protocolGen.Type.Module,
 				PlatformDir: rootDir,
 			}
@@ -114,7 +114,7 @@ func (db *Generator) Generate(platform string, version int, rootDir string, fram
 				mw.EnumAliases = append(mw.EnumAliases, db.ToEnumInfo(framework, s))
 				continue
 			}
-			st, err := s.Parse()
+			st, err := s.Parse(db.Platform)
 			if err != nil || st.TypeAlias == nil {
 				log.Printf("skipping '%s', bad decl: %s", s.Name, s.Declaration)
 				continue
@@ -147,7 +147,7 @@ func (db *Generator) ResolveTypeAlias(typeName string) (declparse.TypeInfo, bool
 	if s == nil {
 		return declparse.TypeInfo{}, false
 	}
-	st, err := s.Parse()
+	st, err := s.Parse(db.Platform)
 	if err != nil || st.TypeAlias == nil {
 		return declparse.TypeInfo{}, false
 	}

generate/members.go

@@ -8,6 +8,7 @@ import (
 	"github.com/progrium/macdriver/generate/codegen"
 	"github.com/progrium/macdriver/generate/declparse"
 	"github.com/progrium/macdriver/generate/modules"
+	"github.com/progrium/macdriver/generate/typing"
 )
 
 func (db *Generator) shouldSkipType(ti declparse.TypeInfo) bool {
@@ -64,6 +65,7 @@ func (db *Generator) shouldSkipType(ti declparse.TypeInfo) bool {
 		"CLBeaconIdentityConstraint",
 		"mach_port_t",
 		"cpu_type_t",
+		"ptrdiff_t",
 	} {
 		if ti.Name == n {
 			return true
@@ -93,7 +95,7 @@ func (db *Generator) Members(fw string, sym Symbol, covariantTypes []string) (pr
 				s.Declaration = strings.ReplaceAll(s.Declaration, fmt.Sprintf("<%s>", ct), "<NSObject>")
 			}
 
-			st, err := s.Parse()
+			st, err := s.Parse(db.Platform)
 			if err != nil {
 				log.Println("Members:", sym.Name, "::", s.Declaration)
 				panic(err)
@@ -181,6 +183,12 @@ func (db *Generator) Members(fw string, sym Symbol, covariantTypes []string) (pr
 					if ptyp == nil {
 						log.Fatalf("Method param type failure: owner=%s arg=%s type=%s methoddecl=%s", sym.Name, arg.Name, arg.Type.Name, s.Declaration)
 					}
+					if ptrtyp, ok := ptyp.(*typing.PointerType); ok {
+						if ptrtyp.Type == nil {
+							log.Println("using NSObject in place of missing type:", arg.Type.Name)
+							ptyp = typing.Object
+						}
+					}
 					param := &codegen.Param{
 						Name:      arg.Name,
 						Type:      ptyp,

generate/modules/modules.go

@@ -119,7 +119,6 @@ var All = []Module{
 	{"UIKit", "UIKit", "uikit", "UIKit/UIKit.h", []string{"NS"}},
 	{"UniformTypeIdentifiers", "Uniform Type Identifiers", "uti", "UniformTypeIdentifiers/UniformTypeIdentifiers.h", []string{"UT"}},
 	{"WebKit", "WebKit", "webkit", "WebKit/WebKit.h", []string{"WK"}},
-	{"MediaPlayer", "Media Player", "mediaplayer", "MediaPlayer/MediaPlayer.h", []string{"MP"}},
 	{"FileProvider", "File Provider", "fileprovider", "FileProvider/FileProvider.h", []string{"NS"}},
 	{"Quartz", "Quartz", "quartz", "Quartz/Quartz.h", []string{"IK", "kQC", "kQuartz", "QC", "IK_"}},
 	{"SecurityInterface", "Security Interface", "securityinterface", "SecurityInterface/SecurityInterface.h", []string{"SF"}},
@@ -158,4 +157,5 @@ var All = []Module{
 	{"MetalPerformanceShadersGraph", "Metal Performance Shaders Graph", "mpsgraph", "MetalPerformanceShadersGraph/MetalPerformanceShadersGraph.h", []string{"MPSGraph"}},
 	{"MetalPerformanceShaders", "Metal Performance Shaders", "mps", "MetalPerformanceShaders/MetalPerformanceShaders.h", []string{"MPS"}},
 	{"SystemConfiguration", "System Configuration", "sysconfig", "SystemConfiguration/SystemConfiguration.h", []string{"SC", "kSC"}},
+	{"MediaPlayer", "Media Player", "mediaplayer", "MediaPlayer/MediaPlayer.h", []string{"MP"}},
 }

generate/protocol.go

@@ -13,7 +13,7 @@ func (db *Generator) ToProtocolGen(fw string, sym Symbol) *codegen.Protocol {
 	if db.genCache == nil {
 		db.genCache = make(map[string]codegen.CodeGen)
 	}
-	key := fmt.Sprintf("%s.%s", fw, sym.Name)
+	key := fmt.Sprintf("%s.P%s", fw, sym.Name)
 	cg, ok := db.genCache[key]
 	if ok {
 		if pcg, ok := cg.Copy().(*codegen.Protocol); ok {
@@ -34,8 +34,8 @@ func (db *Generator) ToProtocolGen(fw string, sym Symbol) *codegen.Protocol {
 		Type:        type_,
 	}
 
-	// symbolsdb doesnt have protocol superclasses yet,
-	// so these are known ones for appkit for now
+	// symbolsdb should have protocol superclasses now via inheritsFrom,
+	// but these are known ones for appkit for now
 	knownSupers := map[string]string{
 		"NSComboBoxDelegate":    "NSTextFieldDelegate",
 		"NSMatrixDelegate":      "NSControlTextEditingDelegate",

generate/symbols.go

@@ -37,20 +37,27 @@ var blacklist = []string{
 	"WebView",              // gets picked up instead of WKWebView
 }
 
+var pathBlacklist = []string{
+	"foundation/nshashtable/legacy_hash_table_implementation/nshashtable", // found instead of NSHashTable class
+	"foundation/nsmaptable/legacy_map_table_implementation/nsmaptable",    // same
+}
+
 type Symbol struct {
 	Name string
 	Path string
 	Kind string
 
-	Description string
-	Type        string
-	Parent      string
-	Modules     []string
-	Platforms   []Platform
-	Declaration string
-	Parameters  []Parameter
-	Return      string
-	Deprecated  bool
+	Description   string
+	Type          string
+	Parent        string
+	Modules       []string
+	Platforms     []Platform
+	Declaration   string
+	Declarations  map[string]string
+	Parameters    []Parameter
+	Return        string
+	Deprecated    bool
+	InheritedFrom string
 }
 
 type Platform struct {
@@ -125,8 +132,12 @@ func (s Symbol) HasPlatform(name string, version int, deprecated bool) bool {
 	return false
 }
 
-func (s Symbol) Parse() (*declparse.Statement, error) {
-	p := declparse.NewStringParser(s.Declaration)
+func (s Symbol) Parse(platform string) (*declparse.Statement, error) {
+	decl := s.Declaration
+	if decl == "" && len(s.Declarations) > 0 {
+		decl = s.Declarations[platform]
+	}
+	p := declparse.NewStringParser(decl)
 	switch s.Kind {
 	case "Constant", "Property":
 		p.Hint = declparse.HintVariable
@@ -177,6 +188,9 @@ func (db *SymbolCache) loadFrom(file *zip.File) (v Symbol, err error) {
 	if strIn(blacklist, v.Name) {
 		return v, fmt.Errorf("blacklisted symbol: %s", v.Name)
 	}
+	if strIn(pathBlacklist, v.Path) {
+		return v, fmt.Errorf("blacklisted path: %s", v.Path)
+	}
 	if v.Kind != "Property" && v.Kind != "Method" && v.Kind != "Framework" {
 		db.cache[v.Name] = v
 	}