home · contact · privacy
Improved comments for windows library header file.
[plomrogue] / 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.
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 forces virtual screen to grow beyond width of 2^16 cells
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
42 /* Individual windows consist of potential (real only if window is visible
43  * inside the virtual screen) ncurses WINDOWs wrapped inside Frame structs (that
44  * keep a window's designated size even when it is invisible) wrapped inside
45  * metadata-rich Win structs. Win structs are chained into a linked list of all
46  * the windows visible on the virtual screen and also contain pointers to what
47  * content is to be drawn inside the window, and by use of what method.
48  */
49
50 struct Frame               /* If Frame is Win's "frame", "size" is the        */
51 {                          /* designated size of curses_win's ncurses WINDOW. */
52     WINDOW * curses_win;   /* If Frame is WinMeta's "padframe", curses_win is */
53     struct yx_uint16 size; /* the ncurses pad representing the virtual screen,*/
54 };                         /* and "size" desribes the terminal screen size.   */
55 struct Frame
56 {
57     WINDOW * curses_win;
58     struct yx_uint16 size;  /* the size curses_win fits into; for the virtual */
59 };                          /* screen padframe: the terminal screen size      */
60
61 struct Win
62 {
63     /* members supposed to be used ONLY INTERNALLY */
64     struct Win * _prev;  /* chain pointers; if 0, they mark the start or end  */
65     struct Win * _next;  /* of the chain; if both are 0, Win is outside chain */
66     struct yx_uint16 _start;       /* upper left corner of WINDOW in "frame" */
67     char * _title;                 /* title to be used in window title bar */
68     void (* _draw) (struct Win *); /* how to draw window content ("data") */
69
70     /* members to be available EXTERNALLY */
71     struct Frame frame;
72     void * data;                   /* window content to be drawn by _draw() */
73 };
74
75
76
77 /* The window manager's parent struct WinMeta provides the virtual screen and a
78  * representation of the terminal screen. It also anchors start and end of the
79  * windows chain.
80  */
81 struct WinMeta
82 {
83     /* members supposed to be used ONLY INTERNALLY */
84     WINDOW * _screen;          /* terminal screen */
85     struct Win * _chain_start; /* if first Win, ._prev to point to 0 */
86     struct Win * _chain_end;   /* if last Win, ._next to point to 0 */
87
88     /* members to be available EXTERNALLY */
89     uint16_t pad_offset;       /* number of cells view is moved to the right */
90     struct Frame padframe;     /* virtual screen fitted into terminal screen */
91     struct Win * active;       /* Win highlighted/selected for manipulation */
92 };
93
94
95
96 /* Initialize empty WinMeta "wmeta" on the terminal "screen". Note that
97  * emptiness is marked by WinMeta.chain_start=0. Other struct values are also
98  * initialized 0, except for the virtual screen (terminal screen height, width =
99  * 1) and its terminal-sized frame.
100  */
101 extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
102
103
104
105 /* Create a window below inside "wmeta" titled "title" of "height" and "width"
106  * and appointing "func"() to interpret and draw the content stored at "data"
107  * if the window is visible.
108  *
109  * A value for "width" <1 will trigger a fallback to width=1. A "height" <1 or
110  * larger than the maximum window height possible within the virtual screen will
111  * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0
112  * to initialize the window to its largest possible height).
113  *
114  * Other values of the Win struct will be initialized to 0. The window will stay
115  * invisible until appended to the chain of visible windows via append_win().
116  */
117 extern struct Win init_win(struct WinMeta * wmeta, char * title,
118                            uint16_t height, uint16_t width,
119                            void * data, void * func);
120
121
122
123 /* Append/suspend window "w" to/from chain of visible windows in "wmeta".
124  * Appended windows will become active. Suspended active windows will move the
125  * active window selection to their successor in the window chain or, failing
126  * that, their predecessor; if no window remains, none will be active.
127  */
128 extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w);
129 extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w);
130
131
132
133 /* Apply scrolling offset "new_offset" to virtual screen if it is sane, i.e.
134  * it's equal/greater zero and does not push the view (further) beyond the
135  * virtual screen's border. If the view is already beyond the virtual screen's
136  * border due to it having shrunk after suspension of windows, only allow view
137  * movement leftwards.
138  */
139 extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
140
141
142
143 /* Apply new size "size" to the active window, but only if it provides for at
144  * least one cell width/height and is in height at least one cell smaller than
145  * the screen's vertical height (to provide space for the title bar).
146  */
147 extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
148
149
150
151 /* Cycle active window selection forwards (set dir="n") or backwards. Wrap
152  * around in the windows chain if start / end of it is met.
153  */
154 extern void cycle_active_win(struct WinMeta * wmeta, char dir);
155
156
157
158 /* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap
159  * around in the window chain if start / end of it is met.
160  */
161 extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
162
163
164
165 /* Draw virtual screen including all windows. Also add scroll hints (see comment
166  * on draw_scroll_hint()) for where the edges of the terminal screen hit
167  * non-edges of and inside the virtual screen. Then update the terminal screen.
168  */
169 extern uint8_t draw_all_wins(struct WinMeta * wmeta);
170
171
172
173 /* Draw scroll hint (a line stating that there is more to see on scrolling
174  * further into a certain direction) into "frame" at position "pos" (describing
175  * a column or a row dependent on "dir" being *either* "<"/">" *or* something
176  * else). It will consist of a line of "dir" symbols bracketing a descriptive
177  * text stating the number of rows/columns further available beyond the hint.
178  */
179 extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos,
180                                 uint32_t dist, char dir);
181
182
183
184 #endif