non-static data members have SymbolIDs and are part of RecordScope

Author: sdkrystian

include/mrdox/Corpus.hpp

@@ -107,12 +107,15 @@ class MRDOX_VISIBLE
         MRDOX_DECL virtual bool visit(TypedefInfo const&);
         MRDOX_DECL virtual bool visit(EnumInfo const&);
         MRDOX_DECL virtual bool visit(VarInfo const&);
+        // KRYSTIAN FIXME: is this correct? does it make sense to
+        // visit a field as a non-member (a field *must* be class member)?
+        MRDOX_DECL virtual bool visit(FieldInfo const&);
 
-        MRDOX_DECL virtual bool visit(DataMember const&, Access);
         MRDOX_DECL virtual bool visit(MemberEnum const&, Access);
         MRDOX_DECL virtual bool visit(MemberFunction const&, Access);
         MRDOX_DECL virtual bool visit(MemberRecord const&, Access);
         MRDOX_DECL virtual bool visit(MemberType const&, Access);
+        MRDOX_DECL virtual bool visit(DataMember const&, Access);
         MRDOX_DECL virtual bool visit(StaticDataMember const&, Access);
     };
 
@@ -169,6 +172,8 @@ get(
         assert(t->IT == InfoType::IT_enum);
     else if constexpr(std::is_same_v<T, VarInfo>)
         assert(t->IT == InfoType::IT_variable);
+    else if constexpr(std::is_same_v<T, FieldInfo>)
+        assert(t->IT == InfoType::IT_field);
     return *t;
 }
 

include/mrdox/Metadata.hpp

@@ -18,13 +18,12 @@
 // metadata extracted from AST
 
 #include <mrdox/Metadata/Enum.hpp>
-#include <mrdox/Metadata/FieldType.hpp>
+#include <mrdox/Metadata/Field.hpp>
 #include <mrdox/Metadata/Function.hpp>
 #include <mrdox/Metadata/Info.hpp>
 #include <mrdox/Metadata/Interface.hpp>
 #include <mrdox/Metadata/Javadoc.hpp>
 #include <mrdox/Metadata/Location.hpp>
-#include <mrdox/Metadata/MemberType.hpp>
 #include <mrdox/Metadata/Namespace.hpp>
 #include <mrdox/Metadata/Overloads.hpp>
 #include <mrdox/Metadata/Record.hpp>

include/mrdox/Metadata/Access.hpp

@@ -35,7 +35,7 @@ enum class Access
     Private
 };
 
-/** A reference to a symbol, and an access speciier.
+/** A reference to a symbol, and an access specifier.
 
     This is used in records to refer to nested
     elements with access control.

include/mrdox/Metadata/Enum.hpp

@@ -24,6 +24,7 @@
 namespace clang {
 namespace mrdox {
 
+// FIXME: this does not store javadocs...
 // Information for a single possible value of an enumeration.
 struct EnumValueInfo
 {
@@ -66,7 +67,8 @@ struct EnumValueInfo
 
 // TODO: Expand to allow for documenting templating.
 // Info for types.
-struct EnumInfo : SymbolInfo
+struct EnumInfo
+    : SymbolInfo
 {
     // Indicates whether this enum is scoped (e.g. enum class).
     bool Scoped = false;
@@ -82,15 +84,10 @@ struct EnumInfo : SymbolInfo
 
     static constexpr InfoType type_id = InfoType::IT_enum;
 
-    EnumInfo()
-        : SymbolInfo(InfoType::IT_enum)
-    {
-    }
-
     explicit
     EnumInfo(
-        SymbolID id_)
-        : SymbolInfo(InfoType::IT_enum, id_)
+        SymbolID id = SymbolID::zero)
+        : SymbolInfo(InfoType::IT_enum, id)
     {
     }
 };

include/mrdox/Metadata/FieldType.hpp renamed to include/mrdox/Metadata/Field.hpp

@@ -5,14 +5,17 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 // Copyright (c) 2023 Vinnie Falco ([email protected])
+// Copyright (c) 2023 Krystian Stasiowski ([email protected])
 //
 // Official repository: https://github.com/cppalliance/mrdox
 //
 
-#ifndef MRDOX_METADATA_FIELDTYPE_HPP
-#define MRDOX_METADATA_FIELDTYPE_HPP
+#ifndef MRDOX_METADATA_FIELD_HPP
+#define MRDOX_METADATA_FIELD_HPP
 
 #include <mrdox/Platform.hpp>
+#include <mrdox/Metadata/Info.hpp>
+#include <mrdox/Metadata/Symbol.hpp>
 #include <mrdox/Metadata/Type.hpp>
 #include <mrdox/ADT/BitField.hpp>
 #include <llvm/ADT/SmallString.h>
@@ -25,37 +28,41 @@ union FieldFlags
 {
     BitFieldFullValue raw{.value=0u};
 
+    // KRYSTIAN FIXME: nodiscard cannot be applied to fields; this should
+    // instead be isMaybeUnused. we should also store the spelling
     BitFlag<0> isNodiscard;
     BitFlag<1> isDeprecated;
     BitFlag<2> hasNoUniqueAddress;
 };
 
-// Info for field types.
+/** Info for fields (i.e. non-static data members)
+
+    Non-static data members cannot be redeclared.
+*/
 struct FieldInfo
-    : public TypeInfo
+    : SymbolInfo
 {
-    llvm::SmallString<16> Name; // Name associated with this info.
+    /** Type of the field */
+    TypeInfo Type;
+
+    // std::string Name; // Name associated with this info.
 
     // When used for function parameters or variables,
     // contains the string representing the expression of the default value,
     // or the variable initializer if any.
-    llvm::SmallString<16> DefaultValue;
+    std::string Default;
 
     // attributes (nodiscard, no_unique_address, deprecated)
-    FieldFlags Flags;
+    FieldFlags specs;
+
     //--------------------------------------------
 
-    FieldInfo() = default;
+    static constexpr InfoType type_id = InfoType::IT_field;
 
     FieldInfo(
-            TypeInfo const& TI,
-            llvm::StringRef Name = llvm::StringRef(),
-            llvm::StringRef DefaultValue = llvm::StringRef(),
-            FieldFlags Flags = {})
-        : TypeInfo(TI)
-        , Name(Name)
-        , DefaultValue(DefaultValue)
-        , Flags(Flags)
+        SymbolID ID = SymbolID::zero,
+        llvm::StringRef Name = llvm::StringRef())
+        : SymbolInfo(InfoType::IT_field, ID, Name)
     {
     }
 };

include/mrdox/Metadata/Function.hpp

@@ -5,6 +5,7 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 // Copyright (c) 2023 Vinnie Falco ([email protected])
+// Copyright (c) 2023 Krystian Stasiowski ([email protected])
 //
 // Official repository: https://github.com/cppalliance/mrdox
 //
@@ -14,7 +15,7 @@
 
 #include <mrdox/Platform.hpp>
 #include <mrdox/ADT/BitField.hpp>
-#include <mrdox/Metadata/FieldType.hpp>
+#include <mrdox/Metadata/Field.hpp>
 #include <mrdox/Metadata/Function.hpp>
 #include <mrdox/Metadata/FunctionKind.hpp>
 #include <mrdox/Metadata/Symbol.hpp>
@@ -79,7 +80,10 @@ struct Param
     /** The type of this parameter */
     TypeInfo Type;
 
-    /** The name of this parameter, if any */
+    /** The parameter name.
+
+        Unnamed parameters are represented by empty strings.
+    */
     std::string Name;
 
     /** The default argument for this parameter, if any */
@@ -100,7 +104,8 @@ struct Param
 
 // TODO: Expand to allow for documenting templating and default args.
 // Info for functions.
-struct FunctionInfo : SymbolInfo
+struct FunctionInfo
+    : SymbolInfo
 {
     TypeInfo ReturnType;   // Info about the return type of this function.
     std::vector<Param> Params; // List of parameters.
@@ -117,7 +122,7 @@ struct FunctionInfo : SymbolInfo
 
     explicit
     FunctionInfo(
-        SymbolID id_ = SymbolID())
+        SymbolID id_ = SymbolID::zero)
         : SymbolInfo(InfoType::IT_function, id_)
     {
     }

include/mrdox/Metadata/Info.hpp

@@ -32,7 +32,7 @@ struct Info
 {
     /** The unique identifier for this symbol.
     */
-    SymbolID id = SymbolID();
+    SymbolID id = SymbolID::zero;
 
     /** Kind of declaration.
     */
@@ -59,7 +59,7 @@ struct Info
     explicit
     Info(
         InfoType IT = InfoType::IT_default,
-        SymbolID id_ = SymbolID(),
+        SymbolID id_ = SymbolID::zero,
         llvm::StringRef Name = llvm::StringRef())
         : id(id_)
         , IT(IT)

include/mrdox/Metadata/MemberType.hpp

@@ -5,6 +5,7 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 // Copyright (c) 2023 Vinnie Falco ([email protected])
+// Copyright (c) 2023 Krystian Stasiowski ([email protected])
 //
 // Official repository: https://github.com/cppalliance/mrdox
 //
@@ -15,8 +16,8 @@
 #include <mrdox/Platform.hpp>
 #include <mrdox/Metadata/Access.hpp>
 #include <mrdox/Metadata/Enum.hpp>
+#include <mrdox/Metadata/Field.hpp>
 #include <mrdox/Metadata/Function.hpp>
-#include <mrdox/Metadata/MemberType.hpp>
 #include <mrdox/Metadata/Record.hpp>
 #include <mrdox/Metadata/Typedef.hpp>
 #include <mrdox/Metadata/Var.hpp>
@@ -26,8 +27,7 @@ namespace mrdox {
 
 struct DataMember
 {
-    // FieldInfo const* I;
-    MemberTypeInfo const* I;
+    FieldInfo const* I;
     RecordInfo const* From;
 };
 

include/mrdox/Metadata/Members.hpp

@@ -15,7 +15,7 @@
 #include <mrdox/Platform.hpp>
 #include <mrdox/Metadata/Access.hpp>
 #include <mrdox/ADT/BitField.hpp>
-#include <mrdox/Metadata/MemberType.hpp>
+#include <mrdox/Metadata/Field.hpp>
 #include <mrdox/Metadata/Reference.hpp>
 #include <mrdox/Metadata/Scope.hpp>
 #include <mrdox/Metadata/Symbol.hpp>
@@ -63,20 +63,22 @@ struct BaseInfo
     }
 };
 
-/** Children of a class, struct, or union.
+/** Members of a class, struct, or union.
 */
 struct RecordScope
 {
     std::vector<MemberRef> Records;
     std::vector<MemberRef> Functions;
     std::vector<MemberRef> Enums;
     std::vector<MemberRef> Types;
+    std::vector<MemberRef> Fields;
     std::vector<MemberRef> Vars;
 };
 
 /** Metadata for struct, class, or union.
 */
-struct RecordInfo : SymbolInfo
+struct RecordInfo
+    : SymbolInfo
 {
     // VFALCO Use our own enumeration for this
     // Type of this record (struct, class, union, interface).
@@ -89,12 +91,11 @@ struct RecordInfo : SymbolInfo
     // structs in a typedef:
     //   typedef struct { ... } foo_t;
     // are converted into records with the typedef as the Name + this flag set.
+    // KRYSTIAN FIXME: this does not account for alias-declarations
     bool IsTypeDef = false;
 
     RecFlags0 specs;
 
-    llvm::SmallVector<MemberTypeInfo, 4> Members;   // List of info about record members.
-
     /** List of immediate bases.
     */
     std::vector<BaseInfo> Bases;
@@ -103,15 +104,17 @@ struct RecordInfo : SymbolInfo
     */
     llvm::SmallVector<SymbolID, 4> Friends;
 
-    RecordScope Children_;
+    /** Record members
+    */
+    RecordScope Members;
 
     //--------------------------------------------
 
     static constexpr InfoType type_id = InfoType::IT_record;
 
     explicit
     RecordInfo(
-        SymbolID id = SymbolID(),
+        SymbolID id = SymbolID::zero,
         llvm::StringRef Name = llvm::StringRef())
         : SymbolInfo(InfoType::IT_record, id, Name)
     {