feat: dom::String

fix #361, fix #372

Author: vinniefalco

include/mrdox/Metadata/Function.hpp

@@ -19,6 +19,7 @@
 #include <mrdox/Metadata/Source.hpp>
 #include <mrdox/Metadata/Symbols.hpp>
 #include <mrdox/Metadata/Template.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <memory>
 #include <string>
 #include <vector>
@@ -59,9 +60,7 @@ enum class FunctionClass
     Deduction,
 };
 
-MRDOX_DECL
-std::string_view
-toString(FunctionClass kind);
+MRDOX_DECL dom::String toString(FunctionClass kind) noexcept;
 
 /** Bit constants used with function specifiers.
 */

include/mrdox/Metadata/Info.hpp

@@ -16,6 +16,7 @@
 #include <mrdox/Metadata/Javadoc.hpp>
 #include <mrdox/Metadata/Specifiers.hpp>
 #include <mrdox/Metadata/Symbols.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <mrdox/Support/TypeTraits.hpp>
 #include <array>
 #include <memory>
@@ -49,9 +50,7 @@ enum class InfoKind
     Specialization
 };
 
-MRDOX_DECL
-std::string_view
-toString(InfoKind kind) noexcept;
+MRDOX_DECL dom::String toString(InfoKind kind) noexcept;
 
 /** Common properties of all symbols
 */

include/mrdox/Metadata/Javadoc.hpp

@@ -14,6 +14,7 @@
 #define MRDOX_API_METADATA_JAVADOC_HPP
 
 #include <mrdox/Platform.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <mrdox/Support/Error.hpp>
 #include <memory>
 #include <string>
@@ -586,6 +587,8 @@ struct Overview
     std::vector<TParam const*> tparams;
 };
 
+MRDOX_DECL dom::String toString(Style style) noexcept;
+
 } // doc
 
 //------------------------------------------------

include/mrdox/Metadata/Record.hpp

@@ -22,6 +22,7 @@
 #include <mrdox/Metadata/Template.hpp>
 #include <mrdox/Metadata/Typedef.hpp>
 #include <mrdox/Metadata/Variable.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <memory>
 #include <string>
 #include <string_view>
@@ -68,9 +69,7 @@ enum class RecordKeyKind
     Union
 };
 
-MRDOX_DECL
-std::string_view
-toString(RecordKeyKind kind) noexcept;
+MRDOX_DECL dom::String toString(RecordKeyKind kind) noexcept;
 
 /** Metadata for struct, class, or union.
 */

include/mrdox/Metadata/Specifiers.hpp

@@ -12,6 +12,7 @@
 #define MRDOX_API_METADATA_SPECIFIERS_HPP
 
 #include <mrdox/Platform.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <string_view>
 
 namespace clang {
@@ -36,25 +37,6 @@ enum class AccessKind
     None
 };
 
-/** Storage class kinds
-
-    [dcl.stc] p1: At most one storage-class-specifier shall appear
-    in a given decl-specifier-seq, except that `thread_local`
-    may appear with `static` or `extern`.
-*/
-enum class StorageClassKind
-{
-    None = 0,
-    Extern,
-    Static,
-    // auto storage-class-specifier (removed in C++11)
-    // only valid for variables
-    Auto,
-    // register storage-class-specifier (removed in C++17)
-    // only valid for variables
-    Register
-};
-
 /** `constexpr`/`consteval` specifier kinds
 
     [dcl.spec.general] p2: At most one of the `constexpr`, `consteval`,
@@ -175,29 +157,31 @@ enum class ReferenceKind
     RValue
 };
 
-MRDOX_DECL
-std::string_view
-toString(AccessKind kind);
-
-MRDOX_DECL
-std::string_view
-toString(StorageClassKind kind);
-
-MRDOX_DECL
-std::string_view
-toString(ConstexprKind kind);
-
-MRDOX_DECL
-std::string_view
-toString(ExplicitKind kind);
+/** Storage class kinds
 
-MRDOX_DECL
-std::string_view
-toString(NoexceptKind kind);
+    [dcl.stc] p1: At most one storage-class-specifier shall appear
+    in a given decl-specifier-seq, except that `thread_local`
+    may appear with `static` or `extern`.
+*/
+enum class StorageClassKind
+{
+    None = 0,
+    Extern,
+    Static,
+    // auto storage-class-specifier (removed in C++11)
+    // only valid for variables
+    Auto,
+    // register storage-class-specifier (removed in C++17)
+    // only valid for variables
+    Register
+};
 
-MRDOX_DECL
-std::string_view
-toString(ReferenceKind kind);
+MRDOX_DECL dom::String toString(AccessKind kind) noexcept;
+MRDOX_DECL dom::String toString(ConstexprKind kind) noexcept;
+MRDOX_DECL dom::String toString(ExplicitKind kind) noexcept;
+MRDOX_DECL dom::String toString(NoexceptKind kind) noexcept;
+MRDOX_DECL dom::String toString(ReferenceKind kind) noexcept;
+MRDOX_DECL dom::String toString(StorageClassKind kind) noexcept;
 
 } // mrdox
 } // clang

include/mrdox/Metadata/Template.hpp

@@ -35,9 +35,7 @@ enum class TParamKind : int
     Template
 };
 
-MRDOX_DECL
-std::string_view
-toString(TParamKind kind);
+MRDOX_DECL dom::String toString(TParamKind kind) noexcept;
 
 struct TParam;
 

include/mrdox/Metadata/Type.hpp

@@ -16,6 +16,7 @@
 #include <mrdox/Metadata/Specifiers.hpp>
 #include <mrdox/Metadata/Symbols.hpp>
 #include <mrdox/MetadataFwd.hpp>
+#include <mrdox/Support/Dom.hpp>
 #include <memory>
 #include <string>
 #include <string_view>
@@ -31,9 +32,7 @@ enum QualifierKind : int
     Volatile
 };
 
-MRDOX_DECL
-std::string_view
-toString(QualifierKind kind);
+MRDOX_DECL dom::String toString(QualifierKind kind) noexcept;
 
 enum class TypeKind
 {
@@ -49,17 +48,13 @@ enum class TypeKind
     Pack
 };
 
-MRDOX_DECL
-std::string_view
-toString(TypeKind kind);
+MRDOX_DECL dom::String toString(TypeKind kind) noexcept;
 
 struct TypeInfo
 {
     TypeKind Kind;
 
-    constexpr
-    virtual
-    ~TypeInfo() = default;
+    constexpr virtual ~TypeInfo() = default;
 
     constexpr bool isBuiltin()         const noexcept { return Kind == TypeKind::Builtin ; }
     constexpr bool isTag()             const noexcept { return Kind == TypeKind::Tag; }
@@ -271,6 +266,7 @@ visit(
     }
 }
 
+// VFALCO maybe we should rename this to `renderType` or something?
 MRDOX_DECL
 std::string
 toString(