refactor: metadata base classes do not expose constructors

Author: alandefreitas

include/mrdocs/Corpus.hpp

@@ -272,9 +272,7 @@ class MRDOCS_VISIBLE
                         {
                             return std::is_lt(cmp);
                         }
-                        return std::is_lt(
-                            CompareDerived(Polymorphic<Info>(lhsInfo),
-                                           Polymorphic<Info>(rhsInfo)));
+                        return std::is_lt(CompareDerived(lhsInfo, rhsInfo));
                     });
                 if (!opts.skipInherited)
                 {

include/mrdocs/Metadata/Info/InfoBase.hpp

@@ -84,26 +84,6 @@ struct MRDOCS_VISIBLE Info
 
     ~Info() override = default;
 
-    Info(Info const& Other) = default;
-
-    /** Move constructor.
-     */
-    Info(Info&& Other) = default;
-
-    /** Construct an Info.
-
-        @param kind The kind of symbol
-        @param ID The unique identifier for this symbol
-    */
-    explicit
-    Info(
-        InfoKind const kind,
-        SymbolID const& ID) noexcept
-        : id(ID)
-        , Kind(kind)
-    {
-    }
-
     #define INFO(Type) constexpr bool is##Type() const noexcept { \
         return Kind == InfoKind::Type; \
     }
@@ -152,8 +132,27 @@ struct MRDOCS_VISIBLE Info
     auto operator<=>(Info const&) const = default;
 
 protected:
-    Info() = default;
+    constexpr Info() = default;
 
+    Info(Info const& Other) = default;
+
+    /** Move constructor.
+     */
+    Info(Info&& Other) = default;
+
+    /** Construct an Info.
+
+        @param kind The kind of symbol
+        @param ID The unique identifier for this symbol
+    */
+    explicit
+        Info(
+            InfoKind const kind,
+            SymbolID const& ID) noexcept
+        : id(ID)
+        , Kind(kind)
+    {
+    }
 };
 
 //------------------------------------------------

include/mrdocs/Metadata/Javadoc/Block/BlockBase.hpp

@@ -17,8 +17,8 @@
 #include <mrdocs/Dom.hpp>
 #include <mrdocs/Dom/LazyArray.hpp>
 #include <mrdocs/Dom/LazyObject.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline.hpp>
 #include <mrdocs/Metadata/Javadoc/Node/NodeBase.hpp>
-#include <mrdocs/Metadata/Javadoc/Text.hpp>
 #include <algorithm>
 #include <string>
 
@@ -94,6 +94,9 @@ struct MRDOCS_DECL
     void append(std::vector<Polymorphic<Text>> const& otherChildren);
 
 protected:
+    constexpr
+    Block() = default;
+
     explicit
     Block(
         NodeKind const kind_,

include/mrdocs/Metadata/Javadoc/Text.hpp renamed to include/mrdocs/Metadata/Javadoc/Inline.hpp

@@ -10,45 +10,45 @@
 // Official repository: https://github.com/cppalliance/mrdocs
 //
 
-#ifndef MRDOCS_API_METADATA_JAVADOC_TEXT_HPP
-#define MRDOCS_API_METADATA_JAVADOC_TEXT_HPP
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_HPP
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/ADT/Polymorphic.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/CopyDetails.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/Link.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/Reference.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/Style.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/Styled.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/TextBase.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/CopyDetails.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Link.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Reference.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Style.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Styled.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Text.hpp>
 #include <mrdocs/Support/Concepts.hpp>
 #include <mrdocs/Support/Visitor.hpp>
 #include <compare>
 
 namespace clang::mrdocs::doc {
 
-/** Visit a text.
+/** Visit an inline.
 
-    @param text The text to visit.
-    @param fn The function to call for each text.
+    @param inline The inline to visit.
+    @param fn The function to call for each inline.
     @param args Additional arguments to pass to the function.
     @return The result of calling the function.
  */
 template<
-    class TextTy,
+    class InlineTy,
     class Fn,
     class... Args>
-    requires std::derived_from<TextTy, Text>
+    requires std::derived_from<InlineTy, Inline>
 decltype(auto)
 visit(
-    TextTy& text,
+    InlineTy& el,
     Fn&& fn,
     Args&&... args)
 {
-    auto visitor = makeVisitor<Text>(
-        text, std::forward<Fn>(fn),
+    auto visitor = makeVisitor<Inline>(
+        el, std::forward<Fn>(fn),
         std::forward<Args>(args)...);
-    switch(text.Kind)
+    switch(el.Kind)
     {
     case NodeKind::link:
         return visitor.template visit<Link>();
@@ -65,36 +65,36 @@ visit(
     }
 }
 
-/** Traverse a list of texts.
+/** Traverse a list of inlines.
 
     @param list The list of texts to traverse.
     @param f The function to call for each text.
     @param args Additional arguments to pass to the function.
  */
 template<class F, class T, class... Args>
-requires std::derived_from<T, Text>
+requires std::derived_from<T, Inline>
 void traverse(
     std::vector<std::unique_ptr<T>> const& list,
     F&& f, Args&&... args)
 {
-    for(auto const& text : list)
-        visit(*text,
+    for(auto const& el : list)
+        visit(*el,
             std::forward<F>(f),
             std::forward<Args>(args)...);
 }
 
-/** Map the Polymorphic Text as a @ref dom::Value object.
+/** Map the Polymorphic Inline as a @ref dom::Value object.
 
     @param io The output parameter to receive the dom::Object.
     @param I The input object.
     @param domCorpus The DOM corpus, or nullptr if not part of a corpus.
  */
-template <class IO, polymorphic_storage_for<Text> TextTy>
+template <class IO, polymorphic_storage_for<Inline> InlineTy>
 void
 tag_invoke(
     dom::ValueFromTag,
     IO& io,
-    TextTy const& I,
+    InlineTy const& I,
     DomCorpus const* domCorpus)
 {
     visit(*I, [&](auto const& U)
@@ -109,14 +109,14 @@ tag_invoke(
 
 MRDOCS_DECL
 std::strong_ordering
-operator<=>(Polymorphic<Text> const& lhs, Polymorphic<Text> const& rhs);
+operator<=>(Polymorphic<Inline> const& lhs, Polymorphic<Inline> const& rhs);
 
 inline
 bool
-operator==(Polymorphic<Text> const& lhs, Polymorphic<Text> const& rhs) {
+operator==(Polymorphic<Inline> const& lhs, Polymorphic<Inline> const& rhs) {
     return std::is_eq(lhs <=> rhs);
 }
 
 } // clang::mrdocs::doc
 
-#endif // MRDOCS_API_METADATA_JAVADOC_TEXT_HPP
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_HPP

include/mrdocs/Metadata/Javadoc/Text/CopyDetails.hpp renamed to include/mrdocs/Metadata/Javadoc/Inline/CopyDetails.hpp

@@ -10,12 +10,12 @@
 // Official repository: https://github.com/cppalliance/mrdocs
 //
 
-#ifndef MRDOCS_API_METADATA_JAVADOC_TEXT_COPYDETAILS_HPP
-#define MRDOCS_API_METADATA_JAVADOC_TEXT_COPYDETAILS_HPP
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_COPYDETAILS_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_COPYDETAILS_HPP
 
 #include <mrdocs/Platform.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/Reference.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/TextBase.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Reference.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Text.hpp>
 #include <string>
 
 namespace clang::mrdocs::doc {
@@ -77,4 +77,4 @@ tag_invoke(
 
 } // clang::mrdocs::doc
 
-#endif // MRDOCS_API_METADATA_JAVADOC_TEXT_COPYDETAILS_HPP
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_COPYDETAILS_HPP

include/mrdocs/Metadata/Javadoc/Inline/InlineBase.hpp

@@ -0,0 +1,89 @@
+//
+// This is a derivative work. originally part of the LLVM Project.
+// Licensed under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com)
+// Copyright (c) 2023 Krystian Stasiowski (sdkrystian@gmail.com)
+//
+// Official repository: https://github.com/cppalliance/mrdocs
+//
+
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_INLINEBASE_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_INLINEBASE_HPP
+
+#include <mrdocs/Platform.hpp>
+#include <mrdocs/Metadata/Javadoc/Node/NodeBase.hpp>
+#include <string>
+
+namespace clang::mrdocs::doc {
+
+/** A Node containing a string of text.
+
+    There will be no newlines in the text. Otherwise,
+    this would be represented as multiple text nodes
+    within a Paragraph node.
+*/
+struct Inline : Node
+{
+    constexpr ~Inline() override = default;
+
+    bool
+    isBlock() const noexcept final
+    {
+        return false;
+    }
+
+    auto operator<=>(Inline const&) const = default;
+    bool operator==(Inline const&) const noexcept = default;
+    bool equals(Node const& other) const noexcept override
+    {
+        return Kind == other.Kind &&
+            *this == dynamic_cast<Inline const&>(other);
+    }
+
+protected:
+    constexpr Inline() noexcept = default;
+
+    Inline(
+        NodeKind kind_)
+        : Node(kind_)
+    {
+    }
+};
+
+/** Map the @ref Inline to a @ref dom::Object.
+
+    @param t The tag.
+    @param io The output object.
+    @param I The input object.
+    @param domCorpus The DOM corpus, or nullptr if not part of a corpus.
+ */
+template <class IO>
+void
+tag_invoke(
+    dom::LazyObjectMapTag t,
+    IO& io,
+    Inline const& I,
+    DomCorpus const* domCorpus)
+{
+    tag_invoke(t, io, dynamic_cast<Node const&>(I), domCorpus);
+}
+
+/** Return the @ref Inline as a @ref dom::Value object.
+ */
+inline
+void
+tag_invoke(
+    dom::ValueFromTag,
+    dom::Value& v,
+    Inline const& I,
+    DomCorpus const* domCorpus)
+{
+    v = dom::LazyObject(I, domCorpus);
+}
+
+} // clang::mrdocs::doc
+
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_INLINEBASE_HPP

include/mrdocs/Metadata/Javadoc/Text/Link.hpp renamed to include/mrdocs/Metadata/Javadoc/Inline/Link.hpp

@@ -10,11 +10,11 @@
 // Official repository: https://github.com/cppalliance/mrdocs
 //
 
-#ifndef MRDOCS_API_METADATA_JAVADOC_TEXT_LINK_HPP
-#define MRDOCS_API_METADATA_JAVADOC_TEXT_LINK_HPP
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_LINK_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_LINK_HPP
 
 #include <mrdocs/Platform.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/TextBase.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Text.hpp>
 #include <string>
 
 namespace clang::mrdocs::doc {
@@ -79,4 +79,4 @@ tag_invoke(
 
 } // clang::mrdocs::doc
 
-#endif // MRDOCS_API_METADATA_JAVADOC_TEXT_LINK_HPP
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_LINK_HPP

include/mrdocs/Metadata/Javadoc/Text/Parts.hpp renamed to include/mrdocs/Metadata/Javadoc/Inline/Parts.hpp

@@ -10,8 +10,8 @@
 // Official repository: https://github.com/cppalliance/mrdocs
 //
 
-#ifndef MRDOCS_API_METADATA_JAVADOC_TEXT_PARTS_HPP
-#define MRDOCS_API_METADATA_JAVADOC_TEXT_PARTS_HPP
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_PARTS_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_PARTS_HPP
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/Dom.hpp>
@@ -54,4 +54,4 @@ tag_invoke(
 
 } // clang::mrdocs::doc
 
-#endif // MRDOCS_API_METADATA_JAVADOC_TEXT_PARTS_HPP
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_PARTS_HPP

include/mrdocs/Metadata/Javadoc/Text/Reference.hpp renamed to include/mrdocs/Metadata/Javadoc/Inline/Reference.hpp

@@ -10,12 +10,12 @@
 // Official repository: https://github.com/cppalliance/mrdocs
 //
 
-#ifndef MRDOCS_API_METADATA_JAVADOC_TEXT_REFERENCE_HPP
-#define MRDOCS_API_METADATA_JAVADOC_TEXT_REFERENCE_HPP
+#ifndef MRDOCS_API_METADATA_JAVADOC_INLINE_REFERENCE_HPP
+#define MRDOCS_API_METADATA_JAVADOC_INLINE_REFERENCE_HPP
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/Metadata/Info/SymbolID.hpp>
-#include <mrdocs/Metadata/Javadoc/Text/TextBase.hpp>
+#include <mrdocs/Metadata/Javadoc/Inline/Text.hpp>
 #include <string>
 
 namespace clang::mrdocs::doc {
@@ -86,4 +86,4 @@ tag_invoke(
 
 } // clang::mrdocs::doc
 
-#endif // MRDOCS_API_METADATA_JAVADOC_TEXT_REFERENCE_HPP
+#endif // MRDOCS_API_METADATA_JAVADOC_INLINE_REFERENCE_HPP