src: Yearly copyright bump
[quassel.git] / src / common / util.h
index 514c564..bbe89f5 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2018 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  *
 
 #pragma once
 
+#include "common-export.h"
+
 #include <QList>
 #include <QString>
 #include <QVariant>
 
-QString nickFromMask(const QString &mask);
-QString userFromMask(const QString &mask);
-QString hostFromMask(const QString &mask);
-bool isChannelName(const QString &str);
+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);
 
 //! Strip mIRC format codes
-QString stripFormatCodes(QString);
+COMMON_EXPORT QString stripFormatCodes(QString);
 
 //! Remove accelerator markers (&) from the string
-QString stripAcceleratorMarkers(const QString &);
+COMMON_EXPORT QString stripAcceleratorMarkers(const QString&);
 
-QString secondsToString(int timeInSeconds);
+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
@@ -44,12 +46,12 @@ QString secondsToString(int timeInSeconds);
  *  \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);
 
-uint editingDistance(const QString &s1, const QString &s2);
+COMMON_EXPORT uint editingDistance(const QString& s1, const QString& s2);
 
 template<typename T>
-QVariantList toVariantList(const QList<T> &list)
+QVariantList toVariantList(const QList<T>list)
 {
     QVariantList variants;
     for (int i = 0; i < list.count(); i++) {
@@ -58,9 +60,8 @@ QVariantList toVariantList(const QList<T> &list)
     return variants;
 }
 
-
 template<typename T>
-QList<T> fromVariantList(const QVariantList &variants)
+QList<T> fromVariantList(const QVariantListvariants)
 {
     QList<T> list;
     for (int i = 0; i < variants.count(); i++) {
@@ -69,8 +70,7 @@ QList<T> fromVariantList(const QVariantList &variants)
     return list;
 }
 
-
-QByteArray prettyDigest(const QByteArray &digest);
+COMMON_EXPORT QByteArray prettyDigest(const QByteArray& digest);
 
 /**
  * Format a string with %%<text>%% to current date/timestamp via QDateTime.
@@ -78,29 +78,7 @@ QByteArray prettyDigest(const QByteArray &digest);
  * @param[in] formatStr String with format codes
  * @return String with current date/time substituted in via formatting codes
  */
-QString formatCurrentDateTimeInString(const QString &formatStr);
-
-/** Check if a scope rule matches a string
- *
- * When isRegEx is false:
- * Checks that the string does NOT match ANY inverted rules (prefixed by '!'), then checks that
- * it matches AT LEAST one normal (non-inverted) rule.
- *
- * If only inverted rules are specified, it'll match so long as the string does not match any
- * inverted rules (implicit wildcard).
- *
- * When isRegEx is true:
- * Checks that the string matches the entire scopeRule as a regular expression.  If scopeRule starts
- * with a '!', check that the string does NOT match the regular expression.
- *
- * @param string           String to test, e.g. network/channel name
- * @param scopeRule        ';'-separated list of wildcard expressions, prefix of '!' inverts subrule
- * @param isRegEx          If true, treat entire scope rule as regular expression, not wildcards
- * @param isCaseSensitive  If true, treat as case-sensitive, else case-insensitive
- * @return True if matches, otherwise false
- */
-bool scopeMatch(const QString &string, const QString &scopeRule,
-                const bool &isRegEx = false, const bool &isCaseSensitive = false);
+COMMON_EXPORT QString formatCurrentDateTimeInString(const QString& formatStr);
 
 /**
  * Try to localize a given date/time in seconds from Unix epoch, pass through string if invalid
@@ -113,10 +91,9 @@ bool scopeMatch(const QString &string, const QString &scopeRule,
  * @param useUTC            If true, use UTC timezone, otherwise use local time
  * @return Localized date/time if parse succeeded, otherwise the source string
  */
-QString tryFormatUnixEpoch(const QString &possibleEpochDate,
-                           Qt::DateFormat dateFormat = Qt::DateFormat::TextDate,
-                           bool useUTC = false);
-
+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
@@ -124,4 +101,31 @@ QString tryFormatUnixEpoch(const QString &possibleEpochDate,
  * @param dateTime Date/time of interest
  * @return Date/time in ISO 8601 format with timezone offset
  */
-QString formatDateTimeToOffsetISO(const QDateTime &dateTime);
+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 = {};