adoc pagination framework

Author: vinniefalco

source/lib/_adoc/AdocGenerator.cpp

@@ -13,17 +13,8 @@
 #define MRDOX_LIB_ADOC_ADOCGENERATOR_HPP
 
 #include <mrdox/Platform.hpp>
-#include <mrdox/Config.hpp>
-#include <mrdox/Corpus.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Generator.hpp>
-#include <mrdox/Metadata/Javadoc.hpp>
-#include <llvm/ADT/Optional.h>
-#include <llvm/ADT/StringRef.h>
-#include <llvm/Support/FileSystem.h>
-#include <llvm/Support/Path.h>
-#include <llvm/Support/raw_ostream.h>
-#include <string>
 
 namespace clang {
 namespace mrdox {
@@ -33,8 +24,6 @@ class AdocGenerator
     : public Generator
 {
 public:
-    class Writer;
-
     llvm::StringRef
     name() const noexcept override
     {
@@ -53,6 +42,12 @@ class AdocGenerator
         return "adoc";
     }
 
+    llvm::Error
+    buildPages(
+        llvm::StringRef outputPath,
+        Corpus const& corpus,
+        Reporter& R) const override;
+
     llvm::Error
     buildSinglePage(
         llvm::raw_ostream& os,
@@ -61,93 +56,6 @@ class AdocGenerator
         llvm::raw_fd_ostream* fd_os) const override;
 };
 
-//------------------------------------------------
-
-class AdocGenerator::Writer
-    : public Corpus::Visitor
-{
-protected:
-    struct Section
-    {
-        int level = 0;
-        std::string markup;
-    };
-
-    llvm::raw_ostream& os_;
-    llvm::raw_fd_ostream* fd_os_;
-    Corpus const& corpus_;
-    Reporter& R_;
-    Section sect_;
-
-public:
-    Writer(
-        llvm::raw_ostream& os,
-        llvm::raw_fd_ostream* fd_os,
-        Corpus const& corpus,
-        Reporter& R) noexcept;
-
-    llvm::Error build();
-
-    struct FormalParam;
-    struct TypeName;
-
-    void writeFormalParam(FormalParam const& p, llvm::raw_ostream& os);
-    void writeTypeName(TypeName const& tn, llvm::raw_ostream& os);
-
-protected:
-    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;
-
-protected:
-    void writeRecord(RecordInfo const& I);
-    void writeFunction(FunctionInfo const& I);
-    void writeTypedef(TypedefInfo const& I);
-    void writeEnum(EnumInfo const& I);
-
-    void writeBase(BaseRecordInfo const& I);
-    void writeFunctionOverloads(
-        llvm::StringRef sectionName,
-        OverloadsSet const& set);
-    void writeNestedTypes(
-        llvm::StringRef sectionName,
-        std::vector<TypedefInfo> const& list,
-        AccessSpecifier access);
-    void writeDataMembers(
-        llvm::StringRef sectionName,
-        llvm::SmallVectorImpl<MemberTypeInfo> const& list,
-        AccessSpecifier access);
-
-    void writeBrief(
-        llvm::Optional<Javadoc> const& javadoc,
-        bool withNewline = true);
-    void writeDescription(
-        llvm::Optional<Javadoc> const& javadoc);
-    void writeLocation(SymbolInfo const& I);
-
-    template<class T>
-    void writeNodes(List<T> const& list);
-    void writeNode(Javadoc::Node const& node);
-    void writeNode(Javadoc::Text const& node);
-    void writeNode(Javadoc::StyledText const& node);
-    void writeNode(Javadoc::Paragraph const& node);
-    void writeNode(Javadoc::Admonition const& node);
-    void writeNode(Javadoc::Code const& node);
-    void writeNode(Javadoc::Param const& node);
-    void writeNode(Javadoc::TParam const& node);
-    void writeNode(Javadoc::Returns const& node);
-
-    FormalParam formalParam(FieldTypeInfo const& ft);
-    TypeName typeName(TypeInfo const& ti);
-
-    void openSection(llvm::StringRef name);
-    void closeSection();
-
-    static llvm::StringRef toString(TagTypeKind k) noexcept;
-};
-
 } // adoc
 } // mrdox
 } // clang

source/lib/_adoc/AdocGenerator.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 ([email protected])
+//
+// Official repository: https://github.com/cppalliance/mrdox
+//
+
+#include "AdocMultiPageWriter.hpp"
+
+namespace clang {
+namespace mrdox {
+namespace adoc {
+
+AdocMultiPageWriter::
+AdocMultiPageWriter(
+    llvm::raw_ostream& os,
+    llvm::raw_fd_ostream* fd_os,
+    Corpus const& corpus,
+    Reporter& R) noexcept
+    : AdocWriter(os, fd_os, corpus, R)
+{
+}
+
+llvm::Error
+AdocMultiPageWriter::
+build()
+{
+    Assert(sect_.level == 0);
+    sect_.level = 1;
+    sect_.markup = "=";
+    os_ <<
+        "= Reference\n"
+        ":role: mrdox\n";
+    (void)corpus_.visit(globalNamespaceID, *this);
+    closeSection();
+    return llvm::Error::success();
+}
+
+bool
+AdocMultiPageWriter::
+visit(
+    NamespaceInfo const& I)
+{
+    return corpus_.visit(I.Children, *this);
+}
+
+bool
+AdocMultiPageWriter::
+visit(
+    RecordInfo const& I)
+{
+    write(I);
+    return corpus_.visit(I.Children, *this);
+}
+
+bool
+AdocMultiPageWriter::
+visit(
+    FunctionInfo const& I)
+{
+    write(I);
+    return true;
+}
+
+bool
+AdocMultiPageWriter::
+visit(
+    TypedefInfo const& I)
+{
+    write(I);
+    return true;
+}
+
+bool
+AdocMultiPageWriter::
+visit(
+    EnumInfo const& I)
+{
+    write(I);
+    return true;
+}
+
+} // adoc
+} // mrdox
+} // clang

source/lib/_adoc/AdocMultiPageWriter.cpp

@@ -0,0 +1,46 @@
+//
+// 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_LIB_ADOC_ADOCMULTIPAGEWRITER_HPP
+#define MRDOX_LIB_ADOC_ADOCMULTIPAGEWRITER_HPP
+
+#include "AdocWriter.hpp"
+#include <mrdox/Corpus.hpp>
+
+namespace clang {
+namespace mrdox {
+namespace adoc {
+
+class AdocMultiPageWriter
+    : public AdocWriter
+    , public Corpus::Visitor
+{
+public:
+    AdocMultiPageWriter(
+        llvm::raw_ostream& os,
+        llvm::raw_fd_ostream* fd_os,
+        Corpus const& corpus,
+        Reporter& R) noexcept;
+
+    llvm::Error build();
+
+private:
+    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;
+};
+
+} // adoc
+} // mrdox
+} // clang
+
+#endif

source/lib/_adoc/AdocMultiPageWriter.hpp

@@ -8,7 +8,7 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "PagesBuilder.hpp"
+#include "AdocPagesBuilder.hpp"
 #include "Support/Radix.hpp"
 #include <mrdox/Metadata.hpp>
 #include <llvm/ADT/STLExtras.h>
@@ -19,26 +19,8 @@ namespace clang {
 namespace mrdox {
 namespace adoc {
 
-/*
-    Pages are as follows:
-
-    Class
-    Class Template
-    Class Template Specialization 
-    OverloadSet
-    Nested Class
-    Free Function
-    Variable/Constant
-    Typedef
-    Enum
-
-    Page name:
-
-    /{namespace}/{symbol}.html
-*/
-
 void
-PagesBuilder::
+AdocPagesBuilder::
 scan()
 {
     // visit the children not the namespace
@@ -55,7 +37,7 @@ scan()
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     NamespaceInfo const& I)
 {
@@ -69,7 +51,7 @@ visit(
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     RecordInfo const& I)
 {
@@ -90,7 +72,7 @@ visit(
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     Overloads const& I)
 {
@@ -105,15 +87,15 @@ visit(
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     FunctionInfo const& I)
 {
     return true;
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     TypedefInfo const& I)
 {
@@ -129,7 +111,7 @@ visit(
 }
 
 bool
-PagesBuilder::
+AdocPagesBuilder::
 visit(
     EnumInfo const& I)
 {

source/lib/_adoc/PagesBuilder.cpp renamed to source/lib/_adoc/AdocPagesBuilder.cpp

@@ -8,8 +8,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_LIB_ADOC_PAGESBUILDER_HPP
-#define MRDOX_LIB_ADOC_PAGESBUILDER_HPP
+#ifndef MRDOX_LIB_ADOC_ADOCPAGESBUILDER_HPP
+#define MRDOX_LIB_ADOC_ADOCPAGESBUILDER_HPP
 
 #include <mrdox/Platform.hpp>
 #include <mrdox/Corpus.hpp>
@@ -20,7 +20,7 @@ namespace clang {
 namespace mrdox {
 namespace adoc {
 
-class PagesBuilder : Corpus::Visitor
+class AdocPagesBuilder : Corpus::Visitor
 {
     Corpus const& corpus_;
 
@@ -39,7 +39,7 @@ class PagesBuilder : Corpus::Visitor
 
     std::vector<Page> pages;
 
-    PagesBuilder(
+    AdocPagesBuilder(
         Corpus const& corpus) noexcept
         : corpus_(corpus)
     {