Text.Regex.TDFA

The Text.Regex.TDFA module provides a backend for regular expressions. It provides instances for the classes defined and documented in Text.Regex.Base and re-exported by this module. If you import this along with other backends then you should do so with qualified imports (with renaming for convenience).

This regex-tdfa package implements, correctly, POSIX extended regular expressions. It is highly unlikely that the regex-posix package on your operating system is correct, see http://www.haskell.org/haskellwiki/Regex_Posix for examples of your OS's bugs.

Importing and using

Declare a dependency on the regex-tdfa library in your .cabal file:

build-depends: regex-tdfa ^>= 1.3.2

In Haskell modules where you want to use regexes simply import this module:

import Text.Regex.TDFA

Basics

>>> let emailRegex = "[a-zA-Z0-9+._-]+\\@[-a-zA-Z]+\\.[a-z]+"
>>> "my email is [e-mail]" =~ emailRegex :: Bool
True

>>> "invalid@mail@com" =~ emailRegex :: Bool
False

>>> "[e-mail]" =~ emailRegex :: Bool
False

>>> "#@invalid.com" =~ emailRegex :: Bool
False

-- non-monadic
λ> <to-match-against> =~ <regex>

-- monadic, uses fail on lack of match
λ> <to-match-against> =~~ <regex>

(=~) and (=~~) are polymorphic in their return type. This is so that regex-tdfa can pick the most efficient way to give you your result based on what you need. For instance, if all you want is to check whether the regex matched or not, there's no need to allocate a result string. If you only want the first match, rather than all the matches, then the matching engine can stop after finding a single hit.

This does mean, though, that you may sometimes have to explicitly specify the type you want, especially if you're trying things out at the REPL.

Common use cases

Get the first match

-- returns empty string if no match
a =~ b :: String  -- or ByteString, or Text...

>>> "alexis-de-tocqueville" =~ "[a-z]+" :: String
"alexis"

>>> "alexis-de-tocqueville" =~ "[0-9]+" :: String
""

Check if it matched at all

a =~ b :: Bool

>>> "alexis-de-tocqueville" =~ "[a-z]+" :: Bool
True

Get first match + text before/after

-- if no match, will just return whole
-- string in the first element of the tuple
a =~ b :: (String, String, String)

>>> "alexis-de-tocqueville" =~ "de" :: (String, String, String)
("alexis-","de","-tocqueville")

>>> "alexis-de-tocqueville" =~ "kant" :: (String, String, String)
("alexis-de-tocqueville","","")

Get first match + submatches

-- same as above, but also returns a list of just submatches.
-- submatch list is empty if regex doesn't match at all
a =~ b :: (String, String, String, [String])

>>> "div[attr=1234]" =~ "div\\[([a-z]+)=([^]]+)\\]" :: (String, String, String, [String])
("","div[attr=1234]","",["attr","1234"])

Get all matches

-- can also return Data.Array instead of List
getAllTextMatches (a =~ b) :: [String]

>>> getAllTextMatches ("john anne yifan" =~ "[a-z]+") :: [String]
["john","anne","yifan"]

>>> getAllTextMatches ("* - . a + z" =~ "[--z]+") :: [String]
["-",".","a","z"]

Feature support

This package does provide captured parenthesized subexpressions.

Depending on the text being searched this package supports Unicode. The [Char], Text, Text.Lazy, and (Seq Char) text types support Unicode. The ByteString and ByteString.Lazy text types only support ASCII.

As of version 1.1.1 the following GNU extensions are recognized, all anchors:

• \` at beginning of entire text
• \' at end of entire text
• \< at beginning of word
• \> at end of word
• \b at either beginning or end of word
• \B at neither beginning nor end of word

The above are controlled by the newSyntax Bool in CompOption.

Where the "word" boundaries means between characters that are and are not in the [:word:] character class which contains [a-zA-Z0-9_]. Note that \< and \b may match before the entire text and \> and \b may match at the end of the entire text.

There is no locale support, so collating elements like [.ch.] are simply ignored and equivalence classes like [=a=] are converted to just [a]. The character classes like [:alnum:] are supported over ASCII only, valid classes are alnum, digit, punct, alpha, graph, space, blank, lower, upper, cntrl, print, xdigit, word.

>>> getAllTextMatches ("john anne yifan" =~ "[[:lower:]]+") :: [String]
["john","anne","yifan"]

This package does not provide "basic" regular expressions. This package does not provide back references inside regular expressions.

The package does not provide Perl style regular expressions. Please look at the regex-pcre and pcre-light packages instead.

This package does not provide find-and-replace.

Avoiding backslashes

If you find yourself writing a lot of regexes, take a look at raw-strings-qq. It'll let you write regexes without needing to escape all your backslashes.

{-# LANGUAGE QuasiQuotes #-}

import Text.RawString.QQ
import Text.Regex.TDFA

λ> "2 * (3 + 1) / 4" =~ [r|\([^)]+\)|] :: String
"(3 + 1)"

Documentation

getVersion_Text_Regex_TDFA :: Version

(=~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target) => source1 -> source -> target

This is the pure functional matching operator. If the target cannot be produced then some empty result will be returned. If there is an error in processing, then error will be called.

(=~~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target, MonadFail m) => source1 -> source -> m target

This is the monadic matching operator. If a single match fails, then fail will be called.

data Regex

The TDFA backend specific Regex type, used by this module's RegexOptions and RegexMaker.

Instances

RegexLike Regex ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray

matchAll :: Regex -> ByteString -> [MatchArray]

matchCount :: Regex -> ByteString -> Int

matchTest :: Regex -> ByteString -> Bool

matchAllText :: Regex -> ByteString -> [MatchText ByteString]

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString)

RegexLike Regex ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray

matchAll :: Regex -> ByteString -> [MatchArray]

matchCount :: Regex -> ByteString -> Int

matchTest :: Regex -> ByteString -> Bool

matchAllText :: Regex -> ByteString -> [MatchText ByteString]

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString)

RegexLike Regex Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexLike Regex Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexLike Regex String

Defined in Text.Regex.TDFA.String

Methods

matchOnce :: Regex -> String -> Maybe MatchArray

matchAll :: Regex -> String -> [MatchArray]

matchCount :: Regex -> String -> Int

matchTest :: Regex -> String -> Bool

matchAllText :: Regex -> String -> [MatchText String]

matchOnceText :: Regex -> String -> Maybe (String, MatchText String, String)

RegexContext Regex ByteString ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex ByteString ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex Text Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexContext Regex Text Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexContext Regex String String

Defined in Text.Regex.TDFA.String

Methods

match :: Regex -> String -> String

matchM :: MonadFail m => Regex -> String -> m String

RegexOptions Regex CompOption ExecOption

Defined in Text.Regex.TDFA.Common

Methods

blankCompOpt :: CompOption

blankExecOpt :: ExecOption

defaultCompOpt :: CompOption

defaultExecOpt :: ExecOption

setExecOpts :: ExecOption -> Regex -> Regex

getExecOpts :: Regex -> ExecOption

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption String

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex

makeRegexM :: MonadFail m => String -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex

makeRegexM :: MonadFail m => Seq Char -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex

RegexLike Regex (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

matchOnce :: Regex -> Seq Char -> Maybe MatchArray

matchAll :: Regex -> Seq Char -> [MatchArray]

matchCount :: Regex -> Seq Char -> Int

matchTest :: Regex -> Seq Char -> Bool

matchAllText :: Regex -> Seq Char -> [MatchText (Seq Char)]

matchOnceText :: Regex -> Seq Char -> Maybe (Seq Char, MatchText (Seq Char), Seq Char)

RegexContext Regex (Seq Char) (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

match :: Regex -> Seq Char -> Seq Char

matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char)

data CompOption

Control whether the pattern is multiline or case-sensitive like Text.Regex and whether to capture the subgroups (\1, \2, etc). Controls enabling extra anchor syntax.

Constructors

CompOption

Fields

• caseSensitive :: Bool

  True in blankCompOpt and defaultCompOpt.

• multiline :: Bool

  False in blankCompOpt, True in defaultCompOpt. Compile for newline-sensitive matching.

  From regexp man page: "By default, newline is a completely ordinary character with no special meaning in either REs or strings. With this flag, inverted bracket expressions [^ and . never match newline, a ^ anchor matches the null string after any newline in the string in addition to its normal function, and the $ anchor matches the null string before any newline in the string in addition to its normal function."

• rightAssoc :: Bool

  True (and therefore right associative) in blankCompOpt and defaultCompOpt.

• newSyntax :: Bool

  False in blankCompOpt, True in defaultCompOpt. Enables the extended non-POSIX syntax described in Text.Regex.TDFA haddock documentation.

• lastStarGreedy :: Bool

  False by default. This is POSIX correct but it takes space and is slower. Setting this to True will improve performance, and should be done if you plan to set the captureGroups ExecOption to False.

Instances

Read CompOption

Defined in Text.Regex.TDFA.Common

Methods

readsPrec :: Int -> ReadS CompOption

readList :: ReadS [CompOption]

readPrec :: ReadPrec CompOption

readListPrec :: ReadPrec [CompOption]

Show CompOption

Defined in Text.Regex.TDFA.Common

Methods

showsPrec :: Int -> CompOption -> ShowS

show :: CompOption -> String

showList :: [CompOption] -> ShowS

RegexOptions Regex CompOption ExecOption

Defined in Text.Regex.TDFA.Common

Methods

blankCompOpt :: CompOption

blankExecOpt :: ExecOption

defaultCompOpt :: CompOption

defaultExecOpt :: ExecOption

setExecOpts :: ExecOption -> Regex -> Regex

getExecOpts :: Regex -> ExecOption

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption String

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex

makeRegexM :: MonadFail m => String -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex

makeRegexM :: MonadFail m => Seq Char -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex

data ExecOption

Constructors

ExecOption

Fields

• captureGroups :: Bool

  True by default. Set to False to improve speed (and space).

Instances

Read ExecOption

Defined in Text.Regex.TDFA.Common

Methods

readsPrec :: Int -> ReadS ExecOption

readList :: ReadS [ExecOption]

readPrec :: ReadPrec ExecOption

readListPrec :: ReadPrec [ExecOption]

Show ExecOption

Defined in Text.Regex.TDFA.Common

Methods

showsPrec :: Int -> ExecOption -> ShowS

show :: ExecOption -> String

showList :: [ExecOption] -> ShowS

RegexOptions Regex CompOption ExecOption

Defined in Text.Regex.TDFA.Common

Methods

blankCompOpt :: CompOption

blankExecOpt :: ExecOption

defaultCompOpt :: CompOption

defaultExecOpt :: ExecOption

setExecOpts :: ExecOption -> Regex -> Regex

getExecOpts :: Regex -> ExecOption

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption String

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex

makeRegexM :: MonadFail m => String -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex

makeRegexM :: MonadFail m => Seq Char -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex

class Extract source where

Minimal complete definition

before, after, empty

Methods

before :: Int -> source -> source

after :: Int -> source -> source

empty :: source

extract :: (Int, Int) -> source -> source

Instances

Extract ByteString

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> ByteString -> ByteString

after :: Int -> ByteString -> ByteString

empty :: ByteString

extract :: (Int, Int) -> ByteString -> ByteString

Extract ByteString

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> ByteString -> ByteString

after :: Int -> ByteString -> ByteString

empty :: ByteString

extract :: (Int, Int) -> ByteString -> ByteString

Extract Text

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> Text -> Text

after :: Int -> Text -> Text

empty :: Text

extract :: (Int, Int) -> Text -> Text

Extract Text

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> Text -> Text

after :: Int -> Text -> Text

empty :: Text

extract :: (Int, Int) -> Text -> Text

Extract String

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> String -> String

after :: Int -> String -> String

empty :: String

extract :: (Int, Int) -> String -> String

Extract (Seq a)

Defined in Text.Regex.Base.RegexLike

Methods

before :: Int -> Seq a -> Seq a

after :: Int -> Seq a -> Seq a

empty :: Seq a

extract :: (Int, Int) -> Seq a -> Seq a

type MatchArray = Array Int (MatchOffset, MatchLength)

class RegexLike regex source => RegexContext regex source target where

Methods

match :: regex -> source -> target

matchM :: MonadFail m => regex -> source -> m target

Instances

RegexContext Regex ByteString ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex ByteString ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

match :: Regex -> ByteString -> ByteString

matchM :: MonadFail m => Regex -> ByteString -> m ByteString

RegexContext Regex Text Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexContext Regex Text Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

match :: Regex -> Text -> Text

matchM :: MonadFail m => Regex -> Text -> m Text

RegexContext Regex String String

Defined in Text.Regex.TDFA.String

Methods

match :: Regex -> String -> String

matchM :: MonadFail m => Regex -> String -> m String

RegexContext Regex (Seq Char) (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

match :: Regex -> Seq Char -> Seq Char

matchM :: MonadFail m => Regex -> Seq Char -> m (Seq Char)

class RegexOptions regex compOpt execOpt => RegexMaker regex compOpt execOpt source | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt where

Minimal complete definition

Nothing

Methods

makeRegex :: source -> regex

makeRegexOpts :: compOpt -> execOpt -> source -> regex

makeRegexM :: MonadFail m => source -> m regex

makeRegexOptsM :: MonadFail m => compOpt -> execOpt -> source -> m regex

Instances

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

makeRegex :: ByteString -> Regex

makeRegexOpts :: CompOption -> ExecOption -> ByteString -> Regex

makeRegexM :: MonadFail m => ByteString -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> ByteString -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

makeRegex :: Text -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Text -> Regex

makeRegexM :: MonadFail m => Text -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Text -> m Regex

RegexMaker Regex CompOption ExecOption String

Defined in Text.Regex.TDFA.String

Methods

makeRegex :: String -> Regex

makeRegexOpts :: CompOption -> ExecOption -> String -> Regex

makeRegexM :: MonadFail m => String -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> String -> m Regex

RegexMaker Regex CompOption ExecOption (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

makeRegex :: Seq Char -> Regex

makeRegexOpts :: CompOption -> ExecOption -> Seq Char -> Regex

makeRegexM :: MonadFail m => Seq Char -> m Regex

makeRegexOptsM :: MonadFail m => CompOption -> ExecOption -> Seq Char -> m Regex

class Extract source => RegexLike regex source where

Minimal complete definition

Nothing

Methods

matchOnce :: regex -> source -> Maybe MatchArray

matchAll :: regex -> source -> [MatchArray]

matchCount :: regex -> source -> Int

matchTest :: regex -> source -> Bool

matchAllText :: regex -> source -> [MatchText source]

matchOnceText :: regex -> source -> Maybe (source, MatchText source, source)

Instances

RegexLike Regex ByteString

Defined in Text.Regex.TDFA.ByteString

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray

matchAll :: Regex -> ByteString -> [MatchArray]

matchCount :: Regex -> ByteString -> Int

matchTest :: Regex -> ByteString -> Bool

matchAllText :: Regex -> ByteString -> [MatchText ByteString]

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString)

RegexLike Regex ByteString

Defined in Text.Regex.TDFA.ByteString.Lazy

Methods

matchOnce :: Regex -> ByteString -> Maybe MatchArray

matchAll :: Regex -> ByteString -> [MatchArray]

matchCount :: Regex -> ByteString -> Int

matchTest :: Regex -> ByteString -> Bool

matchAllText :: Regex -> ByteString -> [MatchText ByteString]

matchOnceText :: Regex -> ByteString -> Maybe (ByteString, MatchText ByteString, ByteString)

RegexLike Regex Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexLike Regex Text

Since: 1.3.1

Defined in Text.Regex.TDFA.Text.Lazy

Methods

matchOnce :: Regex -> Text -> Maybe MatchArray

matchAll :: Regex -> Text -> [MatchArray]

matchCount :: Regex -> Text -> Int

matchTest :: Regex -> Text -> Bool

matchAllText :: Regex -> Text -> [MatchText Text]

matchOnceText :: Regex -> Text -> Maybe (Text, MatchText Text, Text)

RegexLike Regex String

Defined in Text.Regex.TDFA.String

Methods

matchOnce :: Regex -> String -> Maybe MatchArray

matchAll :: Regex -> String -> [MatchArray]

matchCount :: Regex -> String -> Int

matchTest :: Regex -> String -> Bool

matchAllText :: Regex -> String -> [MatchText String]

matchOnceText :: Regex -> String -> Maybe (String, MatchText String, String)

RegexLike Regex (Seq Char)

Defined in Text.Regex.TDFA.Sequence

Methods

matchOnce :: Regex -> Seq Char -> Maybe MatchArray

matchAll :: Regex -> Seq Char -> [MatchArray]

matchCount :: Regex -> Seq Char -> Int

matchTest :: Regex -> Seq Char -> Bool

matchAllText :: Regex -> Seq Char -> [MatchText (Seq Char)]

matchOnceText :: Regex -> Seq Char -> Maybe (Seq Char, MatchText (Seq Char), Seq Char)

class RegexOptions regex compOpt execOpt | regex -> compOpt execOpt, compOpt -> regex execOpt, execOpt -> regex compOpt where

Methods

blankCompOpt :: compOpt

blankExecOpt :: execOpt

defaultCompOpt :: compOpt

defaultExecOpt :: execOpt

setExecOpts :: execOpt -> regex -> regex

getExecOpts :: regex -> execOpt

Instances

RegexOptions Regex CompOption ExecOption

Defined in Text.Regex.TDFA.Common

Methods

blankCompOpt :: CompOption

blankExecOpt :: ExecOption

defaultCompOpt :: CompOption

defaultExecOpt :: ExecOption

setExecOpts :: ExecOption -> Regex -> Regex

getExecOpts :: Regex -> ExecOption

type MatchOffset = Int

type MatchLength = Int

newtype AllMatches (f :: Type -> Type) b

Constructors

AllMatches

Fields

• getAllMatches :: f b

newtype AllSubmatches (f :: Type -> Type) b

Constructors

AllSubmatches

Fields

• getAllSubmatches :: f b

newtype AllTextMatches (f :: Type -> Type) b

Constructors

AllTextMatches

Fields

• getAllTextMatches :: f b

newtype AllTextSubmatches (f :: Type -> Type) b

Constructors

AllTextSubmatches

Fields

• getAllTextSubmatches :: f b

data MatchResult a

Constructors

MR

Fields

• mrBefore :: a
• mrMatch :: a
• mrAfter :: a
• mrSubList :: [a]
• mrSubs :: Array Int a

type MatchText source = Array Int (source, (MatchOffset, MatchLength))

getVersion_Text_Regex_Base :: Version