qregexp.h

/****************************************************************************
** 
**
** Definition of QRegExp class
**
** Created : 950126
**
** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
**
** This file is part of the tools module of the Qt GUI Toolkit.
**
** This file may be distributed under the terms of the Q Public License
** as defined by Trolltech AS of Norway and appearing in the file
** LICENSE.QPL included in the packaging of this file.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** licenses may use this file in accordance with the Qt Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about Qt Commercial License Agreements.
** See http://www.trolltech.com/qpl/ for QPL licensing information.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#ifndef QREGEXP_H
#define QREGEXP_H

#ifndef QT_H
#include "qcstring.h"
#endif // QT_H


class Q_EXPORT QRegExp
{
public:
    QRegExp();
    QRegExp( const QCString &, bool caseSensitive=TRUE, bool wildcard=FALSE );
    QRegExp( const QRegExp & );
   ~QRegExp();
    QRegExp    &operator=( const QRegExp & );
    QRegExp    &operator=( const QCString &pattern );

    bool    operator==( const QRegExp & )  const;
    bool    operator!=( const QRegExp &r ) const
                    { return !(this->operator==(r)); }

    bool    isEmpty()   const   { return rxdata == 0; }
    bool    isValid()   const   { return error == 0; }

    bool    caseSensitive() const   { return cs; }
    void    setCaseSensitive( bool );

    bool    wildcard()  const   { return wc; }
    void    setWildcard( bool );

    QCString    pattern()   const   { return rxstring; }
    // ### in Qt 3.0, provide a real implementation
    void    setPattern( const QCString& pattern )
                    { operator=( pattern ); }

    int     match( const QCString &str, int index=0, int *len=0,
               bool indexIsStart = TRUE ) const;
    int     find( const QCString& str, int index )
                    { return match( str, index ); }

protected:
    void    compile();
    const char *matchstr( uint *, const char *, uint, const char * ) const;

private:
    QCString    rxstring;           // regular expression pattern
    uint    *rxdata;            // compiled regexp pattern
    int     error;              // error status
    bool    cs;             // case sensitive
    bool    wc;             // wildcard
};


#endif // QREGEXP_H