| ||||||||
| ||||||||
| ||||||||
Description | ||||||||
WrapPosix.hsc exports a wrapped version of the ffi imports. To increase type safety, the flags are newtype'd. The other important export is a Regex type that is specific to the Posix library backend. The flags are documented in Text.Regex.Posix. The defaultCompOpt is (compExtended .|. compNewline). The Regex, CompOption, and ExecOption types and their RegexOptions instance is declared. The =~ and =~~ convenience functions are defined. The exported symbols are the same whether 1 is defined, but when it is not defined then getVersion == Nothing and all other exported values will call error or fail. This module will fail or error only if allocation fails or a nullPtr is passed in. 2009-January : wrapMatchAll and wrapCount now adjust the execution option execNotBOL after the first result to take into account '\n' in the text immediately before the next matches. (version 0.93.3) 2009-January : wrapMatchAll and wrapCount have been changed to return all non-overlapping matches, including empty matches even if they coincide with the end of the previous non-empty match. The change is that the first non-empty match no longer terminates the search. One can filter the results to obtain the old behavior or to obtain the behavior of sed, where sed eliminates the empty matches which coincide with the end of non-empty matches. (version 0.94.0) | ||||||||
Synopsis | ||||||||
High-level API | ||||||||
data Regex | ||||||||
type RegOffset = Int64 | ||||||||
RegOffset is typedef int regoff_t on Linux and ultimately typedef long long __int64_t on Max OS X. So rather than saying 2,147,483,647 is all the length you need, I'll take the larger: 9,223,372,036,854,775,807 should be enough bytes for anyone, no need for Integer. The alternative is to compile to different sizes in a platform dependent manner with type RegOffset = (, which I do not want to do. There is also a special value unusedRegOffset :: RegOffset which is (-1) and as a starting index means that the subgroup capture was unused. Otherwise the RegOffset indicates a character boundary that is before the character at that index offset, with the first character at index offset 0. So starting at 1 and ending at 2 means to take only the second character. | ||||||||
(=~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target) => source1 -> source -> target | ||||||||
(=~~) :: (RegexMaker Regex CompOption ExecOption source, RegexContext Regex source1 target, Monad m) => source1 -> source -> m target | ||||||||
Low-level API | ||||||||
type WrapError = (ReturnCode, String) | ||||||||
The return code will be retOk when it is the Haskell wrapper and not the underlying library generating the error message. | ||||||||
wrapCompile | ||||||||
| ||||||||
wrapTest :: Regex -> CString -> IO (Either WrapError Bool) | ||||||||
wrapMatch :: Regex -> CString -> IO (Either WrapError (Maybe [(RegOffset, RegOffset)])) | ||||||||
wrapMatch returns offsets for the begin and end of each capture. Unused captures have offsets of unusedRegOffset which is (-1) | ||||||||
wrapMatchAll :: Regex -> CString -> IO (Either WrapError [MatchArray]) | ||||||||
wrapMatchAll returns the offset and length of each capture. Unused captures have an offset of unusedRegOffset which is (-1) and length of 0. | ||||||||
wrapCount :: Regex -> CString -> IO (Either WrapError Int) | ||||||||
Miscellaneous | ||||||||
unusedRegOffset :: RegOffset | ||||||||
Compilation options | ||||||||
newtype CompOption | ||||||||
| ||||||||
compBlank :: CompOption | ||||||||
A completely zero value for all the flags. This is also the blankCompOpt value. | ||||||||
compExtended :: CompOption | ||||||||
compIgnoreCase :: CompOption | ||||||||
compNoSub :: CompOption | ||||||||
compNewline :: CompOption | ||||||||
Execution options | ||||||||
newtype ExecOption | ||||||||
| ||||||||
execBlank :: ExecOption | ||||||||
A completely zero value for all the flags. This is also the blankExecOpt value. | ||||||||
execNotBOL :: ExecOption | ||||||||
execNotEOL :: ExecOption | ||||||||
Return codes | ||||||||
newtype ReturnCode | ||||||||
| ||||||||
retBadbr :: ReturnCode | ||||||||
retBadpat :: ReturnCode | ||||||||
retBadrpt :: ReturnCode | ||||||||
retEcollate :: ReturnCode | ||||||||
retEctype :: ReturnCode | ||||||||
retEescape :: ReturnCode | ||||||||
retEsubreg :: ReturnCode | ||||||||
retEbrack :: ReturnCode | ||||||||
retEparen :: ReturnCode | ||||||||
retEbrace :: ReturnCode | ||||||||
retErange :: ReturnCode | ||||||||
retEspace :: ReturnCode | ||||||||
Produced by Haddock version 2.7.2 |