{-|
Module      : BearLibTerminal.Terminal.CString
Description : String functions taking `CString`s.
License     : MIT
Stability   : experimental
Portability : POSIX

Functions that take strings as `CString`s. Unless you are wanting to marshall across the foreign boundary yourself,
you probably don't want to use these (prefer `Data.Text.Text` from `BearLibTerminal` or `String` from `BearLibTerminal.Terminal.String`).
-}

module BearLibTerminal.Terminal.CString
  ( terminalSetCString
  , terminalSetCString_
  , terminalColorNameCString
  , terminalBkColorNameCString

  , terminalPrintCString
  , terminalPrintExtCString

  , terminalMeasureCString
  , terminalMeasureExtCString

  ) where

import BearLibTerminal.Raw
import Control.Monad.IO.Class
import Data.Function ((&))
import Data.Maybe (fromMaybe)
import Foreign
import Foreign.C.String
import Foreign.C.Types (CInt)

-- | Set one or more of the configuration options, given as a `CString`.
--
-- Wrapper around [@terminal_set@](http://foo.wyrd.name/en:bearlibterminal:reference).
-- More details are available at the BearLibTerminal docs: http://foo.wyrd.name/en:bearlibterminal:reference:configuration.
terminalSetCString :: MonadIO m =>
  CString -- ^ Configuration string.
  -> m Bool -- ^ whether the configuration was successful.
terminalSetCString :: forall (m :: * -> *). MonadIO m => CString -> m Bool
terminalSetCString = IO Bool -> m Bool
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Bool -> m Bool) -> (CString -> IO Bool) -> CString -> m Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ((CInt -> Bool) -> IO CInt -> IO Bool
forall a b. (a -> b) -> IO a -> IO b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap CInt -> Bool
asBool (IO CInt -> IO Bool) -> (CString -> IO CInt) -> CString -> IO Bool
forall b c a. (b -> c) -> (a -> b) -> a -> c
. CString -> IO CInt
c_terminal_set)

-- | Set one or more of the configuration options, given as a `CString`. Ignore if it was successful.
--
-- Wrapper around [@terminal_set@](http://foo.wyrd.name/en:bearlibterminal:reference).
-- More details are available at the BearLibTerminal docs: http://foo.wyrd.name/en:bearlibterminal:reference:configuration.
terminalSetCString_ :: MonadIO m =>
  CString -- ^ Configuration string.
  -> m ()
terminalSetCString_ :: forall (m :: * -> *). MonadIO m => CString -> m ()
terminalSetCString_ = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> (CString -> IO ()) -> CString -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (IO CInt -> IO ()
forall a. IO a -> IO ()
void (IO CInt -> IO ()) -> (CString -> IO CInt) -> CString -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. CString -> IO CInt
c_terminal_set)

-- | Set the currently selected foreground color to be used by following output functions (e.g. `terminalPrintText`).
-- Takes a color as a name in a variety of formats; see [@color_from_name@](http://foo.wyrd.name/en:bearlibterminal:reference#color_from_name)
-- for a full list.
--
-- Takes the color name as a `CString`.
--
-- Wrapper around [@terminal_color@](http://foo.wyrd.name/en:bearlibterminal:reference#color) and
-- [@color_from_name@](http://foo.wyrd.name/en:bearlibterminal:reference#color_from_name).
terminalColorNameCString ::
  MonadIO m
  => CString  -- ^ the color name to be selected, in @"[brightness]hue"@ format as specified in @color_from_name@.
  -> m ()
terminalColorNameCString :: forall (m :: * -> *). MonadIO m => CString -> m ()
terminalColorNameCString = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> (CString -> IO ()) -> CString -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. CString -> IO ()
c_terminal_color_from_name

-- | Set the currently selected foreground color to be used by following output functions (e.g. `terminalPrintText`).
-- Takes a color as a name in a variety of formats; see [@color_from_name@](http://foo.wyrd.name/en:bearlibterminal:reference#color_from_name)
-- for a full list.
--
-- Takes the color name as a `CString`.
--
-- Wrapper around [@terminal_bkcolor@](http://foo.wyrd.name/en:bearlibterminal:reference#bkcolor) and
-- [@color_from_name@](http://foo.wyrd.name/en:bearlibterminal:reference#color_from_name).
terminalBkColorNameCString ::
  MonadIO m
  => CString  -- ^ the color name to be selected, in @"[brightness]hue"@ format as specified in @color_from_name@.
  -> m ()
terminalBkColorNameCString :: forall (m :: * -> *). MonadIO m => CString -> m ()
terminalBkColorNameCString = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> (CString -> IO ()) -> CString -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. CString -> IO ()
c_terminal_bkcolor_from_name

-- | Print a string to the screen, given as a `CString`.
--
-- Wrapper around [@terminal_print@](http://foo.wyrd.name/en:bearlibterminal:reference#print).
terminalPrintCString ::
  MonadIO m
  => Int  -- ^ x-coordinate to start printing the string at.
  -> Int -- ^ y-coordinate to start printing the string at.
  -> CString -- ^ the string to print.
  -> m Dimensions -- ^ the `Dimensions` of the string as printed on screen.
terminalPrintCString :: forall (m :: * -> *).
MonadIO m =>
Int -> Int -> CString -> m Dimensions
terminalPrintCString Int
x Int
y CString
c = IO Dimensions -> m Dimensions
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Dimensions -> m Dimensions) -> IO Dimensions -> m Dimensions
forall a b. (a -> b) -> a -> b
$ (Ptr Dimensions -> IO Dimensions) -> IO Dimensions
forall a b. Storable a => (Ptr a -> IO b) -> IO b
alloca (\Ptr Dimensions
dim -> CInt -> CInt -> CString -> Ptr Dimensions -> IO ()
c_terminal_print_ptr (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
x) (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
y) CString
c Ptr Dimensions
dim IO () -> IO Dimensions -> IO Dimensions
forall a b. IO a -> IO b -> IO b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Ptr Dimensions -> IO Dimensions
forall a. Storable a => Ptr a -> IO a
peek Ptr Dimensions
dim)

-- | Print a string to the screen, given as a `CString`, with (optional) auto-wrapping and alignment.
-- Wrapper around [@terminal_print_ext@](http://foo.wyrd.name/en:bearlibterminal:reference#print_ext)
terminalPrintExtCString ::
  MonadIO m
  => Int  -- ^ x-coordinate to start printing the string at.
  -> Int -- ^ y-coordinate to start printing the string at.
  -> Int -- ^ width of the bounding box for auto-wrapping and alignment.
  -> Int -- ^ height of the bounding box for auto-wrapping and alignment.
  -> Maybe PrintAlignment -- ^ alignment of the string within the bounding box.
  -> CString -- ^ the string to print.
  -> m Dimensions -- ^ the `Dimensions` of the string as printed on screen.
terminalPrintExtCString :: forall (m :: * -> *).
MonadIO m =>
Int
-> Int
-> Int
-> Int
-> Maybe PrintAlignment
-> CString
-> m Dimensions
terminalPrintExtCString Int
x Int
y Int
w Int
h Maybe PrintAlignment
mbAlign CString
c =
  let align :: CInt
      align :: CInt
align = PrintAlignment -> Maybe PrintAlignment -> PrintAlignment
forall a. a -> Maybe a -> a
fromMaybe PrintAlignment
AlignDefault Maybe PrintAlignment
mbAlign PrintAlignment -> (PrintAlignment -> CInt) -> CInt
forall a b. a -> (a -> b) -> b
& \case
        PrintAlignment
AlignDefault -> CInt
0
        PrintAlignment
AlignLeft -> CInt
1
        PrintAlignment
AlignRight -> CInt
2
        PrintAlignment
AlignCenter -> CInt
3
        PrintAlignment
AlignTop -> CInt
4
        PrintAlignment
AlignBottom -> CInt
8
        PrintAlignment
AlignMiddle -> CInt
12
  in
  IO Dimensions -> m Dimensions
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Dimensions -> m Dimensions) -> IO Dimensions -> m Dimensions
forall a b. (a -> b) -> a -> b
$ (Ptr Dimensions -> IO Dimensions) -> IO Dimensions
forall a b. Storable a => (Ptr a -> IO b) -> IO b
alloca (\Ptr Dimensions
dim -> CInt
-> CInt
-> CInt
-> CInt
-> CInt
-> CString
-> Ptr Dimensions
-> IO ()
c_terminal_print_ext_ptr (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
x) (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
y) (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
w) (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
h) CInt
align CString
c Ptr Dimensions
dim IO () -> IO Dimensions -> IO Dimensions
forall a b. IO a -> IO b -> IO b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Ptr Dimensions -> IO Dimensions
forall a. Storable a => Ptr a -> IO a
peek Ptr Dimensions
dim)

-- | Measure the size of a string *if it were to be printed to the screen*, given as a `CString`.
-- Wrapper around [@terminal_measure@](http://foo.wyrd.name/en:bearlibterminal:reference#measure)
terminalMeasureCString ::
  MonadIO m
  => CString -- ^ the string to measure the print for.
  -> m Dimensions -- ^ the size of the string if it were printed to the screen.
terminalMeasureCString :: forall (m :: * -> *). MonadIO m => CString -> m Dimensions
terminalMeasureCString CString
c = IO Dimensions -> m Dimensions
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Dimensions -> m Dimensions) -> IO Dimensions -> m Dimensions
forall a b. (a -> b) -> a -> b
$ (Ptr Dimensions -> IO Dimensions) -> IO Dimensions
forall a b. Storable a => (Ptr a -> IO b) -> IO b
alloca (\Ptr Dimensions
dim -> CString -> Ptr Dimensions -> IO ()
c_terminal_measure_ptr CString
c Ptr Dimensions
dim IO () -> IO Dimensions -> IO Dimensions
forall a b. IO a -> IO b -> IO b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Ptr Dimensions -> IO Dimensions
forall a. Storable a => Ptr a -> IO a
peek Ptr Dimensions
dim)

-- | Measure the size of a string *if it were to be printed to the screen*, autowrapped in a bounding box, given as a `CString`.
-- Wrapper around [@terminal_measure_ext@](http://foo.wyrd.name/en:bearlibterminal:reference#measure)
terminalMeasureExtCString ::
  MonadIO m
  => Int -- ^ the width of the bounding box.
  -> Int -- ^ the height of the bounding box.
  -> CString  -- ^ the string to measure the print for.
  -> m Dimensions -- ^ the size of the string if it were printed to the screen.
terminalMeasureExtCString :: forall (m :: * -> *).
MonadIO m =>
Int -> Int -> CString -> m Dimensions
terminalMeasureExtCString Int
w Int
h CString
c = IO Dimensions -> m Dimensions
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Dimensions -> m Dimensions) -> IO Dimensions -> m Dimensions
forall a b. (a -> b) -> a -> b
$ (Ptr Dimensions -> IO Dimensions) -> IO Dimensions
forall a b. Storable a => (Ptr a -> IO b) -> IO b
alloca (\Ptr Dimensions
dim -> CInt -> CInt -> CString -> Ptr Dimensions -> IO ()
c_terminal_measure_ext_ptr (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
w) (Int -> CInt
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
h) CString
c Ptr Dimensions
dim IO () -> IO Dimensions -> IO Dimensions
forall a b. IO a -> IO b -> IO b
forall (m :: * -> *) a b. Monad m => m a -> m b -> m b
>> Ptr Dimensions -> IO Dimensions
forall a. Storable a => Ptr a -> IO a
peek Ptr Dimensions
dim)