pugs-hsregex-1.0: Haskell PCRE bindingContentsIndex
RRegex
Contents
Regular expressions
Description

Regular expressions, based on PCRE.

   A king he was on carven throne
   In many-pillared halls of stone
   With golden roof and silver floor,
   And runes of power upon the door...
Synopsis
data Regex
mkRegex :: String -> Regex
mkRegexWithOpts :: String -> Bool -> Bool -> Regex
mkRegexWithPCRE :: String -> [Int] -> Regex
matchRegex :: Regex -> String -> Maybe [String]
matchRegexAll :: Regex -> String -> Maybe (String, String, String, [String])
matchRegexWithPCRE :: Regex -> String -> Int -> IO (Maybe (Array Int (Int, Int)))
numSubs :: Regex -> IO Int
pcreCaseless :: Int
pcreMultiline :: Int
pcreDotall :: Int
pcreExtended :: Int
pcreAnchored :: Int
pcreDollarEndonly :: Int
pcreExtra :: Int
pcreNotbol :: Int
pcreNoteol :: Int
pcreUngreedy :: Int
pcreNotempty :: Int
pcreUtf8 :: Int
Regular expressions
data Regex
A compiled regular expression
show/hide Instances
mkRegex :: String -> Regex
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). Note: this is arguably the incorrect default. single line is the default everywhere else.
mkRegexWithOpts
:: StringThe regular expression to compile
-> BoolTrue <=> '^' and '$' match the beginning and end of individual lines respectively, and '.' does not match the newline character.
-> BoolTrue <=> matching is case-sensitive
-> RegexReturns: the compiled regular expression
Makes a regular expression, where the multi-line and case-sensitve options can be changed from the default settings.
mkRegexWithPCRE
:: StringThe regular expression to compile
-> [Int]Flags
-> RegexReturns: the compiled regular expression
Makes a regular expression with PCRE flags
matchRegex
:: RegexThe regular expression
-> StringThe 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
:: RegexThe regular expression
-> StringThe 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.
matchRegexWithPCRE
:: RegexCompiled regular expression
-> StringString to match against
-> IntOptions
-> IO (Maybe (Array Int (Int, Int)))
numSubs :: Regex -> IO Int
pcreCaseless :: Int
pcreMultiline :: Int
pcreDotall :: Int
pcreExtended :: Int
pcreAnchored :: Int
pcreDollarEndonly :: Int
pcreExtra :: Int
pcreNotbol :: Int
pcreNoteol :: Int
pcreUngreedy :: Int
pcreNotempty :: Int
pcreUtf8 :: Int
Produced by Haddock version 2.1.0