{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (garetxe@gmail.com)

Represents the resolve undo entries in an index object.
-}

module GI.Ggit.Structs.IndexEntriesResolveUndo
    ( 

-- * Exported types
    IndexEntriesResolveUndo(..)             ,
    noIndexEntriesResolveUndo               ,


 -- * Methods
-- ** get #method:get#
#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
    IndexEntriesResolveUndoGetMethodInfo    ,
#endif
    indexEntriesResolveUndoGet              ,


-- ** getByFile #method:getByFile#
#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
    IndexEntriesResolveUndoGetByFileMethodInfo,
#endif
    indexEntriesResolveUndoGetByFile        ,


-- ** ref #method:ref#
#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
    IndexEntriesResolveUndoRefMethodInfo    ,
#endif
    indexEntriesResolveUndoRef              ,


-- ** size #method:size#
#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
    IndexEntriesResolveUndoSizeMethodInfo   ,
#endif
    indexEntriesResolveUndoSize             ,


-- ** unref #method:unref#
#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
    IndexEntriesResolveUndoUnrefMethodInfo  ,
#endif
    indexEntriesResolveUndoUnref            ,




    ) 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.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
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 {-# SOURCE #-} qualified GI.Ggit.Structs.IndexEntryResolveUndo as Ggit.IndexEntryResolveUndo
import qualified GI.Gio.Interfaces.File as Gio.File

newtype IndexEntriesResolveUndo = IndexEntriesResolveUndo (ManagedPtr IndexEntriesResolveUndo)
foreign import ccall "ggit_index_entries_resolve_undo_get_type" c_ggit_index_entries_resolve_undo_get_type :: 
    IO GType

instance BoxedObject IndexEntriesResolveUndo where
    boxedType _ = c_ggit_index_entries_resolve_undo_get_type

noIndexEntriesResolveUndo :: Maybe IndexEntriesResolveUndo
noIndexEntriesResolveUndo = Nothing


#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
instance O.HasAttributeList IndexEntriesResolveUndo
type instance O.AttributeList IndexEntriesResolveUndo = IndexEntriesResolveUndoAttributeList
type IndexEntriesResolveUndoAttributeList = ('[ ] :: [(Symbol, *)])
#endif

-- method IndexEntriesResolveUndo::get
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "entries", argType = TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GgitIndexEntriesResolveUndo.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "idx", argType = TBasicType TUInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the index of the entry.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Ggit", name = "IndexEntryResolveUndo"}))
-- throws : False
-- Skip return : False

foreign import ccall "ggit_index_entries_resolve_undo_get" ggit_index_entries_resolve_undo_get :: 
    Ptr IndexEntriesResolveUndo ->          -- entries : TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"})
    Word32 ->                               -- idx : TBasicType TUInt
    IO (Ptr Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo)

{- |
Get a 'GI.Ggit.Structs.IndexEntryResolveUndo.IndexEntryResolveUndo' by index. Note that the returned
'GI.Ggit.Structs.IndexEntryResolveUndo.IndexEntryResolveUndo' is _only_ valid as long as:

1) The associated index has been closed
2) The entry has not been removed (see 'GI.Ggit.Objects.Index.indexRemove')
3) The index has not been refreshed (see 'GI.Ggit.Objects.Index.indexRead')
-}
indexEntriesResolveUndoGet ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    IndexEntriesResolveUndo
    {- ^ /@entries@/: a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
    -> Word32
    {- ^ /@idx@/: the index of the entry. -}
    -> m Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo
    {- ^ __Returns:__ a 'GI.Ggit.Structs.IndexEntryResolveUndo.IndexEntryResolveUndo'. -}
indexEntriesResolveUndoGet entries idx = liftIO $ do
    entries' <- unsafeManagedPtrGetPtr entries
    result <- ggit_index_entries_resolve_undo_get entries' idx
    checkUnexpectedReturnNULL "indexEntriesResolveUndoGet" result
    result' <- (wrapBoxed Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo) result
    touchManagedPtr entries
    return result'

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
data IndexEntriesResolveUndoGetMethodInfo
instance (signature ~ (Word32 -> m Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo), MonadIO m) => O.MethodInfo IndexEntriesResolveUndoGetMethodInfo IndexEntriesResolveUndo signature where
    overloadedMethod _ = indexEntriesResolveUndoGet

#endif

-- method IndexEntriesResolveUndo::get_by_file
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "entries", argType = TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GgitIndexEntriesResolveUndo.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "file", argType = TInterface (Name {namespace = "Gio", name = "File"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GFile.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Ggit", name = "IndexEntryResolveUndo"}))
-- throws : False
-- Skip return : False

foreign import ccall "ggit_index_entries_resolve_undo_get_by_file" ggit_index_entries_resolve_undo_get_by_file :: 
    Ptr IndexEntriesResolveUndo ->          -- entries : TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"})
    Ptr Gio.File.File ->                    -- file : TInterface (Name {namespace = "Gio", name = "File"})
    IO (Ptr Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo)

{- |
Get an resolve_undo entry specified by path. The returned entry is read
only and should not be modified by the caller. If the entry could not be
found, 'Nothing' is returned.
-}
indexEntriesResolveUndoGetByFile ::
    (B.CallStack.HasCallStack, MonadIO m, Gio.File.IsFile a) =>
    IndexEntriesResolveUndo
    {- ^ /@entries@/: a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
    -> a
    {- ^ /@file@/: a 'GI.Gio.Interfaces.File.File'. -}
    -> m Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo
    {- ^ __Returns:__ a 'GI.Ggit.Structs.IndexEntryResolveUndo.IndexEntryResolveUndo' or 'Nothing'. -}
indexEntriesResolveUndoGetByFile entries file = liftIO $ do
    entries' <- unsafeManagedPtrGetPtr entries
    file' <- unsafeManagedPtrCastPtr file
    result <- ggit_index_entries_resolve_undo_get_by_file entries' file'
    checkUnexpectedReturnNULL "indexEntriesResolveUndoGetByFile" result
    result' <- (wrapBoxed Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo) result
    touchManagedPtr entries
    touchManagedPtr file
    return result'

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
data IndexEntriesResolveUndoGetByFileMethodInfo
instance (signature ~ (a -> m Ggit.IndexEntryResolveUndo.IndexEntryResolveUndo), MonadIO m, Gio.File.IsFile a) => O.MethodInfo IndexEntriesResolveUndoGetByFileMethodInfo IndexEntriesResolveUndo signature where
    overloadedMethod _ = indexEntriesResolveUndoGetByFile

#endif

-- method IndexEntriesResolveUndo::ref
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "entries", argType = TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GgitIndexEntriesResolveUndo.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}))
-- throws : False
-- Skip return : False

foreign import ccall "ggit_index_entries_resolve_undo_ref" ggit_index_entries_resolve_undo_ref :: 
    Ptr IndexEntriesResolveUndo ->          -- entries : TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"})
    IO (Ptr IndexEntriesResolveUndo)

{- |
Atomically increments the reference count of /@entries@/ by one.
This function is MT-safe and may be called from any thread.
-}
indexEntriesResolveUndoRef ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    IndexEntriesResolveUndo
    {- ^ /@entries@/: a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
    -> m IndexEntriesResolveUndo
    {- ^ __Returns:__ a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
indexEntriesResolveUndoRef entries = liftIO $ do
    entries' <- unsafeManagedPtrGetPtr entries
    result <- ggit_index_entries_resolve_undo_ref entries'
    checkUnexpectedReturnNULL "indexEntriesResolveUndoRef" result
    result' <- (newBoxed IndexEntriesResolveUndo) result
    touchManagedPtr entries
    return result'

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
data IndexEntriesResolveUndoRefMethodInfo
instance (signature ~ (m IndexEntriesResolveUndo), MonadIO m) => O.MethodInfo IndexEntriesResolveUndoRefMethodInfo IndexEntriesResolveUndo signature where
    overloadedMethod _ = indexEntriesResolveUndoRef

#endif

-- method IndexEntriesResolveUndo::size
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "entries", argType = TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GgitIndexEntriesResolveUndo.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "ggit_index_entries_resolve_undo_size" ggit_index_entries_resolve_undo_size :: 
    Ptr IndexEntriesResolveUndo ->          -- entries : TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"})
    IO Word32

{- |
Get the number of 'GI.Ggit.Structs.IndexEntryResolveUndo.IndexEntryResolveUndo' entries.
-}
indexEntriesResolveUndoSize ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    IndexEntriesResolveUndo
    {- ^ /@entries@/: a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
    -> m Word32
    {- ^ __Returns:__ the number of entries. -}
indexEntriesResolveUndoSize entries = liftIO $ do
    entries' <- unsafeManagedPtrGetPtr entries
    result <- ggit_index_entries_resolve_undo_size entries'
    touchManagedPtr entries
    return result

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
data IndexEntriesResolveUndoSizeMethodInfo
instance (signature ~ (m Word32), MonadIO m) => O.MethodInfo IndexEntriesResolveUndoSizeMethodInfo IndexEntriesResolveUndo signature where
    overloadedMethod _ = indexEntriesResolveUndoSize

#endif

-- method IndexEntriesResolveUndo::unref
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "entries", argType = TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GgitIndexEntriesResolveUndo.", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "ggit_index_entries_resolve_undo_unref" ggit_index_entries_resolve_undo_unref :: 
    Ptr IndexEntriesResolveUndo ->          -- entries : TInterface (Name {namespace = "Ggit", name = "IndexEntriesResolveUndo"})
    IO ()

{- |
Atomically decrements the reference count of /@entries@/ by one.
If the reference count drops to 0, /@entries@/ is freed.
-}
indexEntriesResolveUndoUnref ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    IndexEntriesResolveUndo
    {- ^ /@entries@/: a 'GI.Ggit.Structs.IndexEntriesResolveUndo.IndexEntriesResolveUndo'. -}
    -> m ()
indexEntriesResolveUndoUnref entries = liftIO $ do
    entries' <- unsafeManagedPtrGetPtr entries
    ggit_index_entries_resolve_undo_unref entries'
    touchManagedPtr entries
    return ()

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
data IndexEntriesResolveUndoUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.MethodInfo IndexEntriesResolveUndoUnrefMethodInfo IndexEntriesResolveUndo signature where
    overloadedMethod _ = indexEntriesResolveUndoUnref

#endif

#if defined(ENABLE_OVERLOADING) && !defined(__HADDOCK_VERSION__)
type family ResolveIndexEntriesResolveUndoMethod (t :: Symbol) (o :: *) :: * where
    ResolveIndexEntriesResolveUndoMethod "get" o = IndexEntriesResolveUndoGetMethodInfo
    ResolveIndexEntriesResolveUndoMethod "ref" o = IndexEntriesResolveUndoRefMethodInfo
    ResolveIndexEntriesResolveUndoMethod "size" o = IndexEntriesResolveUndoSizeMethodInfo
    ResolveIndexEntriesResolveUndoMethod "unref" o = IndexEntriesResolveUndoUnrefMethodInfo
    ResolveIndexEntriesResolveUndoMethod "getByFile" o = IndexEntriesResolveUndoGetByFileMethodInfo
    ResolveIndexEntriesResolveUndoMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveIndexEntriesResolveUndoMethod t IndexEntriesResolveUndo, O.MethodInfo info IndexEntriesResolveUndo p) => O.IsLabelProxy t (IndexEntriesResolveUndo -> p) where
    fromLabelProxy _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)

#if MIN_VERSION_base(4,9,0)
instance (info ~ ResolveIndexEntriesResolveUndoMethod t IndexEntriesResolveUndo, O.MethodInfo info IndexEntriesResolveUndo p) => O.IsLabel t (IndexEntriesResolveUndo -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#else
    fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#endif
#endif

#endif