Skip to content

fix: group overloads per access level #895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions include/mrdocs/Metadata/Info/Overloads.hpp
Original file line number Diff line number Diff line change
@@ -12,7 +12,8 @@
#define MRDOCS_API_METADATA_OVERLOADS_HPP

#include <mrdocs/Platform.hpp>
#include <ranges>
#include <mrdocs/Metadata/Info.hpp>
#include <mrdocs/Metadata/Info/Function.hpp>

namespace clang::mrdocs {

@@ -41,7 +42,7 @@ struct OverloadsInfo final
}

explicit
OverloadsInfo(SymbolID const& Parent, std::string_view Name) noexcept;
OverloadsInfo(SymbolID const& Parent, std::string_view Name, AccessKind Access, bool isStatic) noexcept;
};

MRDOCS_DECL
2 changes: 2 additions & 0 deletions include/mrdocs/Metadata/Javadoc.hpp
Original file line number Diff line number Diff line change
@@ -891,6 +891,8 @@ struct Brief final : Paragraph
operator=(text);
}

Brief(Brief const& other) = default;

Brief&
operator=(Brief const& other) = default;

21 changes: 11 additions & 10 deletions src/lib/Metadata/Finalizers/OverloadsFinalizer.cpp
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@
//

#include "OverloadsFinalizer.hpp"
#include <mrdocs/Support/Assert.hpp>

namespace clang::mrdocs {

@@ -93,7 +94,7 @@ findBaseClassPermutation(

void
OverloadsFinalizer::
foldOverloads(SymbolID const& contextId, std::vector<SymbolID>& functionIds)
foldOverloads(SymbolID const& contextId, std::vector<SymbolID>& functionIds, bool isStatic)
{
for (auto functionIdIt = functionIds.begin();
functionIdIt != functionIds.end();
@@ -153,7 +154,7 @@ foldOverloads(SymbolID const& contextId, std::vector<SymbolID>& functionIds)
// FunctionInfo is not unique and there's no equivalent
// overload set in base classes, so we merge it with the
// other FunctionInfos into a new OverloadsInfo
OverloadsInfo O(contextId, function->Name);
OverloadsInfo O(contextId, function->Name, function->Access, isStatic);
addMember(O, *function);
*functionIdIt = O.id;
auto const itOffset = functionIdIt - functionIds.begin();
@@ -170,15 +171,15 @@ foldOverloads(SymbolID const& contextId, std::vector<SymbolID>& functionIds)
}
}
functionIdIt = functionIds.begin() + itOffset;
corpus_.info_.emplace(std::make_unique<OverloadsInfo>(std::move(O)));
MRDOCS_ASSERT(corpus_.info_.emplace(std::make_unique<OverloadsInfo>(std::move(O))).second);
}
}

void
OverloadsFinalizer::
operator()(NamespaceInfo& I)
{
foldOverloads(I.id, I.Members.Functions);
foldOverloads(I.id, I.Members.Functions, true);
foldRecordMembers(I.Members.Records);
foldNamespaceMembers(I.Members.Namespaces);
}
@@ -203,12 +204,12 @@ operator()(RecordInfo& I)
MRDOCS_CHECK_OR(baseRecord);
operator()(*baseRecord);
}
foldOverloads(I.id, I.Interface.Public.Functions);
foldOverloads(I.id, I.Interface.Protected.Functions);
foldOverloads(I.id, I.Interface.Private.Functions);
foldOverloads(I.id, I.Interface.Public.StaticFunctions);
foldOverloads(I.id, I.Interface.Protected.StaticFunctions);
foldOverloads(I.id, I.Interface.Private.StaticFunctions);
foldOverloads(I.id, I.Interface.Public.Functions, false);
foldOverloads(I.id, I.Interface.Protected.Functions, false);
foldOverloads(I.id, I.Interface.Private.Functions, false);
foldOverloads(I.id, I.Interface.Public.StaticFunctions, true);
foldOverloads(I.id, I.Interface.Protected.StaticFunctions, true);
foldOverloads(I.id, I.Interface.Private.StaticFunctions, true);
foldRecordMembers(I.Interface.Public.Records);
foldRecordMembers(I.Interface.Protected.Records);
foldRecordMembers(I.Interface.Private.Records);
3 changes: 2 additions & 1 deletion src/lib/Metadata/Finalizers/OverloadsFinalizer.hpp
Original file line number Diff line number Diff line change
@@ -38,7 +38,8 @@ class OverloadsFinalizer
void
foldOverloads(
SymbolID const& contextId,
std::vector<SymbolID>& functionIds);
std::vector<SymbolID>& functionIds,
bool isStatic);

public:
OverloadsFinalizer(CorpusImpl& corpus)
4 changes: 2 additions & 2 deletions src/lib/Metadata/Info/Overloads.cpp
Original file line number Diff line number Diff line change
@@ -21,10 +21,10 @@
namespace clang::mrdocs {

OverloadsInfo::
OverloadsInfo(SymbolID const& Parent, std::string_view Name) noexcept
OverloadsInfo(SymbolID const& Parent, std::string_view Name, AccessKind access, bool isStatic) noexcept
: InfoCommonBase(
SymbolID::createFromString(
fmt::format("{}-{}", toBase16(Parent), Name)))
fmt::format("{}-{}-{}-{}", toBase16(Parent), Name, toString(access), isStatic)))
{
this->Parent = Parent;
}
4 changes: 2 additions & 2 deletions test-files/golden-tests/config/overloads/const-mutable.adoc
Original file line number Diff line number Diff line change
@@ -30,11 +30,11 @@ class C;
|===
| Name
| Description
| <<C-foo-01,`foo`>>
| <<C-foo-0e,`foo`>>
|
|===

[#C-foo-01]
[#C-foo-0e]
== <<C,C>>::foo

=== Synopses
4 changes: 2 additions & 2 deletions test-files/golden-tests/config/overloads/const-mutable.html
Original file line number Diff line number Diff line change
@@ -47,7 +47,7 @@ <h2>Member Functions</h2>
</thead>
<tbody>
<tr>
<td><a href="#C-foo-01"><code>foo</code></a> </td><td><span></span></td></tr>
<td><a href="#C-foo-0e"><code>foo</code></a> </td><td><span></span></td></tr>
</tbody>
</table>

@@ -56,7 +56,7 @@ <h2>Member Functions</h2>
</div>
<div>
<div>
<h2 id="C-foo-01"><a href="#C">C</a>::foo</h2>
<h2 id="C-foo-0e"><a href="#C">C</a>::foo</h2>
</div>
<div>
<h3>Synopses</h3>
Loading
Loading