*
* Windows can be almost any width (number has to fit into 16 bits); 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.
+ * 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)
* Functions that return uint8_t return these error codes:
* 0 - success
* 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
- * 2 - activity forces virtual screen to grow beyond width of 2^16 cells
+ * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
+ *
+ * TODO: Expose less internals to the API.
*
* TODO: Think up a more intuitive window positioning algorithm or at least make
* the chain that windows are positioned by visible.
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,*/
+ struct yx_uint16 size; /* the ncurses pad representing the virtual screen */
}; /* and "size" desribes the terminal screen size. */
-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
{
/* 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 WINDOW in "frame" */
+ 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") */
-/* 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
{
/* members supposed to be used ONLY INTERNALLY */
- WINDOW * _screen; /* terminal screen */
- struct Win * _chain_start; /* if first Win, ._prev to point to 0 */
- struct Win * _chain_end; /* if last Win, ._next to point to 0 */
+ 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 */
-/* 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.
+/* 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.
*/
extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
-/* Create a window below inside "wmeta" titled "title" of "height" and "width"
+/* Create a window as child of "wmeta" titled "title" of "height" and "width"
* and appointing "func"() to interpret and draw the content stored at "data"
* if the window is visible.
*
- * 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).
+ * Pass 0 for "width" to make the window as wide as the terminal screen. Pass
+ * for "height" 0 or a value larger than the maximum window height possible
+ * within the virtual screen to attain that maximum window height.
*
- * Other values of the Win struct will be initialized to 0. The window will stay
+ * Other members of the Win struct are 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,
-/* 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.
/* 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 uint8_t resize_active_win(struct WinMeta * wmeta, 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.
+/* 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 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.
+/* 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 uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
projects / plomrogue / blobdiff