Extend custom enumeration API: string_to_enumeration (#44)

* Extend custom enumeration API: string_to_enumeration

Signed-off-by: Juan López Fernández <juanlopez@eprosima.com>

* Uncrustify

Signed-off-by: Juan López Fernández <juanlopez@eprosima.com>

---------

Signed-off-by: Juan López Fernández <juanlopez@eprosima.com>

Author: juanlofer-eprosima

cpp_utils/include/cpp_utils/macros/custom_enumeration.hpp

@@ -75,12 +75,20 @@ namespace utils {
     inline std::vector<std::string> string_vector_ ## enumeration_name()                                            \
     { return std::vector<std::string> (NAMES_ ## enumeration_name.begin(), NAMES_ ## enumeration_name.end()); }     \
                                                                                                                     \
+    /* String to enumeration */                                                                                     \
+    inline bool string_to_enumeration(const std::string& s, enumeration_name & e)                                   \
+    {                                                                                                               \
+        for (int i = 0; i < COUNT_ARGUMENTS(__VA_ARGS__); i++)                                                      \
+        if (NAMES_ ## enumeration_name[i] == s){e = static_cast<enumeration_name>(i); return true;}                 \
+        return false;                                                                                               \
+    }                                                                                                               \
+                                                                                                                    \
     /* From string */                                                                                               \
     inline enumeration_name from_string_ ## enumeration_name(const std::string& s)                                  \
     {                                                                                                               \
-        for (int i = 0; i < COUNT_ARGUMENTS(__VA_ARGS__); i++)                                                      \
-        if (NAMES_ ## enumeration_name[i] == s)return static_cast<enumeration_name>(i);                             \
-        throw eprosima::utils::InitializationException(                                                             \
+        enumeration_name e;                                                                                         \
+        if (string_to_enumeration(s, e))return e;                                                                   \
+        throw eprosima::utils::InitializationException (                                                            \
                   STR_ENTRY << "Not correct name " << s << " for Enum " << STRINGIFY(enumeration_name) << ".");     \
     }                                                                                                               \
                                                                                                                     \
@@ -95,7 +103,7 @@ namespace utils {
     inline std::array<enumeration_name, COUNT_ARGUMENTS(__VA_ARGS__)> all_values_ ## enumeration_name()             \
     {                                                                                                               \
         std::array<enumeration_name, COUNT_ARGUMENTS(__VA_ARGS__)> result;                                          \
-        for (int i = 0; i < COUNT_ARGUMENTS(__VA_ARGS__); i++)result[i] = enumeration_name(i);                     \
+        for (int i = 0; i < COUNT_ARGUMENTS(__VA_ARGS__); i++)result[i] = enumeration_name(i);                      \
         return result;                                                                                              \
     }                                                                                                               \
                                                                                                                     \

cpp_utils/test/unittest/macros/CMakeLists.txt

@@ -90,6 +90,7 @@ set(TEST_SOURCES
 
 set(TEST_LIST
         show_how
+        string_to_enumeration
         from_string
         to_string
         serializator

cpp_utils/test/unittest/macros/enumerationBuilderMacrosTest.cpp

@@ -92,6 +92,27 @@ TEST(enumerationBuilderMacrosTest, n_values)
     ASSERT_EQ(test::N_VALUES_TestCustomEnum, test::NUMBER_OF_ELEMENTS);
 }
 
+/**
+ * Construct enumeration of type TestCustomEnum from a string.
+ *
+ * CASES:
+ * x each element inside
+ * - string not in enumeration
+ */
+TEST(enumerationBuilderMacrosTest, string_to_enumeration)
+{
+    test::TestCustomEnum value;
+    // x each element inside
+    for (unsigned int i = 0; i < test::N_VALUES_TestCustomEnum; i++)
+    {
+        ASSERT_TRUE(test::string_to_enumeration(test::string_values[i], value));
+        ASSERT_TRUE(value == test::enum_values[i]);
+    }
+
+    // string not in enumeration
+    ASSERT_FALSE(test::string_to_enumeration("el_0", value));
+}
+
 /**
  * Construct enumeration of type TestCustomEnum from a string.
  *