Hypertext.hs


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

An interface used for objects which implement linking between
multiple resource or content locations, or multiple \'markers\'
within a single document.  A Hypertext instance is associated with
one or more Hyperlinks, which are associated with particular
offsets within the Hypertext\'s included content.  While this
interface is derived from Text, there is no requirement that
Hypertext instances have textual content; they may implement Image
as well, and Hyperlinks need not have non-zero text offsets.
-}

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

module GI.Atk.Interfaces.Hypertext
    ( 

-- * Exported types
    Hypertext(..)                           ,
    noHypertext                             ,
    IsHypertext                             ,
    toHypertext                             ,


 -- * Methods
-- ** getLink #method:getLink#

#if ENABLE_OVERLOADING
    HypertextGetLinkMethodInfo              ,
#endif
    hypertextGetLink                        ,


-- ** getLinkIndex #method:getLinkIndex#

#if ENABLE_OVERLOADING
    HypertextGetLinkIndexMethodInfo         ,
#endif
    hypertextGetLinkIndex                   ,


-- ** getNLinks #method:getNLinks#

#if ENABLE_OVERLOADING
    HypertextGetNLinksMethodInfo            ,
#endif
    hypertextGetNLinks                      ,




 -- * Signals
-- ** linkSelected #signal:linkSelected#

    C_HypertextLinkSelectedCallback         ,
    HypertextLinkSelectedCallback           ,
#if ENABLE_OVERLOADING
    HypertextLinkSelectedSignalInfo         ,
#endif
    afterHypertextLinkSelected              ,
    genClosure_HypertextLinkSelected        ,
    mk_HypertextLinkSelectedCallback        ,
    noHypertextLinkSelectedCallback         ,
    onHypertextLinkSelected                 ,
    wrap_HypertextLinkSelectedCallback      ,




    ) 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.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.Atk.Objects.Hyperlink as Atk.Hyperlink
import qualified GI.GObject.Objects.Object as GObject.Object

-- interface Hypertext 
-- | Memory-managed wrapper type.
newtype Hypertext = Hypertext (ManagedPtr Hypertext)
-- | A convenience alias for `Nothing` :: `Maybe` `Hypertext`.
noHypertext :: Maybe Hypertext
noHypertext = Nothing

-- signal Hypertext::link-selected
{- |
The \"link-selected\" signal is emitted by an AtkHyperText
object when one of the hyperlinks associated with the object
is selected.
-}
type HypertextLinkSelectedCallback =
    Int32
    {- ^ /@arg1@/: the index of the hyperlink which is selected -}
    -> IO ()

-- | A convenience synonym for @`Nothing` :: `Maybe` `HypertextLinkSelectedCallback`@.
noHypertextLinkSelectedCallback :: Maybe HypertextLinkSelectedCallback
noHypertextLinkSelectedCallback = Nothing

-- | Type for the callback on the (unwrapped) C side.
type C_HypertextLinkSelectedCallback =
    Ptr () ->                               -- object
    Int32 ->
    Ptr () ->                               -- user_data
    IO ()

-- | Generate a function pointer callable from C code, from a `C_HypertextLinkSelectedCallback`.
foreign import ccall "wrapper"
    mk_HypertextLinkSelectedCallback :: C_HypertextLinkSelectedCallback -> IO (FunPtr C_HypertextLinkSelectedCallback)

-- | Wrap the callback into a `GClosure`.
genClosure_HypertextLinkSelected :: MonadIO m => HypertextLinkSelectedCallback -> m (GClosure C_HypertextLinkSelectedCallback)
genClosure_HypertextLinkSelected cb = liftIO $ do
    let cb' = wrap_HypertextLinkSelectedCallback cb
    mk_HypertextLinkSelectedCallback cb' >>= B.GClosure.newGClosure


-- | Wrap a `HypertextLinkSelectedCallback` into a `C_HypertextLinkSelectedCallback`.
wrap_HypertextLinkSelectedCallback ::
    HypertextLinkSelectedCallback ->
    C_HypertextLinkSelectedCallback
wrap_HypertextLinkSelectedCallback _cb _ arg1 _ = do
    _cb  arg1


{- |
Connect a signal handler for the “@link-selected@” signal, to be run before the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to

@
'Data.GI.Base.Signals.on' hypertext #linkSelected callback
@
-}
onHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId
onHypertextLinkSelected obj cb = liftIO $ do
    let cb' = wrap_HypertextLinkSelectedCallback cb
    cb'' <- mk_HypertextLinkSelectedCallback cb'
    connectSignalFunPtr obj "link-selected" cb'' SignalConnectBefore

{- |
Connect a signal handler for the “@link-selected@” signal, to be run after the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to

@
'Data.GI.Base.Signals.after' hypertext #linkSelected callback
@
-}
afterHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId
afterHypertextLinkSelected obj cb = liftIO $ do
    let cb' = wrap_HypertextLinkSelectedCallback cb
    cb'' <- mk_HypertextLinkSelectedCallback cb'
    connectSignalFunPtr obj "link-selected" cb'' SignalConnectAfter


#if ENABLE_OVERLOADING
data HypertextLinkSelectedSignalInfo
instance SignalInfo HypertextLinkSelectedSignalInfo where
    type HaskellCallbackType HypertextLinkSelectedSignalInfo = HypertextLinkSelectedCallback
    connectSignal _ obj cb connectMode = do
        let cb' = wrap_HypertextLinkSelectedCallback cb
        cb'' <- mk_HypertextLinkSelectedCallback cb'
        connectSignalFunPtr obj "link-selected" cb'' connectMode

type instance O.SignalList Hypertext = HypertextSignalList
type HypertextSignalList = ('[ '("linkSelected", HypertextLinkSelectedSignalInfo), '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)])

#endif

foreign import ccall "atk_hypertext_get_type"
    c_atk_hypertext_get_type :: IO GType

instance GObject Hypertext where
    gobjectType = c_atk_hypertext_get_type
    

-- | Type class for types which can be safely cast to `Hypertext`, for instance with `toHypertext`.
class (GObject o, O.IsDescendantOf Hypertext o) => IsHypertext o
instance (GObject o, O.IsDescendantOf Hypertext o) => IsHypertext o

instance O.HasParentTypes Hypertext
type instance O.ParentTypes Hypertext = '[GObject.Object.Object]

-- | Cast to `Hypertext`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toHypertext :: (MonadIO m, IsHypertext o) => o -> m Hypertext
toHypertext = liftIO . unsafeCastTo Hypertext

#if ENABLE_OVERLOADING
instance O.HasAttributeList Hypertext
type instance O.AttributeList Hypertext = HypertextAttributeList
type HypertextAttributeList = ('[ ] :: [(Symbol, *)])
#endif

#if ENABLE_OVERLOADING
#endif

#if ENABLE_OVERLOADING
type family ResolveHypertextMethod (t :: Symbol) (o :: *) :: * where
    ResolveHypertextMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveHypertextMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveHypertextMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveHypertextMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveHypertextMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveHypertextMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveHypertextMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveHypertextMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveHypertextMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveHypertextMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveHypertextMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveHypertextMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveHypertextMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveHypertextMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveHypertextMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveHypertextMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveHypertextMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveHypertextMethod "getLink" o = HypertextGetLinkMethodInfo
    ResolveHypertextMethod "getLinkIndex" o = HypertextGetLinkIndexMethodInfo
    ResolveHypertextMethod "getNLinks" o = HypertextGetNLinksMethodInfo
    ResolveHypertextMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveHypertextMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveHypertextMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveHypertextMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveHypertextMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveHypertextMethod t Hypertext, O.MethodInfo info Hypertext p) => OL.IsLabel t (Hypertext -> 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

-- method Hypertext::get_link
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "hypertext", argType = TInterface (Name {namespace = "Atk", name = "Hypertext"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an #AtkHypertext", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "link_index", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an integer specifying the desired link", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Atk", name = "Hyperlink"}))
-- throws : False
-- Skip return : False

foreign import ccall "atk_hypertext_get_link" atk_hypertext_get_link :: 
    Ptr Hypertext ->                        -- hypertext : TInterface (Name {namespace = "Atk", name = "Hypertext"})
    Int32 ->                                -- link_index : TBasicType TInt
    IO (Ptr Atk.Hyperlink.Hyperlink)

{- |
Gets the link in this hypertext document at index
/@linkIndex@/
-}
hypertextGetLink ::
    (B.CallStack.HasCallStack, MonadIO m, IsHypertext a) =>
    a
    {- ^ /@hypertext@/: an 'GI.Atk.Interfaces.Hypertext.Hypertext' -}
    -> Int32
    {- ^ /@linkIndex@/: an integer specifying the desired link -}
    -> m Atk.Hyperlink.Hyperlink
    {- ^ __Returns:__ the link in this hypertext document at
index /@linkIndex@/ -}
hypertextGetLink hypertext linkIndex = liftIO $ do
    hypertext' <- unsafeManagedPtrCastPtr hypertext
    result <- atk_hypertext_get_link hypertext' linkIndex
    checkUnexpectedReturnNULL "hypertextGetLink" result
    result' <- (newObject Atk.Hyperlink.Hyperlink) result
    touchManagedPtr hypertext
    return result'

#if ENABLE_OVERLOADING
data HypertextGetLinkMethodInfo
instance (signature ~ (Int32 -> m Atk.Hyperlink.Hyperlink), MonadIO m, IsHypertext a) => O.MethodInfo HypertextGetLinkMethodInfo a signature where
    overloadedMethod _ = hypertextGetLink

#endif

-- method Hypertext::get_link_index
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "hypertext", argType = TInterface (Name {namespace = "Atk", name = "Hypertext"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an #AtkHypertext", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "char_index", argType = TBasicType TInt, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a character index", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False

foreign import ccall "atk_hypertext_get_link_index" atk_hypertext_get_link_index :: 
    Ptr Hypertext ->                        -- hypertext : TInterface (Name {namespace = "Atk", name = "Hypertext"})
    Int32 ->                                -- char_index : TBasicType TInt
    IO Int32

{- |
Gets the index into the array of hyperlinks that is associated with
the character specified by /@charIndex@/.
-}
hypertextGetLinkIndex ::
    (B.CallStack.HasCallStack, MonadIO m, IsHypertext a) =>
    a
    {- ^ /@hypertext@/: an 'GI.Atk.Interfaces.Hypertext.Hypertext' -}
    -> Int32
    {- ^ /@charIndex@/: a character index -}
    -> m Int32
    {- ^ __Returns:__ an index into the array of hyperlinks in /@hypertext@/,
or -1 if there is no hyperlink associated with this character. -}
hypertextGetLinkIndex hypertext charIndex = liftIO $ do
    hypertext' <- unsafeManagedPtrCastPtr hypertext
    result <- atk_hypertext_get_link_index hypertext' charIndex
    touchManagedPtr hypertext
    return result

#if ENABLE_OVERLOADING
data HypertextGetLinkIndexMethodInfo
instance (signature ~ (Int32 -> m Int32), MonadIO m, IsHypertext a) => O.MethodInfo HypertextGetLinkIndexMethodInfo a signature where
    overloadedMethod _ = hypertextGetLinkIndex

#endif

-- method Hypertext::get_n_links
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "hypertext", argType = TInterface (Name {namespace = "Atk", name = "Hypertext"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "an #AtkHypertext", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False

foreign import ccall "atk_hypertext_get_n_links" atk_hypertext_get_n_links :: 
    Ptr Hypertext ->                        -- hypertext : TInterface (Name {namespace = "Atk", name = "Hypertext"})
    IO Int32

{- |
Gets the number of links within this hypertext document.
-}
hypertextGetNLinks ::
    (B.CallStack.HasCallStack, MonadIO m, IsHypertext a) =>
    a
    {- ^ /@hypertext@/: an 'GI.Atk.Interfaces.Hypertext.Hypertext' -}
    -> m Int32
    {- ^ __Returns:__ the number of links within this hypertext document -}
hypertextGetNLinks hypertext = liftIO $ do
    hypertext' <- unsafeManagedPtrCastPtr hypertext
    result <- atk_hypertext_get_n_links hypertext'
    touchManagedPtr hypertext
    return result

#if ENABLE_OVERLOADING
data HypertextGetNLinksMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsHypertext a) => O.MethodInfo HypertextGetNLinksMethodInfo a signature where
    overloadedMethod _ = hypertextGetNLinks

#endif