Client.CApi.Types

Marshaling types and functions for the C API

Extension record

data FgnExtension

struct glirc_extension;

Constructors

FgnExtension

Fields

• fgnStart :: FunPtr StartExtension

  Optional startup callback

• fgnStop :: FunPtr StopExtension

  Optional shutdown callback

• fgnMessage :: FunPtr ProcessMessage

  Optional message received callback

• fgnCommand :: FunPtr ProcessCommand

  Optional client command callback

• fgnName :: CString

  Null-terminated name

• fgnMajorVersion, fgnMinorVersion :: CInt

  extension version

Instances

Storable FgnExtension

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

-> IO (Ptr ())

initialized extension state

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

type StopExtension

Arguments

 = Ptr ()

api token

-> Ptr ()

extension state

-> IO ()

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

type ProcessMessage

Arguments

 = Ptr ()

api token

-> Ptr ()

extention state

-> Ptr FgnMsg

message to send

-> IO MessageResult

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

type ProcessCommand

Arguments

 = Ptr ()

api token

-> Ptr ()

extension state

-> Ptr FgnCmd

command

-> IO ()

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

Strings

data FgnStringLen

struct glirc_string

Constructors

FgnStringLen !CString !CSize

Instances

Storable FgnStringLen

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

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

struct glirc_command

Constructors

FgnCmd

Fields

• fcParams :: Ptr FgnStringLen

  array

• fcParamN :: CSize

  array length

Instances

Storable FgnCmd

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 ()

Function pointer calling

type Dynamic a = FunPtr a -> a

Type of dynamic function pointer wrappers.

runStartExtension :: Dynamic StartExtension

runStopExtension :: Dynamic StopExtension

runProcessMessage :: Dynamic ProcessMessage

runProcessCommand :: Dynamic ProcessCommand

report message codes

newtype MessageCode

Tag for describing the kind of message to display in the client as used in glirc_print.

enum message_code;

Constructors

MessageCode CInt

Instances

Eq MessageCode

Methods

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

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

normalMessage :: MessageCode

errorMessage :: MessageCode

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

enum process_result;

process message results

newtype MessageResult

Constructors

MessageResult CInt

Instances

Eq MessageResult

Methods

(==) :: MessageResult -> MessageResult -> Bool

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

passMessage :: MessageResult

dropMessage :: MessageResult