X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=e768f545d8877e045e4a567caeb08bc63208b31e;hb=181e40411dc49b42aba7619992394fa0b595a47e;hp=a40835d9c591925b3d080b8747495c9b21a5c3ed;hpb=0399a31b31047ab82348f733d6c56524258d1188;p=plomrogue diff --git a/src/windows.h b/src/windows.h index a40835d..e768f54 100644 --- a/src/windows.h +++ b/src/windows.h @@ -37,37 +37,30 @@ #include /* for uint8_t, uint16_t, uint32_t */ -#include /* for the WINDOW typedef */ -#include "yx_uint16.h" /* for yx_uint16 coordinates */ +#include /* for the WINDOW and chtype typedefs */ +#include "yx_uint16.h" /* for yx_uint16 struct */ -/* Individual windows consist of potential (real only if window is visible - * inside the virtual screen) ncurses WINDOWs wrapped inside Frame structs (that - * keep a window's designated size even when it is invisible) wrapped inside - * metadata-rich Win structs. Win structs are chained into a linked list of all - * the windows visible on the virtual screen and also contain pointers to what - * content is to be drawn inside the window, and by use of what method. +/* Individual windows are represented by "Win" structs. They describe frames + * located inside the virtual screen pad through which "winmaps" are visible, + * 2-dimensional maps of ncurses chtypes. Win structs are chained into a linked + * list of all the windows visible on the virtual screen and also contain + * pointers to what content is to be drawn inside the window, and by use of what + * method. */ - -struct Frame /* If Frame is Win's "frame", "size" is the */ -{ /* designated size of curses_win's ncurses WINDOW. */ - WINDOW * curses_win; /* If Frame is WinMeta's "padframe", curses_win is */ - struct yx_uint16 size; /* the ncurses pad representing the virtual screen */ -}; /* and "size" desribes the terminal screen size. */ - struct Win { - /* members supposed to be used ONLY INTERNALLY */ - struct Win * _prev; /* chain pointers; if 0, they mark the start or end */ - struct Win * _next; /* of the chain; if both are 0, Win is outside chain */ - struct yx_uint16 _start; /* upper left corner of "frame" WINDOW */ - char * _title; /* title to be used in window title bar */ - void (* _draw) (struct Win *); /* how to draw window content ("data") */ - - /* members to be available EXTERNALLY */ - struct Frame frame; - void * data; /* window content to be drawn by _draw() */ + struct Win * prev; /* chain pointers; if 0, they mark the start or end */ + struct Win * next; /* of the chain; if both are 0, Win is outside chain */ + struct yx_uint16 framesize; /* window frame size to see winmap through */ + struct yx_uint16 start; /* upper left corner of window in pad */ + struct yx_uint16 center; /* window content center to focus window on */ + char * title; /* title to be used in window title bar */ + void (* draw) (struct Win *); /* how to draw window content ("data") */ + void * data; /* window content to be drawn by _draw() */ + chtype * winmap; /* sequence of cells, sorted into lines ... */ + struct yx_uint16 winmapsize; /* ... with these geometry infos */ }; @@ -77,15 +70,13 @@ struct Win */ struct WinMeta { - /* members supposed to be used ONLY INTERNALLY */ - WINDOW * _screen; /* ncurses' pointer to the terminal screen */ - struct Win * _chain_start; /* first Win in chain; its _prev == 0 */ - struct Win * _chain_end; /* last Win in chain; its _next == 0 */ - - /* members to be available EXTERNALLY */ - 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 */ + WINDOW * screen; /* ncurses' pointer to the terminal screen */ + WINDOW * pad; /* ncurses pad of virtual screen */ + uint16_t pad_offset; /* number of cells view is moved to the right */ + struct yx_uint16 padsize; /* virtual screen size */ + struct Win * chain_start; /* first Win in chain; its _prev == 0 */ + struct Win * chain_end; /* last Win in chain; its _next == 0 */ + struct Win * active; /* Win highlighted/selected for manipulation */ }; @@ -93,9 +84,9 @@ struct WinMeta /* Initialize empty WinMeta "wmeta" on the terminal "screen". (Note that * emptiness is marked by WinMeta.chain_start=0.) Other struct members are also * initialized 0, except for the virtual screen (height = that of the terminal - * screen; width = 1) amd its frame sized to the size of the terminal screen. + * screen; width = 1) sized to the size of the terminal screen. */ -extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta); +extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta ** wmeta); @@ -104,12 +95,13 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta); * the window is visible. * * Pass 0 for "width" to make the window as wide as the terminal screen. Pass - * negative values for "width" to make the size so many cells smaller than the - * terminal screen. Pass 0 for "height" to give the window the maximum allowed - * height: one cell smaller than the terminal screen. Pass negative values to - * make the window so many smalls smaller than the terminal screen. The maximum - * allowed height is also applied for positive values that exceed it or negative - * values that would reduce the window height < 1 cell. + * negative values for "width" to make the width so many cells smaller than that + * of the terminal screen. Pass 0 for "height" to give the window the maximum + * allowed height: one cell smaller than that of the terminal screen. Pass + * negative values to make the window width so many cells smaller than that of + * the terminal screen. The maximum allowed height is also applied for positive + * values that exceed it or negative values that would reduce the window height + * < 1 cell. * * Other members of the Win struct are initialized to 0. */ @@ -119,7 +111,8 @@ extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title, -/* Free allocated memory for an initialized Win struct. */ +/* Free allocated memory for an initialized Win / WinMeta structs. */ +extern void free_winmeta(struct WinMeta * wmeta); extern void free_win(struct Win * win); @@ -169,22 +162,11 @@ extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir); -/* 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. - */ -extern uint8_t draw_all_wins(struct WinMeta * wmeta); - - - -/* Draw scroll hint (a line stating that there is more to see on scrolling - * further into a certain direction) into "frame" at position "pos" (describing - * 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. +/* Draw virtual screen including all windows. Also add scroll hints for where + * the edges of the terminal screen hit non-edges of and inside the virtual + * screen. Then update the terminal screen. */ -extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos, - uint32_t dist, char dir); +extern uint8_t draw_all_wins(struct WinMeta * wm);