{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A compiled set of rules which applied to resource loads.
-- 
-- /Since: 2.24/

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

module GI.WebKit2.Structs.UserContentFilter
    ( 

-- * Exported types
    UserContentFilter(..)                   ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [ref]("GI.WebKit2.Structs.UserContentFilter#g:method:ref"), [unref]("GI.WebKit2.Structs.UserContentFilter#g:method:unref").
-- 
-- ==== Getters
-- [getIdentifier]("GI.WebKit2.Structs.UserContentFilter#g:method:getIdentifier").
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveUserContentFilterMethod          ,
#endif

-- ** getIdentifier #method:getIdentifier#

#if defined(ENABLE_OVERLOADING)
    UserContentFilterGetIdentifierMethodInfo,
#endif
    userContentFilterGetIdentifier          ,


-- ** ref #method:ref#

#if defined(ENABLE_OVERLOADING)
    UserContentFilterRefMethodInfo          ,
#endif
    userContentFilterRef                    ,


-- ** unref #method:unref#

#if defined(ENABLE_OVERLOADING)
    UserContentFilterUnrefMethodInfo        ,
#endif
    userContentFilterUnref                  ,




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


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

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

foreign import ccall "webkit_user_content_filter_get_type" c_webkit_user_content_filter_get_type :: 
    IO GType

type instance O.ParentTypes UserContentFilter = '[]
instance O.HasParentTypes UserContentFilter

instance B.Types.TypedObject UserContentFilter where
    glibType :: IO GType
glibType = IO GType
c_webkit_user_content_filter_get_type

instance B.Types.GBoxed UserContentFilter

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


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

-- method UserContentFilter::get_identifier
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "user_content_filter"
--           , argType =
--               TInterface
--                 Name { namespace = "WebKit2" , name = "UserContentFilter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "A #WebKitUserContentFilter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "webkit_user_content_filter_get_identifier" webkit_user_content_filter_get_identifier :: 
    Ptr UserContentFilter ->                -- user_content_filter : TInterface (Name {namespace = "WebKit2", name = "UserContentFilter"})
    IO CString

-- | Obtain the identifier previously used to save the /@userContentFilter@/.
-- 
-- Obtain the identifier previously used to save the /@userContentFilter@/ in the
-- t'GI.WebKit2.Objects.UserContentFilterStore.UserContentFilterStore'.
-- 
-- /Since: 2.24/
userContentFilterGetIdentifier ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    UserContentFilter
    -- ^ /@userContentFilter@/: A t'GI.WebKit2.Structs.UserContentFilter.UserContentFilter'
    -> m T.Text
    -- ^ __Returns:__ the identifier for the filter
userContentFilterGetIdentifier :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
UserContentFilter -> m Text
userContentFilterGetIdentifier UserContentFilter
userContentFilter = 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
    Ptr UserContentFilter
userContentFilter' <- UserContentFilter -> IO (Ptr UserContentFilter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr UserContentFilter
userContentFilter
    CString
result <- Ptr UserContentFilter -> IO CString
webkit_user_content_filter_get_identifier Ptr UserContentFilter
userContentFilter'
    Text -> CString -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"userContentFilterGetIdentifier" CString
result
    Text
result' <- HasCallStack => CString -> IO Text
CString -> IO Text
cstringToText CString
result
    UserContentFilter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr UserContentFilter
userContentFilter
    Text -> IO Text
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Text
result'

#if defined(ENABLE_OVERLOADING)
data UserContentFilterGetIdentifierMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.OverloadedMethod UserContentFilterGetIdentifierMethodInfo UserContentFilter signature where
    overloadedMethod = userContentFilterGetIdentifier

instance O.OverloadedMethodInfo UserContentFilterGetIdentifierMethodInfo UserContentFilter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.WebKit2.Structs.UserContentFilter.userContentFilterGetIdentifier",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-webkit2-4.0.29/docs/GI-WebKit2-Structs-UserContentFilter.html#v:userContentFilterGetIdentifier"
        })


#endif

-- method UserContentFilter::ref
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "user_content_filter"
--           , argType =
--               TInterface
--                 Name { namespace = "WebKit2" , name = "UserContentFilter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "A #WebKitUserContentFilter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface
--                  Name { namespace = "WebKit2" , name = "UserContentFilter" })
-- throws : False
-- Skip return : False

foreign import ccall "webkit_user_content_filter_ref" webkit_user_content_filter_ref :: 
    Ptr UserContentFilter ->                -- user_content_filter : TInterface (Name {namespace = "WebKit2", name = "UserContentFilter"})
    IO (Ptr UserContentFilter)

-- | Atomically increments the reference count of /@userContentFilter@/ by one.
-- 
-- This function is MT-safe and may be called from any thread.
-- 
-- /Since: 2.24/
userContentFilterRef ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    UserContentFilter
    -- ^ /@userContentFilter@/: A t'GI.WebKit2.Structs.UserContentFilter.UserContentFilter'
    -> m UserContentFilter
    -- ^ __Returns:__ the /@userContentFilter@/ passed in.
userContentFilterRef :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
UserContentFilter -> m UserContentFilter
userContentFilterRef UserContentFilter
userContentFilter = IO UserContentFilter -> m UserContentFilter
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO UserContentFilter -> m UserContentFilter)
-> IO UserContentFilter -> m UserContentFilter
forall a b. (a -> b) -> a -> b
$ do
    Ptr UserContentFilter
userContentFilter' <- UserContentFilter -> IO (Ptr UserContentFilter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr UserContentFilter
userContentFilter
    Ptr UserContentFilter
result <- Ptr UserContentFilter -> IO (Ptr UserContentFilter)
webkit_user_content_filter_ref Ptr UserContentFilter
userContentFilter'
    Text -> Ptr UserContentFilter -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"userContentFilterRef" Ptr UserContentFilter
result
    UserContentFilter
result' <- ((ManagedPtr UserContentFilter -> UserContentFilter)
-> Ptr UserContentFilter -> IO UserContentFilter
forall a.
(HasCallStack, GBoxed a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapBoxed ManagedPtr UserContentFilter -> UserContentFilter
UserContentFilter) Ptr UserContentFilter
result
    UserContentFilter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr UserContentFilter
userContentFilter
    UserContentFilter -> IO UserContentFilter
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return UserContentFilter
result'

#if defined(ENABLE_OVERLOADING)
data UserContentFilterRefMethodInfo
instance (signature ~ (m UserContentFilter), MonadIO m) => O.OverloadedMethod UserContentFilterRefMethodInfo UserContentFilter signature where
    overloadedMethod = userContentFilterRef

instance O.OverloadedMethodInfo UserContentFilterRefMethodInfo UserContentFilter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.WebKit2.Structs.UserContentFilter.userContentFilterRef",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-webkit2-4.0.29/docs/GI-WebKit2-Structs-UserContentFilter.html#v:userContentFilterRef"
        })


#endif

-- method UserContentFilter::unref
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "user_content_filter"
--           , argType =
--               TInterface
--                 Name { namespace = "WebKit2" , name = "UserContentFilter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "A #WebKitUserContentFilter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "webkit_user_content_filter_unref" webkit_user_content_filter_unref :: 
    Ptr UserContentFilter ->                -- user_content_filter : TInterface (Name {namespace = "WebKit2", name = "UserContentFilter"})
    IO ()

-- | Atomically decrements the reference count of /@userContentFilter@/ by one.
-- 
-- If the reference count drops to 0, all the memory allocated by the
-- t'GI.WebKit2.Structs.UserContentFilter.UserContentFilter' is released. This function is MT-safe and may
-- be called from any thread.
-- 
-- /Since: 2.24/
userContentFilterUnref ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    UserContentFilter
    -- ^ /@userContentFilter@/: A t'GI.WebKit2.Structs.UserContentFilter.UserContentFilter'
    -> m ()
userContentFilterUnref :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
UserContentFilter -> m ()
userContentFilterUnref UserContentFilter
userContentFilter = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr UserContentFilter
userContentFilter' <- UserContentFilter -> IO (Ptr UserContentFilter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr UserContentFilter
userContentFilter
    Ptr UserContentFilter -> IO ()
webkit_user_content_filter_unref Ptr UserContentFilter
userContentFilter'
    UserContentFilter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr UserContentFilter
userContentFilter
    () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data UserContentFilterUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.OverloadedMethod UserContentFilterUnrefMethodInfo UserContentFilter signature where
    overloadedMethod = userContentFilterUnref

instance O.OverloadedMethodInfo UserContentFilterUnrefMethodInfo UserContentFilter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.WebKit2.Structs.UserContentFilter.userContentFilterUnref",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-webkit2-4.0.29/docs/GI-WebKit2-Structs-UserContentFilter.html#v:userContentFilterUnref"
        })


#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveUserContentFilterMethod (t :: Symbol) (o :: *) :: * where
    ResolveUserContentFilterMethod "ref" o = UserContentFilterRefMethodInfo
    ResolveUserContentFilterMethod "unref" o = UserContentFilterUnrefMethodInfo
    ResolveUserContentFilterMethod "getIdentifier" o = UserContentFilterGetIdentifierMethodInfo
    ResolveUserContentFilterMethod l o = O.MethodResolutionFailed l o

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

#endif

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

#endif