qgsstringutils.h

Go to the documentation of this file.

/***************************************************************************
    qgsstringutils.h
    ----------------
    begin                : June 2015
    copyright            : (C) 2015 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#include "qgis_core.h"
#include <QString>
#include <QRegExp>
#include <QList>
#include <QDomDocument>
#include <QFont> // for enum values
#include "qgis.h"

#ifndef QGSSTRINGUTILS_H
#define QGSSTRINGUTILS_H


class CORE_EXPORT QgsStringReplacement
{

  public:

    QgsStringReplacement( const QString &match,
                          const QString &replacement,
                          bool caseSensitive = false,
                          bool wholeWordOnly = false );

    QString match() const { return mMatch; }

    QString replacement() const { return mReplacement; }

    bool caseSensitive() const { return mCaseSensitive; }

    bool wholeWordOnly() const { return mWholeWordOnly; }

    QString process( const QString &input ) const;

    bool operator==( const QgsStringReplacement &other )
    {
      return mMatch == other.mMatch
             && mReplacement == other.mReplacement
             && mCaseSensitive == other.mCaseSensitive
             && mWholeWordOnly == other.mWholeWordOnly;
    }

    QgsStringMap properties() const;

    static QgsStringReplacement fromProperties( const QgsStringMap &properties );

  private:

    QString mMatch;

    QString mReplacement;

    bool mCaseSensitive;

    bool mWholeWordOnly;

    QRegExp mRx;
};


class CORE_EXPORT QgsStringReplacementCollection
{

  public:

    QgsStringReplacementCollection( const QList< QgsStringReplacement > &replacements = QList< QgsStringReplacement >() )
      : mReplacements( replacements )
    {}

    QList< QgsStringReplacement > replacements() const { return mReplacements; }

    void setReplacements( const QList< QgsStringReplacement > &replacements )
    {
      mReplacements = replacements;
    }

    QString process( const QString &input ) const;

    void writeXml( QDomElement &elem, QDomDocument &doc ) const;

    void readXml( const QDomElement &elem );

  private:

    QList< QgsStringReplacement > mReplacements;


};

class CORE_EXPORT QgsStringUtils
{
  public:

    enum Capitalization
    {
      MixedCase = QFont::MixedCase, 
      AllUppercase = QFont::AllUppercase, 
      AllLowercase = QFont::AllLowercase,  
      ForceFirstLetterToCapital = QFont::Capitalize, 
      TitleCase = QFont::Capitalize + 1000, 
      UpperCamelCase = QFont::Capitalize + 1001, 
    };

    static QString capitalize( const QString &string, Capitalization capitalization );

    static QString ampersandEncode( const QString &string );

    static int levenshteinDistance( const QString &string1, const QString &string2, bool caseSensitive = false );

    static QString longestCommonSubstring( const QString &string1, const QString &string2, bool caseSensitive = false );

    static int hammingDistance( const QString &string1, const QString &string2, bool caseSensitive = false );

    static QString soundex( const QString &string );

    static QString insertLinks( const QString &string, bool *foundLinks = nullptr );

    static QString wordWrap( const QString &string, int length, bool useMaxLineLength = true, const QString &customDelimiter = QString() );

    static QString substituteVerticalCharacters( QString string );

    static QString htmlToMarkdown( const QString &html );

};

#endif //QGSSTRINGUTILS_H