* (in a bizarre fashion, see below) 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.
+ * 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, which
+ * must also fit into 2^16 cells.
*
* Positioning of windows can only indirectly be influenced: by resizing them,
* and by shifting their relative position inside the (currently invisible)
*
* 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.
*/
#ifndef WINDOWS_H
#define WINDOWS_H
+#include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
+#include <ncurses.h> /* for the WINDOW and chtype typedefs */
+#include "yx_uint16.h" /* for yx_uint16 struct */
-#include <stdint.h> /* for uint16_t, uint32_t */
-#include <ncurses.h> /* 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.
+/* 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
-{
- 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; /* 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") */
+ 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 */
};
-/* Create on the terminal "screen" an empty WinMeta. 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.
+/* 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) sized to the size of the terminal screen.
*/
-extern struct WinMeta init_win_meta(WINDOW * screen);
+extern void init_win_meta(WINDOW * screen);
-/* 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.
+/* Initialize a window child of "wmeta" to "title", "height" and "width" and
+ * appointing "func"() to interpret and draw the window when it's 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().
+ * Pass 0 for "width" to make the window as wide as the terminal screen. Pass
+ * 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.
*
- * TODO: Why default start widths/heights instead of passing start values?
+ * Other members of the Win struct are initialized to 0.
*/
-extern struct Win init_win(struct WinMeta * wmeta, char * title,
- void * data, void * func);
+extern void init_win(struct Win ** wp, char * title, int16_t height,
+ int16_t width, void * func);
+/* Free allocated memory for an initialized Win / WinMeta structs. */
+extern void free_winmeta();
+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.
*/
-extern void append_win(struct WinMeta * wmeta, struct Win * w);
-extern void suspend_win(struct WinMeta * wmeta, struct Win * w);
-
-
+extern void append_win(struct Win * w);
+extern void suspend_win(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
* border due to it having shrunk after suspension of windows, only allow view
* movement leftwards.
*/
-extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
-
-
+extern void reset_pad_offset(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).
+ * the screen's vertical height (to provide space for the title bar). Does
+ * nothing if no window is active.
*/
-extern void resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
+extern void resize_active_win(struct yx_uint16 size);
-
-
-/* Cycle active window selection forwards (set dir="n") or backwards. Wrap
- * around in the windows chain if start / end of it is met.
- */
-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.
+/* 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 void 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").
+ * 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.
+/* 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 void draw_scroll_hint(struct Frame * frame, uint16_t pos, uint32_t dist,
- char dir);
+extern void draw_all_wins();