{-# LINE 1 "src/Client/CApi/Types.hsc" #-}
{-# Language RecordWildCards #-}

{-|
Module      : Client.CApi.Types
Description : Marshaling support for C API
Copyright   : (c) Eric Mertens, 2016
License     : ISC
Maintainer  : emertens@gmail.com

Marshaling types and functions for the C API

-}



module Client.CApi.Types
  ( -- * Extension record
    FgnExtension(..)
  , StartExtension
  , StopExtension
  , ProcessMessage
  , ProcessCommand

  -- * Strings
  , FgnStringLen(..)

  -- * Messages
  , FgnMsg(..)

  -- * Commands
  , FgnCmd(..)

  -- * Chat
  , FgnChat(..)

  -- * Function pointer calling
  , Dynamic
  , runStartExtension
  , runStopExtension
  , runProcessMessage
  , runProcessCommand
  , runProcessChat

  -- * report message codes
  , MessageCode(..), normalMessage, errorMessage

  -- * process message results
  , MessageResult(..), passMessage, dropMessage

  -- * Marshaling helpers
  , withText0
  , exportText
  , poke'
  ) where

import           Control.Monad
import           Data.Text (Text)
import qualified Data.Text.Foreign as Text
import           Foreign.C
import           Foreign.Marshal.Array
import           Foreign.Ptr
import           Foreign.Storable

-- | Tag for describing the kind of message to display in the client
-- as used in `glirc_print`.
--
-- @enum message_code;@
newtype MessageCode = MessageCode CInt deriving Eq
normalMessage :: MessageCode
normalMessage = MessageCode 0
errorMessage :: MessageCode
errorMessage = MessageCode 1

{-# LINE 70 "src/Client/CApi/Types.hsc" #-}

-- | Result used to determine what to do after processing a message with
-- the 'ProcessMessage' callback.
--
-- @enum process_result;@
newtype MessageResult = MessageResult CInt deriving Eq
passMessage :: MessageResult
passMessage = MessageResult 0
dropMessage :: MessageResult
dropMessage = MessageResult 1

{-# LINE 77 "src/Client/CApi/Types.hsc" #-}

--

-- | @typedef void *start(void *glirc, const char *path);@
type StartExtension =
  Ptr ()      {- ^ api token                   -} ->
  CString     {- ^ path to extension           -} ->
  IO (Ptr ()) {- ^ initialized extension state -}

-- | @typedef void stop(void *glirc, void *S);@
type StopExtension =
  Ptr () {- ^ api token       -} ->
  Ptr () {- ^ extension state -} ->
  IO ()

-- | @typedef enum process_result process_message(void *glirc, void *S, const struct glirc_message *);@
type ProcessMessage =
  Ptr ()     {- ^ api token       -} ->
  Ptr ()     {- ^ extention state -} ->
  Ptr FgnMsg {- ^ message to send -} ->
  IO MessageResult

-- | @typedef void process_command(void *glirc, void *S, const struct glirc_command *);@
type ProcessCommand =
  Ptr ()     {- ^ api token       -} ->
  Ptr ()     {- ^ extension state -} ->
  Ptr FgnCmd {- ^ command         -} ->
  IO ()

-- | @typedef void process_chat(void *glirc, void *S, const struct glirc_chat *);@
type ProcessChat =
  Ptr ()      {- ^ api token       -} ->
  Ptr ()      {- ^ extension state -} ->
  Ptr FgnChat {- ^ chat info       -} ->
  IO MessageResult

-- | Type of dynamic function pointer wrappers.
type Dynamic a = FunPtr a -> a

foreign import ccall "dynamic" runStartExtension :: Dynamic StartExtension
foreign import ccall "dynamic" runStopExtension  :: Dynamic StopExtension
foreign import ccall "dynamic" runProcessMessage :: Dynamic ProcessMessage
foreign import ccall "dynamic" runProcessCommand :: Dynamic ProcessCommand
foreign import ccall "dynamic" runProcessChat    :: Dynamic ProcessChat

------------------------------------------------------------------------

-- | @struct glirc_extension;@
data FgnExtension = FgnExtension
  { 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
  }

instance Storable FgnExtension where
  alignment _ = 8
{-# LINE 137 "src/Client/CApi/Types.hsc" #-}
  sizeOf    _ = (56)
{-# LINE 138 "src/Client/CApi/Types.hsc" #-}
  peek p      = FgnExtension
            <$> ((\hsc_ptr -> peekByteOff hsc_ptr 16)) p
{-# LINE 140 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 24)) p
{-# LINE 141 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 32)) p
{-# LINE 142 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 48)) p
{-# LINE 143 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 40)) p
{-# LINE 144 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p
{-# LINE 145 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 8)) p
{-# LINE 146 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 12)) p
{-# LINE 147 "src/Client/CApi/Types.hsc" #-}
  poke p FgnExtension{..} =
             do ((\hsc_ptr -> pokeByteOff hsc_ptr 16)) p fgnStart
{-# LINE 149 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 24)) p fgnStop
{-# LINE 150 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 32)) p fgnMessage
{-# LINE 151 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 48)) p fgnChat
{-# LINE 152 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 40)) p fgnCommand
{-# LINE 153 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p fgnName
{-# LINE 154 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 8)) p fgnMajorVersion
{-# LINE 155 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 12)) p fgnMinorVersion
{-# LINE 156 "src/Client/CApi/Types.hsc" #-}

------------------------------------------------------------------------

-- | @struct glirc_message@
data FgnMsg = FgnMsg
  { 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
  }

instance Storable FgnMsg where
  alignment _ = 8
{-# LINE 175 "src/Client/CApi/Types.hsc" #-}
  sizeOf    _ = (120)
{-# LINE 176 "src/Client/CApi/Types.hsc" #-}
  peek p      = FgnMsg
            <$> ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p
{-# LINE 178 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 16)) p
{-# LINE 179 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 32)) p
{-# LINE 180 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 48)) p
{-# LINE 181 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 64)) p
{-# LINE 182 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 80)) p
{-# LINE 183 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 88)) p
{-# LINE 184 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 96)) p
{-# LINE 185 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 104)) p
{-# LINE 186 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 112)) p
{-# LINE 187 "src/Client/CApi/Types.hsc" #-}

  poke p FgnMsg{..} =
             do ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p fmNetwork
{-# LINE 190 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 16)) p fmPrefixNick
{-# LINE 191 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 32)) p fmPrefixUser
{-# LINE 192 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 48)) p fmPrefixHost
{-# LINE 193 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 64)) p fmCommand
{-# LINE 194 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 80)) p fmParams
{-# LINE 195 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 88)) p fmParamN
{-# LINE 196 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 96)) p fmTagKeys
{-# LINE 197 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 104)) p fmTagVals
{-# LINE 198 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 112)) p fmTagN
{-# LINE 199 "src/Client/CApi/Types.hsc" #-}

------------------------------------------------------------------------

-- | @struct glirc_message@
data FgnChat = FgnChat
  { fhNetwork    :: FgnStringLen
  , fhTarget     :: FgnStringLen
  , fhMessage    :: FgnStringLen
  }

instance Storable FgnChat where
  alignment _ = 8
{-# LINE 211 "src/Client/CApi/Types.hsc" #-}
  sizeOf    _ = (48)
{-# LINE 212 "src/Client/CApi/Types.hsc" #-}
  peek p      = FgnChat
            <$> ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p
{-# LINE 214 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 16)) p
{-# LINE 215 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 32)) p
{-# LINE 216 "src/Client/CApi/Types.hsc" #-}

  poke p FgnChat{..} =
             do ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p fhNetwork
{-# LINE 219 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 16)) p fhTarget
{-# LINE 220 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 32)) p fhMessage
{-# LINE 221 "src/Client/CApi/Types.hsc" #-}

------------------------------------------------------------------------

-- | @struct glirc_command@
data FgnCmd = FgnCmd
  { fcCommand :: FgnStringLen
  }

instance Storable FgnCmd where
  alignment _ = 8
{-# LINE 231 "src/Client/CApi/Types.hsc" #-}
  sizeOf    _ = (16)
{-# LINE 232 "src/Client/CApi/Types.hsc" #-}
  peek p      = FgnCmd
            <$> ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p
{-# LINE 234 "src/Client/CApi/Types.hsc" #-}

  poke p FgnCmd{..} = ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p fcCommand
{-# LINE 236 "src/Client/CApi/Types.hsc" #-}

------------------------------------------------------------------------

-- | @struct glirc_string@
data FgnStringLen = FgnStringLen !CString !CSize

instance Storable FgnStringLen where
  alignment _ = 8
{-# LINE 244 "src/Client/CApi/Types.hsc" #-}
  sizeOf    _ = (16)
{-# LINE 245 "src/Client/CApi/Types.hsc" #-}
  peek p      = FgnStringLen
            <$> ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p
{-# LINE 247 "src/Client/CApi/Types.hsc" #-}
            <*> ((\hsc_ptr -> peekByteOff hsc_ptr 8)) p
{-# LINE 248 "src/Client/CApi/Types.hsc" #-}
  poke p (FgnStringLen x y) =
             do ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p x
{-# LINE 250 "src/Client/CApi/Types.hsc" #-}
                ((\hsc_ptr -> pokeByteOff hsc_ptr 8)) p y
{-# LINE 251 "src/Client/CApi/Types.hsc" #-}

------------------------------------------------------------------------

-- | Like 'poke' except it doesn't write to NULL
poke' :: Storable a => Ptr a -> a -> IO ()
poke' ptr x = unless (nullPtr == ptr) (poke ptr x)

-- | Marshal a text as a malloced null-terminated CStringLen
exportText :: Ptr CString -> Ptr CSize -> Text -> IO ()
exportText dstP dstL txt =

  Text.withCStringLen txt $ \(srcP, srcL) ->
    do poke' dstL (fromIntegral srcL)
       unless (dstP == nullPtr) $
         do a <- mallocArray0 srcL
            copyArray a srcP srcL
            pokeElemOff a srcL 0
            poke dstP a

-- | Marshal a text as a temporary null-terminated CStringLen
withText0 :: Text -> (CStringLen -> IO a) -> IO a
withText0 txt k =
  Text.withCStringLen txt $ \(p,l) ->
  allocaArray0 l $ \p' ->
    do copyArray p' p l
       pokeElemOff p' l 0
       k (p', l)