{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (garetxe@gmail.com)
-}

module GI.Gst.Structs.DebugMessage
    ( 

-- * Exported types
    DebugMessage(..)                        ,
    noDebugMessage                          ,


 -- * Methods
-- ** get #method:get#
    DebugMessageGetMethodInfo               ,
    debugMessageGet                         ,




    ) 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.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
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


newtype DebugMessage = DebugMessage (ManagedPtr DebugMessage)
-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance WrappedPtr DebugMessage where
    wrappedPtrCalloc = return nullPtr
    wrappedPtrCopy = return
    wrappedPtrFree = Nothing

noDebugMessage :: Maybe DebugMessage
noDebugMessage = Nothing


instance O.HasAttributeList DebugMessage
type instance O.AttributeList DebugMessage = DebugMessageAttributeList
type DebugMessageAttributeList = ('[ ] :: [(Symbol, *)])

-- method DebugMessage::get
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "message", argType = TInterface (Name {namespace = "Gst", name = "DebugMessage"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a debug message", 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 "gst_debug_message_get" gst_debug_message_get :: 
    Ptr DebugMessage ->                     -- message : TInterface (Name {namespace = "Gst", name = "DebugMessage"})
    IO CString

{- |
Gets the string representation of a 'GI.Gst.Structs.DebugMessage.DebugMessage'. This function is used
in debug handlers to extract the message.
-}
debugMessageGet ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    DebugMessage
    {- ^ /@message@/: a debug message -}
    -> m T.Text
    {- ^ __Returns:__ the string representation of a 'GI.Gst.Structs.DebugMessage.DebugMessage'. -}
debugMessageGet message = liftIO $ do
    message' <- unsafeManagedPtrGetPtr message
    result <- gst_debug_message_get message'
    checkUnexpectedReturnNULL "debugMessageGet" result
    result' <- cstringToText result
    touchManagedPtr message
    return result'

data DebugMessageGetMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.MethodInfo DebugMessageGetMethodInfo DebugMessage signature where
    overloadedMethod _ = debugMessageGet

type family ResolveDebugMessageMethod (t :: Symbol) (o :: *) :: * where
    ResolveDebugMessageMethod "get" o = DebugMessageGetMethodInfo
    ResolveDebugMessageMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveDebugMessageMethod t DebugMessage, O.MethodInfo info DebugMessage p) => O.IsLabelProxy t (DebugMessage -> p) where
    fromLabelProxy _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)

#if MIN_VERSION_base(4,9,0)
instance (info ~ ResolveDebugMessageMethod t DebugMessage, O.MethodInfo info DebugMessage p) => O.IsLabel t (DebugMessage -> p) where
    fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info)
#endif