HexChat.Internal

This module contains the "raw" functions that leak the fact that all Haskell scripts are actually executed under the same hexchat_plugin structure. You should unhook everything you have hooked.

Documentation

pri_HIGHEST :: CInt

pri_HIGH :: CInt

pri_NORM :: CInt

pri_LOW :: CInt

pri_LOWEST :: CInt

data Hook

An opaque type referencing a particular hook. Can be passed to unhook.

Instances

Eq Hook

Methods

(==) :: Hook -> Hook -> Bool

(/=) :: Hook -> Hook -> Bool

Ord Hook

Methods

compare :: Hook -> Hook -> Ordering

(<) :: Hook -> Hook -> Bool

(<=) :: Hook -> Hook -> Bool

(>) :: Hook -> Hook -> Bool

(>=) :: Hook -> Hook -> Bool

max :: Hook -> Hook -> Hook

min :: Hook -> Hook -> Hook

Show Hook

Methods

showsPrec :: Int -> Hook -> ShowS

show :: Hook -> String

showList :: [Hook] -> ShowS

data Eat

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

Constructors

EatNone

Pass the event to everything else.

EatHexChat

Pass the event to all other scripts but not HexChat.

EatPlugin

Pass the event to HexChat but not any other scripts.

EatAll

Completely consume the event.

Instances

Eq Eat

Methods

(==) :: Eat -> Eat -> Bool

(/=) :: Eat -> Eat -> Bool

Read Eat

Methods

readsPrec :: Int -> ReadS Eat

readList :: ReadS [Eat]

readPrec :: ReadPrec Eat

readListPrec :: ReadPrec [Eat]

Show Eat

Methods

showsPrec :: Int -> Eat -> ShowS

show :: Eat -> String

showList :: [Eat] -> ShowS

data EventAttrs

Event attributes.

Constructors

EventAttrs

Fields

• server_time_utc :: CTime

Instances

Eq EventAttrs

Methods

(==) :: EventAttrs -> EventAttrs -> Bool

(/=) :: EventAttrs -> EventAttrs -> Bool

Read EventAttrs

Methods

readsPrec :: Int -> ReadS EventAttrs

readList :: ReadS [EventAttrs]

readPrec :: ReadPrec EventAttrs

readListPrec :: ReadPrec [EventAttrs]

Show EventAttrs

Methods

showsPrec :: Int -> EventAttrs -> ShowS

show :: EventAttrs -> String

showList :: [EventAttrs] -> ShowS

data Context

An opaque type referencing a context (tab or window).

Instances

Eq Context

Methods

(==) :: Context -> Context -> Bool

(/=) :: Context -> Context -> Bool

Ord Context

Methods

compare :: Context -> Context -> Ordering

(<) :: Context -> Context -> Bool

(<=) :: Context -> Context -> Bool

(>) :: Context -> Context -> Bool

(>=) :: Context -> Context -> Bool

max :: Context -> Context -> Context

min :: Context -> Context -> Context

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

data List

Instances

Eq List

Methods

(==) :: List -> List -> Bool

(/=) :: List -> List -> Bool

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 ()

module Foreign.C.Types

newtype Plugin

Constructors

Plugin (Ptr HexChat_Plugin)

Instances

Eq Plugin

Methods

(==) :: Plugin -> Plugin -> Bool

(/=) :: Plugin -> Plugin -> Bool

Ord Plugin

Methods

compare :: Plugin -> Plugin -> Ordering

(<) :: Plugin -> Plugin -> Bool

(<=) :: Plugin -> Plugin -> Bool

(>) :: Plugin -> Plugin -> Bool

(>=) :: Plugin -> Plugin -> Bool

max :: Plugin -> Plugin -> Plugin

min :: Plugin -> Plugin -> Plugin

Show Plugin

Methods

showsPrec :: Int -> Plugin -> ShowS

show :: Plugin -> String

showList :: [Plugin] -> ShowS

type Plugin_Init = Plugin -> Ptr CString -> Ptr CString -> Ptr CString -> CString -> IO CInt

type Plugin_Deinit = Plugin -> IO CInt