    {-# LANGUAGE TypeApplications #-}

    -- | Copyright  : Will Thompson and Iñaki García Etxebarria
    -- License    : LGPL-2.1
    -- Maintainer : Iñaki García Etxebarria
    --
    -- An opaque type representing a string as an index into a table
    -- of strings on the X server.

    #if !defined(__HADDOCK_VERSION__)
    #define ENABLE_OVERLOADING
    #endif

    module GI.Gdk.Structs.Atom
        (

    -- * Exported types
        Atom(..)                                ,

     -- * Methods
    -- |
    --
    --  === __Click to display all available methods, including inherited ones__
    -- ==== Methods
    -- [name]("GI.Gdk.Structs.Atom#g:method:name").
    --
    -- ==== Getters
    -- /None/.
    --
    -- ==== Setters
    -- /None/.

    #if defined(ENABLE_OVERLOADING)
        ResolveAtomMethod                       ,
    #endif

    -- ** intern #method:intern#

        atomIntern                              ,

    -- ** internStaticString #method:internStaticString#

        atomInternStaticString                  ,

    -- ** name #method:name#

    #if defined(ENABLE_OVERLOADING)
        AtomNameMethodInfo                      ,
    #endif
        atomName                                ,

        ) 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 Atom = Atom (SP.ManagedPtr Atom)
        deriving (Atom -> Atom -> Bool
    (Atom -> Atom -> Bool) -> (Atom -> Atom -> Bool) -> Eq Atom
    forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
    $c== :: Atom -> Atom -> Bool
    == :: Atom -> Atom -> Bool
    $c/= :: Atom -> Atom -> Bool
    /= :: Atom -> Atom -> Bool
    Eq)

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

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

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

    -- method Atom::name
    -- method type : OrdinaryMethod
    -- Args: [ Arg
    --           { argCName = "atom"
    --           , argType = TInterface Name { namespace = "Gdk" , name = "Atom" }
    --           , argCType = Just "GdkAtom"
    --           , direction = DirectionIn
    --           , mayBeNull = False
    --           , argDoc =
    --               Documentation
    --                 { rawDocText = Just "a #GdkAtom." , 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 "gdk_atom_name" gdk_atom_name ::
        Ptr Atom ->                             -- atom : TInterface (Name {namespace = "Gdk", name = "Atom"})
        IO CString

    -- | Determines the string corresponding to an atom.
    atomName ::
        (B.CallStack.HasCallStack, MonadIO m) =>
        Atom
        -- ^ /@atom@/: a t'GI.Gdk.Structs.Atom.Atom'.
        -> m T.Text
        -- ^ __Returns:__ a newly-allocated string containing the string
        --   corresponding to /@atom@/. When you are done with the
        --   return value, you should free it using 'GI.GLib.Functions.free'.
    atomName :: forall (m :: * -> *). (HasCallStack, MonadIO m) => Atom -> m Text
    atomName Atom
    atom = 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
        atom' <- Atom -> IO (Ptr Atom)
    forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
    unsafeManagedPtrGetPtr Atom
    atom
        result <- gdk_atom_name atom'
        checkUnexpectedReturnNULL "atomName" result
        result' <- cstringToText result
        freeMem result
        touchManagedPtr atom
        return result'

    #if defined(ENABLE_OVERLOADING)
    data AtomNameMethodInfo
    instance (signature ~ (m T.Text), MonadIO m) => O.OverloadedMethod AtomNameMethodInfo Atom signature where
        overloadedMethod = atomName

    instance O.OverloadedMethodInfo AtomNameMethodInfo Atom where
        overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
            O.resolvedSymbolName = "GI.Gdk.Structs.Atom.atomName",
            O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gdk-3.0.29/docs/GI-Gdk-Structs-Atom.html#v:atomName"
            })

    #endif

    -- method Atom::intern
    -- method type : MemberFunction
    -- Args: [ Arg
    --           { argCName = "atom_name"
    --           , argType = TBasicType TUTF8
    --           , argCType = Just "const gchar*"
    --           , direction = DirectionIn
    --           , mayBeNull = False
    --           , argDoc =
    --               Documentation
    --                 { rawDocText = Just "a string." , sinceVersion = Nothing }
    --           , argScope = ScopeTypeInvalid
    --           , argClosure = -1
    --           , argDestroy = -1
    --           , argCallerAllocates = False
    --           , argCallbackUserData = False
    --           , transfer = TransferNothing
    --           }
    --       , Arg
    --           { argCName = "only_if_exists"
    --           , argType = TBasicType TBoolean
    --           , argCType = Just "gboolean"
    --           , direction = DirectionIn
    --           , mayBeNull = False
    --           , argDoc =
    --               Documentation
    --                 { rawDocText =
    --                     Just
    --                       "if %TRUE, GDK is allowed to not create a new atom, but\n  just return %GDK_NONE if the requested atom doesn\8217t already\n  exists. Currently, the flag is ignored, since checking the\n  existance of an atom is as expensive as creating it."
    --                 , sinceVersion = Nothing
    --                 }
    --           , argScope = ScopeTypeInvalid
    --           , argClosure = -1
    --           , argDestroy = -1
    --           , argCallerAllocates = False
    --           , argCallbackUserData = False
    --           , transfer = TransferNothing
    --           }
    --       ]
    -- Lengths: []
    -- returnType: Just (TInterface Name { namespace = "Gdk" , name = "Atom" })
    -- throws : False
    -- Skip return : False

    foreign import ccall "gdk_atom_intern" gdk_atom_intern ::
        CString ->                              -- atom_name : TBasicType TUTF8
        CInt ->                                 -- only_if_exists : TBasicType TBoolean
        IO (Ptr Atom)

    -- | Finds or creates an atom corresponding to a given string.
    atomIntern ::
        (B.CallStack.HasCallStack, MonadIO m) =>
        T.Text
        -- ^ /@atomName@/: a string.
        -> Bool
        -- ^ /@onlyIfExists@/: if 'P.True', GDK is allowed to not create a new atom, but
        --   just return @/GDK_NONE/@ if the requested atom doesn’t already
        --   exists. Currently, the flag is ignored, since checking the
        --   existance of an atom is as expensive as creating it.
        -> m Atom
        -- ^ __Returns:__ the atom corresponding to /@atomName@/.
    atomIntern :: forall (m :: * -> *).
    (HasCallStack, MonadIO m) =>
    Text -> Bool -> m Atom
    atomIntern Text
    atomName Bool
    onlyIfExists = IO Atom -> m Atom
    forall a. IO a -> m a
    forall (m :: * -> *) a. MonadIO m => IO a -> m a
    liftIO (IO Atom -> m Atom) -> IO Atom -> m Atom
    forall a b. (a -> b) -> a -> b
    $ do
        atomName' <- Text -> IO CString
    textToCString Text
    atomName
        let onlyIfExists' = (Int -> CInt
    forall a b. (Integral a, Num b) => a -> b
    P.fromIntegral (Int -> CInt) -> (Bool -> Int) -> Bool -> CInt
    forall b c a. (b -> c) -> (a -> b) -> a -> c
    . Bool -> Int
    forall a. Enum a => a -> Int
    P.fromEnum) Bool
    onlyIfExists
        result <- gdk_atom_intern atomName' onlyIfExists'
        checkUnexpectedReturnNULL "atomIntern" result
        result' <- (newPtr Atom) result
        freeMem atomName'
        return result'

    #if defined(ENABLE_OVERLOADING)
    #endif

    -- method Atom::intern_static_string
    -- method type : MemberFunction
    -- Args: [ Arg
    --           { argCName = "atom_name"
    --           , argType = TBasicType TUTF8
    --           , argCType = Just "const gchar*"
    --           , direction = DirectionIn
    --           , mayBeNull = False
    --           , argDoc =
    --               Documentation
    --                 { rawDocText = Just "a static string" , sinceVersion = Nothing }
    --           , argScope = ScopeTypeInvalid
    --           , argClosure = -1
    --           , argDestroy = -1
    --           , argCallerAllocates = False
    --           , argCallbackUserData = False
    --           , transfer = TransferNothing
    --           }
    --       ]
    -- Lengths: []
    -- returnType: Just (TInterface Name { namespace = "Gdk" , name = "Atom" })
    -- throws : False
    -- Skip return : False

    foreign import ccall "gdk_atom_intern_static_string" gdk_atom_intern_static_string ::
        CString ->                              -- atom_name : TBasicType TUTF8
        IO (Ptr Atom)

    -- | Finds or creates an atom corresponding to a given string.
    --
    -- Note that this function is identical to 'GI.Gdk.Functions.atomIntern' except
    -- that if a new t'GI.Gdk.Structs.Atom.Atom' is created the string itself is used rather
    -- than a copy. This saves memory, but can only be used if the string
    -- will always exist. It can be used with statically
    -- allocated strings in the main program, but not with statically
    -- allocated memory in dynamically loaded modules, if you expect to
    -- ever unload the module again (e.g. do not use this function in
    -- GTK+ theme engines).
    --
    -- /Since: 2.10/
    atomInternStaticString ::
        (B.CallStack.HasCallStack, MonadIO m) =>
        T.Text
        -- ^ /@atomName@/: a static string
        -> m Atom
        -- ^ __Returns:__ the atom corresponding to /@atomName@/
    atomInternStaticString :: forall (m :: * -> *). (HasCallStack, MonadIO m) => Text -> m Atom
    atomInternStaticString Text
    atomName = IO Atom -> m Atom
    forall a. IO a -> m a
    forall (m :: * -> *) a. MonadIO m => IO a -> m a
    liftIO (IO Atom -> m Atom) -> IO Atom -> m Atom
    forall a b. (a -> b) -> a -> b
    $ do
        atomName' <- Text -> IO CString
    textToCString Text
    atomName
        result <- gdk_atom_intern_static_string atomName'
        checkUnexpectedReturnNULL "atomInternStaticString" result
        result' <- (newPtr Atom) result
        freeMem atomName'
        return result'

    #if defined(ENABLE_OVERLOADING)
    #endif

    #if defined(ENABLE_OVERLOADING)
    type family ResolveAtomMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
        ResolveAtomMethod "name" o = AtomNameMethodInfo
        ResolveAtomMethod l o = O.MethodResolutionFailed l o

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

    #endif

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

    #endif