diff --git a/Lua/lbtui.c b/Lua/lbtui.c index ffedd34..46dcd67 100644 --- a/Lua/lbtui.c +++ b/Lua/lbtui.c @@ -156,6 +156,33 @@ static int Lbtui_move(lua_State *L) return 0; } +static int Lbtui_setcursor(lua_State *L) +{ + btui_t **bt = (btui_t**)lua_touserdata(L, 1); + if (bt == NULL) luaL_error(L, "Not a BTUI object"); + const char *cursortype = luaL_optlstring(L, 2, "default", NULL); + if (strcmp(cursortype, "default") == 0) { + btui_set_cursor(*bt, CURSOR_DEFAULT); + } else if (strcmp(cursortype, "blinking block") == 0) { + btui_set_cursor(*bt, CURSOR_BLINKING_BLOCK); + } else if (strcmp(cursortype, "block") == 0) { + btui_set_cursor(*bt, CURSOR_STEADY_BLOCK); + } else if (strcmp(cursortype, "blinking underline") == 0) { + btui_set_cursor(*bt, CURSOR_BLINKING_UNDERLINE); + } else if (strcmp(cursortype, "underline") == 0) { + btui_set_cursor(*bt, CURSOR_STEADY_UNDERLINE); + } else if (strcmp(cursortype, "blinking bar") == 0) { + btui_set_cursor(*bt, CURSOR_BLINKING_BAR); + } else if (strcmp(cursortype, "bar") == 0) { + btui_set_cursor(*bt, CURSOR_STEADY_BAR); + } else { + lua_pushliteral(L, "unknown cursor type"); + lua_error(L); + } + btui_flush(*bt); + return 0; +} + static int Lbtui_withfg(lua_State *L) { btui_t **bt = (btui_t**)lua_touserdata(L, 1); @@ -467,6 +494,7 @@ static const luaL_Reg Rclass_metamethods[] = {"move", Lbtui_move}, {"scroll", Lbtui_scroll}, {"setattributes", Lbtui_setattributes}, + {"setcursor", Lbtui_setcursor}, {"shadow", Lbtui_shadow}, {"showcursor", Lbtui_showcursor}, {"suspend", Lbtui_suspend}, diff --git a/Python/btui.py b/Python/btui.py index e0dad7b..776c1d7 100644 --- a/Python/btui.py +++ b/Python/btui.py @@ -180,6 +180,15 @@ class BTUI: libbtui.btui_move_cursor(self._btui, int(x), int(y)) libbtui.btui_flush(self._btui) + def set_cursor(self, cursor_type="default"): + assert self._btui + if cursor_type in ('default', 'blinking block', 'blinking underline', 'blinking bar'): + c = ctypes.c_uint.in_dll(libbtui, 'CURSOR_' + cursor_type.replace(' ', '_').upper()) + elif cursor_type in ('block', 'underline', 'bar'): + c = ctypes.c_uint.in_dll(libbtui, 'CURSOR_STEADY_' + cursor_type.upper()) + libbtui.btui_set_cursor(self._btui, c) + libbtui.btui_flush(self._btui) + def hide_cursor(self): assert self._btui libbtui.btui_hide_cursor(self._btui) diff --git a/README.md b/README.md index 001b6c0..d58a3ff 100644 --- a/README.md +++ b/README.md @@ -87,28 +87,31 @@ BTUI comes with bindings for C, Python, and Lua. BTUI has the following C function definitions, as well as definitions for some constants, including terminal escape values and keycodes. - int btui_clear(btui_t *bt, int mode); - void btui_disable(btui_t *bt); - void btui_draw_linebox(btui_t *bt, int x, int y, int w, int h); - void btui_draw_shadow(btui_t *bt, int x, int y, int w, int h); - btui_t* btui_enable(void); - void btui_fill_box(btui_t *bt, int x, int y, int w, int h); - int btui_flush(btui_t *bt); - int btui_getkey(btui_t *bt, int timeout, int *mouse_x, int *mouse_y); - int btui_hide_cursor(btui_t *bt); - char *btui_keyname(int key, char *buf); - int btui_keynamed(const char *name); - int btui_move_cursor(btui_t *bt, int x, int y); - #define btui_printf(bt, ...) fprintf((bt)->out, __VA_ARGS__) - int btui_puts(btui_t *bt, const char *s); - int btui_scroll(btui_t *bt, int firstline, int lastline, int scroll_amount); - int btui_set_attributes(btui_t *bt, attr_t attrs); - int btui_set_bg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); - int btui_set_bg_hex(btui_t *bt, int hex); - int btui_set_fg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); - int btui_set_fg_hex(btui_t *bt, int hex); - int btui_show_cursor(btui_t *bt); - int btui_suspend(btui_t *bt); +```c +int btui_clear(btui_t *bt, int mode); +void btui_disable(btui_t *bt); +void btui_draw_linebox(btui_t *bt, int x, int y, int w, int h); +void btui_draw_shadow(btui_t *bt, int x, int y, int w, int h); +btui_t* btui_enable(void); +void btui_fill_box(btui_t *bt, int x, int y, int w, int h); +int btui_flush(btui_t *bt); +int btui_getkey(btui_t *bt, int timeout, int *mouse_x, int *mouse_y); +int btui_hide_cursor(btui_t *bt); +char *btui_keyname(int key, char *buf); +int btui_keynamed(const char *name); +int btui_move_cursor(btui_t *bt, int x, int y); +#define btui_printf(bt, ...) fprintf((bt)->out, __VA_ARGS__) +int btui_puts(btui_t *bt, const char *s); +int btui_scroll(btui_t *bt, int firstline, int lastline, int scroll_amount); +int btui_set_attributes(btui_t *bt, attr_t attrs); +int btui_set_bg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); +int btui_set_bg_hex(btui_t *bt, int hex); +int btui_set_cursor(btui_t *bt, cursor_t cur); +int btui_set_fg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); +int btui_set_fg_hex(btui_t *bt, int hex); +int btui_show_cursor(btui_t *bt); +int btui_suspend(btui_t *bt); +``` See [C/test.c](C/test.c) and [C/rainbow.c](C/rainbow.c) for example usage. You can run `make testc` to run the C test demo and `make rainbow` to run the @@ -139,6 +142,7 @@ bt:linebox(x,y,w,h) -- Draw an outlined box around the given rectangle bt:move(x, y) -- Move the cursor to the given position. (0,0) is the top left corner. bt:scroll(firstline, lastline, amount) -- Scroll the given screen region by the given amount. bt:setattributes(attrs...) -- Set the given attributes +bt:setcursor(type) -- Set the cursor type bt:shadow(x,y,w,h) -- Draw a shaded shadow to the bottom right of the given rectangle bt:showcursor() -- Show the cursor bt:suspend() -- Suspend the current process and drop back into normal terminal mode @@ -194,6 +198,7 @@ class BTUI: def scroll(self, firstline, lastline=None, amount=None): def set_attributes(self, *attrs): def set_bg(self, r, g, b): # R,G,B values are [0.0, 1.0] + def set_cursor(self, cursor_type="default"): def set_fg(self, r, g, b): # R,G,B values are [0.0, 1.0] def show_cursor(self): def suspend(self): diff --git a/btui.h b/btui.h index 1dc33e7..f67cf8d 100644 --- a/btui.h +++ b/btui.h @@ -68,6 +68,15 @@ typedef enum { MOUSE_WHEEL_RELEASE, MOUSE_WHEEL_PRESS, } btui_key_t; +typedef int cursor_t; +const cursor_t CURSOR_DEFAULT = 0; +const cursor_t CURSOR_BLINKING_BLOCK = 1; +const cursor_t CURSOR_STEADY_BLOCK = 2; +const cursor_t CURSOR_BLINKING_UNDERLINE = 3; +const cursor_t CURSOR_STEADY_UNDERLINE = 4; +const cursor_t CURSOR_BLINKING_BAR = 5; +const cursor_t CURSOR_STEADY_BAR = 6; + // Overlapping key codes: #define KEY_CTRL_BACKTICK KEY_CTRL_AT #define KEY_CTRL_2 KEY_CTRL_AT @@ -185,6 +194,7 @@ int btui_scroll(btui_t *bt, int firstline, int lastline, int scroll_amount); int btui_set_attributes(btui_t *bt, attr_t attrs); int btui_set_bg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); int btui_set_bg_hex(btui_t *bt, int hex); +int btui_set_cursor(btui_t *bt, cursor_t cur); int btui_set_fg(btui_t *bt, unsigned char r, unsigned char g, unsigned char b); int btui_set_fg_hex(btui_t *bt, int hex); int btui_show_cursor(btui_t *bt); @@ -310,6 +320,7 @@ static void btui_cleanup(void) { if (!current_bt.out) return; tcsetattr(fileno(current_bt.out), TCSANOW, &normal_termios); + btui_set_cursor(¤t_bt, CURSOR_DEFAULT); fputs(BTUI_LEAVE, current_bt.out); fflush(current_bt.out); } @@ -759,6 +770,14 @@ int btui_set_bg_hex(btui_t *bt, int hex) (hex >> 16) & 0xFF, (hex >> 8) & 0xFF, hex & 0xFF); } +/* + * Set the cursor shape. + */ +int btui_set_cursor(btui_t *bt, cursor_t cur) +{ + return fprintf(bt->out, "\033[%d q", cur); +} + /* * Set the terminal text foreground color to the given RGB value. */