X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Futil.h;h=f638dfed52dcabe2ac80c2efe315b7258e108467;hp=28639ba97be6b1e3efe726ae2dddf06f7a89665f;hb=52209badc8e769e50aa3019b63689dda0e79e9d0;hpb=6f99a6e2f39aaacabe8bb51a7bb1ff53c1b2082f diff --git a/src/common/util.h b/src/common/util.h index 28639ba9..f638dfed 100644 --- 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,29 +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 -#include -#include -#include -#include +#include "common-export.h" +#include +#include +#include +#include -// TODO Use versions from Network instead -QString nickFromMask(QString mask); -QString userFromMask(QString mask); -QString hostFromMask(QString mask); -bool isChannelName(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 +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 @@ -46,45 +47,96 @@ 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); + +COMMON_EXPORT uint editingDistance(const QString& s1, const QString& s2); -uint editingDistance(const QString &s1, const QString &s2); +template +QSet toQSet(const QList& list) +{ +#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0) + return list.toSet(); +#else + return {list.begin(), list.end()}; +#endif +} -QDir quasselDir(); +template +QVariantList toVariantList(const QList& list) +{ + QVariantList variants; + for (int i = 0; i < list.count(); i++) { + variants << QVariant::fromValue(list[i]); + } + return variants; +} -//! Returns a list of data directory paths -/** There are several locations for applications to install their data files in. On Unix, - * a common location is /usr/share; others include $PREFIX/share and additional directories - * specified in the env variable XDG_DATA_DIRS. - * \return A list of directory paths to look for data files in +template +QList fromVariantList(const QVariantList& variants) +{ + QList list; + for (int i = 0; i < variants.count(); i++) { + list << variants[i].value(); + } + return list; +} + +COMMON_EXPORT QByteArray prettyDigest(const QByteArray& digest); + +/** + * Format a string with %%%% to current date/timestamp via QDateTime. + * + * @param[in] formatStr String with format codes + * @return String with current date/time substituted in via formatting codes */ -QStringList dataDirPaths(); +COMMON_EXPORT QString formatCurrentDateTimeInString(const QString& formatStr); -//! Searches for a data file in the possible data directories -/** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories - * returned by \sa dataDirPaths(). - * \return The full path to the data file if found; a null QString else +/** + * 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 */ -QString findDataFilePath(const QString &fileName); +COMMON_EXPORT QString tryFormatUnixEpoch(const QString& possibleEpochDate, + Qt::DateFormat dateFormat = Qt::DateFormat::TextDate, + bool useUTC = false); -void loadTranslation(const QLocale &locale); +/** + * 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); -template -QVariantList toVariantList(const QList &list) { - QVariantList variants; - for(int i = 0; i < list.count(); i++) { - variants << QVariant::fromValue(list[i]); - } - return variants; -} +namespace detail { -template -QList fromVariantList(const QVariantList &variants) { - QList list; - for(int i = 0; i < variants.count(); i++) { - list << variants[i].value(); - } - return list; -} +template +struct SelectOverloadHelper +{ + template + constexpr auto operator()(R (C::*func)(Args...)) const noexcept -> decltype(func) + { + return func; + } +}; -#endif +} // namespace detail + +/** + * Helper for resolving ambiguous overloads when using the member function-based connect syntax. + * + * Example usage: + * @code + * connect(this, selectOverload(&MyClass::mySignal), other, &Other::mySlot); + * @endcode + * + * @tparam Args Argument types of the desired signature + */ +template +constexpr Q_DECL_UNUSED detail::SelectOverloadHelper selectOverload = {};