ttkregularexpression.h

Go to the documentation of this file.

#ifndef TTKREGULAREXPRESSION_H
#define TTKREGULAREXPRESSION_H

/***************************************************************************
 * This file is part of the TTK Library Module project
 * Copyright (C) 2015 - 2026 Greedysky Studio

 * This program 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 3 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 Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public License along
 * with this program; If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

#include "ttkmoduleexport.h"
#if TTK_QT_VERSION_CHECK(5,0,0)
#  include <QRegularExpression>
#else
#  include <QRegExp>
#endif

class TTK_MODULE_EXPORT TTKRegularExpression
{
public:
    enum PatternOption
    {
        NoPatternOption          = 0x0000,
        CaseInsensitiveOption    = 0x0001,
        InvertedGreedinessOption = 0x0010,
    };

    TTKRegularExpression();
    explicit TTKRegularExpression(const QString &pattern, int option = NoPatternOption);

    QString pattern() const;
    void setPattern(const QString &v);

    int patternOptions() const;
    void setPatternOptions(const int option);

public:
    bool hasMatch(const QString &str);

    int match(const QString &str, int pos = 0);

    QString captured(int index) const;

    int capturedLength() const;

public:
    bool isGreediness() const;

    void setGreediness(bool v);

    bool isCaseSensitivity() const;

    void setCaseSensitivity(bool v);

public:
    static QString escape(const QString &str);

#if TTK_QT_VERSION_CHECK(5,0,0)
    const QRegularExpression &value() const;
    operator QRegularExpression &();
    operator const QRegularExpression &() const;
private:
    QRegularExpression m_regular;
    QRegularExpressionMatch m_match;
#else
    const QRegExp &value() const;
    operator QRegExp &();
    operator const QRegExp &() const;
private:
    QRegExp m_regular;
#endif

};

#endif // TTKREGULAREXPRESSION_H