File indexing completed on 2024-05-12 05:10:17

0001 /***************************************************************************
0002     Copyright (C) 2003-2009 Robby Stephenson <robby@periapsis.org>
0003  ***************************************************************************/
0004 
0005 /***************************************************************************
0006  *                                                                         *
0007  *   This program is free software; you can redistribute it and/or         *
0008  *   modify it under the terms of the GNU General Public License as        *
0009  *   published by the Free Software Foundation; either version 2 of        *
0010  *   the License or (at your option) version 3 or any later version        *
0011  *   accepted by the membership of KDE e.V. (or its successor approved     *
0012  *   by the membership of KDE e.V.), which shall act as a proxy            *
0013  *   defined in Section 14 of version 3 of the license.                    *
0014  *                                                                         *
0015  *   This program is distributed in the hope that it will be useful,       *
0016  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0017  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0018  *   GNU General Public License for more details.                          *
0019  *                                                                         *
0020  *   You should have received a copy of the GNU General Public License     *
0021  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
0022  *                                                                         *
0023  ***************************************************************************/
0024 
0025 #ifndef STRING_UTILS_H
0026 #define STRING_UTILS_H
0027 
0028 class QByteArray;
0029 class QString;
0030 
0031 /**
0032  * This file contains utility functions for manipulating strings.
0033  *
0034  * @author Robby Stephenson
0035  */
0036 namespace Tellico {
0037   /**
0038    * Decode HTML entities. Only numeric entities are handled currently.
0039    */
0040   QString decodeHTML(const QByteArray& data);
0041   QString decodeHTML(const QString& text);
0042 
0043   /**
0044    * Return a random, and almost certainly unique UID.
0045    *
0046    * @param length The UID starts with "Tellico" and adds enough letters to be @p length long.
0047    */
0048   QString uid(int length=20, bool prefix=true);
0049   unsigned int toUInt(const QString& string, bool* ok);
0050   /**
0051    * Replace all occurrences  of <i18n>text</i18n> with i18n("text")
0052    */
0053   QString i18nReplace(QString text);
0054   QString removeAccents(const QString& value);
0055 
0056   int stringHash(const QString& str);
0057   /** take advantage string collisions to reduce memory
0058   */
0059   QString shareString(const QString& str);
0060 
0061   QString minutes(int seconds);
0062   QString fromHtmlData(const QByteArray& data, const char* codecName = nullptr);
0063 
0064   QByteArray obfuscate(const QString& string);
0065   QString reverseObfuscate(const QByteArray& bytes);
0066 
0067   QString removeControlCodes(const QString& string);
0068 }
0069 
0070 #endif