[WIP] add AttributeKind

Author: sdkrystian

docs/modules/ROOT/pages/generators.adoc

@@ -189,6 +189,10 @@ The `Symbol` object represents a symbol extracted from the source code.The symbo
 | `Any`
 | The documentation for the symbol.
 
+| `attributes`
+| `string[]`
+| The attributes of the symbol.
+
 |===
 
 Handlebars generators extend each symbol with the following fields:
@@ -326,10 +330,6 @@ When the symbol kind is `function`, the symbol object has the following addition
 | `bool`
 | Whether the function is deleted as written.
 
-| `isNoReturn`
-| `bool`
-| Whether the function is noreturn.
-
 | `isOverride`
 | `bool`
 | Whether the function is override.
@@ -350,10 +350,6 @@ When the symbol kind is `function`, the symbol object has the following addition
 | `bool`
 | Whether the function is final.
 
-| `isNodiscard`
-| `bool`
-| Whether the function is nodiscard.
-
 | `isExplicitObjectMemberFunction`
 | `bool`
 | Whether the function is an explicit object member function.
@@ -401,10 +397,6 @@ When the symbol kind is `function`, the symbol object has the following addition
 | `requires`
 | `string`
 | The `requires` expression of the function.
-
-| `attributes`
-| `string[]`
-| The attributes of the function.
 |===
 
 When the symbol kind is `typedef`, the symbol object has the following additional properties:
@@ -461,10 +453,6 @@ When the symbol kind is `variable`, the symbol object has the following addition
 | `initializer`
 | `string`
 | The initializer of the variable.
-
-| `attributes`
-| `string[]`
-| The attributes of the variable.
 |===
 
 When the symbol kind is `field` (i.e. non-static data members), the symbol object has the following additional properties:
@@ -480,14 +468,6 @@ When the symbol kind is `field` (i.e. non-static data members), the symbol objec
 | `string`
 | The default value of the field.
 
-| `isMaybeUnused`
-| `bool`
-| Whether the field is maybe unused.
-
-| `isDeprecated`
-| `bool`
-| Whether the field is deprecated.
-
 | `isVariant`
 | `bool`
 | Whether the field is a variant.
@@ -500,17 +480,9 @@ When the symbol kind is `field` (i.e. non-static data members), the symbol objec
 | `bool`
 | Whether the field is a bitfield.
 
-| `hasNoUniqueAddress`
-| `string`
-| Whether the field has the `[[no_unique_address]]` attribute.
-
 | `bitfieldWidth`
 | `string`
 | The width of the bitfield.
-
-| `attributes`
-| `string[]`
-| The attributes of the field.
 |===
 
 When the symbol kind is `friend`, the symbol object has the following additional properties:

include/mrdocs/Metadata/Info.hpp

@@ -14,6 +14,7 @@
 
 #include <mrdocs/Platform.hpp>
 #include <mrdocs/Dom.hpp>
+#include <mrdocs/Dom/LazyArray.hpp>
 #include <mrdocs/Dom/LazyObject.hpp>
 #include <mrdocs/Metadata/ExtractionMode.hpp>
 #include <mrdocs/Metadata/Javadoc.hpp>
@@ -112,6 +113,10 @@ struct MRDOCS_VISIBLE Info
      */
     std::optional<Javadoc> javadoc;
 
+    /** The attributes appertaining to this declaration.
+    */
+    std::vector<AttributeKind> Attributes;
+
     //--------------------------------------------
 
     ~Info() override = default;
@@ -298,6 +303,8 @@ tag_invoke(
     {
         io.map("doc", *I.javadoc);
     }
+
+    io.map("attributes", dom::LazyArray(I.Attributes));
     io.map("loc", dynamic_cast<SourceInfo const&>(I));
 }
 

include/mrdocs/Metadata/Info/Field.hpp

@@ -48,16 +48,6 @@ struct FieldInfo final
     /** The width of the bitfield */
     ConstantExprInfo<std::uint64_t> BitfieldWidth;
 
-    // KRYSTIAN FIXME: nodiscard cannot be applied to fields; this should
-    // instead be IsMaybeUnused. we should also store the spelling
-    bool IsMaybeUnused = false;
-
-    bool IsDeprecated = false;
-
-    bool HasNoUniqueAddress = false;
-
-    std::vector<std::string> Attributes;
-
     //--------------------------------------------
 
     explicit FieldInfo(SymbolID ID) noexcept
@@ -86,17 +76,13 @@ tag_invoke(
     {
         io.map("default", I.Default.Written);
     }
-    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);
-    io.map("hasNoUniqueAddress", I.HasNoUniqueAddress);
     if (I.IsBitfield)
     {
         io.map("bitfieldWidth", I.BitfieldWidth.Written);
     }
-    io.map("attributes", dom::LazyArray(I.Attributes));
 }
 
 /** Map the FieldInfo to a @ref dom::Value object.

include/mrdocs/Metadata/Info/Function.hpp

@@ -160,10 +160,7 @@ struct FunctionInfo final
     bool IsExplicitlyDefaulted = false;
     bool IsDeleted = false;
     bool IsDeletedAsWritten = false;
-    bool IsNoReturn = false;
-    bool IsOverride = false;
     bool HasTrailingReturn = false;
-    bool IsNodiscard = false;
     bool IsExplicitObjectMemberFunction = false;
     ConstexprKind Constexpr = ConstexprKind::None;
     OperatorKind OverloadedOperator = OperatorKind::None;
@@ -178,6 +175,7 @@ struct FunctionInfo final
     bool IsConst = false;
     bool IsVolatile = false;
     bool IsFinal = false;
+    bool IsOverride = false;
     ReferenceKind RefQualifier = ReferenceKind::None;
     ExplicitInfo Explicit;
 
@@ -215,13 +213,11 @@ tag_invoke(
     io.map("isExplicitlyDefaulted", I.IsExplicitlyDefaulted);
     io.map("isDeleted", I.IsDeleted);
     io.map("isDeletedAsWritten", I.IsDeletedAsWritten);
-    io.map("isNoReturn", I.IsNoReturn);
-    io.map("isOverride", I.IsOverride);
     io.map("hasTrailingReturn", I.HasTrailingReturn);
     io.map("isConst", I.IsConst);
     io.map("isVolatile", I.IsVolatile);
     io.map("isFinal", I.IsFinal);
-    io.map("isNodiscard", I.IsNodiscard);
+    io.map("isOverride", I.IsOverride);
     io.map("isExplicitObjectMemberFunction", I.IsExplicitObjectMemberFunction);
     if (I.Constexpr != ConstexprKind::None)
     {
@@ -246,7 +242,6 @@ tag_invoke(
     {
         io.map("requires", I.Requires.Written);
     }
-    io.map("attributes", dom::LazyArray(I.Attributes));
 }
 
 /** Map the FunctionInfo to a @ref dom::Value object.

include/mrdocs/Metadata/Info/Variable.hpp

@@ -17,7 +17,6 @@
 #include <mrdocs/Metadata/Template.hpp>
 #include <mrdocs/Metadata/Info.hpp>
 #include <mrdocs/Metadata/Type.hpp>
-#include <mrdocs/Dom/LazyArray.hpp>
 #include <mrdocs/ADT/Polymorphic.hpp>
 
 namespace clang::mrdocs {
@@ -89,7 +88,6 @@ tag_invoke(
     {
         io.map("initializer", I.Initializer.Written);
     }
-    io.map("attributes", dom::LazyArray(I.Attributes));
 }
 
 /** Map the VariableInfo to a @ref dom::Value object.

include/mrdocs/Metadata/Specifiers.hpp

@@ -36,6 +36,17 @@ enum class AccessKind
     Private,
 };
 
+/** Attribute kinds.
+*/
+enum class AttributeKind
+{
+    Deprecated,
+    MaybeUnused,
+    Nodiscard,
+    Noreturn,
+    NoUniqueAddress
+};
+
 /** `constexpr`/`consteval` specifier kinds
 
     [dcl.spec.general] p2: At most one of the `constexpr`, `consteval`,
@@ -209,6 +220,7 @@ enum class StorageClassKind
 };
 
 MRDOCS_DECL dom::String toString(AccessKind kind) noexcept;
+MRDOCS_DECL dom::String toString(AttributeKind kind) noexcept;
 MRDOCS_DECL dom::String toString(ConstexprKind kind) noexcept;
 MRDOCS_DECL dom::String toString(ExplicitKind kind) noexcept;
 MRDOCS_DECL dom::String toString(NoexceptKind kind) noexcept;
@@ -278,6 +290,18 @@ tag_invoke(
     v = toString(kind);
 }
 
+/** Return the AttributeKind as a @ref dom::Value string.
+ */
+inline
+void
+tag_invoke(
+    dom::ValueFromTag,
+    dom::Value& v,
+    AttributeKind kind)
+{
+    v = toString(kind);
+}
+
 /** Return the ConstexprKind as a @ref dom::Value string.
  */
 inline

src/lib/AST/ASTVisitor.cpp

@@ -522,6 +522,7 @@ populate(Info& I, bool const isNew, DeclTy const* D)
 {
     populate(I.javadoc, D);
     populate(dynamic_cast<SourceInfo&>(I), D);
+    populateAttributes(I, D);
 
     // All other information is redundant if the symbol is not new
     MRDOCS_CHECK_OR(isNew);
@@ -767,7 +768,6 @@ populate(
     I.IsExplicitlyDefaulted |= D->isExplicitlyDefaulted();
     I.IsDeleted |= D->isDeleted();
     I.IsDeletedAsWritten |= D->isDeletedAsWritten();
-    I.IsNoReturn |= D->isNoReturn();
 
     if (ConstexprSpecKind const CSK = D->getConstexprKind();
         CSK != ConstexprSpecKind::Unspecified)
@@ -780,7 +780,6 @@ populate(
         I.StorageClass = toStorageClassKind(SC);
     }
 
-    I.IsNodiscard |= D->hasAttr<WarnUnusedResultAttr>();
     I.IsExplicitObjectMemberFunction |= D->hasCXXExplicitFunctionObjectParameter();
 
     ArrayRef<ParmVarDecl*> const params = D->parameters();
@@ -867,8 +866,6 @@ populate(
             }
         }
     }
-
-    populateAttributes(I, D);
 }
 
 void
@@ -1024,7 +1021,6 @@ populate(
         QT.removeLocalConst();
     }
     I.Type = toTypeInfo(QT);
-    populateAttributes(I, D);
 }
 
 void
@@ -1068,10 +1064,6 @@ populate(
         I.IsBitfield = true;
         populate(I.BitfieldWidth, D->getBitWidth());
     }
-    I.HasNoUniqueAddress = D->hasAttr<NoUniqueAddressAttr>();
-    I.IsDeprecated = D->hasAttr<DeprecatedAttr>();
-    I.IsMaybeUnused = D->hasAttr<UnusedAttr>();
-    populateAttributes(I, D);
 }
 
 void
@@ -1568,11 +1560,53 @@ populate(
         }));
 }
 
-template <std::derived_from<Info> InfoTy>
 void
 ASTVisitor::
-populateAttributes(InfoTy& I, Decl const* D)
-{
+populateAttributes(Info& I, Decl const* D)
+{
+    for(const Attr* AT : D->getAttrs())
+    {
+        switch(AT->getKind())
+        {
+        case attr::Kind::Deprecated:
+            addAttribute(I, AttributeKind::Deprecated);
+            break;
+        case attr::Kind::Unused:
+            addAttribute(I, AttributeKind::MaybeUnused);
+            break;
+        case attr::Kind::WarnUnusedResult:
+            addAttribute(I, AttributeKind::Nodiscard);
+            break;
+        case attr::Kind::NoReturn:
+            addAttribute(I, AttributeKind::Noreturn);
+            break;
+        case attr::Kind::NoUniqueAddress:
+            addAttribute(I, AttributeKind::NoUniqueAddress);
+            break;
+        default:
+            // KRYSTIAN TODO: handle more attributes types
+            break;
+        }
+    }
+
+#if 0
+    if(D->hasAttr<DeprecatedAttr>())
+        addAttribute(I, AttributeKind::Deprecated);
+
+    if(D->hasAttr<UnusedAttr>())
+        addAttribute(I, AttributeKind::MaybeUnused);
+
+    if(D->hasAttr<WarnUnusedResultAttr>())
+        addAttribute(I, AttributeKind::Nodiscard);
+
+    if(D->hasAttr<NoReturnAttr>())
+        addAttribute(I, AttributeKind::Noreturn);
+
+    if(D->hasAttr<NoUniqueAddressAttr>())
+        addAttribute(I, AttributeKind::NoUniqueAddress);
+    #endif
+
+    #if 0
     if constexpr (requires { I.Attributes; })
     {
         MRDOCS_CHECK_OR(D->hasAttrs());
@@ -1589,6 +1623,18 @@ populateAttributes(InfoTy& I, Decl const* D)
             }
         }
     }
+    #endif
+}
+
+void
+ASTVisitor::
+addAttribute(
+    Info& I,
+    AttributeKind kind)
+{
+    if(std::ranges::find(I.Attributes, kind) != I.Attributes.end())
+        return;
+    I.Attributes.emplace_back(kind);
 }
 
 void

src/lib/AST/ASTVisitor.hpp

@@ -698,10 +698,11 @@ class ASTVisitor
         std::vector<Polymorphic<TArg>>& result,
         ASTTemplateArgumentListInfo const* args);
 
-    template <std::derived_from<Info> InfoTy>
-    static
     void
-    populateAttributes(InfoTy& I, Decl const* D);
+    populateAttributes(Info& I, Decl const* D);
+
+    void
+    addAttribute(Info& I, AttributeKind kind);
 
     // =================================================
     // Populate function helpers