strings.hpp

//------------------------------------------------------------------------------
// strings.hpp
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2010 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef __STRINGS_HPP_
#define __STRINGS_HPP_
// Why hpp in this case? Glibc 2.26 changed string.h to include its strings.h
// so this file would shadow that header and cause errors.

#include "global.h"

#include <QtContainerFwd>

class QString;

// Keep compatibility with older Qt releases while using identifiers Qt 6 requires
#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
#include <QString>
namespace Qt
{
        constexpr auto KeepEmptyParts = QString::KeepEmptyParts;
        constexpr auto SkipEmptyParts = QString::SkipEmptyParts;
}
#endif

// \c = '\034'
#define ESCAPE_COLOR_CHAR       '\034'

class MAIN_EXPORT Strings
{
        public:
                static QString colorizeString(const QString &str, int def=4);

                static QStringList combineManyPaths(const QStringList &fronts, const QString &pathEnd);

                static QString combinePaths(QString pathFront, QString pathEnd);

                static QString createRandomAlphaNumericString(unsigned numChars);
                static QString createRandomAlphaNumericStringWithNewLines(unsigned numCharsPerLine, unsigned numLines);

                static const QString &escape(QString &str);

                static QString formatDataAmount(qint64 bytes);

                static QString formatDataSpeed(float speedInBytesPerSecond);

                static QString formatTime(float seconds);

                static bool isCharOnCharList(char c, const QString& charList);

                static QString normalizePath(QString path);

                static QByteArray readUntilByte(QDataStream& stream, unsigned char stopByte);

                static void translateServerAddress(const QString& addressString, QString& hostname, unsigned short& port, const QString& defaultAddress);

                static const QString &unescape(QString &str);

                static bool isUrlSafe(const QString& url);

                static QString timestamp(const QString& format);
                static QString& trim(QString& str, const QString& charList) { return trimr(triml(str, charList), charList); }
                static QString& trimr(QString& str, const QString& charList);
                static QString& triml(QString& str, const QString& charList);

                static QString wrapUrlsWithHtmlATags(const QString& str);

        protected:
                enum DataUnit
                {
                        Byte = 0,
                        Kilobyte = 1,
                        Megabyte = 2,
                        Gigabyte = 3
                };

                static const unsigned RANDOM_CHAR_POOL_SIZE = 36;
                static const char RANDOM_CHAR_POOL[RANDOM_CHAR_POOL_SIZE];


                static float scaleDataUnit(float bytes, DataUnit& outUnit);
};

#endif