-/// This class is used by Function and CallInst to represent the set of
-/// parameter attributes used. It represents a list of pairs of uint16_t, one
-/// for the parameter index, and one a set of ParameterAttributes bits.
-/// Parameters that have no attributes are not present in the list. The list
-/// may also be empty, but this doesn't occur in practice. The list constructs
-/// as empty and is filled by the insert method. The list can be turned into
-/// a string of mnemonics suitable for LLVM Assembly output. Various accessors
-/// are provided to obtain information about the attributes.
+}
+
+/// This is just a pair of values to associate a set of parameter attributes
+/// with a parameter index.
+/// @brief ParameterAttributes with a parameter index.
+struct ParamAttrsWithIndex {
+ uint16_t attrs; ///< The attributes that are set, |'d together
+ uint16_t index; ///< Index of the parameter for which the attributes apply
+
+ static ParamAttrsWithIndex get(uint16_t idx, uint16_t attrs) {
+ ParamAttrsWithIndex P;
+ P.index = idx;
+ P.attrs = attrs;
+ return P;
+ }
+};
+
+/// @brief A vector of attribute/index pairs.
+typedef SmallVector<ParamAttrsWithIndex,4> ParamAttrsVector;
+
+/// @brief A more friendly way to reference the attributes.
+typedef ParamAttr::Attributes ParameterAttributes;
+
+/// This class represents a list of attribute/index pairs for parameter
+/// attributes. Each entry in the list contains the index of a function
+/// parameter and the associated ParameterAttributes. If a parameter's index is
+/// not present in the list, then no attributes are set for that parameter. The
+/// list may also be empty, but this does not occur in practice. An item in
+/// the list with an index of 0 refers to the function as a whole or its result.
+/// To construct a ParamAttrsList, you must first fill a ParamAttrsVector with
+/// the attribute/index pairs you wish to set. The list of attributes can be
+/// turned into a string of mnemonics suitable for LLVM Assembly output.
+/// Various accessors are provided to obtain information about the attributes.
+/// Note that objects of this class are "uniqued". The \p get method can return
+/// the pointer of an existing and identical instance. Consequently, reference
+/// counting is necessary in order to determine when the last reference to a
+/// ParamAttrsList of a given shape is dropped. Users of this class should use
+/// the addRef and dropRef methods to add/drop references. When the reference
+/// count goes to zero, the ParamAttrsList object is deleted.
+/// This class is used by Function, CallInst and InvokeInst to represent their
+/// sets of parameter attributes.