{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A helper object to build a 'P.Nothing'-terminated string array
-- by appending. See @/g_strv_builder_new()/@.
-- 
-- /Since: 2.68/

#if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__))
#define ENABLE_OVERLOADING
#endif

module GI.GLib.Structs.StrvBuilder
    ( 

-- * Exported types
    StrvBuilder(..)                         ,


 -- * Methods
-- ** Overloaded methods #method:Overloaded methods#

#if defined(ENABLE_OVERLOADING)
    ResolveStrvBuilderMethod                ,
#endif


-- ** add #method:add#

#if defined(ENABLE_OVERLOADING)
    StrvBuilderAddMethodInfo                ,
#endif
    strvBuilderAdd                          ,


-- ** unref #method:unref#

#if defined(ENABLE_OVERLOADING)
    StrvBuilderUnrefMethodInfo              ,
#endif
    strvBuilderUnref                        ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.BasicTypes as B.Types
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GArray as B.GArray
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.GI.Base.Signals as B.Signals
import qualified Control.Monad.IO.Class as MIO
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL


-- | Memory-managed wrapper type.
newtype StrvBuilder = StrvBuilder (SP.ManagedPtr StrvBuilder)
    deriving (StrvBuilder -> StrvBuilder -> Bool
(StrvBuilder -> StrvBuilder -> Bool)
-> (StrvBuilder -> StrvBuilder -> Bool) -> Eq StrvBuilder
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StrvBuilder -> StrvBuilder -> Bool
$c/= :: StrvBuilder -> StrvBuilder -> Bool
== :: StrvBuilder -> StrvBuilder -> Bool
$c== :: StrvBuilder -> StrvBuilder -> Bool
Eq)

instance SP.ManagedPtrNewtype StrvBuilder where
    toManagedPtr :: StrvBuilder -> ManagedPtr StrvBuilder
toManagedPtr (StrvBuilder p :: ManagedPtr StrvBuilder
p) = ManagedPtr StrvBuilder
p

-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance BoxedPtr StrvBuilder where
    boxedPtrCopy :: StrvBuilder -> IO StrvBuilder
boxedPtrCopy = StrvBuilder -> IO StrvBuilder
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: StrvBuilder -> IO ()
boxedPtrFree = \_x :: StrvBuilder
_x -> () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()


#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList StrvBuilder
type instance O.AttributeList StrvBuilder = StrvBuilderAttributeList
type StrvBuilderAttributeList = ('[ ] :: [(Symbol, *)])
#endif

-- method StrvBuilder::add
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "builder"
--           , argType =
--               TInterface Name { namespace = "GLib" , name = "StrvBuilder" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation { rawDocText = Nothing , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "value"
--           , argType = TBasicType TUTF8
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation { rawDocText = Nothing , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_strv_builder_add" g_strv_builder_add :: 
    Ptr StrvBuilder ->                      -- builder : TInterface (Name {namespace = "GLib", name = "StrvBuilder"})
    CString ->                              -- value : TBasicType TUTF8
    IO ()

-- | /No description available in the introspection data./
strvBuilderAdd ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    StrvBuilder
    -> T.Text
    -> m ()
strvBuilderAdd :: StrvBuilder -> Text -> m ()
strvBuilderAdd builder :: StrvBuilder
builder value :: Text
value = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr StrvBuilder
builder' <- StrvBuilder -> IO (Ptr StrvBuilder)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr StrvBuilder
builder
    CString
value' <- Text -> IO CString
textToCString Text
value
    Ptr StrvBuilder -> CString -> IO ()
g_strv_builder_add Ptr StrvBuilder
builder' CString
value'
    StrvBuilder -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr StrvBuilder
builder
    CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
value'
    () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data StrvBuilderAddMethodInfo
instance (signature ~ (T.Text -> m ()), MonadIO m) => O.MethodInfo StrvBuilderAddMethodInfo StrvBuilder signature where
    overloadedMethod = strvBuilderAdd

#endif

-- method StrvBuilder::unref
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "builder"
--           , argType =
--               TInterface Name { namespace = "GLib" , name = "StrvBuilder" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation { rawDocText = Nothing , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_strv_builder_unref" g_strv_builder_unref :: 
    Ptr StrvBuilder ->                      -- builder : TInterface (Name {namespace = "GLib", name = "StrvBuilder"})
    IO ()

-- | /No description available in the introspection data./
strvBuilderUnref ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    StrvBuilder
    -> m ()
strvBuilderUnref :: StrvBuilder -> m ()
strvBuilderUnref builder :: StrvBuilder
builder = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr StrvBuilder
builder' <- StrvBuilder -> IO (Ptr StrvBuilder)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr StrvBuilder
builder
    Ptr StrvBuilder -> IO ()
g_strv_builder_unref Ptr StrvBuilder
builder'
    StrvBuilder -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr StrvBuilder
builder
    () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data StrvBuilderUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.MethodInfo StrvBuilderUnrefMethodInfo StrvBuilder signature where
    overloadedMethod = strvBuilderUnref

#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveStrvBuilderMethod (t :: Symbol) (o :: *) :: * where
    ResolveStrvBuilderMethod "add" o = StrvBuilderAddMethodInfo
    ResolveStrvBuilderMethod "unref" o = StrvBuilderUnrefMethodInfo
    ResolveStrvBuilderMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveStrvBuilderMethod t StrvBuilder, O.MethodInfo info StrvBuilder p) => OL.IsLabel t (StrvBuilder -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod @info
#else
    fromLabel _ = O.overloadedMethod @info
#endif

#endif