wxWidgets/include/wx/regex.h
Vadim Zeitlin e7208277c1 wxRegEx class added
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@11004 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2001-07-13 16:17:43 +00:00

128 lines
3.7 KiB
C++

///////////////////////////////////////////////////////////////////////////////
// Name: wx/regex.h
// Purpose: regular expression matching
// Author: Karsten Ballüder
// Modified by: VZ at 13.07.01 (integrated to wxWin)
// Created: 05.02.2000
// RCS-ID: $Id$
// Copyright: (c) 2000 Karsten Ballüder <ballueder@gmx.net>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_REGEX_H_
#define _WX_REGEX_H_
#ifdef __GNUG__
#pragma interface "regex.h"
#endif
#include "wx/defs.h"
#if wxUSE_REGEX
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
// max number of subexpression matches, the default should be big enough for
// all uses but may be a bit wasteful
#ifndef WX_REGEX_MAXMATCHES
#define WX_REGEX_MAXMATCHES 1024
#endif
// flags for regex compilation: these can be used with Compile()
enum
{
// use extended regex syntax: default
wxRE_EXTENDED = 0,
// use basic RE syntax
wxRE_BASIC = 2,
// ignore case in match
wxRE_ICASE = 4,
// only check match, don't set back references
wxRE_NOSUB = 8,
// if not set, treat '\n' as an ordinary character, otherwise it is
// special: it is not matched by '.' and '^' and '$' always match
// after/before it regardless of the setting of wxRE_NOT[BE]OL
wxRE_NEWLINE = 16,
// default flags
wxRE_DEFAULT = wxRE_NOSUB | wxRE_EXTENDED
};
// flags for regex matching: these can be used with Matches()
//
// these flags are mainly useful when doing several matches in a long string,
// they can be used to prevent erroneous matches for '^' and '$'
enum
{
// '^' doesn't match at the start of line
wxRE_NOTBOL = 32,
// '$' doesn't match at the end of line
wxRE_NOTEOL = 64
};
// ----------------------------------------------------------------------------
// wxRegEx: a regular expression
// ----------------------------------------------------------------------------
class WXDLLEXPORT wxRegExImpl;
class WXDLLEXPORT wxRegEx
{
public:
// default ctor: use Compile() later
wxRegEx() { Init(); }
// create and compile
wxRegEx(const wxString& expr, int flags = wxRE_DEFAULT)
{
Init();
(void)Compile(expr, flags);
}
// return TRUE if this is a valid compiled regular expression
bool IsValid() const { return m_impl != NULL; }
// compile the string into regular expression, return TRUE if ok or FALSE
// if string has a syntax error
bool Compile(const wxString& pattern, int flags = wxRE_DEFAULT);
// matches the precompiled regular expression against a string, return
// TRUE if matches and FALSE otherwise
//
// flags may be combination of wxRE_NOTBOL and wxRE_NOTEOL
bool Matches(const wxString& str, int flags = 0) const;
// get the start index and the length of the match of the expression
// (index 0) or a bracketed subexpression (index != 0)
//
// return FALSE if no match or on error
bool GetMatch(size_t *start, size_t *len, size_t index = 0) const;
// replaces the current regular expression in the string pointed to by
// pattern, with the text in replacement and return number of matches
// replaced (maybe 0 if none found) or -1 on error
int Replace(wxString *str, const wxString& replacement) const;
// dtor not virtual, don't derive from this class
~wxRegEx();
private:
// common part of all ctors
void Init();
// the real guts of this class
wxRegExImpl *m_impl;
};
#endif // wxUSE_REGEX
#endif // _WX_REGEX_H_