X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=5f6a02406983ad0ddd900fb2d3c2bae1685f9856;hb=f21d01eb14c3b3ac09463de3e573dd99e002fe3d;hp=28239961c2d713aa337b9b313733fd1a740347bf;hpb=7815e738f77aad4e918c84a89aa21f7ae683ebab;p=plomrogue

diff --git a/src/windows.h b/src/windows.h
index 2823996..5f6a024 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -79,12 +79,14 @@ struct WinMeta
 
 
 
-/* Create on the terminal "screen" an empty WinMeta. 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 values are also
+ * initialized 0, except for the virtual screen (terminal screen height, width =
+ * 1) and its terminal-sized frame.
+ *
+ * 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);
 
 
 
@@ -101,7 +103,7 @@ extern struct WinMeta init_win_meta(WINDOW * screen);
  * 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 widtht,
+                           uint16_t height, uint16_t width,
                            void * data, void * func);
 
 
@@ -110,9 +112,11 @@ extern struct Win init_win(struct WinMeta * wmeta, char * title,
  * 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);
 
 
 
@@ -129,8 +133,10 @@ extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset);
 /* 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);
 
 
 
@@ -143,17 +149,20 @@ 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.
+ *
+ * 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);
 
 
 
@@ -162,9 +171,11 @@ extern void 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);