Strongly overhauled keybinding managemment. Window-specific keybindings and a window...

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index aedb30b12e44030d8e8b949ad9ac56521e13e6d1..9f1b02b8cf2b1b876c68fb48ec95b40436272a72 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -58,16 +58,13 @@ 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 */
+    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 +74,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,12 +98,13 @@ 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.
  *
  * Other members of the Win struct are initialized to 0.
  */
@@ -119,7 +114,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 struct. */
+extern void free_winmeta(struct WinMeta * wmeta);
 extern void free_win(struct Win * win);
 
 
@@ -181,7 +177,8 @@ extern uint8_t draw_all_wins(struct WinMeta * wmeta);
  * 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.
+ * text stating "dist" as 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);