refactor metadata extraction

cppalliance · May 4, 2023 · 1cee02e · 1cee02e
1 parent 81d2d91
commit 1cee02e
Show file tree

Hide file tree

Showing 38 changed files with 1,405 additions and 1,683 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -93,7 +93,7 @@ file(GLOB_RECURSE LIB_SOURCES CONFIGURE_DEPENDS
     source/api/*.h
     source/api/*.hpp
     source/api/*.cpp
-    #source/api/*.natvis
+    source/api/*.natvis
 )
 
 add_library(mrdox-api ${MRDOX_LINK_MODE} ${LIB_INCLUDES} ${LIB_SOURCES})

diff --git a/include/mrdox/Corpus.hpp b/include/mrdox/Corpus.hpp
@@ -106,7 +106,7 @@ class MRDOX_VISIBLE
         MRDOX_DECL virtual bool visit(FunctionInfo const&);
         MRDOX_DECL virtual bool visit(TypedefInfo const&);
         MRDOX_DECL virtual bool visit(EnumInfo const&);
-        MRDOX_DECL virtual bool visit(VariableInfo const&);
+        MRDOX_DECL virtual bool visit(VarInfo const&);
     };
 
     /** Visit the specified symbol ID or node.
@@ -160,7 +160,7 @@ get(
         Assert(t->IT == InfoType::IT_typedef);
     else if constexpr(std::is_same_v<T, EnumInfo>)
         Assert(t->IT == InfoType::IT_enum);
-    else if constexpr(std::is_same_v<T, VariableInfo>)
+    else if constexpr(std::is_same_v<T, VarInfo>)
         Assert(t->IT == InfoType::IT_variable);
     return *t;
 }

diff --git a/include/mrdox/Metadata.hpp b/include/mrdox/Metadata.hpp
@@ -36,6 +36,6 @@
 #include <mrdox/Metadata/TemplateParam.hpp>
 #include <mrdox/Metadata/Type.hpp>
 #include <mrdox/Metadata/Typedef.hpp>
-#include <mrdox/Metadata/Variable.hpp>
+#include <mrdox/Metadata/Var.hpp>
 
 #endif
diff --git a/include/mrdox/Metadata/Function.hpp b/include/mrdox/Metadata/Function.hpp
@@ -83,7 +83,9 @@ enum class FnFlags1 : std::uint32_t
                               0x00000008 +
                               0x00000010,
 
-    isExplicit              = 0x00000020
+    isExplicit              = 0x00000020,
+
+    functionKind            = 0b00000000'00000000'00011111'11000000
 };
 
 // TODO: Expand to allow for documenting templating and default args.

diff --git a/include/mrdox/Metadata/Scope.hpp b/include/mrdox/Metadata/Scope.hpp
@@ -39,7 +39,7 @@ struct Scope
     std::vector<Reference> Functions;
     std::vector<Reference> Typedefs;
     std::vector<Reference> Enums;
-    std::vector<Reference> Variables;
+    std::vector<Reference> Vars;
 
     explicit
     Scope(

diff --git a/include/mrdox/Metadata/Variable.hpp → include/mrdox/Metadata/Var.hpp b/include/mrdox/Metadata/Variable.hpp → include/mrdox/Metadata/Var.hpp
@@ -31,7 +31,7 @@ enum class VarFlags0 : std::uint32_t
     This includes variables at namespace
     scope, and static variables at class scope.
 */
-struct VariableInfo
+struct VarInfo
     : SymbolInfo
     , TypeInfo // holds the type of this variable
 {
@@ -42,7 +42,7 @@ struct VariableInfo
     static constexpr InfoType type_id = InfoType::IT_variable;
 
     explicit
-    VariableInfo(
+    VarInfo(
         SymbolID ID = SymbolID(),
         llvm::StringRef Name = llvm::StringRef())
         : SymbolInfo(InfoType::IT_variable, ID, Name)

diff --git a/include/mrdox/MetadataFwd.hpp b/include/mrdox/MetadataFwd.hpp
@@ -44,7 +44,7 @@ struct TemplateParamInfo;
 struct TemplateSpecializationInfo;
 struct TypeInfo;
 struct TypedefInfo;
-struct VariableInfo;
+struct VarInfo;
 struct VerbatimBlock;
 
 } // mrdox

diff --git a/mrdox.rnc b/mrdox.rnc
@@ -100,7 +100,7 @@ grammar {
         Javadoc?
     }
 
-    VariableInfo = element variable {
+    VarInfo = element var {
             Name,
             Id,
             (Location &

diff --git a/mrdox.rng b/mrdox.rng
@@ -205,8 +205,8 @@
       </optional>
     </element>
   </define>
-  <define name="VariableInfo">
-    <element name="variable">
+  <define name="VarInfo">
+    <element name="var">
       <ref name="Name"/>
       <ref name="Id"/>
       <interleave>
@@ -302,7 +302,7 @@
         <ref name="FunctionInfo"/>
         <ref name="TypedefInfo"/>
         <ref name="EnumInfo"/>
-        <ref name="VariableInfo"/>
+        <ref name="VarInfo"/>
       </choice>
     </zeroOrMore>
   </define>