X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=ce6d7cbc6d0645f5bf59435ea5f9709973bea5e1;hb=f9274f0ef5edae9b1a2afcc0a4e739552d6d875a;hp=03d44b693e4fdb65e04c5a31a95bae1ab4fd2779;hpb=566ddf894142085e3f0208a08fa36ccce6d6a6ea;p=plomrogue diff --git a/src/windows.h b/src/windows.h index 03d44b6..ce6d7cb 100644 --- a/src/windows.h +++ b/src/windows.h @@ -31,7 +31,7 @@ -#include /* for uint16_t, uint32_t */ +#include /* for uint8_t, uint16_t, uint32_t */ #include /* for the WINDOW typedef */ #include "yx_uint16.h" /* for yx_uint16 coordinates */ @@ -47,18 +47,18 @@ struct Frame { WINDOW * curses_win; - struct yx_uint16 size; /* designated size of curses_win */ -}; + struct yx_uint16 size; /* the size curses_win fits into; for the virtual */ +}; /* screen padframe: the terminal screen size */ struct Win { - struct Win * prev; /* prev=next=0 if Win is outside the chain */ - struct Win * next; - struct yx_uint16 start; /* upper left corner (of WINDOW or border?) */ + struct Win * _prev; /* INTERNAL */ /* _prev == _next == 0 if */ + struct Win * _next; /* INTERNAL */ /* Win is outside the chain */ + struct yx_uint16 _start; /* INTERNAL: upper left corner of WINDOW */ + char * _title; /* INTERNAL: title for window title bar */ + void (* _draw) (struct Win *); /* INTERNAL: how to draw window content */ struct Frame frame; - char * title; /* title to be shown on window border top */ - void (* draw) (struct Win *); /* function to draw window content ("data") */ - void * data; /* content to be drawn; draw() knows how */ + void * data; /* window content to be drawn by _draw() */ }; @@ -69,37 +69,41 @@ struct Win */ struct WinMeta { - WINDOW * screen; /* terminal screen */ - uint16_t pad_offset; /* number of cells view is moved to the right */ - struct Frame pad; /* virtual screen */ - struct Win * chain_start; /* first Win, whose .prev shall point to 0 */ - struct Win * chain_end; /* last Win, whose .next shall point to 0 */ - struct Win * active; /* window highlighted/selected for manipulation */ + WINDOW * _screen; /* INTERNAL: terminal screen */ + struct Win * _chain_start; /* INTERNAL: first Win, ._prev to point to 0 */ + struct Win * _chain_end; /* INTERNAL: last Win, ._next to point to 0 */ + uint16_t pad_offset; /* number of cells view is moved to the right */ + struct Frame padframe; /* virtual screen fitted into terminal screen */ + struct Win * active; /* Win highlighted/selected for manipulation */ }; -/* Create on the terminal "screen" an empty WinMeta whose virtual screen at the - * beginning is sized just like the terminal screen. Note that emptiness is - * marked by WinMeta.chain_start=0. Other struct values are also initialized 0. +/* Initialize empty WinMeta "wmeta" on the terminal "screen". Note that + * emptiness is marked by WinMeta.chain_start=0. Other struct values are also + * initialized 0, except for the virtual screen (terminal screen height, width = + * 1) and its terminal-sized frame. * - * TODO: Why is an *empty* virtual screen's size that of the terminal screen? + * Returns 0 on success, 1 on (ncurses newpad() memory allocation) error. */ -extern struct WinMeta init_win_meta(WINDOW * screen); +extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta); -/* Create a window below inside "wmeta" titled "title" and appointing "func"() - * to interpret and draw the content stored at "data" if the window is visible. +/* Create a window below inside "wmeta" titled "title" of "height" and "width" + * and appointing "func"() to interpret and draw the content stored at "data" + * if the window is visible. * - * The start size for the Frame will be a width of 20 cells and a height one - * less than the height of the virtual screen (so as to fit the title bar on top - * of the window). Other values will be initialized to 0. The window will stay - * invisible until appended to the chain of visible windows via append_win(). + * A value for "width" <1 will trigger a fallback to width=1. A "height" <1 or + * larger than the maximum window height possible within the virtual screen will + * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0 + * to initialize the window to its largest possible height). * - * TODO: Why a default start width instead of passing a start width? + * Other values of the Win struct will be initialized to 0. The window will stay + * invisible until appended to the chain of visible windows via append_win(). */ extern struct Win init_win(struct WinMeta * wmeta, char * title, + uint16_t height, uint16_t width, void * data, void * func); @@ -108,9 +112,11 @@ extern struct Win init_win(struct WinMeta * wmeta, char * title, * Appended windows will become active. Suspended active windows will move the * active window selection to their successor in the window chain or, failing * that, their predecessor; if no window remains, none will be active. + * + * Return 0 on success, and 1 on (ncurses window/pad memory allocation) error. */ -extern void append_win(struct WinMeta * wmeta, struct Win * w); -extern void suspend_win(struct WinMeta * wmeta, struct Win * w); +extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w); +extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w); @@ -127,8 +133,10 @@ extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset); /* Apply new size "size" to the active window, but only if it provides for at * least one cell width/height and is in height at least one cell smaller than * the screen's vertical height (to provide space for the title bar). + * + * Returns 0 on success, 1 on (ncurses window/pad memory allocation) error. */ -extern void resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size); +extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size); @@ -141,17 +149,20 @@ extern void cycle_active_win(struct WinMeta * wmeta, char dir); /* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap * around in the window chain if start / end of it is met. + * + * Returns 0 on success, 1 on (ncurses window/pad memory allocation) error. */ -extern void shift_active_win(struct WinMeta * wmeta, char dir); +extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir); -/* Draw virtual screen including all windows. Also add scroll hints (a line - * stating that there is more to see on scrolling further into a certain - * direction) for where the edges of the terminal screen hit non-edges of and - * inside the virtual screen. Then update the terminal screen. +/* Draw virtual screen including all windows. Also add scroll hints (see comment + * on draw_scroll_hint()) for where the edges of the terminal screen hit + * non-edges of and inside the virtual screen. Then update the terminal screen. + * + * Returns 0 on success, 1 on error (of scroll hint text memory allocation). */ -extern void draw_all_wins(struct WinMeta * wmeta); +extern uint8_t draw_all_wins(struct WinMeta * wmeta); @@ -160,9 +171,11 @@ extern void draw_all_wins(struct WinMeta * wmeta); * a column or a row dependent on "dir" being *either* "<"/">" *or* something * else). It will consist of a line of "dir" symbols bracketing a descriptive * text stating the number of rows/columns further available beyond the hint. + * + * Return 0 on success, and 1 on error (of scroll hint text memory allocation). */ -extern void draw_scroll_hint(struct Frame * frame, uint16_t pos, uint32_t dist, - char dir); +extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos, + uint32_t dist, char dir);