Copyright	(c) Chris Kuklewicz 2006 derived from (c) The University of Glasgow 2001
License	BSD-style (see the file LICENSE)
Maintainer	hvr@gnu.org
Stability	experimental
Portability	non-portable (regex-base needs MPTC+FD)
Safe Haskell	Trustworthy
Language	Haskell2010

Text.Regex

Contents

Regular expressions

Description

Regular expression matching. Uses the POSIX regular expression interface in Text.Regex.Posix.

Synopsis

data Regex
mkRegex :: String -> Regex
mkRegexWithOpts :: String -> Bool -> Bool -> Regex
matchRegex :: Regex -> String -> Maybe [String]
matchRegexAll :: Regex -> String -> Maybe (String, String, String, [String])
subRegex :: Regex -> String -> String -> String
splitRegex :: Regex -> String -> [String]

Regular expressions

data Regex #

A compiled regular expression.

Instances

Instances details

RegexOptions Regex CompOption ExecOption

Instance details

Defined in Text.Regex.Posix.Wrap

Methods

blankCompOpt :: CompOption #

blankExecOpt :: ExecOption #

defaultCompOpt :: CompOption #

defaultExecOpt :: ExecOption #

setExecOpts :: ExecOption -> Regex -> Regex #

getExecOpts :: Regex -> ExecOption #

mkRegex :: String -> Regex Source #

Makes a regular expression with the default options (multi-line, case-sensitive). The syntax of regular expressions is otherwise that of egrep (i.e. POSIX "extended" regular expressions).

mkRegexWithOpts Source #

Arguments

:: String

The regular expression to compile.

-> Bool

True iff '^' and '$' match the beginning and end of individual lines respectively, and '.' does not match the newline character.

-> Bool

True iff matching is case-sensitive.

-> Regex

Returns: the compiled regular expression.

Makes a regular expression, where the multi-line and case-sensitive options can be changed from the default settings.

matchRegex Source #

Arguments

:: Regex

The regular expression.

-> String

The string to match against.

-> Maybe [String]

Returns: Just strs if the match succeeded (and strs is the list of subexpression matches), or Nothing otherwise.

Match a regular expression against a string.

matchRegexAll Source #

Arguments

:: Regex

The regular expression.

-> String

The string to match against.

-> Maybe (String, String, String, [String])

Returns: Nothing if the match failed, or:

 Just ( everything before match,
 portion matched,
 everything after the match,
 subexpression matches )

Match a regular expression against a string, returning more information about the match.

subRegex Source #

Arguments

:: Regex

Search pattern

-> String

Input string

-> String

Replacement text

-> String

Output string

Replaces every occurrence of the given regexp with the replacement string.

In the replacement string, "1円" refers to the first substring; "2円" to the second, etc; and "0円" to the entire match. "\\\\" will insert a literal backslash.

This does not advance if the regex matches an empty string. This misfeature is here to match the behavior of the original Text.Regex API.

splitRegex :: Regex -> String -> [String] Source #

Splits a string based on a regular expression. The regular expression should identify one delimiter.

This does not advance and produces an infinite list of [] if the regex matches an empty string. This misfeature is here to match the behavior of the original Text.Regex API.