Add help links to rendered indexes

Author: gtaylor

src/mux/help/help_render.c

@@ -98,6 +98,15 @@ static void help_text_buffer_append_quoted(HelpTextBuffer *buffer,
   }
 }
 
+static void help_text_buffer_append_help_link(HelpTextBuffer *buffer,
+                                              const char *topic) {
+  help_text_buffer_append_str(buffer, "[send=\"help ");
+  help_text_buffer_append_quoted(buffer, topic);
+  help_text_buffer_append_str(buffer, "\"]");
+  help_text_buffer_append_code(buffer, topic);
+  help_text_buffer_append_str(buffer, "[/]");
+}
+
 static void help_render_ensure_blank_line(HelpTextBuffer *buffer) {
   if (buffer->length == 0)
     return;
@@ -170,10 +179,12 @@ static void help_render_index_section(const HelpIndex *index,
   help_render_ensure_blank_line(out);
   if (index_article->index_style == HELP_INDEX_STYLE_COLUMNAR) {
     for (i = 0; i < count; i++) {
-      char column[32];
+      const char *topic = entries[i]->keywords.items[0];
+      size_t topic_length = strlen(topic);
 
-      snprintf(column, sizeof(column), "%-20s", entries[i]->keywords.items[0]);
-      help_text_buffer_append_str(out, column);
+      help_text_buffer_append_help_link(out, topic);
+      for (size_t padding = topic_length; padding < 20; padding++)
+        help_text_buffer_append_str(out, " ");
       if ((i + 1) % 3 == 0)
         help_text_buffer_append_str(out, "\n");
     }
@@ -187,11 +198,15 @@ static void help_render_index_section(const HelpIndex *index,
       help_text_buffer_append_str(out, header);
     }
     for (i = 0; i < count; i++) {
-      char line[256];
+      const char *topic = entries[i]->keywords.items[0];
+      size_t topic_length = strlen(topic);
 
-      snprintf(line, sizeof(line), "%-20s %s\n", entries[i]->keywords.items[0],
-               entries[i]->description);
-      help_text_buffer_append_str(out, line);
+      help_text_buffer_append_help_link(out, topic);
+      for (size_t padding = topic_length; padding < 20; padding++)
+        help_text_buffer_append_str(out, " ");
+      help_text_buffer_append_str(out, " ");
+      help_text_buffer_append_str(out, entries[i]->description);
+      help_text_buffer_append_str(out, "\n");
     }
   }
   free(entries);

tests/help_render.c

@@ -1,36 +1,37 @@
 /* help_render.c -- Plain-text markdown rendering unit test */
 
+#include <stdlib.h>
 #include <string.h>
 
 #include "mux/help/help_index.h"
 #include "mux/help/help_render.h"
 #include "mux/help/help_types.h"
 #include "mux/server/game.h"
 
-/*
- * help_render_markdown() never calls these (the render test never invokes
- * help_article_render_body or help_render_send), but the object file
- * references them; stub them out so this test can link help_render.c
- * without pulling in help_index.c and its server-wide dependencies.
- */
+static const HelpArticle *test_articles;
+static size_t test_article_count;
+
 char *help_index_read_body(const HelpIndex *index, const HelpArticle *article,
                            size_t *out_length) {
   (void)index;
   (void)article;
-  (void)out_length;
-  return nullptr;
+  char *body = malloc(1);
+
+  body[0] = '\0';
+  if (out_length)
+    *out_length = 0;
+  return body;
 }
 
 size_t help_index_article_count(const HelpIndex *index) {
   (void)index;
-  return 0;
+  return test_article_count;
 }
 
 const HelpArticle *help_index_article_at(const HelpIndex *index,
                                          size_t article_index) {
   (void)index;
-  (void)article_index;
-  return nullptr;
+  return &test_articles[article_index];
 }
 
 void notify_checked(EvaluationContext *evaluation, DbRef target, DbRef sender,
@@ -53,6 +54,47 @@ static int help_render_test_expect(const char *markdown, const char *expected) {
   return ok;
 }
 
+static int help_render_test_index_links(void) {
+  char *index_tags[] = {"index-entry"};
+  char *index_keywords[] = {"index"};
+  char *topic_tags[] = {"index-entry"};
+  char *topic_keywords[] = {"topic name"};
+  HelpArticle articles[] = {
+      {
+          .keywords = {.items = index_keywords, .count = 1},
+          .show_index_for_article_tags = {.items = index_tags, .count = 1},
+      },
+      {
+          .description = "A linked help topic.",
+          .keywords = {.items = topic_keywords, .count = 1},
+          .article_tags = {.items = topic_tags, .count = 1},
+      },
+  };
+  HelpTextBuffer buffer;
+  int ok;
+
+  test_articles = articles;
+  test_article_count = sizeof(articles) / sizeof(articles[0]);
+  help_text_buffer_init(&buffer);
+  help_article_render_body(nullptr, &articles[0], false, &buffer);
+  ok = buffer.data != nullptr &&
+       !strcmp(buffer.data,
+               "TOPIC                DESCRIPTION\n"
+               "[send=\"help topic name\"]topic name[/]           "
+               "A linked help topic.\n");
+  help_text_buffer_free(&buffer);
+  articles[0].index_style = HELP_INDEX_STYLE_COLUMNAR;
+  help_text_buffer_init(&buffer);
+  help_article_render_body(nullptr, &articles[0], false, &buffer);
+  ok = ok && buffer.data != nullptr &&
+       !strcmp(buffer.data,
+               "[send=\"help topic name\"]topic name[/]          \n");
+  help_text_buffer_free(&buffer);
+  test_articles = nullptr;
+  test_article_count = 0;
+  return ok;
+}
+
 int main(void) {
   if (!help_render_test_expect("# Header 1\n\nContent here\n\n## Header 2\n",
                                "# Header 1\n\nContent here\n\n## Header 2"))
@@ -76,5 +118,7 @@ int main(void) {
                                "```\n",
                                "@name drone=[[fg=bright-cyan]Aegis[[/]\n"))
     return 6;
+  if (!help_render_test_index_links())
+    return 8;
   return 0;
 }