Hub.hsc

{-# LANGUAGE OverloadedStrings, TemplateHaskell, QuasiQuotes, RecordWildCards #-}
module Myo.Foreign.Hub (
  -- * Low level functions
    initHub
  , freeHub
  , freeErrorDetails
  -- * High level functions
  , newHub
  ) where

import qualified Language.C.Inline as C
import           Data.Monoid
import           Foreign.ForeignPtr
import           Foreign.Ptr
import           Foreign.C.String
import           Foreign.Storable
import           Foreign.Marshal.Alloc

import           Myo.Foreign.Types
import           Myo.Foreign.Hub.Types

C.context (myoCtx <> hubCtx)
C.include "libmyo.h"
C.include "<string.h>"

{-
Initialize a connection to the hub.
\a application_identifier must follow a reverse domain name format (ex. com.domainname.appname). Application
identifiers can be formed from the set of alphanumeric ASCII characters (a-z, A-Z, 0-9). The hyphen (-) and
underscore (_) characters are permitted if they are not adjacent to a period (.) character (i.e. not at the start or
end of each segment), but are not permitted in the top-level domain. Application identifiers must have three or more
segments. For example, if a company's domain is example.com and the application is named hello-world, one could use
"com.example.hello-world" as a valid application identifier. \a application_identifier can be NULL or empty.
@returns libmyo_success if the connection is successfully established, otherwise:
 - libmyo_error_runtime if a connection could not be established
 - libmyo_error_invalid_argument if \a out_hub is NULL
 - libmyo_error_invalid_argument if \a application_identifier is longer than 255 characters
 - libmyo_error_invalid_argument if \a application_identifier is not in the proper reverse domain name format
-}

initHub :: MyoHub -> ApplicationID -> ErrorDetails -> IO Result
initHub h aid e = withForeignPtr h $ \h' ->
  withForeignPtr e $ \e' -> do
    alloca $ \resPtr -> do
     [C.block| void {
             libmyo_result_t r = libmyo_init_hub( &$(libmyo_hub_t h')
                                   , $(const char* aid)
                                   , &$(libmyo_error_details_t e'));
             memmove($(libmyo_result_t* resPtr) ,&r, sizeof(libmyo_result_t));
            }
     |]
     peek resPtr

-------------------------------------------------------------------------------
-- | Free the resources allocated by the ErrorDetails object.
foreign import ccall "wrapper.h &myo_error_details_free"
  freeErrorDetails :: FunPtr (Ptr ErrorDetails_t -> IO ())

-------------------------------------------------------------------------------
-- | Free the resources allocated by the ErrorDetails object.
foreign import ccall "wrapper.h &myo_hub_free"
  freeHub :: FunPtr (Ptr Hub_t -> IO ())

-------------------------------------------------------------------------------
-- | High-level function to create a new Hub.
newHub :: String -> IO (Either ErrorReport MyoHub)
newHub aid = do
  hub <- malloc >>= newForeignPtr_ -- freeHub
  eDetails <- malloc >>= newForeignPtr_ --freeErrorDetails
  aId <- newCString aid
  r <- initHub hub aId eDetails
  case r of
    Success -> return $ Right hub
    _ -> return $ Left (ErrorReport r eDetails)