extract variables

Author: vinniefalco

Diff for: CMakeLists.txt

@@ -92,7 +92,8 @@ 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})
 target_compile_features(mrdox-api PUBLIC cxx_std_20)

Diff for: include/mrdox/Metadata.hpp

@@ -36,5 +36,6 @@
 #include <mrdox/Metadata/TemplateParam.hpp>
 #include <mrdox/Metadata/Type.hpp>
 #include <mrdox/Metadata/Typedef.hpp>
+#include <mrdox/Metadata/Variable.hpp>
 
 #endif

Diff for: include/mrdox/Metadata/Scope.hpp

@@ -39,6 +39,7 @@ struct Scope
     std::vector<Reference> Functions;
     std::vector<TypedefInfo> Typedefs;
     std::vector<EnumInfo> Enums;
+    std::vector<Reference> Variables;
 
     explicit
     Scope(

Diff for: include/mrdox/Metadata/Symbols.hpp

@@ -47,7 +47,8 @@ enum class InfoType
     IT_record,
     IT_function,
     IT_enum,
-    IT_typedef
+    IT_typedef,
+    IT_variable
 };
 
 /** Return the result of comparing s0 to s1.

Diff for: include/mrdox/Metadata/Variable.hpp

@@ -0,0 +1,41 @@
+//
+// 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_METADATA_VARIABLE_HPP
+#define MRDOX_METADATA_VARIABLE_HPP
+
+#include <mrdox/Platform.hpp>
+#include <mrdox/Metadata/Symbol.hpp>
+
+namespace clang {
+namespace mrdox {
+
+/** A variable.
+
+    This includes variables at namespace
+    scope, and static variables at class scope.
+*/
+struct VariableInfo : SymbolInfo
+{
+    TypeInfo Type;
+
+    explicit
+    VariableInfo(
+        SymbolID ID = SymbolID(),
+        llvm::StringRef Name = llvm::StringRef())
+        : SymbolInfo(InfoType::IT_variable, ID, Name)
+    {
+    }
+};
+
+} // mrdox
+} // clang
+
+#endif

Diff for: include/mrdox/MetadataFwd.hpp

@@ -44,6 +44,7 @@ struct TemplateParamInfo;
 struct TemplateSpecializationInfo;
 struct TypeInfo;
 struct TypedefInfo;
+struct VariableInfo;
 struct VerbatimBlock;
 
 } // mrdox

Diff for: source/api/AST/ASTVisitor.cpp

@@ -268,6 +268,15 @@ WalkUpFromEnumDecl(
     return true;
 }
 
+bool
+ASTVisitor::
+WalkUpFromVarDecl(
+    VarDecl* D)
+{
+    mapDecl(D);
+    return true;
+}
+
 int
 ASTVisitor::
 getLine(

Diff for: source/api/AST/ASTVisitor.hpp

@@ -79,6 +79,7 @@ class ASTVisitor
     bool WalkUpFromTypeAliasDecl(TypeAliasDecl* D);
     bool WalkUpFromTypedefDecl(TypedefDecl* D);
     bool WalkUpFromEnumDecl(EnumDecl* D);
+    bool WalkUpFromVarDecl(VarDecl* D);
 
 private:
     template <typename T>

Diff for: source/api/AST/BitcodeIDs.hpp

@@ -67,6 +67,7 @@ enum BlockId
     BI_TEMPLATE_SPECIALIZATION_BLOCK_ID,
     BI_TYPE_BLOCK_ID,
     BI_TYPEDEF_BLOCK_ID,
+    BI_VARIABLE_BLOCK_ID,
     BI_LAST,
     BI_FIRST = BI_VERSION_BLOCK_ID
 };
@@ -126,6 +127,10 @@ enum RecordId
     TYPEDEF_NAME,
     TYPEDEF_DEFLOCATION,
     TYPEDEF_IS_USING,
+    VARIABLE_USR,
+    VARIABLE_NAME,
+    VARIABLE_DEFLOCATION,
+    VARIABLE_LOCATION,
     RI_LAST,
     RI_FIRST = VERSION
 };

Diff for: source/api/AST/BitcodeReader.cpp

@@ -201,12 +201,13 @@ decodeRecord(
     case InfoType::IT_function:
     case InfoType::IT_enum:
     case InfoType::IT_typedef:
-    case InfoType::IT_default:
+    case InfoType::IT_variable:
         Field = IT;
         return llvm::Error::success();
+    default:
+        Field = InfoType::IT_default;
+        return makeError("invalid value for InfoType");
     }
-    Field = InfoType::IT_default;
-    return makeError("invalid value for InfoType");
 }
 
 static