adoc work

Author: vinniefalco

source/lib/Asciidoc.cpp

@@ -14,8 +14,6 @@
 namespace clang {
 namespace mrdox {
 
-namespace {
-
 //------------------------------------------------
 //
 // AsciidocGenerator
@@ -101,7 +99,8 @@ buildOne(
     }
 
     Writer w(corpus, config, R);
-    return w.buildOne(os);
+    w.writeOne(os);
+    return ! os.has_error();
 }
 
 bool
@@ -115,75 +114,238 @@ buildString(
     dest.clear();
     llvm::raw_string_ostream os(dest);
     Writer w(corpus, config, R);
-    return w.buildOne(os);
+    w.writeOne(os);
+    return true;
 }
 
+//------------------------------------------------
+//
+// Writer
+//
 //------------------------------------------------
 
-#if 0
-llvm::Error
+void
+AsciidocGenerator::
+Writer::
+write(
+    llvm::StringRef rootDir)
+{
+}
+
+void
+AsciidocGenerator::
+Writer::
+writeOne(
+    llvm::raw_ostream& os)
+{
+    os_ = &os;
+    openSection("Reference");
+    writeAllSymbols();
+    closeSection();
+}
+
+//------------------------------------------------
+
+void
 AsciidocGenerator::
-generateDocForInfo(
-    Info* I,
-    llvm::raw_ostream& os,
-    const Config& config)
+Writer::
+writeAllSymbols()
 {
-    switch (I->IT)
+    for(auto const& id : corpus_.allSymbols)
     {
-    case InfoType::IT_namespace:
-        makeNamespacePage(config, *static_cast<clang::mrdox::NamespaceInfo*>(I), os);
-        break;
-    case InfoType::IT_record:
-        genMarkdown(config, *static_cast<clang::mrdox::RecordInfo*>(I), os);
-        break;
-    case InfoType::IT_enum:
-        genMarkdown(config, *static_cast<clang::mrdox::EnumInfo*>(I), os);
-        break;
-    case InfoType::IT_function:
-        genMarkdown(config, *static_cast<clang::mrdox::FunctionInfo*>(I), os);
-        break;
-    case InfoType::IT_typedef:
-        genMarkdown(config, *static_cast<clang::mrdox::TypedefInfo*>(I), os);
-        break;
-    case InfoType::IT_default:
-        return llvm::createStringError(llvm::inconvertibleErrorCode(),
-            "unexpected InfoType");
+        auto const& I = corpus_.at(id);
+        switch(I.IT)
+        {
+        case InfoType::IT_function:
+            write(static_cast<FunctionInfo const&>(I));
+            break;
+        default:
+            break;
+        }
     }
-    return llvm::Error::success();
 }
-#endif
 
 //------------------------------------------------
-//
-// Writer
-//
+
+struct AsciidocGenerator::Writer::
+    FormalParam
+{
+    FieldTypeInfo const& I;
+    Writer& w;
+
+    friend
+    llvm::raw_ostream&
+    operator<<(
+        llvm::raw_ostream& os,
+        FormalParam const& t)
+    {
+        t.w.write(t, os);
+        return os;
+    }
+};
+
+struct AsciidocGenerator::Writer::
+    TypeName
+{
+    TypeInfo const& I;
+    Writer& w;
+
+    friend
+    llvm::raw_ostream&
+    operator<<(
+        llvm::raw_ostream& os,
+        TypeName const& t)
+    {
+        t.w.write(t, os);
+        return os;
+    }
+};
+
 //------------------------------------------------
 
-bool
+void
+AsciidocGenerator::
 Writer::
-build(
-    llvm::StringRef rootDir)
+write(
+    FunctionInfo const& I)
 {
-    return true;
+    openSection(I.Name);
+    *os_ << I.javadoc.brief << "\n\n";
+
+    openSection("Synopsis");
+    *os_ <<
+        "Located in <" <<
+        I.Loc[0].Filename << ">\n" <<
+        "[,cpp]\n"
+        "----\n";
+
+    // params
+    if(! I.Params.empty())
+    {
+        *os_ <<
+            typeName(I.ReturnType) << '\n' <<
+            I.Name << "(\n"
+            "    " << formalParam(I.Params[0]);
+        for(std::size_t i = 1; i < I.Params.size(); ++i)
+        {
+            *os_ << ",\n"
+                "    " << formalParam(I.Params[i]);
+        }
+        *os_ << ");\n";
+    }
+    else
+    {
+        *os_ << I.Name << "();" << "\n";
+    }
+
+    *os_ <<
+        "----\n";
+    closeSection();
+
+    if(! I.javadoc.desc.empty())
+    {
+        *os_ << "\n";
+        openSection("Description");
+        *os_ << I.javadoc.desc << "\n";
+        closeSection();
+    }
+
+    closeSection();
 }
 
-bool
+//------------------------------------------------
+
+void
+AsciidocGenerator::
 Writer::
-buildOne(
+write(
+    FormalParam const& t,
     llvm::raw_ostream& os)
 {
-    return true;
+    assert(&os == os_);
+    auto const& I = t.I;
+    *os_ << I.Type.Name << ' ' << I.Name;
+}
+
+auto
+AsciidocGenerator::
+Writer::
+formalParam(
+    FieldTypeInfo const& t) ->
+        FormalParam
+{
+    return FormalParam{ t, *this };
+}
+
+//------------------------------------------------
+
+void
+AsciidocGenerator::
+Writer::
+write(
+    TypeName const& t,
+    llvm::raw_ostream& os)
+{
+    assert(&os == os_);
+    if(t.I.Type.USR == EmptySID)
+    {
+        *os_ << t.I.Type.Name;
+        return;
+    }
+    auto const& I = corpus_.get<RecordInfo>(t.I.Type.USR);
+    // VFALCO add namespace qualifiers if I is in
+    //        a different namesapce
+    *os_ << I.Name;
+}
+
+auto
+AsciidocGenerator::
+Writer::
+typeName(
+    TypeInfo const& t) ->
+        TypeName
+{
+    return TypeName{ t, *this };
+}
+
+//------------------------------------------------
+
+void
+AsciidocGenerator::
+Writer::
+openSection(
+    llvm::StringRef name)
+{
+    sect_.level++;
+    if(sect_.level <= 6)
+        sect_.markup.push_back('=');
+    *os_ << sect_.markup << ' ' << name << "\n\n";
+}
+
+void
+AsciidocGenerator::
+Writer::
+closeSection()
+{
+    assert(sect_.level > 0);
+    if(sect_.level <= 6)
+        sect_.markup.pop_back();
+    sect_.level--;
 }
 
+//------------------------------------------------
+//------------------------------------------------
 //------------------------------------------------
 
+#if 0
+
 //
 // Asciidoc generation
 //
 
 std::string
 genEmphasis(
-    Twine const& t)
+    llvm::Twine const& t)
 {
     return "*" + t.str() + "*";
 }
@@ -853,7 +1015,7 @@ genIndex(
     return llvm::Error::success();
 }
 
-} // (anon)
+#endif
 
 //------------------------------------------------
 

source/lib/Asciidoc.hpp

@@ -26,10 +26,12 @@
 namespace clang {
 namespace mrdox {
 
-namespace {
-
-struct AsciidocGenerator : Generator
+class AsciidocGenerator
+    : public Generator
 {
+public:
+    class Writer;
+
     llvm::StringRef
     name() const noexcept override
     {
@@ -64,23 +66,12 @@ struct AsciidocGenerator : Generator
         Corpus const& corpus,
         Config const& config,
         Reporter& R) const override;
-
-    bool
-    build(
-        llvm::raw_ostream& os,
-        Corpus const& corpus,
-        Config const& config,
-        Reporter& R) const;
 };
 
 //------------------------------------------------
 
-class Writer
+class AsciidocGenerator::Writer
 {
-    Corpus const& corpus_;
-    Config const& config_;
-    Reporter& R_;
-
 public:
     Writer(
         Corpus const& corpus,
@@ -92,12 +83,37 @@ class Writer
     {
     }
 
-    bool build(llvm::StringRef rootDir);
+    void write(llvm::StringRef rootDir);
+    void writeOne(llvm::raw_ostream& os);
 
-    bool buildOne(llvm::raw_ostream& os);
-};
+    void writeAllSymbols();
+
+    void write(FunctionInfo const& I);
+
+    struct FormalParam;
+    void write(FormalParam const& p, llvm::raw_ostream& os);
+    FormalParam formalParam(FieldTypeInfo const& ft);
 
-} // (anon)
+    struct TypeName;
+    void write(TypeName const& tn, llvm::raw_ostream& os);
+    TypeName typeName(TypeInfo const& ti);
+
+    void openSection(llvm::StringRef name);
+    void closeSection();
+
+private:
+    struct Section
+    {
+        int level = 0;
+        std::string markup;
+    };
+
+    Corpus const& corpus_;
+    Config const& config_;
+    Reporter& R_;
+    llvm::raw_ostream* os_ = nullptr;
+    Section sect_;
+};
 
 } // mrdox
 } // clang