build: Allow overriden functions calls

r-l-x · flimzy · commit c47ddde90f81 · 2023-06-26T14:20:19.000+02:00
Before this commit, every overriden standard library function was renamed
'_'. Now, if there is the following directive in the function comment:
"//gopherjs:keep_overridden", they are prefixed with "_gopherjs_overridden_"
so that they can be called from the overriding function. This is typically
useful to use the standard library implementation as a fallback.
diff --git a/build/build.go b/build/build.go
@@ -117,6 +117,23 @@ func ImportDir(dir string, mode build.ImportMode, installSuffix string, buildTag
 	return pkg, nil
 }
 
+// Test if we find the '//gopherjs:keep_overridden' comment
+func findKeepOverridenComment(doc *ast.CommentGroup) bool {
+	if doc == nil {
+		return false
+	}
+	for _, comment := range doc.List {
+		text := comment.Text
+		if i := strings.Index(text, " "); i >= 0 {
+			text = text[:i]
+		}
+		if text == "//gopherjs:keep_overridden" {
+			return true
+		}
+	}
+	return false
+}
+
 // parseAndAugment parses and returns all .go files of given pkg.
 // Standard Go library packages are augmented with files in compiler/natives folder.
 // If isTest is true and pkg.ImportPath has no _test suffix, package is built for running internal tests.
@@ -125,12 +142,19 @@ func ImportDir(dir string, mode build.ImportMode, installSuffix string, buildTag
 // The native packages are augmented by the contents of natives.FS in the following way.
 // The file names do not matter except the usual `_test` suffix. The files for
 // native overrides get added to the package (even if they have the same name
-// as an existing file from the standard library). For all identifiers that exist
-// in the original AND the overrides, the original identifier in the AST gets
-// replaced by `_`. New identifiers that don't exist in original package get added.
+// as an existing file from the standard library). For function identifiers that exist
+// in the original AND the overrides AND that include the following directive in their comment:
+// //gopherjs:keep_overridden, the original identifier in the AST gets prefixed by
+// `_gopherjs_overridden_`. For other identifiers that exist in the original AND the overrides,
+// the original identifier gets replaced by `_`. New identifiers that don't exist in original
+// package get added.
 func parseAndAugment(xctx XContext, pkg *PackageData, isTest bool, fileSet *token.FileSet) ([]*ast.File, []JSFile, error) {
 	var files []*ast.File
-	replacedDeclNames := make(map[string]bool)
+
+	type overrideInfo struct {
+		keepOverriden bool
+	}
+	replacedDeclNames := make(map[string]overrideInfo)
 	pruneOriginalFuncs := make(map[string]bool)
 
 	isXTest := strings.HasSuffix(pkg.ImportPath, "_test")
@@ -170,18 +194,18 @@ func parseAndAugment(xctx XContext, pkg *PackageData, isTest bool, fileSet *toke
 				switch d := decl.(type) {
 				case *ast.FuncDecl:
 					k := astutil.FuncKey(d)
-					replacedDeclNames[k] = true
+					replacedDeclNames[k] = overrideInfo{keepOverriden: findKeepOverridenComment(d.Doc)}
 					pruneOriginalFuncs[k] = astutil.PruneOriginal(d)
 				case *ast.GenDecl:
 					switch d.Tok {
 					case token.TYPE:
 						for _, spec := range d.Specs {
-							replacedDeclNames[spec.(*ast.TypeSpec).Name.Name] = true
+							replacedDeclNames[spec.(*ast.TypeSpec).Name.Name] = overrideInfo{}
 						}
 					case token.VAR, token.CONST:
 						for _, spec := range d.Specs {
 							for _, name := range spec.(*ast.ValueSpec).Names {
-								replacedDeclNames[name.Name] = true
+								replacedDeclNames[name.Name] = overrideInfo{}
 							}
 						}
 					}
@@ -234,20 +258,26 @@ func parseAndAugment(xctx XContext, pkg *PackageData, isTest bool, fileSet *toke
 			switch d := decl.(type) {
 			case *ast.FuncDecl:
 				k := astutil.FuncKey(d)
-				if replacedDeclNames[k] {
-					d.Name = ast.NewIdent("_")
+				if info, ok := replacedDeclNames[k]; ok {
 					if pruneOriginalFuncs[k] {
 						// Prune function bodies, since it may contain code invalid for
 						// GopherJS and pin unwanted imports.
 						d.Body = nil
 					}
+					if info.keepOverriden {
+						// Allow overridden function calls
+						// The standard library implementation of foo() becomes _gopherjs_overridden_foo()
+						d.Name.Name = "_gopherjs_overridden_" + d.Name.Name
+					} else {
+						d.Name = ast.NewIdent("_")
+					}
 				}
 			case *ast.GenDecl:
 				switch d.Tok {
 				case token.TYPE:
 					for _, spec := range d.Specs {
 						s := spec.(*ast.TypeSpec)
-						if replacedDeclNames[s.Name.Name] {
+						if _, ok := replacedDeclNames[s.Name.Name]; ok {
 							s.Name = ast.NewIdent("_")
 							s.Type = &ast.StructType{Struct: s.Pos(), Fields: &ast.FieldList{}}
 							s.TypeParams = nil
@@ -257,7 +287,7 @@ func parseAndAugment(xctx XContext, pkg *PackageData, isTest bool, fileSet *toke
 					for _, spec := range d.Specs {
 						s := spec.(*ast.ValueSpec)
 						for i, name := range s.Names {
-							if replacedDeclNames[name.Name] {
+							if _, ok := replacedDeclNames[name.Name]; ok {
 								s.Names[i] = ast.NewIdent("_")
 							}
 						}
