better top

[micro.git] / internal / util / lua.go

diff --git a/internal/util/lua.go b/internal/util/lua.go
index 3f0393d410e861dd2feb6b2b6e1006dfe6b608fa..8d1ce7725e1662736a316a3b12c7f23ff866dd4a 100644 (file)
--- a/internal/util/lua.go
+++ b/internal/util/lua.go
@@ -4,6 +4,8 @@ import (
        "unicode/utf8"
 )
 
+// LuaRuneAt is a helper function for lua plugins to return the rune
+// at an index within a string
 func LuaRuneAt(str string, runeidx int) string {
        i := 0
        for len(str) > 0 {
@@ -20,6 +22,7 @@ func LuaRuneAt(str string, runeidx int) string {
        return ""
 }
 
+// LuaGetLeadingWhitespace returns the leading whitespace of a string (used by lua plugins)
 func LuaGetLeadingWhitespace(s string) string {
        ws := []byte{}
        for len(s) > 0 {
@@ -35,6 +38,7 @@ func LuaGetLeadingWhitespace(s string) string {
        return string(ws)
 }
 
+// LuaIsWordChar returns true if the first rune in a string is a word character
 func LuaIsWordChar(s string) bool {
        r, _ := utf8.DecodeRuneInString(s)
        return IsWordChar(r)