Improved comments for windows library header file.

[plomrogue] / src / windows.h

diff --git a/src/windows.h b/src/windows.h
index af84228ef454059debf78ba8eb7627cab5cffce4..d894fd28e5178f15ce6c42aea82ffb215ddda341 100644 (file)
--- a/src/windows.h
+++ b/src/windows.h
@@ -8,8 +8,8 @@
  * (in a bizarre fashion, see below) automatically.
  *
  * Windows can be almost any width (number has to fit into 16 bits); the virtual
- * screen grows with them as needed -- but only horizontally. Their height is
- * limited by the height of the terminal screen.
+ * 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.
  *
  * Positioning of windows can only indirectly be influenced: by resizing them,
  * and by shifting their relative position inside the (currently invisible)
@@ -22,7 +22,7 @@
  * 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 makes virtual screen grow beyond uint16 height/width confines
+ * 2 - activity forces virtual screen to grow beyond width of 2^16 cells
  *
  * TODO: Think up a more intuitive window positioning algorithm or at least make
  * the chain that windows are positioned by visible.
@@ -38,42 +38,48 @@
 #include "yx_uint16.h" /* for yx_uint16 coordinates */
 
 
-/* Individual windows consist of potential (real if window is visible) ncurses
- * WINDOWs wrapped inside Frame structs (that keep a window's designated size
- * even when it is invisible) wrapped inside metadata-rich Win structs. Win
- * structs are chained into a linked list of all the windows visible on the
- * virtual screen and also contain pointers to what content is to be drawn
- * inside the window, and by use of what method.
+
+/* Individual windows consist of potential (real only if window is visible
+ * inside the virtual screen) ncurses WINDOWs wrapped inside Frame structs (that
+ * keep a window's designated size even when it is invisible) wrapped inside
+ * metadata-rich Win structs. Win structs are chained into a linked list of all
+ * the windows visible on the virtual screen and also contain pointers to what
+ * 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 */