{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- /No description available in the introspection data./

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

module GI.WebKit2.Structs.UserContentFilter
    ( 

-- * Exported types
    UserContentFilter(..)                   ,
    noUserContentFilter                     ,


 -- * Methods
-- ** Overloaded methods #method:Overloaded methods#

#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.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.GI.Base.Signals as B.Signals
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


-- | Memory-managed wrapper type.
newtype UserContentFilter = UserContentFilter (ManagedPtr UserContentFilter)
    deriving (UserContentFilter -> UserContentFilter -> Bool
(UserContentFilter -> UserContentFilter -> Bool)
-> (UserContentFilter -> UserContentFilter -> Bool)
-> Eq UserContentFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UserContentFilter -> UserContentFilter -> Bool
$c/= :: UserContentFilter -> UserContentFilter -> Bool
== :: UserContentFilter -> UserContentFilter -> Bool
$c== :: UserContentFilter -> UserContentFilter -> Bool
Eq)
foreign import ccall "webkit_user_content_filter_get_type" c_webkit_user_content_filter_get_type :: 
    IO GType

instance BoxedObject UserContentFilter where
    boxedType :: UserContentFilter -> IO GType
boxedType _ = IO GType
c_webkit_user_content_filter_get_type

-- | Convert 'UserContentFilter' to and from 'Data.GI.Base.GValue.GValue' with 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue UserContentFilter where
    toGValue :: UserContentFilter -> IO GValue
toGValue o :: UserContentFilter
o = do
        GType
gtype <- IO GType
c_webkit_user_content_filter_get_type
        UserContentFilter
-> (Ptr UserContentFilter -> IO GValue) -> IO GValue
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr UserContentFilter
o (GType
-> (GValue -> Ptr UserContentFilter -> IO ())
-> Ptr UserContentFilter
-> IO GValue
forall a. GType -> (GValue -> a -> IO ()) -> a -> IO GValue
B.GValue.buildGValue GType
gtype GValue -> Ptr UserContentFilter -> IO ()
forall a. GValue -> Ptr a -> IO ()
B.GValue.set_boxed)
        
    fromGValue :: GValue -> IO UserContentFilter
fromGValue gv :: GValue
gv = do
        Ptr UserContentFilter
ptr <- GValue -> IO (Ptr UserContentFilter)
forall b. GValue -> IO (Ptr b)
B.GValue.get_boxed GValue
gv :: IO (Ptr UserContentFilter)
        (ManagedPtr UserContentFilter -> UserContentFilter)
-> Ptr UserContentFilter -> IO UserContentFilter
forall a.
(HasCallStack, BoxedObject a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
B.ManagedPtr.newBoxed ManagedPtr UserContentFilter -> UserContentFilter
UserContentFilter Ptr UserContentFilter
ptr
        
    

-- | A convenience alias for `Nothing` :: `Maybe` `UserContentFilter`.
noUserContentFilter :: Maybe UserContentFilter
noUserContentFilter :: Maybe UserContentFilter
noUserContentFilter = Maybe UserContentFilter
forall a. Maybe a
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@/ 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 :: UserContentFilter -> m Text
userContentFilterGetIdentifier userContentFilter :: UserContentFilter
userContentFilter = IO Text -> m Text
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 "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 (m :: * -> *) a. Monad m => a -> m a
return Text
result'

#if defined(ENABLE_OVERLOADING)
data UserContentFilterGetIdentifierMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.MethodInfo UserContentFilterGetIdentifierMethodInfo UserContentFilter signature where
    overloadedMethod = 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
userContentFilterRef :: UserContentFilter -> m UserContentFilter
userContentFilterRef userContentFilter :: UserContentFilter
userContentFilter = IO UserContentFilter -> m UserContentFilter
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 "userContentFilterRef" Ptr UserContentFilter
result
    UserContentFilter
result' <- ((ManagedPtr UserContentFilter -> UserContentFilter)
-> Ptr UserContentFilter -> IO UserContentFilter
forall a.
(HasCallStack, BoxedObject 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 (m :: * -> *) a. Monad m => a -> m a
return UserContentFilter
result'

#if defined(ENABLE_OVERLOADING)
data UserContentFilterRefMethodInfo
instance (signature ~ (m UserContentFilter), MonadIO m) => O.MethodInfo UserContentFilterRefMethodInfo UserContentFilter signature where
    overloadedMethod = 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 :: UserContentFilter -> m ()
userContentFilterUnref userContentFilter :: UserContentFilter
userContentFilter = IO () -> m ()
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 (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data UserContentFilterUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.MethodInfo UserContentFilterUnrefMethodInfo UserContentFilter signature where
    overloadedMethod = 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.MethodInfo 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

#endif