Add a method to find data files in standard directories (such as $PREFIX/share)

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

diff --git a/src/common/util.h b/src/common/util.h
index 342356f..28639ba 100644 (file)
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005/06 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005/06 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -18,45 +18,73 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _UTIL_H_
-#define _UTIL_H_
+#ifndef UTIL_H
+#define UTIL_H
 
-#include <QIODevice>
+#include <QDir>
+#include <QLocale>
 #include <QVariant>
 #include <QString>
 #include <QMetaMethod>
 
+
+// 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);
+
+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
  *  decoded appropriately. Otherwise, the specified text codec is used to transform the string.
  *  \param input The input string containing encoded data
- *  \param encoding The text encoding we assume if it's not utf8
+ *  \param codec The text codec we use if the input is not utf8
  *  \return The decoded string.
  */
-QString decodeString(QByteArray input, QString encoding = "ISO-8859-15");
+QString decodeString(const QByteArray &input, QTextCodec *codec = 0);
 
-bool isChannelName(QString str);
+uint editingDistance(const QString &s1, const QString &s2);
 
-/**
- *  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.
+QDir quasselDir();
+
+//! 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
  */
-void writeDataToDevice(QIODevice *, const QVariant &);
+QStringList dataDirPaths();
 
-/** 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.
+//! 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
  */
-bool readDataFromDevice(QIODevice *, quint32 &, QVariant &);
+QString findDataFilePath(const QString &fileName);
 
+void loadTranslation(const QLocale &locale);
 
-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;
+}
 
-QByteArray methodName(const QMetaMethod &method);
+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