xml work

Author: vinniefalco

NOTES.adoc

@@ -15,3 +15,9 @@ cmake --install . --prefix "C:\Users\vinnie\src\llvm-install\Debug" --config Deb
 # MrDox
 cmake -G "Visual Studio 17 2022" -A x64 -B bin64 -DCMAKE_PREFIX_PATH="C:\Users\vinnie\src\llvm-install\RelWithDebInfo" -DCMAKE_TOOLCHAIN_FILE="C:\Users\vinnie\src\mrdox\toolchain.cmake"
 ```
+
+== Implementation notes
+
+Namespaces do not have a source location. This is because there
+can be many namespaces. We probably don't want to store any
+javadocs for namespaces either.

include/mrdox/Corpus.hpp

@@ -23,8 +23,9 @@ namespace mrdox {
 
 /** The collection of declarations in extracted form.
 */
-struct Corpus
+class Corpus
 {
+public:
     /** Index of all emitted symbols.
     */
     Index Idx;

source/lib/Asciidoc.hpp

@@ -71,12 +71,6 @@ struct AsciidocGenerator : Generator
         Corpus const& corpus,
         Config const& config,
         Reporter& R) const;
-
-    llvm::Error
-    generateDocForInfo(
-        Info* I,
-        llvm::raw_ostream& os,
-        Config const& config);
 };
 
 //------------------------------------------------

source/lib/Symbol.hpp

@@ -19,10 +19,15 @@
 namespace clang {
 namespace mrdox {
 
-// Info for symbols.
-struct SymbolInfo
-    : public Info
+/** Base class for Info that have source locations.
+*/
+struct SymbolInfo : Info
 {
+    llvm::Optional<Location> DefLoc;     // Location where this decl is defined.
+    llvm::SmallVector<Location, 2> Loc; // Locations where this decl is declared.
+
+    //--------------------------------------------
+
     explicit
     SymbolInfo(
         InfoType IT,
@@ -34,9 +39,6 @@ struct SymbolInfo
     }
 
     void merge(SymbolInfo&& I);
-
-    llvm::Optional<Location> DefLoc;     // Location where this decl is defined.
-    llvm::SmallVector<Location, 2> Loc; // Locations where this decl is declared.
 };
 
 } // mrdox

source/lib/Visitor.cpp

@@ -106,8 +106,9 @@ mapDecl(T const* D)
         config_.PublicOnly,
         R_);
 
-    // A null in place of I indicates that the serializer is skipping this decl
-    // for some reason (e.g. we're only reporting public decls).
+    // A null in place of I indicates that the
+    // serializer is skipping this decl for some
+    // reason (e.g. we're only reporting public decls).
     if (I.first)
         Corpus::reportResult(exc_, *I.first);
     if (I.second)
@@ -159,8 +160,6 @@ VisitFunctionDecl(
     return mapDecl(D);
 }
 
-// https://github.com/llvm/llvm-project/blob/466d554dcab39c3d42fe0c5b588b795e0e4b9d0d/clang/include/clang/AST/Type.h#L1566
-
 bool
 Visitor::
 VisitTypedefDecl(TypedefDecl const* D)

source/lib/XML.cpp

@@ -46,7 +46,7 @@ buildOne(
     }
 
     Writer w(corpus, config, R);
-    return w.build(os);
+    return w.write(os);
 }
 
 bool
@@ -60,7 +60,7 @@ buildString(
     dest.clear();
     llvm::raw_string_ostream os(dest);
     Writer w(corpus, config, R);
-    return w.build(os);
+    return w.write(os);
 }
 
 //------------------------------------------------
@@ -69,9 +69,20 @@ buildString(
 //
 //------------------------------------------------
 
+Writer::
+Writer(
+    Corpus const& corpus,
+    Config const& config,
+    Reporter& R) noexcept
+    : corpus_(corpus)
+    , config_(config)
+    , R_(R)
+{
+}
+
 bool
 Writer::
-build(
+write(
     llvm::raw_ostream& os)
 {
     auto const ns = findGlobalNamespace();
@@ -178,8 +189,6 @@ Writer::
 write(
     NamespaceInfo const& I)
 {
-    assertExists(I);
-
     openTag("namespace", {
         { "name", I.Name },
         { I.USR }
@@ -198,8 +207,6 @@ Writer::
 write(
     RecordInfo const& I)
 {
-    assertExists(I);
-
     llvm::StringRef tag;
     switch(I.TagType)
     {
@@ -226,21 +233,17 @@ Writer::
 write(
     FunctionInfo const& I)
 {
-    //assertExists(I);
-
     openTag("function", {
         { "name", I.Name },
-        { "access", toString(I.Access) },
+        { I.Access },
         { I.USR }
         });
     writeSymbolInfo(I);
     writeTag("return", {
         { "name", I.ReturnType.Type.Name },
         { I.ReturnType.Type.USR }
         });
-
     write(I.Params);
-
     write(I.ReturnType.Type);
     if(I.Template)
     {
@@ -250,7 +253,6 @@ write(
                 { "n", tp.Contents }
                 });
     }
-    write(I.Loc);
 
     closeTag("function");
 }
@@ -260,8 +262,6 @@ Writer::
 write(
     EnumInfo const& I)
 {
-    //assertExists(I);
-
     openTag("enum", {
         { "name", I.Name },
         { I.USR }
@@ -282,18 +282,36 @@ Writer::
 write(
     TypedefInfo const& I)
 {
-    //assertExists(I);
-
+    writeSymbolInfo(I);
     openTag("typedef", {
         { "name", I.Name },
         { I.USR }
         });
-    writeSymbolInfo(I);
     if(I.Underlying.Type.USR != EmptySID)
         writeTagLine("qualusr", toBase64(I.Underlying.Type.USR));
     closeTag("typedef");
 }
 
+void
+Writer::
+writeSymbolInfo(
+    SymbolInfo const& I)
+{
+    writeInfo(I);
+    // VFALCO Why so many Location?
+    if(I.DefLoc)
+        write(*I.DefLoc);
+    for(auto const& loc : I.Loc)
+        write(loc);
+}
+
+void
+Writer::
+writeInfo(
+    Info const& I)
+{
+}
+
 //------------------------------------------------
 
 void
@@ -337,57 +355,22 @@ write(
         //});
     //writeTagLine("relpath", ref.getRelativeFilePath());
     //writeTagLine("basename",I.getFileBaseName());
-    writeTagLine("name", I.Name);
-    writeTagLine("tag", std::to_string(static_cast<int>(I.RefType)));
-    writeTagLine("path", I.Path);
+    //writeTagLine("name", I.Name);
+    //writeTagLine("tag", std::to_string(static_cast<int>(I.RefType)));
+    //writeTagLine("path", I.Path);
     //closeTag("ref");
 }
 
 //------------------------------------------------
 
-void
-Writer::
-writeInfo(
-    Info const& I)
-{
-#if 0
-    writeTagLine("extract-name", I.extractName());
-    auto relPath = I.getRelativeFilePath(config_.SourceRoot);
-    if(! relPath.empty())
-        writeTagLine("rel-path", relPath);
-    writeTagLine("base-name", I.getFileBaseName());
-#endif
-}
-
-void
-Writer::
-writeSymbolInfo(
-    SymbolInfo const& I)
-{
-    writeInfo(I);
-    if(I.DefLoc)
-        write(*I.DefLoc);
-    write(I.Loc);
-}
-
-void
-Writer::
-write(
-    llvm::ArrayRef<Location> const& locs)
-{
-    for(auto const& loc : locs)
-        write(loc);
-}
-
 void
 Writer::
 write(
     Location const& loc)
 {
-    *os_ << level_ <<
-        "<file>" << escape(loc.Filename) <<
-        "</file><line>" << std::to_string(loc.LineNumber) <<
-        "</line>\n";
+    writeTag("file", {
+        { "path", loc.Filename },
+        { "line", std::to_string(loc.LineNumber) }});
 }
 
 //------------------------------------------------
@@ -494,6 +477,22 @@ outdent()
 
 //------------------------------------------------
 
+NamespaceInfo const*
+Writer::
+findGlobalNamespace()
+{
+    auto p = corpus_.find(EmptySID);
+    if(p != nullptr)
+    {
+        assert(p->Name.empty());
+        assert(p->IT == InfoType::IT_namespace);
+        return static_cast<NamespaceInfo const*>(p);
+    }
+    return nullptr;
+}
+
+//------------------------------------------------
+
 std::string
 Writer::
 toString(
@@ -521,32 +520,6 @@ toString(
     }
 }
 
-//------------------------------------------------
-
-NamespaceInfo const*
-Writer::
-findGlobalNamespace()
-{
-    auto p = corpus_.find(EmptySID);
-    if(p != nullptr)
-    {
-        assert(p->Name.empty());
-        assert(p->IT == InfoType::IT_namespace);
-        return static_cast<NamespaceInfo const*>(p);
-    }
-    return nullptr;
-}
-
-#ifndef NDEBUG
-void
-Writer::
-assertExists(
-    Info const& I)
-{
-    assert(corpus_.exists(I.USR));
-}
-#endif
-
 llvm::StringRef
 Writer::
 toString(
@@ -567,16 +540,6 @@ toString(
 
 //------------------------------------------------
 
-llvm::Error
-Writer::
-generateDocForInfo(
-    clang::mrdox::Info* I,
-    llvm::raw_ostream& os,
-    clang::mrdox::Config const& config)
-{
-    return llvm::Error::success();
-}
-
 } // (anon)
 
 //------------------------------------------------