Moduleregex-1.1.0.2Haskell2010

Text.RE.REOptions

Contents

The Options Tutorial
SimpleREOptions
REOptions_
The Macro Tables

Synopsis

data SimpleREOptions
data REOptions_
type Macros
newtype MacroID
value emptyMacros

Packageregex-1.1.0.2
Exports5
LanguageHaskell2010
LicenceBSD-3-Clause
SourceREOptions.lhs

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

datadata SimpleREOptions

Source#

the default API uses these simple, universal RE options, which get auto-converted into the appropriate 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

Instances7Bounded, Enum, Eq, Ord, Show, IsOption, …

Bounded SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
Enum SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
Eq SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
Ord SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
Show SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
IsOption SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFA
Lift SimpleREOptionsDefined in regex-1.1.0.2 · Text.RE.REOptions
we need to use this in the quasi quoters to specify SimpleREOptions selected by the quasi quoter

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 appropriate types (see, for example, Text.RE.TDFA)

Constructors

REOptions
- optionsMacs :: !Macros r
  the available TestBench RE macros
- optionsComp :: !c
  the back end compile-time options
- optionsExec :: !e
  the back end execution-time options

Instances2IsOption, Show

IsOption REOptionsDefined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFA
(Show r, Show c, Show e) => Show (REOptions_ r c e)Defined in regex-1.1.0.2 · Text.RE.REOptions

The Macro Tables

typetype Macros r = HashMap MacroID r

Source#

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)

newtypenewtype MacroID

Source#

MacroID is just a wrapped String type with an IsString instance

Constructors

MacroID
- getMacroID :: String

Instances6Eq, Ord, Show, IsString, Hashable, IsOption

Eq MacroIDDefined in regex-1.1.0.2 · Text.RE.REOptions
Ord MacroIDDefined in regex-1.1.0.2 · Text.RE.REOptions
Show MacroIDDefined in regex-1.1.0.2 · Text.RE.REOptions
IsString MacroIDDefined in regex-1.1.0.2 · Text.RE.REOptions
Hashable MacroIDDefined in regex-1.1.0.2 · Text.RE.REOptions
MacroID is used with HM.HashMap to build macro lookup tables
IsOption (Macros RE)Defined in regex-1.1.0.2 · Text.RE.ZeInternals.TDFA

valueemptyMacros :: Macros r

Source#

a macro table containing no entries