gi-wireplumber-0.5.14: GI/Wp/Interfaces/ComponentLoader.hs

{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- An interface that provides the ability to load components.
-- Components can be:
-- * WirePlumber modules (libraries that provide WpPlugin and WpSiFactory objects)
-- * Scripts (ex. lua scripts)
-- 
-- 
-- The WirePlumber library provides built-in support for loading WirePlumber modules, without a component loader. For other kinds of components, a component loader is meant to be provided in by some WirePlumber module. For Lua scripts specifically, a component loader is provided by the lua scripting module.

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

module GI.Wp.Interfaces.ComponentLoader
    ( 

-- * Exported types
    ComponentLoader(..)                     ,
    IsComponentLoader                       ,
    toComponentLoader                       ,


 -- * 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").
-- 
-- ==== 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)
    ResolveComponentLoaderMethod            ,
#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.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)
import qualified GI.GObject.Objects.Object as GObject.Object

#else
import qualified GI.GObject.Objects.Object as GObject.Object

#endif

-- interface ComponentLoader 
-- | Memory-managed wrapper type.
newtype ComponentLoader = ComponentLoader (SP.ManagedPtr ComponentLoader)
    deriving (Eq)

instance SP.ManagedPtrNewtype ComponentLoader where
    toManagedPtr (ComponentLoader p) = p

foreign import ccall "wp_component_loader_get_type"
    c_wp_component_loader_get_type :: IO B.Types.GType

instance B.Types.TypedObject ComponentLoader where
    glibType = c_wp_component_loader_get_type

instance B.Types.GObject ComponentLoader

-- | Type class for types which can be safely cast to t'ComponentLoader', for instance with `toComponentLoader`.
class (SP.GObject o, O.IsDescendantOf ComponentLoader o) => IsComponentLoader o
instance (SP.GObject o, O.IsDescendantOf ComponentLoader o) => IsComponentLoader o

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

-- | Cast to t'ComponentLoader', for types for which this is known to be safe. For general casts, use 'Data.GI.Base.ManagedPtr.castTo'.
toComponentLoader :: (MIO.MonadIO m, IsComponentLoader o) => o -> m ComponentLoader
toComponentLoader = MIO.liftIO . B.ManagedPtr.unsafeCastTo ComponentLoader

-- | Convert t'ComponentLoader' to and from t'Data.GI.Base.GValue.GValue'. See 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue (Maybe ComponentLoader) where
    gvalueGType_ = c_wp_component_loader_get_type
    gvalueSet_ gv P.Nothing = B.GValue.set_object gv (FP.nullPtr :: FP.Ptr ComponentLoader)
    gvalueSet_ gv (P.Just obj) = B.ManagedPtr.withManagedPtr obj (B.GValue.set_object gv)
    gvalueGet_ gv = do
        ptr <- B.GValue.get_object gv :: IO (FP.Ptr ComponentLoader)
        if ptr /= FP.nullPtr
        then P.Just <$> B.ManagedPtr.newObject ComponentLoader ptr
        else return P.Nothing
        
    

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

#if defined(ENABLE_OVERLOADING)
#endif

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

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

#endif

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

#endif

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

#endif