qa: Avoid deprecation warnings for QList/QSet conversions

[quassel.git] / src / common / util.h

diff --git a/src/common/util.h b/src/common/util.h
index 9354620..f638dfe 100644 (file)
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 by the Quassel Project                          *
+ *   Copyright (C) 2005-2019 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,24 +15,30 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef _UTIL_H_
-#define _UTIL_H_
+#pragma once
 
-#include <QIODevice>
-#include <QVariant>
+#include "common-export.h"
+
+#include <QList>
+#include <QSet>
 #include <QString>
-#include <QMetaMethod>
+#include <QVariant>
 
+COMMON_EXPORT QString nickFromMask(const QString& mask);
+COMMON_EXPORT QString userFromMask(const QString& mask);
+COMMON_EXPORT QString hostFromMask(const QString& mask);
+COMMON_EXPORT bool isChannelName(const QString& str);
 
-// TODO Use versions from Network instead
-QString nickFromMask(QString mask);
-QString userFromMask(QString mask);
-QString hostFromMask(QString mask);
-bool isChannelName(QString str);
+//! Strip mIRC format codes
+COMMON_EXPORT QString stripFormatCodes(QString);
 
+//! Remove accelerator markers (&) from the string
+COMMON_EXPORT QString stripAcceleratorMarkers(const QString&);
+
+COMMON_EXPORT QString secondsToString(int timeInSeconds);
 
 //! Take a string and decode it using the specified text codec, recognizing utf8.
 /** This function takes a string and first checks if it is encoded in utf8, in which case it is
@@ -41,14 +47,96 @@ bool isChannelName(QString str);
  *  \param codec The text codec we use if the input is not utf8
  *  \return The decoded string.
  */
-QString decodeString(const QByteArray &input, QTextCodec *codec = 0);
+COMMON_EXPORT QString decodeString(const QByteArray& input, QTextCodec* codec = nullptr);
 
-// NOTE: We have static copies of these in SignalProxy...
-//void writeDataToDevice(QIODevice *, const QVariant &);
-//bool readDataFromDevice(QIODevice *, quint32 &, QVariant &);
+COMMON_EXPORT uint editingDistance(const QString& s1, const QString& s2);
 
-uint editingDistance(const QString &s1, const QString &s2);
+template<typename T>
+QSet<T> toQSet(const QList<T>& list)
+{
+#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
+    return list.toSet();
+#else
+    return {list.begin(), list.end()};
+#endif
+}
 
-QByteArray methodName(const QMetaMethod &method);
+template<typename T>
+QVariantList toVariantList(const QList<T>& list)
+{
+    QVariantList variants;
+    for (int i = 0; i < list.count(); i++) {
+        variants << QVariant::fromValue(list[i]);
+    }
+    return variants;
+}
 
-#endif
+template<typename T>
+QList<T> fromVariantList(const QVariantList& variants)
+{
+    QList<T> list;
+    for (int i = 0; i < variants.count(); i++) {
+        list << variants[i].value<T>();
+    }
+    return list;
+}
+
+COMMON_EXPORT QByteArray prettyDigest(const QByteArray& digest);
+
+/**
+ * Format a string with %%<text>%% to current date/timestamp via QDateTime.
+ *
+ * @param[in] formatStr String with format codes
+ * @return String with current date/time substituted in via formatting codes
+ */
+COMMON_EXPORT QString formatCurrentDateTimeInString(const QString& formatStr);
+
+/**
+ * Try to localize a given date/time in seconds from Unix epoch, pass through string if invalid
+ *
+ * Allows compatibility with date/time fields that may or may not be in Unix epoch format,
+ * localizing if possible, leaving alone if not.
+ *
+ * @param possibleEpochDate Date/time that might be in seconds since Unix epoch format
+ * @param dateFormat        Desired format of the date/time string
+ * @param useUTC            If true, use UTC timezone, otherwise use local time
+ * @return Localized date/time if parse succeeded, otherwise the source string
+ */
+COMMON_EXPORT QString tryFormatUnixEpoch(const QString& possibleEpochDate,
+                                         Qt::DateFormat dateFormat = Qt::DateFormat::TextDate,
+                                         bool useUTC = false);
+
+/**
+ * Format the given date/time in ISO 8601 format with timezone offset
+ *
+ * @param dateTime Date/time of interest
+ * @return Date/time in ISO 8601 format with timezone offset
+ */
+COMMON_EXPORT QString formatDateTimeToOffsetISO(const QDateTime& dateTime);
+
+namespace detail {
+
+template<typename... Args>
+struct SelectOverloadHelper
+{
+    template<typename R, typename C>
+    constexpr auto operator()(R (C::*func)(Args...)) const noexcept -> decltype(func)
+    {
+        return func;
+    }
+};
+
+}  // namespace detail
+
+/**
+ * Helper for resolving ambiguous overloads when using the member function-based connect syntax.
+ *
+ * Example usage:
+ * @code
+ * connect(this, selectOverload<int, QString>(&MyClass::mySignal), other, &Other::mySlot);
+ * @endcode
+ *
+ * @tparam Args Argument types of the desired signature
+ */
+template<typename... Args>
+constexpr Q_DECL_UNUSED detail::SelectOverloadHelper<Args...> selectOverload = {};