{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- This represents the configuration for a single remote repository. Currently,
-- remotes can only be passed around as (reference counted) opaque handles. In
-- future, more API may be added to create and interrogate them.
-- 
-- /Since: 2018.6/

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

module GI.OSTree.Structs.Remote
    ( 

-- * Exported types
    Remote(..)                              ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [ref]("GI.OSTree.Structs.Remote#g:method:ref"), [unref]("GI.OSTree.Structs.Remote#g:method:unref").
-- 
-- ==== Getters
-- [getName]("GI.OSTree.Structs.Remote#g:method:getName"), [getUrl]("GI.OSTree.Structs.Remote#g:method:getUrl").
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveRemoteMethod                     ,
#endif

-- ** getName #method:getName#

#if defined(ENABLE_OVERLOADING)
    RemoteGetNameMethodInfo                 ,
#endif
    remoteGetName                           ,


-- ** getUrl #method:getUrl#

#if defined(ENABLE_OVERLOADING)
    RemoteGetUrlMethodInfo                  ,
#endif
    remoteGetUrl                            ,


-- ** ref #method:ref#

#if defined(ENABLE_OVERLOADING)
    RemoteRefMethodInfo                     ,
#endif
    remoteRef                               ,


-- ** unref #method:unref#

#if defined(ENABLE_OVERLOADING)
    RemoteUnrefMethodInfo                   ,
#endif
    remoteUnref                             ,




    ) 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
import qualified Data.Word as DW
import qualified Data.Int as DI
import qualified System.Posix.Types as SPT
import qualified Foreign.C.Types as FCT

-- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/23392
#if MIN_VERSION_base(4,18,0)

#else

#endif

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

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

foreign import ccall "ostree_remote_get_type" c_ostree_remote_get_type :: 
    IO GType

type instance O.ParentTypes Remote = '[]
instance O.HasParentTypes Remote

instance B.Types.TypedObject Remote where
    glibType :: IO GType
glibType = IO GType
c_ostree_remote_get_type

instance B.Types.GBoxed Remote

-- | Convert t'Remote' to and from 'Data.GI.Base.GValue.GValue'. See 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue (Maybe Remote) where
    gvalueGType_ :: IO GType
gvalueGType_ = IO GType
c_ostree_remote_get_type
    gvalueSet_ :: Ptr GValue -> Maybe Remote -> IO ()
gvalueSet_ Ptr GValue
gv Maybe Remote
P.Nothing = Ptr GValue -> Ptr Remote -> IO ()
forall a. Ptr GValue -> Ptr a -> IO ()
B.GValue.set_boxed Ptr GValue
gv (Ptr Remote
forall a. Ptr a
FP.nullPtr :: FP.Ptr Remote)
    gvalueSet_ Ptr GValue
gv (P.Just Remote
obj) = Remote -> (Ptr Remote -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr Remote
obj (Ptr GValue -> Ptr Remote -> IO ()
forall a. Ptr GValue -> Ptr a -> IO ()
B.GValue.set_boxed Ptr GValue
gv)
    gvalueGet_ :: Ptr GValue -> IO (Maybe Remote)
gvalueGet_ Ptr GValue
gv = do
        ptr <- Ptr GValue -> IO (Ptr Remote)
forall b. Ptr GValue -> IO (Ptr b)
B.GValue.get_boxed Ptr GValue
gv :: IO (Ptr Remote)
        if ptr /= FP.nullPtr
        then P.Just <$> B.ManagedPtr.newBoxed Remote ptr
        else return P.Nothing
        
    


#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList Remote
type instance O.AttributeList Remote = RemoteAttributeList
type RemoteAttributeList = ('[ ] :: [(Symbol, DK.Type)])
#endif

-- method Remote::get_name
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "remote"
--           , argType =
--               TInterface Name { namespace = "OSTree" , name = "Remote" }
--           , argCType = Just "OstreeRemote*"
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "an #OstreeRemote" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "ostree_remote_get_name" ostree_remote_get_name :: 
    Ptr Remote ->                           -- remote : TInterface (Name {namespace = "OSTree", name = "Remote"})
    IO CString

-- | Get the human-readable name of the remote. This is what the user configured,
-- if the remote was explicitly configured; and will otherwise be a stable,
-- arbitrary, string.
-- 
-- /Since: 2018.6/
remoteGetName ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    Remote
    -- ^ /@remote@/: an t'GI.OSTree.Structs.Remote.Remote'
    -> m T.Text
    -- ^ __Returns:__ remote’s name
remoteGetName :: forall (m :: * -> *). (HasCallStack, MonadIO m) => Remote -> m Text
remoteGetName Remote
remote = 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
    remote' <- Remote -> IO (Ptr Remote)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr Remote
remote
    result <- ostree_remote_get_name remote'
    checkUnexpectedReturnNULL "remoteGetName" result
    result' <- cstringToText result
    touchManagedPtr remote
    return result'

#if defined(ENABLE_OVERLOADING)
data RemoteGetNameMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.OverloadedMethod RemoteGetNameMethodInfo Remote signature where
    overloadedMethod = remoteGetName

instance O.OverloadedMethodInfo RemoteGetNameMethodInfo Remote where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.OSTree.Structs.Remote.remoteGetName",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-ostree-1.0.19/docs/GI-OSTree-Structs-Remote.html#v:remoteGetName"
        })


#endif

-- method Remote::get_url
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "remote"
--           , argType =
--               TInterface Name { namespace = "OSTree" , name = "Remote" }
--           , argCType = Just "OstreeRemote*"
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "an #OstreeRemote" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "ostree_remote_get_url" ostree_remote_get_url :: 
    Ptr Remote ->                           -- remote : TInterface (Name {namespace = "OSTree", name = "Remote"})
    IO CString

-- | Get the URL from the remote.
-- 
-- /Since: 2018.6/
remoteGetUrl ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    Remote
    -- ^ /@remote@/: an t'GI.OSTree.Structs.Remote.Remote'
    -> m (Maybe T.Text)
    -- ^ __Returns:__ the remote\'s URL
remoteGetUrl :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
Remote -> m (Maybe Text)
remoteGetUrl Remote
remote = IO (Maybe Text) -> m (Maybe Text)
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO (Maybe Text) -> m (Maybe Text))
-> IO (Maybe Text) -> m (Maybe Text)
forall a b. (a -> b) -> a -> b
$ do
    remote' <- Remote -> IO (Ptr Remote)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr Remote
remote
    result <- ostree_remote_get_url remote'
    maybeResult <- convertIfNonNull result $ \CString
result' -> do
        result'' <- HasCallStack => CString -> IO Text
CString -> IO Text
cstringToText CString
result'
        freeMem result'
        return result''
    touchManagedPtr remote
    return maybeResult

#if defined(ENABLE_OVERLOADING)
data RemoteGetUrlMethodInfo
instance (signature ~ (m (Maybe T.Text)), MonadIO m) => O.OverloadedMethod RemoteGetUrlMethodInfo Remote signature where
    overloadedMethod = remoteGetUrl

instance O.OverloadedMethodInfo RemoteGetUrlMethodInfo Remote where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.OSTree.Structs.Remote.remoteGetUrl",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-ostree-1.0.19/docs/GI-OSTree-Structs-Remote.html#v:remoteGetUrl"
        })


#endif

-- method Remote::ref
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "remote"
--           , argType =
--               TInterface Name { namespace = "OSTree" , name = "Remote" }
--           , argCType = Just "OstreeRemote*"
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "an #OstreeRemote" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "OSTree" , name = "Remote" })
-- throws : False
-- Skip return : False

foreign import ccall "ostree_remote_ref" ostree_remote_ref :: 
    Ptr Remote ->                           -- remote : TInterface (Name {namespace = "OSTree", name = "Remote"})
    IO (Ptr Remote)

-- | Increase the reference count on the given /@remote@/.
-- 
-- /Since: 2018.6/
remoteRef ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    Remote
    -- ^ /@remote@/: an t'GI.OSTree.Structs.Remote.Remote'
    -> m Remote
    -- ^ __Returns:__ a copy of /@remote@/, for convenience
remoteRef :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
Remote -> m Remote
remoteRef Remote
remote = IO Remote -> m Remote
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Remote -> m Remote) -> IO Remote -> m Remote
forall a b. (a -> b) -> a -> b
$ do
    remote' <- Remote -> IO (Ptr Remote)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr Remote
remote
    result <- ostree_remote_ref remote'
    checkUnexpectedReturnNULL "remoteRef" result
    result' <- (wrapBoxed Remote) result
    touchManagedPtr remote
    return result'

#if defined(ENABLE_OVERLOADING)
data RemoteRefMethodInfo
instance (signature ~ (m Remote), MonadIO m) => O.OverloadedMethod RemoteRefMethodInfo Remote signature where
    overloadedMethod = remoteRef

instance O.OverloadedMethodInfo RemoteRefMethodInfo Remote where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.OSTree.Structs.Remote.remoteRef",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-ostree-1.0.19/docs/GI-OSTree-Structs-Remote.html#v:remoteRef"
        })


#endif

-- method Remote::unref
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "remote"
--           , argType =
--               TInterface Name { namespace = "OSTree" , name = "Remote" }
--           , argCType = Just "OstreeRemote*"
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "an #OstreeRemote" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferEverything
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "ostree_remote_unref" ostree_remote_unref :: 
    Ptr Remote ->                           -- remote : TInterface (Name {namespace = "OSTree", name = "Remote"})
    IO ()

-- | Decrease the reference count on the given /@remote@/ and free it if the
-- reference count reaches 0.
-- 
-- /Since: 2018.6/
remoteUnref ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    Remote
    -- ^ /@remote@/: an t'GI.OSTree.Structs.Remote.Remote'
    -> m ()
remoteUnref :: forall (m :: * -> *). (HasCallStack, MonadIO m) => Remote -> m ()
remoteUnref Remote
remote = 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
    remote' <- Remote -> IO (Ptr Remote)
forall a. (HasCallStack, GBoxed a) => a -> IO (Ptr a)
B.ManagedPtr.disownBoxed Remote
remote
    ostree_remote_unref remote'
    touchManagedPtr remote
    return ()

#if defined(ENABLE_OVERLOADING)
data RemoteUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.OverloadedMethod RemoteUnrefMethodInfo Remote signature where
    overloadedMethod = remoteUnref

instance O.OverloadedMethodInfo RemoteUnrefMethodInfo Remote where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.OSTree.Structs.Remote.remoteUnref",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-ostree-1.0.19/docs/GI-OSTree-Structs-Remote.html#v:remoteUnref"
        })


#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveRemoteMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveRemoteMethod "ref" o = RemoteRefMethodInfo
    ResolveRemoteMethod "unref" o = RemoteUnrefMethodInfo
    ResolveRemoteMethod "getName" o = RemoteGetNameMethodInfo
    ResolveRemoteMethod "getUrl" o = RemoteGetUrlMethodInfo
    ResolveRemoteMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveRemoteMethod t Remote, O.OverloadedMethod info Remote p) => OL.IsLabel t (Remote -> 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 ~ ResolveRemoteMethod t Remote, O.OverloadedMethod info Remote p, R.HasField t Remote p) => R.HasField t Remote p where
    getField = O.overloadedMethod @info

#endif

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

#endif