Text.RE.REOptions

The Options Tutorial

This API module provides the generic types used to specify the options when compiling REs for each of the backl ends.

See the tutorials at http://re-tutorial-options.regex.uk

SimpleREOptions

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

IsOption SimpleREOptions

Methods

makeREOptions :: SimpleREOptions -> REOptions

REOptions_

data REOptions_ r c e

the general options for an RE are dependent on which back end is being used and are parameterised over the RE type for the back end, and its CompOption and ExecOption types (the compile-time and execution time options, respectively); each back end will define an REOptions type that fills out these three type parameters with the apropriate types (see, for example, Text.RE.TDFA)

Constructors

REOptions

Fields

• optionsMacs :: !(Macros r)

  the available TestBench RE macros

• optionsComp :: !c

  the back end compile-time options

• optionsExec :: !e

  the back end execution-time options

Instances

IsOption REOptions

Methods

makeREOptions :: REOptions -> REOptions

(Show e, Show c, Show r) => Show (REOptions_ r c e)

Methods

showsPrec :: Int -> REOptions_ r c e -> ShowS

show :: REOptions_ r c e -> String

showList :: [REOptions_ r c e] -> ShowS

The Macro Tables

type Macros r = HashMap MacroID r

our macro tables are parameterised over the back end RE type and and just associate each MacroID with an RE (which may in turn contain macros to be expanded)

newtype MacroID

MacroID is just a wrapped String type with an IsString instance

Constructors

MacroID

Fields

• getMacroID :: String

Instances

Eq MacroID

Methods

(==) :: MacroID -> MacroID -> Bool

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

Ord MacroID

Methods

compare :: MacroID -> MacroID -> Ordering

(<) :: MacroID -> MacroID -> Bool

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

(>) :: MacroID -> MacroID -> Bool

(>=) :: MacroID -> MacroID -> Bool

max :: MacroID -> MacroID -> MacroID

min :: MacroID -> MacroID -> MacroID

Show MacroID

Methods

showsPrec :: Int -> MacroID -> ShowS

show :: MacroID -> String

showList :: [MacroID] -> ShowS

IsString MacroID

Methods

fromString :: String -> MacroID

Hashable MacroID

MacroID is used with HM.HashMap to build macro lookup tables

Methods

hashWithSalt :: Int -> MacroID -> Int

hash :: MacroID -> Int

IsOption (Macros RE)

Methods

makeREOptions :: Macros RE -> REOptions

emptyMacros :: Macros r

a macro table containing no entries