GI.HarfBuzz.Callbacks

Signals

BufferMessageFuncT

type BufferMessageFuncT

Arguments

 = BufferT

buffer: An BufferT to work upon

-> FontT

font: The FontT the buffer is shaped with

-> Text

message: Nothing-terminated message passed to the function

-> IO Int32

Returns: true to perform the shaping step, false to skip it.

A callback method for BufferT. The method gets called with the BufferT it was set on, the FontT the buffer is shaped with and a message describing what step of the shaping process will be performed. Returning false from this method will skip this shaping step and move to the next one.

Since: 1.1.3

type BufferMessageFuncT_WithClosures

Arguments

 = BufferT

buffer: An BufferT to work upon

-> FontT

font: The FontT the buffer is shaped with

-> Text

message: Nothing-terminated message passed to the function

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Int32

Returns: true to perform the shaping step, false to skip it.

A callback method for BufferT. The method gets called with the BufferT it was set on, the FontT the buffer is shaped with and a message describing what step of the shaping process will be performed. Returning false from this method will skip this shaping step and move to the next one.

Since: 1.1.3

type C_BufferMessageFuncT = Ptr BufferT -> Ptr FontT -> CString -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

drop_closures_BufferMessageFuncT :: BufferMessageFuncT -> BufferMessageFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_BufferMessageFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_BufferMessageFuncT

-> BufferT

buffer: An BufferT to work upon

-> FontT

font: The FontT the buffer is shaped with

-> Text

message: Nothing-terminated message passed to the function

-> Ptr ()

userData: User data pointer passed by the caller

-> m Int32

Returns: true to perform the shaping step, false to skip it.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_BufferMessageFuncT :: MonadIO m => BufferMessageFuncT -> m (GClosure C_BufferMessageFuncT)

Wrap the callback into a GClosure.

mk_BufferMessageFuncT :: C_BufferMessageFuncT -> IO (FunPtr C_BufferMessageFuncT)

Generate a function pointer callable from C code, from a C_BufferMessageFuncT.

noBufferMessageFuncT :: Maybe BufferMessageFuncT

A convenience synonym for Nothing :: Maybe BufferMessageFuncT.

noBufferMessageFuncT_WithClosures :: Maybe BufferMessageFuncT_WithClosures

A convenience synonym for Nothing :: Maybe BufferMessageFuncT_WithClosures.

wrap_BufferMessageFuncT :: Maybe (Ptr (FunPtr C_BufferMessageFuncT)) -> BufferMessageFuncT_WithClosures -> C_BufferMessageFuncT

Wrap a BufferMessageFuncT into a C_BufferMessageFuncT.

DestroyFuncT

type C_DestroyFuncT = Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DestroyFuncT = IO ()

A virtual method for destroy user-data callbacks.

type DestroyFuncT_WithClosures

Arguments

 = Ptr ()

userData: the data to be destroyed

-> IO ()

A virtual method for destroy user-data callbacks.

drop_closures_DestroyFuncT :: DestroyFuncT -> DestroyFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_DestroyFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_DestroyFuncT

-> Ptr ()

userData: the data to be destroyed

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_DestroyFuncT :: MonadIO m => DestroyFuncT -> m (GClosure C_DestroyFuncT)

Wrap the callback into a GClosure.

mk_DestroyFuncT :: C_DestroyFuncT -> IO (FunPtr C_DestroyFuncT)

Generate a function pointer callable from C code, from a C_DestroyFuncT.

noDestroyFuncT :: Maybe DestroyFuncT

A convenience synonym for Nothing :: Maybe DestroyFuncT.

noDestroyFuncT_WithClosures :: Maybe DestroyFuncT_WithClosures

A convenience synonym for Nothing :: Maybe DestroyFuncT_WithClosures.

wrap_DestroyFuncT :: Maybe (Ptr (FunPtr C_DestroyFuncT)) -> DestroyFuncT_WithClosures -> C_DestroyFuncT

Wrap a DestroyFuncT into a C_DestroyFuncT.

FontGetGlyphAdvanceFuncT

type C_FontGetGlyphAdvanceFuncT = Ptr FontT -> Ptr () -> Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphAdvanceFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> IO Int32

Returns: The advance of glyph within font

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the advance for a specified glyph. The method must return an hb_position_t.

type FontGetGlyphAdvanceFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Int32

Returns: The advance of glyph within font

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the advance for a specified glyph. The method must return an hb_position_t.

drop_closures_FontGetGlyphAdvanceFuncT :: FontGetGlyphAdvanceFuncT -> FontGetGlyphAdvanceFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphAdvanceFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphAdvanceFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m Int32

Returns: The advance of glyph within font

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphAdvanceFuncT :: MonadIO m => FontGetGlyphAdvanceFuncT -> m (GClosure C_FontGetGlyphAdvanceFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphAdvanceFuncT :: C_FontGetGlyphAdvanceFuncT -> IO (FunPtr C_FontGetGlyphAdvanceFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphAdvanceFuncT.

noFontGetGlyphAdvanceFuncT :: Maybe FontGetGlyphAdvanceFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphAdvanceFuncT.

noFontGetGlyphAdvanceFuncT_WithClosures :: Maybe FontGetGlyphAdvanceFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphAdvanceFuncT_WithClosures.

wrap_FontGetGlyphAdvanceFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphAdvanceFuncT)) -> FontGetGlyphAdvanceFuncT_WithClosures -> C_FontGetGlyphAdvanceFuncT

Wrap a FontGetGlyphAdvanceFuncT into a C_FontGetGlyphAdvanceFuncT.

FontGetGlyphAdvancesFuncT

type C_FontGetGlyphAdvancesFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Word32 -> Ptr Int32 -> Word32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FontGetGlyphAdvancesFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: The number of glyph IDs in the sequence queried

-> Word32

firstGlyph: The first glyph ID to query

-> Word32

glyphStride: The stride between successive glyph IDs

-> Word32

advanceStride: The stride between successive advances

-> IO Int32

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the advances for a sequence of glyphs.

type FontGetGlyphAdvancesFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: The number of glyph IDs in the sequence queried

-> Word32

firstGlyph: The first glyph ID to query

-> Word32

glyphStride: The stride between successive glyph IDs

-> Word32

advanceStride: The stride between successive advances

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Int32

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the advances for a sequence of glyphs.

drop_closures_FontGetGlyphAdvancesFuncT :: FontGetGlyphAdvancesFuncT -> FontGetGlyphAdvancesFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphAdvancesFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphAdvancesFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: The number of glyph IDs in the sequence queried

-> Word32

firstGlyph: The first glyph ID to query

-> Word32

glyphStride: The stride between successive glyph IDs

-> Word32

advanceStride: The stride between successive advances

-> Ptr ()

userData: User data pointer passed by the caller

-> m Int32

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphAdvancesFuncT :: MonadIO m => FontGetGlyphAdvancesFuncT -> m (GClosure C_FontGetGlyphAdvancesFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphAdvancesFuncT :: C_FontGetGlyphAdvancesFuncT -> IO (FunPtr C_FontGetGlyphAdvancesFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphAdvancesFuncT.

noFontGetGlyphAdvancesFuncT :: Maybe FontGetGlyphAdvancesFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphAdvancesFuncT.

noFontGetGlyphAdvancesFuncT_WithClosures :: Maybe FontGetGlyphAdvancesFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphAdvancesFuncT_WithClosures.

wrap_FontGetGlyphAdvancesFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphAdvancesFuncT)) -> FontGetGlyphAdvancesFuncT_WithClosures -> C_FontGetGlyphAdvancesFuncT

Wrap a FontGetGlyphAdvancesFuncT into a C_FontGetGlyphAdvancesFuncT.

FontGetGlyphContourPointFuncT

type C_FontGetGlyphContourPointFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Ptr Int32 -> Ptr Int32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphContourPointFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Word32

pointIndex: The contour-point index to query

-> IO (Int32, Int32, Int32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the (X,Y) coordinates (in font units) for a specified contour point in a glyph. Each coordinate must be returned as an hb_position_t output parameter.

type FontGetGlyphContourPointFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Word32

pointIndex: The contour-point index to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Int32, Int32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the (X,Y) coordinates (in font units) for a specified contour point in a glyph. Each coordinate must be returned as an hb_position_t output parameter.

drop_closures_FontGetGlyphContourPointFuncT :: FontGetGlyphContourPointFuncT -> FontGetGlyphContourPointFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphContourPointFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphContourPointFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Word32

pointIndex: The contour-point index to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Int32, Int32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphContourPointFuncT :: MonadIO m => FontGetGlyphContourPointFuncT -> m (GClosure C_FontGetGlyphContourPointFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphContourPointFuncT :: C_FontGetGlyphContourPointFuncT -> IO (FunPtr C_FontGetGlyphContourPointFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphContourPointFuncT.

noFontGetGlyphContourPointFuncT :: Maybe FontGetGlyphContourPointFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphContourPointFuncT.

noFontGetGlyphContourPointFuncT_WithClosures :: Maybe FontGetGlyphContourPointFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphContourPointFuncT_WithClosures.

wrap_FontGetGlyphContourPointFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphContourPointFuncT)) -> FontGetGlyphContourPointFuncT_WithClosures -> C_FontGetGlyphContourPointFuncT

Wrap a FontGetGlyphContourPointFuncT into a C_FontGetGlyphContourPointFuncT.

FontGetGlyphFromNameFuncT

type C_FontGetGlyphFromNameFuncT = Ptr FontT -> Ptr () -> Ptr CString -> Int32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphFromNameFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> [Text]

name: The name string to query

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID that corresponds to a glyph-name string.

type FontGetGlyphFromNameFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> [Text]

name: The name string to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID that corresponds to a glyph-name string.

drop_closures_FontGetGlyphFromNameFuncT :: FontGetGlyphFromNameFuncT -> FontGetGlyphFromNameFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphFromNameFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphFromNameFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> [Text]

name: The name string to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Word32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphFromNameFuncT :: MonadIO m => FontGetGlyphFromNameFuncT -> m (GClosure C_FontGetGlyphFromNameFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphFromNameFuncT :: C_FontGetGlyphFromNameFuncT -> IO (FunPtr C_FontGetGlyphFromNameFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphFromNameFuncT.

noFontGetGlyphFromNameFuncT :: Maybe FontGetGlyphFromNameFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphFromNameFuncT.

noFontGetGlyphFromNameFuncT_WithClosures :: Maybe FontGetGlyphFromNameFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphFromNameFuncT_WithClosures.

wrap_FontGetGlyphFromNameFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphFromNameFuncT)) -> FontGetGlyphFromNameFuncT_WithClosures -> C_FontGetGlyphFromNameFuncT

Wrap a FontGetGlyphFromNameFuncT into a C_FontGetGlyphFromNameFuncT.

FontGetGlyphFuncT

type C_FontGetGlyphFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

Deprecated: (Since version 1.2.3)

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID for a specified Unicode code point font, with an optional variation selector.

type FontGetGlyphFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID for a specified Unicode code point font, with an optional variation selector.

drop_closures_FontGetGlyphFuncT :: FontGetGlyphFuncT -> FontGetGlyphFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Word32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphFuncT :: MonadIO m => FontGetGlyphFuncT -> m (GClosure C_FontGetGlyphFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphFuncT :: C_FontGetGlyphFuncT -> IO (FunPtr C_FontGetGlyphFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphFuncT.

noFontGetGlyphFuncT :: Maybe FontGetGlyphFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphFuncT.

noFontGetGlyphFuncT_WithClosures :: Maybe FontGetGlyphFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphFuncT_WithClosures.

wrap_FontGetGlyphFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphFuncT)) -> FontGetGlyphFuncT_WithClosures -> C_FontGetGlyphFuncT

Wrap a FontGetGlyphFuncT into a C_FontGetGlyphFuncT.

FontGetGlyphKerningFuncT

type C_FontGetGlyphKerningFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphKerningFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

firstGlyph: The glyph ID of the first glyph in the glyph pair

-> Word32

secondGlyph: The glyph ID of the second glyph in the glyph pair

-> IO Int32

This method should retrieve the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.

type FontGetGlyphKerningFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

firstGlyph: The glyph ID of the first glyph in the glyph pair

-> Word32

secondGlyph: The glyph ID of the second glyph in the glyph pair

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Int32

This method should retrieve the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.

drop_closures_FontGetGlyphKerningFuncT :: FontGetGlyphKerningFuncT -> FontGetGlyphKerningFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphKerningFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphKerningFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

firstGlyph: The glyph ID of the first glyph in the glyph pair

-> Word32

secondGlyph: The glyph ID of the second glyph in the glyph pair

-> Ptr ()

userData: User data pointer passed by the caller

-> m Int32

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphKerningFuncT :: MonadIO m => FontGetGlyphKerningFuncT -> m (GClosure C_FontGetGlyphKerningFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphKerningFuncT :: C_FontGetGlyphKerningFuncT -> IO (FunPtr C_FontGetGlyphKerningFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphKerningFuncT.

noFontGetGlyphKerningFuncT :: Maybe FontGetGlyphKerningFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphKerningFuncT.

noFontGetGlyphKerningFuncT_WithClosures :: Maybe FontGetGlyphKerningFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphKerningFuncT_WithClosures.

wrap_FontGetGlyphKerningFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphKerningFuncT)) -> FontGetGlyphKerningFuncT_WithClosures -> C_FontGetGlyphKerningFuncT

Wrap a FontGetGlyphKerningFuncT into a C_FontGetGlyphKerningFuncT.

FontGetGlyphNameFuncT

type C_FontGetGlyphNameFuncT = Ptr FontT -> Ptr () -> Word32 -> Ptr (Ptr CString) -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphNameFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> IO (Int32, [Text])

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph name that corresponds to a glyph ID. The name should be returned in a string output parameter.

type FontGetGlyphNameFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, [Text])

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph name that corresponds to a glyph ID. The name should be returned in a string output parameter.

drop_closures_FontGetGlyphNameFuncT :: FontGetGlyphNameFuncT -> FontGetGlyphNameFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphNameFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphNameFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, [Text])

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphNameFuncT :: MonadIO m => FontGetGlyphNameFuncT -> m (GClosure C_FontGetGlyphNameFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphNameFuncT :: C_FontGetGlyphNameFuncT -> IO (FunPtr C_FontGetGlyphNameFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphNameFuncT.

noFontGetGlyphNameFuncT :: Maybe FontGetGlyphNameFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphNameFuncT.

noFontGetGlyphNameFuncT_WithClosures :: Maybe FontGetGlyphNameFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphNameFuncT_WithClosures.

wrap_FontGetGlyphNameFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphNameFuncT)) -> FontGetGlyphNameFuncT_WithClosures -> C_FontGetGlyphNameFuncT

Wrap a FontGetGlyphNameFuncT into a C_FontGetGlyphNameFuncT.

FontGetGlyphOriginFuncT

type C_FontGetGlyphOriginFuncT = Ptr FontT -> Ptr () -> Word32 -> Ptr Int32 -> Ptr Int32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetGlyphOriginFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> IO (Int32, Int32, Int32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph. Each coordinate must be returned in an hb_position_t output parameter.

type FontGetGlyphOriginFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Int32, Int32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph. Each coordinate must be returned in an hb_position_t output parameter.

drop_closures_FontGetGlyphOriginFuncT :: FontGetGlyphOriginFuncT -> FontGetGlyphOriginFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetGlyphOriginFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetGlyphOriginFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

glyph: The glyph ID to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Int32, Int32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetGlyphOriginFuncT :: MonadIO m => FontGetGlyphOriginFuncT -> m (GClosure C_FontGetGlyphOriginFuncT)

Wrap the callback into a GClosure.

mk_FontGetGlyphOriginFuncT :: C_FontGetGlyphOriginFuncT -> IO (FunPtr C_FontGetGlyphOriginFuncT)

Generate a function pointer callable from C code, from a C_FontGetGlyphOriginFuncT.

noFontGetGlyphOriginFuncT :: Maybe FontGetGlyphOriginFuncT

A convenience synonym for Nothing :: Maybe FontGetGlyphOriginFuncT.

noFontGetGlyphOriginFuncT_WithClosures :: Maybe FontGetGlyphOriginFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetGlyphOriginFuncT_WithClosures.

wrap_FontGetGlyphOriginFuncT :: Maybe (Ptr (FunPtr C_FontGetGlyphOriginFuncT)) -> FontGetGlyphOriginFuncT_WithClosures -> C_FontGetGlyphOriginFuncT

Wrap a FontGetGlyphOriginFuncT into a C_FontGetGlyphOriginFuncT.

FontGetNominalGlyphFuncT

type C_FontGetNominalGlyphFuncT = Ptr FontT -> Ptr () -> Word32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetNominalGlyphFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the nominal glyph ID for a specified Unicode code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

type FontGetNominalGlyphFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the nominal glyph ID for a specified Unicode code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

drop_closures_FontGetNominalGlyphFuncT :: FontGetNominalGlyphFuncT -> FontGetNominalGlyphFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetNominalGlyphFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetNominalGlyphFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Word32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetNominalGlyphFuncT :: MonadIO m => FontGetNominalGlyphFuncT -> m (GClosure C_FontGetNominalGlyphFuncT)

Wrap the callback into a GClosure.

mk_FontGetNominalGlyphFuncT :: C_FontGetNominalGlyphFuncT -> IO (FunPtr C_FontGetNominalGlyphFuncT)

Generate a function pointer callable from C code, from a C_FontGetNominalGlyphFuncT.

noFontGetNominalGlyphFuncT :: Maybe FontGetNominalGlyphFuncT

A convenience synonym for Nothing :: Maybe FontGetNominalGlyphFuncT.

noFontGetNominalGlyphFuncT_WithClosures :: Maybe FontGetNominalGlyphFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetNominalGlyphFuncT_WithClosures.

wrap_FontGetNominalGlyphFuncT :: Maybe (Ptr (FunPtr C_FontGetNominalGlyphFuncT)) -> FontGetNominalGlyphFuncT_WithClosures -> C_FontGetNominalGlyphFuncT

Wrap a FontGetNominalGlyphFuncT into a C_FontGetNominalGlyphFuncT.

FontGetNominalGlyphsFuncT

type C_FontGetNominalGlyphsFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Word32 -> Ptr Word32 -> Word32 -> Ptr () -> IO Word32

Type for the callback on the (unwrapped) C side.

type FontGetNominalGlyphsFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: number of code points to query

-> Word32

firstUnicode: The first Unicode code point to query

-> Word32

unicodeStride: The stride between successive code points

-> Word32

glyphStride: The stride between successive glyph IDs

-> IO (Word32, Word32)

Returns: the number of code points processed

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the nominal glyph IDs for a sequence of Unicode code points. Glyph IDs must be returned in a hb_codepoint_t output parameter.

type FontGetNominalGlyphsFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: number of code points to query

-> Word32

firstUnicode: The first Unicode code point to query

-> Word32

unicodeStride: The stride between successive code points

-> Word32

glyphStride: The stride between successive glyph IDs

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Word32, Word32)

Returns: the number of code points processed

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the nominal glyph IDs for a sequence of Unicode code points. Glyph IDs must be returned in a hb_codepoint_t output parameter.

drop_closures_FontGetNominalGlyphsFuncT :: FontGetNominalGlyphsFuncT -> FontGetNominalGlyphsFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetNominalGlyphsFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetNominalGlyphsFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

count: number of code points to query

-> Word32

firstUnicode: The first Unicode code point to query

-> Word32

unicodeStride: The stride between successive code points

-> Word32

glyphStride: The stride between successive glyph IDs

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Word32, Word32)

Returns: the number of code points processed

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetNominalGlyphsFuncT :: MonadIO m => FontGetNominalGlyphsFuncT -> m (GClosure C_FontGetNominalGlyphsFuncT)

Wrap the callback into a GClosure.

mk_FontGetNominalGlyphsFuncT :: C_FontGetNominalGlyphsFuncT -> IO (FunPtr C_FontGetNominalGlyphsFuncT)

Generate a function pointer callable from C code, from a C_FontGetNominalGlyphsFuncT.

noFontGetNominalGlyphsFuncT :: Maybe FontGetNominalGlyphsFuncT

A convenience synonym for Nothing :: Maybe FontGetNominalGlyphsFuncT.

noFontGetNominalGlyphsFuncT_WithClosures :: Maybe FontGetNominalGlyphsFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetNominalGlyphsFuncT_WithClosures.

wrap_FontGetNominalGlyphsFuncT :: Maybe (Ptr (FunPtr C_FontGetNominalGlyphsFuncT)) -> FontGetNominalGlyphsFuncT_WithClosures -> C_FontGetNominalGlyphsFuncT

Wrap a FontGetNominalGlyphsFuncT into a C_FontGetNominalGlyphsFuncT.

FontGetVariationGlyphFuncT

type C_FontGetVariationGlyphFuncT = Ptr FontT -> Ptr () -> Word32 -> Word32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type FontGetVariationGlyphFuncT

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID for a specified Unicode code point followed by a specified Variation Selector code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

type FontGetVariationGlyphFuncT_WithClosures

Arguments

 = FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO (Int32, Word32)

Returns: true if data found, false otherwise

A virtual method for the FontFuncsT of an FontT object.

This method should retrieve the glyph ID for a specified Unicode code point followed by a specified Variation Selector code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

drop_closures_FontGetVariationGlyphFuncT :: FontGetVariationGlyphFuncT -> FontGetVariationGlyphFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_FontGetVariationGlyphFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_FontGetVariationGlyphFuncT

-> FontT

font: FontT to work upon

-> Ptr ()

fontData: font user data pointer

-> Word32

unicode: The Unicode code point to query

-> Word32

variationSelector: The variation-selector code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m (Int32, Word32)

Returns: true if data found, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_FontGetVariationGlyphFuncT :: MonadIO m => FontGetVariationGlyphFuncT -> m (GClosure C_FontGetVariationGlyphFuncT)

Wrap the callback into a GClosure.

mk_FontGetVariationGlyphFuncT :: C_FontGetVariationGlyphFuncT -> IO (FunPtr C_FontGetVariationGlyphFuncT)

Generate a function pointer callable from C code, from a C_FontGetVariationGlyphFuncT.

noFontGetVariationGlyphFuncT :: Maybe FontGetVariationGlyphFuncT

A convenience synonym for Nothing :: Maybe FontGetVariationGlyphFuncT.

noFontGetVariationGlyphFuncT_WithClosures :: Maybe FontGetVariationGlyphFuncT_WithClosures

A convenience synonym for Nothing :: Maybe FontGetVariationGlyphFuncT_WithClosures.

wrap_FontGetVariationGlyphFuncT :: Maybe (Ptr (FunPtr C_FontGetVariationGlyphFuncT)) -> FontGetVariationGlyphFuncT_WithClosures -> C_FontGetVariationGlyphFuncT

Wrap a FontGetVariationGlyphFuncT into a C_FontGetVariationGlyphFuncT.

ReferenceTableFuncT

type C_ReferenceTableFuncT = Ptr FaceT -> Word32 -> Ptr () -> IO (Ptr BlobT)

Type for the callback on the (unwrapped) C side.

type ReferenceTableFuncT

Arguments

 = FaceT

face: an FaceT to reference table for

-> Word32

tag: the tag of the table to reference

-> IO BlobT

Returns: A pointer to the tag table within face

Callback function for faceCreateForTables.

Since: 0.9.2

type ReferenceTableFuncT_WithClosures

Arguments

 = FaceT

face: an FaceT to reference table for

-> Word32

tag: the tag of the table to reference

-> Ptr ()

userData: User data pointer passed by the caller

-> IO BlobT

Returns: A pointer to the tag table within face

Callback function for faceCreateForTables.

Since: 0.9.2

drop_closures_ReferenceTableFuncT :: ReferenceTableFuncT -> ReferenceTableFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_ReferenceTableFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_ReferenceTableFuncT

-> FaceT

face: an FaceT to reference table for

-> Word32

tag: the tag of the table to reference

-> Ptr ()

userData: User data pointer passed by the caller

-> m BlobT

Returns: A pointer to the tag table within face

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_ReferenceTableFuncT :: MonadIO m => ReferenceTableFuncT -> m (GClosure C_ReferenceTableFuncT)

Wrap the callback into a GClosure.

mk_ReferenceTableFuncT :: C_ReferenceTableFuncT -> IO (FunPtr C_ReferenceTableFuncT)

Generate a function pointer callable from C code, from a C_ReferenceTableFuncT.

noReferenceTableFuncT :: Maybe ReferenceTableFuncT

A convenience synonym for Nothing :: Maybe ReferenceTableFuncT.

noReferenceTableFuncT_WithClosures :: Maybe ReferenceTableFuncT_WithClosures

A convenience synonym for Nothing :: Maybe ReferenceTableFuncT_WithClosures.

wrap_ReferenceTableFuncT :: Maybe (Ptr (FunPtr C_ReferenceTableFuncT)) -> ReferenceTableFuncT_WithClosures -> C_ReferenceTableFuncT

Wrap a ReferenceTableFuncT into a C_ReferenceTableFuncT.

UnicodeCombiningClassFuncT

type C_UnicodeCombiningClassFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr () -> IO CUInt

Type for the callback on the (unwrapped) C side.

type UnicodeCombiningClassFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> IO UnicodeCombiningClassT

Returns: The UnicodeCombiningClassT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Canonical Combining Class (ccc) property for a specified Unicode code point.

type UnicodeCombiningClassFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO UnicodeCombiningClassT

Returns: The UnicodeCombiningClassT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Canonical Combining Class (ccc) property for a specified Unicode code point.

drop_closures_UnicodeCombiningClassFuncT :: UnicodeCombiningClassFuncT -> UnicodeCombiningClassFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeCombiningClassFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeCombiningClassFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m UnicodeCombiningClassT

Returns: The UnicodeCombiningClassT of unicode

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeCombiningClassFuncT :: MonadIO m => UnicodeCombiningClassFuncT -> m (GClosure C_UnicodeCombiningClassFuncT)

Wrap the callback into a GClosure.

mk_UnicodeCombiningClassFuncT :: C_UnicodeCombiningClassFuncT -> IO (FunPtr C_UnicodeCombiningClassFuncT)

Generate a function pointer callable from C code, from a C_UnicodeCombiningClassFuncT.

noUnicodeCombiningClassFuncT :: Maybe UnicodeCombiningClassFuncT

A convenience synonym for Nothing :: Maybe UnicodeCombiningClassFuncT.

noUnicodeCombiningClassFuncT_WithClosures :: Maybe UnicodeCombiningClassFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeCombiningClassFuncT_WithClosures.

wrap_UnicodeCombiningClassFuncT :: Maybe (Ptr (FunPtr C_UnicodeCombiningClassFuncT)) -> UnicodeCombiningClassFuncT_WithClosures -> C_UnicodeCombiningClassFuncT

Wrap a UnicodeCombiningClassFuncT into a C_UnicodeCombiningClassFuncT.

UnicodeComposeFuncT

type C_UnicodeComposeFuncT = Ptr UnicodeFuncsT -> Word32 -> Word32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type UnicodeComposeFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

a: The first code point to compose

-> Word32

b: The second code point to compose

-> IO (Int32, Word32)

Returns: true is a,b composed, false otherwise

A virtual method for the UnicodeFuncsT structure.

This method should compose a sequence of two input Unicode code points by canonical equivalence, returning the composed code point in a hb_codepoint_t output parameter (if successful). The method must return an hb_bool_t indicating the success of the composition.

type UnicodeComposeFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

a: The first code point to compose

-> Word32

b: The second code point to compose

-> Ptr ()

userData: user data pointer passed by the caller

-> IO (Int32, Word32)

Returns: true is a,b composed, false otherwise

A virtual method for the UnicodeFuncsT structure.

This method should compose a sequence of two input Unicode code points by canonical equivalence, returning the composed code point in a hb_codepoint_t output parameter (if successful). The method must return an hb_bool_t indicating the success of the composition.

drop_closures_UnicodeComposeFuncT :: UnicodeComposeFuncT -> UnicodeComposeFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeComposeFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeComposeFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

a: The first code point to compose

-> Word32

b: The second code point to compose

-> Ptr ()

userData: user data pointer passed by the caller

-> m (Int32, Word32)

Returns: true is a,b composed, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeComposeFuncT :: MonadIO m => UnicodeComposeFuncT -> m (GClosure C_UnicodeComposeFuncT)

Wrap the callback into a GClosure.

mk_UnicodeComposeFuncT :: C_UnicodeComposeFuncT -> IO (FunPtr C_UnicodeComposeFuncT)

Generate a function pointer callable from C code, from a C_UnicodeComposeFuncT.

noUnicodeComposeFuncT :: Maybe UnicodeComposeFuncT

A convenience synonym for Nothing :: Maybe UnicodeComposeFuncT.

noUnicodeComposeFuncT_WithClosures :: Maybe UnicodeComposeFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeComposeFuncT_WithClosures.

wrap_UnicodeComposeFuncT :: Maybe (Ptr (FunPtr C_UnicodeComposeFuncT)) -> UnicodeComposeFuncT_WithClosures -> C_UnicodeComposeFuncT

Wrap a UnicodeComposeFuncT into a C_UnicodeComposeFuncT.

UnicodeDecomposeCompatibilityFuncT

type C_UnicodeDecomposeCompatibilityFuncT = Ptr UnicodeFuncsT -> Word32 -> Word32 -> Ptr () -> IO Word32

Type for the callback on the (unwrapped) C side.

type UnicodeDecomposeCompatibilityFuncT

Arguments

 = UnicodeFuncsT

ufuncs: a Unicode function structure

-> Word32

u: codepoint to decompose

-> Word32

decomposed: address of codepoint array (of length UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into

-> IO Word32

Returns: number of codepoints in the full compatibility decomposition of u, or 0 if no decomposition available.

Deprecated: (Since version 2.0.0)

Fully decompose u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to decomposed. The complete length of the decomposition will be returned.

If u has no compatibility decomposition, zero should be returned.

The Unicode standard guarantees that a buffer of length UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any compatibility decomposition plus an terminating value of 0. Consequently, decompose must be allocated by the caller to be at least this length. Implementations of this function type must ensure that they do not write past the provided array.

type UnicodeDecomposeCompatibilityFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: a Unicode function structure

-> Word32

u: codepoint to decompose

-> Word32

decomposed: address of codepoint array (of length UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into

-> Ptr ()

userData: user data pointer as passed to unicodeFuncsSetDecomposeCompatibilityFunc

-> IO Word32

Returns: number of codepoints in the full compatibility decomposition of u, or 0 if no decomposition available.

Fully decompose u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to decomposed. The complete length of the decomposition will be returned.

If u has no compatibility decomposition, zero should be returned.

The Unicode standard guarantees that a buffer of length UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any compatibility decomposition plus an terminating value of 0. Consequently, decompose must be allocated by the caller to be at least this length. Implementations of this function type must ensure that they do not write past the provided array.

drop_closures_UnicodeDecomposeCompatibilityFuncT :: UnicodeDecomposeCompatibilityFuncT -> UnicodeDecomposeCompatibilityFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeDecomposeCompatibilityFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeDecomposeCompatibilityFuncT

-> UnicodeFuncsT

ufuncs: a Unicode function structure

-> Word32

u: codepoint to decompose

-> Word32

decomposed: address of codepoint array (of length UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into

-> Ptr ()

userData: user data pointer as passed to unicodeFuncsSetDecomposeCompatibilityFunc

-> m Word32

Returns: number of codepoints in the full compatibility decomposition of u, or 0 if no decomposition available.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeDecomposeCompatibilityFuncT :: MonadIO m => UnicodeDecomposeCompatibilityFuncT -> m (GClosure C_UnicodeDecomposeCompatibilityFuncT)

Wrap the callback into a GClosure.

mk_UnicodeDecomposeCompatibilityFuncT :: C_UnicodeDecomposeCompatibilityFuncT -> IO (FunPtr C_UnicodeDecomposeCompatibilityFuncT)

Generate a function pointer callable from C code, from a C_UnicodeDecomposeCompatibilityFuncT.

noUnicodeDecomposeCompatibilityFuncT :: Maybe UnicodeDecomposeCompatibilityFuncT

A convenience synonym for Nothing :: Maybe UnicodeDecomposeCompatibilityFuncT.

noUnicodeDecomposeCompatibilityFuncT_WithClosures :: Maybe UnicodeDecomposeCompatibilityFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeDecomposeCompatibilityFuncT_WithClosures.

wrap_UnicodeDecomposeCompatibilityFuncT :: Maybe (Ptr (FunPtr C_UnicodeDecomposeCompatibilityFuncT)) -> UnicodeDecomposeCompatibilityFuncT_WithClosures -> C_UnicodeDecomposeCompatibilityFuncT

Wrap a UnicodeDecomposeCompatibilityFuncT into a C_UnicodeDecomposeCompatibilityFuncT.

UnicodeDecomposeFuncT

type C_UnicodeDecomposeFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr () -> IO Int32

Type for the callback on the (unwrapped) C side.

type UnicodeDecomposeFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

ab: The code point to decompose

-> IO (Int32, Word32, Word32)

Returns: true if ab decomposed, false otherwise

A virtual method for the UnicodeFuncsT structure.

This method should decompose an input Unicode code point, returning the two decomposed code points in hb_codepoint_t output parameters (if successful). The method must return an hb_bool_t indicating the success of the composition.

type UnicodeDecomposeFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

ab: The code point to decompose

-> Ptr ()

userData: user data pointer passed by the caller

-> IO (Int32, Word32, Word32)

Returns: true if ab decomposed, false otherwise

A virtual method for the UnicodeFuncsT structure.

This method should decompose an input Unicode code point, returning the two decomposed code points in hb_codepoint_t output parameters (if successful). The method must return an hb_bool_t indicating the success of the composition.

drop_closures_UnicodeDecomposeFuncT :: UnicodeDecomposeFuncT -> UnicodeDecomposeFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeDecomposeFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeDecomposeFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

ab: The code point to decompose

-> Ptr ()

userData: user data pointer passed by the caller

-> m (Int32, Word32, Word32)

Returns: true if ab decomposed, false otherwise

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeDecomposeFuncT :: MonadIO m => UnicodeDecomposeFuncT -> m (GClosure C_UnicodeDecomposeFuncT)

Wrap the callback into a GClosure.

mk_UnicodeDecomposeFuncT :: C_UnicodeDecomposeFuncT -> IO (FunPtr C_UnicodeDecomposeFuncT)

Generate a function pointer callable from C code, from a C_UnicodeDecomposeFuncT.

noUnicodeDecomposeFuncT :: Maybe UnicodeDecomposeFuncT

A convenience synonym for Nothing :: Maybe UnicodeDecomposeFuncT.

noUnicodeDecomposeFuncT_WithClosures :: Maybe UnicodeDecomposeFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeDecomposeFuncT_WithClosures.

wrap_UnicodeDecomposeFuncT :: Maybe (Ptr (FunPtr C_UnicodeDecomposeFuncT)) -> UnicodeDecomposeFuncT_WithClosures -> C_UnicodeDecomposeFuncT

Wrap a UnicodeDecomposeFuncT into a C_UnicodeDecomposeFuncT.

UnicodeEastasianWidthFuncT

type C_UnicodeEastasianWidthFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr () -> IO Word32

Type for the callback on the (unwrapped) C side.

type UnicodeEastasianWidthFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> IO Word32

Deprecated: (Since version 2.0.0)

A virtual method for the UnicodeFuncsT structure.

type UnicodeEastasianWidthFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Word32

A virtual method for the UnicodeFuncsT structure.

drop_closures_UnicodeEastasianWidthFuncT :: UnicodeEastasianWidthFuncT -> UnicodeEastasianWidthFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeEastasianWidthFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeEastasianWidthFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m Word32

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeEastasianWidthFuncT :: MonadIO m => UnicodeEastasianWidthFuncT -> m (GClosure C_UnicodeEastasianWidthFuncT)

Wrap the callback into a GClosure.

mk_UnicodeEastasianWidthFuncT :: C_UnicodeEastasianWidthFuncT -> IO (FunPtr C_UnicodeEastasianWidthFuncT)

Generate a function pointer callable from C code, from a C_UnicodeEastasianWidthFuncT.

noUnicodeEastasianWidthFuncT :: Maybe UnicodeEastasianWidthFuncT

A convenience synonym for Nothing :: Maybe UnicodeEastasianWidthFuncT.

noUnicodeEastasianWidthFuncT_WithClosures :: Maybe UnicodeEastasianWidthFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeEastasianWidthFuncT_WithClosures.

wrap_UnicodeEastasianWidthFuncT :: Maybe (Ptr (FunPtr C_UnicodeEastasianWidthFuncT)) -> UnicodeEastasianWidthFuncT_WithClosures -> C_UnicodeEastasianWidthFuncT

Wrap a UnicodeEastasianWidthFuncT into a C_UnicodeEastasianWidthFuncT.

UnicodeGeneralCategoryFuncT

type C_UnicodeGeneralCategoryFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr () -> IO CUInt

Type for the callback on the (unwrapped) C side.

type UnicodeGeneralCategoryFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> IO UnicodeGeneralCategoryT

Returns: The UnicodeGeneralCategoryT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the General Category property for a specified Unicode code point.

type UnicodeGeneralCategoryFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO UnicodeGeneralCategoryT

Returns: The UnicodeGeneralCategoryT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the General Category property for a specified Unicode code point.

drop_closures_UnicodeGeneralCategoryFuncT :: UnicodeGeneralCategoryFuncT -> UnicodeGeneralCategoryFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeGeneralCategoryFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeGeneralCategoryFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m UnicodeGeneralCategoryT

Returns: The UnicodeGeneralCategoryT of unicode

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeGeneralCategoryFuncT :: MonadIO m => UnicodeGeneralCategoryFuncT -> m (GClosure C_UnicodeGeneralCategoryFuncT)

Wrap the callback into a GClosure.

mk_UnicodeGeneralCategoryFuncT :: C_UnicodeGeneralCategoryFuncT -> IO (FunPtr C_UnicodeGeneralCategoryFuncT)

Generate a function pointer callable from C code, from a C_UnicodeGeneralCategoryFuncT.

noUnicodeGeneralCategoryFuncT :: Maybe UnicodeGeneralCategoryFuncT

A convenience synonym for Nothing :: Maybe UnicodeGeneralCategoryFuncT.

noUnicodeGeneralCategoryFuncT_WithClosures :: Maybe UnicodeGeneralCategoryFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeGeneralCategoryFuncT_WithClosures.

wrap_UnicodeGeneralCategoryFuncT :: Maybe (Ptr (FunPtr C_UnicodeGeneralCategoryFuncT)) -> UnicodeGeneralCategoryFuncT_WithClosures -> C_UnicodeGeneralCategoryFuncT

Wrap a UnicodeGeneralCategoryFuncT into a C_UnicodeGeneralCategoryFuncT.

UnicodeMirroringFuncT

type C_UnicodeMirroringFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr () -> IO Word32

Type for the callback on the (unwrapped) C side.

type UnicodeMirroringFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> IO Word32

Returns: The hb_codepoint_t of the Mirroring Glyph for unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Bi-Directional Mirroring Glyph code point for a specified Unicode code point.

<note>Note: If a code point does not have a specified Bi-Directional Mirroring Glyph defined, the method should return the original code point.</note>

type UnicodeMirroringFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO Word32

Returns: The hb_codepoint_t of the Mirroring Glyph for unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Bi-Directional Mirroring Glyph code point for a specified Unicode code point.

<note>Note: If a code point does not have a specified Bi-Directional Mirroring Glyph defined, the method should return the original code point.</note>

drop_closures_UnicodeMirroringFuncT :: UnicodeMirroringFuncT -> UnicodeMirroringFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeMirroringFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeMirroringFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m Word32

Returns: The hb_codepoint_t of the Mirroring Glyph for unicode

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeMirroringFuncT :: MonadIO m => UnicodeMirroringFuncT -> m (GClosure C_UnicodeMirroringFuncT)

Wrap the callback into a GClosure.

mk_UnicodeMirroringFuncT :: C_UnicodeMirroringFuncT -> IO (FunPtr C_UnicodeMirroringFuncT)

Generate a function pointer callable from C code, from a C_UnicodeMirroringFuncT.

noUnicodeMirroringFuncT :: Maybe UnicodeMirroringFuncT

A convenience synonym for Nothing :: Maybe UnicodeMirroringFuncT.

noUnicodeMirroringFuncT_WithClosures :: Maybe UnicodeMirroringFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeMirroringFuncT_WithClosures.

wrap_UnicodeMirroringFuncT :: Maybe (Ptr (FunPtr C_UnicodeMirroringFuncT)) -> UnicodeMirroringFuncT_WithClosures -> C_UnicodeMirroringFuncT

Wrap a UnicodeMirroringFuncT into a C_UnicodeMirroringFuncT.

UnicodeScriptFuncT

type C_UnicodeScriptFuncT = Ptr UnicodeFuncsT -> Word32 -> Ptr () -> IO CUInt

Type for the callback on the (unwrapped) C side.

type UnicodeScriptFuncT

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> IO ScriptT

Returns: The ScriptT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Script property for a specified Unicode code point.

type UnicodeScriptFuncT_WithClosures

Arguments

 = UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> IO ScriptT

Returns: The ScriptT of unicode

A virtual method for the UnicodeFuncsT structure.

This method should retrieve the Script property for a specified Unicode code point.

drop_closures_UnicodeScriptFuncT :: UnicodeScriptFuncT -> UnicodeScriptFuncT_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_UnicodeScriptFuncT

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_UnicodeScriptFuncT

-> UnicodeFuncsT

ufuncs: A Unicode-functions structure

-> Word32

unicode: The code point to query

-> Ptr ()

userData: User data pointer passed by the caller

-> m ScriptT

Returns: The ScriptT of unicode

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_UnicodeScriptFuncT :: MonadIO m => UnicodeScriptFuncT -> m (GClosure C_UnicodeScriptFuncT)

Wrap the callback into a GClosure.

mk_UnicodeScriptFuncT :: C_UnicodeScriptFuncT -> IO (FunPtr C_UnicodeScriptFuncT)

Generate a function pointer callable from C code, from a C_UnicodeScriptFuncT.

noUnicodeScriptFuncT :: Maybe UnicodeScriptFuncT

A convenience synonym for Nothing :: Maybe UnicodeScriptFuncT.

noUnicodeScriptFuncT_WithClosures :: Maybe UnicodeScriptFuncT_WithClosures

A convenience synonym for Nothing :: Maybe UnicodeScriptFuncT_WithClosures.

wrap_UnicodeScriptFuncT :: Maybe (Ptr (FunPtr C_UnicodeScriptFuncT)) -> UnicodeScriptFuncT_WithClosures -> C_UnicodeScriptFuncT

Wrap a UnicodeScriptFuncT into a C_UnicodeScriptFuncT.