plomlompom.com Git - plomrogue/blob - src/windows.h

   1 /* windows.h
   2  *
   3  * A tiled window manager for the terminal.
   4  *
   5  * It provides a virtual screen that can be scrolled horizontally and may
   6  * contain any number of windows that can be appeared, disappeared, resized and
   7  * (somewhat) moved around. They have borders and a title bar and are positioned
   8  * (in a bizarre fashion, see below) automatically.
   9  *
  10  * Windows can be almost any width (number has to fit into 16 bits); the virtual
  11  * screen grows with them as needed -- but only horizontally. Their height is
  12  * limited by the height of the terminal screen.
  13  *
  14  * Positioning of windows can only indirectly be influenced: by resizing them,
  15  * and by shifting their relative position inside the (currently invisible)
  16  * chain that the window manager treats their plurality as. The first window
  17  * goes into the upper left corner of the virtual screen. Further visible
  18  * windows are fitted left-aligned below their (chain-wise) closest predecessor
  19  * that thrones over enough space to fit them in; failing that, they are placed
  20  * to the right of the window with the rightmost border.
  21  *
  22  * Functions that return uint8_t return these error codes:
  23  * 0 - success
  24  * 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
  25  * 2 - activity makes virtual screen grow beyond uint16 height/width confines
  26  *
  27  * TODO: Think up a more intuitive window positioning algorithm or at least make
  28  * the chain that windows are positioned by visible.
  29  */
  30
  31 #ifndef WINDOWS_H
  32 #define WINDOWS_H
  33
  34
  35
  36 #include <stdint.h>    /* for uint8_t, uint16_t, uint32_t */
  37 #include <ncurses.h>   /* for the WINDOW typedef */
  38 #include "yx_uint16.h" /* for yx_uint16 coordinates */
  39
  40
  41 /* Individual windows consist of potential (real if window is visible) ncurses
  42  * WINDOWs wrapped inside Frame structs (that keep a window's designated size
  43  * even when it is invisible) wrapped inside metadata-rich Win structs. Win
  44  * structs are chained into a linked list of all the windows visible on the
  45  * virtual screen and also contain pointers to what content is to be drawn
  46  * inside the window, and by use of what method.
  47  */
  48
  49 struct Frame
  50 {
  51     WINDOW * curses_win;
  52     struct yx_uint16 size;  /* the size curses_win fits into; for the virtual */
  53 };                          /* screen padframe: the terminal screen size      */
  54
  55 struct Win
  56 {
  57     struct Win * _prev;            /* INTERNAL */ /* _prev == _next == 0 if   */
  58     struct Win * _next;            /* INTERNAL */ /* Win is outside the chain */
  59     struct yx_uint16 _start;       /* INTERNAL: upper left corner of WINDOW */
  60     char * _title;                 /* INTERNAL: title for window title bar */
  61     void (* _draw) (struct Win *); /* INTERNAL: how to draw window content */
  62     struct Frame frame;
  63     void * data;                   /* window content to be drawn by _draw() */
  64 };
  65
  66
  67
  68 /* The window manager's parent struct WinMeta provides the virtual screen and a
  69  * representation of the terminal screen. It also anchors start and end of the
  70  * windows chain.
  71  */
  72 struct WinMeta
  73 {
  74     WINDOW * _screen;          /* INTERNAL: terminal screen */
  75     struct Win * _chain_start; /* INTERNAL: first Win, ._prev to point to 0 */
  76     struct Win * _chain_end;   /* INTERNAL: last Win, ._next to point to 0 */
  77     uint16_t pad_offset;       /* number of cells view is moved to the right */
  78     struct Frame padframe;     /* virtual screen fitted into terminal screen */
  79     struct Win * active;       /* Win highlighted/selected for manipulation */
  80 };
  81
  82
  83
  84 /* Initialize empty WinMeta "wmeta" on the terminal "screen". Note that
  85  * emptiness is marked by WinMeta.chain_start=0. Other struct values are also
  86  * initialized 0, except for the virtual screen (terminal screen height, width =
  87  * 1) and its terminal-sized frame.
  88  */
  89 extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
  90
  91
  92
  93 /* Create a window below inside "wmeta" titled "title" of "height" and "width"
  94  * and appointing "func"() to interpret and draw the content stored at "data"
  95  * if the window is visible.
  96  *
  97  * A value for "width" <1 will trigger a fallback to width=1. A "height" <1 or
  98  * larger than the maximum window height possible within the virtual screen will
  99  * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0
 100  * to initialize the window to its largest possible height).
 101  *
 102  * Other values of the Win struct will be initialized to 0. The window will stay
 103  * invisible until appended to the chain of visible windows via append_win().
 104  */
 105 extern struct Win init_win(struct WinMeta * wmeta, char * title,
 106                            uint16_t height, uint16_t width,
 107                            void * data, void * func);
 108
 109
 110
 111 /* Append/suspend window "w" to/from chain of visible windows in "wmeta".
 112  * Appended windows will become active. Suspended active windows will move the
 113  * active window selection to their successor in the window chain or, failing
 114  * that, their predecessor; if no window remains, none will be active.
 115  */
 116 extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w);
 117 extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w);
 118
 119
 120
 121 /* Apply scrolling offset "new_offset" to virtual screen if it is sane, i.e.
 122  * it's equal/greater zero and does not push the view (further) beyond the
 123  * virtual screen's border. If the view is already beyond the virtual screen's
 124  * border due to it having shrunk after suspension of windows, only allow view
 125  * movement leftwards.
 126  */
 127 extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
 128
 129
 130
 131 /* Apply new size "size" to the active window, but only if it provides for at
 132  * least one cell width/height and is in height at least one cell smaller than
 133  * the screen's vertical height (to provide space for the title bar).
 134  */
 135 extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
 136
 137
 138
 139 /* Cycle active window selection forwards (set dir="n") or backwards. Wrap
 140  * around in the windows chain if start / end of it is met.
 141  */
 142 extern void cycle_active_win(struct WinMeta * wmeta, char dir);
 143
 144
 145
 146 /* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap
 147  * around in the window chain if start / end of it is met.
 148  */
 149 extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
 150
 151
 152
 153 /* Draw virtual screen including all windows. Also add scroll hints (see comment
 154  * on draw_scroll_hint()) for where the edges of the terminal screen hit
 155  * non-edges of and inside the virtual screen. Then update the terminal screen.
 156  */
 157 extern uint8_t draw_all_wins(struct WinMeta * wmeta);
 158
 159
 160
 161 /* Draw scroll hint (a line stating that there is more to see on scrolling
 162  * further into a certain direction) into "frame" at position "pos" (describing
 163  * a column or a row dependent on "dir" being *either* "<"/">" *or* something
 164  * else). It will consist of a line of "dir" symbols bracketing a descriptive
 165  * text stating the number of rows/columns further available beyond the hint.
 166  */
 167 extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos,
 168                                 uint32_t dist, char dir);
 169
 170
 171
 172 #endif