{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- t'GI.GLib.Structs.StrvBuilder.StrvBuilder' is a method of easily building dynamically sized
-- NULL-terminated string arrays.
-- 
-- The following example shows how to build a two element array:
-- 
-- 
-- === /C code/
-- >
-- >  g_autoptr(GStrvBuilder) builder = g_strv_builder_new ();
-- >  g_strv_builder_add (builder, "hello");
-- >  g_strv_builder_add (builder, "world");
-- >  g_auto(GStrv) array = g_strv_builder_end (builder);
-- 
-- 
-- /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
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [add]("GI.GLib.Structs.StrvBuilder#g:method:add"), [addv]("GI.GLib.Structs.StrvBuilder#g:method:addv"), [end]("GI.GLib.Structs.StrvBuilder#g:method:end").
-- 
-- ==== Getters
-- /None/.
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveStrvBuilderMethod                ,
#endif

-- ** add #method:add#

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


-- ** addv #method:addv#

#if defined(ENABLE_OVERLOADING)
    StrvBuilderAddvMethodInfo               ,
#endif
    strvBuilderAddv                         ,


-- ** end #method:end#

#if defined(ENABLE_OVERLOADING)
    StrvBuilderEndMethodInfo                ,
#endif
    strvBuilderEnd                          ,




    ) 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.GHashTable as B.GHT
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.Coerce as Coerce
import qualified Data.Text as T
import qualified Data.Kind as DK
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
import qualified GHC.Records as R


-- | 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
$c== :: StrvBuilder -> StrvBuilder -> Bool
== :: StrvBuilder -> StrvBuilder -> Bool
$c/= :: StrvBuilder -> StrvBuilder -> Bool
/= :: StrvBuilder -> StrvBuilder -> Bool
Eq)

instance SP.ManagedPtrNewtype StrvBuilder where
    toManagedPtr :: StrvBuilder -> ManagedPtr StrvBuilder
toManagedPtr (StrvBuilder 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 a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: StrvBuilder -> IO ()
boxedPtrFree = \StrvBuilder
_x -> () -> IO ()
forall a. a -> IO a
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, DK.Type)])
#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 = Just "a #GStrvBuilder" , 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 = Just "a string." , 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 ()

-- | Add a string to the end of the array.
-- 
-- Since 2.68
strvBuilderAdd ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    StrvBuilder
    -- ^ /@builder@/: a t'GI.GLib.Structs.StrvBuilder.StrvBuilder'
    -> T.Text
    -- ^ /@value@/: a string.
    -> m ()
strvBuilderAdd :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
StrvBuilder -> Text -> m ()
strvBuilderAdd StrvBuilder
builder Text
value = IO () -> m ()
forall a. IO a -> m a
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 a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

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

instance O.OverloadedMethodInfo StrvBuilderAddMethodInfo StrvBuilder where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GLib.Structs.StrvBuilder.strvBuilderAdd",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-glib-2.0.29/docs/GI-GLib-Structs-StrvBuilder.html#v:strvBuilderAdd"
        })


#endif

-- method StrvBuilder::addv
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "builder"
--           , argType =
--               TInterface Name { namespace = "GLib" , name = "StrvBuilder" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GStrvBuilder" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "value"
--           , argType = TCArray True (-1) (-1) (TBasicType TUTF8)
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the vector of strings to add"
--                 , 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_addv" g_strv_builder_addv :: 
    Ptr StrvBuilder ->                      -- builder : TInterface (Name {namespace = "GLib", name = "StrvBuilder"})
    Ptr CString ->                          -- value : TCArray True (-1) (-1) (TBasicType TUTF8)
    IO ()

-- | Appends all the strings in the given vector to the builder.
-- 
-- Since 2.70
strvBuilderAddv ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    StrvBuilder
    -- ^ /@builder@/: a t'GI.GLib.Structs.StrvBuilder.StrvBuilder'
    -> [T.Text]
    -- ^ /@value@/: the vector of strings to add
    -> m ()
strvBuilderAddv :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
StrvBuilder -> [Text] -> m ()
strvBuilderAddv StrvBuilder
builder [Text]
value = IO () -> m ()
forall a. IO a -> m a
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 CString
value' <- [Text] -> IO (Ptr CString)
packZeroTerminatedUTF8CArray [Text]
value
    Ptr StrvBuilder -> Ptr CString -> IO ()
g_strv_builder_addv Ptr StrvBuilder
builder' Ptr CString
value'
    StrvBuilder -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr StrvBuilder
builder
    (CString -> IO ()) -> Ptr CString -> IO ()
forall a b. (Ptr a -> IO b) -> Ptr (Ptr a) -> IO ()
mapZeroTerminatedCArray CString -> IO ()
forall a. Ptr a -> IO ()
freeMem Ptr CString
value'
    Ptr CString -> IO ()
forall a. Ptr a -> IO ()
freeMem Ptr CString
value'
    () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data StrvBuilderAddvMethodInfo
instance (signature ~ ([T.Text] -> m ()), MonadIO m) => O.OverloadedMethod StrvBuilderAddvMethodInfo StrvBuilder signature where
    overloadedMethod = strvBuilderAddv

instance O.OverloadedMethodInfo StrvBuilderAddvMethodInfo StrvBuilder where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GLib.Structs.StrvBuilder.strvBuilderAddv",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-glib-2.0.29/docs/GI-GLib-Structs-StrvBuilder.html#v:strvBuilderAddv"
        })


#endif

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

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

-- | Ends the builder process and returns the constructed NULL-terminated string
-- array. The returned value should be freed with 'GI.GLib.Functions.strfreev' when no longer
-- needed.
strvBuilderEnd ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    StrvBuilder
    -- ^ /@builder@/: a t'GI.GLib.Structs.StrvBuilder.StrvBuilder'
    -> m [T.Text]
    -- ^ __Returns:__ the constructed string array.
    -- 
    -- Since 2.68
strvBuilderEnd :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
StrvBuilder -> m [Text]
strvBuilderEnd StrvBuilder
builder = IO [Text] -> m [Text]
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO [Text] -> m [Text]) -> IO [Text] -> m [Text]
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 CString
result <- Ptr StrvBuilder -> IO (Ptr CString)
g_strv_builder_end Ptr StrvBuilder
builder'
    Text -> Ptr CString -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"strvBuilderEnd" Ptr CString
result
    [Text]
result' <- HasCallStack => Ptr CString -> IO [Text]
Ptr CString -> IO [Text]
unpackZeroTerminatedUTF8CArray Ptr CString
result
    (CString -> IO ()) -> Ptr CString -> IO ()
forall a b. (Ptr a -> IO b) -> Ptr (Ptr a) -> IO ()
mapZeroTerminatedCArray CString -> IO ()
forall a. Ptr a -> IO ()
freeMem Ptr CString
result
    Ptr CString -> IO ()
forall a. Ptr a -> IO ()
freeMem Ptr CString
result
    StrvBuilder -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr StrvBuilder
builder
    [Text] -> IO [Text]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return [Text]
result'

#if defined(ENABLE_OVERLOADING)
data StrvBuilderEndMethodInfo
instance (signature ~ (m [T.Text]), MonadIO m) => O.OverloadedMethod StrvBuilderEndMethodInfo StrvBuilder signature where
    overloadedMethod = strvBuilderEnd

instance O.OverloadedMethodInfo StrvBuilderEndMethodInfo StrvBuilder where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GLib.Structs.StrvBuilder.strvBuilderEnd",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-glib-2.0.29/docs/GI-GLib-Structs-StrvBuilder.html#v:strvBuilderEnd"
        })


#endif

-- XXX Could not generate method StrvBuilder::unref
-- Bad introspection data: Transferring a non-boxed struct with unknown size!
#if defined(ENABLE_OVERLOADING)
type family ResolveStrvBuilderMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveStrvBuilderMethod "add" o = StrvBuilderAddMethodInfo
    ResolveStrvBuilderMethod "addv" o = StrvBuilderAddvMethodInfo
    ResolveStrvBuilderMethod "end" o = StrvBuilderEndMethodInfo
    ResolveStrvBuilderMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveStrvBuilderMethod t StrvBuilder, O.OverloadedMethod 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

#if MIN_VERSION_base(4,13,0)
instance (info ~ ResolveStrvBuilderMethod t StrvBuilder, O.OverloadedMethod info StrvBuilder p, R.HasField t StrvBuilder p) => R.HasField t StrvBuilder p where
    getField = O.overloadedMethod @info

#endif

instance (info ~ ResolveStrvBuilderMethod t StrvBuilder, O.OverloadedMethodInfo info StrvBuilder) => OL.IsLabel t (O.MethodProxy info StrvBuilder) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.MethodProxy
#else
    fromLabel _ = O.MethodProxy
#endif

#endif