chore: visit replaces Visitor

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -90,33 +90,6 @@ class MRDOX_VISIBLE
 
     //--------------------------------------------
 
-    /** Base class used to visit elements of the corpus.
-    */
-    struct Visitor
-    {
-        MRDOX_DECL virtual ~Visitor() noexcept;
-
-        MRDOX_DECL virtual bool visit(NamespaceInfo const&);
-        MRDOX_DECL virtual bool visit(RecordInfo const&);
-        MRDOX_DECL virtual bool visit(FunctionInfo const&);
-        MRDOX_DECL virtual bool visit(TypedefInfo const&);
-        MRDOX_DECL virtual bool visit(EnumInfo const&);
-        MRDOX_DECL virtual bool visit(VariableInfo const&);
-        MRDOX_DECL virtual bool visit(FieldInfo const&);
-        MRDOX_DECL virtual bool visit(SpecializationInfo const&);
-    };
-
-    /** Traverse the symbol, list, or its children.
-    */
-    /** @{ */
-    MRDOX_DECL bool traverse(Visitor&, Info const& I) const;
-    MRDOX_DECL bool traverse(Visitor&, NamespaceInfo const& I) const;
-    MRDOX_DECL bool traverse(Visitor&, RecordInfo const& I) const;
-    MRDOX_DECL bool traverse(Visitor&, SpecializationInfo const& I) const;
-    MRDOX_DECL bool traverse(Visitor&, SymbolID id) const;
-    MRDOX_DECL bool traverse(Visitor&, std::vector<SymbolID> const& R) const;
-    /** @} */
-
     template<class F, class... Args>
     void traverse(
         NamespaceInfo const& I,
@@ -127,6 +100,11 @@ class MRDOX_VISIBLE
         RecordInfo const& I,
         F&& f, Args&&... args) const;
 
+    template<class F, class... Args>
+    void traverse(
+        SpecializationInfo const& I,
+        F&& f, Args&&... args) const;
+
     //--------------------------------------------
 
     // KRYSTIAN NOTE: temporary
@@ -169,6 +147,9 @@ 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>
@@ -181,14 +162,24 @@ traverse(
     for(auto const& id : I.Members)
         visit(get(id), std::forward<F>(f),
             std::forward<Args>(args)...);
-    for(auto const& id : I.Friends)
-        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>
+void
+Corpus::
+traverse(
+    SpecializationInfo const& I,
+    F&& f, Args&&... args) const
+{
+    for(auto const& J : I.Members)
+        visit(get(J.Specialized),
+            std::forward<F>(f),
+                std::forward<Args>(args)...);
+}
+
 } // mrdox
 } // clang
 

source/-XML/XMLWriter.cpp

@@ -148,8 +148,7 @@ build()
     if(options_.index || options_.safe_names)
         writeIndex();
 
-    if(! corpus_.traverse(*this, SymbolID::zero))
-        return formatError("visitation aborted");
+    visit(corpus_.globalNamespace(), *this);
 
     if(options_.prolog)
         os_ << "</mrdox>\n";
@@ -192,85 +191,41 @@ writeIndex()
 
 //------------------------------------------------
 
-bool
-XMLWriter::
-visit(
-    NamespaceInfo const& I)
-{
-    tags_.open(namespaceTagName, {
-        { "name", I.Name },
-        { I.id }
-        });
-
-    writeJavadoc(I.javadoc);
-
-    if(! corpus_.traverse(*this, I))
-        return false;
-
-    tags_.close(namespaceTagName);
-
-    return true;
-}
-
-bool
-XMLWriter::
-visit(
-    RecordInfo const& I)
-{
-    return writeRecord(I);
-}
-
-bool
-XMLWriter::
-visit(
-    FunctionInfo const& I)
-{
-    return writeFunction(I);
-}
-
-bool
-XMLWriter::
-visit(
-    TypedefInfo const& I)
-{
-    return writeTypedef(I);
-}
-
-bool
-XMLWriter::
-visit(
-    EnumInfo const& I)
-{
-    return writeEnum(I);
-}
-
-bool
-XMLWriter::
-visit(
-    FieldInfo const& I)
-{
-    return writeField(I);
-}
-
-bool
-XMLWriter::
-visit(
-    VariableInfo const& I)
-{
-    return writeVar(I);
-}
-
-bool
+template<class T>
+void
 XMLWriter::
-visit(
-    SpecializationInfo const& I)
+operator()(
+    T const& I)
 {
-    return writeSpecialization(I);
+    if constexpr(T::isNamespace())
+    {
+        tags_.open(namespaceTagName, {
+            { "name", I.Name },
+            { I.id }
+            });
+        writeJavadoc(I.javadoc);
+        corpus_.traverse(I, *this);
+        tags_.close(namespaceTagName);
+    }
+    if constexpr(T::isRecord())
+        writeRecord(I);
+    if constexpr(T::isFunction())
+        writeFunction(I);
+    if constexpr(T::isEnum())
+        writeEnum(I);
+    if constexpr(T::isTypedef())
+        writeTypedef(I);
+    if constexpr(T::isField())
+        writeField(I);
+    if constexpr(T::isVariable())
+        writeVar(I);
+    if constexpr(T::isSpecialization())
+        writeSpecialization(I);
 }
 
 //------------------------------------------------
 
-bool
+void
 XMLWriter::
 writeEnum(
     EnumInfo const& I)
@@ -313,10 +268,9 @@ writeEnum(
     writeJavadoc(I.javadoc);
 
     tags_.close(enumTagName);
-    return true;
 }
 
-bool
+void
 XMLWriter::
 writeFunction(
     FunctionInfo const& I)
@@ -344,10 +298,9 @@ writeFunction(
     tags_.close(functionTagName);
 
     closeTemplate(I.Template);
-    return true;
 }
 
-bool
+void
 XMLWriter::
 writeRecord(
     RecordInfo const& I)
@@ -383,17 +336,14 @@ writeRecord(
 
     writeJavadoc(I.javadoc);
 
-    if(! corpus_.traverse(*this, I))
-        return false;
+    corpus_.traverse(I, *this);
 
     tags_.close(tagName);
 
     closeTemplate(I.Template);
-
-    return true;
 }
 
-bool
+void
 XMLWriter::
 writeTypedef(
     TypedefInfo const& I)
@@ -420,11 +370,9 @@ writeTypedef(
     tags_.close(tag);
 
     closeTemplate(I.Template);
-
-    return true;
 }
 
-bool
+void
 XMLWriter::
 writeField(
     const FieldInfo& I)
@@ -445,11 +393,9 @@ writeField(
     writeJavadoc(I.javadoc);
 
     tags_.close(dataMemberTagName);
-
-    return true;
 }
 
-bool
+void
 XMLWriter::
 writeVar(
     VariableInfo const& I)
@@ -473,8 +419,6 @@ writeVar(
     tags_.close(varTagName);
 
     closeTemplate(I.Template);
-
-    return true;
 }
 
 //------------------------------------------------
@@ -537,7 +481,7 @@ closeTemplate(
     tags_.close(templateTagName);
 }
 
-bool
+void
 XMLWriter::
 writeSpecialization(
     const SpecializationInfo& I)
@@ -550,12 +494,9 @@ writeSpecialization(
     for(const TArg& targ : I.Args)
         writeTemplateArg(targ, tags_);
 
-    if(! corpus_.traverse(*this, I))
-        return false;
+    corpus_.traverse(I, *this);
 
     tags_.close(specializationTagName);
-
-    return true;
 }
 
 //------------------------------------------------

source/-XML/XMLWriter.hpp

@@ -28,7 +28,6 @@ class jit_indenter;
 /** A writer which outputs XML.
 */
 class XMLWriter
-    : public Corpus::Visitor
 {
     template<class T>
     friend struct llvm::yaml::MappingTraits;
@@ -55,25 +54,18 @@ class XMLWriter
 
     Error build();
 
-private:
     void writeIndex();
 
-    bool visit(NamespaceInfo const&) override;
-    bool visit(RecordInfo const&) override;
-    bool visit(FunctionInfo const&) override;
-    bool visit(TypedefInfo const&) override;
-    bool visit(EnumInfo const&) override;
-    bool visit(VariableInfo const&) override;
-    bool visit(SpecializationInfo const&) override;
-    bool visit(FieldInfo const&) override;
-
-    bool writeEnum(EnumInfo const&);
-    bool writeFunction(FunctionInfo const&);
-    bool writeRecord(RecordInfo const&);
-    bool writeTypedef(TypedefInfo const&);
-    bool writeField(FieldInfo const&);
-    bool writeVar(VariableInfo const&);
-    bool writeSpecialization(const SpecializationInfo&);
+    template<class T>
+    void operator()(T const&);
+
+    void writeRecord(RecordInfo const&);
+    void writeFunction(FunctionInfo const&);
+    void writeEnum(EnumInfo const&);
+    void writeField(FieldInfo const&);
+    void writeTypedef(TypedefInfo const&);
+    void writeVar(VariableInfo const&);
+    void writeSpecialization(const SpecializationInfo&);
 
     void writeSourceInfo(SourceInfo const& I);
     void writeLocation(Location const& loc, bool def = false);