Bruce/btui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added Lua bindings, some documentation, and moved things around a bit.

Browse Source
This commit is contained in:
Bruce Hill 2020-04-18 21:18:23 -07:00
parent d86a21678a
commit ea19304c4f
10 changed files with 328 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
C/Makefile Normal file
View File

@ -0,0 +1,21 @@
PREFIX=
CC ?= gcc
O ?= -O2
CFLAGS=-std=c99 -D_XOPEN_SOURCE=500 -D_GNU_SOURCE -D_POSIX_C_SOURCE=200809L
CWARN=-Wall -Wpedantic -Wextra -Wno-unknown-pragmas -Wno-missing-field-initializers\
-Wno-padded -Wsign-conversion -Wno-missing-noreturn -Wno-cast-qual -Wtype-limits
#CFLAGS += -fsanitize=address -fno-omit-frame-pointer
G=
all:
clean:
rm -f test
ctest: test.c ../btui.h
$(CC) $(CFLAGS) $(CWARN) $(G) $(O) $< -o $@
test: ctest
./ctest
.PHONY: all, clean, test

1
C/btui.h Symbolic link
View File

@ -0,0 +1 @@
../btui.h

10
test.c → C/test.c
View File

@ -13,7 +13,9 @@ int main(void)
btui_printf(bt, "Update %d, size = %dx%d", i++, bt->width, bt->height);
btui_flush(bt);
int key = btui_getkey(bt, NULL, NULL);
int mouse_x = -1, mouse_y = -1;
int key = btui_getkey(bt, &mouse_x, &mouse_y);
btui_clear(bt);
switch (key) {
case 'q': case KEY_CTRL_C: done = 1; break;
case -1: break;
@ -24,9 +26,13 @@ int main(void)
btui_scroll(bt, 1, bt->height-1, -1);
break;
default: {
if (mouse_x != -1) {
x = mouse_x;
y = mouse_y;
}
char buf[256] = {0};
btui_keyname(key, buf);
btui_move_cursor(bt, x, y++);
btui_move_cursor(bt, x, y);
//btui_set_attributes(bt, BTUI_FG_YELLOW | BTUI_BOLD);
btui_set_fg_hex(bt, 0xacff40);
btui_printf(bt, "Pressed: %s", buf);

23
Makefile
View File

@ -7,12 +7,29 @@ CWARN=-Wall -Wpedantic -Wextra -Wno-unknown-pragmas -Wno-missing-field-initializ
#CFLAGS += -fsanitize=address -fno-omit-frame-pointer
G=
all: test
all: checksyntax
checksyntax: btui.h
$(CC) $(CFLAGS) $(CWARN) $(G) $(O) -fsyntax-only $<
clean:
rm -f test
@cd lua; make clean
@cd C; make clean
@cd python; make clean
%: %.c btui.h
$(CC) $(CFLAGS) $(CWARN) $(G) $(O) $< -o $@
.PHONY: all, clean
c:
@cd C; make
testc:
@cd C; make test
lua:
@cd lua; make
testlua:
@cd lua; make test
.PHONY: all, checksyntax, clean, c, testc, lua, testlua

59
README.md
View File

@ -3,3 +3,62 @@
BTUI is a minimal, embeddable single header file alternative to bloatware like
ncurses. BTUI aims to be under 1/1,000th the size of ncurses, while also
providing a more usable and modern API.
## Language Bindings
BTUI comes with bindings for C and Lua, with plans to add Python bindings.
### C API
BTUI has the following C function definitions, as well as definitions for some
constants, including terminal escape values and keycodes.
btui_t* btui_enable(void);
void btui_disable(btui_t *bt);
int btui_getkey(btui_t *bt, int *mouse_x, int *mouse_y);
int btui_move_cursor(btui_t *bt, int x, int y);
char *btui_keyname(int key, char *buf);
int btui_keynamed(const char *name);
int btui_set_attributes(btui_t *bt, unsigned long attrs);
int btui_set_fg_rgb(btui_t *bt, unsigned char r, unsigned char g, unsigned char b);
int btui_set_bg_rgb(btui_t *bt, unsigned char r, unsigned char g, unsigned char b);
int btui_set_fg_hex(btui_t *bt, int hex);
int btui_set_bg_hex(btui_t *bt, int hex);
#define btui_printf(bt, ...) fprintf((bt)->out, __VA_ARGS__)
#define btui_puts(bt, s) fputs(s, (bt)->out)
#define btui_flush(bt) fflush((bt)->out)
#define btui_clear(bt) fputs("\033[2J", (bt)->out)
#define btui_clear_below(bt) fputs("\033[J", (bt)->out)
#define btui_clear_above(bt) fputs("\033[1J", (bt)->out)
#define btui_clear_eol(bt) fputs("\033[K", (bt)->out)
#define btui_clear_line(bt) fputs("\033[2K", (bt)->out)
### Lua API
The Lua library returns a function that takes one argument: a function that will
be called with a `BTUI` object, which can be used to do TUI actions. Errors will
be propagated out of the function, but the terminal will be cleaned up nicely
before the error is printed. Here's a simple example program:
local btui = require("btui")
btui(function(bt)
local key = nil
local x, y = 0, 0
while key ~= "q" and key ~= "Ctrl-c" do
bt:clear()
bt:move(x, y)
bt:print("Pressed: ", key)
if key == "e" then error("ERR MESSAGE") end
local s = ("Size: (%dx%d)"):format(bt:width(), bt:height())
bt:move(bt:width()-#s, bt:height()-1)
bt:print(s)
local mouse_x, mouse_y
key, mouse_x, mouse_y = bt:getkey()
if mouse_x then x, y = mouse_x, mouse_y end
end
if key == "Ctrl-c" then
error("Interrupt received!")
end
end)

11
btui.h
View File

@ -24,8 +24,6 @@ typedef struct {
int size_changed;
} btui_t;
static btui_t current_bt;
btui_t* btui_enable(void);
void btui_disable(btui_t *bt);
int btui_getkey(btui_t *bt, int *mouse_x, int *mouse_y);
@ -38,6 +36,7 @@ int btui_set_bg_rgb(btui_t *bt, unsigned char r, unsigned char g, unsigned char
int btui_set_fg_hex(btui_t *bt, int hex);
int btui_set_bg_hex(btui_t *bt, int hex);
#define btui_printf(bt, ...) fprintf((bt)->out, __VA_ARGS__)
#define btui_puts(bt, s) fputs(s, (bt)->out)
#define btui_flush(bt) fflush((bt)->out)
#define btui_clear(bt) fputs("\033[2J", (bt)->out)
#define btui_clear_below(bt) fputs("\033[J", (bt)->out)
@ -45,6 +44,8 @@ int btui_set_bg_hex(btui_t *bt, int hex);
#define btui_clear_eol(bt) fputs("\033[K", (bt)->out)
#define btui_clear_line(bt) fputs("\033[2K", (bt)->out)
static btui_t current_bt;
// Terminal escape sequences:
#define T_WRAP "7"
#define T_SHOW_CURSOR "25"
@ -129,9 +130,9 @@ static keyname_t key_names[] = {
{KEY_ARROW_UP, "Up"}, {KEY_ARROW_DOWN, "Down"}, {KEY_ARROW_LEFT, "Left"}, {KEY_ARROW_RIGHT, "Right"},
{MOUSE_LEFT_PRESS, "Left press"}, {MOUSE_RIGHT_PRESS, "Right press"}, {MOUSE_MIDDLE_PRESS, "Middle press"},
{MOUSE_LEFT_DRAG, "Left drag"}, {MOUSE_RIGHT_DRAG, "Right drag"}, {MOUSE_MIDDLE_DRAG, "Middle drag"},
{MOUSE_LEFT_RELEASE, "Left click"}, {MOUSE_RIGHT_RELEASE, "Right click"}, {MOUSE_MIDDLE_RELEASE, "Middle click"},
{MOUSE_LEFT_RELEASE, "Left up"}, {MOUSE_RIGHT_RELEASE, "Right up"}, {MOUSE_MIDDLE_RELEASE, "Middle up"},
{MOUSE_LEFT_RELEASE, "Left release"}, {MOUSE_RIGHT_RELEASE, "Right release"}, {MOUSE_MIDDLE_RELEASE, "Middle release"},
{MOUSE_LEFT_RELEASE, "Left up"}, {MOUSE_RIGHT_RELEASE, "Right up"}, {MOUSE_MIDDLE_RELEASE, "Middle up"},
{MOUSE_LEFT_RELEASE, "Left click"}, {MOUSE_RIGHT_RELEASE, "Right click"}, {MOUSE_MIDDLE_RELEASE, "Middle click"},
{MOUSE_LEFT_DOUBLE, "Double left click"}, {MOUSE_RIGHT_DOUBLE, "Double right click"}, {MOUSE_MIDDLE_DOUBLE, "Double middle click"},
{MOUSE_WHEEL_RELEASE, "Mouse wheel up"}, {MOUSE_WHEEL_PRESS, "Mouse wheel down"},
{KEY_TAB, "Tab"}, {KEY_ENTER, "Enter"}, {KEY_ENTER, "Return"},
@ -386,7 +387,7 @@ static const struct termios normal_termios = {
.c_cc[VTIME] = 0,
};
const struct termios tui_termios = {
static const struct termios tui_termios = {
.c_iflag = 0,
.c_oflag = ONLCR | NL0 | CR0 | TAB0 | BS0 | VT0 | FF0,
.c_lflag = ECHOE | ECHOK | ECHOCTL | ECHOKE,

30
lua/Makefile Normal file
View File

@ -0,0 +1,30 @@
PREFIX=
CC ?= gcc
O ?= -O2
CFLAGS=-std=c99 -D_XOPEN_SOURCE=500 -D_GNU_SOURCE -D_POSIX_C_SOURCE=200809L
CWARN=-Wall -Wpedantic -Wextra -Wno-unknown-pragmas -Wno-missing-field-initializers\
-Wno-padded -Wsign-conversion -Wno-missing-noreturn -Wno-cast-qual -Wtype-limits
#CFLAGS += -fsanitize=address -fno-omit-frame-pointer
G=
LUA_DIR=/usr/local
LUA_INC=$(LUA_DIR)/include
LUA_BIN=$(LUA_DIR)/bin
LUA= lua
#LUA_SHARED_FLAGS=-bundle -undefined dynamic_lookup
LUA_SHARED_FLAGS=-shared -fPIC
all: btui.so
clean:
rm -f lbtui.o btui.so
test: btui.so test.lua
$(LUA) test.lua
btui.so: lbtui.o ../btui.h
$(CC) $(CFLAGS) $(CWARN) $(G) $(O) $(LUA_SHARED_FLAGS) -I$(LUA_INC) -o $@ $<
lbtui.o: lbtui.c
$(CC) $(CFLAGS) $(CWARN) $(G) $(O) -fPIC -c -o $@ $<
.PHONY: all, clean, testlua, test

1
lua/btui.h Symbolic link
View File

@ -0,0 +1 @@
../btui.h

160
lua/lbtui.c Normal file
View File

@ -0,0 +1,160 @@
/*
* lbtui.c
* A Lua library binding for btui, Bruce's Text User Interface library.
*/
#include "lua.h"
#include "lauxlib.h"
#include "btui.h"
// The C API changed from 5.1 to 5.2, so these shims help the code compile on >=5.2
#if LUA_VERSION_NUM >= 502
#define lua_objlen(L, i) lua_rawlen(L, i)
#define luaL_register(L, _, R) luaL_setfuncs(L, R, 0)
#endif
// Lua 5.3 introduced lua_isinteger, fall back to lua_isnumber
#if LUA_VERSION_NUM < 503
#define lua_isinteger(L, i) lua_isnumber(L, i)
#endif
const int BTUI_METATABLE;
static int Lbtui_enable(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
*bt = btui_enable();
btui_move_cursor(*bt, 0, 0);
btui_flush(*bt);
return 0;
}
static int Lbtui_disable(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
if (*bt == NULL) luaL_error(L, "BTUI object not initialized");
btui_disable(*bt);
return 0;
}
static int Lbtui_getkey(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
if (*bt == NULL) luaL_error(L, "BTUI object not initialized");
int mouse_x = -1, mouse_y = -1;
int key = btui_getkey(*bt, &mouse_x, &mouse_y);
if (key == -1) return 0;
char buf[256] = {0};
btui_keyname(key, buf);
lua_pushstring(L, buf);
if (mouse_x != -1 || mouse_y != -1) {
lua_pushinteger(L, mouse_x);
lua_pushinteger(L, mouse_y);
return 3;
}
return 1;
}
static int Lbtui_print(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
int n = lua_gettop(L);
for (int i = 2; i <= n; i++) {
btui_puts(*bt, luaL_tolstring(L, i, NULL));
lua_pop(L, 1);
}
btui_flush(*bt);
return 0;
}
static int Lbtui_clear(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
btui_clear(*bt);
btui_flush(*bt);
return 0;
}
static int Lbtui_move(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
if (lua_gettop(L) < 3) luaL_error(L, "Expected x and y values");
int isnum;
int x = lua_tointegerx(L, 2, &isnum);
if (!isnum) luaL_error(L, "Expected integer x value");
int y = lua_tointegerx(L, 3, &isnum);
if (!isnum) luaL_error(L, "Expected integer y value");
btui_move_cursor(*bt, x, y);
btui_flush(*bt);
return 0;
}
static int Lbtui_width(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
lua_pushinteger(L, (*bt)->width);
return 1;
}
static int Lbtui_height(lua_State *L)
{
btui_t **bt = (btui_t**)lua_touserdata(L, 1);
if (bt == NULL) luaL_error(L, "Not a BTUI object");
lua_pushinteger(L, (*bt)->height);
return 1;
}
static int Lbtui_wrap(lua_State *L)
{
if (lua_gettop(L) < 1) luaL_error(L, "expected a callable object");
btui_t **bt = (btui_t**)lua_newuserdata(L, sizeof(btui_t*));
lua_pushlightuserdata(L, (void*)&BTUI_METATABLE);
lua_gettable(L, LUA_REGISTRYINDEX);
lua_setmetatable(L, -2);
*bt = btui_enable();
btui_move_cursor(*bt, 0, 0);
int status = lua_pcall(L, 1, 0, 0);
btui_disable(*bt);
if (status != LUA_OK)
lua_error(L);
return 0;
}
static int Lbtui_tostring(lua_State *L)
{
lua_pushliteral(L, "<BTUI>");
return 1;
}
static const luaL_Reg Rclass_metamethods[] =
{
{ "__tostring", Lbtui_tostring},
{ "enable", Lbtui_enable},
{ "disable", Lbtui_disable},
{ "getkey", Lbtui_getkey},
{ "print", Lbtui_print},
{ "clear", Lbtui_clear},
{ "move", Lbtui_move},
{ "width", Lbtui_width},
{ "height", Lbtui_height},
{ NULL, NULL}
};
LUALIB_API int luaopen_btui(lua_State *L)
{
lua_pushlightuserdata(L, (void*)&BTUI_METATABLE);
lua_createtable(L, 0, 16);
luaL_register(L, NULL, Rclass_metamethods);
lua_pushvalue(L, -1);
lua_setfield(L, -2, "__index");
lua_settable(L, LUA_REGISTRYINDEX);
lua_pushcfunction(L, Lbtui_wrap);
return 1;
}

22
lua/test.lua Normal file
View File

@ -0,0 +1,22 @@
local btui = require("btui")
btui(function(bt)
local key = nil
local x, y = 0, 0
while key ~= "q" and key ~= "Ctrl-c" do
bt:clear()
bt:move(x, y)
bt:print("Pressed: ", key)
if key == "e" then error("ERR MESSAGE") end
local s = ("Size: (%dx%d)"):format(bt:width(), bt:height())
bt:move(bt:width()-#s, bt:height()-1)
bt:print(s)
local mouse_x, mouse_y
key, mouse_x, mouse_y = bt:getkey()
if mouse_x then x, y = mouse_x, mouse_y end
end
if key == "Ctrl-c" then
error("Interrupt received!")
end
end)