gi-glib-0.2.46.12: GI/GLib/Structs/OptionGroup.hs
{- |
Copyright : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License : LGPL-2.1
Maintainer : Iñaki García Etxebarria (garetxe@gmail.com)
A `GOptionGroup` struct defines the options in a single
group. The struct has only private fields and should not be directly accessed.
All options in a group share the same translation function. Libraries which
need to parse commandline options are expected to provide a function for
getting a `GOptionGroup` holding their options, which
the application can then add to its #GOptionContext.
-}
module GI.GLib.Structs.OptionGroup
(
-- * Exported types
OptionGroup(..) ,
noOptionGroup ,
-- * Methods
-- ** optionGroupAddEntries
optionGroupAddEntries ,
-- ** optionGroupFree
optionGroupFree ,
-- ** optionGroupNew
optionGroupNew ,
-- ** optionGroupRef
optionGroupRef ,
-- ** optionGroupSetTranslateFunc
optionGroupSetTranslateFunc ,
-- ** optionGroupSetTranslationDomain
optionGroupSetTranslationDomain ,
-- ** optionGroupUnref
optionGroupUnref ,
) where
import Prelude ()
import Data.GI.Base.ShortPrelude
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import GI.GLib.Types
import GI.GLib.Callbacks
newtype OptionGroup = OptionGroup (ForeignPtr OptionGroup)
foreign import ccall "g_option_group_get_type" c_g_option_group_get_type ::
IO GType
instance BoxedObject OptionGroup where
boxedType _ = c_g_option_group_get_type
noOptionGroup :: Maybe OptionGroup
noOptionGroup = Nothing
-- method OptionGroup::new
-- method type : Constructor
-- Args : [Arg {argName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "description", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "help_description", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "user_data", argType = TBasicType TVoid, direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "destroy", argType = TInterface "GLib" "DestroyNotify", direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeAsync, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "description", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "help_description", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "user_data", argType = TBasicType TVoid, direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "destroy", argType = TInterface "GLib" "DestroyNotify", direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeAsync, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TInterface "GLib" "OptionGroup"
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_new" g_option_group_new ::
CString -> -- name : TBasicType TUTF8
CString -> -- description : TBasicType TUTF8
CString -> -- help_description : TBasicType TUTF8
Ptr () -> -- user_data : TBasicType TVoid
FunPtr DestroyNotifyC -> -- destroy : TInterface "GLib" "DestroyNotify"
IO (Ptr OptionGroup)
optionGroupNew ::
(MonadIO m) =>
T.Text -> -- name
T.Text -> -- description
T.Text -> -- help_description
Maybe (Ptr ()) -> -- user_data
Maybe (DestroyNotify) -> -- destroy
m OptionGroup
optionGroupNew name description help_description user_data destroy = liftIO $ do
name' <- textToCString name
description' <- textToCString description
help_description' <- textToCString help_description
maybeUser_data <- case user_data of
Nothing -> return nullPtr
Just jUser_data -> do
return jUser_data
ptrdestroy <- callocMem :: IO (Ptr (FunPtr DestroyNotifyC))
maybeDestroy <- case destroy of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jDestroy -> do
jDestroy' <- mkDestroyNotify (destroyNotifyWrapper (Just ptrdestroy) jDestroy)
poke ptrdestroy jDestroy'
return jDestroy'
result <- g_option_group_new name' description' help_description' maybeUser_data maybeDestroy
checkUnexpectedReturnNULL "g_option_group_new" result
result' <- (wrapBoxed OptionGroup) result
freeMem name'
freeMem description'
freeMem help_description'
return result'
-- method OptionGroup::add_entries
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "entries", argType = TInterface "GLib" "OptionEntry", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "entries", argType = TInterface "GLib" "OptionEntry", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_add_entries" g_option_group_add_entries ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
Ptr OptionEntry -> -- entries : TInterface "GLib" "OptionEntry"
IO ()
optionGroupAddEntries ::
(MonadIO m) =>
OptionGroup -> -- _obj
OptionEntry -> -- entries
m ()
optionGroupAddEntries _obj entries = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
let entries' = unsafeManagedPtrGetPtr entries
g_option_group_add_entries _obj' entries'
touchManagedPtr _obj
touchManagedPtr entries
return ()
-- method OptionGroup::free
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_free" g_option_group_free ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
IO ()
{-# DEPRECATED optionGroupFree ["(Since version 2.44)","Use g_option_group_unref() instead."]#-}
optionGroupFree ::
(MonadIO m) =>
OptionGroup -> -- _obj
m ()
optionGroupFree _obj = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
g_option_group_free _obj'
touchManagedPtr _obj
return ()
-- method OptionGroup::ref
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TInterface "GLib" "OptionGroup"
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_ref" g_option_group_ref ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
IO (Ptr OptionGroup)
optionGroupRef ::
(MonadIO m) =>
OptionGroup -> -- _obj
m OptionGroup
optionGroupRef _obj = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
result <- g_option_group_ref _obj'
checkUnexpectedReturnNULL "g_option_group_ref" result
result' <- (wrapBoxed OptionGroup) result
touchManagedPtr _obj
return result'
-- method OptionGroup::set_translate_func
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "func", argType = TInterface "GLib" "TranslateFunc", direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeNotified, argClosure = 2, argDestroy = 3, transfer = TransferNothing},Arg {argName = "data", argType = TBasicType TVoid, direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "destroy_notify", argType = TInterface "GLib" "DestroyNotify", direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeAsync, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "func", argType = TInterface "GLib" "TranslateFunc", direction = DirectionIn, mayBeNull = True, argScope = ScopeTypeNotified, argClosure = 2, argDestroy = 3, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_set_translate_func" g_option_group_set_translate_func ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
FunPtr TranslateFuncC -> -- func : TInterface "GLib" "TranslateFunc"
Ptr () -> -- data : TBasicType TVoid
FunPtr DestroyNotifyC -> -- destroy_notify : TInterface "GLib" "DestroyNotify"
IO ()
optionGroupSetTranslateFunc ::
(MonadIO m) =>
OptionGroup -> -- _obj
Maybe (TranslateFunc) -> -- func
m ()
optionGroupSetTranslateFunc _obj func = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
maybeFunc <- case func of
Nothing -> return (castPtrToFunPtr nullPtr)
Just jFunc -> do
jFunc' <- mkTranslateFunc (translateFuncWrapper Nothing jFunc)
return jFunc'
let data_ = castFunPtrToPtr maybeFunc
let destroy_notify = safeFreeFunPtrPtr
g_option_group_set_translate_func _obj' maybeFunc data_ destroy_notify
touchManagedPtr _obj
return ()
-- method OptionGroup::set_translation_domain
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "domain", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing},Arg {argName = "domain", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_set_translation_domain" g_option_group_set_translation_domain ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
CString -> -- domain : TBasicType TUTF8
IO ()
optionGroupSetTranslationDomain ::
(MonadIO m) =>
OptionGroup -> -- _obj
T.Text -> -- domain
m ()
optionGroupSetTranslationDomain _obj domain = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
domain' <- textToCString domain
g_option_group_set_translation_domain _obj' domain'
touchManagedPtr _obj
freeMem domain'
return ()
-- method OptionGroup::unref
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "GLib" "OptionGroup", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False
foreign import ccall "g_option_group_unref" g_option_group_unref ::
Ptr OptionGroup -> -- _obj : TInterface "GLib" "OptionGroup"
IO ()
optionGroupUnref ::
(MonadIO m) =>
OptionGroup -> -- _obj
m ()
optionGroupUnref _obj = liftIO $ do
let _obj' = unsafeManagedPtrGetPtr _obj
g_option_group_unref _obj'
touchManagedPtr _obj
return ()