serializer has state

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -20,6 +20,7 @@
 #include <clang/Tooling/Execution.h>
 #include <llvm/Support/Mutex.h>
 #include <memory>
+#include <string>
 #include <type_traits>
 #include <vector>
 
@@ -176,13 +177,20 @@ class Corpus
         std::shared_ptr<Config const> config,
         Reporter& R);
 
-    /** Store the Info in the tool results, keyed by SymbolID.
+    /** Store a key/value pair in the tool results.
+
+        This function inserts the bitcode for the
+        specified symbol ID into the tool results
+        of the execution context.
+
+        Each symbol ID can have multiple bitcodes.
     */
     static
     void
     reportResult(
         tooling::ExecutionContext& exc,
-        Info const& I);
+        SymbolID id,
+        std::string bitcode);
 
 private:
     struct Temps;

include/mrdox/Reporter.hpp

@@ -27,8 +27,9 @@ namespace mrdox {
 
 /** Used to check and report errors uniformly.
 */
-struct Reporter
+class Reporter
 {
+public:
     /** Return a suitable exit code.
     */
     int getExitCode() const noexcept;

source/lib/ast/Bitcode.hpp source/lib/Bitcode.hpp

@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_SOURCE_AST_BITCODE_HPP
-#define MRDOX_SOURCE_AST_BITCODE_HPP
+#ifndef MRDOX_SOURCE_BITCODE_HPP
+#define MRDOX_SOURCE_BITCODE_HPP
 
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Reporter.hpp>

source/lib/Corpus.cpp

@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include "ast/Bitcode.hpp"
-#include "ast/Serialize.hpp"
+#include "FrontendAction.hpp"
+#include "Bitcode.hpp"
 #include "meta/Reduce.hpp"
 #include <mrdox/Corpus.hpp>
 #include <mrdox/Error.hpp>
@@ -22,16 +22,6 @@
 namespace clang {
 namespace mrdox {
 
-// VFALCO This is in FrontendAction.cpp
-/** Return a factory used to visit the AST nodes.
-*/
-std::unique_ptr<tooling::FrontendActionFactory>
-extern
-makeFrontendActionFactory(
-    tooling::ExecutionContext& exc,
-    Config const& config,
-    Reporter& R);
-
 struct Corpus::Temps
 {
     std::string s0;
@@ -284,11 +274,11 @@ void
 Corpus::
 reportResult(
     tooling::ExecutionContext& exc,
-    Info const& I)
+    SymbolID id,
+    std::string bitcode)
 {
-    std::string s = serialize(I);
     exc.reportResult(
-        llvm::toStringRef(I.USR), std::move(s));
+        llvm::toStringRef(id), std::move(bitcode));
 }
 
 //------------------------------------------------

source/lib/FrontendAction.hpp

@@ -0,0 +1,36 @@
+//
+// 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_SOURCE_FRONTENDACTION_HPP
+#define MRDOX_SOURCE_FRONTENDACTION_HPP
+
+#include <clang/Tooling/Execution.h>
+#include <clang/Tooling/Tooling.h>
+#include <memory>
+
+namespace clang {
+namespace mrdox {
+
+class Config;
+class Reporter;
+
+/** Return a factory used to create our visitor.
+*/
+std::unique_ptr<tooling::FrontendActionFactory>
+makeFrontendActionFactory(
+    tooling::ExecutionContext& exc,
+    Config const& config,
+    Reporter& R);
+
+} // mrdox
+} // clang
+
+#endif

source/lib/ast/FrontendAction.cpp

@@ -11,30 +11,21 @@
 
 #include "Commands.hpp"
 #include "utility.hpp"
-#include "ast/Serialize.hpp"
-#include "ast/FrontendAction.hpp"
+#include "Serialize.hpp"
+#include "FrontendAction.hpp"
 #include <mrdox/Corpus.hpp>
 #include <clang/Index/USRGeneration.h>
 #include <clang/AST/RecursiveASTVisitor.h>
 #include <llvm/ADT/StringExtras.h>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/Path.h>
 
-//
-// This file implements the Mapper piece of the clang-doc tool. It implements
-// a RecursiveASTVisitor to look at each declaration and populate the info
-// into the internal representation. Each seen declaration is serialized to
-// to bitcode and written out to the ExecutionContext as a KV pair where the
-// key is the declaration's USR and the value is the serialized bitcode.
-//
-
 namespace clang {
 namespace mrdox {
 
 //------------------------------------------------
 
-/*  An instance of Visitor runs on one translation unit.
-*/
+// An instance of Visitor runs on one translation unit.
 void
 Visitor::
 HandleTranslationUnit(
@@ -45,13 +36,15 @@ HandleTranslationUnit(
     llvm::Optional<llvm::StringRef> filePath = 
         Context.getSourceManager().getNonBuiltinFilenameForID(
             Context.getSourceManager().getMainFileID());
-    if(filePath)
-    {
-        llvm::SmallString<0> s(*filePath);
-        convert_to_slash(s);
-        if(config_.shouldVisitTU(s))
-            TraverseDecl(Context.getTranslationUnitDecl());
-    }
+    if(! filePath)
+        return;
+
+    llvm::SmallString<0> s(*filePath);
+    convert_to_slash(s);
+    if(! config_.shouldVisitTU(s))
+        return;
+
+    TraverseDecl(Context.getTranslationUnitDecl());
 }
 
 template<typename T>
@@ -123,21 +116,21 @@ mapDecl(T const* D)
     // VFALCO is this right?
     bool const IsFileInRootDir = true;
 
-    auto I = buildInfoPair(
-        D,
+    Serializer sr(
         getLine(D, D->getASTContext()),
         filePath,
         IsFileInRootDir,
-        ! config_.includePrivate(),
+        config_,
         R_);
+    auto I = sr.buildInfoPair(D);
 
     // 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(ex_, *I.first);
+        Corpus::reportResult(ex_, I.first->USR, serialize(*I.first));
     if (I.second)
-        Corpus::reportResult(ex_, *I.second);
+        Corpus::reportResult(ex_, I.second->USR, serialize(*I.second));
 
     return true;
 }

source/lib/ast/FrontendAction.hpp

@@ -9,8 +9,8 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_FRONTENDACTION_HPP
-#define MRDOX_FRONTENDACTION_HPP
+#ifndef MRDOX_SOURCE_AST_FRONTENDACTION_HPP
+#define MRDOX_SOURCE_AST_FRONTENDACTION_HPP
 
 #include <mrdox/Config.hpp>
 #include <mrdox/Reporter.hpp>
@@ -21,7 +21,17 @@
 namespace clang {
 namespace mrdox {
 
-/** Visits AST and converts it to our metadata.
+/** Convert AST to our metadata and serialize to bitcode.
+
+    An instance of this object visits the AST
+    for exactly one translation unit. The AST is
+    converted into our metadata, and this metadata
+    is then serialized into bitcode. The resulting
+    bitcode is inserted into the tool results,
+    keyed by USR. Each USR can have multiple
+    serialized bitcodes, as the same declaration
+    in a particular include file can be seen by
+    more than one translation unit.
 */
 class Visitor
     : public RecursiveASTVisitor<Visitor>