You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdepim/libkdepim/kregexp3.h

112 lines
4.1 KiB

/* -*- c++ -*-
kregexp3.h
This file is part of libkdenetwork.
Copyright (c) 2001 Marc Mutz <mutz@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License,
version 2, as published by the Free Software Foundation.
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
General Public License for more details.
You should have received a copy of the GNU 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
In addition, as a special exception, the copyright holders give
permission to link the code of this library with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#include <qglobal.h>
#include <qregexp.h>
#include <qstring.h>
#include <kdepimmacros.h>
/** @short A QRegExp (Qt3.x) with a replace() method.
This class is simply there to provide a namespace for some nice
enhancements of the mighty QRegExp (Qt3 version) regular
expression engine, namely the method replace(), which can be
used to do search-and-replace like one is used to from perl or sed.
It "simply" adds the ability to define a replacement string which
contains references to the captured substrings. The following
constructs are understood, which can be freely mixed in the
replacement string:
@section Sed syntax
Back references in the replacement string are made using \n
(backslash-digit), where @p n is a single digit. With this mode of
operation, only the first nine captured substrings can be
referenced.
NOTE: Remember that C++ interprets the backslash in string
constants, so you have to write a backslash as "\\".
@section Perl syntax
Back references in the replacement string are made using $n
(dollarsign-digit), where @p n is a single digit. With this mode
of operation, only the first nine captured substrings can be
referenced.
Additionally, Perl supports the syntax ${nn}
(dollarSign-leftCurlyBrace-digits-rightCurlyBrace), where @p nn
can be a multi-digit number.
In all modes, counting of captured substrings starts with 1 (one)!
To reference the entire matched string, use $0, ${0} or \\0.
@author Marc Mutz <mutz@kde.org>
@see QRegExp
*/
class KDE_EXPORT KRegExp3 : public QRegExp
{
public:
KRegExp3()
: QRegExp() {}
KRegExp3( const QString & pattern,
bool caseSensitive = TRUE,
bool wildcard = FALSE )
: QRegExp( pattern, caseSensitive, wildcard ) {}
KRegExp3( const QRegExp & rx )
: QRegExp( rx ) {}
KRegExp3( const KRegExp3 & rx )
: QRegExp( (QRegExp)rx ) {}
/** Replaces each matching subpattern in @p str with
@p replacementStr, inserting captured substrings for
\\n, $n and ${nn} as described in the class documentation.
@param str The source string.
@param replacementStr The string which replaces matched
substrings of @p str.
@param start Start position for the search.
If @p start is negative, starts @p -(start) positions
from the end of @p str.
@param global If @p TRUE, requests to replace all occurrences
of the regexp with @p replacementStr; if @p FALSE,
only the first occurrence will be replaced.
Equivalent to the /g switch to perl's s/// operator.
@return The modified string.
*/
QString replace( const QString & str,
const QString & replacementStr,
int start=0, bool global=TRUE );
};