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

diff --git a/src/windows.h b/src/windows.h
index 7cca04d..a13e447 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -47,34 +47,39 @@
  * content is to be drawn inside the window, and by use of what method.
  */
 
-struct Frame
-{
-    WINDOW * curses_win;
-    struct yx_uint16 size;  /* the size curses_win fits into; for the virtual */
-};                          /* screen padframe: the terminal screen size      */
+struct Frame               /* If Frame is Win's "frame", "size" is the        */
+{                          /* designated size of curses_win's ncurses WINDOW. */
+    WINDOW * curses_win;   /* If Frame is WinMeta's "padframe", curses_win is */
+    struct yx_uint16 size; /* the ncurses pad representing the virtual screen */
+};                         /* and "size" desribes the terminal screen size.   */
 
 struct Win
 {
-    struct Win * _prev;            /* INTERNAL */ /* _prev == _next == 0 if   */
-    struct Win * _next;            /* INTERNAL */ /* Win is outside the chain */
-    struct yx_uint16 _start;       /* INTERNAL: upper left corner of WINDOW */
-    char * _title;                 /* INTERNAL: title for window title bar */
-    void (* _draw) (struct Win *); /* INTERNAL: how to draw window content */
+    /* 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 Frame frame;
     void * data;                   /* window content to be drawn by _draw() */
 };
 
 
 
-/* The window manager's parent struct WinMeta provides the virtual screen and a
- * representation of the terminal screen. It also anchors start and end of the
- * windows chain.
+/* The window manager's parent struct WinMeta contains the virtual screen,
+ * relates it to the terminal screen and anchors the chain of visible windows.
  */
 struct WinMeta
 {
-    WINDOW * _screen;          /* INTERNAL: terminal screen */
-    struct Win * _chain_start; /* INTERNAL: first Win, ._prev to point to 0 */
-    struct Win * _chain_end;   /* INTERNAL: last Win, ._next to point to 0 */
+    /* 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 */
@@ -82,10 +87,10 @@ struct WinMeta
 
 
 
-/* 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.
+/* Initialize empty WinMeta "wmeta" on the terminal "screen". (Note that
+ * emptiness is marked by WinMeta.chain_start=0.) Other struct members are also
+ * initialized 0, except for the virtual screen (height = that of the terminal
+ * screen; width = 1) amd its frame sized to the size of the terminal screen.
  */
 extern uint8_t init_win_meta(WINDOW * screen, struct WinMeta * wmeta);