{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- Interface for completion proposals.
-- 
-- This interface is used to denote that an object is capable of being
-- a completion proposal for [class/@completion@/].
-- 
-- Currently, no method or functions are required but additional methods
-- may be added in the future. Proposals created by
-- t'GI.GtkSource.Interfaces.CompletionProvider.CompletionProvider' can use @/GObject.IMPLEMENT_INTERFACE/@ to
-- implement this with 'P.Nothing' for the interface init function.

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

module GI.GtkSource.Interfaces.CompletionProposal
    ( 

-- * Exported types
    CompletionProposal(..)                  ,
    IsCompletionProposal                    ,
    toCompletionProposal                    ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [bindProperty]("GI.GObject.Objects.Object#g:method:bindProperty"), [bindPropertyFull]("GI.GObject.Objects.Object#g:method:bindPropertyFull"), [forceFloating]("GI.GObject.Objects.Object#g:method:forceFloating"), [freezeNotify]("GI.GObject.Objects.Object#g:method:freezeNotify"), [getv]("GI.GObject.Objects.Object#g:method:getv"), [isFloating]("GI.GObject.Objects.Object#g:method:isFloating"), [notify]("GI.GObject.Objects.Object#g:method:notify"), [notifyByPspec]("GI.GObject.Objects.Object#g:method:notifyByPspec"), [ref]("GI.GObject.Objects.Object#g:method:ref"), [refSink]("GI.GObject.Objects.Object#g:method:refSink"), [runDispose]("GI.GObject.Objects.Object#g:method:runDispose"), [stealData]("GI.GObject.Objects.Object#g:method:stealData"), [stealQdata]("GI.GObject.Objects.Object#g:method:stealQdata"), [thawNotify]("GI.GObject.Objects.Object#g:method:thawNotify"), [unref]("GI.GObject.Objects.Object#g:method:unref"), [watchClosure]("GI.GObject.Objects.Object#g:method:watchClosure").
-- 
-- ==== Getters
-- [getData]("GI.GObject.Objects.Object#g:method:getData"), [getProperty]("GI.GObject.Objects.Object#g:method:getProperty"), [getQdata]("GI.GObject.Objects.Object#g:method:getQdata"), [getTypedText]("GI.GtkSource.Interfaces.CompletionProposal#g:method:getTypedText").
-- 
-- ==== Setters
-- [setData]("GI.GObject.Objects.Object#g:method:setData"), [setDataFull]("GI.GObject.Objects.Object#g:method:setDataFull"), [setProperty]("GI.GObject.Objects.Object#g:method:setProperty").

#if defined(ENABLE_OVERLOADING)
    ResolveCompletionProposalMethod         ,
#endif

-- ** getTypedText #method:getTypedText#

#if defined(ENABLE_OVERLOADING)
    CompletionProposalGetTypedTextMethodInfo,
#endif
    completionProposalGetTypedText          ,




    ) 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 GI.GObject.Objects.Object as GObject.Object

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

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

foreign import ccall "gtk_source_completion_proposal_get_type"
    c_gtk_source_completion_proposal_get_type :: IO B.Types.GType

instance B.Types.TypedObject CompletionProposal where
    glibType :: IO GType
glibType = IO GType
c_gtk_source_completion_proposal_get_type

instance B.Types.GObject CompletionProposal

-- | Type class for types which can be safely cast to `CompletionProposal`, for instance with `toCompletionProposal`.
class (SP.GObject o, O.IsDescendantOf CompletionProposal o) => IsCompletionProposal o
instance (SP.GObject o, O.IsDescendantOf CompletionProposal o) => IsCompletionProposal o

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

-- | Cast to `CompletionProposal`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toCompletionProposal :: (MIO.MonadIO m, IsCompletionProposal o) => o -> m CompletionProposal
toCompletionProposal :: forall (m :: * -> *) o.
(MonadIO m, IsCompletionProposal o) =>
o -> m CompletionProposal
toCompletionProposal = IO CompletionProposal -> m CompletionProposal
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
MIO.liftIO (IO CompletionProposal -> m CompletionProposal)
-> (o -> IO CompletionProposal) -> o -> m CompletionProposal
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ManagedPtr CompletionProposal -> CompletionProposal)
-> o -> IO CompletionProposal
forall o o'.
(HasCallStack, ManagedPtrNewtype o, TypedObject o,
 ManagedPtrNewtype o', TypedObject o') =>
(ManagedPtr o' -> o') -> o -> IO o'
B.ManagedPtr.unsafeCastTo ManagedPtr CompletionProposal -> CompletionProposal
CompletionProposal

-- | Convert 'CompletionProposal' 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 CompletionProposal) where
    gvalueGType_ :: IO GType
gvalueGType_ = IO GType
c_gtk_source_completion_proposal_get_type
    gvalueSet_ :: Ptr GValue -> Maybe CompletionProposal -> IO ()
gvalueSet_ Ptr GValue
gv Maybe CompletionProposal
P.Nothing = Ptr GValue -> Ptr CompletionProposal -> IO ()
forall a. GObject a => Ptr GValue -> Ptr a -> IO ()
B.GValue.set_object Ptr GValue
gv (Ptr CompletionProposal
forall a. Ptr a
FP.nullPtr :: FP.Ptr CompletionProposal)
    gvalueSet_ Ptr GValue
gv (P.Just CompletionProposal
obj) = CompletionProposal -> (Ptr CompletionProposal -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr CompletionProposal
obj (Ptr GValue -> Ptr CompletionProposal -> IO ()
forall a. GObject a => Ptr GValue -> Ptr a -> IO ()
B.GValue.set_object Ptr GValue
gv)
    gvalueGet_ :: Ptr GValue -> IO (Maybe CompletionProposal)
gvalueGet_ Ptr GValue
gv = do
        Ptr CompletionProposal
ptr <- Ptr GValue -> IO (Ptr CompletionProposal)
forall a. GObject a => Ptr GValue -> IO (Ptr a)
B.GValue.get_object Ptr GValue
gv :: IO (FP.Ptr CompletionProposal)
        if Ptr CompletionProposal
ptr Ptr CompletionProposal -> Ptr CompletionProposal -> Bool
forall a. Eq a => a -> a -> Bool
/= Ptr CompletionProposal
forall a. Ptr a
FP.nullPtr
        then CompletionProposal -> Maybe CompletionProposal
forall a. a -> Maybe a
P.Just (CompletionProposal -> Maybe CompletionProposal)
-> IO CompletionProposal -> IO (Maybe CompletionProposal)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (ManagedPtr CompletionProposal -> CompletionProposal)
-> Ptr CompletionProposal -> IO CompletionProposal
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
B.ManagedPtr.newObject ManagedPtr CompletionProposal -> CompletionProposal
CompletionProposal Ptr CompletionProposal
ptr
        else Maybe CompletionProposal -> IO (Maybe CompletionProposal)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe CompletionProposal
forall a. Maybe a
P.Nothing
        
    

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

#if defined(ENABLE_OVERLOADING)
#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveCompletionProposalMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveCompletionProposalMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveCompletionProposalMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveCompletionProposalMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveCompletionProposalMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveCompletionProposalMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveCompletionProposalMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveCompletionProposalMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveCompletionProposalMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveCompletionProposalMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveCompletionProposalMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveCompletionProposalMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveCompletionProposalMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveCompletionProposalMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveCompletionProposalMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveCompletionProposalMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveCompletionProposalMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveCompletionProposalMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveCompletionProposalMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveCompletionProposalMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveCompletionProposalMethod "getTypedText" o = CompletionProposalGetTypedTextMethodInfo
    ResolveCompletionProposalMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveCompletionProposalMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo
    ResolveCompletionProposalMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveCompletionProposalMethod l o = O.MethodResolutionFailed l o

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

#endif

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

#endif

-- method CompletionProposal::get_typed_text
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "proposal"
--           , argType =
--               TInterface
--                 Name { namespace = "GtkSource" , name = "CompletionProposal" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GtkSourceCompletionProposal"
--                 , 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 "gtk_source_completion_proposal_get_typed_text" gtk_source_completion_proposal_get_typed_text :: 
    Ptr CompletionProposal ->               -- proposal : TInterface (Name {namespace = "GtkSource", name = "CompletionProposal"})
    IO CString

-- | Gets the typed-text for the proposal, if supported by the implementation.
-- 
-- Implementing this virtual-function is optional, but can be useful to allow
-- external tooling to compare results.
-- 
-- /Since: 5.6/
completionProposalGetTypedText ::
    (B.CallStack.HasCallStack, MonadIO m, IsCompletionProposal a) =>
    a
    -- ^ /@proposal@/: a t'GI.GtkSource.Interfaces.CompletionProposal.CompletionProposal'
    -> m (Maybe T.Text)
    -- ^ __Returns:__ a newly allocated string, or 'P.Nothing'
completionProposalGetTypedText :: forall (m :: * -> *) a.
(HasCallStack, MonadIO m, IsCompletionProposal a) =>
a -> m (Maybe Text)
completionProposalGetTypedText a
proposal = 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
    Ptr CompletionProposal
proposal' <- a -> IO (Ptr CompletionProposal)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
proposal
    CString
result <- Ptr CompletionProposal -> IO CString
gtk_source_completion_proposal_get_typed_text Ptr CompletionProposal
proposal'
    Maybe Text
maybeResult <- CString -> (CString -> IO Text) -> IO (Maybe Text)
forall a b. Ptr a -> (Ptr a -> IO b) -> IO (Maybe b)
convertIfNonNull CString
result ((CString -> IO Text) -> IO (Maybe Text))
-> (CString -> IO Text) -> IO (Maybe Text)
forall a b. (a -> b) -> a -> b
$ \CString
result' -> do
        Text
result'' <- HasCallStack => CString -> IO Text
CString -> IO Text
cstringToText CString
result'
        CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
result'
        Text -> IO Text
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Text
result''
    a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
proposal
    Maybe Text -> IO (Maybe Text)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe Text
maybeResult

#if defined(ENABLE_OVERLOADING)
data CompletionProposalGetTypedTextMethodInfo
instance (signature ~ (m (Maybe T.Text)), MonadIO m, IsCompletionProposal a) => O.OverloadedMethod CompletionProposalGetTypedTextMethodInfo a signature where
    overloadedMethod = completionProposalGetTypedText

instance O.OverloadedMethodInfo CompletionProposalGetTypedTextMethodInfo a where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.GtkSource.Interfaces.CompletionProposal.completionProposalGetTypedText",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gtksource-5.0.0/docs/GI-GtkSource-Interfaces-CompletionProposal.html#v:completionProposalGetTypedText"
        })


#endif

#if defined(ENABLE_OVERLOADING)
type instance O.SignalList CompletionProposal = CompletionProposalSignalList
type CompletionProposalSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, DK.Type)])

#endif