Compare commits

..

No commits in common. "df70082a81a70811edc9ef58903b046879bee003" and "e4833bdba9b2f7a3b73309c64a697bfa5c1d2952" have entirely different histories.

19 changed files with 47 additions and 313 deletions

1
.gitignore vendored
View File

@ -1,6 +1,5 @@
*.exe *.exe
hilbish hilbish
docgen
.vim .vim
petals/ petals/

View File

@ -15,7 +15,7 @@ hilbiline:
install: install:
@install -v -d "$(DESTDIR)$(BINDIR)/" && install -m 0755 -v hilbish "$(DESTDIR)$(BINDIR)/hilbish" @install -v -d "$(DESTDIR)$(BINDIR)/" && install -m 0755 -v hilbish "$(DESTDIR)$(BINDIR)/hilbish"
@mkdir -p "$(DESTDIR)$(LIBDIR)" @mkdir -p "$(DESTDIR)$(LIBDIR)"
@cp libs docs preload.lua .hilbishrc.lua "$(DESTDIR)$(LIBDIR)" -r @cp libs preload.lua .hilbishrc.lua "$(DESTDIR)$(LIBDIR)" -r
@grep "$(DESTDIR)$(BINDIR)/hilbish" -qxF /etc/shells || echo "$(DESTDIR)$(BINDIR)/hilbish" >> /etc/shells @grep "$(DESTDIR)$(BINDIR)/hilbish" -qxF /etc/shells || echo "$(DESTDIR)$(BINDIR)/hilbish" >> /etc/shells
@echo "Hilbish Installed" @echo "Hilbish Installed"

View File

@ -1,79 +0,0 @@
package main
import (
"fmt"
"path/filepath"
"go/ast"
"go/doc"
"go/parser"
"go/token"
"strings"
"os"
)
// feel free to clean this up
// it works, dont really care about the code
func main() {
fset := token.NewFileSet()
dirs := []string{"./"}
filepath.Walk("golibs/", func (path string, info os.FileInfo, err error) error {
if !info.IsDir() {
return nil
}
dirs = append(dirs, "./" + path)
return nil
})
pkgs := make(map[string]*ast.Package)
for _, path := range dirs {
d, err := parser.ParseDir(fset, path, nil, parser.ParseComments)
if err != nil {
fmt.Println(err)
return
}
for k, v := range d {
pkgs[k] = v
}
}
prefix := map[string]string{
"main": "hsh",
"hilbish": "hl",
"fs": "f",
"commander": "c",
"bait": "b",
}
docs := make(map[string][]string)
for l, f := range pkgs {
p := doc.New(f, "./", doc.AllDecls)
for _, t := range p.Funcs {
mod := l
if strings.HasPrefix(t.Name, "hl") { mod = "hilbish" }
if !strings.HasPrefix(t.Name, prefix[mod]) || t.Name == "Loader" { continue }
parts := strings.Split(t.Doc, "\n")
funcsig := parts[0]
doc := parts[1:]
docs[mod] = append(docs[mod], funcsig + " > " + strings.Join(doc, "\n"))
}
for _, t := range p.Types {
for _, m := range t.Methods {
if !strings.HasPrefix(m.Name, prefix[l]) || m.Name == "Loader" { continue }
parts := strings.Split(m.Doc, "\n")
funcsig := parts[0]
doc := parts[1:]
docs[l] = append(docs[l], funcsig + " > " + strings.Join(doc, "\n"))
}
}
}
for mod, v := range docs {
if mod == "main" { mod = "global" }
os.Mkdir("docs", 0777)
f, _ := os.Create("docs/" + mod + ".txt")
f.WriteString(strings.Join(v, "\n") + "\n")
}
}

View File

@ -1,4 +0,0 @@
catch(name, cb) > Catches a hook with `name`. Runs the `cb` when it is thrown
throw(name, ...args) > Throws a hook with `name` with the provided `args`

View File

@ -1,4 +0,0 @@
deregister(name) > Deregisters any command registered with `name`
register(name, cb) > Register a command with `name` that runs `cb` when ran

View File

@ -1,8 +0,0 @@
cd(dir) > Changes directory to `dir`
mkdir(name, recursive) > Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
readdir(dir) > Returns a table of files in `dir`
stat(path) > Returns info about `path`

View File

@ -1,21 +0,0 @@
alias(cmd, orig) > Sets an alias of `orig` to `cmd`
appendPath(dir) > Appends `dir` to $PATH
exec(cmd) > Replaces running hilbish with `cmd`
goro(fn) > Puts `fn` in a goroutine
interval(cb, time) > Runs the `cb` function every `time` milliseconds
multiprompt(str) > Changes the continued line prompt to `str`
prompt(str) > Changes the shell prompt to `str`
There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values.
`%d` - Current working directory
`%u` - Name of current user
`%h` - Hostname of device
timeout(cb, time) > Runs the `cb` function after `time` in milliseconds

View File

@ -1,6 +0,0 @@
cwd() > Returns the current directory of the shell
flag(f) > Checks if the `f` flag has been passed to Hilbish.
run(cmd) > Runs `cmd` in Hilbish's sh interpreter

View File

@ -1,8 +1,6 @@
package bait package bait
import ( import (
"hilbish/util"
"github.com/chuckpreslar/emission" "github.com/chuckpreslar/emission"
"github.com/yuin/gopher-lua" "github.com/yuin/gopher-lua"
"layeh.com/gopher-luar" "layeh.com/gopher-luar"
@ -20,28 +18,18 @@ func New() Bait {
func (b *Bait) Loader(L *lua.LState) int { func (b *Bait) Loader(L *lua.LState) int {
mod := L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{}) mod := L.SetFuncs(L.NewTable(), map[string]lua.LGFunction{})
L.SetField(mod, "throw", luar.New(L, b.bthrow)) L.SetField(mod, "throw", luar.New(L, b.throw))
L.SetField(mod, "catch", luar.New(L, b.bcatch)) L.SetField(mod, "catch", luar.New(L, b.catch))
util.Document(L, mod, `Bait is the event emitter for Hilbish. Why name it bait?
Because it throws hooks that you can catch
(emits events that you can listen to) and because why not,
fun naming is fun. This is what you will use if you want to
listen in on hooks to know when certain things have happened,
like when you've changed directory, a command has failed, etc.`)
L.Push(mod) L.Push(mod)
return 1 return 1
} }
// throw(name, ...args) func (b *Bait) throw(name string, args ...interface{}) {
// Throws a hook with `name` with the provided `args`
func (b *Bait) bthrow(name string, args ...interface{}) {
b.Em.Emit(name, args...) b.Em.Emit(name, args...)
} }
// catch(name, cb) func (b *Bait) catch(name string, catcher func(...interface{})) {
// Catches a hook with `name`. Runs the `cb` when it is thrown
func (b *Bait) bcatch(name string, catcher func(...interface{})) {
b.Em.On(name, catcher) b.Em.On(name, catcher)
} }

View File

@ -1,8 +1,6 @@
package commander package commander
import ( import (
"hilbish/util"
"github.com/chuckpreslar/emission" "github.com/chuckpreslar/emission"
"github.com/yuin/gopher-lua" "github.com/yuin/gopher-lua"
) )
@ -19,19 +17,17 @@ func New() Commander {
func (c *Commander) Loader(L *lua.LState) int { func (c *Commander) Loader(L *lua.LState) int {
var exports = map[string]lua.LGFunction{ var exports = map[string]lua.LGFunction{
"register": c.cregister, "register": c.register,
"deregister": c.cderegister, "deregister": c.deregister,
} }
mod := L.SetFuncs(L.NewTable(), exports) mod := L.SetFuncs(L.NewTable(), exports)
util.Document(L, mod, "Commander is Hilbish's custom command library, a way to write commands with the shell in Lua.")
L.Push(mod) L.Push(mod)
return 1 return 1
} }
// register(name, cb) func (c *Commander) register(L *lua.LState) int {
// Register a command with `name` that runs `cb` when ran
func (c *Commander) cregister(L *lua.LState) int {
cmdName := L.CheckString(1) cmdName := L.CheckString(1)
cmd := L.CheckFunction(2) cmd := L.CheckFunction(2)
@ -40,9 +36,7 @@ func (c *Commander) cregister(L *lua.LState) int {
return 0 return 0
} }
// deregister(name) func (c *Commander) deregister(L *lua.LState) int {
// Deregisters any command registered with `name`
func (c *Commander) cderegister(L *lua.LState) int {
cmdName := L.CheckString(1) cmdName := L.CheckString(1)
c.Events.Emit("commandDeregister", cmdName) c.Events.Emit("commandDeregister", cmdName)

View File

@ -1,12 +1,10 @@
// The fs module provides easy and simple access to filesystem functions and other
// things, and acts an addition to the Lua standard library's I/O and fs functions.
package fs package fs
import ( import (
"fmt"
"os" "os"
"strings" "strings"
"hilbish/util"
"github.com/yuin/gopher-lua" "github.com/yuin/gopher-lua"
"layeh.com/gopher-luar" "layeh.com/gopher-luar"
) )
@ -14,91 +12,62 @@ import (
func Loader(L *lua.LState) int { func Loader(L *lua.LState) int {
mod := L.SetFuncs(L.NewTable(), exports) mod := L.SetFuncs(L.NewTable(), exports)
util.Document(L, mod, `The fs module provides easy and simple access to
filesystem functions and other things, and acts an
addition to the Lua standard library's I/O and fs functions.`)
L.Push(mod) L.Push(mod)
return 1 return 1
} }
func luaErr(L *lua.LState, msg string) { func LuaErr(L *lua.LState, code int) {
L.Error(lua.LString(msg), 2) // TODO: Error with a table, with path and error code
L.Error(lua.LNumber(code), 2)
} }
var exports = map[string]lua.LGFunction{ var exports = map[string]lua.LGFunction{
"cd": fcd, "cd": cd,
"mkdir": fmkdir, "mkdir": mkdir,
"stat": fstat, "stat": stat,
"readdir": freaddir,
} }
// cd(dir) func cd(L *lua.LState) int {
// Changes directory to `dir`
func fcd(L *lua.LState) int {
path := L.CheckString(1) path := L.CheckString(1)
err := os.Chdir(strings.TrimSpace(path)) err := os.Chdir(strings.TrimSpace(path))
if err != nil { if err != nil {
e := err.(*os.PathError).Err.Error() switch e := err.(*os.PathError).Err.Error(); e {
luaErr(L, e) case "no such file or directory":
LuaErr(L, 1)
case "not a directory":
LuaErr(L, 2)
default:
fmt.Printf("Found unhandled error case: %s\n", e)
fmt.Printf("Report this at https://github.com/Rosettea/Hilbish/issues with the title being: \"fs: unhandled error case %s\", and show what caused it.\n", e)
LuaErr(L, 213)
}
} }
return 0 return 0
} }
// mkdir(name, recursive) func mkdir(L *lua.LState) int {
// Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
func fmkdir(L *lua.LState) int {
dirname := L.CheckString(1) dirname := L.CheckString(1)
recursive := L.ToBool(2) recursive := L.ToBool(2)
path := strings.TrimSpace(dirname) path := strings.TrimSpace(dirname)
var err error
// TODO: handle error here
if recursive { if recursive {
err = os.MkdirAll(path, 0744) os.MkdirAll(path, 0744)
} else { } else {
err = os.Mkdir(path, 0744) os.Mkdir(path, 0744)
}
if err != nil {
luaErr(L, err.Error())
} }
return 0 return 0
} }
// stat(path) func stat(L *lua.LState) int {
// Returns info about `path`
func fstat(L *lua.LState) int {
path := L.CheckString(1) path := L.CheckString(1)
// TODO: handle error here // TODO: handle error here
pathinfo, err := os.Stat(path) pathinfo, _ := os.Stat(path)
if err != nil {
luaErr(L, err.Error())
return 0
}
L.Push(luar.New(L, pathinfo)) L.Push(luar.New(L, pathinfo))
return 1 return 1
} }
// readdir(dir)
// Returns a table of files in `dir`
func freaddir(L *lua.LState) int {
dir := L.CheckString(1)
names := []string{}
dirEntries, err := os.ReadDir(dir)
if err != nil {
luaErr(L, err.Error())
return 0
}
for _, entry := range dirEntries {
names = append(names, entry.Name())
}
L.Push(luar.New(L, names))
return 1
}

View File

@ -8,17 +8,15 @@ import (
"runtime" "runtime"
"strings" "strings"
"hilbish/util"
"github.com/pborman/getopt" "github.com/pborman/getopt"
"github.com/yuin/gopher-lua" "github.com/yuin/gopher-lua"
"mvdan.cc/sh/v3/interp" "mvdan.cc/sh/v3/interp"
) )
var exports = map[string]lua.LGFunction { var exports = map[string]lua.LGFunction {
"run": hlrun, "run": run,
"flag": hlflag, "flag": flag,
"cwd": hlcwd, "cwd": cwd,
} }
func HilbishLoader(L *lua.LState) int { func HilbishLoader(L *lua.LState) int {
@ -41,15 +39,13 @@ func HilbishLoader(L *lua.LState) int {
L.SetField(xdg, "data", lua.LString(getenv("XDG_DATA_HOME", homedir + "/.local/share/"))) L.SetField(xdg, "data", lua.LString(getenv("XDG_DATA_HOME", homedir + "/.local/share/")))
L.SetField(mod, "xdg", xdg) L.SetField(mod, "xdg", xdg)
util.Document(L, mod, "A miscellaneous sort of \"core\" API for things that relate to the shell itself and others.")
L.Push(mod) L.Push(mod)
return 1 return 1
} }
// run(cmd) // Runs a command
// Runs `cmd` in Hilbish's sh interpreter func run(L *lua.LState) int {
func hlrun(L *lua.LState) int {
var exitcode uint8 = 0 var exitcode uint8 = 0
cmd := L.CheckString(1) cmd := L.CheckString(1)
err := execCommand(cmd) err := execCommand(cmd)
@ -64,9 +60,7 @@ func hlrun(L *lua.LState) int {
return 1 return 1
} }
// flag(f) func flag(L *lua.LState) int {
// Checks if the `f` flag has been passed to Hilbish.
func hlflag(L *lua.LState) int {
flagchar := L.CheckString(1) flagchar := L.CheckString(1)
L.Push(lua.LBool(getopt.Lookup([]rune(flagchar)[0]).Seen())) L.Push(lua.LBool(getopt.Lookup([]rune(flagchar)[0]).Seen()))
@ -74,9 +68,7 @@ func hlflag(L *lua.LState) int {
return 1 return 1
} }
// cwd() func cwd(L *lua.LState) int {
// Returns the current directory of the shell
func hlcwd(L *lua.LState) int {
cwd, _ := os.Getwd() cwd, _ := os.Getwd()
L.Push(lua.LString(cwd)) L.Push(lua.LString(cwd))

21
lua.go
View File

@ -95,29 +95,18 @@ func RunLogin() {
} }
} }
/* prompt(str)
Changes the shell prompt to `str`
There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values.
`%d` - Current working directory
`%u` - Name of current user
`%h` - Hostname of device */
func hshprompt(L *lua.LState) int { func hshprompt(L *lua.LState) int {
prompt = L.CheckString(1) prompt = L.CheckString(1)
return 0 return 0
} }
// multiprompt(str)
// Changes the continued line prompt to `str`
func hshmlprompt(L *lua.LState) int { func hshmlprompt(L *lua.LState) int {
multilinePrompt = L.CheckString(1) multilinePrompt = L.CheckString(1)
return 0 return 0
} }
// alias(cmd, orig)
// Sets an alias of `orig` to `cmd`
func hshalias(L *lua.LState) int { func hshalias(L *lua.LState) int {
alias := L.CheckString(1) alias := L.CheckString(1)
source := L.CheckString(2) source := L.CheckString(2)
@ -127,8 +116,6 @@ func hshalias(L *lua.LState) int {
return 1 return 1
} }
// appendPath(dir)
// Appends `dir` to $PATH
func hshappendPath(L *lua.LState) int { func hshappendPath(L *lua.LState) int {
dir := L.CheckString(1) dir := L.CheckString(1)
dir = strings.Replace(dir, "~", curuser.HomeDir, 1) dir = strings.Replace(dir, "~", curuser.HomeDir, 1)
@ -142,8 +129,6 @@ func hshappendPath(L *lua.LState) int {
return 0 return 0
} }
// exec(cmd)
// Replaces running hilbish with `cmd`
func hshexec(L *lua.LState) int { func hshexec(L *lua.LState) int {
cmd := L.CheckString(1) cmd := L.CheckString(1)
cmdArgs, _ := splitInput(cmd) cmdArgs, _ := splitInput(cmd)
@ -161,22 +146,16 @@ func hshexec(L *lua.LState) int {
return 0 // random thought: does this ever return? return 0 // random thought: does this ever return?
} }
// goro(fn)
// Puts `fn` in a goroutine
func hshgoroutine(gofunc func()) { func hshgoroutine(gofunc func()) {
go gofunc() go gofunc()
} }
// timeout(cb, time)
// Runs the `cb` function after `time` in milliseconds
func hshtimeout(timeoutfunc func(), ms int) { func hshtimeout(timeoutfunc func(), ms int) {
timeout := time.Duration(ms) * time.Millisecond timeout := time.Duration(ms) * time.Millisecond
time.Sleep(timeout) time.Sleep(timeout)
timeoutfunc() timeoutfunc()
} }
// interval(cb, time)
// Runs the `cb` function every `time` milliseconds
func hshinterval(L *lua.LState) int { func hshinterval(L *lua.LState) int {
intervalfunc := L.CheckFunction(1) intervalfunc := L.CheckFunction(1)
ms := L.CheckInt(2) ms := L.CheckInt(2)

View File

@ -44,57 +44,6 @@ commander.register('exit', function()
os.exit(0) os.exit(0)
end) end)
commander.register('doc', function(args)
local moddocPath = hilbish.dataDir .. '/docs/'
local globalDesc = [[
These are the global Hilbish functions that are always available and not part of a module.]]
if #args > 0 then
local mod = ''
for i = 1, #args do
mod = mod .. tostring(args[i]) .. ' '
end
mod = mod:gsub('^%s*(.-)%s*$', '%1')
local f = io.open(moddocPath .. mod .. '.txt', 'rb')
if not f then
print('Could not find docs for module named ' .. mod .. '.')
return 1
end
local desc = (mod == 'global' and globalDesc or getmetatable(require(mod)).__doc)
local funcdocs = f:read '*a'
local backtickOccurence = 0
print(desc .. '\n\n' .. lunacolors.format(funcdocs:sub(1, #funcdocs - 1):gsub('`', function()
backtickOccurence = backtickOccurence + 1
if backtickOccurence % 2 == 0 then
return '{reset}'
else
return '{invert}'
end
end)))
f:close()
return
end
local modules = fs.readdir(moddocPath)
io.write [[
Welcome to Hilbish's doc tool! Here you can find documentation for builtin
functions and other things.
Usage: doc <module>
Available modules: ]]
local mods = ''
for i = 1, #modules do
mods = mods .. tostring(modules[i]):gsub('.txt', '') .. ', '
end
print(mods)
return
end)
do do
local virt_G = { } local virt_G = { }

3
rl.go
View File

@ -1,10 +1,9 @@
// +build !hilbiline // +build !hilbiline
package main
// Here we define a generic interface for readline and hilbiline, // Here we define a generic interface for readline and hilbiline,
// making them interchangable during build time // making them interchangable during build time
// this is normal readline // this is normal readline
package main
import "github.com/bobappleyard/readline" import "github.com/bobappleyard/readline"

View File

@ -1,10 +1,9 @@
// +build hilbiline // +build hilbiline
package main
// Here we define a generic interface for readline and hilbiline, // Here we define a generic interface for readline and hilbiline,
// making them interchangable during build time // making them interchangable during build time
// this is hilbiline's, as is obvious by the filename // this is hilbiline's, as is obvious by the filename
package main
import "github.com/Rosettea/Hilbiline" import "github.com/Rosettea/Hilbiline"

View File

@ -1,10 +0,0 @@
package util
import "github.com/yuin/gopher-lua"
func Document(L *lua.LState, module lua.LValue, doc string) {
mt := L.NewTable()
L.SetField(mt, "__doc", lua.LString(doc))
L.SetMetatable(module, mt)
}

View File

@ -13,7 +13,6 @@ var (
.. hilbish.xdg.config .. '/hilbish/?/init.lua' .. hilbish.xdg.config .. '/hilbish/?/init.lua'
.. hilbish.xdg.config .. '/hilbish/?/?.lua' .. hilbish.xdg.config .. '/hilbish/?/?.lua'
.. hilbish.xdg.config .. '/hilbish/?.lua'` .. hilbish.xdg.config .. '/hilbish/?.lua'`
dataDir = "/usr/share/hilbish" preloadPath = "/usr/share/hilbish/preload.lua"
preloadPath = dataDir + "/preload.lua" sampleConfPath = "/usr/share/hilbish/.hilbishrc.lua" // Path to default/sample config
sampleConfPath = dataDir + "/.hilbishrc.lua" // Path to default/sample config
) )

View File

@ -7,7 +7,6 @@ var (
requirePaths = `';./libs/?/init.lua;./?/init.lua;./?/?.lua' requirePaths = `';./libs/?/init.lua;./?/init.lua;./?/?.lua'
.. hilbish.home .. '\\Appdata\\Roaming\\Hilbish\\libs\\?\\init.lua;' .. hilbish.home .. '\\Appdata\\Roaming\\Hilbish\\libs\\?\\init.lua;'
.. hilbish.home .. '\\Appdata\\Roaming\\Hilbish\\libs\\?\\?.lua;'` .. hilbish.home .. '\\Appdata\\Roaming\\Hilbish\\libs\\?\\?.lua;'`
dataDir = "~\\Appdata\\Roaming\\Hilbish" // ~ and \ gonna cry? preloadPath = "~\\Appdata\\Roaming\\Hilbish\\preload.lua" // ~ and \ gonna cry?
preloadPath = dataDir + "\\preload.lua" sampleConfPath = "~\\Appdata\\Roaming\\Hilbish\\hilbishrc.lua" // Path to default/sample config
sampleConfPath = dataDir + "\\hilbishrc.lua" // Path to default/sample config
) )