home · contact · privacy
Renamed borders to borderlines in function names where appropriate in windows.c
[plomrogue] / src / windows.c
index b2643bf31d3ba0d0b065a92ae6c9bd4dfb8492e3..c201b7c134a909d59e0863314ace6703a8b9997b 100644 (file)
@@ -10,7 +10,7 @@
 
 
 /* Stores a window's border corners. This is a helper to draw_all_wins() (and
- * filled by its helper draw_wins_borders()) which draws the horizontal and
+ * filled by its helper draw_wins_borderlines()) which draws the horizontal and
  * vertical lines of all windows' borders first and the corner characters of
  * all windows only afterwards (so that corners are not overwritten by lines).
  * This delay of corner drawing necessitates temporarily storing their
@@ -18,7 +18,7 @@
  * series of such Corners structs to be released at the end.
  *
  * TODO: Maybe replace this complicated method by dropping the harvesting of
- * corners from draw_wins_borders() and instead collecting them in a second
+ * corners from draw_wins_borderlines() and instead collecting them in a second
  * border drawing cycle that repeats some cycles but works in a much more
  * straightforward way.
  */
@@ -57,19 +57,20 @@ static void draw_wins(struct Win * w);
 
 
 
-/* draw_win_borders() Draws the vertical and horizontal borders of window "w"
- * sans corners, and draws the top border line as the windows' title bar
+/* draw_win_borderlines() draws the vertical and horizontal borders of window
+ * "w" sans corners, and draws the top border line as the windows' title bar
  * (highlighted if the window is described active by "active" being set).
- * draw_wins_borders().
+ * draw_wins_borderlines().
  *
- * draw_wins_borders() calls draw_win_borders() recursively on all windows from
- * "w" on. It also fills "corners" with coordinates of each window's corners,
- * iterating over its Corners structs via the "i" index incremented by 1 over
- * each handled window. "w_active" is a pointer to the one window that
- * draw_win_borders() is supposed to handle as the active window.
+ * draw_wins_borderlines() calls draw_win_borderlines() recursively on all
+ * windows from "w" on. It also fills "corners" with coordinates of each
+ * window's corners, iterating over its Corners structs via the "i" index
+ * incremented by 1 over each handled window. "w_active" is a pointer to the
+ * one window that draw_win_borderlines() is supposed to handle as the active
+ * window.
  */
-static void draw_win_borders(struct Win * w, char active);
-static void draw_wins_borders(struct Win * w, struct Win * w_active,
+static void draw_win_borderlines(struct Win * w, char active);
+static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
                               struct Corners * corners, uint16_t i);
 
 
@@ -202,48 +203,50 @@ static void draw_wins (struct Win * w)
 
 
 
-static void draw_win_borders(struct Win * w, char active)
+static void draw_win_borderlines(struct Win * w, char active)
 {
-  /* Draw vertical and horizontal border lines. */
-  uint16_t y, x;
-  for (y = w->start.y; y <= w->start.y + w->frame.size.y; y++)
-  {
-    mvwaddch(wgetparent(w->frame.curses_win), y, w->start.x - 1, '|');
-    mvwaddch(wgetparent(w->frame.curses_win),
-             y, w->start.x + w->frame.size.x, '|');
-  }
-  for (x = w->start.x; x <= w->start.x + w->frame.size.x; x++)
-  {
-    mvwaddch(wgetparent(w->frame.curses_win), w->start.y - 1, x, '-');
-    mvwaddch(wgetparent(w->frame.curses_win),
-             w->start.y + w->frame.size.y, x, '-');
-  }
-
-  /* Draw as much as possible of the title into center of top border line. */
-  char min_title_length_visible = 3; /* minimum 1 char + 2 padding/decoration */
-  if (w->frame.size.x >= min_title_length_visible)
-  {
-    uint16_t title_offset = 0;
-    if (w->frame.size.x > strlen(w->title) + 2)
+    /* Draw vertical and horizontal border lines. */
+    uint16_t y, x;
+    for (y = w->start.y; y <= w->start.y + w->frame.size.y; y++)
     {
-      title_offset = (w->frame.size.x - (strlen(w->title) + 2)) / 2;                  // + 2 is for decoration
+        mvwaddch(wgetparent(w->frame.curses_win), y, w->start.x - 1, '|');
+        mvwaddch(wgetparent(w->frame.curses_win),
+                 y, w->start.x + w->frame.size.x, '|');
     }
-    uint16_t length_visible = strnlen(w->title, w->frame.size.x - 2);
-    char title[length_visible + 3];
-    char decoration = ' ';
-    if (1 == active)
+    for (x = w->start.x; x <= w->start.x + w->frame.size.x; x++)
     {
-      decoration = '$';
+        mvwaddch(wgetparent(w->frame.curses_win), w->start.y - 1, x, '-');
+        mvwaddch(wgetparent(w->frame.curses_win),
+                 w->start.y + w->frame.size.y, x, '-');
+    }
+
+    /* Draw as much as possible of the title into center of top border line. */
+    char min_title_length_visible = 3;  /* min. 1 char + 2 padding/decoration */
+    if (w->frame.size.x >= min_title_length_visible)
+    {
+        uint16_t title_offset = 0;
+        if (w->frame.size.x > strlen(w->title) + 2)
+        {
+            title_offset = (w->frame.size.x - (strlen(w->title) + 2)) / 2;
+        }                                     /* +2 is for padding/decoration */
+        uint16_t length_visible = strnlen(w->title, w->frame.size.x - 2);
+        char title[length_visible + 3];
+        char decoration = ' ';
+        if (1 == active)
+        {
+            decoration = '$';
+        }
+        memcpy(title + 1, w->title, length_visible);
+        title[0] = title[length_visible + 1] = decoration;
+        title[length_visible + 2] = '\0';
+        mvwaddstr(wgetparent(w->frame.curses_win),
+                  w->start.y - 1, w->start.x + title_offset, title);
     }
-    memcpy(title + 1, w->title, length_visible);
-    title[0] = title[length_visible + 1] = decoration;
-    title[length_visible + 2] = '\0';
-    mvwaddstr(wgetparent(w->frame.curses_win),
-              w->start.y - 1, w->start.x + title_offset, title);
-  }
 }
 
-static void draw_wins_borders(struct Win * w, struct Win * w_active,
+
+
+static void draw_wins_borderlines(struct Win * w, struct Win * w_active,
                               struct Corners * corners, uint16_t i)
 {
     char active = 0;
@@ -251,7 +254,7 @@ static void draw_wins_borders(struct Win * w, struct Win * w_active,
     {
         active = 1;
     }
-    draw_win_borders(w, active);
+    draw_win_borderlines(w, active);
     corners[i].tl.y = w->start.y - 1;
     corners[i].tl.x = w->start.x - 1;
     corners[i].tr.y = w->start.y - 1;
@@ -262,7 +265,7 @@ static void draw_wins_borders(struct Win * w, struct Win * w_active,
     corners[i].br.x = w->start.x + w->frame.size.x;
     if (0 != w->next)
     {
-        draw_wins_borders (w->next, w_active, corners, i + 1);
+        draw_wins_borderlines (w->next, w_active, corners, i + 1);
     }
 }
 
@@ -434,16 +437,18 @@ extern void shift_active_win(struct WinMeta * wmeta, char dir)
             wrap = 1;
         }
 
-        /* Suspend all visible windows. */
+        /* Suspend all visible windows, remember their order in wins[]. */
         uint16_t i, i_max;
-        for (i_max = 1, w_p = wmeta->chain_start;
+        for (w_p  = wmeta->chain_start, i_max = 1;
              w_p != wmeta->chain_end;
-             i_max++)
+             w_p  = w_p->next)
         {
-            w_p = w_p->next;
+            i_max++;
         }
         struct Win ** wins = malloc(i_max * sizeof(struct Win *));
-        for (i = 0, w_p = wmeta->chain_start; i < i_max; i++)
+        for (i = 0, w_p = wmeta->chain_start;
+             i < i_max;
+             i++)
         {
             w_p_next = w_p->next;
             suspend_win(wmeta, w_p);
@@ -490,7 +495,7 @@ extern void shift_active_win(struct WinMeta * wmeta, char dir)
         }
         free(wins);
 
-        wmeta->active = w_shift;      /* TODO: Is this necessary? If so, why? */
+        wmeta->active = w_shift;  /* Otherwise lastly appended win is active. */
     }
 }
 
@@ -517,7 +522,7 @@ extern void draw_all_wins(struct WinMeta * wmeta)
             n_wins++;
         }
         struct Corners * all_corners = malloc(sizeof(struct Corners) * n_wins);
-        draw_wins_border(wmeta->chain_start, wmeta->active, all_corners, 0);
+        draw_wins_borderlines(wmeta->chain_start, wmeta->active, all_corners, 0);
         for (i = 0; i < n_wins; i++)
         {
             mvwaddch(wmeta->pad.curses_win,
@@ -573,7 +578,7 @@ extern void draw_scroll_hint(struct Frame * frame, uint16_t pos, uint32_t dist,
         unit = unit_cols;
     }
     char * scrolldsc = malloc((4 * sizeof(char)) + strlen(more) + strlen(unit)
-                              + 10);  /* 10 = uint32 max strlen */
+                              + 10);                /* 10 = uint32 max strlen */
     sprintf(scrolldsc, " %d %s %s ", dist, more, unit);
 
     /* Decide on offset of the description text inside the scroll hint line. */