Merge pull request #283 from boombuler/autocompleteplugin

Autocomplete for plugins

cmd/micro/autocomplete.go

@@ -8,6 +8,8 @@ import (
 	"github.com/mitchellh/go-homedir"
 )
 
+var pluginCompletions []func(string) []string
+
 // This file is meant (for now) for autocompletion in command mode, not
 // while coding. This helps micro autocomplete commands and then filenames
 // for example with `vsplit filename`.
@@ -123,3 +125,24 @@ func OptionComplete(input string) (string, []string) {
 	}
 	return chosen, suggestions
 }
+
+// MakeCompletion registeres a function from a plugin for autocomplete commands
+func MakeCompletion(function string) Completion {
+	pluginCompletions = append(pluginCompletions, LuaFunctionComplete(function))
+	return Completion(-len(pluginCompletions))
+}
+
+// PluginComplete autocompletes from plugin function
+func PluginComplete(complete Completion, input string) (chosen string, suggestions []string) {
+	idx := int(-complete) - 1
+
+	if len(pluginCompletions) <= idx {
+		return "", nil
+	}
+	suggestions = pluginCompletions[idx](input)
+
+	if len(suggestions) == 1 {
+		chosen = suggestions[0]
+	}
+	return
+}

cmd/micro/messenger.go

@@ -232,6 +232,8 @@ func (m *Messenger) Prompt(prompt, historyType string, completionTypes ...Comple
 					chosen, suggestions = HelpComplete(currentArg)
 				} else if completionType == OptionCompletion {
 					chosen, suggestions = OptionComplete(currentArg)
+				} else if completionType < NoCompletion {
+					chosen, suggestions = PluginComplete(completionType, currentArg)
 				}
 
 				if len(suggestions) > 1 {

cmd/micro/micro.go

@@ -306,6 +306,7 @@ func main() {
 	L.SetGlobal("HandleCommand", luar.New(L, HandleCommand))
 	L.SetGlobal("HandleShellCommand", luar.New(L, HandleShellCommand))
 	L.SetGlobal("GetLeadingWhitespace", luar.New(L, GetLeadingWhitespace))
+	L.SetGlobal("MakeCompletion", luar.New(L, MakeCompletion))
 
 	// Used for asynchronous jobs
 	L.SetGlobal("JobStart", luar.New(L, JobStart))

cmd/micro/plugin.go

@@ -85,6 +85,30 @@ func LuaFunctionCommand(function string) func([]string) {
 	}
 }
 
+// LuaFunctionComplete returns a function which can be used for autocomplete in plugins
+func LuaFunctionComplete(function string) func(string) []string {
+	return func(input string) (result []string) {
+
+		res, err := Call(function, input)
+		if err != nil {
+			TermMessage(err)
+		}
+		if tbl, ok := res.(*lua.LTable); !ok {
+			TermMessage(function, "should return a table of strings")
+		} else {
+			for i := 1; i <= tbl.Len(); i++ {
+				val := tbl.RawGetInt(i)
+				if v, ok := val.(lua.LString); !ok {
+					TermMessage(function, "should return a table of strings")
+				} else {
+					result = append(result, string(v))
+				}
+			}
+		}
+		return result
+	}
+}
+
 func LuaFunctionJob(function string) func(string, ...string) {
 	return func(output string, args ...string) {
 		_, err := Call(function, unpack(append([]string{output}, args...))...)

runtime/help/plugins.md

@@ -66,6 +66,9 @@ as Go's GOOS variable, so `darwin`, `windows`, `linux`, `freebsd`...)
    creates a command with `name` which will call `function` when executed.
    Use 0 for completions to get NoCompletion.
 
+* `MakeCompletion(function string)`:
+   creates a `Completion` to use with `MakeCommand`.
+
 * `CurView()`: returns the current view
 
 * `HandleCommand(cmd string)`: runs the given command
@@ -104,6 +107,36 @@ The possible methods which you can call using the `messenger` variable are:
 
 If you want a standard prompt, just use `messenger.Prompt(prompt, "", 0)`
 
+# Autocomplete command arguments
+
+See this example to learn how to use `MakeCompletion` and `MakeCommand`
+
+```lua
+local function StartsWith(String,Start)
+  String = String:upper()
+  Start = Start:upper() 
+  return string.sub(String,1,string.len(Start))==Start
+end
+
+function complete(input)
+  local allCompletions = {"Hello", "World", "Foo", "Bar"}
+  local result = {}
+   
+  for i,v in pairs(allCompletions) do
+  if StartsWith(v, input) then
+       table.insert(result, v)
+     end
+   end
+   return result
+end
+
+function foo(arg)
+  messenger:Message(arg)
+end
+
+MakeCommand("foo", "example.foo", MakeCompletion("example.complete"))
+```
+
 # Default plugins
 
 For examples of plugins, see the default plugins `linter`, `go`, and `autoclose`.