Merge branch 'named-enums' into resize-control

src/libcalamares/utils/NamedEnum.h

@@ -0,0 +1,110 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2019, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/** @brief Support for "named" enumerations
+ *
+ * For tables which map string names to enum values, provide a NamedEnumTable
+ * which hangs on to an initializer_list of pairs of names and values.
+ * This table can be used with find() to map names to values, or
+ * values to names. A convenience function smash() is provided to help
+ * in printing integer (underlying) values of an enum.
+ */
+
+#ifndef LIBCALAMARES_NAMEDENUM_H
+#define LIBCALAMARES_NAMEDENUM_H
+
+#include <QString>
+
+#include <type_traits>
+#include <initializer_list>
+
+/** @brief Type for collecting parts of a named enum. */
+template<typename T>
+struct NamedEnumTable
+{
+    using string_t = QString;
+    using enum_t = T;
+    using pair_t = std::pair< string_t, enum_t >;
+    using type = std::initializer_list< pair_t >;
+
+    type table;
+
+    /** @brief Create a table of named enum values.
+     *
+     * Use braced-initialisation for NamedEnum, and remember that the
+     * elements of the list are **pairs**, e.g.
+     *
+     * static const NamedEnumTable<Colors> c{ {"red", Colors::Red } };
+     */
+    NamedEnumTable( type v ) : table( v ) { /* static_assert( v.size() > 0 ); */ };
+
+    /** @brief Find a name @p s in the table.
+     *
+     * Searches case-insensitively.
+     *
+     * If the name @p s is not found, @p ok is set to false and
+     * the first enum value in the table is returned. Otherwise,
+     * @p ok is set to true and the corresponding value is returned.
+     *
+     */
+    enum_t find( const string_t& s, bool& ok ) const
+    {
+        ok = false;
+
+        for ( const auto p : table )
+            if ( 0 == QString::compare( s, p.first, Qt::CaseInsensitive ) )
+            {
+                ok = true;
+                return p.second;
+            }
+
+        // ok is still false
+        return table.begin()->second;
+    }
+
+    /** @brief Find a value @p s in the table.
+     *
+     * If the value @p s is not found, @p ok is set to false and
+     * an empty string is returned. Otherwise, @p is set to true
+     * and the corresponding name is returned.
+     */
+    string_t find( enum_t s, bool& ok ) const
+    {
+        ok = false;
+
+        for ( const auto p : table )
+            if ( s == p.second)
+            {
+                ok = true;
+                return p.first;
+            }
+
+        // ok is still false
+        return string_t();
+    }
+} ;
+
+/** @brief Smashes an enum value to its underlying type. */
+template<typename E>
+constexpr typename std::underlying_type<E>::type smash( const E e )
+{
+    return static_cast<typename std::underlying_type<E>::type>( e );
+}
+
+
+#endif

src/modules/partition/gui/PartitionViewStep.cpp

@@ -35,6 +35,7 @@
 #include "CalamaresVersion.h"
 #include "utils/CalamaresUtilsGui.h"
 #include "utils/Logger.h"
+#include "utils/NamedEnum.h"
 #include "utils/Retranslator.h"
 #include "widgets/WaitingWidget.h"
 #include "GlobalStorage.h"
@@ -474,25 +475,17 @@ PartitionViewStep::onLeave()
 static PartitionActions::Choices::SwapChoice
 nameToChoice( QString name, bool& ok )
 {
-    ok = false;
-    name = name.toLower();
-
     using namespace PartitionActions::Choices;
 
-    // Each return here first sets ok to true, returns enum value
-    if ( name == QStringLiteral( "none" ) )
-        return( ok=true, SwapChoice::NoSwap );
-    else if ( name == QStringLiteral( "small" ) )
-        return( ok=true, SwapChoice::SmallSwap);
-    else if ( name == QStringLiteral( "suspend" ) )
-        return( ok=true, SwapChoice::FullSwap );
-    else if ( name == QStringLiteral( "reuse" ) )
-        return( ok=true, SwapChoice::ReuseSwap );
-    else if ( name == QStringLiteral( "file" ) )
-        return( ok=true, SwapChoice::SwapFile );
+    static const NamedEnumTable<SwapChoice> names {
+        { QStringLiteral( "none" ), SwapChoice::NoSwap },
+        { QStringLiteral( "small" ), SwapChoice::SmallSwap },
+        { QStringLiteral( "suspend" ), SwapChoice::FullSwap },
+        { QStringLiteral( "reuse" ), SwapChoice::ReuseSwap },
+        { QStringLiteral( "file" ), SwapChoice::SwapFile }
+    };
 
-    ok = false;
-    return SwapChoice::NoSwap;
+    return names.find( name, ok );
 }