known_branch_stairs

New routine known_branch_stairs() was performing two different things
and was unnecessarly complicated because of that.  Split off newer
routine stairs_description() to handle one of those.

include/extern.h

@@ -634,7 +634,8 @@ extern unsigned int induced_align(int);
 extern boolean Invocation_lev(d_level *);
 extern xchar level_difficulty(void);
 extern schar lev_by_name(const char *);
-extern boolean known_branch_stairs(stairway *, char *, boolean);
+extern boolean known_branch_stairs(stairway *);
+extern char *stairs_description(stairway *, char *, boolean);
 extern schar print_dungeon(boolean, schar *, xchar *);
 extern char *get_annotation(d_level *);
 extern int donamelevel(void);

src/display.c

@@ -1856,14 +1856,14 @@ back_to_glyph(xchar x, xchar y)
         break;
     case STAIRS:
         sway = stairway_at(x, y);
-        if (known_branch_stairs(sway, (char *) 0, FALSE))
+        if (known_branch_stairs(sway))
             idx = (ptr->ladder & LA_DOWN) ? S_brdnstair : S_brupstair;
         else
             idx = (ptr->ladder & LA_DOWN) ? S_dnstair : S_upstair;
         break;
     case LADDER:
         sway = stairway_at(x, y);
-        if (known_branch_stairs(sway, (char *) 0, FALSE))
+        if (known_branch_stairs(sway))
             idx = (ptr->ladder & LA_DOWN) ? S_brdnladder : S_brupladder;
         else
             idx = (ptr->ladder & LA_DOWN) ? S_dnladder : S_upladder;

src/dungeon.c

@@ -2113,46 +2113,48 @@ tport_menu(winid win, char *entry, struct lchoice *lchoices,
     return;
 }
 
+/* return True if 'sway' is a branch staircase and hero has used these stairs
+   to visit the branch */
 boolean
-known_branch_stairs(stairway *sway, char *outbuf, boolean stcase)
+known_branch_stairs(stairway *sway)
+{
+    return (sway && sway->tolev.dnum != u.uz.dnum && sway->u_traversed);
+}
+
+/* describe staircase 'sway' based on whether hero knows the destination */
+char *
+stairs_description(
+    stairway *sway, /* stairs/ladder to describe */
+    char *outbuf,   /* result buffer */
+    boolean stcase) /* True: "staircase" or "ladder", always singular;
+                     * False: "stairs" or "ladder"; caller needs to deal
+                     * with singular vs plural when forming a sentence */
 {
     d_level tolev;
     const char *stairs, *updown;
-    int ledgr, dest_visited;
-
-    if (outbuf)
-        *outbuf = '\0';
-    if (!sway)
-        return FALSE;
 
     tolev = sway->tolev;
     stairs = sway->isladder ? "ladder" : stcase ? "staircase" : "stairs";
     updown = sway->up ? "up" : "down";
-    ledgr = ledger_no(&tolev);
-    dest_visited = (g.level_info[ledgr].flags & VISITED) != 0;
 
-    if (tolev.dnum == u.uz.dnum || !sway->u_traversed) {
+    if (!known_branch_stairs(sway)) {
-        if (outbuf) {
+        /* ordinary stairs or branch stairs to not-yet-visited branch */
-            Sprintf(outbuf, "%s %s", stairs, updown);
+        Sprintf(outbuf, "%s %s", stairs, updown);
-            if (dest_visited) {
+        if (sway->u_traversed) {
-                boolean specialdepth = (tolev.dnum == quest_dnum
+            boolean specialdepth = (tolev.dnum == quest_dnum
-                                        || tolev.dnum == knox_level.dnum);
+                                    || single_level_branch(&tolev)); /* knox */
-                int to_dlev = specialdepth ? dunlev(&tolev) : depth(&tolev);
+            int to_dlev = specialdepth ? dunlev(&tolev) : depth(&tolev);
 
-                Sprintf(eos(outbuf), " to level %d", to_dlev);
+            Sprintf(eos(outbuf), " to level %d", to_dlev);
-            }
         }
-        /* might actually be branch stairs but if the branch hasn't been
+    } else {
-           visited yet, the hero won't know that */
+        /* known branch stairs; tacking on destination level is too verbose */
-        return FALSE;
-    }
-    if (outbuf) {
         Sprintf(outbuf, "branch %s %s to %s",
                 stairs, updown, g.dungeons[tolev.dnum].dname);
+        /* dungeons[].dname is capitalized; undo that for "The <Branch>" */
         (void) strsubst(outbuf, "The ", "the ");
     }
-    /* branch stairs and hero knows it */
+    return outbuf;
-    return TRUE;
 }
 
 /* Convert a branch type to a string usable by print_dungeon(). */

src/invent.c

@@ -3325,18 +3325,7 @@ dfeature_at(int x, int y, char *buf)
                 align_str(Amask2align(lev->altarmask & ~AM_SHRINE)));
         dfeature = altbuf;
     } else if (stway) {
-        (void) known_branch_stairs(stway, altbuf, TRUE);
+        dfeature = stairs_description(stway, altbuf, TRUE);
-        dfeature = altbuf;
-#if 0
-        if (!stway->isladder && stway->up)
-            cmap = S_upstair; /* "staircase up" */
-        else if (!stway->isladder && !stway->up)
-            cmap = S_dnstair; /* "staircase down" */
-        else if (stway->isladder && stway->up)
-            cmap = S_upladder; /* "ladder up" */
-        else if (stway->isladder && !stway->up)
-            cmap = S_dnladder; /* "ladder down" */
-#endif
     } else if (ltyp == DRAWBRIDGE_DOWN)
         cmap = S_vodbridge; /* "lowered drawbridge" */
     else if (ltyp == DBWALL)