X-Git-Url: https://plomlompom.com/repos/foo.html?a=blobdiff_plain;f=src%2Fwindows.h;h=a98bbdb6708f8fc50c03d46be7cf4573be0b2f08;hb=3b2c82991c9ab169b33248c7be840a9bcd351e6d;hp=2116b7bef605ae875504ef1e732f089b60f41444;hpb=f5d7b724bd9572a918f3f8a1803a23648458a07c;p=plomrogue
diff --git a/src/windows.h b/src/windows.h
index 2116b7b..a98bbdb 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)
@@ -22,7 +23,9 @@
* 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
+ * 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.
@@ -100,21 +103,24 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);
* and appointing "func"() to interpret and draw the content stored at "data"
* if 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 members of the Win struct are 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,
+ int16_t height, int16_t width,
void * data, void * func);
-/* 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 +142,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);