Modulepcre2-2.3.1GHC2021

Text.Regex.Pcre2.Foreign

A complete binding to the low-level C API.

Items here are named identically to their C counterparts. Therefore, documentation will be sparse; the official PCRE2 API docs should suffice.

Contents

Types
Opaque types
The general context
The compile context
Compile context setters
The match context
Match context setters
Checking build-time options
Compiling a pattern
Main compile options
Extra compile options
Locale support
Information about a compiled pattern
Duplicate capture group names
Callouts
Callout struct getters
pcre2_callout_block
pcre2_callout_enumerate_block
pcre2_substitute_callout_block
The match data block
Matching a pattern
Match options
Match errors
UTF-16-specific errors
DFA matching
DFA matching options
DFA matching errors
Returned string and captured substrings
Creating a new string with substitutions
Substitution options
Substitution errors
Other information about a match
Obtaining a textual error message
Iterating over all matches
Pattern serialization

Synopsis

type PCRE2_UCHAR
type PCRE2_SPTR
type PCRE2_SIZE
data Pcre2_general_context
data Pcre2_compile_context
data Pcre2_match_context
data Pcre2_callout_block
data Pcre2_substitute_callout_block
data Pcre2_code
data Pcre2_match_data
data Pcre2_callout_enumerate_block
value pcre2_general_context_create
value pcre2_general_context_copy
value pcre2_general_context_free
value pcre2_general_context_finalizer
value pcre2_compile_context_create
value pcre2_compile_context_copy
value pcre2_compile_context_free
value pcre2_compile_context_finalizer
value pcre2_ERROR_BADDATA
value pcre2_set_bsr
value pcre2_BSR_ANYCRLF
value pcre2_BSR_UNICODE
value pcre2_set_character_tables
value pcre2_set_compile_extra_options
value pcre2_set_max_pattern_length
value pcre2_set_newline
value pcre2_NEWLINE_CR
value pcre2_NEWLINE_LF
value pcre2_NEWLINE_CRLF
value pcre2_NEWLINE_ANY
value pcre2_NEWLINE_ANYCRLF
value pcre2_NEWLINE_NUL
value pcre2_set_parens_nest_limit
value pcre2_set_compile_recursion_guard
value pcre2_match_context_create
value pcre2_match_context_copy
value pcre2_match_context_free
value pcre2_match_context_finalizer
value pcre2_set_callout
value pcre2_set_substitute_callout
value pcre2_set_offset_limit
value pcre2_UNSET
value pcre2_set_heap_limit
value pcre2_set_match_limit
value pcre2_set_depth_limit
value pcre2_config
value pcre2_CONFIG_BSR
value pcre2_CONFIG_COMPILED_WIDTHS
value pcre2_CONFIG_DEPTHLIMIT
value pcre2_CONFIG_EFFECTIVE_LINKSIZE
value pcre2_CONFIG_HEAPLIMIT
value pcre2_CONFIG_JIT
value pcre2_CONFIG_JITTARGET
value pcre2_CONFIG_LINKSIZE
value pcre2_CONFIG_MATCHLIMIT
value pcre2_CONFIG_NEWLINE
value pcre2_CONFIG_NEVER_BACKSLASH_C
value pcre2_CONFIG_PARENSLIMIT
value pcre2_CONFIG_STACKRECURSE
value pcre2_CONFIG_TABLES_LENGTH
value pcre2_CONFIG_UNICODE_VERSION
value pcre2_CONFIG_UNICODE
value pcre2_CONFIG_VERSION
value pcre2_compile
value pcre2_ZERO_TERMINATED
value pcre2_code_free
value pcre2_code_finalizer
value pcre2_code_copy
value pcre2_code_copy_with_tables
value pcre2_ANCHORED
value pcre2_ALLOW_EMPTY_CLASS
value pcre2_ALT_BSUX
value pcre2_ALT_CIRCUMFLEX
value pcre2_ALT_VERBNAMES
value pcre2_AUTO_CALLOUT
value pcre2_CASELESS
value pcre2_DOLLAR_ENDONLY
value pcre2_DOTALL
value pcre2_DUPNAMES
value pcre2_ENDANCHORED
value pcre2_EXTENDED
value pcre2_EXTENDED_MORE
value pcre2_FIRSTLINE
value pcre2_LITERAL
value pcre2_MATCH_INVALID_UTF
value pcre2_MATCH_UNSET_BACKREF
value pcre2_MULTILINE
value pcre2_NEVER_BACKSLASH_C
value pcre2_NEVER_UCP
value pcre2_NEVER_UTF
value pcre2_NO_AUTO_CAPTURE
value pcre2_NO_AUTO_POSSESS
value pcre2_NO_DOTSTAR_ANCHOR
value pcre2_NO_START_OPTIMIZE
value pcre2_NO_UTF_CHECK
value pcre2_UCP
value pcre2_UNGREEDY
value pcre2_USE_OFFSET_LIMIT
value pcre2_UTF
value pcre2_EXTRA_ALLOW_SURROGATE_ESCAPES
value pcre2_EXTRA_ALT_BSUX
value pcre2_EXTRA_BAD_ESCAPE_IS_LITERAL
value pcre2_EXTRA_ESCAPED_CR_IS_LF
value pcre2_EXTRA_MATCH_LINE
value pcre2_EXTRA_MATCH_WORD
value pcre2_maketables
value pcre2_maketables_free
value pcre2_pattern_info
value pcre2_INFO_ALLOPTIONS
value pcre2_INFO_ARGOPTIONS
value pcre2_INFO_EXTRAOPTIONS
value pcre2_INFO_BACKREFMAX
value pcre2_INFO_BSR
value pcre2_INFO_CAPTURECOUNT
value pcre2_INFO_DEPTHLIMIT
value pcre2_INFO_FIRSTBITMAP
value pcre2_INFO_FIRSTCODETYPE
value pcre2_INFO_FIRSTCODEUNIT
value pcre2_INFO_FRAMESIZE
value pcre2_INFO_HASBACKSLASHC
value pcre2_INFO_HASCRORLF
value pcre2_INFO_HEAPLIMIT
value pcre2_INFO_JCHANGED
value pcre2_INFO_LASTCODETYPE
value pcre2_INFO_LASTCODEUNIT
value pcre2_INFO_MATCHEMPTY
value pcre2_INFO_MATCHLIMIT
value pcre2_INFO_MAXLOOKBEHIND
value pcre2_INFO_MINLENGTH
value pcre2_INFO_NAMECOUNT
value pcre2_INFO_NAMEENTRYSIZE
value pcre2_INFO_NAMETABLE
value pcre2_INFO_NEWLINE
value pcre2_INFO_SIZE
value pcre2_ERROR_UNSET
value pcre2_substring_nametable_scan
value pcre2_callout_enumerate
value pcre2_callout_block_version
value pcre2_callout_block_callout_number
value pcre2_callout_block_capture_top
value pcre2_callout_block_capture_last
value pcre2_callout_block_callout_flags
value pcre2_CALLOUT_STARTMATCH
value pcre2_CALLOUT_BACKTRACK
value pcre2_callout_block_offset_vector
value pcre2_callout_block_mark
value pcre2_callout_block_subject
value pcre2_callout_block_subject_length
value pcre2_callout_block_start_match
value pcre2_callout_block_current_position
value pcre2_callout_block_pattern_position
value pcre2_callout_block_next_item_length
value pcre2_callout_block_callout_string_offset
value pcre2_callout_block_callout_string_length
value pcre2_callout_block_callout_string
value pcre2_callout_enumerate_block_version
value pcre2_callout_enumerate_block_pattern_position
value pcre2_callout_enumerate_block_next_item_length
value pcre2_callout_enumerate_block_callout_number
value pcre2_callout_enumerate_block_callout_string_offset
value pcre2_callout_enumerate_block_callout_string_length
value pcre2_callout_enumerate_block_callout_string
value pcre2_substitute_callout_block_version
value pcre2_substitute_callout_block_subscount
value pcre2_substitute_callout_block_input
value pcre2_substitute_callout_block_output
value pcre2_substitute_callout_block_ovector
value pcre2_substitute_callout_block_oveccount
value pcre2_substitute_callout_block_output_offsets
value pcre2_match_data_create
value pcre2_match_data_create_from_pattern
value pcre2_match_data_free
value pcre2_match_data_finalizer
value pcre2_match
value pcre2_COPY_MATCHED_SUBJECT
value pcre2_NOTBOL
value pcre2_NOTEOL
value pcre2_NOTEMPTY
value pcre2_NOTEMPTY_ATSTART
value pcre2_PARTIAL_HARD
value pcre2_PARTIAL_SOFT
value pcre2_ERROR_NOMATCH
value pcre2_ERROR_PARTIAL
value pcre2_ERROR_BADMAGIC
value pcre2_ERROR_BADMODE
value pcre2_ERROR_BADOFFSET
value pcre2_ERROR_BADOPTION
value pcre2_ERROR_BADUTFOFFSET
value pcre2_ERROR_CALLOUT
value pcre2_ERROR_DEPTHLIMIT
value pcre2_ERROR_HEAPLIMIT
value pcre2_ERROR_INTERNAL
value pcre2_ERROR_MATCHLIMIT
value pcre2_ERROR_NOMEMORY
value pcre2_ERROR_NULL
value pcre2_ERROR_UTF16_ERR1
value pcre2_ERROR_UTF16_ERR2
value pcre2_ERROR_UTF16_ERR3
value pcre2_dfa_match
value pcre2_DFA_SHORTEST
value pcre2_DFA_RESTART
value pcre2_ERROR_DFA_UFUNC
value pcre2_ERROR_DFA_UITEM
value pcre2_ERROR_DFA_UCOND
value pcre2_ERROR_DFA_UINVALID_UTF
value pcre2_ERROR_DFA_WSSIZE
value pcre2_ERROR_DFA_RECURSE
value pcre2_ERROR_DFA_BADRESTART
value pcre2_get_ovector_count
value pcre2_get_ovector_pointer
value pcre2_substring_length_bynumber
value pcre2_substring_copy_bynumber
value pcre2_substring_get_bynumber
value pcre2_substring_list_get
value pcre2_substring_list_free
value pcre2_substring_number_from_name
value pcre2_substring_length_byname
value pcre2_substring_copy_byname
value pcre2_substring_get_byname
value pcre2_substring_free
value pcre2_ERROR_NOSUBSTRING
value pcre2_ERROR_NOUNIQUESUBSTRING
value pcre2_ERROR_UNAVAILABLE
value pcre2_substitute
value pcre2_SUBSTITUTE_REPLACEMENT_ONLY
value pcre2_SUBSTITUTE_GLOBAL
value pcre2_SUBSTITUTE_MATCHED
value pcre2_SUBSTITUTE_OVERFLOW_LENGTH
value pcre2_SUBSTITUTE_LITERAL
value pcre2_SUBSTITUTE_UNKNOWN_UNSET
value pcre2_SUBSTITUTE_UNSET_EMPTY
value pcre2_SUBSTITUTE_EXTENDED
value pcre2_ERROR_BADREPLACEMENT
value pcre2_ERROR_BADREPESCAPE
value pcre2_ERROR_BADSUBSTITUTION
value pcre2_ERROR_BADSUBSPATTERN
value pcre2_get_mark
value pcre2_get_startchar
value pcre2_get_error_message
value pcre2_next_match
value pcre2_serialize_decode
value pcre2_serialize_encode
value pcre2_serialize_free
value pcre2_serialize_get_number_of_codes
value pcre2_ERROR_BADSERIALIZEDDATA
value pcre2_ERROR_MIXEDTABLES

Packagepcre2-2.3.1
Exports247
LanguageGHC2021
LicenceApache-2.0
SourceForeign.hs

Types

typetype PCRE2_UCHAR = CUChar

Source#

"The UCHAR types define unsigned code units of the appropriate widths. For example, PCRE2_UCHAR16 is usually defined as uint16_t."

typetype PCRE2_SPTR = Ptr PCRE2_UCHAR

Source#

"The SPTR types are constant pointers to the equivalent UCHAR types, that is, they are pointers to vectors of unsigned code units."

typetype PCRE2_SIZE = CSize

Source#

"...string lengths and offsets into strings of code units...are always of type PCRE2_SIZE...currently always defined as size_t."

Opaque types

These correspond to structs that are only ever passed by reference. They simply exist for type safety and cannot be constructed in Haskell.

datadata Pcre2_general_context

datadata Pcre2_compile_context

datadata Pcre2_match_context

datadata Pcre2_callout_block

datadata Pcre2_substitute_callout_block

datadata Pcre2_code

datadata Pcre2_match_data

datadata Pcre2_callout_enumerate_block

The general context

valuepcre2_general_context_create

:: FunPtr (PCRE2_SIZE -> Ptr a -> IO (Ptr b))
custom malloc
-> FunPtr (Ptr b -> Ptr a -> IO ())
custom free
-> Ptr a
-> IO (Ptr Pcre2_general_context)

valuepcre2_general_context_copy

:: Ptr Pcre2_general_context
-> IO (Ptr Pcre2_general_context)

valuepcre2_general_context_free :: Ptr Pcre2_general_context -> IO ()

valuepcre2_general_context_finalizer :: FinalizerPtr Pcre2_general_context

The compile context

valuepcre2_compile_context_create

:: Ptr Pcre2_general_context
-> IO (Ptr Pcre2_compile_context)

valuepcre2_compile_context_copy

:: Ptr Pcre2_compile_context
-> IO (Ptr Pcre2_compile_context)

valuepcre2_compile_context_free :: Ptr Pcre2_compile_context -> IO ()

valuepcre2_compile_context_finalizer :: FinalizerPtr Pcre2_compile_context

Compile context setters

valuepcre2_ERROR_BADDATA :: CInt

valuepcre2_set_bsr

:: Ptr Pcre2_compile_context
-> CUInt
See below for possible values.
-> IO CInt

valuepcre2_BSR_ANYCRLF :: CUInt

valuepcre2_BSR_UNICODE :: CUInt

valuepcre2_set_character_tables

valuepcre2_set_compile_extra_options

:: Ptr Pcre2_compile_context
-> CUInt
See "Extra compile options" below for possible bit flags.
-> IO CInt

valuepcre2_set_max_pattern_length

:: Ptr Pcre2_compile_context
-> PCRE2_SIZE
-> IO CInt

valuepcre2_set_newline

:: Ptr Pcre2_compile_context
-> CUInt
See below for possible values.
-> IO CInt

valuepcre2_NEWLINE_CR :: CUInt

valuepcre2_NEWLINE_LF :: CUInt

valuepcre2_NEWLINE_CRLF :: CUInt

valuepcre2_NEWLINE_ANY :: CUInt

valuepcre2_NEWLINE_ANYCRLF :: CUInt

valuepcre2_NEWLINE_NUL :: CUInt

valuepcre2_set_parens_nest_limit :: Ptr Pcre2_compile_context -> CUInt -> IO CInt

valuepcre2_set_compile_recursion_guard

:: Ptr Pcre2_compile_context
-> FunPtr (CUInt -> Ptr a -> IO CInt)
-> Ptr a
-> IO CInt

The match context

valuepcre2_match_context_create

:: Ptr Pcre2_general_context
-> IO (Ptr Pcre2_match_context)

valuepcre2_match_context_copy

:: Ptr Pcre2_match_context
-> IO (Ptr Pcre2_match_context)

valuepcre2_match_context_free :: Ptr Pcre2_match_context -> IO ()

valuepcre2_match_context_finalizer :: FinalizerPtr Pcre2_match_context

Match context setters

valuepcre2_set_callout

:: Ptr Pcre2_match_context
-> FunPtr (Ptr Pcre2_callout_block -> Ptr a -> IO CInt)
-> Ptr a
-> IO CInt

valuepcre2_set_substitute_callout

:: Ptr Pcre2_match_context
-> FunPtr (Ptr Pcre2_substitute_callout_block -> Ptr a -> IO CInt)
-> Ptr a
-> IO CInt

valuepcre2_set_offset_limit

:: Ptr Pcre2_match_context
-> PCRE2_SIZE
Can be unset. See below.
-> IO CInt

valuepcre2_UNSET :: PCRE2_SIZE

valuepcre2_set_heap_limit :: Ptr Pcre2_match_context -> CUInt -> IO CInt

valuepcre2_set_match_limit :: Ptr Pcre2_match_context -> CUInt -> IO CInt

valuepcre2_set_depth_limit :: Ptr Pcre2_match_context -> CUInt -> IO CInt

Checking build-time options

valuepcre2_config

:: CUInt
See below for possible values.
-> Ptr a
See the C API docs for what gets returned here.
-> IO CInt

valuepcre2_CONFIG_BSR :: CUInt

valuepcre2_CONFIG_COMPILED_WIDTHS :: CUInt

valuepcre2_CONFIG_DEPTHLIMIT :: CUInt

valuepcre2_CONFIG_EFFECTIVE_LINKSIZE :: CUInt

valuepcre2_CONFIG_HEAPLIMIT :: CUInt

valuepcre2_CONFIG_JIT :: CUInt

valuepcre2_CONFIG_JITTARGET :: CUInt

valuepcre2_CONFIG_LINKSIZE :: CUInt

valuepcre2_CONFIG_MATCHLIMIT :: CUInt

valuepcre2_CONFIG_NEWLINE :: CUInt

valuepcre2_CONFIG_NEVER_BACKSLASH_C :: CUInt

valuepcre2_CONFIG_PARENSLIMIT :: CUInt

valuepcre2_CONFIG_STACKRECURSE :: CUInt

valuepcre2_CONFIG_TABLES_LENGTH :: CUInt

valuepcre2_CONFIG_UNICODE_VERSION :: CUInt

valuepcre2_CONFIG_UNICODE :: CUInt

valuepcre2_CONFIG_VERSION :: CUInt

Compiling a pattern

valuepcre2_compile

:: PCRE2_SPTR
-> PCRE2_SIZE
Can be zero-terminated. See below.
-> CUInt
See "Main compile options" below for possible bit flags.
-> Ptr CInt
-> Ptr PCRE2_SIZE
-> Ptr Pcre2_compile_context
-> IO (Ptr Pcre2_code)

valuepcre2_ZERO_TERMINATED :: PCRE2_SIZE

valuepcre2_code_free :: Ptr Pcre2_code -> IO ()

valuepcre2_code_finalizer :: FinalizerPtr Pcre2_code

valuepcre2_code_copy :: Ptr Pcre2_code -> IO (Ptr Pcre2_code)

valuepcre2_code_copy_with_tables :: Ptr Pcre2_code -> IO (Ptr Pcre2_code)

Main compile options

valuepcre2_ANCHORED :: CUInt

valuepcre2_ALLOW_EMPTY_CLASS :: CUInt

valuepcre2_ALT_BSUX :: CUInt

valuepcre2_ALT_CIRCUMFLEX :: CUInt

valuepcre2_ALT_VERBNAMES :: CUInt

valuepcre2_AUTO_CALLOUT :: CUInt

valuepcre2_CASELESS :: CUInt

valuepcre2_DOLLAR_ENDONLY :: CUInt

valuepcre2_DOTALL :: CUInt

valuepcre2_DUPNAMES :: CUInt

valuepcre2_ENDANCHORED :: CUInt

valuepcre2_EXTENDED :: CUInt

valuepcre2_EXTENDED_MORE :: CUInt

valuepcre2_FIRSTLINE :: CUInt

valuepcre2_LITERAL :: CUInt

valuepcre2_MATCH_INVALID_UTF :: CUInt

valuepcre2_MATCH_UNSET_BACKREF :: CUInt

valuepcre2_MULTILINE :: CUInt

valuepcre2_NEVER_BACKSLASH_C :: CUInt

valuepcre2_NEVER_UCP :: CUInt

valuepcre2_NEVER_UTF :: CUInt

valuepcre2_NO_AUTO_CAPTURE :: CUInt

valuepcre2_NO_AUTO_POSSESS :: CUInt

valuepcre2_NO_DOTSTAR_ANCHOR :: CUInt

valuepcre2_NO_START_OPTIMIZE :: CUInt

valuepcre2_NO_UTF_CHECK :: CUInt

valuepcre2_UCP :: CUInt

valuepcre2_UNGREEDY :: CUInt

valuepcre2_USE_OFFSET_LIMIT :: CUInt

valuepcre2_UTF :: CUInt

Extra compile options

valuepcre2_EXTRA_ALLOW_SURROGATE_ESCAPES :: CUInt

valuepcre2_EXTRA_ALT_BSUX :: CUInt

valuepcre2_EXTRA_BAD_ESCAPE_IS_LITERAL :: CUInt

valuepcre2_EXTRA_ESCAPED_CR_IS_LF :: CUInt

valuepcre2_EXTRA_MATCH_LINE :: CUInt

valuepcre2_EXTRA_MATCH_WORD :: CUInt

Locale support

valuepcre2_maketables :: Ptr Pcre2_general_context -> IO (Ptr CUChar)

valuepcre2_maketables_free :: Ptr Pcre2_general_context -> Ptr CUChar -> IO ()

Information about a compiled pattern

valuepcre2_pattern_info

:: Ptr Pcre2_code
-> CUInt
See below for possible values.
-> Ptr a
-> IO CInt
See below for possible error values.

valuepcre2_INFO_ALLOPTIONS :: CUInt

valuepcre2_INFO_ARGOPTIONS :: CUInt

valuepcre2_INFO_EXTRAOPTIONS :: CUInt

valuepcre2_INFO_BACKREFMAX :: CUInt

valuepcre2_INFO_BSR :: CUInt

valuepcre2_INFO_CAPTURECOUNT :: CUInt

valuepcre2_INFO_DEPTHLIMIT :: CUInt

valuepcre2_INFO_FIRSTBITMAP :: CUInt

valuepcre2_INFO_FIRSTCODETYPE :: CUInt

valuepcre2_INFO_FIRSTCODEUNIT :: CUInt

valuepcre2_INFO_FRAMESIZE :: CUInt

valuepcre2_INFO_HASBACKSLASHC :: CUInt

valuepcre2_INFO_HASCRORLF :: CUInt

valuepcre2_INFO_HEAPLIMIT :: CUInt

valuepcre2_INFO_JCHANGED :: CUInt

valuepcre2_INFO_LASTCODETYPE :: CUInt

valuepcre2_INFO_LASTCODEUNIT :: CUInt

valuepcre2_INFO_MATCHEMPTY :: CUInt

valuepcre2_INFO_MATCHLIMIT :: CUInt

valuepcre2_INFO_MAXLOOKBEHIND :: CUInt

valuepcre2_INFO_MINLENGTH :: CUInt

valuepcre2_INFO_NAMECOUNT :: CUInt

valuepcre2_INFO_NAMEENTRYSIZE :: CUInt

valuepcre2_INFO_NAMETABLE :: CUInt

valuepcre2_INFO_NEWLINE :: CUInt

valuepcre2_INFO_SIZE :: CUInt

valuepcre2_ERROR_UNSET :: CInt

Duplicate capture group names

valuepcre2_substring_nametable_scan

:: Ptr Pcre2_code
-> PCRE2_SPTR
name
-> Ptr PCRE2_SPTR
first
-> Ptr PCRE2_SPTR
last
-> IO CInt

Callouts

valuepcre2_callout_enumerate

:: Ptr Pcre2_code
-> FunPtr (Ptr Pcre2_callout_enumerate_block -> Ptr a -> IO CInt)
-> Ptr a
-> IO CInt

Callout struct getters

These functions are not part of the official API; we provide them here. C API consumers are supposed to access struct fields directly, but the FFI cannot yet do that as of GHC 8.8.4.

`pcre2_callout_block`

valuepcre2_callout_block_version :: Ptr Pcre2_callout_block -> IO CUInt

valuepcre2_callout_block_callout_number :: Ptr Pcre2_callout_block -> IO CUInt

valuepcre2_callout_block_capture_top :: Ptr Pcre2_callout_block -> IO CUInt

valuepcre2_callout_block_capture_last :: Ptr Pcre2_callout_block -> IO CUInt

valuepcre2_callout_block_callout_flags :: Ptr Pcre2_callout_block -> IO CUInt

Source#

See below for possible bit flags.

valuepcre2_CALLOUT_STARTMATCH :: CUInt

valuepcre2_CALLOUT_BACKTRACK :: CUInt

valuepcre2_callout_block_offset_vector

:: Ptr Pcre2_callout_block
-> IO (Ptr PCRE2_SIZE)

valuepcre2_callout_block_mark :: Ptr Pcre2_callout_block -> IO PCRE2_SPTR

valuepcre2_callout_block_subject :: Ptr Pcre2_callout_block -> IO PCRE2_SPTR

valuepcre2_callout_block_subject_length

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_start_match :: Ptr Pcre2_callout_block -> IO PCRE2_SIZE

valuepcre2_callout_block_current_position

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_pattern_position

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_next_item_length

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_callout_string_offset

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_callout_string_length

:: Ptr Pcre2_callout_block
-> IO PCRE2_SIZE

valuepcre2_callout_block_callout_string

:: Ptr Pcre2_callout_block
-> IO PCRE2_SPTR

`pcre2_callout_enumerate_block`

valuepcre2_callout_enumerate_block_version

:: Ptr Pcre2_callout_enumerate_block
-> IO CUInt

valuepcre2_callout_enumerate_block_pattern_position

:: Ptr Pcre2_callout_enumerate_block
-> IO PCRE2_SIZE

valuepcre2_callout_enumerate_block_next_item_length

:: Ptr Pcre2_callout_enumerate_block
-> IO PCRE2_SIZE

valuepcre2_callout_enumerate_block_callout_number

:: Ptr Pcre2_callout_enumerate_block
-> IO CUInt

valuepcre2_callout_enumerate_block_callout_string_offset

:: Ptr Pcre2_callout_enumerate_block
-> IO PCRE2_SIZE

valuepcre2_callout_enumerate_block_callout_string_length

:: Ptr Pcre2_callout_enumerate_block
-> IO PCRE2_SIZE

valuepcre2_callout_enumerate_block_callout_string

:: Ptr Pcre2_callout_enumerate_block
-> IO PCRE2_SPTR

`pcre2_substitute_callout_block`

valuepcre2_substitute_callout_block_version

:: Ptr Pcre2_substitute_callout_block
-> IO CUInt

valuepcre2_substitute_callout_block_subscount

:: Ptr Pcre2_substitute_callout_block
-> IO CUInt

valuepcre2_substitute_callout_block_input

:: Ptr Pcre2_substitute_callout_block
-> IO PCRE2_SPTR

valuepcre2_substitute_callout_block_output

:: Ptr Pcre2_substitute_callout_block
-> IO PCRE2_SPTR

valuepcre2_substitute_callout_block_ovector

:: Ptr Pcre2_substitute_callout_block
-> IO (Ptr PCRE2_SIZE)

valuepcre2_substitute_callout_block_oveccount

:: Ptr Pcre2_substitute_callout_block
-> IO CUInt

valuepcre2_substitute_callout_block_output_offsets

:: Ptr Pcre2_substitute_callout_block
-> IO (Ptr PCRE2_SIZE)

Source#

Array of 2 (PCRE2_SIZE[2])

The match data block

valuepcre2_match_data_create

:: CUInt
ovecsize
-> Ptr Pcre2_general_context
-> IO (Ptr Pcre2_match_data)

valuepcre2_match_data_create_from_pattern

:: Ptr Pcre2_code
-> Ptr Pcre2_general_context
-> IO (Ptr Pcre2_match_data)

valuepcre2_match_data_free :: Ptr Pcre2_match_data -> IO ()

valuepcre2_match_data_finalizer :: FinalizerPtr Pcre2_match_data

Matching a pattern

valuepcre2_match

:: Ptr Pcre2_code
-> PCRE2_SPTR
subject
-> PCRE2_SIZE
length
-> PCRE2_SIZE
startoffset
-> CUInt
See below for possible bit flags.
-> Ptr Pcre2_match_data
-> Ptr Pcre2_match_context
-> IO CInt

Match options

valuepcre2_COPY_MATCHED_SUBJECT :: CUInt

valuepcre2_NOTBOL :: CUInt

valuepcre2_NOTEOL :: CUInt

valuepcre2_NOTEMPTY :: CUInt

valuepcre2_NOTEMPTY_ATSTART :: CUInt

valuepcre2_PARTIAL_HARD :: CUInt

valuepcre2_PARTIAL_SOFT :: CUInt

Match errors

valuepcre2_ERROR_NOMATCH :: CInt

valuepcre2_ERROR_PARTIAL :: CInt

valuepcre2_ERROR_BADMAGIC :: CInt

valuepcre2_ERROR_BADMODE :: CInt

valuepcre2_ERROR_BADOFFSET :: CInt

valuepcre2_ERROR_BADOPTION :: CInt

valuepcre2_ERROR_BADUTFOFFSET :: CInt

valuepcre2_ERROR_CALLOUT :: CInt

valuepcre2_ERROR_DEPTHLIMIT :: CInt

valuepcre2_ERROR_HEAPLIMIT :: CInt

valuepcre2_ERROR_INTERNAL :: CInt

valuepcre2_ERROR_MATCHLIMIT :: CInt

valuepcre2_ERROR_NOMEMORY :: CInt

valuepcre2_ERROR_NULL :: CInt

UTF-16-specific errors

valuepcre2_ERROR_UTF16_ERR1 :: CInt

Source#

"Missing low surrogate at end of string"

valuepcre2_ERROR_UTF16_ERR2 :: CInt

Source#

"Invalid low surrogate follows high surrogate"

valuepcre2_ERROR_UTF16_ERR3 :: CInt

Source#

"Isolated low surrogate"

DFA matching

valuepcre2_dfa_match

:: Ptr Pcre2_code
-> PCRE2_SPTR
subject
-> PCRE2_SIZE
length
-> PCRE2_SIZE
startoffset
-> CUInt
options
-> Ptr Pcre2_match_data
-> Ptr Pcre2_match_context
-> Ptr CInt
workspace
-> PCRE2_SIZE
wscount
-> IO CInt

DFA matching options

valuepcre2_DFA_SHORTEST :: CUInt

valuepcre2_DFA_RESTART :: CUInt

DFA matching errors

valuepcre2_ERROR_DFA_UFUNC :: CInt

valuepcre2_ERROR_DFA_UITEM :: CInt

valuepcre2_ERROR_DFA_UCOND :: CInt

valuepcre2_ERROR_DFA_UINVALID_UTF :: CInt

valuepcre2_ERROR_DFA_WSSIZE :: CInt

valuepcre2_ERROR_DFA_RECURSE :: CInt

valuepcre2_ERROR_DFA_BADRESTART :: CInt

Returned string and captured substrings

valuepcre2_get_ovector_count :: Ptr Pcre2_match_data -> IO CUInt

valuepcre2_get_ovector_pointer :: Ptr Pcre2_match_data -> IO (Ptr PCRE2_SIZE)

valuepcre2_substring_length_bynumber

:: Ptr Pcre2_match_data
-> CUInt
number
-> Ptr PCRE2_SIZE
length
-> IO CInt

valuepcre2_substring_copy_bynumber

:: Ptr Pcre2_match_data
-> CUInt
number
-> Ptr PCRE2_UCHAR
buffer
-> Ptr PCRE2_SIZE
bufflen
-> IO CInt

valuepcre2_substring_get_bynumber

:: Ptr Pcre2_match_data
-> CUInt
name
-> Ptr (Ptr PCRE2_UCHAR)
bufferptr
-> Ptr PCRE2_SIZE
bufflen
-> IO CInt

valuepcre2_substring_list_get

:: Ptr Pcre2_match_data
-> Ptr (Ptr (Ptr PCRE2_UCHAR))
listptr
-> Ptr (Ptr PCRE2_SIZE)
lengthsptr
-> IO CInt

valuepcre2_substring_list_free :: Ptr PCRE2_SPTR -> IO ()

valuepcre2_substring_number_from_name

:: Ptr Pcre2_code
-> PCRE2_SPTR
name
-> IO CInt

valuepcre2_substring_length_byname

:: Ptr Pcre2_match_data
-> PCRE2_SPTR
name
-> Ptr PCRE2_SIZE
length
-> IO CInt

valuepcre2_substring_copy_byname

:: Ptr Pcre2_match_data
-> PCRE2_SPTR
name
-> Ptr PCRE2_UCHAR
buffer
-> Ptr PCRE2_SIZE
bufflen
-> IO CInt

valuepcre2_substring_get_byname

:: Ptr Pcre2_match_data
-> PCRE2_SPTR
name
-> Ptr (Ptr PCRE2_UCHAR)
bufferptr
-> Ptr PCRE2_SIZE
bufflen
-> IO CInt

valuepcre2_substring_free :: Ptr PCRE2_UCHAR -> IO ()

valuepcre2_ERROR_NOSUBSTRING :: CInt

valuepcre2_ERROR_NOUNIQUESUBSTRING :: CInt

valuepcre2_ERROR_UNAVAILABLE :: CInt

Creating a new string with substitutions

valuepcre2_substitute

:: Ptr Pcre2_code
-> PCRE2_SPTR
subject
-> PCRE2_SIZE
length
-> PCRE2_SIZE
startoffset
-> CUInt
options
-> Ptr Pcre2_match_data
-> Ptr Pcre2_match_context
-> PCRE2_SPTR
replacement
-> PCRE2_SIZE
rlength
-> Ptr PCRE2_UCHAR
outputbuffer
-> Ptr PCRE2_SIZE
outlengthptr
-> IO CInt

Substitution options

valuepcre2_SUBSTITUTE_REPLACEMENT_ONLY :: CUInt

valuepcre2_SUBSTITUTE_GLOBAL :: CUInt

valuepcre2_SUBSTITUTE_MATCHED :: CUInt

valuepcre2_SUBSTITUTE_OVERFLOW_LENGTH :: CUInt

valuepcre2_SUBSTITUTE_LITERAL :: CUInt

valuepcre2_SUBSTITUTE_UNKNOWN_UNSET :: CUInt

valuepcre2_SUBSTITUTE_UNSET_EMPTY :: CUInt

valuepcre2_SUBSTITUTE_EXTENDED :: CUInt

Substitution errors

valuepcre2_ERROR_BADREPLACEMENT :: CInt

valuepcre2_ERROR_BADREPESCAPE :: CInt

valuepcre2_ERROR_BADSUBSTITUTION :: CInt

valuepcre2_ERROR_BADSUBSPATTERN :: CInt

Other information about a match

valuepcre2_get_mark :: Ptr Pcre2_match_data -> IO PCRE2_SPTR

valuepcre2_get_startchar :: Ptr Pcre2_match_data -> IO PCRE2_SIZE

Obtaining a textual error message

valuepcre2_get_error_message :: CInt -> Ptr PCRE2_UCHAR -> PCRE2_SIZE -> IO CInt

Iterating over all matches

valuepcre2_next_match

Pattern serialization

valuepcre2_serialize_decode

:: Ptr (Ptr Pcre2_code)
codes
-> CInt
number of codes
-> Ptr CUInt
bytes
-> Ptr Pcre2_general_context
-> IO CInt

valuepcre2_serialize_encode

:: Ptr (Ptr Pcre2_code)
codes
-> CInt
number of codes
-> Ptr (Ptr CUInt)
serialized bytes
-> Ptr PCRE2_SIZE
serialized size
-> Ptr Pcre2_general_context
-> IO CInt

valuepcre2_serialize_free :: Ptr CUChar -> IO ()

valuepcre2_serialize_get_number_of_codes :: Ptr CUChar -> IO CInt

valuepcre2_ERROR_BADSERIALIZEDDATA :: CInt

valuepcre2_ERROR_MIXEDTABLES :: CInt