KviQString.h

Go to the documentation of this file.

#ifndef _KVI_QSTRING_H_
#define _KVI_QSTRING_H_
//=============================================================================
//
//   File : KviQString.h
//   Creation date : Mon Aug 04 2003 13:36:33 CEST by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2003-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program 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 General Public License for more details.
//
//   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include "kvi_settings.h"
#include "kvi_inttypes.h"
#include "kvi_stdarg.h"

#include <QString>
#include <QByteArray>

namespace KviQString
{
        enum EscapeKVSFlags
        {
                EscapeSpace = 1,       
                PermitVariables = 2,   
                PermitFunctions = 4,   
                PermitMultiLine = 8,   
                EscapeParenthesis = 16 
        };

        extern KVILIB_API const QString Empty;

        extern KVILIB_API QString makeSizeReadable(quint64 size);

        extern KVILIB_API bool equalCS(const QString & sz1, const QString & sz2);

        extern KVILIB_API bool equalCS(const QString & sz1, const char * pc2);

        extern KVILIB_API bool equalCI(const QString & sz1, const QString & sz2);

        extern KVILIB_API bool equalCI(const QString & sz1, const char * pc2);

        extern KVILIB_API bool equalCI(const QString & sz1, const QChar * pC2);

        extern KVILIB_API bool equalCSN(const QString & sz1, const QString & sz2, unsigned int uLen);

        extern KVILIB_API bool equalCSN(const QString & sz1, const char * pc2, unsigned int uLen);

        extern KVILIB_API bool equalCIN(const QString & sz1, const QString & sz2, unsigned int uLen);

        extern KVILIB_API bool equalCIN(const QString & sz1, const char * pc2, unsigned int uLen);

        extern KVILIB_API bool equalCIN(const QString & sz1, const QChar * pC2, unsigned int uLen);

        extern KVILIB_API int cmpCI(const QString & sz1, const QString & sz2, bool bNonAlphaGreater = false);
        // sz1.compare(sz2,Qt::CaseInsensitive)

        extern KVILIB_API int cmpCIN(const QString & sz1, const QString & sz2, unsigned int uLen);

        extern KVILIB_API void ensureLastCharIs(QString & szSrc, const QChar & c);

        extern KVILIB_API bool matchWildExpressions(const QString & szM1, const QString & szM2);

        extern KVILIB_API bool matchString(const QString & szExp, const QString & szStr, bool bIsRegExp = false, bool bExact = false, bool bCs = false);

        extern KVILIB_API void vsprintf(QString & szSrc, const QString & szFmt, kvi_va_list list);

        extern KVILIB_API void stripRightWhiteSpace(QString & szSrc);

        extern KVILIB_API void stripLeft(QString & szSrc, const QChar & c);

        extern KVILIB_API void stripRight(QString & szSrc, const QChar & c);

        extern KVILIB_API void appendFormatted(QString & szSrc, QString szFmt, ...);

        extern KVILIB_API void appendNumber(QString & szSrc, double dReal);

        extern KVILIB_API void appendNumber(QString & szSrc, kvi_i64_t iInteger);

        extern KVILIB_API void appendNumber(QString & szSrc, int iInteger);

        extern KVILIB_API void appendNumber(QString & szSrc, unsigned int uInteger);

        extern KVILIB_API void appendNumber(QString & szSrc, kvi_u64_t uInteger);

        extern KVILIB_API void cutFromFirst(QString & szSrc, const QChar & c, bool bIncluded = true);

        extern KVILIB_API void cutFromFirst(QString & szSrc, const QString & szFind, bool bIncluded = true);

        extern KVILIB_API void cutFromLast(QString & szSrc, const QChar & c, bool bIncluded = true);

        extern KVILIB_API void cutFromLast(QString & szSrc, const QString & szFind, bool bIncluded = true);

        extern KVILIB_API void cutToFirst(QString & szSrc, const QChar & c, bool bIncluded = true, bool bClearIfNotFound = false);

        extern KVILIB_API void cutToFirst(QString & szSrc, const QString & szFind, bool bIncluded = true, bool bClearIfNotFound = false);

        extern KVILIB_API void cutToLast(QString & szSrc, const QChar & c, bool bIncluded = true, bool bClearIfNotFound = false);

        extern KVILIB_API void cutToLast(QString & szSrc, const QString & szFind, bool bIncluded = true, bool bClearIfNotFound = false);

        extern KVILIB_API QString leftToFirst(QString & szSrc, const QChar & c, bool bIncluded = true, bool bReturnFullStringIfNotFound = true);

        extern KVILIB_API QString leftToFirst(QString & szSrc, const QString & szFind, bool bIncluded = true, bool bReturnFullStringIfNotFound = true);

        extern KVILIB_API QString leftToLast(QString & szSrc, const QChar & c, bool bIncluded = true, bool bReturnFullStringIfNotFound = true);

        extern KVILIB_API QString leftToLast(QString & szSrc, const QString & szFind, bool bIncluded = true, bool bReturnFullStringIfNotFound = true);

        extern KVILIB_API QString upperISO88591(const QString & szSrc);

        extern KVILIB_API QString lowerISO88591(const QString & szSrc);

        extern KVILIB_API QString getToken(QString & szSrc, const QChar & sep);

        extern KVILIB_API void transliterate(QString & szSrc, const QString & szToFind, const QString & szReplacement);

        extern KVILIB_API void bufferToHex(QString & szRetBuffer, const unsigned char * pcBuffer, unsigned int uLen);

        extern KVILIB_API void escapeKvs(QString * szData, uint uFlags = 0);

        extern KVILIB_API QString toHtmlEscaped(QString szData);

        inline kvi_i64_t toI64(QString & szNumber, bool * bOk)
        {
#if SYSTEM_SIZE_OF_LONG_INT == 8
                return szNumber.toLong(bOk);
#else
                return szNumber.toLongLong(bOk);
#endif
        }

        inline kvi_u64_t toU64(QString & szNumber, bool * bOk)
        {
#if SYSTEM_SIZE_OF_LONG_INT == 8
                return szNumber.toULong(bOk);
#else
                return szNumber.toULongLong(bOk);
#endif
        }
}

#endif //_KVI_QSTRING_H_