chore: Dom diagnostics and tidy

Author: vinniefalco

include/mrdox/Support/Dom.hpp

@@ -12,6 +12,7 @@
 #define MRDOX_API_SUPPORT_DOM_HPP
 
 #include <mrdox/Platform.hpp>
+#include <fmt/format.h>
 #include <atomic>
 #include <cstdint>
 #include <initializer_list>
@@ -101,7 +102,6 @@ class MRDOX_DECL
 };
 
 template<class U, class... Args>
-requires std::derived_from<U, Any>
 auto create(Args&&... args);
 
 //------------------------------------------------
@@ -123,7 +123,8 @@ class Pointer
     friend class Pointer;
 
     explicit
-    Pointer(Any* any) noexcept
+    Pointer(
+        Any* any) noexcept
         : any_(any)
     {
     }
@@ -143,22 +144,31 @@ class Pointer
     }
 
     template<class U>
-    requires std::convertible_to<U*, T*>
-    Pointer(U* u) noexcept
+    requires(
+        std::convertible_to<U*, T*> &&
+        std::derived_from<U, Any>)
+    Pointer(
+        U* u) noexcept
         : any_(u->addref())
     {
     }
 
     template<class U>
-    requires std::convertible_to<U*, T*>
-    Pointer(Pointer<U> const& other) noexcept
+    requires(
+        std::convertible_to<U*, T*> &&
+        std::derived_from<U, Any>)
+    Pointer(
+        Pointer<U> const& other) noexcept
         : any_(other.any_->addref())
     {
     }
 
     template<class U>
-    requires std::convertible_to<U*, T*>
-    Pointer& operator=(
+    requires(
+        std::convertible_to<U*, T*> &&
+        std::derived_from<U, Any>)
+    Pointer&
+    operator=(
         Pointer<U> const& other) noexcept
     {
         Pointer temp(other);
@@ -196,12 +206,10 @@ class Pointer
     }
 
     template<class U, class... Args>
-    requires std::derived_from<U, Any>
     friend auto create(Args&&... args);
 };
 
 template<class U, class... Args>
-requires std::derived_from<U, Any>
 auto create(Args&&... args)
 {
     return Pointer<U>(new U(
@@ -220,6 +228,11 @@ class MRDOX_DECL
 public:
     virtual std::size_t length() const noexcept;
     virtual Value get(std::size_t) const;
+
+    /** Return a diagnostic string.
+    */
+    std::string
+    displayString() const;
 };
 
 using ArrayPtr = Pointer<Array>;
@@ -235,13 +248,8 @@ using ArrayPtr = Pointer<Array>;
 class MRDOX_DECL
     Object : public Any
 {
-protected:
-    /** Constructor.
-
-        The newly constructed object will retain
-        a copy of the list of values in `other`.
-    */
-    Object(Object const& other);
+    template<class U, class... Args>
+    friend auto create(Args&&... args);
 
 public:
     /** The type of an element in this container.
@@ -252,12 +260,20 @@ class MRDOX_DECL
     */
     using list_type = std::vector<value_type>;
 
+protected:
     /** Constructor.
 
         Default-constructed objects are empty.
     */
     Object() noexcept;
 
+    /** Constructor.
+
+        The newly constructed object will retain
+        a copy of the list of values in `other`.
+    */
+    Object(Object const& other);
+
     /** Constructor.
 
         Upon construction, the object will retain
@@ -269,6 +285,7 @@ class MRDOX_DECL
     */
     explicit Object(list_type list);
 
+public:
     /** Return an iterable range with the contents.
     */
     list_type const& list() const noexcept;
@@ -322,6 +339,11 @@ class MRDOX_DECL
     */
     virtual void set(std::string_view key, Value value);
 
+    /** Return a diagnostic string.
+    */
+    std::string
+    displayString() const;
+
     // VFALCO DEPRECATED (for duktape)
     virtual std::vector<std::string_view> props() const;
 
@@ -405,6 +427,9 @@ class MRDOX_DECL
         LazyObjectPtr lazy_obj_;
     };
 
+    friend class Array;
+    friend class Object;
+
 public:
     ~Value();
     Value() noexcept;
@@ -553,6 +578,19 @@ class MRDOX_DECL
     {
         v0.swap(v1);
     }
+
+    /** Return a diagnostic string.
+    */
+    std::string
+    displayString() const;
+
+private:
+    /** Return a diagnostic string.
+
+        This function will not traverse children.
+    */
+    std::string
+    displayString1() const;
 };
 
 /** Return a non-empty string, or a null.
@@ -571,4 +609,32 @@ stringOrNull(
 } // mrdox
 } // clang
 
+//------------------------------------------------
+
+template<>
+struct fmt::formatter<clang::mrdox::dom::Object>
+    : fmt::formatter<std::string>
+{
+    auto format(
+        clang::mrdox::dom::Object const& value,
+        fmt::format_context& ctx) const
+    {
+        return fmt::formatter<std::string>::format(
+            value.displayString(), ctx);
+    }
+};
+
+template<>
+struct fmt::formatter<clang::mrdox::dom::Value>
+    : fmt::formatter<std::string>
+{
+    auto format(
+        clang::mrdox::dom::Value const& value,
+        fmt::format_context& ctx) const
+    {
+        return fmt::formatter<std::string>::format(
+            value.displayString(), ctx);
+    }
+};
+
 #endif

include/mrdox/Support/JavaScript.hpp

@@ -214,8 +214,6 @@ class Scope
     MRDOX_DECL
     Object
     getGlobal(std::string_view name);
-
-    Expected<Value> call();
 };
 
 //------------------------------------------------

source/Metadata/DomMetadata.cpp

@@ -71,7 +71,7 @@ class DomSymbolArray : public dom::Array
     {
     }
 
-    std::size_t length() const noexcept
+    std::size_t length() const noexcept override
     {
         return list_.size();
     }
@@ -205,14 +205,6 @@ class DomSourceInfo : public dom::Object
     }
 };
 
-static
-dom::Value
-domCreate(
-    SourceInfo const& I)
-{
-    return dom::create<DomSourceInfo>(I);
-}
-
 //------------------------------------------------
 //
 // TypeInfo
@@ -250,7 +242,6 @@ domCreate(
 //
 // Param
 //
-//
 //------------------------------------------------
 
 /** A function parameter
@@ -558,7 +549,7 @@ class DomEnumValueArray : public dom::Array
     {
     }
 
-    std::size_t length() const noexcept
+    std::size_t length() const noexcept override
     {
         return list_.size();
     }
@@ -592,8 +583,7 @@ class DomTrancheArray : public dom::Array
     {
     }
 
-    std::size_t
-    length() const noexcept override
+    std::size_t length() const noexcept override
     {
         return list_.size();
     }