common: Make frequently called util methods more efficient
[quassel.git] / src / common / util.h
index 0b372b6..61530a0 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 by the Quassel Project                          *
+ *   Copyright (C) 2005-2016 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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 <QDir>
-#include <QIODevice>
-#include <QVariant>
+#include <QList>
 #include <QString>
-#include <QMetaMethod>
+#include <QVariant>
 
+QString nickFromMask(const QString &mask);
+QString userFromMask(const QString &mask);
+QString hostFromMask(const QString &mask);
+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
+QString stripFormatCodes(QString);
 
+//! Remove accelerator markers (&) from the string
+QString stripAcceleratorMarkers(const QString &);
+
+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,14 +46,36 @@ bool isChannelName(QString str);
  */
 QString decodeString(const QByteArray &input, QTextCodec *codec = 0);
 
-// NOTE: We have static copies of these in SignalProxy...
-//void writeDataToDevice(QIODevice *, const QVariant &);
-//bool readDataFromDevice(QIODevice *, quint32 &, QVariant &);
-
 uint editingDistance(const QString &s1, const QString &s2);
 
-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<T>(list[i]);
+    }
+    return variants;
+}
 
-QDir quasselDir();
 
-#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;
+}
+
+
+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);