Client.CApi.Types

Marshaling types and functions for the C API

Extension record

data FgnExtension

Information describing an extension's entry-points and metadata.

Constructors

FgnExtension

Fields

• fgnStart :: FunPtr StartExtension

  Optional startup callback

• fgnStop :: FunPtr StopExtension

  Optional shutdown callback

• fgnMessage :: FunPtr ProcessMessage

  Optional message received callback

• fgnChat :: FunPtr ProcessChat

  Optional message send callback

• fgnCommand :: FunPtr ProcessCommand

  Optional client command callback

• fgnName :: CString

  Null-terminated name

• fgnMajorVersion, fgnMinorVersion :: CInt

  extension version

Instances

Storable FgnExtension

struct glirc_extension

Defined in Client.CApi.Types

Methods

sizeOf :: FgnExtension -> Int

alignment :: FgnExtension -> Int

peekElemOff :: Ptr FgnExtension -> Int -> IO FgnExtension

pokeElemOff :: Ptr FgnExtension -> Int -> FgnExtension -> IO ()

peekByteOff :: Ptr b -> Int -> IO FgnExtension

pokeByteOff :: Ptr b -> Int -> FgnExtension -> IO ()

peek :: Ptr FgnExtension -> IO FgnExtension

poke :: Ptr FgnExtension -> FgnExtension -> IO ()

type StartExtension

Arguments

 = Ptr ()

api token

-> CString

path to extension

-> Ptr FgnStringLen

array of arguments

-> CSize

number of arguments

-> IO (Ptr ())

initialized extension state

typedef void *start(void *glirc, const char *path)

type StopExtension

Arguments

 = Ptr ()

extension state

-> IO ()

typedef void stop(void *glirc, void *S)

type ProcessMessage

Arguments

 = Ptr ()

extention state

-> Ptr FgnMsg

message to send

-> IO ProcessResult

typedef enum process_result process_message(void *glirc, void *S, const struct glirc_message *)

type ProcessCommand

Arguments

 = Ptr ()

extension state

-> Ptr FgnCmd

command

-> IO ()

typedef void process_command(void *glirc, void *S, const struct glirc_command *)

type ProcessChat

Arguments

 = Ptr ()

extension state

-> Ptr FgnChat

chat info

-> IO ProcessResult

typedef void process_chat(void *glirc, void *S, const struct glirc_chat *)

type TimerCallback

Arguments

 = Ptr ()

timer state

-> TimerId

timer ID

-> IO ()

Callback function when timer triggers

type TimerId = Int64

Integer type of timer IDs

Strings

data FgnStringLen

Pointer to UTF-8 encoded string and as string length. Strings are null-terminated. The null-terminator is not counted in the length.

Constructors

FgnStringLen !CString !CSize

Instances

Storable FgnStringLen

struct glirc_string

Defined in Client.CApi.Types

Methods

sizeOf :: FgnStringLen -> Int

alignment :: FgnStringLen -> Int

peekElemOff :: Ptr FgnStringLen -> Int -> IO FgnStringLen

pokeElemOff :: Ptr FgnStringLen -> Int -> FgnStringLen -> IO ()

peekByteOff :: Ptr b -> Int -> IO FgnStringLen

pokeByteOff :: Ptr b -> Int -> FgnStringLen -> IO ()

peek :: Ptr FgnStringLen -> IO FgnStringLen

poke :: Ptr FgnStringLen -> FgnStringLen -> IO ()

Messages

data FgnMsg

struct glirc_message

Constructors

FgnMsg

Fields

• fmNetwork :: FgnStringLen
• fmPrefixNick :: FgnStringLen
• fmPrefixUser :: FgnStringLen
• fmPrefixHost :: FgnStringLen
• fmCommand :: FgnStringLen
• fmParams :: Ptr FgnStringLen

  array

• fmParamN :: CSize

  array length

• fmTagKeys :: Ptr FgnStringLen

  array

• fmTagVals :: Ptr FgnStringLen

  array

• fmTagN :: CSize

  array length

Instances

Storable FgnMsg

Defined in Client.CApi.Types

Methods

sizeOf :: FgnMsg -> Int

alignment :: FgnMsg -> Int

peekElemOff :: Ptr FgnMsg -> Int -> IO FgnMsg

pokeElemOff :: Ptr FgnMsg -> Int -> FgnMsg -> IO ()

peekByteOff :: Ptr b -> Int -> IO FgnMsg

pokeByteOff :: Ptr b -> Int -> FgnMsg -> IO ()

peek :: Ptr FgnMsg -> IO FgnMsg

poke :: Ptr FgnMsg -> FgnMsg -> IO ()

Commands

data FgnCmd

Used to pass arguments from /extension EXT_NAME client command into an extension.

Constructors

FgnCmd

Fields

• fcCommand :: FgnStringLen

Instances

Storable FgnCmd

struct glirc_command

Defined in Client.CApi.Types

Methods

sizeOf :: FgnCmd -> Int

alignment :: FgnCmd -> Int

peekElemOff :: Ptr FgnCmd -> Int -> IO FgnCmd

pokeElemOff :: Ptr FgnCmd -> Int -> FgnCmd -> IO ()

peekByteOff :: Ptr b -> Int -> IO FgnCmd

pokeByteOff :: Ptr b -> Int -> FgnCmd -> IO ()

peek :: Ptr FgnCmd -> IO FgnCmd

poke :: Ptr FgnCmd -> FgnCmd -> IO ()

Chat

data FgnChat

Chat message data containing the source network, window target, and message body.

Constructors

FgnChat

Fields

• fhNetwork :: FgnStringLen
• fhTarget :: FgnStringLen
• fhMessage :: FgnStringLen

Instances

Storable FgnChat

struct glirc_message

Defined in Client.CApi.Types

Methods

sizeOf :: FgnChat -> Int

alignment :: FgnChat -> Int

peekElemOff :: Ptr FgnChat -> Int -> IO FgnChat

pokeElemOff :: Ptr FgnChat -> Int -> FgnChat -> IO ()

peekByteOff :: Ptr b -> Int -> IO FgnChat

pokeByteOff :: Ptr b -> Int -> FgnChat -> IO ()

peek :: Ptr FgnChat -> IO FgnChat

poke :: Ptr FgnChat -> FgnChat -> IO ()

Function pointer calling

type Dynamic a = FunPtr a -> a

Type of dynamic function pointer wrappers. These convert C function-pointers into Haskell functions.

runStartExtension :: Dynamic StartExtension

Dynamic import for StartExtension.

runStopExtension :: Dynamic StopExtension

Dynamic import for StopExtension.

runProcessMessage :: Dynamic ProcessMessage

Dynamic import for ProcessMessage.

runProcessCommand :: Dynamic ProcessCommand

Dynamic import for ProcessCommand.

runProcessChat :: Dynamic ProcessChat

Dynamic import for ProcessChat.

runTimerCallback :: Dynamic TimerCallback

Dynamic import for timer callback

report message codes

newtype MessageCode

Tag for describing the kind of message to display in the client as used in glirc_print. See normalMessage and errorMessage.

enum message_code;

Constructors

MessageCode Word32

Instances

Eq MessageCode

Defined in Client.CApi.Types

Methods

(==) :: MessageCode -> MessageCode -> Bool

(/=) :: MessageCode -> MessageCode -> Bool

normalMessage :: MessageCode

Normal client message. Unread counter increments, but no client bell or error status update.

errorMessage :: MessageCode

Important client message. Unread counter increments, bell rings, and error status updates.

process message results

newtype ProcessResult

Result used to determine what to do after processing a message with the ProcessMessage callback.

| enum process_result

Constructors

ProcessResult Word32

Instances

Eq ProcessResult

Defined in Client.CApi.Types

Methods

(==) :: ProcessResult -> ProcessResult -> Bool

(/=) :: ProcessResult -> ProcessResult -> Bool

passMessage :: ProcessResult

Allow the message to proceed through the client logic.

dropMessage :: ProcessResult

Drop the message from further processing.

Marshaling helpers

withText0 :: Text -> (CStringLen -> IO a) -> IO a

Marshal a text as a temporary null-terminated CStringLen

exportText :: Ptr CString -> Ptr CSize -> Text -> IO ()

Marshal a text as a malloced null-terminated CStringLen

poke' :: Storable a => Ptr a -> a -> IO ()

Like poke except it doesn't write to NULL