Added support for comms::option::def::HasName option.

commschamp · Nov 21, 2024 · d8601fa · d8601fa
1 parent c93bad4
commit d8601fa
Show file tree

Hide file tree

Showing 12 changed files with 101 additions and 4 deletions.
diff --git a/include/comms/Field.h b/include/comms/Field.h
@@ -111,6 +111,13 @@ class Field : public details::FieldBase<TOptions...>
         return false;
     }
 
+    /// @brief Check of whether the field class defines @b name() function
+    /// @return Always @b false
+    static constexpr bool hasName()
+    {
+        return false;
+    }     
+
 protected:
     /// @brief Write data into the output buffer.
     /// @details Use this function to write data to the the buffer

diff --git a/include/comms/field/ArrayList.h b/include/comms/field/ArrayList.h
@@ -171,6 +171,7 @@ using ArrayListBase =
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::SequenceElemFixedSerLengthFieldPrefix
 ///     @li @ref comms::option::def::SequenceElemSerLengthFieldPrefix
@@ -362,6 +363,13 @@ class ArrayList : public details::ArrayListBase<TFieldBase, TElement, TOptions..
         return ParsedOptions::HasFixedValue;
     }      
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }  
+
     /// @brief Compile time inquiry of fixed size provided via @ref comms::option::def::SequenceFixedSize option.
     /// @details If the @ref comms::option::def::SequenceFixedSize option hasn't been used
     ///     <b>std::numeric_limits&lt;std::size_t&gt;\::max()</b> is returned.

diff --git a/include/comms/field/Bitfield.h b/include/comms/field/Bitfield.h
@@ -75,6 +75,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::HasVersionDependentMembers
 ///     @li @ref comms::option::def::VersionStorage
 
@@ -187,6 +188,13 @@ class Bitfield : public
         return ParsedOptions::HasFixedValue;
     }  
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }     
+
     /// @brief Retrieve number of bits specified member field consumes.
     /// @tparam TIdx Index of the member field.
     /// @return Number of bits, specified with @ref comms::option::def::FixedBitLength option

diff --git a/include/comms/field/BitmaskValue.h b/include/comms/field/BitmaskValue.h
@@ -90,6 +90,7 @@ using BitmaskUndertlyingTypeT =
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::VersionStorage
 /// @extends comms::Field
@@ -194,7 +195,14 @@ class BitmaskValue : public TFieldBase
     static constexpr bool hasFixedValue()
     {
         return ParsedOptions::HasFixedValue;
-    }      
+    }  
+
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }         
 
     /// @brief Get access to underlying mask value storage.
     /// @return Const reference to the underlying stored value.

diff --git a/include/comms/field/Bundle.h b/include/comms/field/Bundle.h
@@ -41,6 +41,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::HasVersionDependentMembers
 ///     @li @ref comms::option::def::RemLengthMemberField
 ///     @li @ref comms::option::def::VersionStorage
@@ -152,6 +153,13 @@ class Bundle : public
         return ParsedOptions::HasFixedValue;
     }      
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    } 
+
     /// @brief Get access to the stored tuple of fields.
     ValueType& value()
     {

diff --git a/include/comms/field/EnumValue.h b/include/comms/field/EnumValue.h
@@ -59,6 +59,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::InvalidByDefault
 ///     @li @ref comms::option::def::NumValueSerOffset
@@ -151,7 +152,14 @@ class EnumValue : public details::AdaptBasicFieldT<basic::EnumValue<TFieldBase,
     static constexpr bool hasFixedValue()
     {
         return ParsedOptions::HasFixedValue;
-    }      
+    }   
+
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }    
 
     /// @brief Get access to enum value storage.
     const ValueType& value() const

diff --git a/include/comms/field/FloatValue.h b/include/comms/field/FloatValue.h
@@ -46,6 +46,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::InvalidByDefault
 ///     @li @b comms::option::def::Units* - all variants of value units, see
@@ -145,6 +146,13 @@ class FloatValue : public details::AdaptBasicFieldT<basic::FloatValue<TFieldBase
         return ParsedOptions::HasFixedValue;
     }   
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    } 
+
     /// @brief Get access to floating point value storage.
     const ValueType& value() const
     {

diff --git a/include/comms/field/IntValue.h b/include/comms/field/IntValue.h
@@ -56,6 +56,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::InvalidByDefault
 ///     @li @ref comms::option::def::NumValueSerOffset
@@ -191,7 +192,14 @@ class IntValue : public details::AdaptBasicFieldT<basic::IntValue<TFieldBase, T>
     static constexpr bool hasDisplayOffset()
     {
         return ParsedOptions::HasDisplayOffset;
-    }                
+    }    
+
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }                  
 
     /// @brief Scales value according to ratio specified in provided
     ///     @ref comms::option::def::ScalingRatio option.

diff --git a/include/comms/field/Optional.h b/include/comms/field/Optional.h
@@ -36,6 +36,7 @@ namespace field
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::MissingOnInvalid
 ///     @li @ref comms::option::def::MissingOnReadFail
 ///     @li @ref comms::option::def::VersionStorage
@@ -141,6 +142,13 @@ class Optional : public details::AdaptBasicFieldT<basic::Optional<TField>, TOpti
         return ParsedOptions::HasFixedValue;
     }       
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    } 
+
     /// @brief Check whether mode is equivalent to Mode::Tentative
     /// @details Convenience wrapper for getMode(), equivalent to
     ///     @code return getMode() == Mode::Tentative; @endcode

diff --git a/include/comms/field/String.h b/include/comms/field/String.h
@@ -140,6 +140,7 @@ using StringBase =
 ///     @li @ref comms::option::def::FixedValue
 ///     @li @ref comms::option::def::HasCustomRead
 ///     @li @ref comms::option::def::HasCustomRefresh
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::IgnoreInvalid
 ///     @li @ref comms::option::def::InvalidByDefault
 ///     @li @ref comms::option::def::SequenceFixedSize
@@ -309,6 +310,13 @@ class String : public details::StringBase<TFieldBase, TOptions...>
         return ParsedOptions::HasFixedValue;
     }  
 
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    } 
+
     /// @brief Compile time inquiry of fixed size provided via @ref comms::option::def::SequenceFixedSize option.
     /// @details If the @ref comms::option::def::SequenceFixedSize option hasn't been used
     ///     <b>std::numeric_limits&lt;std::size_t&gt;\::max()</b> is returned.

diff --git a/include/comms/field/Variant.h b/include/comms/field/Variant.h
@@ -58,6 +58,7 @@ namespace field
 ///         functionality
 ///     @li @ref comms::option::def::HasCustomRefresh - Mark field to have custom
 ///         refresh functionality.
+///     @li @ref comms::option::def::HasName
 ///     @li @ref comms::option::def::HasVersionDependentMembers
 ///     @li @ref comms::option::def::VariantHasCustomResetOnDestruct - avoid calling
 ///         default @ref comms::field::Variant::reset() "reset()" on destruction, assume
@@ -174,7 +175,14 @@ class Variant : public
     static constexpr bool hasFixedValue()
     {
         return ParsedOptions::HasFixedValue;
-    }        
+    }   
+
+    /// @brief Compile time inquiry of whether @ref comms::option::def::HasName option
+    ///     has been used.
+    static constexpr bool hasName()
+    {
+        return ParsedOptions::HasName;
+    }       
 
     /// @brief Get access to the internal storage buffer.
     /// @details Should not be used in normal operation.

diff --git a/include/comms/field/details/OptionsParser.h b/include/comms/field/details/OptionsParser.h
@@ -76,6 +76,7 @@ class OptionsParser<>
     static constexpr bool HasVersionDependentMembersForced = false;
     static constexpr bool HasFixedValue = false;
     static constexpr bool HasDisplayOffset = false;
+    static constexpr bool HasName = false;
 
     using UnitsType = void;
     using ScalingRatio = std::ratio<1, 1>;
@@ -825,6 +826,15 @@ class OptionsParser<
     using AdaptDisplayOffset = comms::field::adapter::DisplayOffset<TOffset, TField>;       
 };
 
+template <typename... TOptions>
+class OptionsParser<
+    comms::option::def::HasName,
+    TOptions...> : public OptionsParser<TOptions...>
+{
+public:
+    static constexpr bool HasName = true;
+};
+
 template <typename... TOptions>
 class OptionsParser<
     comms::option::app::EmptyOption,