Text.Regex.Pcre2.Foreign · pcre2-2.3.1

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

#

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)

#

Array of 2 (PCRE2_SIZE[2])

The match data block

4 declarations

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

1 declaration

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

#

"Missing low surrogate at end of string"

valuepcre2_ERROR_UTF16_ERR2 :: CInt

#

"Invalid low surrogate follows high surrogate"

valuepcre2_ERROR_UTF16_ERR3 :: CInt

#

"Isolated low surrogate"

DFA matching

1 declaration

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

15 declarations

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

1 declaration

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

2 declarations

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

1 declaration

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

#

Iterating over all matches

1 declaration

valuepcre2_next_match

#

Pattern serialization

6 declarations

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

#