Function parameters use Param

Author: sdkrystian

include/mrdox/Metadata/FieldType.hpp

@@ -31,7 +31,7 @@ union FieldFlags
 };
 
 // Info for field types.
-struct FieldTypeInfo
+struct FieldInfo
     : public TypeInfo
 {
     llvm::SmallString<16> Name; // Name associated with this info.
@@ -45,9 +45,9 @@ struct FieldTypeInfo
     FieldFlags Flags;
     //--------------------------------------------
 
-    FieldTypeInfo() = default;
+    FieldInfo() = default;
 
-    FieldTypeInfo(
+    FieldInfo(
             TypeInfo const& TI,
             llvm::StringRef Name = llvm::StringRef(),
             llvm::StringRef DefaultValue = llvm::StringRef(),

include/mrdox/Metadata/Function.hpp

@@ -71,12 +71,39 @@ union FnFlags1
     BitField<6, 7, FunctionKind> functionKind;
 };
 
+// KRYSTIAN TODO: attributes (nodiscard, deprecated, and carries_dependency)
+// KRYSTIAN TODO: flag to indicate whether this is a function parameter pack
+/** Represents a single function parameter */
+struct Param
+{
+    /** The type of this parameter */
+    TypeInfo Type;
+
+    /** The name of this parameter, if any */
+    std::string Name;
+
+    /** The default argument for this parameter, if any */
+    std::string Default;
+
+    Param() = default;
+
+    Param(
+        TypeInfo&& type,
+        std::string&& name,
+        std::string&& def_arg)
+        : Type(std::move(type))
+        , Name(std::move(name))
+        , Default(std::move(def_arg))
+    {
+    }
+};
+
 // TODO: Expand to allow for documenting templating and default args.
 // Info for functions.
 struct FunctionInfo : SymbolInfo
 {
     TypeInfo ReturnType;   // Info about the return type of this function.
-    llvm::SmallVector<FieldTypeInfo, 4> Params; // List of parameters.
+    std::vector<Param> Params; // List of parameters.
 
     // When present, this function is a template or specialization.
     llvm::Optional<TemplateInfo> Template;

include/mrdox/Metadata/MemberType.hpp

@@ -25,7 +25,7 @@ namespace mrdox {
 /** A data member for a class.
 */
 struct MemberTypeInfo
-    : FieldTypeInfo
+    : FieldInfo
     //, SymbolInfo
 {
     Access access = Access::Public;
@@ -40,7 +40,7 @@ struct MemberTypeInfo
         TypeInfo const& TI,
         llvm::StringRef Name,
         Access access_)
-        : FieldTypeInfo(TI, Name)
+        : FieldInfo(TI, Name)
         , access(access_)
     {
     }

include/mrdox/Metadata/Members.hpp

@@ -26,6 +26,7 @@ namespace mrdox {
 
 struct DataMember
 {
+    // FieldInfo const* I;
     MemberTypeInfo const* I;
     RecordInfo const* From;
 };

include/mrdox/MetadataFwd.hpp

@@ -30,7 +30,8 @@ enum class Access;
 struct BaseInfo;
 struct EnumValueInfo;
 struct EnumInfo;
-struct FieldTypeInfo;
+struct FieldInfo;
+struct Param;
 struct FunctionInfo;
 struct Info;
 struct Javadoc;

source/-XML/CXXTags.hpp

@@ -243,13 +243,13 @@ inline void writeReturnType(TypeInfo const& I, XMLTags& tags)
         });
 }
 
-inline void writeParam(FieldTypeInfo const& I, XMLTags& tags)
+inline void writeParam(Param const& P, XMLTags& tags)
 {
     tags.write(paramTagName, {}, {
-        { "name", I.Name, ! I.Name.empty() },
-        { "type", I.Type.Name },
-        { "default", I.DefaultValue, ! I.DefaultValue.empty() },
-        { I.Type.id } });
+        { "name", P.Name, ! P.Name.empty() },
+        { "type", P.Type.Type.Name },
+        { "default", P.Default, ! P.Default.empty() },
+        { P.Type.Type.id } });
 }
 
 inline void writeTemplateParam(const TParam& I, XMLTags& tags)

source/-adoc/AdocWriter.cpp

@@ -106,7 +106,7 @@ namespace adoc {
 
 struct AdocWriter::FormalParam
 {
-    FieldTypeInfo const& I;
+    Param const& I;
     AdocWriter& w;
 
     friend
@@ -115,9 +115,11 @@ struct AdocWriter::FormalParam
         llvm::raw_ostream& os,
         FormalParam const& t)
     {
-        os << t.I.Type.Name;
+        // KRYSTIAN FIXME: use AdocWriter::typeName
+        os << t.I.Type.Type.Name;
         if(! t.I.Name.empty())
             os << ' ' << t.I.Name;
+        // KRYSTIAN TODO: emit default argument
         return os;
     }
 };
@@ -218,7 +220,7 @@ write(
 auto
 AdocWriter::
 formalParam(
-    FieldTypeInfo const& t) ->
+    Param const& t) ->
         FormalParam
 {
     return FormalParam{ t, *this };
@@ -322,7 +324,7 @@ writeTrancheList(
             "|";
         writeBrief(V.I->javadoc, false);
         os_ << '\n';
-    }   
+    }
     os_ <<
         "|===\n" <<
         "\n";
@@ -461,7 +463,7 @@ AdocWriter::
 writeLinkFor(OverloadInfo const& I)
 {
     std::string s = names_.get(I.Parent->id).str();
-    
+
     os_ << "xref:#" <<
         names_.get(I.Parent->id) <<
         '-' << I.Name << "[" <<
@@ -516,7 +518,7 @@ writeNestedTypes(
             "|";
         writeBrief(I.javadoc, false);
         os_ << '\n';
-    }   
+    }
     os_ <<
         "|===\n" <<
         "\n";

source/-adoc/AdocWriter.hpp

@@ -65,8 +65,7 @@ class AdocWriter
     Section sect_;
     std::string temp_;
 
-    friend class TypeName;
-
+    friend struct TypeName;
 public:
     virtual ~AdocWriter() = default;
 
@@ -136,7 +135,7 @@ class AdocWriter
     void writeNode(Javadoc::TParam const& node);
     void writeNode(Javadoc::Returns const& node);
 
-    FormalParam formalParam(FieldTypeInfo const& ft);
+    FormalParam formalParam(Param const& ft);
     TypeName typeName(TypeInfo const& ti);
 
     void beginSection(Info const& I);

source/AST/ASTVisitor.cpp

@@ -337,11 +337,10 @@ parseParameters(
         // KRYSTIAN NOTE: call getOriginalType instead
         // of getType if we want to preserve top-level
         // cv-qualfiers/array types/function types
-        FieldTypeInfo& FieldInfo = I.Params.emplace_back(
+        I.Params.emplace_back(
             getTypeInfoForType(P->getType()),
-            P->getNameAsString());
-        FieldInfo.DefaultValue = getSourceCode(
-            D, P->getDefaultArgRange());
+            P->getNameAsString(),
+            getSourceCode(D, P->getDefaultArgRange()));
     }
 }
 

source/AST/AnyBlock.hpp

@@ -438,13 +438,13 @@ class FieldTypeBlock
 {
 protected:
     BitcodeReader& br_;
-    FieldTypeInfo& I_;
+    FieldInfo& I_;
 
 public:
     FieldId F;
 
     FieldTypeBlock(
-        FieldTypeInfo& I,
+        FieldInfo& I,
         BitcodeReader& br) noexcept
         : br_(br)
         , I_(I)
@@ -807,6 +807,80 @@ class TemplateBlock
     }
 };
 
+//------------------------------------------------
+
+class FunctionParamBlock
+    : public BitcodeReader::AnyBlock
+{
+    BitcodeReader& br_;
+    Param& I_;
+
+public:
+    FunctionParamBlock(
+        Param& I,
+        BitcodeReader& br) noexcept
+        : br_(br)
+        , I_(I)
+    {
+    }
+
+    llvm::Error
+    parseRecord(
+        Record const& R,
+        unsigned ID,
+        llvm::StringRef Blob) override
+    {
+        switch(ID)
+        {
+        case FUNCTION_PARAM_NAME:
+        {
+            return decodeRecord(R, I_.Name, Blob);
+        }
+        case FUNCTION_PARAM_DEFAULT:
+        {
+            return decodeRecord(R, I_.Default, Blob);
+        }
+        /*
+        case FUNCTION_PARAM_IS_PACK:
+        {
+            return decodeRecord(R, I_.IsParameterPack, Blob);
+        }
+        */
+        default:
+            return AnyBlock::parseRecord(R, ID, Blob);
+        }
+    }
+
+    llvm::Error
+    readSubBlock(
+        unsigned ID) override
+    {
+        switch(ID)
+        {
+        case BI_TYPE_BLOCK_ID:
+        {
+            TypeBlock B(I_.Type, br_);
+            if(auto Err = br_.readBlock(B, ID))
+                return Err;
+            // KRYSTIAN NOTE: is this check correct?
+            // copied from a function with TypeInfo sub-block
+            switch(B.F)
+            {
+            case FieldId::F_type:
+                break;
+            default:
+                return makeWrongFieldError(B.F);
+            }
+            return llvm::Error::success();
+        }
+        default:
+            break;
+        }
+        return AnyBlock::readSubBlock(ID);
+    }
+};
+
+
 //------------------------------------------------
 
 template<class T>
@@ -1041,6 +1115,8 @@ class FunctionBlock
             }
             return llvm::Error::success();
         }
+
+#if 0
         case BI_FIELD_TYPE_BLOCK_ID:
         {
             FieldTypeBlock B(I->Params.emplace_back(), br_);
@@ -1055,6 +1131,13 @@ class FunctionBlock
             }
             return llvm::Error::success();
         }
+#else
+        case BI_FUNCTION_PARAM_BLOCK_ID:
+        {
+            FunctionParamBlock B(I->Params.emplace_back(), br_);
+            return br_.readBlock(B, ID);
+        }
+#endif
         case BI_TEMPLATE_BLOCK_ID:
         {
             TemplateBlock B(I->Template, br_);