add FlatWriter

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -124,6 +124,17 @@ class Corpus
         llvm::StringRef symbolName0,
         llvm::StringRef symbolName1) noexcept;
 
+    /** Return the ID of the global namespace.
+    */
+    static
+    SymbolID
+    globalNamespaceID() noexcept;
+
+    /** Return the metadata for the global namespace.
+    */
+    NamespaceInfo const&
+    globalNamespace() const noexcept;
+
     /** Return true if an Info with the specified symbol ID exists.
     */
     bool

include/mrdox/FlatWriter.hpp

@@ -0,0 +1,83 @@
+//
+// 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 ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#ifndef MRDOX_FLAT_WRITER_HPP
+#define MRDOX_FLAT_WRITER_HPP
+
+#include <mrdox/Info.hpp>
+#include <mrdox/Reporter.hpp>
+#include <llvm/ADT/StringRef.h>
+#include <llvm/Support/raw_ostream.h>
+#include <string>
+
+namespace clang {
+namespace mrdox {
+
+//------------------------------------------------
+
+class Corpus;
+class Config;
+struct NamespaceInfo;
+struct RecordInfo;
+struct FunctionInfo;
+struct EnumInfo;
+struct TypedefInfo;
+struct Scope;
+
+//------------------------------------------------
+
+/** An abstract writer for flat output formats.
+*/
+class FlatWriter
+{
+protected:
+    llvm::raw_ostream& os_;
+    Corpus const& corpus_;
+    Config const& config_;
+    Reporter& R_;
+
+    /** Constructor.
+    */
+    FlatWriter(
+        llvm::raw_ostream& os,
+        Corpus const& corpus,
+        Config const& config,
+        Reporter& R) noexcept;
+
+public:
+    /** Destructor.
+    */
+    virtual ~FlatWriter() = default;
+
+    void visitAllSymbols();
+    void visit(SymbolID const& id);
+
+    virtual void beginFile();
+    virtual void endFile();
+
+protected:
+    virtual void writeNamespace(NamespaceInfo const& I);
+    virtual void writeRecord(RecordInfo const& I);
+    virtual void writeFunction(FunctionInfo const& I);
+    virtual void writeEnum(EnumInfo const& I);
+    virtual void writeTypedef(TypedefInfo const& I);
+
+private:
+    void visit(NamespaceInfo const&);
+    void visit(RecordInfo const&);
+    void visit(FunctionInfo const&);
+    void visit(Scope const&);
+};
+
+} // mrdox
+} // clang
+
+#endif

include/mrdox/RecursiveWriter.hpp

@@ -49,19 +49,25 @@ struct Scope;
 */
 class RecursiveWriter
 {
-    llvm::raw_fd_ostream* fd_os_ = nullptr;
-    llvm::raw_string_ostream* str_os_ = nullptr;
     std::string indentString_;
 
 protected:
+    llvm::raw_ostream& os_;
     Corpus const& corpus_;
     Config const& config_;
     Reporter& R_;
 
-    llvm::raw_ostream& os() noexcept;
     llvm::raw_ostream& indent();
     void adjustNesting(int levels);
 
+    /** Constructor.
+    */
+    RecursiveWriter(
+        llvm::raw_ostream& os,
+        Corpus const& corpus,
+        Config const& config,
+        Reporter& R) noexcept;
+
 public:
     /** Describes an item in the list of all symbols.
     */
@@ -79,44 +85,37 @@ class RecursiveWriter
         */
         SymbolID id;
 
+        /** Constructor.
+        */
         AllSymbol(Info const& I);
     };
 
     /** Destructor.
     */
-    ~RecursiveWriter() = default;
+    virtual ~RecursiveWriter() = default;
 
-    /** Constructor.
+    /** Write the contents of the corpus.
     */
-    RecursiveWriter(
-        Corpus const& corpus,
-        Config const& config,
-        Reporter& R) noexcept;
+    void write();
+
+protected:
+    /** Called to write all symbols.
 
-    /** Write the contents of the corpus to the output stream.
+        Each element contains the fully qualified
+        name and the type of symbol. The list is
+        canonicalized by a visual sort on symbol.
     */
-    /** @{ */
-    void write(llvm::raw_fd_ostream& os);
-    void write(llvm::raw_string_ostream& os);
-    /** @} */
+    virtual void writeAllSymbols(std::vector<AllSymbol> const& list);
 
     /** Called to open and close the document.
 
         The default implementation does nothing.
     */
     /** @{ */
-    virtual void beginDoc();
-    virtual void endDoc();
+    virtual void beginFile();
+    virtual void endFile();
     /** @} */
 
-    /** Called to write all symbols.
-
-        Each element contains the fully qualified
-        name and the type of symbol. The list is
-        canonicalized by a visual sort on symbol.
-    */
-    virtual void writeAllSymbols(std::vector<AllSymbol> const& list);
-
     /** Called to open or close a scope.
 
         The default implementation does nothing.
@@ -142,8 +141,8 @@ class RecursiveWriter
 private:
     void visit(NamespaceInfo const&);
     void visit(RecordInfo const&);
-    void visit(Scope const&);
     void visit(FunctionInfo const&);
+    void visit(Scope const&);
 
     std::vector<AllSymbol> makeAllSymbols();
 };