feat: extract and render initializers for variables and fields

cppalliance · Dec 18, 2023 · 42cc6ec · 42cc6ec
1 parent bf60a45
commit 42cc6ec
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 10 deletions.
diff --git a/include/mrdocs/Metadata/Field.hpp b/include/mrdocs/Metadata/Field.hpp
@@ -48,7 +48,7 @@ struct FieldInfo
 
     /** The default member initializer, if any.
     */
-    std::string Default;
+    ExprInfo Default;
 
     // attributes (maybe_unused, no_unique_address, deprecated)
     FieldFlags specs;

diff --git a/include/mrdocs/Metadata/Variable.hpp b/include/mrdocs/Metadata/Variable.hpp
@@ -14,6 +14,7 @@
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/ADT/BitField.hpp>
+#include <mrdocs/Metadata/Expression.hpp>
 #include <mrdocs/Metadata/Source.hpp>
 #include <mrdocs/Metadata/Template.hpp>
 #include <mrdocs/Metadata/Type.hpp>
@@ -48,6 +49,8 @@ struct VariableInfo
 
     VariableFlags0 specs{.raw={0}};
 
+    ExprInfo Initializer;
+
     //--------------------------------------------
 
     explicit VariableInfo(SymbolID ID) noexcept

diff --git a/share/mrdocs/addons/generator/asciidoc/partials/signature/field.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/signature/field.adoc.hbs
@@ -2,4 +2,5 @@
 {{/if~}}
 {{>declarator-before symbol.type}} {{>declarator-id symbol~}}
 {{#if symbol.isBitfield}} : {{symbol.bitfieldWidth}}{{/if~}}
+{{#if symbol.default}} = {{symbol.default}}{{/if~}}
 {{>declarator-after symbol.type}}
diff --git a/share/mrdocs/addons/generator/asciidoc/partials/signature/variable.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/signature/variable.adoc.hbs
@@ -7,4 +7,5 @@
 {{#if symbol.isThreadLocal}}thread_local
 {{/if~}}
 {{>declarator-before symbol.type}} {{>declarator-id symbol link=symbol.template.primary~}}
-{{>declarator-after symbol.type}}
+{{>declarator-after symbol.type~}}
+{{#if symbol.initializer}} = {{symbol.initializer}}{{/if}}
diff --git a/src/lib/AST/ASTVisitor.cpp b/src/lib/AST/ASTVisitor.cpp
@@ -1682,6 +1682,9 @@ class ASTVisitor
         if(D->isConstexpr())
             I.specs.constexprKind = ConstexprKind::Constexpr;
 
+        if(const Expr* E = D->getInit())
+            buildExprInfo(I.Initializer, E);
+
         if(! created)
             return;
 
@@ -1714,6 +1717,9 @@ class ASTVisitor
 
         I.IsMutable = D->isMutable();
 
+        if(const Expr* E = D->getInClassInitializer())
+            buildExprInfo(I.Default, E);
+
         if(D->isBitField())
         {
             I.IsBitfield = true;

diff --git a/src/lib/AST/AnyBlock.hpp b/src/lib/AST/AnyBlock.hpp
@@ -778,6 +778,22 @@ class ExprBlock
             return AnyBlock::parseRecord(R, ID, Blob);
         }
     }
+
+    Error
+    readSubBlock(unsigned ID) override
+    {
+        switch(ID)
+        {
+        // if this has a BI_EXPR_BLOCK_ID child, it means
+        // that this is the child of some block which is
+        // a proxy for an EXPR_BLOCK. in such cases, just
+        // forward the result to the caller
+        case BI_EXPR_BLOCK_ID:
+            return br_.readBlock(*this, ID);
+        default:
+            return AnyBlock::readSubBlock(ID);
+        };
+    }
 };
 
 //------------------------------------------------
@@ -1694,6 +1710,11 @@ class VarBlock
     {
         switch(ID)
         {
+        case BI_EXPR_BLOCK_ID:
+        {
+            ExprBlock B(I->Initializer, br_);
+            return br_.readBlock(B, ID);
+        }
         case BI_TYPEINFO_BLOCK_ID:
         {
             TypeInfoBlock B(I->Type, br_);
@@ -1727,8 +1748,6 @@ class FieldBlock
     {
         switch(ID)
         {
-        case FIELD_DEFAULT:
-            return decodeRecord(R, I->Default, Blob);
         case FIELD_ATTRIBUTES:
             return decodeRecord(R, {&I->specs.raw}, Blob);
         case FIELD_IS_MUTABLE:
@@ -1752,6 +1771,11 @@ class FieldBlock
             return br_.readBlock(B, ID);
         }
         case BI_EXPR_BLOCK_ID:
+        {
+            ExprBlock B(I->Default, br_);
+            return br_.readBlock(B, ID);
+        }
+        case BI_BITFIELD_WIDTH_BLOCK_ID:
         {
             ExprBlock B(I->BitfieldWidth, br_);
             return br_.readBlock(B, ID);

diff --git a/src/lib/AST/BitcodeIDs.hpp b/src/lib/AST/BitcodeIDs.hpp
@@ -59,6 +59,7 @@ enum BlockID
     BI_BASE_BLOCK_ID,
     BI_ENUM_BLOCK_ID,
     BI_EXPR_BLOCK_ID,
+    BI_BITFIELD_WIDTH_BLOCK_ID,
     BI_FIELD_BLOCK_ID,
     BI_FUNCTION_BLOCK_ID,
     BI_FUNCTION_PARAM_BLOCK_ID,

diff --git a/src/lib/AST/BitcodeWriter.cpp b/src/lib/AST/BitcodeWriter.cpp
@@ -236,6 +236,7 @@ BlockIdNameMap = []()
         {BI_NAMESPACE_BLOCK_ID, "NamespaceBlock"},
         {BI_ENUM_BLOCK_ID, "EnumBlock"},
         {BI_EXPR_BLOCK_ID, "ExprBlock"},
+        {BI_BITFIELD_WIDTH_BLOCK_ID, "BitfieldWidthBlock"},
         {BI_TYPEDEF_BLOCK_ID, "TypedefBlock"},
         {BI_TYPEINFO_BLOCK_ID, "TypeInfoBlock"},
         {BI_TYPEINFO_PARENT_BLOCK_ID, "TypeInfoParentBlock"},
@@ -374,6 +375,8 @@ RecordsByBlock{
     // ExprInfo and ConstantExprInfo
     {BI_EXPR_BLOCK_ID,
         {EXPR_WRITTEN, EXPR_VALUE}},
+    {BI_BITFIELD_WIDTH_BLOCK_ID,
+        {}},
     // FieldInfo
     {BI_FIELD_BLOCK_ID,
         {FIELD_DEFAULT, FIELD_ATTRIBUTES,
@@ -854,11 +857,11 @@ emitBlock(
     emitInfoPart(F);
     emitSourceInfo(F);
     emitBlock(F.Type);
-    emitRecord(F.Default, FIELD_DEFAULT);
+    emitBlock(F.Default);
     emitRecord({F.specs.raw}, FIELD_ATTRIBUTES);
     emitRecord(F.IsMutable, FIELD_IS_MUTABLE);
     emitRecord(F.IsBitfield, FIELD_IS_BITFIELD);
-    emitBlock(F.BitfieldWidth);
+    emitBlock(F.BitfieldWidth, BI_BITFIELD_WIDTH_BLOCK_ID);
 }
 
 void
@@ -968,6 +971,18 @@ emitBlock(
     }
 }
 
+template<typename ExprInfoTy>
+    requires std::derived_from<ExprInfoTy, ExprInfo>
+void
+BitcodeWriter::
+emitBlock(
+    ExprInfoTy const& E,
+    BlockID ID)
+{
+    StreamSubBlockGuard Block(Stream, ID);
+    emitBlock(E);
+}
+
 void
 BitcodeWriter::
 emitBlock(
@@ -1226,6 +1241,7 @@ emitBlock(
     if(I.Template)
         emitBlock(*I.Template);
     emitBlock(I.Type);
+    emitBlock(I.Initializer);
     emitRecord({I.specs.raw}, VARIABLE_BITS);
 }
 

diff --git a/src/lib/AST/BitcodeWriter.hpp b/src/lib/AST/BitcodeWriter.hpp
@@ -138,6 +138,9 @@ class BitcodeWriter
     template<typename ExprInfoTy>
         requires std::derived_from<ExprInfoTy, ExprInfo>
     void emitBlock(ExprInfoTy const& E);
+    template<typename ExprInfoTy>
+        requires std::derived_from<ExprInfoTy, ExprInfo>
+    void emitBlock(ExprInfoTy const& E, BlockID ID);
 
     //--------------------------------------------
 

diff --git a/src/lib/Gen/xml/XMLWriter.cpp b/src/lib/Gen/xml/XMLWriter.cpp
@@ -468,7 +468,7 @@ writeField(
         { I.Access },
         { I.id },
         { "width", bit_width, I.IsBitfield },
-        { "default", I.Default, ! I.Default.empty() }
+        { "default", I.Default.Written, ! I.Default.Written.empty() }
     });
 
     writeSourceInfo(I);

diff --git a/src/lib/Metadata/DomMetadata.cpp b/src/lib/Metadata/DomMetadata.cpp
@@ -825,14 +825,15 @@ DomInfo<T>::construct() const
             { "constexprKind",  toString(I_.specs.constexprKind.get()) },
             { "storageClass",   toString(I_.specs.storageClass.get()) },
             { "isConstinit",    I_.specs.isConstinit.get() },
-            { "isThreadLocal",  I_.specs.isThreadLocal.get() }
+            { "isThreadLocal",  I_.specs.isThreadLocal.get() },
+            { "initializer",    dom::stringOrNull(I_.Initializer.Written) },
             });
     }
     if constexpr(T::isField())
     {
         entries.insert(entries.end(), {
             { "type",               domCreate(I_.Type, domCorpus_) },
-            { "default",            dom::stringOrNull(I_.Default) },
+            { "default",            dom::stringOrNull(I_.Default.Written) },
             { "isMaybeUnused",      I_.specs.isMaybeUnused.get() },
             { "isDeprecated",       I_.specs.isDeprecated.get() },
             { "isMutable",          I_.IsMutable },

diff --git a/src/lib/Metadata/Reduce.cpp b/src/lib/Metadata/Reduce.cpp
@@ -254,7 +254,7 @@ void merge(FieldInfo& I, FieldInfo&& Other)
     mergeInfo(I, std::move(Other));
     I.specs.raw.value |= Other.specs.raw.value;
     I.IsMutable |= Other.IsMutable;
-    if(I.Default.empty())
+    if(I.Default.Written.empty())
         I.Default = std::move(Other.Default);
 
     I.IsBitfield |= Other.IsBitfield;
@@ -269,6 +269,8 @@ void merge(VariableInfo& I, VariableInfo&& Other)
         I.Type = std::move(Other.Type);
     if(! I.Template)
         I.Template = std::move(Other.Template);
+    if(I.Initializer.Written.empty())
+        I.Initializer = std::move(Other.Initializer);
     mergeSourceInfo(I, std::move(Other));
     mergeInfo(I, std::move(Other));
     I.specs.raw.value |= Other.specs.raw.value;