remove Path from meta

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -15,7 +15,6 @@
 #include <mrdox/Config.hpp>
 #include <mrdox/MetadataFwd.hpp>
 #include <mrdox/Reporter.hpp>
-#include <mrdox/meta/Index.hpp>
 #include <mrdox/meta/Symbols.hpp>
 #include <clang/Tooling/Execution.h>
 #include <llvm/Support/Mutex.h>

include/mrdox/Metadata.hpp

@@ -15,11 +15,11 @@
 // All headers related to
 // metadata extracted from AST
 
+#include <mrdox/meta/BaseRecord.hpp>
 #include <mrdox/meta/Enum.hpp>
 #include <mrdox/meta/FieldType.hpp>
 #include <mrdox/meta/Function.hpp>
 #include <mrdox/meta/Overloads.hpp>
-#include <mrdox/meta/Index.hpp>
 #include <mrdox/meta/Info.hpp>
 #include <mrdox/meta/Javadoc.hpp>
 #include <mrdox/meta/Location.hpp>

include/mrdox/MetadataFwd.hpp

@@ -27,7 +27,6 @@ struct FieldTypeInfo;
 struct FunctionInfo;
 struct Overloads;
 struct OverloadsSet;
-struct Index;
 struct Info;
 struct Javadoc;
 struct Location;

include/mrdox/meta/BaseRecord.hpp

@@ -0,0 +1,44 @@
+//
+// 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_META_BASERECORD_HPP
+#define MRDOX_META_BASERECORD_HPP
+
+#include <mrdox/meta/Record.hpp>
+
+namespace clang {
+namespace mrdox {
+
+struct BaseRecordInfo : public RecordInfo
+{
+    BaseRecordInfo();
+
+    BaseRecordInfo(
+        SymbolID USR,
+        llvm::StringRef Name,
+        bool IsVirtual,
+        AccessSpecifier Access,
+        bool IsParent);
+
+    // Indicates if base corresponds to a virtual inheritance
+    bool IsVirtual = false;
+
+    // Access level associated with this inherited info (public, protected,
+    // private).
+    AccessSpecifier Access = AccessSpecifier::AS_public;
+
+    bool IsParent = false; // Indicates if this base is a direct parent
+};
+
+} // mrdox
+} // clang
+
+#endif

include/mrdox/meta/Index.hpp

@@ -49,12 +49,6 @@ struct Info
     */
     Javadoc javadoc;
 
-    // Path of directory where the clang-doc
-    // generated file will be saved
-    llvm::SmallString<128> Path;          
-
-    std::string mangledName;
-
     //--------------------------------------------
 
     virtual ~Info() = default;
@@ -65,25 +59,21 @@ struct Info
     Info(
         InfoType IT = InfoType::IT_default,
         SymbolID USR = SymbolID(),
-        llvm::StringRef Name = llvm::StringRef(),
-        llvm::StringRef Path = llvm::StringRef())
+        llvm::StringRef Name = llvm::StringRef())
         : USR(USR)
         , IT(IT)
         , Name(Name)
-        , Path(Path)
     {
     }
 
     bool canMerge(const Info& Other);
     void mergeBase(Info&& I);
 
-    llvm::SmallString<16> extractName() const;
-
-    /// Returns the file path for this Info relative to CurrentPath.
-    llvm::SmallString<64> getRelativeFilePath(llvm::StringRef const& CurrentPath) const;
+    //
+    // Observers
+    //
 
-    /// Returns the basename that should be used for this Info.
-    //llvm::SmallString<16> getFileBaseName() const;
+    llvm::SmallString<16> extractName() const;
 
     /** Return the fully qualified name.
     */
@@ -93,30 +83,12 @@ struct Info
 
     /** Return a string representing the symbol type.
 
-        This will be one of:
-
-        @li default
-        @li namespace
-        @li class
-        @li struct
-        @li union
-        @li function
-        @li enum
-        @li typedef
+        For example, "namespace", "class", et. al.
     */
     llvm::StringRef
     symbolType() const noexcept;
 };
 
-//------------------------------------------------
-
-llvm::SmallString<64>
-calculateRelativeFilePath(
-    InfoType const& Type,
-    llvm::StringRef const& Path,
-    llvm::StringRef const& Name,
-    llvm::StringRef const& CurrentPath);
-
 } // mrdox
 } // clang
 

include/mrdox/meta/Info.hpp

@@ -31,8 +31,7 @@ struct NamespaceInfo
 
     NamespaceInfo(
         SymbolID USR,
-        llvm::StringRef Name = llvm::StringRef(),
-        llvm::StringRef Path = llvm::StringRef());
+        llvm::StringRef Name = llvm::StringRef());
 
     void merge(NamespaceInfo&& I);
 };

include/mrdox/meta/Namespace.hpp

@@ -37,8 +37,7 @@ struct RecordInfo : SymbolInfo
 
     RecordInfo(
         SymbolID USR = SymbolID(),
-        llvm::StringRef Name = llvm::StringRef(),
-        llvm::StringRef Path = llvm::StringRef());
+        llvm::StringRef Name = llvm::StringRef());
 
     void merge(RecordInfo&& I);
 
@@ -68,30 +67,6 @@ struct RecordInfo : SymbolInfo
     Scope Children;
 };
 
-//------------------------------------------------
-
-struct BaseRecordInfo : public RecordInfo
-{
-    BaseRecordInfo();
-
-    BaseRecordInfo(
-        SymbolID USR,
-        llvm::StringRef Name,
-        llvm::StringRef Path,
-        bool IsVirtual,
-        AccessSpecifier Access,
-        bool IsParent);
-
-    // Indicates if base corresponds to a virtual inheritance
-    bool IsVirtual = false;
-
-    // Access level associated with this inherited info (public, protected,
-    // private).
-    AccessSpecifier Access = AccessSpecifier::AS_public;
-
-    bool IsParent = false; // Indicates if this base is a direct parent
-};
-
 } // mrdox
 } // clang
 

include/mrdox/meta/Record.hpp

@@ -35,10 +35,6 @@ struct Reference
     */
     InfoType RefType = InfoType::IT_default;
 
-    // Path of directory where the generated file
-    // will be saved (possibly unresolved)
-    llvm::SmallString<128> Path;
-
     //--------------------------------------------
 
     // This variant (that takes no qualified name parameter) uses the Name as the
@@ -56,18 +52,6 @@ struct Reference
     {
     }
 
-    Reference(
-        SymbolID USR,
-        llvm::StringRef Name,
-        InfoType IT,
-        llvm::StringRef Path)
-        : USR(USR)
-        , Name(Name)
-        , RefType(IT)
-        , Path(Path)
-    {
-    }
-
     bool
     operator==(
         Reference const& Other) const
@@ -81,12 +65,6 @@ struct Reference
 
     bool canMerge(Reference const& Other);
     void merge(Reference&& I);
-
-    /// Returns the path for this Reference relative to CurrentPath.
-    llvm::SmallString<64> getRelativeFilePath(llvm::StringRef const& CurrentPath) const;
-
-    /// Returns the basename that should be used for this Reference.
-    //llvm::SmallString<16> getFileBaseName() const;
 };
 
 } // mrdox

include/mrdox/meta/Reference.hpp

@@ -33,9 +33,8 @@ struct SymbolInfo : Info
     SymbolInfo(
         InfoType IT,
         SymbolID USR = SymbolID(),
-        llvm::StringRef Name = llvm::StringRef(),
-        llvm::StringRef Path = llvm::StringRef())
-        : Info(IT, USR, Name, Path)
+        llvm::StringRef Name = llvm::StringRef())
+        : Info(IT, USR, Name)
     {
     }