src/common/util.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 by The Quassel Team                             *
   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) any later version.                                   *
   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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _UTIL_H_
  22 #define _UTIL_H_
  23
  24 #include <QIODevice>
  25 #include <QVariant>
  26 #include <QString>
  27
  28 QString nickFromMask(QString mask);
  29 QString userFromMask(QString mask);
  30 QString hostFromMask(QString mask);
  31
  32 //! Take a string and decode it using the specified text codec, recognizing utf8.
  33 /** This function takes a string and first checks if it is encoded in utf8, in which case it is
  34  *  decoded appropriately. Otherwise, the specified text codec is used to transform the string.
  35  *  \param input The input string containing encoded data
  36  *  \param encoding The text encoding we assume if it's not utf8
  37  *  \return The decoded string.
  38  */
  39 QString decodeString(QByteArray input, QString encoding = "ISO-8859-15");
  40
  41 bool isChannelName(QString str);
  42
  43 /**
  44  *  Writes a QVariant to a device. The data item is prefixed with the resulting blocksize,
  45  *  so the corresponding function readDataFromDevice() can check if enough data is available
  46  *  at the device to reread the item.
  47  */
  48 void writeDataToDevice(QIODevice *, const QVariant &);
  49
  50 /** Reads a data item from a device that has previously been written by writeDataToDevice().
  51  *  If not enough data bytes are available, the function returns false and the QVariant reference
  52  *  remains untouched.
  53  */
  54 bool readDataFromDevice(QIODevice *, quint32 &, QVariant &);
  55
  56
  57 uint editingDistance(const QString &s1, const QString &s2);
  58
  59
  60 #endif