struct Frame
{
WINDOW * curses_win;
- struct yx_uint16 size; /* designated size of curses_win */
-};
+ struct yx_uint16 size; /* the size curses_win fits into; for the virtual */
+}; /* screen padframe: the terminal screen size */
struct Win
{
{
WINDOW * screen; /* terminal screen */
uint16_t pad_offset; /* number of cells view is moved to the right */
- struct Frame pad; /* virtual screen */
+ 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 */
-/* Create on the terminal "screen" an empty WinMeta whose virtual screen at the
- * beginning is sized just like the terminal screen. Note that emptiness is
- * marked by WinMeta.chain_start=0. Other struct values are also initialized 0.
+/* 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.
*
- * TODO: Why is an *empty* virtual screen's size that of the terminal screen?
+ * Returns 0 on success, 1 on (ncurses newpad() memory allocation) error.
*/
-extern struct WinMeta init_win_meta(WINDOW * screen);
+extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
-/* 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.
+/* Create a window below inside "wmeta" titled "title" of "height" and "width"
+ * and appointing "func"() to interpret and draw the content stored at "data"
+ * if the window is 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().
+ * 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).
*
- * TODO: Why a default start width instead of passing a start width?
+ * Other values of the Win struct will be 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,
+ uint16_t height, uint16_t width,
void * data, void * func);
* 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.
+ *
+ * Return 0 on success, and 1 on (ncurses window/pad memory allocation) error.
*/
-extern void append_win(struct WinMeta * wmeta, struct Win * w);
-extern void suspend_win(struct WinMeta * wmeta, struct Win * w);
+extern uint8_t append_win(struct WinMeta * wmeta, struct Win * w);
+extern uint8_t suspend_win(struct WinMeta * wmeta, struct Win * w);
/* 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).
+ *
+ * Returns 0 on success, 1 on (ncurses window/pad memory allocation) error.
*/
-extern void resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
+extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
/* 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.
+ *
+ * Returns 0 on success, 1 on (ncurses window/pad memory allocation) error.
*/
-extern void shift_active_win(struct WinMeta * wmeta, char dir);
+extern uint8_t shift_active_win(struct WinMeta * wmeta, 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.
+/* Draw virtual screen including all windows. Also add scroll hints (see comment
+ * on draw_scroll_hint()) for where the edges of the terminal screen hit
+ * non-edges of and inside the virtual screen. Then update the terminal screen.
+ *
+ * Returns 0 on success, 1 on error (of scroll hint text memory allocation).
*/
-extern void draw_all_wins(struct WinMeta * wmeta);
+extern uint8_t draw_all_wins(struct WinMeta * wmeta);
* 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.
+ *
+ * Return 0 on success, and 1 on error (of scroll hint text memory allocation).
*/
-extern void draw_scroll_hint(struct Frame * frame, uint16_t pos, uint32_t dist,
- char dir);
+extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos,
+ uint32_t dist, char dir);
projects / plomrogue / blobdiff