common: Make frequently called util methods more efficient

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

diff --git a/src/common/util.h b/src/common/util.h
index 1a6d889..61530a0 100644 (file)
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -1,11 +1,11 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 by The Quassel Team                             *
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program 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 2 of the License, or     *
- *   (at your option) any later version.                                   *
+ *   (at your option) version 3.                                           *
  *                                                                         *
  *   This program is distributed in the hope that it will be useful,       *
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
@@ -15,37 +15,67 @@
  *   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 <QList>
 #include <QString>
+#include <QVariant>
 
-QString nickFromMask(QString mask);
-QString userFromMask(QString mask);
-QString hostFromMask(QString mask);
+QString nickFromMask(const QString &mask);
+QString userFromMask(const QString &mask);
+QString hostFromMask(const QString &mask);
+bool isChannelName(const QString &str);
 
-bool isChannelName(QString str);
+//! Strip mIRC format codes
+QString stripFormatCodes(QString);
 
-/**
- *  Writes a QVariant to a device. The data item is prefixed with the resulting blocksize,
- *  so the corresponding function readDataFromDevice() can check if enough data is available
- *  at the device to reread the item.
- */
-void writeDataToDevice(QIODevice *, const QVariant &);
+//! Remove accelerator markers (&) from the string
+QString stripAcceleratorMarkers(const QString &);
+
+QString secondsToString(int timeInSeconds);
 
-/** Reads a data item from a device that has previously been written by writeDataToDevice().
- *  If not enough data bytes are available, the function returns false and the QVariant reference
- *  remains untouched.
+//! 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
+ *  decoded appropriately. Otherwise, the specified text codec is used to transform the string.
+ *  \param input The input string containing encoded data
+ *  \param codec The text codec we use if the input is not utf8
+ *  \return The decoded string.
  */
-bool readDataFromDevice(QIODevice *, quint32 &, QVariant &);
+QString decodeString(const QByteArray &input, QTextCodec *codec = 0);
 
+uint editingDistance(const QString &s1, const QString &s2);
 
+template<typename T>
+QVariantList toVariantList(const QList<T> &list)
+{
+    QVariantList variants;
+    for (int i = 0; i < list.count(); i++) {
+        variants << QVariant::fromValue<T>(list[i]);
+    }
+    return variants;
+}
 
 
+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;
+}
 
-#endif
+
+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
+ */
+QString formatCurrentDateTimeInString(const QString &formatStr);