X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=a40835d9c591925b3d080b8747495c9b21a5c3ed;hb=0399a31b31047ab82348f733d6c56524258d1188;hp=a13e447c2d98d340d0ed2db562ede8b6d72b60b8;hpb=6403baf26d20951ef830ed9660a23241c3079896;p=plomrogue

diff --git a/src/windows.h b/src/windows.h
index a13e447..a40835d 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -9,7 +9,8 @@
  *
  * Windows can be almost any width (number has to fit into 16 bits); the virtual
  * screen grows with them as needed -- but only horizontally and only up to 2^16
- * cells. Their height is limited by the height of the terminal screen.
+ * cells. Their height is limited by the height of the terminal screen, which
+ * must also fit into 2^16 cells.
  *
  * Positioning of windows can only indirectly be influenced: by resizing them,
  * and by shifting their relative position inside the (currently invisible)
@@ -21,8 +22,10 @@
  *
  * Functions that return uint8_t return these error codes:
  * 0 - success
- * 1 - memory allocation error (of ncurses' pads/windows, or scroll hint texts)
- * 2 - activity forces virtual screen to grow beyond width of 2^16 cells
+ * 1 - memory allocation error
+ * 2 - would force virtual screen to grow beyond width or height of 2^16 cells
+ *
+ * TODO: Expose less internals to the API.
  *
  * TODO: Think up a more intuitive window positioning algorithm or at least make
  * the chain that windows are positioned by visible.
@@ -96,25 +99,32 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
 
 
 
-/* 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.
+/* Initialize a window child of "wmeta" to "title", "height" and "width" and
+ * appointing "func"() to interpret and draw the content stored at "data" when
+ * the window is visible.
  *
- * 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).
+ * Pass 0 for "width" to make the window as wide as the terminal screen. Pass
+ * negative values for "width" to make the size so many cells smaller than the
+ * terminal screen. Pass 0 for "height" to give the window the maximum allowed
+ * height: one cell smaller than the terminal screen. Pass negative values to
+ * make the window so many smalls smaller than the terminal screen. The maximum
+ * allowed height is also applied for positive values that exceed it or negative
+ * values that would reduce the window height < 1 cell.
  *
- * 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().
+ * Other members of the Win struct are initialized to 0.
  */
-extern struct Win init_win(struct WinMeta * wmeta, char * title,
-                           uint16_t height, uint16_t width,
-                           void * data, void * func);
+extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title,
+                        int16_t height, int16_t width,
+                        void * data, void * func);
+
+
+
+/* Free allocated memory for an initialized Win struct. */
+extern void free_win(struct Win * win);
 
 
 
-/* Append/suspend window "w" to/from chain of visible windows in "wmeta".
+/* Append/suspend window "w" to/from chain of visible windows below "wmeta".
  * 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.
@@ -136,21 +146,24 @@ 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).
+ * the screen's vertical height (to provide space for the title bar). Does
+ * nothing if no window is active.
  */
 extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size);
 
 
 
-/* Cycle active window selection forwards (set dir="n") or backwards. Wrap
- * around in the windows chain if start / end of it is met.
+/* Cycle active window selection forwards ("dir" == "f") or backwards (any
+ * other "dir"). Wrap around in the windows chain if start / end of it is met.
+ * Does nothing if no window is active.
  */
 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.
+/* Move active window forwards ("dir" == "f") or backwards (any other "dir").
+ * Wrap around in the window chain if start / end of it is met. Does nothing if
+ * no window is active.
  */
 extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);