nvim: support deprecated.go to api_tool

Signed-off-by: Koichi Shiraishi <[email protected]>

Author: zchee

nvim/api_tool.go

@@ -1,7 +1,7 @@
 //go:build ignore
 // +build ignore
 
-// Command apitool generates api.go from api_def.go. The command also has
+// Command api_tool generates api.go from api_def.go. The command also has
 // an option to compare api_def.go to Nvim's current API meta data.
 package main
 
@@ -122,13 +122,16 @@ func parseFields(fset *token.FileSet, fl *ast.FieldList) []*Field {
 }
 
 // parseAPIDef parses the file api_def.go.
-func parseAPIDef() ([]*Function, error) {
+func parseAPIDef() ([]*Function, []*Function, error) {
 	fset := token.NewFileSet()
 	file, err := parser.ParseFile(fset, "api_def.go", nil, parser.ParseComments)
 	if err != nil {
-		return nil, err
+		return nil, nil, err
 	}
+
 	var functions []*Function
+	var deprecateds []*Function
+
 	for _, decl := range file.Decls {
 		fdecl, ok := decl.(*ast.FuncDecl)
 		if !ok {
@@ -148,10 +151,13 @@ func parseAPIDef() ([]*Function, error) {
 			Doc:        string(doc),
 			Parameters: parseFields(fset, fdecl.Type.Params),
 		}
+
 		fields := parseFields(fset, fdecl.Type.Results)
 		if len(fields) > 1 {
-			return nil, fmt.Errorf("%s: more than one result for %s", fset.Position(fdecl.Pos()), m.Name)
-		} else if len(fields) == 1 {
+			return nil, nil, fmt.Errorf("%s: more than one result for %s", fset.Position(fdecl.Pos()), m.Name)
+		}
+
+		if len(fields) == 1 {
 			m.ReturnName = fields[0].Name
 			m.ReturnType = fields[0].Type
 		}
@@ -179,65 +185,22 @@ func parseAPIDef() ([]*Function, error) {
 				}
 			}
 		}
+
 		if m.Name == "" {
-			return nil, fmt.Errorf("%s: service method not specified for %s", fset.Position(fdecl.Pos()), m.Name)
+			return nil, nil, fmt.Errorf("%s: service method not specified for %s", fset.Position(fdecl.Pos()), m.Name)
+		}
+
+		if m.DeprecatedSince > 0 {
+			deprecateds = append(deprecateds, m)
+			continue
 		}
 		functions = append(functions, m)
 	}
-	return functions, nil
-}
-
-var implementationTemplate = template.Must(template.New("").Funcs(template.FuncMap{
-	"lower": strings.ToLower,
-}).Parse(`// Code generated by running "go generate" in github.com/neovim/go-client/nvim. DO NOT EDIT.
-
-package nvim
-
-import (
-    "fmt"
-
-    "github.com/neovim/go-client/msgpack"
-    "github.com/neovim/go-client/msgpack/rpc"
-)
-
-const (
-    {{- range $name, $type := .ErrorTypes}}
-    {{- lower $name}}Error = {{$type.ID}}
-    {{  end -}}
-)
-
-func withExtensions() rpc.Option {
-	return rpc.WithExtensions(msgpack.ExtensionMap{
-{{- range $name, $type := .Types}}
-		{{$type.ID}}: func(p []byte) (interface{}, error) {
-			x, err := decodeExt(p)
-			return {{$name}}(x), err
-		},
-{{end -}}
-	})
-}
-
-{{range $name, $type := .Types}}
-{{$type.Doc}}
-type {{$name}} int
-
-// MarshalMsgPack implements msgpack.Marshaler.
-func (x {{$name}}) MarshalMsgPack(enc *msgpack.Encoder) error {
-	return enc.PackExtension({{$type.ID}}, encodeExt(int(x)))
-}
 
-// UnmarshalMsgPack implements msgpack.Unmarshaler.
-func (x *{{$name}}) UnmarshalMsgPack(dec *msgpack.Decoder) error {
-	n, err := unmarshalExt(dec, {{$type.ID}}, x)
-	*x = {{$name}}(n)
-	return err
+	return functions, deprecateds, nil
 }
 
-// String returns a string representation of the {{$name}}.
-func (x {{$name}}) String() string {
-	return fmt.Sprintf("{{$name}}:%d", int(x))
-}
-{{end}}
+const genTemplate = `
 
 {{range .Functions}}
 {{if eq "interface{}" .ReturnType}}
@@ -295,11 +258,137 @@ func (b *Batch) {{.GoName}}({{range .Parameters}}{{.Name}} {{.Type}},{{end}}) {
 }
 {{end}}
 {{end}}
-`))
+`
+
+var implementationTemplate = template.Must(template.New("implementation").Funcs(template.FuncMap{
+	"lower": strings.ToLower,
+}).Parse(`// Code generated by running "go generate" in github.com/neovim/go-client/nvim. DO NOT EDIT.
+
+package nvim
+
+import (
+    "fmt"
+
+    "github.com/neovim/go-client/msgpack"
+    "github.com/neovim/go-client/msgpack/rpc"
+)
+
+const (
+    {{- range $name, $type := .ErrorTypes}}
+    {{- lower $name}}Error = {{$type.ID}}
+    {{  end -}}
+)
+
+func withExtensions() rpc.Option {
+	return rpc.WithExtensions(msgpack.ExtensionMap{
+{{- range $name, $type := .Types}}
+		{{$type.ID}}: func(p []byte) (interface{}, error) {
+			x, err := decodeExt(p)
+			return {{$name}}(x), err
+		},
+{{end -}}
+	})
+}
+
+{{range $name, $type := .Types}}
+{{$type.Doc}}
+type {{$name}} int
+
+// MarshalMsgPack implements msgpack.Marshaler.
+func (x {{$name}}) MarshalMsgPack(enc *msgpack.Encoder) error {
+	return enc.PackExtension({{$type.ID}}, encodeExt(int(x)))
+}
+
+// UnmarshalMsgPack implements msgpack.Unmarshaler.
+func (x *{{$name}}) UnmarshalMsgPack(dec *msgpack.Decoder) error {
+	n, err := unmarshalExt(dec, {{$type.ID}}, x)
+	*x = {{$name}}(n)
+	return err
+}
+
+// String returns a string representation of the {{$name}}.
+func (x {{$name}}) String() string {
+	return fmt.Sprintf("{{$name}}:%d", int(x))
+}
+{{end}}
+` + genTemplate))
+
+var deprecatedTemplate = template.Must(template.New("deprecated").Funcs(template.FuncMap{
+	"lower": strings.ToLower,
+}).Parse(`// Code generated by running "go generate" in github.com/neovim/go-client/nvim. DO NOT EDIT.
 
-func printImplementation(functions []*Function, outFile string) error {
+package nvim
+
+// EmbedOptions specifies options for starting an embedded instance of Nvim.
+//
+// Deprecated: Use ChildProcessOption instead.
+type EmbedOptions struct {
+	// Logf log function for rpc.WithLogf.
+	Logf func(string, ...interface{})
+
+	// Dir specifies the working directory of the command. The working
+	// directory in the current process is used if Dir is "".
+	Dir string
+
+	// Path is the path of the command to run. If Path = "", then
+	// StartEmbeddedNvim searches for "nvim" on $PATH.
+	Path string
+
+	// Args specifies the command line arguments. Do not include the program
+	// name (the first argument) or the --embed option.
+	Args []string
+
+	// Env specifies the environment of the Nvim process. The current process
+	// environment is used if Env is nil.
+	Env []string
+}
+
+// NewEmbedded starts an embedded instance of Nvim using the specified options.
+//
+// The application must call Serve() to handle RPC requests and responses.
+//
+// Deprecated: Use NewChildProcess instead.
+func NewEmbedded(options *EmbedOptions) (*Nvim, error) {
+	if options == nil {
+		options = &EmbedOptions{}
+	}
+	path := options.Path
+	if path == "" {
+		path = "nvim"
+	}
+
+	return NewChildProcess(
+		ChildProcessArgs(append([]string{"--embed"}, options.Args...)...),
+		ChildProcessCommand(path),
+		ChildProcessEnv(options.Env),
+		ChildProcessDir(options.Dir),
+		ChildProcessServe(false))
+}
+
+// ExecuteLua executes a Lua block.
+//
+// Deprecated: Use ExecLua instead.
+func (v *Nvim) ExecuteLua(code string, result interface{}, args ...interface{}) error {
+	if args == nil {
+		args = []interface{}{}
+	}
+	return v.call("nvim_execute_lua", result, code, args)
+}
+
+// ExecuteLua executes a Lua block.
+//
+// Deprecated: Use ExecLua instead.
+func (b *Batch) ExecuteLua(code string, result interface{}, args ...interface{}) {
+	if args == nil {
+		args = []interface{}{}
+	}
+	b.call("nvim_execute_lua", result, code, args)
+}
+` + genTemplate))
+
+func printImplementation(functions []*Function, tmpl *template.Template, outFile string) error {
 	var buf bytes.Buffer
-	if err := implementationTemplate.Execute(&buf, &APIInfo{
+	if err := tmpl.Execute(&buf, &APIInfo{
 		Functions:  functions,
 		Types:      extensionTypes,
 		ErrorTypes: errorTypes,
@@ -517,6 +606,7 @@ func main() {
 	log.SetFlags(log.Lshortfile)
 
 	generateFlag := flag.String("generate", "", "Generate implementation from api_def.go and write to `file`")
+	deprecatedFlag := flag.String("deprecated", "", "Generate deprecated implementation from api_def.go and write to `file`")
 	compareFlag := flag.Bool("compare", false, "Compare api_def.go to the output of nvim --api-info")
 	dumpFlag := flag.Bool("dump", false, "Print nvim --api-info as JSON")
 	flag.Parse()
@@ -528,16 +618,25 @@ func main() {
 		return
 	}
 
-	functions, err := parseAPIDef()
+	functions, deprecateds, err := parseAPIDef()
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	switch {
 	case *compareFlag:
+		functions = append(functions, deprecateds...)
 		err = compareFunctions(functions)
 	default:
-		err = printImplementation(functions, *generateFlag)
+		if *generateFlag != "" {
+			if *deprecatedFlag == "" {
+				functions = append(functions, deprecateds...)
+			}
+			err = printImplementation(functions, implementationTemplate, *generateFlag)
+		}
+		if *deprecatedFlag != "" {
+			err = printImplementation(deprecateds, deprecatedTemplate, *deprecatedFlag)
+		}
 	}
 	if err != nil {
 		log.Fatal(err)