Implement programmable prompt (issue #09)

Replace static _PROMPT/_PROMPT2 with dynamic __prompt(exitcode)/__prompt2(exitcode)
functions. Fallback chain: __prompt() → _PROMPT → "> ". Install a default __prompt
that shows the current directory with ~ abbreviation. Track last exit code from the
REPL loop and pass it to the prompt function.
This commit is contained in:
Cormac Shannon
2026-03-03 23:19:09 +00:00
parent bbc0f24009
commit e8756d5d78
3 changed files with 179 additions and 5 deletions

View File

@@ -1,7 +1,6 @@
# 09 — Programmable prompt # 09 — Programmable prompt
**Status:** open **Status:** done
**Blocked by:** #08
Users should be able to customize the shell prompt by defining a Lua function, similar to how other shells use `PS1`/`PROMPT_COMMAND`/`precmd`. Users should be able to customize the shell prompt by defining a Lua function, similar to how other shells use `PS1`/`PROMPT_COMMAND`/`precmd`.

47
lua.c
View File

@@ -541,19 +541,38 @@ static void lua_initreadline (lua_State *L) {
#endif /* } */ #endif /* } */
static int last_exit_code = 0; /* tracks exit code for __prompt() */
/* /*
** Return the string to be used as a prompt by the interpreter. Leave ** Return the string to be used as a prompt by the interpreter. Leave
** the string (or nil, if using the default value) on the stack, to keep ** the string (or nil, if using the default value) on the stack, to keep
** it anchored. ** it anchored.
**
** Fallback chain: __prompt()/__prompt2() → _PROMPT/_PROMPT2 → "> "/">> "
*/ */
static const char *get_prompt (lua_State *L, int firstline) { static const char *get_prompt (lua_State *L, int firstline) {
if (lua_getglobal(L, firstline ? "_PROMPT" : "_PROMPT2") == LUA_TNIL) const char *fname = firstline ? "__prompt" : "__prompt2";
return (firstline ? LUA_PROMPT : LUA_PROMPT2); /* use the default */ if (lua_getglobal(L, fname) == LUA_TFUNCTION) {
else { /* apply 'tostring' over the value */ lua_pushinteger(L, last_exit_code);
if (lua_pcall(L, 1, 1, 0) == LUA_OK) {
const char *p = lua_tostring(L, -1);
if (p != NULL) return p; /* string stays on stack, anchored */
}
lua_pop(L, 1); /* pop error message or non-string result */
} else {
lua_pop(L, 1); /* pop the non-function value */
}
/* fallback: check _PROMPT/_PROMPT2 globals (standard Lua compat) */
if (lua_getglobal(L, firstline ? "_PROMPT" : "_PROMPT2") != LUA_TNIL) {
const char *p = luaL_tolstring(L, -1, NULL); const char *p = luaL_tolstring(L, -1, NULL);
lua_remove(L, -2); /* remove original value */ lua_remove(L, -2); /* remove original value */
return p; return p;
} }
lua_pop(L, 1); /* pop nil */
/* final fallback: push default string so pushline can pop it */
lua_pushstring(L, firstline ? LUA_PROMPT : LUA_PROMPT2);
return lua_tostring(L, -1);
} }
/* mark in error messages for incomplete statements */ /* mark in error messages for incomplete statements */
@@ -673,6 +692,26 @@ static int loadline (lua_State *L) {
} }
/*
** Install default __prompt function if not already defined (e.g. by config).
** Shows current directory with ~ substitution for HOME.
*/
static void install_default_prompt (lua_State *L) {
if (lua_getglobal(L, "__prompt") == LUA_TNIL) {
luaL_dostring(L,
"function __prompt(exitcode)\n"
" local cwd = os.getenv('PWD') or '?'\n"
" local home = os.getenv('HOME') or ''\n"
" if home ~= '' and cwd:sub(1, #home) == home then\n"
" cwd = '~' .. cwd:sub(#home + 1)\n"
" end\n"
" return cwd .. '> '\n"
"end\n");
}
lua_pop(L, 1); /* pop the getglobal result */
}
/* /*
** Prints (calling the Lua 'print' function) any values on the stack ** Prints (calling the Lua 'print' function) any values on the stack
*/ */
@@ -698,6 +737,7 @@ static void doREPL (lua_State *L) {
const char *oldprogname = progname; const char *oldprogname = progname;
progname = NULL; /* no 'progname' on errors in interactive mode */ progname = NULL; /* no 'progname' on errors in interactive mode */
lua_initreadline(L); lua_initreadline(L);
install_default_prompt(L);
setsignal(SIGINT, repl_sigint_handler); setsignal(SIGINT, repl_sigint_handler);
if (sigsetjmp(repl_jmp, 1)) { if (sigsetjmp(repl_jmp, 1)) {
/* Ctrl-C during input — print newline, clear stack, re-prompt */ /* Ctrl-C during input — print newline, clear stack, re-prompt */
@@ -708,6 +748,7 @@ static void doREPL (lua_State *L) {
while ((status = loadline(L)) != -1) { while ((status = loadline(L)) != -1) {
if (status == LUA_OK) if (status == LUA_OK)
status = docall(L, 0, LUA_MULTRET); status = docall(L, 0, LUA_MULTRET);
last_exit_code = status; /* track for __prompt() */
if (status == LUA_OK) l_print(L); if (status == LUA_OK) l_print(L);
else report(L, status); else report(L, status);
setsignal(SIGINT, repl_sigint_handler); /* re-install after docall */ setsignal(SIGINT, repl_sigint_handler); /* re-install after docall */

134
testes/lush/prompt.lua Normal file
View File

@@ -0,0 +1,134 @@
-- testes/lush/prompt.lua
-- Tests for programmable prompt (issue #09).
print "testing programmable prompt"
-- helper: get a unique temp directory
local tmpbase = os.tmpname()
os.remove(tmpbase) -- tmpname creates the file on some systems
local function mkdir(path)
os.execute('mkdir -p "' .. path .. '"')
end
local function writefile(path, content)
local f = assert(io.open(path, "w"))
f:write(content)
f:close()
end
local function rmrf(path)
os.execute('rm -rf "' .. path .. '"')
end
-- helper: run ./lua -i with config, use print() to reveal prompt state
local function run_lua(input, config_content)
local tmpdir = tmpbase .. "_run"
mkdir(tmpdir .. "/lush")
if config_content then
writefile(tmpdir .. "/lush/config", config_content)
end
local cmd = string.format(
'printf "%%s\\n" %s | XDG_CONFIG_HOME="%s" ./lua -i 2>&1',
input, tmpdir)
local f = io.popen(cmd)
local output = f:read("*a")
f:close()
rmrf(tmpdir)
return output
end
-- ===== TEST 1: Default __prompt is installed =====
-- After starting the REPL, __prompt should be a function
do
local out = run_lua('"print(type(__prompt))"')
assert(out:find("function"),
"default __prompt should be installed as function: " .. out)
end
-- ===== TEST 2: Default __prompt returns cwd =====
do
local cwd = os.getenv("PWD") or ""
local home = os.getenv("HOME") or ""
local expected
if home ~= "" and cwd:sub(1, #home) == home then
expected = "~" .. cwd:sub(#home + 1)
else
expected = cwd
end
local out = run_lua('"print(__prompt(0))"')
assert(out:find(expected, 1, true),
"default __prompt should return cwd: expected '" ..
expected .. "' in: " .. out)
end
-- ===== TEST 3: Custom __prompt() overrides default =====
do
local out = run_lua('"print(__prompt(0))"',
'function __prompt() return "custom> " end\n')
assert(out:find("custom> ", 1, true),
"custom __prompt should be used: " .. out)
end
-- ===== TEST 4: __prompt() receives exit code =====
do
local out = run_lua(
'"error()" "print(__prompt())" "os.exit()"',
'function __prompt(code)\n'
.. ' return "exit:" .. tostring(code) .. "> "\n'
.. 'end\n')
-- After error(), the next prompt call should receive non-zero code.
-- But since we're calling __prompt() manually via print, we test
-- the mechanism differently: call it with a code directly.
local out2 = run_lua('"print(__prompt(42))"',
'function __prompt(code)\n'
.. ' return "exit:" .. tostring(code) .. "> "\n'
.. 'end\n')
assert(out2:find("exit:42> ", 1, true),
"exit code should be passed to __prompt: " .. out2)
end
-- ===== TEST 5: __prompt2 for continuation =====
do
local out = run_lua('"print(type(__prompt2))"')
-- __prompt2 is not installed by default
assert(out:find("nil") or out:find("function"),
"__prompt2 should be nil or function: " .. out)
end
-- ===== TEST 6: Broken __prompt() falls back gracefully =====
do
local out = run_lua('"print(42)"',
'function __prompt() error("boom") end\n')
assert(out:find("42"),
"broken __prompt should still allow REPL to work: " .. out)
end
-- ===== TEST 7: _PROMPT still works (backward compat) =====
do
-- When __prompt is defined (default), it takes priority.
-- To test _PROMPT fallback, unset __prompt.
local out = run_lua('"print(42)"',
'__prompt = nil\n_PROMPT = "old> "\n')
assert(out:find("42"),
"_PROMPT fallback should still work: " .. out)
end
-- ===== TEST 8: Config-defined __prompt is not overwritten =====
do
local out = run_lua('"print(__prompt(0))"',
'function __prompt() return "from_config> " end\n')
assert(out:find("from_config> ", 1, true),
"config __prompt should not be overwritten: " .. out)
end
print "OK"