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 and only up to 2^16
  12  * cells. Their height is limited by the height of the terminal screen, which
  13  * must also fit into 2^16 cells.
  14  *
  15  * Positioning of windows can only indirectly be influenced: by resizing them,
  16  * and by shifting their relative position inside the (currently invisible)
  17  * chain that the window manager treats their plurality as. The first window
  18  * goes into the upper left corner of the virtual screen. Further visible
  19  * windows are fitted left-aligned below their (chain-wise) closest predecessor
  20  * that thrones over enough space to fit them in; failing that, they are placed
  21  * to the right of the window with the rightmost border.
  22  *
  23  * Functions that return uint8_t return these error codes:
  24  * 0 - success
  25  * 1 - memory allocation error
  26  * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
  27  *
  28  * TODO: Expose less internals to the API.
  29  *
  30  * TODO: Think up a more intuitive window positioning algorithm or at least make
  31  * the chain that windows are positioned by visible.
  32  */
  33
  34 #ifndef WINDOWS_H
  35 #define WINDOWS_H
  36
  37
  38
  39 #include <stdint.h>    /* for uint8_t, uint16_t, uint32_t */
  40 #include <ncurses.h>   /* for the WINDOW and chtype typedefs */
  41 #include "yx_uint16.h" /* for yx_uint16 struct */
  42
  43
  44
  45 /* Individual windows are represented by "Win" structs. They describe frames
  46  * located inside the virtual screen pad through which "winmaps" are visible,
  47  * 2-dimensional maps of ncurses chtypes. Win structs are chained into a linked
  48  * list of all the windows visible on the virtual screen and also contain
  49  * pointers to what content is to be drawn inside the window, and by use of what
  50  * method.
  51  */
  52 struct Win
  53 {
  54     struct Win * prev;  /* chain pointers; if 0, they mark the start or end  */
  55     struct Win * next;  /* of the chain; if both are 0, Win is outside chain */
  56     struct yx_uint16 framesize;   /* window frame size to see winmap through */
  57     struct yx_uint16 start;       /* upper left corner of window in pad */
  58     struct yx_uint16 center;      /* window content center to focus window on */
  59     char * title;                 /* title to be used in window title bar */
  60     void (* draw) (struct Win *); /* how to draw window content ("data") */
  61     void * data;                  /* window content to be drawn by _draw() */
  62     chtype * winmap;              /* sequence of cells, sorted into lines ... */
  63     struct yx_uint16 winmapsize;  /* ... with these geometry infos  */
  64 };
  65
  66
  67
  68 /* The window manager's parent struct WinMeta contains the virtual screen,
  69  * relates it to the terminal screen and anchors the chain of visible windows.
  70  */
  71 struct WinMeta
  72 {
  73     WINDOW * screen;          /* ncurses' pointer to the terminal screen */
  74     WINDOW * pad;             /* ncurses pad of virtual screen */
  75     uint16_t pad_offset;      /* number of cells view is moved to the right */
  76     struct yx_uint16 padsize; /* virtual screen size */
  77     struct Win * chain_start; /* first Win in chain; its _prev == 0 */
  78     struct Win * chain_end;   /* last Win in chain; its _next == 0 */
  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 members are also
  86  * initialized 0, except for the virtual screen (height = that of the terminal
  87  * screen; width = 1) amd its frame sized to the size of the terminal screen.
  88  */
  89 extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta ** wmeta);
  90
  91
  92
  93 /* Initialize a window child of "wmeta" to "title", "height" and "width" and
  94  * appointing "func"() to interpret and draw the content stored at "data" when
  95  * the window is visible.
  96  *
  97  * Pass 0 for "width" to make the window as wide as the terminal screen. Pass
  98  * negative values for "width" to make the width so many cells smaller than that
  99  * of the terminal screen. Pass 0 for "height" to give the window the maximum
 100  * allowed height: one cell smaller than that of the terminal screen. Pass
 101  * negative values to make the window width so many cells smaller than that of
 102  * the terminal screen. The maximum allowed height is also applied for positive
 103  * values that exceed it or negative values that would reduce the window height
 104  * < 1 cell.
 105  *
 106  * The Win frame's curses window is initialized to a pad of size 1x1 cells.
 107  * Other members of the Win struct are initialized to 0.
 108  */
 109 extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title,
 110                         int16_t height, int16_t width,
 111                         void * data, void * func);
 112
 113
 114
 115 /* Free allocated memory for an initialized Win / WinMeta structs. */
 116 extern void free_winmeta(struct WinMeta * wmeta);
 117 extern void free_win(struct Win * win);
 118
 119
 120
 121 /* Append/suspend window "w" to/from chain of visible windows below "wmeta".
 122  * Appended windows will become active. Suspended active windows will move the
 123  * active window selection to their successor in the window chain or, failing
 124  * that, their predecessor; if no window remains, none will be active.
 125  */
 126 extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w);
 127 extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w);
 128
 129
 130
 131 /* Apply scrolling offset "new_offset" to virtual screen if it is sane, i.e.
 132  * it's equal/greater zero and does not push the view (further) beyond the
 133  * virtual screen's border. If the view is already beyond the virtual screen's
 134  * border due to it having shrunk after suspension of windows, only allow view
 135  * movement leftwards.
 136  */
 137 extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
 138
 139
 140
 141 /* Apply new size "size" to the active window, but only if it provides for at
 142  * least one cell width/height and is in height at least one cell smaller than
 143  * the screen's vertical height (to provide space for the title bar). Does
 144  * nothing if no window is active.
 145  */
 146 extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
 147
 148
 149
 150 /* Cycle active window selection forwards ("dir" == "f") or backwards (any
 151  * other "dir"). Wrap around in the windows chain if start / end of it is met.
 152  * Does nothing if no window is active.
 153  */
 154 extern void cycle_active_win(struct WinMeta * wmeta, char dir);
 155
 156
 157
 158 /* Move active window forwards ("dir" == "f") or backwards (any other "dir").
 159  * Wrap around in the window chain if start / end of it is met. Does nothing if
 160  * no window is active.
 161  */
 162 extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
 163
 164
 165
 166 /* Draw virtual screen including all windows. Also add scroll hints for where
 167  * the edges of the terminal screen hit non-edges of and inside the virtual
 168  * screen. Then update the terminal screen.
 169  */
 170 extern uint8_t draw_all_wins(struct WinMeta * wm);
 171
 172
 173
 174 #endif