chore: move safename enable logic into SafeNames

sdkrystian · sdkrystian · commit 2d3aa0b4759b · 2023-10-26T15:17:07.000-04:00
diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs
@@ -2,4 +2,4 @@
 {{#with symbol}}
 [#{{#if (is_multipage)}}{{id}}{{else}}{{ref}}{{/if}}]
 {{> (lookup . 'kind') symbol=.}}
-{{/with}}
+{{/with}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/declarator-before.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/declarator-before.adoc.hbs
@@ -14,7 +14,7 @@
 {{/if~}}
 {{#if symbol~}}
     {{#if (not parent-type)}}{{>qualified-path symbol=symbol.parent}}{{/if~}}
-    {{>xref symbol}}[{{name}}]{{else if name}}{{name~}}
+    xref:{{symbol.ref}}[{{name}}]{{else if name}}{{name~}}
 {{/if~}}
 {{#if (eq kind "specialization")}}{{>template-args args=args}}{{/if~}}
 {{#if is-pack~}}...{{/if}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/function-sig.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/function-sig.adoc.hbs
@@ -13,7 +13,7 @@
 {{>declarator-before return}}
 
 {{#if (eq template.kind "explicit")~}}
-    {{#if template.primary.id~}}{{>xref template.primary}}[{{name}}]{{else}}{{name}}{{/if~}}
+    {{#if template.primary.id~}}xref:{{template.primary.ref}}[{{name}}]{{else}}{{name}}{{/if~}}
     {{~>template-args args=template.args~}}
 {{else~}}
     {{name~}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/info-list.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/info-list.adoc.hbs
@@ -2,6 +2,6 @@
 |===
 |Name |Description
 {{#each .}}
-|{{>xref .}}[`pass:v[{{name}}]`] |{{doc.brief}}
+|xref:{{ref}}[`pass:v[{{name}}]`] |{{doc.brief}}
 {{/each}}
 |===
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs
@@ -5,6 +5,6 @@
 |===
 |Name |Description
 {{#each symbol.members}}
-|{{>xref .}}[`pass:v[{{name}}]`] |{{doc.brief}}
+|xref:{{ref}}[`pass:v[{{name}}]`] |{{doc.brief}}
 {{/each}}
 |===
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/qualified-path.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/qualified-path.adoc.hbs
@@ -3,5 +3,5 @@
 {{>qualified-path symbol=symbol.parent~}}
 {{else~}}
 {{/if~}}
-{{#if symbol.name}}{{>xref symbol}}[{{~symbol.name}}]::{{/if~}}
+{{#if symbol.name}}xref:{{symbol.ref}}[{{symbol.name}}]::{{/if~}}
 {{/unless}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs
@@ -10,7 +10,7 @@
 {{#if template}}{{>template-head symbol.template}}
 {{/if~}}
 {{#if (or (eq symbol.template.kind "explicit") (eq symbol.template.kind "partial"))~}}
-    {{symbol.tag}} {{#if symbol.template.primary.id~}}{{>xref symbol.template.primary}}[{{symbol.name}}]{{else}}{{symbol.name}}{{/if~}}
+    {{symbol.tag}} {{#if symbol.template.primary.id~}}xref:{{symbol.template.primary.ref}}[{{symbol.name}}]{{else}}{{symbol.name}}{{/if~}}
     {{~>template-args args=symbol.template.args~}}
 {{else~}}
     {{symbol.tag}} {{symbol.name~}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/template-arg.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/template-arg.adoc.hbs
@@ -3,6 +3,6 @@
 {{else if (eq kind "non-type")~}}
 {{~value~}}
 {{else if (eq kind "template")~}}
-{{#if template}}{{>xref template}}[{{name~}}]{{else~}}{{name~}}{{/if~}}
+{{#if template}}xref:{{template.ref}}[{{name~}}]{{else~}}{{name~}}{{/if~}}
 {{/if~}}
 {{~#if is-pack}}...{{/if~}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs
@@ -16,7 +16,7 @@
 {{#if symbol.isThreadLocal}}thread_local
 {{/if~}}
 {{#if (or (eq symbol.template.kind "explicit") (eq symbol.template.kind "partial"))~}}
-    {{>declarator-before symbol.type}} {{#if symbol.template.primary.id~}}{{>xref symbol.template.primary}}[{{symbol.name}}]{{else}}{{symbol.name}}{{/if~}}
+    {{>declarator-before symbol.type}} {{#if symbol.template.primary.id~}}xref:{{symbol.template.primary.ref}}[{{symbol.name}}]{{else}}{{symbol.name}}{{/if~}}
     {{~>template-args args=symbol.template.args~}}
 {{else~}}
     {{>declarator-before symbol.type}} {{symbol.name~}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/xref.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/xref.adoc.hbs
diff --git a/src/lib/-XML/XMLWriter.cpp b/src/lib/-XML/XMLWriter.cpp
@@ -170,7 +170,7 @@ writeIndex()
     tags_.open("symbols");
     if(options_.safe_names)
     {
-        SafeNames names(corpus_);
+        SafeNames names(corpus_, true);
         for(auto& I : corpus_)
         {
             auto safe_name = names.getUnqualified(I.id);
diff --git a/src/lib/-adoc/AdocCorpus.cpp b/src/lib/-adoc/AdocCorpus.cpp
@@ -366,12 +366,14 @@ std::string
 AdocCorpus::
 getXref(SymbolID const& id) const
 {
-    if(! safe_names)
-        // no safenames, use the SymbolID for references
-        return toBase16(id);
+    bool multipage = getCorpus().config->multiPage;
     // use '/' as the seperator for multi-page, and '-' for single-page
-    return safe_names->getQualified(id,
-        getCorpus().config->multiPage ? '/' : '-');
+    std::string xref = names_.getQualified(
+        id, multipage ? '/' : '-');
+    // add the file extension if in multipage mode
+    if(multipage)
+        xref.append(".adoc");
+    return xref;
 }
 
 dom::Value
diff --git a/src/lib/-adoc/AdocCorpus.hpp b/src/lib/-adoc/AdocCorpus.hpp
@@ -25,16 +25,15 @@ class AdocCorpus : public DomCorpus
 {
 public:
     Options options;
-    std::optional<SafeNames> safe_names;
+    SafeNames names_;
 
     AdocCorpus(
         Corpus const& corpus,
         Options&& opts)
         : DomCorpus(corpus)
         , options(std::move(opts))
+        , names_(corpus, options.safe_names)
     {
-        if(options.safe_names)
-            safe_names.emplace(corpus);
     }
 
     dom::Object
diff --git a/src/lib/-adoc/MultiPageVisitor.cpp b/src/lib/-adoc/MultiPageVisitor.cpp
@@ -38,9 +38,8 @@ renderPage(
         {
             auto pageText = builder(I).value();
 
-
             std::string fileName = files::appendPath(
-                outputPath_, builder.domCorpus.getXref(I.id) + ".adoc");
+                outputPath_, builder.domCorpus.getXref(I.id));
 
             std::string dir = files::getParentDir(fileName);
             if(auto err = files::createDirectory(dir))
diff --git a/src/lib/-bitcode/BitcodeGenerator.cpp b/src/lib/-bitcode/BitcodeGenerator.cpp
@@ -35,7 +35,7 @@ class MultiFileBuilder
         Corpus const& corpus)
         : corpus_(corpus)
         , outputPath_(outputPath)
-        , names_(corpus_)
+        , names_(corpus_, true)
         , taskGroup_(corpus.config.threadPool())
     {
     }
diff --git a/src/lib/Support/SafeNames.cpp b/src/lib/Support/SafeNames.cpp
@@ -355,9 +355,12 @@ class SafeNames::Impl
 //------------------------------------------------
 
 SafeNames::
-SafeNames(Corpus const& corpus)
-    : impl_(std::make_unique<Impl>(corpus, "index"))
+SafeNames(
+    Corpus const& corpus,
+    bool enabled)
 {
+    if(enabled)
+        impl_ = std::make_unique<Impl>(corpus, "index");
 }
 
 SafeNames::
@@ -368,6 +371,8 @@ SafeNames::
 getUnqualified(
     SymbolID const& id) const
 {
+    if(! impl_)
+        return toBase16(id);
     std::string result;
     impl_->getSafeUnqualified(result, id);
     return result;
@@ -379,6 +384,8 @@ getQualified(
     SymbolID const& id,
     char delim) const
 {
+    if(! impl_)
+        return toBase16(id);
     std::string result;
     impl_->getSafeQualified(result, id, delim);
     return result;
diff --git a/src/lib/Support/SafeNames.hpp b/src/lib/Support/SafeNames.hpp
@@ -40,8 +40,9 @@ class SafeNames
         Upon construction, the entire table of
         safe names is built from the corpus.
     */
-    explicit
-    SafeNames(Corpus const& corpus);
+    SafeNames(
+        Corpus const& corpus,
+        bool enabled);
 
     ~SafeNames() noexcept;
 
