-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | FFI interface to libltdl
--   
--   This package provides an interface to GNU libtldl.
@package libltdl
@version 0.1.1

module Foreign.LibLTDL.Internal

-- | System-dependent path separator
lT_PATHSEP_CHAR :: Char

-- | Module handle
data OpaqueDLHandle
OpaqueDLHandle :: OpaqueDLHandle
newtype DLHandle
DLHandle :: Ptr OpaqueDLHandle -> DLHandle
[unDLHandle] :: DLHandle -> Ptr OpaqueDLHandle

-- | Optional module loading modes
data OpaqueDLAdvise
OpaqueDLAdvise :: OpaqueDLAdvise
newtype DLAdvise
DLAdvise :: Ptr OpaqueDLAdvise -> DLAdvise
[unDLAdvise] :: DLAdvise -> Ptr OpaqueDLAdvise
c_lt_dlinit :: IO CInt
c_lt_dlexit :: IO CInt
c_lt_dlopen :: CString -> IO DLHandle
c_lt_dlopenext :: CString -> IO DLHandle
c_lt_dlopenadvise :: CString -> DLAdvise -> IO DLHandle
c_lt_dladvise_init :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_destroy :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_ext :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_global :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_local :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_resident :: Ptr DLAdvise -> IO CInt
c_lt_dladvise_preload :: Ptr DLAdvise -> IO CInt
c_lt_dlclose :: DLHandle -> IO CInt
c_lt_dlsym :: DLHandle -> CString -> IO (FunPtr a)
c_lt_dlerror :: IO CString
c_lt_dladdsearchdir :: CString -> IO CInt
c_lt_dlinsertsearchdir :: CString -> CString -> IO CInt
c_lt_dlsetsearchpath :: CString -> IO CInt
c_lt_dlgetsearchpath :: IO CString
c_lt_dlforeachfile :: CString -> FunPtr (CString -> Ptr a -> IO CInt) -> Ptr a -> IO CInt
c_lt_dlmakeresident :: DLHandle -> IO CInt
c_lt_dlisresident :: DLHandle -> IO CInt
instance Foreign.Storable.Storable Foreign.LibLTDL.Internal.DLAdvise
instance GHC.Show.Show Foreign.LibLTDL.Internal.DLAdvise
instance GHC.Classes.Ord Foreign.LibLTDL.Internal.DLAdvise
instance GHC.Classes.Eq Foreign.LibLTDL.Internal.DLAdvise
instance GHC.Show.Show Foreign.LibLTDL.Internal.DLHandle
instance GHC.Classes.Ord Foreign.LibLTDL.Internal.DLHandle
instance GHC.Classes.Eq Foreign.LibLTDL.Internal.DLHandle

module Foreign.LibLTDL
data Advice
Ext :: Advice
Global :: Advice
Local :: Advice
Resident :: Advice
Preload :: Advice

-- | CUDA extensible exception
newtype DLException
DLException :: String -> DLException
newtype DLHandle
DLHandle :: Ptr OpaqueDLHandle -> DLHandle
[unDLHandle] :: DLHandle -> Ptr OpaqueDLHandle
type SearchPath = [FilePath]

-- | Initialize libltdl. This function must be called before using libltdl
--   and may be called several times.
dlInit :: IO ()

-- | Shut down libltdl and close all modules.This function will only then
--   shut down libltdl when it was called as many times as <tt>dlInit</tt>
--   has been successfully called.
dlExit :: IO ()

-- | Open the module with the specified file name and return a handle for
--   it.
dlOpen :: Maybe String -> IO DLHandle

-- | Open the module with the specified file name and return a handle to
--   it. This variant trid appending various extensions to teh file name in
--   an effort to find the module.
dlOpenExt :: Maybe String -> IO DLHandle
dlOpenAdvise :: [Advice] -> Maybe String -> IO DLHandle

-- | Decrement the reference count on the module <tt>h</tt>. If it drops to
--   zero and no other module depends on this module, then the module is
--   unloaded.
dlClose :: DLHandle -> IO ()

-- | Return the address of the symbol <tt>name</tt> in the module
--   <tt>h</tt>.
dlSym :: DLHandle -> String -> IO (FunPtr a)

-- | Replace the current user-defined library search path with
--   <tt>path</tt>, which must be a list of absolute directories separated
--   by <tt>lT_PATHSEP_CHAR</tt>.
dlSetSearchPath :: SearchPath -> IO ()

-- | Return the current user-defined library search path.
dlGetSearchPath :: IO SearchPath

-- | Iterate over the directory list in <tt>path</tt>, calling <tt>f</tt>
--   for each module, until <tt>f</tt> returns a non-zero result, or until
--   there are no more modules. The value returned by the last call to
--   <tt>f</tt> is returned.
dlForEachFile :: Maybe SearchPath -> (String -> IO Int) -> IO Int

-- | Mark a module so that it cannot be closed.
dlMakeResident :: DLHandle -> IO ()

-- | Check whether a particular module has been marked as resident, return
--   <tt>True</tt> if it has or <tt>False</tt> otherwise.
dlIsResident :: DLHandle -> IO Bool
instance GHC.Show.Show Foreign.LibLTDL.Advice
instance GHC.Enum.Enum Foreign.LibLTDL.Advice
instance GHC.Classes.Ord Foreign.LibLTDL.Advice
instance GHC.Classes.Eq Foreign.LibLTDL.Advice
instance GHC.Show.Show Foreign.LibLTDL.DLException
instance GHC.Exception.Exception Foreign.LibLTDL.DLException