merge mutually exclusive field and variable symbol types

#improvement

Author: alandefreitas

include/mrdocs/Metadata.hpp

@@ -14,16 +14,10 @@
 
 #include <mrdocs/Platform.hpp>
 
-// All headers related to
-// metadata extracted from AST
-
-#include <mrdocs/Metadata/Info/Using.hpp>
-#include <mrdocs/Metadata/Expression.hpp>
 #include <mrdocs/Metadata/Info.hpp>
 #include <mrdocs/Metadata/Info/Concept.hpp>
 #include <mrdocs/Metadata/Info/Enum.hpp>
 #include <mrdocs/Metadata/Info/EnumConstant.hpp>
-#include <mrdocs/Metadata/Info/Field.hpp>
 #include <mrdocs/Metadata/Info/Friend.hpp>
 #include <mrdocs/Metadata/Info/Function.hpp>
 #include <mrdocs/Metadata/Info/Guide.hpp>
@@ -33,6 +27,9 @@
 #include <mrdocs/Metadata/Info/Record.hpp>
 #include <mrdocs/Metadata/Info/Typedef.hpp>
 #include <mrdocs/Metadata/Info/Variable.hpp>
+#include <mrdocs/Metadata/Info/Using.hpp>
+
+#include <mrdocs/Metadata/Expression.hpp>
 #include <mrdocs/Metadata/Javadoc.hpp>
 #include <mrdocs/Metadata/Name.hpp>
 #include <mrdocs/Metadata/Source.hpp>

include/mrdocs/Metadata/Info/Field.hpp

@@ -25,7 +25,7 @@ namespace clang::mrdocs {
 /** A variable.
 
     This includes variables at namespace
-    scope, and static variables at class scope.
+    or record scope.
 */
 struct VariableInfo final
     : InfoCommonBase<InfoKind::Variable>
@@ -35,6 +35,8 @@ struct VariableInfo final
 
     std::optional<TemplateInfo> Template;
 
+    /** The default member initializer, if any.
+     */
     ExprInfo Initializer;
 
     StorageClassKind StorageClass = StorageClassKind::None;
@@ -49,6 +51,28 @@ struct VariableInfo final
 
     std::vector<std::string> Attributes;
 
+    bool IsMaybeUnused = false;
+
+    bool IsDeprecated = false;
+
+    bool HasNoUniqueAddress = false;
+
+    //--------------------------------------------
+    // Record fields
+    bool IsRecordField = false;
+
+    /** Whether the field is declared mutable */
+    bool IsMutable = false;
+
+    /** Whether the field is a variant member */
+    bool IsVariant = false;
+
+    /** Whether the field is a bitfield */
+    bool IsBitfield = false;
+
+    /** The width of the bitfield */
+    ConstantExprInfo<std::uint64_t> BitfieldWidth;
+
     //--------------------------------------------
 
     explicit VariableInfo(SymbolID const &ID) noexcept
@@ -90,6 +114,18 @@ tag_invoke(
         io.map("initializer", I.Initializer.Written);
     }
     io.map("attributes", dom::LazyArray(I.Attributes));
+    io.map("isRecordField", I.IsRecordField);
+    io.map("isMaybeUnused", I.IsMaybeUnused);
+    io.map("isDeprecated", I.IsDeprecated);
+    io.map("isVariant", I.IsVariant);
+    io.map("isMutable", I.IsMutable);
+    io.map("isBitfield", I.IsBitfield);
+    if (I.IsBitfield)
+    {
+        io.map("bitfieldWidth", I.BitfieldWidth.Written);
+    }
+    io.map("hasNoUniqueAddress", I.HasNoUniqueAddress);
+    io.map("attributes", dom::LazyArray(I.Attributes));
 }
 
 /** Map the VariableInfo to a @ref dom::Value object.

include/mrdocs/Metadata/Info/Variable.hpp

@@ -1,11 +1,17 @@
+{{#if attributes}}{{ str "[[" }}{{join ", " attributes}}{{ str "]]" }}
+{{/if}}
 {{#if template}}{{>template/head template}}
 {{/if~}}
+{{#if isMutable}}mutable
+{{/if~}}
 {{#if isInline}}inline {{/if~}}
 {{#if isConstexpr}}constexpr {{/if~}}
 {{#if storageClass}}{{storageClass}}
 {{/if~}}
 {{#if isThreadLocal}}thread_local
 {{/if~}}
 {{>type/declarator-prefix type}} {{>symbol/name symbol link=(select link link template.primary)~}}
+{{#if isBitfield}} : {{bitfieldWidth}}{{/if~}}
+{{#if default}} = {{default}}{{/if~}}
 {{>type/declarator-suffix type~}}
 {{#if initializer}} = {{initializer}}{{/if}};

share/mrdocs/addons/generator/common/partials/symbol/signature/field.hbs

@@ -26,7 +26,7 @@
     {{~#if isDeleted~}}
         {{str ' '}}{{#>markup/span class="small"}}[deleted]{{/markup/span}}
     {{~/if~}}
-{{else if (eq kind "field")~}}
+{{else if (eq kind "variable")~}}
     {{~#if isVariant~}}
         {{#>markup/span class="small"}}[variant member]{{/markup/span}}
     {{~/if~}}

share/mrdocs/addons/generator/common/partials/symbol/signature/variable.hbs

@@ -1085,16 +1085,17 @@ populate(VariableInfo& I, VarTemplatePartialSpecializationDecl const* D)
 void
 ASTVisitor::
 populate(
-    FieldInfo& I,
+    VariableInfo& I,
     FieldDecl const* D)
 {
+    I.IsRecordField = true;
     I.Type = toTypeInfo(D->getType());
-    I.IsVariant = D->getParent()->isUnion();
-    I.IsMutable = D->isMutable();
     if (Expr const* E = D->getInClassInitializer())
     {
-        populate(I.Default, E);
+        populate(I.Initializer, E);
     }
+    I.IsVariant = D->getParent()->isUnion();
+    I.IsMutable = D->isMutable();
     if(D->isBitField())
     {
         I.IsBitfield = true;
@@ -1756,14 +1757,16 @@ addMember(RecordTranche& T, Info const& Member)
         }
         return;
     }
-    if (auto const* U = Member.asFieldPtr())
-    {
-        addMember(T.Variables, *U);
-        return;
-    }
     if (auto const* U = Member.asVariablePtr())
     {
-        addMember(T.StaticVariables, *U);
+        if (U->StorageClass != StorageClassKind::Static)
+        {
+            addMember(T.Variables, *U);
+        }
+        else
+        {
+            addMember(T.StaticVariables, *U);
+        }
         return;
     }
     if (auto const* U = Member.asConceptPtr())

share/mrdocs/addons/generator/common/partials/symbol/special-function-suffix.hbs

@@ -573,7 +573,7 @@ class ASTVisitor
     populate(VariableInfo& I, VarTemplatePartialSpecializationDecl const* D);
 
     void
-    populate(FieldInfo& I, FieldDecl const* D);
+    populate(VariableInfo& I, FieldDecl const* D);
 
     void
     populate(FriendInfo& I, FriendDecl const* D);

src/lib/AST/ASTVisitor.cpp

@@ -165,10 +165,9 @@ template <>
 struct InfoTypeFor<VarTemplateDecl>
     : std::type_identity<VariableInfo> {};
 
-// Extract FieldInfo from FieldDecl
 template <>
 struct InfoTypeFor<FieldDecl>
-    : std::type_identity<FieldInfo> {};
+    : std::type_identity<VariableInfo> {};
 
 // Extract FriendInfo from FriendDecl
 template <>

src/lib/AST/ASTVisitor.hpp

@@ -556,26 +556,26 @@ writeTypedef(
 
 void
 XMLWriter::
-writeField(
-    FieldInfo const& I)
+writeVariable(
+    VariableInfo const& I)
 {
-    std::string_view tag_name = dataMemberTagName;
+    openTemplate(I.Template);
+
     std::string bit_width;
     if(I.IsBitfield)
     {
-        tag_name = bitfieldTagName;
         bit_width = I.BitfieldWidth.Value ?
             std::to_string(*I.BitfieldWidth.Value) :
             I.BitfieldWidth.Written;
     }
 
-    tags_.open(tag_name, {
+    tags_.open(varTagName, {
         { "name", I.Name },
         { I.Access },
         { I.id },
-        { "width", bit_width, I.IsBitfield },
-        { "default", I.Default.Written, ! I.Default.Written.empty() }
-    });
+           { "width", bit_width, I.IsBitfield },
+        { "default", I.Initializer.Written, ! I.Initializer.Written.empty() }
+        });
 
     writeSourceInfo(I);
 
@@ -584,39 +584,17 @@ writeField(
             {"id", "is-mutable"}
         });
 
-    writeAttr(I.IsVariant, "is-variant", tags_);
-    writeAttr(I.IsMaybeUnused, "maybe-unused", tags_);
-    writeAttr(I.IsDeprecated, "deprecated", tags_);
-    writeAttr(I.HasNoUniqueAddress, "no-unique-address", tags_);
-
-    writeType(I.Type, tags_);
-
-    writeJavadoc(I.javadoc);
-
-    tags_.close(tag_name);
-}
-
-void
-XMLWriter::
-writeVariable(
-    VariableInfo const& I)
-{
-    openTemplate(I.Template);
-
-    tags_.open(varTagName, {
-        { "name", I.Name },
-        { I.Access },
-        { I.id }
-        });
-
-    writeSourceInfo(I);
-
     writeAttr(I.StorageClass, "storage-class", tags_);
     writeAttr(I.IsInline, "is-inline", tags_);
     writeAttr(I.IsConstexpr, "is-constexpr", tags_);
     writeAttr(I.IsConstinit, "is-constinit", tags_);
     writeAttr(I.IsThreadLocal, "is-thread-local", tags_);
 
+    writeAttr(I.IsVariant, "is-variant", tags_);
+    writeAttr(I.IsMaybeUnused, "maybe-unused", tags_);
+    writeAttr(I.IsDeprecated, "deprecated", tags_);
+    writeAttr(I.HasNoUniqueAddress, "no-unique-address", tags_);
+
     writeType(I.Type, tags_);
 
     writeJavadoc(I.javadoc);