refactor into jad files

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -12,7 +12,8 @@
 #ifndef MRDOX_CORPUS_HPP
 #define MRDOX_CORPUS_HPP
 
-#include "Representation.h"
+#include "jad/Index.hpp"
+#include <clang/Tooling/Execution.h>
 
 namespace clang {
 namespace mrdox {

source/lib/AsciidocGenerator.cpp

@@ -9,10 +9,11 @@
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#include <mrdox/Config.hpp>
-#include <mrdox/Corpus.hpp>
 #include "Generators.h"
 #include "Representation.h"
+#include "jad/Namespace.hpp"
+#include <mrdox/Config.hpp>
+#include <mrdox/Corpus.hpp>
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/Path.h"

source/lib/BitcodeWriter.cpp

@@ -16,9 +16,6 @@
 namespace clang {
 namespace mrdox {
 
-// Empty SymbolID for comparison, so we don't have to construct one every time.
-static const SymbolID EmptySID = SymbolID();
-
 // Since id enums are not zero-indexed, we need to transform the given id into
 // its associated index.
 struct BlockIdToIndexFunctor {

source/lib/BitcodeWriter.h

@@ -19,6 +19,7 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_BITCODEWRITER_H
 
 #include "Representation.h"
+#include "jad/Namespace.hpp"
 #include "clang/AST/AST.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/SmallVector.h"

source/lib/Reduce.h

@@ -12,12 +12,14 @@
 #ifndef MRDOX_REDUCE_HPP
 #define MRDOX_REDUCE_HPP
 
-#include <Representation.h>
+#include "jad/Info.hpp"
+#include <llvm/Support/Error.h>
+#include <memory>
+#include <vector>
 
 namespace clang {
 namespace mrdox {
 
-SymbolID const EmptySID = SymbolID();
 template <typename T>
 llvm::Expected<std::unique_ptr<Info>>
 reduce(

source/lib/Representation.cpp

@@ -25,6 +25,7 @@
 
 #include "Reduce.h"
 #include "Representation.h"
+#include "jad/Namespace.hpp"
 #include <mrdox/Config.hpp>
 #include "llvm/Support/Error.h"
 #include "llvm/Support/Path.h"
@@ -99,163 +100,6 @@ bool CommentInfo::operator<(const CommentInfo& Other) const {
     return false;
 }
 
-static llvm::SmallString<64>
-calculateRelativeFilePath(const InfoType& Type, const StringRef& Path,
-    const StringRef& Name, const StringRef& CurrentPath) {
-    llvm::SmallString<64> FilePath;
-
-    if (CurrentPath != Path) {
-        // iterate back to the top
-        for (llvm::sys::path::const_iterator I =
-            llvm::sys::path::begin(CurrentPath);
-            I != llvm::sys::path::end(CurrentPath); ++I)
-            llvm::sys::path::append(FilePath, "..");
-        llvm::sys::path::append(FilePath, Path);
-    }
-
-    // Namespace references have a Path to the parent namespace, but
-    // the file is actually in the subdirectory for the namespace.
-    if (Type == mrdox::InfoType::IT_namespace)
-        llvm::sys::path::append(FilePath, Name);
-
-    return llvm::sys::path::relative_path(FilePath);
-}
-
-llvm::SmallString<64>
-Reference::getRelativeFilePath(const StringRef& CurrentPath) const {
-    return calculateRelativeFilePath(RefType, Path, Name, CurrentPath);
-}
-
-llvm::SmallString<16> Reference::getFileBaseName() const {
-    if (RefType == InfoType::IT_namespace)
-        return llvm::SmallString<16>("index");
-
-    return Name;
-}
-
-llvm::SmallString<64>
-Info::getRelativeFilePath(const StringRef& CurrentPath) const {
-    return calculateRelativeFilePath(IT, Path, extractName(), CurrentPath);
-}
-
-llvm::SmallString<16> Info::getFileBaseName() const {
-    if (IT == InfoType::IT_namespace)
-        return llvm::SmallString<16>("index");
-
-    return extractName();
-}
-
-bool Reference::mergeable(const Reference& Other) {
-    return RefType == Other.RefType && USR == Other.USR;
-}
-
-void Reference::merge(Reference&& Other) {
-    assert(mergeable(Other));
-    if (Name.empty())
-        Name = Other.Name;
-    if (Path.empty())
-        Path = Other.Path;
-}
-
-void Info::mergeBase(Info&& Other)
-{
-    assert(mergeable(Other));
-    if (USR == EmptySID)
-        USR = Other.USR;
-    if (Name == "")
-        Name = Other.Name;
-    if (Path == "")
-        Path = Other.Path;
-    if (Namespace.empty())
-        Namespace = std::move(Other.Namespace);
-    // Unconditionally extend the description, since each decl may have a comment.
-    std::move(Other.Description.begin(), Other.Description.end(),
-        std::back_inserter(Description));
-    llvm::sort(Description);
-    auto Last = std::unique(Description.begin(), Description.end());
-    Description.erase(Last, Description.end());
-    if (javadoc.brief.empty())
-        javadoc.brief = std::move(Other.javadoc.brief);
-    if (javadoc.desc.empty())
-        javadoc.desc = std::move(Other.javadoc.desc);
-}
-
-bool Info::mergeable(const Info& Other) {
-    return IT == Other.IT && USR == Other.USR;
-}
-
-void SymbolInfo::merge(SymbolInfo&& Other) {
-    assert(mergeable(Other));
-    if (!DefLoc)
-        DefLoc = std::move(Other.DefLoc);
-    // Unconditionally extend the list of locations, since we want all of them.
-    std::move(Other.Loc.begin(), Other.Loc.end(), std::back_inserter(Loc));
-    llvm::sort(Loc);
-    auto Last = std::unique(Loc.begin(), Loc.end());
-    Loc.erase(Last, Loc.end());
-    mergeBase(std::move(Other));
-}
-
-NamespaceInfo::
-NamespaceInfo(
-    SymbolID USR,
-    StringRef Name,
-    StringRef Path)
-    : Info(InfoType::IT_namespace, USR, Name, Path)
-    // VFALCO Shouldn't this be AS_none? But
-    //        the Bitcode writer expects the
-    //        default to be AS_public...
-    , Children(clang::AccessSpecifier::AS_public)
-{
-}
-
-void
-NamespaceInfo::
-merge(NamespaceInfo&& Other)
-{
-    assert(mergeable(Other));
-    // Reduce children if necessary.
-    reduceChildren(Children.Namespaces, std::move(Other.Children.Namespaces));
-    reduceChildren(Children.Records, std::move(Other.Children.Records));
-    Children.functions.merge(std::move(Other.Children.functions));
-    reduceChildren(Children.Enums, std::move(Other.Children.Enums));
-    reduceChildren(Children.Typedefs, std::move(Other.Children.Typedefs));
-    mergeBase(std::move(Other));
-}
-
-RecordInfo::
-RecordInfo(
-    SymbolID USR,
-    StringRef Name,
-    StringRef Path)
-    : SymbolInfo(InfoType::IT_record, USR, Name, Path)
-    , scope()
-{
-}
-
-void RecordInfo::merge(RecordInfo&& Other) {
-    assert(mergeable(Other));
-    if (!TagType)
-        TagType = Other.TagType;
-    IsTypeDef = IsTypeDef || Other.IsTypeDef;
-    if (Members.empty())
-        Members = std::move(Other.Members);
-    if (Bases.empty())
-        Bases = std::move(Other.Bases);
-    if (Parents.empty())
-        Parents = std::move(Other.Parents);
-    if (VirtualParents.empty())
-        VirtualParents = std::move(Other.VirtualParents);
-    // Reduce children if necessary.
-    reduceChildren(Children.Records, std::move(Other.Children.Records));
-    Children.functions.merge(std::move(Other.Children.functions));
-    reduceChildren(Children.Enums, std::move(Other.Children.Enums));
-    reduceChildren(Children.Typedefs, std::move(Other.Children.Typedefs));
-    SymbolInfo::merge(std::move(Other));
-    if (!Template)
-        Template = Other.Template;
-}
-
 void EnumInfo::merge(EnumInfo&& Other) {
     assert(mergeable(Other));
     if (!Scoped)
@@ -299,43 +143,10 @@ BaseRecordInfo::BaseRecordInfo(SymbolID USR, StringRef Name, StringRef Path,
     : RecordInfo(USR, Name, Path), IsVirtual(IsVirtual), Access(Access),
     IsParent(IsParent) {}
 
-llvm::SmallString<16> Info::extractName() const {
-    if (!Name.empty())
-        return Name;
-
-    switch (IT) {
-    case InfoType::IT_namespace:
-        // Cover the case where the project contains a base namespace called
-        // 'GlobalNamespace' (i.e. a namespace at the same level as the global
-        // namespace, which would conflict with the hard-coded global namespace name
-        // below.)
-        if (Name == "GlobalNamespace" && Namespace.empty())
-            return llvm::SmallString<16>("@GlobalNamespace");
-        // The case of anonymous namespaces is taken care of in serialization,
-        // so here we can safely assume an unnamed namespace is the global
-        // one.
-        return llvm::SmallString<16>("GlobalNamespace");
-    case InfoType::IT_record:
-        return llvm::SmallString<16>("@nonymous_record_" +
-            toHex(llvm::toStringRef(USR)));
-    case InfoType::IT_enum:
-        return llvm::SmallString<16>("@nonymous_enum_" +
-            toHex(llvm::toStringRef(USR)));
-    case InfoType::IT_typedef:
-        return llvm::SmallString<16>("@nonymous_typedef_" +
-            toHex(llvm::toStringRef(USR)));
-    case InfoType::IT_function:
-        return llvm::SmallString<16>("@nonymous_function_" +
-            toHex(llvm::toStringRef(USR)));
-    case InfoType::IT_default:
-        return llvm::SmallString<16>("@nonymous_" + toHex(llvm::toStringRef(USR)));
-    }
-    llvm_unreachable("Invalid InfoType.");
-    return llvm::SmallString<16>("");
-}
-
-// Order is based on the Name attribute: case insensitive order
-bool Index::operator<(const Index& Other) const {
+// Order is based on the Name attribute:
+// case insensitive order
+bool
+Index::operator<(const Index& Other) const {
     // Loop through each character of both strings
     for (unsigned I = 0; I < Name.size() && I < Other.Name.size(); ++I) {
         // Compare them after converting both to lower case