refactor: don't represent using-directives as Info

sdkrystian · sdkrystian · commit c4441d41c6cf · 2024-05-30T10:52:46.000-04:00
diff --git a/include/mrdocs/Metadata/Info.hpp b/include/mrdocs/Metadata/Info.hpp
@@ -69,7 +69,7 @@ enum class InfoKind
     Guide,
     /// The symbol is a namespace alias
     Alias,
-    /// The symbol is a using declaration and using directive
+    /// The symbol is a using declaration
     Using,
 };
 
@@ -187,7 +187,7 @@ struct MRDOCS_VISIBLE
     /// Determine if this symbol is a namespace alias.
     constexpr bool isAlias()          const noexcept { return Kind == InfoKind::Alias; }
 
-    /// Determine if this symbol is a using declaration or using directive.
+    /// Determine if this symbol is a using declaration.
     constexpr bool isUsing()          const noexcept { return Kind == InfoKind::Using; }
 };
 
@@ -245,7 +245,7 @@ struct IsInfo : Info
     /// Determine if this symbol is a namespace alias.
     static constexpr bool isAlias()          noexcept { return K == InfoKind::Alias; }
 
-    /// Determine if this symbol is a using declaration or using directive.
+    /// Determine if this symbol is a using declaration.
     static constexpr bool isUsing()          noexcept { return K == InfoKind::Using; }
 
 protected:
diff --git a/include/mrdocs/Metadata/Namespace.hpp b/include/mrdocs/Metadata/Namespace.hpp
@@ -37,6 +37,10 @@ struct NamespaceInfo
 {
     NamespaceFlags specs;
 
+    /** Namespaces nominated by using-directives.
+    */
+    std::vector<SymbolID> UsingDirectives;
+
     //--------------------------------------------
 
     explicit NamespaceInfo(SymbolID ID) noexcept
diff --git a/include/mrdocs/Metadata/Using.hpp b/include/mrdocs/Metadata/Using.hpp
@@ -26,7 +26,6 @@ enum class UsingClass
     Normal = 0,     // using
     Typename,       // using typename
     Enum,           // using enum
-    Namespace       // using namespace (using directive)
 };
 
 static constexpr
@@ -38,24 +37,26 @@ toString(UsingClass const& value)
     case UsingClass::Normal:    return "normal";
     case UsingClass::Typename:  return "typename";
     case UsingClass::Enum:      return "enum";
-    case UsingClass::Namespace: return "namespace";
     }
     return "unknown";
 }
 
-/** Info for using declarations and directives.
+/** Info for using declarations.
  */
 struct UsingInfo
     : IsInfo<InfoKind::Using>,
     SourceInfo
 {
-    /** The kind of using declaration/directive. */
+    /** The kind of using declaration.
+    */
     UsingClass Class = UsingClass::Normal;
 
-    /** The symbols being "used". */
+    /** The symbols being "used".
+    */
     std::vector<SymbolID> UsingSymbols;
 
-    /** The qualifier for a using declaration/directive. */
+    /** The qualifier for a using declaration.
+    */
     std::unique_ptr<NameInfo> Qualifier;
 
     //--------------------------------------------
diff --git a/mrdocs.rnc b/mrdocs.rnc
@@ -35,6 +35,7 @@ grammar
             attribute is-inline { "1" }?,
             attribute is-anonymous { "1" }?,
             Javadoc?,
+            element using-directive { ID } *,
             Scope
         }
 
@@ -238,7 +239,7 @@ grammar
             ID,
             Location *,
             Javadoc ?,
-            attribute class { "using" | "using typename" | "using enum" | "using namespace" },
+            attribute class { "using" | "using typename" | "using enum" },
             attribute qualifier { text } ?,
             element named { ID } *
         }
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/signature/using.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/signature/using.adoc.hbs
@@ -1,5 +1 @@
-{{#if (eq symbol.class "namespace")}}
-using namespace {{#if symbol.qualifier}}{{>name-info symbol.qualifier}}::{{/if}}{{symbol.name}}
-{{else}}
-using {{#if (eq symbol.class "typename")}}typename {{/if}}{{#if (eq symbol.class "enum")}}enum {{/if}}{{#if symbol.qualifier}}{{>name-info symbol.qualifier}}::{{/if}}{{symbol.name}}
-{{/if}}
+using {{#if (eq symbol.class "typename")}}typename {{/if}}{{#if (eq symbol.class "enum")}}enum {{/if}}{{#if symbol.qualifier}}{{>name-info symbol.qualifier}}::{{/if}}{{symbol.name~}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/symbols/namespace.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/symbols/namespace.adoc.hbs
@@ -2,3 +2,5 @@
 = {{#if symbol.name}}Namespace {{>nested-name-specifier symbol=symbol.parent}}{{symbol.name}}{{else if symbol.parent}}Unnamed namespace{{else}}Global namespace{{/if}}
 
 {{> tranche tranche=symbol.interface label="" is-namespace=true}}
+
+{{>info-list members=symbol.usingDirectives title="Using Directives"}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/symbols/using.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/symbols/using.adoc.hbs
@@ -1,5 +1,5 @@
 {{!-- symbols/using.adoc.hbs --}}
-= Using {{#if (eq symbol.class "namespace")}}Directive: {{symbol.qualifier.name}}{{else}}Declaration: {{symbol.name}}{{/if}}
+= Using Declaration {{symbol.name}}
 
 {{symbol.doc.brief}}
 
@@ -19,13 +19,14 @@
 
 {{/if}}
 
-{{#unless (eq symbol.class "namespace")}}
+{{#if symbol.shadows}}
 == Introduced Symbols
 
 |===
 | Name
-{{#each symbol.symbols}}
+{{#each symbol.shadows}}
 | {{name}}
 {{/each}}
 |===
-{{/unless}}
+
+{{/if}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs
@@ -11,6 +11,6 @@
 {{>info-list members=tranche.variables title=(concat label " " "Static Data Members")}}
 {{>info-list members=tranche.friends title=(concat label " " "Friends")}}
 {{>info-list members=tranche.aliases title=(concat label " " "Aliases")}}
-{{>info-list members=tranche.usings title=(concat label " " "Usings Declarations/Directives")}}
+{{>info-list members=tranche.usings title=(concat label " " "Usings Declarations")}}
 {{/if}}
 {{>info-list members=tranche.guides title=(concat label " " "Deduction Guides")}}
diff --git a/src/lib/AST/ASTVisitor.cpp b/src/lib/AST/ASTVisitor.cpp
@@ -436,6 +436,8 @@ class ASTVisitor
     std::pair<InfoTy&, bool>
     getOrCreateInfo(const SymbolID& id)
     {
+        assert(id != SymbolID::invalid &&
+            "creating symbol with invalid SymbolID?");
         Info* info = getInfo(id);
         bool created = ! info;
         if(! info)
@@ -535,17 +537,6 @@ class ASTVisitor
             return false;
         }
 
-        // Handling UsingDirectiveDecl
-        if (const auto* UDD = dyn_cast<UsingDirectiveDecl>(D))
-        {
-            if (index::generateUSRForDecl(UDD->getNominatedNamespace(), usr_)) {
-                return true;
-            }
-            usr_.append("@UD");
-            usr_.append(UDD->getQualifiedNameAsString());
-            return false;
-        }
-
         // Handling UsingDecl
         if (const auto* UD = dyn_cast<UsingDecl>(D))
         {
@@ -2194,39 +2185,6 @@ class ASTVisitor
         getParentNamespaces(I, D);
     }
 
-
-    //------------------------------------------------
-
-    void
-    buildUsingDirective(
-        UsingInfo& I,
-        bool created,
-        UsingDirectiveDecl* D)
-    {
-        bool documented = parseRawComment(I.javadoc, D);
-        addSourceLocation(I, D->getBeginLoc(), true, documented);
-
-        if(! created)
-            return;
-
-        I.Class = UsingClass::Namespace;
-
-        if (D->getQualifier())
-        {
-            I.Qualifier = buildNameInfo(D->getQualifier());
-        }
-
-        if (NamedDecl* ND = D->getNominatedNamespace())
-        {
-            I.Name = extractName(ND);
-            SymbolID id;
-            getDependencyID(ND, id);
-            I.UsingSymbols.emplace_back(id);
-        }
-        getParentNamespaces(I, D);
-    }
-
-
     //------------------------------------------------
 
     void
@@ -2601,12 +2559,23 @@ void
 ASTVisitor::
 traverse(UsingDirectiveDecl* D)
 {
-    auto exp = getAsMrDocsInfo(D);
-    if(! exp) { return; }
-    auto [I, created] = *exp;
-    buildUsingDirective(I, created, D);
-}
+    if(! shouldExtract(D, getAccess(D)))
+        return;
 
+    Decl* PD = getParentDecl(D);
+    // only extract using-directives in namespace scope
+    if(! cast<DeclContext>(PD)->isFileContext())
+        return;
+
+    if(Info* PI = getInfo(extractSymbolID(PD)))
+    {
+        assert(PI->isNamespace());
+        NamespaceInfo* NI = static_cast<NamespaceInfo*>(PI);
+        getDependencyID(
+            D->getNominatedNamespaceAsWritten(),
+            NI->UsingDirectives.emplace_back());
+    }
+}
 
 //------------------------------------------------
 // UsingDecl
diff --git a/src/lib/AST/ASTVisitorHelpers.hpp b/src/lib/AST/ASTVisitorHelpers.hpp
@@ -58,9 +58,6 @@ struct MrDocsType<CXXDeductionGuideDecl> : std::type_identity<GuideInfo> {};
 template <>
 struct MrDocsType<NamespaceAliasDecl> : std::type_identity<AliasInfo> {};
 
-template <>
-struct MrDocsType<UsingDirectiveDecl> : std::type_identity<UsingInfo> {};
-
 template <>
 struct MrDocsType<UsingDecl> : std::type_identity<UsingInfo> {};
 
diff --git a/src/lib/AST/AnyBlock.hpp b/src/lib/AST/AnyBlock.hpp
@@ -1467,6 +1467,8 @@ class NamespaceBlock
         {
         case NAMESPACE_BITS:
             return decodeRecord(R, {&I->specs.raw}, Blob);
+        case NAMESPACE_USING_DIRECTIVES:
+            return decodeRecord(R, I->UsingDirectives, Blob);
         default:
             return TopLevelBlock::parseRecord(R, ID, Blob);
         }
diff --git a/src/lib/AST/BitcodeIDs.hpp b/src/lib/AST/BitcodeIDs.hpp
@@ -109,6 +109,7 @@ enum RecordID
     NAME_INFO_NAME,
 
     NAMESPACE_BITS,
+    NAMESPACE_USING_DIRECTIVES,
     TYPEINFO_KIND,
     TYPEINFO_IS_PACK,
     TYPEINFO_CVQUAL,
diff --git a/src/lib/AST/BitcodeWriter.cpp b/src/lib/AST/BitcodeWriter.cpp
@@ -329,6 +329,7 @@ RecordIDNameMap = []()
         {JAVADOC_NODE_SYMBOLREF, {"JavadocNodeSymbol", &SymbolIDAbbrev}},
         {JAVADOC_PARAM_DIRECTION, {"JavadocParamDirection", &Integer32Abbrev}},
         {NAMESPACE_BITS, {"NamespaceBits", &Integer32ArrayAbbrev}},
+        {NAMESPACE_USING_DIRECTIVES, {"NamespaceUsingDirectives", &SymbolIDsAbbrev}},
         {NAME_INFO_KIND, {"NameKind", &Integer32Abbrev}},
         {NAME_INFO_ID, {"NameID", &SymbolIDAbbrev}},
         {NAME_INFO_NAME, {"NameName", &StringAbbrev}},
@@ -426,7 +427,7 @@ RecordsByBlock{
         JAVADOC_NODE_PART, JAVADOC_NODE_SYMBOLREF}},
     // NamespaceInfo
     {BI_NAMESPACE_BLOCK_ID,
-        {NAMESPACE_BITS}},
+        {NAMESPACE_BITS, NAMESPACE_USING_DIRECTIVES}},
     // RecordInfo
     {BI_RECORD_BLOCK_ID,
         {RECORD_KEY_KIND, RECORD_IS_TYPE_DEF, RECORD_BITS}},
@@ -1108,6 +1109,7 @@ emitBlock(
     emitInfoPart(I);
     emitScopeInfo(I);
     emitRecord({I.specs.raw}, NAMESPACE_BITS);
+    emitRecord(I.UsingDirectives, NAMESPACE_USING_DIRECTIVES);
 }
 
 void
diff --git a/src/lib/Gen/xml/XMLWriter.cpp b/src/lib/Gen/xml/XMLWriter.cpp
@@ -209,6 +209,8 @@ operator()(
             { "is-inline", "1", I.specs.isInline}
             });
         writeJavadoc(I.javadoc);
+        for(const SymbolID& id : I.UsingDirectives)
+            tags_.write("using-directive", {}, { { id } });
         corpus_.traverse(I, *this);
         tags_.close(namespaceTagName);
     }
@@ -425,9 +427,6 @@ XMLWriter::
     case UsingClass::Enum:
         classStr = "using enum";
         break;
-    case UsingClass::Namespace:
-        classStr = "using namespace";
-        break;
     default:
         MRDOCS_UNREACHABLE();
     }
diff --git a/src/lib/Metadata/DomMetadata.cpp b/src/lib/Metadata/DomMetadata.cpp
@@ -737,6 +737,8 @@ DomInfo<T>::construct() const
             std::make_shared<Tranche>(
                 makeTranche(I_, *domCorpus_)),
             domCorpus_));
+        entries.emplace_back("usingDirectives", dom::newArray<DomSymbolArray>(
+            I_.UsingDirectives, domCorpus_));
     }
     if constexpr(T::isRecord())
     {
@@ -875,11 +877,8 @@ DomInfo<T>::construct() const
     if constexpr(T::isUsing())
     {
         entries.emplace_back("class", toString(I_.Class));
-        entries.emplace_back("symbols", dom::newArray<DomSymbolArray>(I_.UsingSymbols, domCorpus_));
-        if (I_.Qualifier)
-        {
-            entries.emplace_back("qualifier", domCreate(I_.Qualifier, domCorpus_));
-        }
+        entries.emplace_back("shadows", dom::newArray<DomSymbolArray>(I_.UsingSymbols, domCorpus_));
+        entries.emplace_back("qualifier", domCreate(I_.Qualifier, domCorpus_));
     }
     if constexpr(T::isEnumerator())
     {
diff --git a/src/lib/Metadata/Finalize.cpp b/src/lib/Metadata/Finalize.cpp
@@ -274,6 +274,7 @@ class Finalizer
         check(I.Namespace);
         check(I.Members);
         finalize(I.javadoc);
+        finalize(I.UsingDirectives);
         // finalize(I.Specializations);
     }
 
diff --git a/src/lib/Metadata/Reduce.cpp b/src/lib/Metadata/Reduce.cpp
@@ -163,6 +163,8 @@ void merge(NamespaceInfo& I, NamespaceInfo&& Other)
     I.specs.raw.value |= Other.specs.raw.value;
     mergeScopeInfo(I, std::move(Other));
     mergeInfo(I, std::move(Other));
+    reduceSymbolIDs(I.UsingDirectives,
+        std::move(Other.UsingDirectives));
 }
 
 void merge(RecordInfo& I, RecordInfo&& Other)
diff --git a/src/lib/Support/SafeNames.cpp b/src/lib/Support/SafeNames.cpp
@@ -208,11 +208,9 @@ class SafeNames::Impl
                     return t.Name;
                 }
 
-                if constexpr(T::isUsing()) {
+                if constexpr(T::isUsing())
+                {
                     MRDOCS_ASSERT(! t.Name.empty());
-                    if (t.Class == UsingClass::Namespace) {
-                        return getReserved(t);
-                    }
                     return t.Name;
                 }
 
diff --git a/test-files/old-tests/using-1.xml b/test-files/old-tests/using-1.xml
@@ -2,11 +2,8 @@
 <mrdocs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://github.com/cppalliance/mrdocs/raw/develop/mrdocs.rnc">
 <namespace id="//////////////////////////8=">
+  <using-directive id="IjtkITsyqdEWPMXZF3lD/2/XH0s="/>
   <namespace name="LongName" id="IjtkITsyqdEWPMXZF3lD/2/XH0s=">
   </namespace>
-  <using id="0dkQs6+jYNOCUA7aOGsT92PFOfk=" class="using namespace">
-    <file path="using-1.cpp" line="3" class="def"/>
-    <named id="IjtkITsyqdEWPMXZF3lD/2/XH0s="/>
-  </using>
 </namespace>
 </mrdocs>

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,10 @@ struct NamespaceInfo`
`37`	`37`	`{`
`38`	`38`	`NamespaceFlags specs;`
`39`	`39`
	`40`	`+ /** Namespaces nominated by using-directives.`
	`41`	`+ */`
	`42`	`+ std::vector<SymbolID> UsingDirectives;`
	`43`	`+`
`40`	`44`	`//--------------------------------------------`
`41`	`45`
`42`	`46`	`explicit NamespaceInfo(SymbolID ID) noexcept`