src/common/util.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <QList>
  24 #include <QString>
  25 #include <QVariant>
  26
  27 QString nickFromMask(const QString &mask);
  28 QString userFromMask(const QString &mask);
  29 QString hostFromMask(const QString &mask);
  30 bool isChannelName(const QString &str);
  31
  32 //! Strip mIRC format codes
  33 QString stripFormatCodes(QString);
  34
  35 //! Remove accelerator markers (&) from the string
  36 QString stripAcceleratorMarkers(const QString &);
  37
  38 QString secondsToString(int timeInSeconds);
  39
  40 //! Take a string and decode it using the specified text codec, recognizing utf8.
  41 /** This function takes a string and first checks if it is encoded in utf8, in which case it is
  42  *  decoded appropriately. Otherwise, the specified text codec is used to transform the string.
  43  *  \param input The input string containing encoded data
  44  *  \param codec The text codec we use if the input is not utf8
  45  *  \return The decoded string.
  46  */
  47 QString decodeString(const QByteArray &input, QTextCodec *codec = 0);
  48
  49 uint editingDistance(const QString &s1, const QString &s2);
  50
  51 template<typename T>
  52 QVariantList toVariantList(const QList<T> &list)
  53 {
  54     QVariantList variants;
  55     for (int i = 0; i < list.count(); i++) {
  56         variants << QVariant::fromValue<T>(list[i]);
  57     }
  58     return variants;
  59 }
  60
  61
  62 template<typename T>
  63 QList<T> fromVariantList(const QVariantList &variants)
  64 {
  65     QList<T> list;
  66     for (int i = 0; i < variants.count(); i++) {
  67         list << variants[i].value<T>();
  68     }
  69     return list;
  70 }
  71
  72
  73 QByteArray prettyDigest(const QByteArray &digest);
  74
  75 /**
  76  * Format a string with %%<text>%% to current date/timestamp via QDateTime.
  77  *
  78  * @param[in] formatStr String with format codes
  79  * @return String with current date/time substituted in via formatting codes
  80  */
  81 QString formatCurrentDateTimeInString(const QString &formatStr);
  82
  83 /** Check if a scope rule matches a string
  84  *
  85  * Checks that the string does NOT match ANY inverted rules (prefixed by '!'), then checks that
  86  * it matches AT LEAST one normal (non-inverted) rule.
  87  *
  88  * If only inverted rules are specified, it'll match so long as the string does not match any
  89  * inverted rules (implicit wildcard).
  90  *
  91  * @param scopeRule  A ';'-separated list of wildcard expressions, prefix of '!' inverts subrule
  92  * @param string     String to test, e.g. network/channel name
  93  * @return True if matches, otherwise false
  94  */
  95 bool scopeMatch(const QString &scopeRule, const QString &string);