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


-- | Haskell scripting interface for HexChat
--   
--   This package builds a shared object ready for loading into HexChat,
--   that will compile and interpret scripts written in Haskell; and also a
--   Haskell library that said scripts should import and use to interface
--   with HexChat.
--   
--   At the moment the scripting interface is not finalized and may (and
--   will) change in a future.
--   
--   At the moment only Linux is supported.
--   
--   For instructions on how to write a script, see the <a>HexChat</a>
--   module.
--   
--   The plugin understands the classic <tt>/load</tt>, <tt>/unload</tt>,
--   <tt>/reload</tt> commands, as well as:
--   
--   <pre>
--   /hs load &lt;filename&gt;
--   /hs unload &lt;filename&gt;
--   /hs reload &lt;filename&gt;
--   /hs list
--   </pre>
--   
--   To automatically load the plugin symlink or copy
--   <tt>~/.cabal/lib/libhexchat-haskell.so</tt> (or
--   <tt>/usr/local/lib/libhexchat-haskell.so</tt>) to
--   <tt>~/.config/hexchat/addons/</tt> (or
--   <tt>/usr/lib/hexchat/plugins/</tt>).
@package hexchat
@version 0.0.2.0


-- | This module contains the "raw" functions that leak the fact that all
--   Haskell scripts are actually executed under the same
--   <tt>hexchat_plugin</tt> structure. You should unhook everything you
--   have hooked.
module HexChat.Internal
pri_HIGHEST :: CInt
pri_HIGH :: CInt
pri_NORM :: CInt
pri_LOW :: CInt
pri_LOWEST :: CInt

-- | An opaque type referencing a particular hook. Can be passed to
--   <a>unhook</a>.
data Hook

-- | This type defines whether the current hook "consumes" the event or
--   lets other hooks know about it.
data Eat

-- | Pass the event to everything else.
EatNone :: Eat

-- | Pass the event to all other scripts but not HexChat.
EatHexChat :: Eat

-- | Pass the event to HexChat but not any other scripts.
EatPlugin :: Eat

-- | Completely consume the event.
EatAll :: Eat

-- | Event attributes.
data EventAttrs
EventAttrs :: CTime -> EventAttrs
[server_time_utc] :: EventAttrs -> CTime

-- | An opaque type referencing a context (tab or window).
data Context
data List
command :: Plugin -> String -> IO ()
print :: Plugin -> String -> IO ()
emitPrint :: Plugin -> String -> [String] -> IO Bool
emitPrintAttrs :: Plugin -> EventAttrs -> String -> [String] -> IO Bool
sendModes :: Plugin -> [String] -> Int -> Char -> Char -> IO ()
nickCmp :: Plugin -> String -> String -> IO Ordering
strip :: Plugin -> Bool -> Bool -> String -> IO String
getPrefs :: Plugin -> String -> (String -> IO a) -> (Int -> IO a) -> (Bool -> IO a) -> IO (Maybe a)
listGet :: Plugin -> String -> IO (Maybe List)
listFields :: Plugin -> String -> IO [String]
listNext :: Plugin -> List -> IO Bool
listStr :: Plugin -> List -> String -> IO String
listInt :: Plugin -> List -> String -> IO Int
listTime :: Plugin -> List -> String -> IO CTime
hookCommand :: Plugin -> String -> CInt -> String -> ([String] -> [String] -> IO Eat) -> IO Hook
hookPrint :: Plugin -> String -> CInt -> ([String] -> IO Eat) -> IO Hook
hookPrintAttrs :: Plugin -> String -> CInt -> ([String] -> EventAttrs -> IO Eat) -> IO Hook
hookServer :: Plugin -> String -> CInt -> ([String] -> [String] -> IO Eat) -> IO Hook
hookServerAttrs :: Plugin -> String -> CInt -> ([String] -> [String] -> EventAttrs -> IO Eat) -> IO Hook
unhook :: Plugin -> Hook -> IO ()
findContext :: Plugin -> Maybe String -> Maybe String -> IO (Maybe Context)
getContext :: Plugin -> IO Context
setContext :: Plugin -> Context -> IO Bool
pluginguiAdd :: Plugin -> String -> String -> String -> String -> IO Plugin
pluginguiRemove :: Plugin -> Plugin -> IO ()
data StaticData
staticData :: StaticData
lPlugin :: IORef Plugin
lHandle :: IORef IORef Plugin
lHooks :: IORef IORef [(Plugin, Hook)]
initStaticData :: Plugin -> IO ()
joinStaticData :: StaticData -> IO ()
getPlugin :: IO Plugin
getHandle :: IO Plugin
withHandle :: Plugin -> IO a -> IO a
unhookHandle :: Plugin -> IO ()
newtype Plugin
Plugin :: (Ptr HexChat_Plugin) -> Plugin
type Plugin_Init = Plugin -> Ptr CString -> Ptr CString -> Ptr CString -> CString -> IO CInt
type Plugin_Deinit = Plugin -> IO CInt
instance GHC.Classes.Eq HexChat.Internal.EventAttrs
instance GHC.Read.Read HexChat.Internal.EventAttrs
instance GHC.Show.Show HexChat.Internal.EventAttrs
instance GHC.Classes.Eq HexChat.Internal.Eat
instance GHC.Read.Read HexChat.Internal.Eat
instance GHC.Show.Show HexChat.Internal.Eat
instance GHC.Classes.Eq HexChat.Internal.List
instance GHC.Classes.Ord HexChat.Internal.Context
instance GHC.Classes.Eq HexChat.Internal.Context
instance GHC.Show.Show HexChat.Internal.Context
instance GHC.Classes.Ord HexChat.Internal.Hook
instance GHC.Classes.Eq HexChat.Internal.Hook
instance GHC.Show.Show HexChat.Internal.Hook
instance GHC.Classes.Ord HexChat.Internal.Plugin
instance GHC.Classes.Eq HexChat.Internal.Plugin
instance GHC.Show.Show HexChat.Internal.Plugin


-- | A HexChat script is a <tt>.hs</tt> file that defines a global
--   identifier <tt>info</tt> with type <a>ModInfo</a>. This structure
--   contains the necessary metadata about a script as well its
--   initialization and deinitialization functions. From your
--   initialization function you may want to hook some events. Any
--   remaining hooks are automatically unhooked after the deinitializer so
--   you don't have to worry about that.
module HexChat

-- | This datatype contains metadata about the script. Every script should
--   define an global binding named <tt>info</tt> of this type. This
--   structure contains internal fields necessary for scripting to work, so
--   when constructing an object please use the default value
--   <a>modInfo</a> with record modification notation, like this:
--   
--   <pre>
--   info = <a>modInfo</a> { <a>modName</a> = "a module", <a>modAuthor</a> = "somepony", ... }
--   </pre>
--   
--   The type parameter signifies the return type of the initializer and
--   has no special meaning otherwise, you can specialize it to anything
--   you want.
--   
--   If you need to pass a lot of data to the deinitializer you could
--   simply let <tt>a ~ <a>IO</a> ()</tt> and <tt><a>modDeinit</a> =
--   <a>id</a></tt>, such as in the following:
--   
--   <pre>
--   info = <a>modInfo</a>
--       { <a>modInit</a> = do
--             x &lt;- createX
--             <a>return</a> $ do
--                 destroyX x
--       , <a>modDeinit</a> = <a>id</a>
--       }
--   </pre>
data ModInfo a
ModInfo :: String -> String -> String -> String -> IO a -> (a -> IO ()) -> StaticData -> ModInfo a

-- | Name of the script.
[modName] :: ModInfo a -> String

-- | Version of the script.
[modVersion] :: ModInfo a -> String

-- | Author of the script.
[modAuthor] :: ModInfo a -> String

-- | A short description of the script that can fit in the "Plugins and
--   Scripts" list window.
[modDescription] :: ModInfo a -> String

-- | This is the entry point of the script. It will be executed immediately
--   after the script is compiled and loaded. The returned value will be
--   opaquely passed to <a>modDeinit</a>.
[modInit] :: ModInfo a -> IO a

-- | This function will be executed shortly before the script is unloaded.
--   You can place any cleanup routines here. As argument it receives
--   whatever <a>modInit</a> returned.
[modDeinit] :: ModInfo a -> a -> IO ()

-- | An internal field that lets the different (to the linker) instances of
--   the HexChat library identify eachother. Please inherit the value of
--   this field from <a>modInfo</a>.
[modStaticData] :: ModInfo a -> StaticData

-- | A default value for <a>ModInfo</a>. This has some sensible defaults
--   and also provides the values of internal fields necessary for the
--   operation of the interface.
modInfo :: ModInfo a

-- | Invoke a HexChat command as if the user has typed it in the inputbox.
--   Do not include the leading <tt>/</tt>.
command :: String -> IO ()

-- | Print some text to the buffer.
print :: String -> IO ()

-- | Output a Text Event to the buffer. First argument is the Text Event
--   identifier (see <tt>Settings -&gt; Text Events</tt>), second is the
--   list of event's parameters.
emitPrint :: String -> [String] -> IO Bool

-- | Event attributes.
data EventAttrs
EventAttrs :: CTime -> EventAttrs
[server_time_utc] :: EventAttrs -> CTime

-- | Same as <a>emitPrint</a> but also lets you specify Event Attributes
--   for the event.
emitPrintAttrs :: EventAttrs -> String -> [String] -> IO Bool

-- | <tt><a>sendModes</a> targets n sign mode</tt> where <tt>sign</tt> is
--   <tt>+</tt> or <tt>-</tt> and <tt>mode</tt> is a channel mode character
--   will set the specified channel mode on each of the specified targets,
--   sending <tt>n</tt> modes per line, or the server's advertised maximum
--   if <tt>n</tt> is zero.
sendModes :: [String] -> Int -> Char -> Char -> IO ()

-- | Compare two nicknames according to the rules of the server.
nickCmp :: String -> String -> IO Ordering

-- | <tt><a>strip</a> colors format</tt> will strip colors if
--   <tt>colors</tt> is <a>True</a>, and miscellaneous formatting if
--   <tt>formatting</tt> is <a>True</a>, from the provided string.
strip :: Bool -> Bool -> String -> IO String

-- | Get a HexChat preference value (see <tt>/set</tt>). You should pass 3
--   continuations one of which will be invoked depending on the type of
--   the actual preference. Returns <a>Nothing</a> if no preference with
--   that name exists.
getPrefs :: String -> (String -> IO a) -> (Int -> IO a) -> (Bool -> IO a) -> IO (Maybe a)

-- | Return the value of a preference that is supposedly a String. Returns
--   <a>Nothing</a> if no such preference exists or it is of the wrong
--   type.
getPrefString :: String -> IO (Maybe String)

-- | Return the value of a preference that is supposedly an Int. Returns
--   <a>Nothing</a> if no such preference exists or it is of the wrong
--   type.
getPrefInt :: String -> IO (Maybe Int)

-- | Return the value of a preference that is supposedly a Bool. Returns
--   <a>Nothing</a> if no such preference exists or it is of the wrong
--   type.
getPrefBool :: String -> IO (Maybe Bool)
data List
listGet :: String -> IO (Maybe List)
listFields :: String -> IO [String]
listNext :: List -> IO Bool
listStr :: List -> String -> IO String
listInt :: List -> String -> IO Int
listTime :: List -> String -> IO CTime
pri_HIGHEST :: CInt
pri_HIGH :: CInt
pri_NORM :: CInt
pri_LOW :: CInt
pri_LOWEST :: CInt

-- | This type defines whether the current hook "consumes" the event or
--   lets other hooks know about it.
data Eat

-- | Pass the event to everything else.
EatNone :: Eat

-- | Pass the event to all other scripts but not HexChat.
EatHexChat :: Eat

-- | Pass the event to HexChat but not any other scripts.
EatPlugin :: Eat

-- | Completely consume the event.
EatAll :: Eat

-- | An opaque type referencing a particular hook. Can be passed to
--   <a>unhook</a>.
data Hook

-- | <tt><a>hookCommand</a> cmd priority description f</tt> registers a
--   command named <tt>cmd</tt> (with description <tt>description</tt>).
--   The given <tt>f</tt> will be passed a list of command's arguments
--   (proper words) and a list of "leftovers" for every position in the
--   word list (with the exact original whitespace).
--   
--   If <tt>cmd</tt> is <tt>""</tt> then instead the hook will be invoked
--   whenever the user types anything not beginning with <tt>/</tt>.
hookCommand :: String -> CInt -> String -> ([String] -> [String] -> IO Eat) -> IO Hook

-- | <tt><a>hookPrint</a> event priority f</tt> hooks <tt>f</tt> to be
--   invoked whenever a Text Event <tt>event</tt> is to be displayed on
--   screen. The given <tt>f</tt> will be passed a list of event's
--   parameters.
hookPrint :: String -> CInt -> ([String] -> IO Eat) -> IO Hook

-- | <tt><a>hookPrintAttrs</a> event priority f</tt> hooks <tt>f</tt> to be
--   invoked whenever a Text Event <tt>event</tt> is to be displayed on
--   screen. The given <tt>f</tt> will be passed a list of event's
--   parameters, and the attributes.
hookPrintAttrs :: String -> CInt -> ([String] -> EventAttrs -> IO Eat) -> IO Hook

-- | <tt><a>hookServer</a> word priority f</tt> hooks <tt>f</tt> to be
--   invoked whenever a <tt>word</tt> command arrives from the IRC server.
--   The given <tt>f</tt> will be passed a list of command's arguments
--   (proper words) and a list of "leftovers" for every position in the
--   word list (with the exact original whitespace). Processing of
--   <tt>:</tt> long arguments is *NOT* done.
--   
--   If <tt>cmd</tt> is <tt>"RAW LINE"</tt> then the hook will be invoked
--   for all commands received from the server.
hookServer :: String -> CInt -> ([String] -> [String] -> IO Eat) -> IO Hook

-- | <tt><a>hookServer</a> word priority f</tt> hooks <tt>f</tt> to be
--   invoked whenever a <tt>word</tt> command arrives from the IRC server.
--   The given <tt>f</tt> will be passed a list of command's arguments
--   (proper words), a list of "leftovers" for every position in the word
--   list (with the exact original whitespace), and the event attributes.
--   Processing of <tt>:</tt> long arguments is *NOT* done.
--   
--   If <tt>cmd</tt> is <tt>"RAW LINE"</tt> then the hook will be invoked
--   for all commands received from the server.
hookServerAttrs :: String -> CInt -> ([String] -> [String] -> EventAttrs -> IO Eat) -> IO Hook

-- | Remove the given hook. All hooks are automatically removed when the
--   script is unloaded.
unhook :: Hook -> IO ()

-- | An opaque type referencing a context (tab or window).
data Context

-- | <tt><a>findContext</a> mserver mtabname</tt> finds the context
--   corresponding to the given tab name (or to the front tab if
--   <a>Nothing</a>) in the given server (or in any of the servers if
--   <a>Nothing</a>).
findContext :: Maybe String -> Maybe String -> IO (Maybe Context)

-- | Obtains the current context.
getContext :: IO Context

-- | Sets the current context. The scope of this function is limited to the
--   currently executing hook (or the initializer/deinitializer).
setContext :: Context -> IO Bool

-- | Execute a given IO action in a given context a-la <a>bracket</a>.
withContext :: Context -> IO a -> IO a