Moduleregex-posix-0.96.0.2Haskell2010

Text.Regex.Posix.String

This provides String instances for RegexMaker and RegexLike based on Text.Regex.Posix.Wrap, and a (RegexContext Regex String String) instance.

To use these instance, you would normally import Text.Regex.Posix. You only need to import this module to use the medium level API of the compile, regexec, and execute functions. All of these report error by returning Left values instead of undefined or error or fail.

7 types
12 values

Packageregex-posix-0.96.0.2
Exports19
LanguageHaskell2010
LicenceBSD-3-Clause
SourceString.hs

Types

5 declarations

datadata Regex

A compiled regular expression.

Instances13RegexOptions, RegexMaker, RegexLike, RegexContext, …

RegexLike Regex ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString · orphan
RegexLike Regex ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString.Lazy · orphan
RegexLike Regex StringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.String · orphan
RegexContext Regex ByteString ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString · orphan
RegexContext Regex ByteString ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString.Lazy · orphan
RegexContext Regex String StringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.String · orphan
RegexOptions Regex CompOption ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.String · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-posix-0.96.0.2 · Text.Regex.Posix.Sequence · orphan
RegexLike Regex (Seq Char)Defined in regex-posix-0.96.0.2 · Text.Regex.Posix.Sequence · orphan
RegexContext Regex (Seq Char) (Seq Char)Defined in regex-posix-0.96.0.2 · Text.Regex.Posix.Sequence · orphan

typetype MatchOffset = Int

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

typetype MatchLength = Int

non-negative length of a match

newtypenewtype ReturnCode

ReturnCode is an enumerated CInt, corresponding to the error codes from man 3 regex:

retBadbr (REG_BADBR) invalid repetition count(s) in { }
retBadpat (REG_BADPAT) invalid regular expression
retBadrpt (REG_BADRPT) ?, *, or + operand invalid
retEcollate (REG_ECOLLATE) invalid collating element
retEctype (REG_ECTYPE) invalid character class
retEescape (REG_EESCAPE) \ applied to unescapable character
retEsubreg (REG_ESUBREG) invalid backreference number
retEbrack (REG_EBRACK) brackets [ ] not balanced
retEparen (REG_EPAREN) parentheses ( ) not balanced
retEbrace (REG_EBRACE) braces { } not balanced
retErange (REG_ERANGE) invalid character range in [ ]
retEspace (REG_ESPACE) ran out of memory
retNoMatch (REG_NOMATCH) The regexec() function failed to match

Instances2Eq, Show

Eq ReturnCodeDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Show ReturnCodeDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap

typetype WrapError = (ReturnCode, String)

The return code will be retOk when it is the Haskell wrapper and not the underlying library generating the error message.

Miscellaneous

1 declaration

valueunusedOffset :: Int

Medium level API functions

3 declarations

valuecompile

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

valueregexec

:: Regex
Compiled regular expression
-> String
String to match against

-> IO (Either WrapError (Maybe (String, String, String, [String])))

Returns: Nothing if the regex did not match the string, or:

  Just (everything before match,
        matched portion,
        everything after match,
        subexpression matches)

Matches a regular expression against a string

valueexecute

:: Regex
Compiled regular expression
-> String
String to match against
-> IO (Either WrapError (Maybe (Array Int (MatchOffset, MatchLength))))
Returns: Nothing if the regex did not match the string, or:
```
  Just (array of offset length pairs)
```

Matches a regular expression against a string

Compilation options

6 declarations

newtypenewtype CompOption

A bitmapped CInt containing options for compilation of regular expressions. Option values (and their man 3 regcomp names) are

compBlank which is a completely zero value for all the flags. This is also the blankCompOpt value.
compExtended (REG_EXTENDED) which can be set to use extended instead of basic regular expressions. This is set in the defaultCompOpt value.
compNewline (REG_NEWLINE) turns on newline sensitivity: The dot (.) and inverted set [^ ] never match newline, and ^ and $ anchors do match after and before newlines. This is set in the defaultCompOpt value.
compIgnoreCase (REG_ICASE) which can be set to match ignoring upper and lower distinctions.
compNoSub (REG_NOSUB) which turns off all information from matching except whether a match exists.

Constructors

CompOption CInt

Instances9Eq, Num, Show, Bits, RegexOptions, RegexMaker, …

Eq CompOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Num CompOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Show CompOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Bits CompOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
RegexOptions Regex CompOption ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.String · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-posix-0.96.0.2 · Text.Regex.Posix.Sequence · orphan

valuecompBlank :: CompOption

A completely zero value for all the flags. This is also the blankCompOpt value.

valuecompExtended :: CompOption

valuecompIgnoreCase :: CompOption

valuecompNoSub :: CompOption

valuecompNewline :: CompOption

Execution options

4 declarations

newtypenewtype ExecOption

A bitmapped CInt containing options for execution of compiled regular expressions. Option values (and their man 3 regexec names) are

execBlank which is a complete zero value for all the flags. This is the blankExecOpt value.
execNotBOL (REG_NOTBOL) can be set to prevent ^ from matching at the start of the input.
execNotEOL (REG_NOTEOL) can be set to prevent $ from matching at the end of the input (before the terminating NUL).

Constructors

ExecOption CInt

Instances9Eq, Num, Show, Bits, RegexOptions, RegexMaker, …

Eq ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Num ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Show ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
Bits ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
RegexOptions Regex CompOption ExecOptionDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.Wrap
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString · orphan
RegexMaker Regex CompOption ExecOption ByteStringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.ByteString.Lazy · orphan
RegexMaker Regex CompOption ExecOption StringDefined in regex-posix-0.96.0.2 · Text.Regex.Posix.String · orphan
RegexMaker Regex CompOption ExecOption (Seq Char)Defined in regex-posix-0.96.0.2 · Text.Regex.Posix.Sequence · orphan

valueexecBlank :: ExecOption

A completely zero value for all the flags. This is also the blankExecOpt value.

valueexecNotBOL :: ExecOption

valueexecNotEOL :: ExecOption

Orphan instances

3 instances

RegexLike Regex String
RegexContext Regex String String
RegexMaker Regex CompOption ExecOption String