feat: overload sets

cppalliance · Nov 21, 2023 · bbc08f1 · bbc08f1
1 parent a0c9d1d
commit bbc08f1
Show file tree

Hide file tree

Showing 39 changed files with 991 additions and 601 deletions.
diff --git a/include/mrdocs/Corpus.hpp b/include/mrdocs/Corpus.hpp
@@ -5,6 +5,7 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 // Copyright (c) 2023 Vinnie Falco ([email protected])
+// Copyright (c) 2023 Krystian Stasiowski ([email protected])
 //
 // Official repository: https://github.com/cppalliance/mrdocs
 //
@@ -101,6 +102,8 @@ class MRDOCS_VISIBLE
 
     //--------------------------------------------
 
+    // KRYSTIAN FIXME: this could just be a single
+    // overload constrained with std::derived_from<ScopeInfo>
     template<class F, class... Args>
     void traverse(
         NamespaceInfo const& I,
@@ -121,6 +124,36 @@ class MRDOCS_VISIBLE
         SpecializationInfo const& I,
         F&& f, Args&&... args) const;
 
+    template<class F, class... Args>
+    void traverse(
+        OverloadSet const& OS,
+        F&& f, Args&&... args) const;
+
+    template<class F, class... Args>
+    void traverseOverloads(
+        ScopeInfo const& S,
+        F&& f, Args&&... args) const;
+
+    template<class F, class... Args>
+    void traverseOverloads(
+        RecordInfo const& I,
+        F&& f, Args&&... args) const;
+
+    template<class F, class... Args>
+    void traverseOverloads(
+        NamespaceInfo const& I,
+        F&& f, Args&&... args) const;
+
+    template<class F, class... Args>
+    void traverseOverloads(
+        EnumInfo const& I,
+        F&& f, Args&&... args) const;
+
+    template<class F, class... Args>
+    void traverseOverloads(
+        SpecializationInfo const& I,
+        F&& f, Args&&... args) const;
+
     //--------------------------------------------
 
     // KRYSTIAN NOTE: temporary
@@ -163,9 +196,6 @@ traverse(
     for(auto const& id : I.Members)
         visit(get(id), std::forward<F>(f),
             std::forward<Args>(args)...);
-    for(auto const& id : I.Specializations)
-        visit(get(id), std::forward<F>(f),
-            std::forward<Args>(args)...);
 }
 
 template<class F, class... Args>
@@ -178,7 +208,16 @@ traverse(
     for(auto const& id : I.Members)
         visit(get(id), std::forward<F>(f),
             std::forward<Args>(args)...);
-    for(auto const& id : I.Specializations)
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverse(
+    EnumInfo const& I,
+    F&& f, Args&&... args) const
+{
+    for(auto const& id : I.Members)
         visit(get(id), std::forward<F>(f),
             std::forward<Args>(args)...);
 }
@@ -187,7 +226,7 @@ template<class F, class... Args>
 void
 Corpus::
 traverse(
-    EnumInfo const& I,
+    SpecializationInfo const& I,
     F&& f, Args&&... args) const
 {
     for(auto const& id : I.Members)
@@ -199,13 +238,138 @@ template<class F, class... Args>
 void
 Corpus::
 traverse(
+    OverloadSet const& OS,
+    F&& f, Args&&... args) const
+{
+    for(auto const& id : OS.Members)
+        visit(get(id), std::forward<F>(f),
+            std::forward<Args>(args)...);
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverseOverloads(
+    ScopeInfo const& S,
+    F&& f, Args&&... args) const
+{
+    for(const SymbolID& id : S.Members)
+    {
+        const Info& member = get(id);
+        const auto& lookup = S.Lookups.at(member.Name);
+        if(lookup.size() == 1 || member.Name.empty())
+        {
+            visit(member, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+        else if(lookup.front() == id)
+        {
+            OverloadSet overloads(member.Name,
+                member.Namespace.front(), lookup);
+            visit(overloads, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+    }
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverseOverloads(
+    RecordInfo const& I,
+    F&& f, Args&&... args) const
+{
+    for(const SymbolID& id : I.Members)
+    {
+        const Info& member = get(id);
+        const auto& lookup = I.Lookups.at(member.Name);
+        if(lookup.size() == 1 || member.Name.empty())
+        {
+            visit(member, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+        else if(lookup.front() == id)
+        {
+            OverloadSet overloads(member.Name, I.id, lookup);
+            visit(overloads, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+    }
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverseOverloads(
+    NamespaceInfo const& I,
+    F&& f, Args&&... args) const
+{
+    for(const SymbolID& id : I.Members)
+    {
+        const Info& member = get(id);
+        const auto& lookup = I.Lookups.at(member.Name);
+        if(lookup.size() == 1 || member.Name.empty())
+        {
+            visit(member, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+        else if(lookup.front() == id)
+        {
+            OverloadSet overloads(member.Name, I.id, lookup);
+            visit(overloads, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+    }
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverseOverloads(
+    EnumInfo const& I,
+    F&& f, Args&&... args) const
+{
+    for(const SymbolID& id : I.Members)
+    {
+        const Info& member = get(id);
+        const auto& lookup = I.Lookups.at(member.Name);
+        if(lookup.size() == 1 || member.Name.empty())
+        {
+            visit(member, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+        else if(lookup.front() == id)
+        {
+            OverloadSet overloads(member.Name, I.id, lookup);
+            visit(overloads, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+    }
+}
+
+template<class F, class... Args>
+void
+Corpus::
+traverseOverloads(
     SpecializationInfo const& I,
     F&& f, Args&&... args) const
 {
-    for(auto const& J : I.Members)
-        visit(get(J.Specialized),
-            std::forward<F>(f),
+    for(const SymbolID& id : I.Members)
+    {
+        const Info& member = get(id);
+        const auto& lookup = I.Lookups.at(member.Name);
+        if(lookup.size() == 1 || member.Name.empty())
+        {
+            visit(member, std::forward<F>(f),
+                std::forward<Args>(args)...);
+        }
+        else if(lookup.front() == id)
+        {
+            OverloadSet overloads(member.Name, I.id, lookup);
+            visit(overloads, std::forward<F>(f),
                 std::forward<Args>(args)...);
+        }
+    }
 }
 
 class Corpus::iterator

diff --git a/include/mrdocs/Metadata/DomMetadata.hpp b/include/mrdocs/Metadata/DomMetadata.hpp
@@ -4,6 +4,7 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 // Copyright (c) 2023 Vinnie Falco ([email protected])
+// Copyright (c) 2023 Krystian Stasiowski ([email protected])
 //
 // Official repository: https://github.com/cppalliance/mrdocs
 //
@@ -53,6 +54,14 @@ class MRDOCS_DECL
     */
     Corpus const& getCorpus() const;
 
+    /** Returns the Corpus associated with the Dom.
+    */
+    Corpus const& operator*() const;
+
+    /** Returns the Corpus associated with the Dom.
+    */
+    Corpus const* operator->() const;
+
     /** Construct a Dom object representing the given symbol.
 
         This function is called internally when a `dom::Object`
@@ -84,6 +93,17 @@ class MRDOCS_DECL
     dom::Value
     getJavadoc(
         Javadoc const& jd) const;
+
+    /** Return a Dom value representing an overload set.
+
+        A @ref Generator should override this member
+        and return suitable @ref dom::Value representing
+        the overload set.
+    */
+    virtual
+    dom::Object
+    getOverloads(
+        OverloadSet const& os) const;
 };
 
 } // mrdocs

diff --git a/include/mrdocs/Metadata/Enum.hpp b/include/mrdocs/Metadata/Enum.hpp
@@ -15,6 +15,7 @@
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/Metadata/Expression.hpp>
 #include <mrdocs/Metadata/Javadoc.hpp>
+#include <mrdocs/Metadata/Scope.hpp>
 #include <mrdocs/Metadata/Source.hpp>
 #include <mrdocs/Metadata/Type.hpp>
 #include <optional>
@@ -30,6 +31,7 @@ namespace mrdocs {
 struct EnumInfo
     : IsInfo<InfoKind::Enum>
     , SourceInfo
+    , ScopeInfo
 {
     // Indicates whether this enum is scoped (e.g. enum class).
     bool Scoped = false;
@@ -39,9 +41,6 @@ struct EnumInfo
     // this will be "short".
     std::unique_ptr<TypeInfo> UnderlyingType;
 
-    // Enumeration members.
-    std::vector<SymbolID> Members;
-
     //--------------------------------------------
 
     explicit EnumInfo(SymbolID ID) noexcept

diff --git a/include/mrdocs/Metadata/Interface.hpp b/include/mrdocs/Metadata/Interface.hpp
@@ -56,6 +56,9 @@ class Interface
     */
     Tranche Private;
 
+    ScopeInfo Overloads;
+    ScopeInfo StaticOverloads;
+
     MRDOCS_DECL
     friend
     Interface

diff --git a/include/mrdocs/Metadata/Namespace.hpp b/include/mrdocs/Metadata/Namespace.hpp
@@ -13,8 +13,9 @@
 #define MRDOCS_API_METADATA_NAMESPACE_HPP
 
 #include <mrdocs/Platform.hpp>
-#include <mrdocs/Metadata/Info.hpp>
 #include <mrdocs/ADT/BitField.hpp>
+#include <mrdocs/Metadata/Info.hpp>
+#include <mrdocs/Metadata/Scope.hpp>
 #include <vector>
 
 namespace clang {
@@ -32,10 +33,8 @@ union NamespaceFlags
 */
 struct NamespaceInfo
     : IsInfo<InfoKind::Namespace>
+    , ScopeInfo
 {
-    std::vector<SymbolID> Members;
-    std::vector<SymbolID> Specializations;
-
     NamespaceFlags specs;
 
     //--------------------------------------------