{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A structure that provides information to the type system which is
-- used specifically for managing fundamental types.

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

module GI.GObject.Structs.TypeFundamentalInfo
    ( 

-- * Exported types
    TypeFundamentalInfo(..)                 ,
    newZeroTypeFundamentalInfo              ,
    noTypeFundamentalInfo                   ,


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

#if defined(ENABLE_OVERLOADING)
    ResolveTypeFundamentalInfoMethod        ,
#endif




 -- * Properties
-- ** typeFlags #attr:typeFlags#
-- | t'GI.GObject.Flags.TypeFundamentalFlags' describing the characteristics of the fundamental type

    getTypeFundamentalInfoTypeFlags         ,
    setTypeFundamentalInfoTypeFlags         ,
#if defined(ENABLE_OVERLOADING)
    typeFundamentalInfo_typeFlags           ,
#endif




    ) 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.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 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

import {-# SOURCE #-} qualified GI.GObject.Flags as GObject.Flags

-- | Memory-managed wrapper type.
newtype TypeFundamentalInfo = TypeFundamentalInfo (ManagedPtr TypeFundamentalInfo)
    deriving (TypeFundamentalInfo -> TypeFundamentalInfo -> Bool
(TypeFundamentalInfo -> TypeFundamentalInfo -> Bool)
-> (TypeFundamentalInfo -> TypeFundamentalInfo -> Bool)
-> Eq TypeFundamentalInfo
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TypeFundamentalInfo -> TypeFundamentalInfo -> Bool
$c/= :: TypeFundamentalInfo -> TypeFundamentalInfo -> Bool
== :: TypeFundamentalInfo -> TypeFundamentalInfo -> Bool
$c== :: TypeFundamentalInfo -> TypeFundamentalInfo -> Bool
Eq)
instance WrappedPtr TypeFundamentalInfo where
    wrappedPtrCalloc :: IO (Ptr TypeFundamentalInfo)
wrappedPtrCalloc = Int -> IO (Ptr TypeFundamentalInfo)
forall a. Int -> IO (Ptr a)
callocBytes 4
    wrappedPtrCopy :: TypeFundamentalInfo -> IO TypeFundamentalInfo
wrappedPtrCopy = \p :: TypeFundamentalInfo
p -> TypeFundamentalInfo
-> (Ptr TypeFundamentalInfo -> IO TypeFundamentalInfo)
-> IO TypeFundamentalInfo
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr TypeFundamentalInfo
p (Int -> Ptr TypeFundamentalInfo -> IO (Ptr TypeFundamentalInfo)
forall a. WrappedPtr a => Int -> Ptr a -> IO (Ptr a)
copyBytes 4 (Ptr TypeFundamentalInfo -> IO (Ptr TypeFundamentalInfo))
-> (Ptr TypeFundamentalInfo -> IO TypeFundamentalInfo)
-> Ptr TypeFundamentalInfo
-> IO TypeFundamentalInfo
forall (m :: * -> *) a b c.
Monad m =>
(a -> m b) -> (b -> m c) -> a -> m c
>=> (ManagedPtr TypeFundamentalInfo -> TypeFundamentalInfo)
-> Ptr TypeFundamentalInfo -> IO TypeFundamentalInfo
forall a.
(HasCallStack, WrappedPtr a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapPtr ManagedPtr TypeFundamentalInfo -> TypeFundamentalInfo
TypeFundamentalInfo)
    wrappedPtrFree :: Maybe (GDestroyNotify TypeFundamentalInfo)
wrappedPtrFree = GDestroyNotify TypeFundamentalInfo
-> Maybe (GDestroyNotify TypeFundamentalInfo)
forall a. a -> Maybe a
Just GDestroyNotify TypeFundamentalInfo
forall a. FunPtr (Ptr a -> IO ())
ptr_to_g_free

-- | Construct a `TypeFundamentalInfo` struct initialized to zero.
newZeroTypeFundamentalInfo :: MonadIO m => m TypeFundamentalInfo
newZeroTypeFundamentalInfo :: m TypeFundamentalInfo
newZeroTypeFundamentalInfo = IO TypeFundamentalInfo -> m TypeFundamentalInfo
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO TypeFundamentalInfo -> m TypeFundamentalInfo)
-> IO TypeFundamentalInfo -> m TypeFundamentalInfo
forall a b. (a -> b) -> a -> b
$ IO (Ptr TypeFundamentalInfo)
forall a. WrappedPtr a => IO (Ptr a)
wrappedPtrCalloc IO (Ptr TypeFundamentalInfo)
-> (Ptr TypeFundamentalInfo -> IO TypeFundamentalInfo)
-> IO TypeFundamentalInfo
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= (ManagedPtr TypeFundamentalInfo -> TypeFundamentalInfo)
-> Ptr TypeFundamentalInfo -> IO TypeFundamentalInfo
forall a.
(HasCallStack, WrappedPtr a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapPtr ManagedPtr TypeFundamentalInfo -> TypeFundamentalInfo
TypeFundamentalInfo

instance tag ~ 'AttrSet => Constructible TypeFundamentalInfo tag where
    new :: (ManagedPtr TypeFundamentalInfo -> TypeFundamentalInfo)
-> [AttrOp TypeFundamentalInfo tag] -> m TypeFundamentalInfo
new _ attrs :: [AttrOp TypeFundamentalInfo tag]
attrs = do
        TypeFundamentalInfo
o <- m TypeFundamentalInfo
forall (m :: * -> *). MonadIO m => m TypeFundamentalInfo
newZeroTypeFundamentalInfo
        TypeFundamentalInfo
-> [AttrOp TypeFundamentalInfo 'AttrSet] -> m ()
forall o (m :: * -> *).
MonadIO m =>
o -> [AttrOp o 'AttrSet] -> m ()
GI.Attributes.set TypeFundamentalInfo
o [AttrOp TypeFundamentalInfo tag]
[AttrOp TypeFundamentalInfo 'AttrSet]
attrs
        TypeFundamentalInfo -> m TypeFundamentalInfo
forall (m :: * -> *) a. Monad m => a -> m a
return TypeFundamentalInfo
o


-- | A convenience alias for `Nothing` :: `Maybe` `TypeFundamentalInfo`.
noTypeFundamentalInfo :: Maybe TypeFundamentalInfo
noTypeFundamentalInfo :: Maybe TypeFundamentalInfo
noTypeFundamentalInfo = Maybe TypeFundamentalInfo
forall a. Maybe a
Nothing

-- | Get the value of the “@type_flags@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.get' typeFundamentalInfo #typeFlags
-- @
getTypeFundamentalInfoTypeFlags :: MonadIO m => TypeFundamentalInfo -> m [GObject.Flags.TypeFundamentalFlags]
getTypeFundamentalInfoTypeFlags :: TypeFundamentalInfo -> m [TypeFundamentalFlags]
getTypeFundamentalInfoTypeFlags s :: TypeFundamentalInfo
s = IO [TypeFundamentalFlags] -> m [TypeFundamentalFlags]
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO [TypeFundamentalFlags] -> m [TypeFundamentalFlags])
-> IO [TypeFundamentalFlags] -> m [TypeFundamentalFlags]
forall a b. (a -> b) -> a -> b
$ TypeFundamentalInfo
-> (Ptr TypeFundamentalInfo -> IO [TypeFundamentalFlags])
-> IO [TypeFundamentalFlags]
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr TypeFundamentalInfo
s ((Ptr TypeFundamentalInfo -> IO [TypeFundamentalFlags])
 -> IO [TypeFundamentalFlags])
-> (Ptr TypeFundamentalInfo -> IO [TypeFundamentalFlags])
-> IO [TypeFundamentalFlags]
forall a b. (a -> b) -> a -> b
$ \ptr :: Ptr TypeFundamentalInfo
ptr -> do
    CUInt
val <- Ptr CUInt -> IO CUInt
forall a. Storable a => Ptr a -> IO a
peek (Ptr TypeFundamentalInfo
ptr Ptr TypeFundamentalInfo -> Int -> Ptr CUInt
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0) :: IO CUInt
    let val' :: [TypeFundamentalFlags]
val' = CUInt -> [TypeFundamentalFlags]
forall a b. (Storable a, Integral a, Bits a, IsGFlag b) => a -> [b]
wordToGFlags CUInt
val
    [TypeFundamentalFlags] -> IO [TypeFundamentalFlags]
forall (m :: * -> *) a. Monad m => a -> m a
return [TypeFundamentalFlags]
val'

-- | Set the value of the “@type_flags@” field.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.set' typeFundamentalInfo [ #typeFlags 'Data.GI.Base.Attributes.:=' value ]
-- @
setTypeFundamentalInfoTypeFlags :: MonadIO m => TypeFundamentalInfo -> [GObject.Flags.TypeFundamentalFlags] -> m ()
setTypeFundamentalInfoTypeFlags :: TypeFundamentalInfo -> [TypeFundamentalFlags] -> m ()
setTypeFundamentalInfoTypeFlags s :: TypeFundamentalInfo
s val :: [TypeFundamentalFlags]
val = IO () -> m ()
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ TypeFundamentalInfo -> (Ptr TypeFundamentalInfo -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
withManagedPtr TypeFundamentalInfo
s ((Ptr TypeFundamentalInfo -> IO ()) -> IO ())
-> (Ptr TypeFundamentalInfo -> IO ()) -> IO ()
forall a b. (a -> b) -> a -> b
$ \ptr :: Ptr TypeFundamentalInfo
ptr -> do
    let val' :: CUInt
val' = [TypeFundamentalFlags] -> CUInt
forall b a. (Num b, IsGFlag a) => [a] -> b
gflagsToWord [TypeFundamentalFlags]
val
    Ptr CUInt -> CUInt -> IO ()
forall a. Storable a => Ptr a -> a -> IO ()
poke (Ptr TypeFundamentalInfo
ptr Ptr TypeFundamentalInfo -> Int -> Ptr CUInt
forall a b. Ptr a -> Int -> Ptr b
`plusPtr` 0) (CUInt
val' :: CUInt)

#if defined(ENABLE_OVERLOADING)
data TypeFundamentalInfoTypeFlagsFieldInfo
instance AttrInfo TypeFundamentalInfoTypeFlagsFieldInfo where
    type AttrBaseTypeConstraint TypeFundamentalInfoTypeFlagsFieldInfo = (~) TypeFundamentalInfo
    type AttrAllowedOps TypeFundamentalInfoTypeFlagsFieldInfo = '[ 'AttrSet, 'AttrGet]
    type AttrSetTypeConstraint TypeFundamentalInfoTypeFlagsFieldInfo = (~) [GObject.Flags.TypeFundamentalFlags]
    type AttrTransferTypeConstraint TypeFundamentalInfoTypeFlagsFieldInfo = (~)[GObject.Flags.TypeFundamentalFlags]
    type AttrTransferType TypeFundamentalInfoTypeFlagsFieldInfo = [GObject.Flags.TypeFundamentalFlags]
    type AttrGetType TypeFundamentalInfoTypeFlagsFieldInfo = [GObject.Flags.TypeFundamentalFlags]
    type AttrLabel TypeFundamentalInfoTypeFlagsFieldInfo = "type_flags"
    type AttrOrigin TypeFundamentalInfoTypeFlagsFieldInfo = TypeFundamentalInfo
    attrGet = getTypeFundamentalInfoTypeFlags
    attrSet = setTypeFundamentalInfoTypeFlags
    attrConstruct = undefined
    attrClear = undefined
    attrTransfer _ v = do
        return v

typeFundamentalInfo_typeFlags :: AttrLabelProxy "typeFlags"
typeFundamentalInfo_typeFlags = AttrLabelProxy

#endif



#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList TypeFundamentalInfo
type instance O.AttributeList TypeFundamentalInfo = TypeFundamentalInfoAttributeList
type TypeFundamentalInfoAttributeList = ('[ '("typeFlags", TypeFundamentalInfoTypeFlagsFieldInfo)] :: [(Symbol, *)])
#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveTypeFundamentalInfoMethod (t :: Symbol) (o :: *) :: * where
    ResolveTypeFundamentalInfoMethod l o = O.MethodResolutionFailed l o

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

#endif