Text.Regex.TDFA.String

regex-tdfa-1.2.2: Replaces/Enhances Text.Regex

Safe Haskell | None
Language | Haskell98

Text.Regex.TDFA.String

Contents

- Types
- Medium level API functions
- Orphan instances

Description

This modules provides `RegexMaker` and `RegexLike` instances for using `String` with the TDFA backend.

This exports instances of the high level API and the medium level API of `compile`,`execute`, and `regexec`.

Synopsis

- data Regex
- type MatchOffset = Int
- type MatchLength = Int
- data CompOption
- data ExecOption
- compile :: CompOption -> ExecOption -> String -> Either String Regex
- execute :: Regex -> String -> Either String (Maybe MatchArray)
- regexec :: Regex -> String -> Either String (Maybe (String, String, String, [String]))

## Types

data Regex #

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

Instances

RegexOptions Regex CompOption ExecOption # |
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

type MatchOffset = Int #

0 based index from start of source, or (-1) for unused

type MatchLength = Int #

non-negative length of a match

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.

Instances

Read CompOption # |
Methods readsPrec :: Int -> ReadS CompOption # readList :: ReadS [CompOption] # readPrec :: ReadPrec CompOption # readListPrec :: ReadPrec [CompOption] #
Show CompOption # |
Methods showsPrec :: Int -> CompOption -> ShowS # show :: CompOption -> String # showList :: [CompOption] -> ShowS #
RegexOptions Regex CompOption ExecOption # |
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

data ExecOption #

Instances

Read ExecOption # |
Methods readsPrec :: Int -> ReadS ExecOption # readList :: ReadS [ExecOption] # readPrec :: ReadPrec ExecOption # readListPrec :: ReadPrec [ExecOption] #
Show ExecOption # |
Methods showsPrec :: Int -> ExecOption -> ShowS # show :: ExecOption -> String # showList :: [ExecOption] -> ShowS #
RegexOptions Regex CompOption ExecOption # |
Methods blankCompOpt :: CompOption # blankExecOpt :: ExecOption # defaultCompOpt :: CompOption # defaultExecOpt :: ExecOption # setExecOpts :: ExecOption -> Regex -> Regex # getExecOpts :: Regex -> ExecOption #

## Medium level API functions

compile #

Arguments

:: CompOption | Flags (summed together)
-> ExecOption | Flags (summed together)
-> String | The regular expression to compile (ASCII only, no null bytes)
-> Either String Regex | Returns: the compiled regular expression

execute #

Arguments

:: Regex | Compiled regular expression
-> String | String to match against
-> Either String (Maybe MatchArray) |

regexec #

Arguments

:: Regex | Compiled regular expression
-> String | String to match against
-> Either String (Maybe (String, String, String, [String])) |

# Orphan instances

RegexLike Regex 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 String String # |
Methods match :: Regex -> String -> String # matchM :: Monad m => Regex -> String -> m String #
RegexMaker Regex CompOption ExecOption String # |
Methods makeRegex :: String -> Regex # makeRegexOpts :: CompOption -> ExecOption -> String -> Regex # makeRegexM :: Monad m => String -> m Regex # makeRegexOptsM :: Monad m => CompOption -> ExecOption -> String -> m Regex #