X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=8485321cfa47f6637c8a4b905395c53bf3f35562;hb=c3d87a1dee96775443fdf73c53e1350af7ca5fc2;hp=9414dd5cc541d5fb525094b40d85ba79447dc6c4;hpb=bed76e36029b889501cf45e6852830fbfa35ea11;p=plomrogue diff --git a/src/windows.h b/src/windows.h index 9414dd5..8485321 100644 --- a/src/windows.h +++ b/src/windows.h @@ -2,179 +2,130 @@ * * A tiled window manager for the terminal. * - * It provides a virtual screen that can be scrolled horizontally and may - * contain any number of windows that can be appeared, disappeared, resized and - * (somewhat) moved around. They have borders and a title bar and are positioned - * (in a bizarre fashion, see below) automatically. + * It provides a virtual screen that can be scrolled horizontally and may carry + * any number of windows to be appeared, disappeared, resized and moved around. + * They have borders and a title bar and are positioned automatically. * - * Windows can be almost any width (number has to fit into 16 bits); the virtual - * screen grows with them as needed -- but only horizontally. Their height is - * limited by the height of the terminal screen. + * Windows can be any width between 1 and 2^16 cells. The virtual screen grows + * with them as needed -- but only horizontally and only up to 2^16 cells. Their + * height is limited by the height of the terminal screen (maximum 2^16 cells). * - * Positioning of windows can only indirectly be influenced: by resizing them, - * and by shifting their relative position inside the (currently invisible) - * chain that the window manager treats their plurality as. The first window - * goes into the upper left corner of the virtual screen. Further visible - * windows are fitted left-aligned below their (chain-wise) closest predecessor - * that thrones over enough space to fit them in; failing that, they are placed - * to the right of the window with the rightmost border. + * Windows' positioning can be influenced only indirectly: by resizing them, and + * by shifting their relative position inside the (currently invisible) chain + * that the window manager treats their plurality as. The first window goes into + * the top left corner of the virtual screen. Further windows are fitted as + * left-aligned as possible below their (chain-wise) closest predecessor that + * thrones over enough space to contain them and that is open to the right. If + * that fails, they're fitted up-right to the window with the rightmost border. * - * TODO: Think up a more intuitive window positioning algorithm or at least make - * the chain that windows are positioned by visible. - * - * TODO: Ensure there are only windows as many / as big as fit into the maximum - * size of the virtual screen. + * TODO: Think up a more intuitive window positioning algorithm. */ #ifndef WINDOWS_H #define WINDOWS_H +#include /* for uint8_t, uint16_t, uint32_t */ +#include /* for the WINDOW and chtype typedefs */ +#include "yx_uint16.h" /* for yx_uint16 struct */ -#include /* for uint16_t, uint32_t */ -#include /* for the WINDOW typedef */ -#include "yx_uint16.h" /* for yx_uint16 coordinates */ - -/* Individual windows consist of potential (real if window is visible) 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. +/* "Win" structs describe windows as frames located inside the virtual screen + * pad through which "winmaps" are visible, 2-dimensional maps of ncurses + * chtypes. If a winmap is bigger than its frame, scrolling hints will appear at + * the proper edges. 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 -{ - WINDOW * 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 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 */ + 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; /* winmap cell to center frame on if smaller*/ + char * title; /* title to be used in window title bar */ + void (* draw) (struct Win *); /* function that draws/updates the winmap */ + chtype * winmap; /* sequence of cells, sorted into lines ... */ + struct yx_uint16 winmapsize; /* ... with these geometry infos */ }; - - -/* The window manager's parent struct WinMeta provides the virtual screen and a - * representation of the terminal screen. It also anchors start and end of the - * windows chain. +/* The window manager's parent struct WinMeta contains the virtual screen, + * relates it to the terminal screen and anchors the chain of visible windows. */ struct WinMeta { - WINDOW * screen; /* terminal screen */ + 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 Frame padframe; /* virtual screen fitted into terminal 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 */ + 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 */ }; -/* 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. - * - * Returns 0 on success, 1 on (ncurses newpad() memory allocation) error. +/* Initialize empty "wmeta" on terminal screen. All struct members initialize to + * 0, except for .screen, the newly created virtual screen .pad and its .padsize + * (height: that of the terminal screen; width: 1 cell). */ -extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta); +extern void init_win_meta(); - - -/* 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. +/* Initialize a Win child "wp" of "wmeta" to "title", "height" and "width" and + * appoint "func"() as its .draw. Initialize other members to 0. * - * 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). - * - * 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(). + * Pass 0 for "width" to make the window as wide as the terminal screen. Pass 0 + * for "height" for the maximum allowed height: one cell smaller than that of + * the terminal screen. Pass negative values for either of them to make the + * window width/height so many cells smaller than what 0 would set. The maximum + * allowed height is also applied for positive height values that exceed it or + * negative values that would reduce the window height to less than 1 cell. */ -extern struct Win init_win(struct WinMeta * wmeta, char * title, - uint16_t height, uint16_t widtht, - void * data, void * func); - +extern void init_win(struct Win ** wp, char * title, int16_t height, + int16_t width, void * func); +/* Free memory initialized Win/WinMeta structs; endwin() for the latter, too. */ +extern void free_winmeta_and_endwin(); +extern void free_win(struct Win * win); -/* Append/suspend window "w" to/from chain of visible windows in "wmeta". +/* Append/suspend window "w" to/from chain of visible windows below "wmeta". * 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 uint8_t append_win(struct WinMeta * wmeta, struct Win * w); -extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w); - - - -/* Apply scrolling offset "new_offset" to virtual screen if it is sane, i.e. - * it's equal/greater zero and does not push the view (further) beyond the - * virtual screen's border. If the view is already beyond the virtual screen's - * border due to it having shrunk after suspension of windows, only allow view - * movement leftwards. + * that, their predecessor, or, failing that, to 0 (no window active). */ -extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset); - - +extern void append_win(struct Win * w); +extern void suspend_win(struct Win * w); -/* 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. +/* Apply scrolling offset "new_offset" to virtual screen if it is equal/greater + * 0 and does not push the view (further) beyond the virtual screen's border. If + * the view is already beyond the virtual screen's border due to it having + * shrunk after suspension of windows, only allow screen scrolling leftwards. */ -extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size); - +extern void reset_pad_offset(uint16_t new_offset); - -/* Cycle active window selection forwards (set dir="n") or backwards. Wrap - * around in the windows chain if start / end of it is met. +/* Apply "size" to the active window if it provides a minimum size of 1x1 cells + * and is in height at least one cell smaller than the screen's vertical height + * (to provide space for the title bar). Does nothing if no window is active. */ -extern void cycle_active_win(struct WinMeta * wmeta, char dir); - +extern void resize_active_win(struct yx_uint16 size); - -/* 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. - * - * Return 0 on success, and 1 on (ncurses window/pad memory allocation) error. +/* Cycle active window selection forwards ("dir" == "f") or backwards (any + * other "dir"). Wrap around in the windows chain if start / end of it is met. + * Does nothing if no window is active. */ -extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir); - - +extern void cycle_active_win(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. +/* Move active window forwards ("dir" == "f") or backwards (any other "dir") in + * the window chain. Wrap around in the window chain if start / end of it is + * met. Does nothing if no window is active. */ -extern void draw_all_wins(struct WinMeta * wmeta); +extern void shift_active_win(char dir); - - -/* 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. - * - * Return 0 on success, and 1 on error (of scroll hint text memory allocation). +/* Draw virtual screen and its windows. Add scroll hints where edges of terminal + * screen hit non-edges inside the virtual screen. Then update terminal screen. */ -extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos, - uint32_t dist, char dir); +extern void draw_all_wins();