Text.RE.TDFA.Sequence

Tutorial

We have a regex tutorial at http://tutorial.regex.uk.

The Matches and Match Operators

(*=~) :: Seq Char -> RE -> Matches (Seq Char)

find all the matches in the argument text; e.g., to count the number of naturals in s:

countMatches $ s *=~ [re|[0-9]+|]

(?=~) :: Seq Char -> RE -> Match (Seq Char)

find the first match in the argument text; e.g., to test if there is a natural number in the input text:

matched $ s ?=~ [re|[0-9]+|]

The SearchReplace Operators

(*=~/) :: Seq Char -> SearchReplace RE (Seq Char) -> Seq Char

search and replace all matches in the argument text; e.g., this section will convert every YYYY-MM-DD format date in its argument text into a DD/MM/YYYY date:

(*=~/ [ed|${y}([0-9]{4})-0*${m}([0-9]{2})-0*${d}([0-9]{2})///${d}/${m}/${y}|])

(?=~/) :: Seq Char -> SearchReplace RE (Seq Char) -> Seq Char

search and replace the first occurrence only (if any) in the input text e.g., to prefix the first string of four hex digits in the imput text, if any, with 0x:

@(?=~/ [ed|[0-9A-Fa-f]{4}///0x$0|])

Matches

data Matches a

the result type to use when every match is needed, not just the first match of the RE against the source

Instances

Functor Matches

Methods

fmap :: (a -> b) -> Matches a -> Matches b

(<$) :: a -> Matches b -> Matches a

(RegexContext regex source [MatchText source], RegexLike regex source) => RegexContext regex source (Matches source)

this instance hooks Matches into regex-base: regex consumers need not worry about any of this

Methods

match :: regex -> source -> Matches source

matchM :: Monad m => regex -> source -> m (Matches source)

Eq a => Eq (Matches a)

Methods

(==) :: Matches a -> Matches a -> Bool

(/=) :: Matches a -> Matches a -> Bool

Show a => Show (Matches a)

Methods

showsPrec :: Int -> Matches a -> ShowS

show :: Matches a -> String

showList :: [Matches a] -> ShowS

matchesSource :: Matches a -> a

the source text being matched

allMatches :: Matches a -> [Match a]

all Match instances found, left to right

anyMatches :: Matches a -> Bool

tests whether the RE matched the source text at all

countMatches :: Matches a -> Int

count the matches

matches :: Matches a -> [a]

list the Matches

Match

data Match a

the result of matching a RE to a text once, listing the text that was matched and the named captures in the RE and all of the substrings matched, with the text captured by the whole RE; a complete failure to match will be represented with an empty array (with bounds (0,-1))

Instances

Functor Match

Methods

fmap :: (a -> b) -> Match a -> Match b

(<$) :: a -> Match b -> Match a

(RegexContext regex source (AllTextSubmatches (Array Int) (source, (Int, Int))), RegexLike regex source) => RegexContext regex source (Match source)

this instance hooks Match into regex-base: regex consumers need not worry about any of this

Methods

match :: regex -> source -> Match source

matchM :: Monad m => regex -> source -> m (Match source)

Eq a => Eq (Match a)

Methods

(==) :: Match a -> Match a -> Bool

(/=) :: Match a -> Match a -> Bool

Show a => Show (Match a)

Methods

showsPrec :: Int -> Match a -> ShowS

show :: Match a -> String

showList :: [Match a] -> ShowS

matchSource :: Match a -> a

the whole source text

matched :: Match a -> Bool

tests whether the RE matched the source text at all

matchedText :: Match a -> Maybe a

tests whether the RE matched the source text at all

The RE Type

data RE

the RE type for this back end representing a well-formed, compiled RE

Instances

IsOption REOptions RE CompOption ExecOption

Methods

makeREOptions :: REOptions -> REOptions_ RE CompOption ExecOption

IsOption (Macros RE) RE CompOption ExecOption

Methods

makeREOptions :: Macros RE -> REOptions_ RE CompOption ExecOption

reSource :: RE -> String

extract the RE source string from the RE

Options

You can specify different compilation options by appending a to the name of an [re| ... |] or [ed| ... /// ... |] quasi quoter to select the corresponding compilation option. For example, the section,

(?=~/ [edBlockInsensitive|foo$///bar|])

will replace a foo suffix of the argument text, of any capitalisation, with a (lower case) bar. If you need to specify the options dynamically, use the [re_| ... |] and [red_| ... /// ... |] quasi quoters, which generate functions that take an IsOption option (e.g., a SimpleReOptions value) and yields a RE or SearchReplace as apropriate. For example if you have a SimpleReOptions value in sro then

(?=~/ [ed_|foo$///bar|] sro)

will compile the foo$ RE according to the value of sro. For more on specifying RE options see Text.RE.REOptions.

data SimpleREOptions

the default API uses these simple, universal RE options, which get auto-converted into the apropriate back-end REOptions_

Constructors

MultilineSensitive

case-sensitive with ^ and $ matching the start and end of a line

MultilineInsensitive

case-insensitive with ^ and $ matsh the start and end of a line

BlockSensitive

case-sensitive with ^ and $ matching the start and end of the input text

BlockInsensitive

case-insensitive with ^ and $ matching the start and end of the input text

Instances

Bounded SimpleREOptions

Methods

minBound :: SimpleREOptions

maxBound :: SimpleREOptions

Enum SimpleREOptions

Methods

succ :: SimpleREOptions -> SimpleREOptions

pred :: SimpleREOptions -> SimpleREOptions

toEnum :: Int -> SimpleREOptions

fromEnum :: SimpleREOptions -> Int

enumFrom :: SimpleREOptions -> [SimpleREOptions]

enumFromThen :: SimpleREOptions -> SimpleREOptions -> [SimpleREOptions]

enumFromTo :: SimpleREOptions -> SimpleREOptions -> [SimpleREOptions]

enumFromThenTo :: SimpleREOptions -> SimpleREOptions -> SimpleREOptions -> [SimpleREOptions]

Eq SimpleREOptions

Methods

(==) :: SimpleREOptions -> SimpleREOptions -> Bool

(/=) :: SimpleREOptions -> SimpleREOptions -> Bool

Ord SimpleREOptions

Methods

compare :: SimpleREOptions -> SimpleREOptions -> Ordering

(<) :: SimpleREOptions -> SimpleREOptions -> Bool

(<=) :: SimpleREOptions -> SimpleREOptions -> Bool

(>) :: SimpleREOptions -> SimpleREOptions -> Bool

(>=) :: SimpleREOptions -> SimpleREOptions -> Bool

max :: SimpleREOptions -> SimpleREOptions -> SimpleREOptions

min :: SimpleREOptions -> SimpleREOptions -> SimpleREOptions

Show SimpleREOptions

Methods

showsPrec :: Int -> SimpleREOptions -> ShowS

show :: SimpleREOptions -> String

showList :: [SimpleREOptions] -> ShowS

Lift SimpleREOptions

we need to use this in the quasi quoters to specify SimpleREOptions selected by the quasi quoter

Methods

lift :: SimpleREOptions -> Q Exp

Compiling and Escaping REs

compileRegex :: (Functor m, Monad m) => String -> m RE

compile a String into a RE with the default options, generating an error if the RE is not well formed

compileRegexWith :: (Functor m, Monad m) => SimpleREOptions -> String -> m RE

compile a String into a RE using the given SimpleREOptions, generating an error if the RE is not well formed

escape :: (Functor m, Monad m) => (String -> String) -> String -> m RE

convert a string into a RE that matches that string, and apply it to an argument continuation function to make up the RE string to be compiled; e.g., to compile a RE that will only match the string:

maybe undefined id . escape (("^"++) . (++"$"))

escapeWith :: (Functor m, Monad m) => SimpleREOptions -> (String -> String) -> String -> m RE

a variant of escape where the SimpleREOptions are specified

escapeREString :: String -> String

Convert a string into a regular expression that will match that string

The Classic rexex-base Match Operators

(=~) :: (Typeable a, RegexContext Regex (Seq Char) a, RegexMaker Regex CompOption ExecOption String) => Seq Char -> RE -> a

the regex-base polymorphic match operator

(=~~) :: (Monad m, Functor m, Typeable a, RegexContext Regex (Seq Char) a, RegexMaker Regex CompOption ExecOption String) => Seq Char -> RE -> m a

the regex-base monadic, polymorphic match operator

The Quasi Quoters and Minor Functions

The [re|.*|] quasi quoters, with variants for specifing different options to the RE compiler (see Text.RE.REOptions), and the specialised back-end types and functions.

module Text.RE.ZeInternals.TDFA

The [ed|.*///foo|] quasi quoters, with variants for specifing different options to the RE compiler (see Text.RE.REOptions).

module Text.RE.ZeInternals.SearchReplace.TDFA.Sequence

Orphan instances

IsRegex RE (Seq Char)

Methods

matchOnce :: RE -> Seq Char -> Match (Seq Char)

matchMany :: RE -> Seq Char -> Matches (Seq Char)

makeRegex :: (Functor m, Monad m) => Seq Char -> m RE

makeRegexWith :: (Functor m, Monad m) => SimpleREOptions -> Seq Char -> m RE

makeSearchReplace :: (Functor m, Monad m, IsRegex RE (Seq Char)) => Seq Char -> Seq Char -> m (SearchReplace RE (Seq Char))

makeSearchReplaceWith :: (Functor m, Monad m, IsRegex RE (Seq Char)) => SimpleREOptions -> Seq Char -> Seq Char -> m (SearchReplace RE (Seq Char))

makeEscaped :: (Functor m, Monad m) => (Seq Char -> Seq Char) -> Seq Char -> m RE

makeEscapedWith :: (Functor m, Monad m) => SimpleREOptions -> (Seq Char -> Seq Char) -> Seq Char -> m RE

regexSource :: RE -> Seq Char