More precise description of what draw_text_from_bottom() does.

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index aedb30b12e44030d8e8b949ad9ac56521e13e6d1..eed33ffdb31cb9cd976707440e81b6ea5bbd8b58 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -58,16 +58,14 @@ struct Frame               /* If Frame is Win's "frame", "size" is the        */
 
 struct Win
 {
-    /* members supposed to be used ONLY INTERNALLY */
-    struct Win * _prev;  /* chain pointers; if 0, they mark the start or end  */
-    struct Win * _next;  /* of the chain; if both are 0, Win is outside chain */
-    struct yx_uint16 _start;       /* upper left corner of "frame" WINDOW */
-    char * _title;                 /* title to be used in window title bar */
-    void (* _draw) (struct Win *); /* how to draw window content ("data") */
-
-    /* members to be available EXTERNALLY */
+    struct Win * prev;  /* chain pointers; if 0, they mark the start or end  */
+    struct Win * next;  /* of the chain; if both are 0, Win is outside chain */
+    struct yx_uint16 start;       /* upper left corner of "frame" WINDOW */
+    struct yx_uint16 center;      /* window content center to focus window on */
+    char * title;                 /* title to be used in window title bar */
+    void (* draw) (struct Win *); /* how to draw window content ("data") */
     struct Frame frame;
-    void * data;                   /* window content to be drawn by _draw() */
+    void * data;                  /* window content to be drawn by _draw() */
 };
 
 
@@ -77,15 +75,12 @@ struct Win
  */
 struct WinMeta
 {
-    /* members supposed to be used ONLY INTERNALLY */
-    WINDOW * _screen;          /* ncurses' pointer to the terminal screen */
-    struct Win * _chain_start; /* first Win in chain; its _prev == 0 */
-    struct Win * _chain_end;   /* last Win in chain; its _next == 0 */
-
-    /* members to be available EXTERNALLY */
-    uint16_t pad_offset;       /* number of cells view is moved to the right */
-    struct Frame padframe;     /* virtual screen fitted into terminal screen */
-    struct Win * active;       /* Win highlighted/selected for manipulation */
+    WINDOW * screen;          /* ncurses' pointer to the terminal screen */
+    struct Win * chain_start; /* first Win in chain; its _prev == 0 */
+    struct Win * chain_end;   /* last Win in chain; its _next == 0 */
+    uint16_t pad_offset;      /* number of cells view is moved to the right */
+    struct Frame padframe;    /* virtual screen fitted into terminal screen */
+    struct Win * active;      /* Win highlighted/selected for manipulation */
 };
 
 
@@ -104,13 +99,15 @@ extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta ** wmeta);
  * the window is visible.
  *
  * 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.
+ * negative values for "width" to make the width so many cells smaller than that
+ * of the terminal screen. Pass 0 for "height" to give the window the maximum
+ * allowed height: one cell smaller than that of the terminal screen. Pass
+ * negative values to make the window width so many cells smaller than that of
+ * 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.
  *
+ * The Win frame's curses window is initialized to a pad of size 1x1 cells.
  * Other members of the Win struct are initialized to 0.
  */
 extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title,
@@ -119,7 +116,8 @@ extern uint8_t init_win(struct WinMeta * wmeta, struct Win ** w, char * title,
 
 
 
-/* Free allocated memory for an initialized Win struct. */
+/* Free allocated memory for an initialized Win / WinMeta structs. */
+extern void free_winmeta(struct WinMeta * wmeta);
 extern void free_win(struct Win * win);
 
 
@@ -169,22 +167,11 @@ extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);
 
 
 
-/* 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.
+/* Draw virtual screen including all windows. Also add scroll hints for where
+ * the edges of the terminal screen hit non-edges of and inside the virtual
+ * screen. Then update the terminal screen.
  */
-extern uint8_t draw_all_wins(struct WinMeta * wmeta);
-
-
-
-/* Draw scroll hint (a line stating that there is more to see on scrolling
- * further into a certain direction) into "frame" at position "pos" (describing
- * 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.
- */
-extern uint8_t draw_scroll_hint(struct Frame * frame, uint16_t pos,
-                                uint32_t dist, char dir);
+extern uint8_t draw_all_wins(struct WinMeta * wm);