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


-- | Bindings to libtelnet
--   
--   Binds <a>https://github.com/seanmiddleditch/libtelnet</a> , a C
--   library for writing telnet clients and servers. See <tt>README.md</tt>
--   or <a>Network.Telnet.LibTelnet</a> to get started.
@package libtelnet
@version 0.1.0.0


-- | Telnet interpret-as-command (IAC) codes. See <a>RFC 854</a> for the
--   meaning of many of these.
module Network.Telnet.LibTelnet.Iac

-- | Wrapper for telnet commands and special values.
newtype Iac
Iac :: CUChar -> Iac
[unIac] :: Iac -> CUChar
iacNull :: Iac
iacIac :: Iac
iacDont :: Iac
iacDo :: Iac
iacWont :: Iac
iacWill :: Iac
iacSB :: Iac
iacGA :: Iac
iacEL :: Iac
iacEC :: Iac
iacAYT :: Iac
iacAO :: Iac
iacIP :: Iac
iacBreak :: Iac
iacDM :: Iac
iacNOP :: Iac
iacSE :: Iac
iacEOR :: Iac
iacAbort :: Iac
iacSusp :: Iac
iacEOF :: Iac
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Iac.Iac
instance GHC.Show.Show Network.Telnet.LibTelnet.Iac.Iac
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Iac.Iac


-- | Telnet option codes. Many of these are defined in their own RFC.
--   <a>http://www.omnifarious.org/~hopper/technical/telnet-rfc.html</a> is
--   a good index of known options.
module Network.Telnet.LibTelnet.Options

-- | Wrapper for telnet option codes.
newtype Option
Option :: CUChar -> Option
[unOption] :: Option -> CUChar
optBinary :: Option
optEcho :: Option
optRCP :: Option
optSGA :: Option
optNAMS :: Option
optStatus :: Option
optTM :: Option
optRCTE :: Option
optNAOL :: Option
optNAOP :: Option
optNAOCRD :: Option
optNAOHTS :: Option
optNAOHTD :: Option
optNAOFFD :: Option
optNAOVTS :: Option
optNAOVTD :: Option
optNAOLFD :: Option
optXASCII :: Option
optLogout :: Option
optBM :: Option
optDET :: Option
optSUPDUP :: Option
optSUPDUPOutput :: Option
optSNDLOC :: Option
optTType :: Option
optEOR :: Option
optTUID :: Option
optOUTMRK :: Option
optTTYLOC :: Option
opt3270Regime :: Option
optX3Pad :: Option
optNAWS :: Option
optTSpeed :: Option
optLFlow :: Option
optLineMode :: Option
optXDISPLOC :: Option
optEnviron :: Option
optAuthentication :: Option
optEncrypt :: Option
optNewEnviron :: Option
optMSSP :: Option
optCompress2 :: Option
optZMP :: Option
optEXOPL :: Option
optMCCP2 :: Option
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Options.Option
instance GHC.Show.Show Network.Telnet.LibTelnet.Options.Option
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Options.Option


-- | Wrappers for <tt>libtelnet</tt> types, where the wrapping is simple
--   enough to not need its own module. Interpret-as-command codes live in
--   <a>Network.Telnet.LibTelnet.Iac</a>, and telnet option codes live in
--   <a>Network.Telnet.LibTelnet.Options</a>.
module Network.Telnet.LibTelnet.Types

-- | Uninhabited type for pointer safety (<tt>telnet_t</tt>).
data TelnetT

-- | Exceptions thrown by the binding, for when something has gone
--   seriously wrong. Errors detected by <tt>libtelnet</tt> are not thrown
--   but instead are passed to the event handler.
data TelnetException
NullTelnetPtr :: TelnetException
UnexpectedEventType :: TelnetEventTypeT -> TelnetException
UnexpectedEnvironCmd :: ECmd -> TelnetException
UnexpectedEnvironVar :: EVar -> TelnetException
UnexpectedTerminalTypeCmd :: TCmd -> TelnetException

-- | Flags for <tt>telnet_init</tt>.
newtype Flag
Flag :: CUChar -> Flag
[unFlag] :: Flag -> CUChar
flagProxy :: Flag

-- | Wraps <tt>telnet_telopt_t</tt>.
data TelnetTeloptT
TelnetTeloptT :: CShort -> Iac -> Iac -> TelnetTeloptT

-- | option value
[_telopt] :: TelnetTeloptT -> CShort

-- | option supported on server
[_us] :: TelnetTeloptT -> Iac

-- | allow clients to use the option?
[_him] :: TelnetTeloptT -> Iac

-- | Wraps <tt>telnet_event_t</tt>.
data EventT

-- | <a>eventData</a>
Data :: (CString, CSize) -> EventT

-- | <a>eventSend</a>
Send :: (CString, CSize) -> EventT

-- | <a>eventWarning</a>
Warning :: ErrorT -> EventT

-- | <a>eventError</a>
Error :: ErrorT -> EventT

-- | <a>eventIac</a>
Command :: Iac -> EventT

-- | <a>eventWill</a>
Will :: Option -> EventT

-- | <a>eventWont</a>
Wont :: Option -> EventT

-- | <a>eventDo</a>
Do :: Option -> EventT

-- | <a>eventDont</a>
Dont :: Option -> EventT

-- | <a>eventSubnegotiation</a>
Subnegotiation :: Option -> (CString, CSize) -> EventT

-- | <a>eventZmp</a>
Zmp :: (Ptr CString, CSize) -> EventT

-- | <a>eventTType</a>
TerminalType :: TCmd -> CString -> EventT

-- | <a>eventCompress</a>
Compress :: CUChar -> EventT

-- | <a>eventEnviron</a>
Environ :: ECmd -> (Ptr TelnetEnvironT, CSize) -> EventT

-- | <a>eventMssp</a>
Mssp :: (Ptr TelnetEnvironT, CSize) -> EventT

-- | Constants from <tt>telnet_event_type_t</tt>.
newtype TelnetEventTypeT
TelnetEventTypeT :: CInt -> TelnetEventTypeT
[unTelnetEventTypeT] :: TelnetEventTypeT -> CInt
eventData :: TelnetEventTypeT
eventSend :: TelnetEventTypeT
eventIac :: TelnetEventTypeT
eventWill :: TelnetEventTypeT
eventWont :: TelnetEventTypeT
eventDo :: TelnetEventTypeT
eventDont :: TelnetEventTypeT
eventSubnegotiation :: TelnetEventTypeT
eventCompress :: TelnetEventTypeT

-- | Data in <a>Warning</a> and <a>Error</a> events, modeled after
--   <tt>struct error_t</tt> inside <tt>telnet_event_t</tt>.
eventZmp :: TelnetEventTypeT
eventTType :: TelnetEventTypeT
data ErrorT
ErrorT :: CString -> CString -> CString -> CInt -> TelnetErrorT -> ErrorT
[_file] :: ErrorT -> CString
[_func] :: ErrorT -> CString
[_msg] :: ErrorT -> CString
[_line] :: ErrorT -> CInt
[_errcode] :: ErrorT -> TelnetErrorT
eventEnviron :: TelnetEventTypeT
eventMssp :: TelnetEventTypeT
eventWarning :: TelnetEventTypeT

-- | Constants from <tt>telnet_error_t</tt>.
eventError :: TelnetEventTypeT
newtype TelnetErrorT
TelnetErrorT :: CInt -> TelnetErrorT
[unTelnetErrorT] :: TelnetErrorT -> CInt
errOK :: TelnetErrorT
errBadVal :: TelnetErrorT
errNoMem :: TelnetErrorT
errOverflow :: TelnetErrorT
errProtocol :: TelnetErrorT

-- | Constants for <tt>TERMINAL-TYPE</tt> commands.
errCompress :: TelnetErrorT
newtype TCmd
TCmd :: CUChar -> TCmd
[unTCmd] :: TCmd -> CUChar
tCmdIs :: TCmd
tCmdSend :: TCmd

-- | Constants for <tt>ENVIRON</tt>/<tt>NEW-ENVIRON</tt> commands.
newtype ECmd
ECmd :: CUChar -> ECmd
[unECmd] :: ECmd -> CUChar
eCmdIs :: ECmd
eCmdSend :: ECmd
eCmdInfo :: ECmd

-- | Constants for <tt>ENVIRON</tt>/<tt>NEW-ENVIRON</tt> variables.
newtype EVar
EVar :: CUChar -> EVar
[unEvar] :: EVar -> CUChar
eVar :: EVar
eValue :: EVar
eUserVar :: EVar

-- | Constants for MSSP.
newtype MsspVar
MsspVar :: CUChar -> MsspVar
[unMsspVar] :: MsspVar -> CUChar
msspVar :: MsspVar
msspVal :: MsspVar

-- | <tt>ENVIRONMENT</tt>/<tt>NEW-ENVIRONMENT</tt>/<tt>MSSP</tt> messages,
--   wrapping <tt>telnet_environ_t</tt>.
data TelnetEnvironT
TelnetEnvironT :: EVar -> CString -> CString -> TelnetEnvironT

-- | <pre>
--   unsigned char type
--   </pre>
[_type] :: TelnetEnvironT -> EVar

-- | <pre>
--   char *var
--   </pre>
[_var] :: TelnetEnvironT -> CString

-- | <pre>
--   char *value
--   </pre>
[_value] :: TelnetEnvironT -> CString
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.MsspVar
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.MsspVar
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.MsspVar
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.TelnetException
instance GHC.Generics.Generic Network.Telnet.LibTelnet.Types.TelnetException
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.TelnetException
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.EVar
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.EVar
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.EVar
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.ECmd
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.ECmd
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.ECmd
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.TCmd
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.TCmd
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.TCmd
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.TelnetErrorT
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.TelnetErrorT
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.TelnetErrorT
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.TelnetEventTypeT
instance GHC.Show.Show Network.Telnet.LibTelnet.Types.TelnetEventTypeT
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Types.TelnetEventTypeT
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.EventT
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.TelnetEnvironT
instance GHC.Exception.Type.Exception Network.Telnet.LibTelnet.Types.TelnetException
instance Foreign.Storable.Storable Network.Telnet.LibTelnet.Types.TelnetTeloptT


-- | FFI binding to <tt>libtelnet</tt>. The vast majority of these
--   functions are generated from <tt>foreign import</tt> declarations.
module Network.Telnet.LibTelnet.Ffi

-- | Wrap <a>cTelnetInit</a>.
telnetInit :: [TelnetTeloptT] -> TelnetEventHandlerT -> [Flag] -> IO (ForeignPtr TelnetT)

-- | C function <tt>telnet_init</tt>.
cTelnetInit :: Ptr TelnetTeloptT -> FunPtr TelnetEventHandlerT -> CUChar -> Ptr () -> IO (Ptr TelnetT)

-- | C function <tt>telnet_free</tt>.
cTelnetFree :: Ptr TelnetT -> IO ()

-- | Represents <tt>telnet_event_handler_t</tt>.
type TelnetEventHandlerT = Ptr TelnetT -> Ptr EventT -> Ptr () -> IO ()

-- | Wrap an <a>TelnetEventHandlerT</a> to pass to C code.
wrapEventHandler :: TelnetEventHandlerT -> IO (FunPtr TelnetEventHandlerT)

-- | Wrap <a>cTelnetRecv</a>.
telnetRecv :: Ptr TelnetT -> ByteString -> IO ()

-- | C function <tt>telnet_recv</tt>.
cTelnetRecv :: Ptr TelnetT -> CString -> CSize -> IO ()

-- | C function <tt>telnet_iac</tt>.
cTelnetIac :: Ptr TelnetT -> Iac -> IO ()

-- | C function <tt>telnet_negotiate</tt>.
cTelnetNegotiate :: Ptr TelnetT -> Iac -> Option -> IO ()

-- | Wrap <a>cTelnetSend</a>.
telnetSend :: Ptr TelnetT -> ByteString -> IO ()

-- | C function <tt>telnet_send</tt>.
cTelnetSend :: Ptr TelnetT -> CString -> CSize -> IO ()

-- | Wrap <a>cTelnetSubnegotiation</a>.
telnetSubnegotiation :: Ptr TelnetT -> Option -> ByteString -> IO ()

-- | C function <tt>telnet_subnegotiation</tt>.
cTelnetSubnegotiation :: Ptr TelnetT -> Option -> CString -> CSize -> IO ()

-- | C function <tt>telnet_begin_compress2</tt>.
cTelnetBeginCompress2 :: Ptr TelnetT -> IO ()

-- | C function <tt>telnet_begin_newenviron</tt>.
cTelnetBeginNewEnviron :: Ptr TelnetT -> ECmd -> IO ()

-- | C function <tt>telnet_newenviron_value</tt>.
cTelnetNewEnvironValue :: Ptr TelnetT -> EVar -> CString -> IO ()

-- | C function <tt>telnet_ttype_send</tt>.
cTelnetTTypeSend :: Ptr TelnetT -> IO ()

-- | C function <tt>telnet_ttype_is</tt>.
cTelnetTTypeIs :: Ptr TelnetT -> CString -> IO ()

-- | Wrap <a>cTelnetSendZmp</a>.
telnetSendZmp :: Ptr TelnetT -> [ByteString] -> IO ()

-- | C function <tt>telnet_send_zmp</tt>.
cTelnetSendZmp :: Ptr TelnetT -> CSize -> Ptr CString -> IO ()

-- | Collect '[ByteString]' into a temporary array of strings in a 'Ptr
--   CString', for passing to C functions.
useAsCStrings :: [ByteString] -> (Ptr CString -> IO a) -> IO a


-- | Getting Started:
--   
--   <ol>
--   <li>Skim <a>the libtelnet documentation</a>, as these bindings follow
--   the C library's conventions quite closely.</li>
--   <li>Write an event-handling function, of type
--   <a>EventHandler</a>.</li>
--   <li>When you accept a new connection, create a <a>Telnet</a> state
--   tracker for it using <a>telnetInit</a>. Options and flags are defined
--   in the same way as the C library; option constants are exported from
--   <a>Network.Telnet.LibTelnet.Options</a>.</li>
--   <li>When you receive data (probably on a socket), tell <a>Telnet</a>
--   about it using <a>telnetRecv</a>.</li>
--   <li>To send data, negotiate options, &amp;c., use <a>telnetSend</a>,
--   <a>telnetIac</a>, &amp;c.</li>
--   <li>IAC (Interpret-As-Command) codes are exported from
--   <a>Network.Telnet.LibTelnet.Iac</a>.</li>
--   </ol>
module Network.Telnet.LibTelnet

-- | Create a <tt>libtelnet</tt> state tracker.
telnetInit :: [OptionSpec] -> [Flag] -> EventHandler -> IO Telnet

-- | Configures which options you want to support. The triple's elements
--   are: option code, support on our end (corresponds to
--   <tt>WILL/WONT</tt>), support on their end (corresponds to
--   <tt>DO/DONT</tt>).
data OptionSpec
OptionSpec :: Option -> Bool -> Bool -> OptionSpec

-- | Option code
[_code] :: OptionSpec -> Option

-- | Supported on our end? (<tt>WILL</tt>/<tt>WONT</tt>)
[_us] :: OptionSpec -> Bool

-- | Can other end use it with us? (<tt>DO</tt>/<tt>DONT</tt>)
[_him] :: OptionSpec -> Bool

-- | Flags for <tt>telnet_init</tt>.
data Flag
flagProxy :: Flag

-- | Garbage-collected pointer to the <tt>libtelnet</tt> state tracker.
--   Your program should hang on to this.
type Telnet = ForeignPtr TelnetT

-- | Raw pointer to the <tt>libtelnet</tt> state tracker. This is passed to
--   the event handlers and you shouldn't see it elsewhere.
type TelnetPtr = Ptr TelnetT

-- | The pointer you get back from <a>telnetInit</a> is a <a>ForeignPtr</a>
--   because it carries around its finalizers, but the pointer that gets
--   passed into your <a>EventHandler</a> is a bare <a>Ptr</a> because it's
--   being passed in from C. This class lets us generalise across both
--   types.
class HasTelnetPtr t
withTelnetPtr :: HasTelnetPtr t => t -> (TelnetPtr -> IO a) -> IO a

-- | Type of the event handler callback.
type EventHandler = TelnetPtr -> Event -> IO ()

-- | Structure provided to the event handler.
data Event

-- | Data received; you should pass it to the application.
Received :: ByteString -> Event

-- | Data you need to send out to the socket.
Send :: ByteString -> Event

-- | Something has gone wrong inside of libtelnet but recovery is (likely)
--   possible.
Warning :: Err -> Event

-- | Something has gone wrong. The application should immediately close the
--   connection.
Error :: Err -> Event

-- | Telnet interpret-as-command.
Iac :: Iac -> Event

-- | Other end offers an option.
Will :: Option -> Event

-- | Other end cannot support option.
Wont :: Option -> Event

-- | Other end asked you to support option.
Do :: Option -> Event

-- | Other end asked you to stop using option.
Dont :: Option -> Event

-- | Subnegotiation received for some option.
Subnegotiation :: Option -> ByteString -> Event

-- | <a>Zenith Mud Protocol</a> message
Zmp :: [ByteString] -> Event

-- | <tt>TERMINAL-TYPE SEND</tt> message <a>(RFC 1091)</a>. The server
--   wants to know about your terminal-type.
TerminalTypeSend :: Event

-- | <tt>TERMINAL-TYPE IS</tt> message <a>(RFC 1091)</a>. The client has
--   told us a terminal-type.
TerminalTypeIs :: ByteString -> Event

-- | Would the client like <a>MCCP Version 2</a>?
Compress :: Bool -> Event

-- | Request to send the following environment variables, per <a>(RFC
--   1408)</a> and <a>(RFC 1572)</a>.
EnvironSend :: [(Var, ByteString)] -> Event

-- | <tt>ENVIRON</tt>/<tt>NEW-ENVIRON</tt> options, per <a>(RFC 1408)</a>
--   and <a>(RFC 1572)</a>. Keys come before values in the tuples.
Environ :: IsInfo -> [(Var, ByteString, ByteString)] -> Event

-- | <a>Mud Server Status Protocol</a> List is <tt>(key, values)</tt>.
Mssp :: [(ByteString, [ByteString])] -> Event

-- | Error message from <tt>libtelnet</tt>.
data Err
Err :: ByteString -> ByteString -> ByteString -> Int -> TelnetErrorT -> Err
[_file] :: Err -> ByteString
[_func] :: Err -> ByteString
[_msg] :: Err -> ByteString
[_line] :: Err -> Int
[_errcode] :: Err -> TelnetErrorT

-- | Were the <a>Environ</a> fields sent as part of a <tt>NEW-ENVIRON
--   IS</tt> message, or part of a <tt>NEW-ENVIRON INFO</tt> message?
data IsInfo
Is :: IsInfo
Info :: IsInfo

-- | In an <a>Environ</a> message, are the vars being sent as <tt>VAR</tt>s
--   or <tt>USERVAR</tt>s?
data Var
Var :: Var
UserVar :: Var

-- | Tell the state tracker about received data.
telnetRecv :: HasTelnetPtr t => t -> ByteString -> IO ()

-- | Send non-command data.
telnetSend :: HasTelnetPtr t => t -> ByteString -> IO ()

-- | Send a telnet command.
telnetIac :: HasTelnetPtr t => t -> Iac -> IO ()

-- | Send a negotiation command.
telnetNegotiate :: HasTelnetPtr t => t -> Iac -> Option -> IO ()

-- | Send a subnegotiation.
telnetSubnegotiation :: HasTelnetPtr t => t -> Option -> ByteString -> IO ()

-- | Begin sending compressed data, using the <tt>COMPRESS2</tt> option.
--   The server should call this command in response to a
--   <tt><a>Compress</a> True</tt> event.
telnetBeginCompress2 :: HasTelnetPtr t => t -> IO ()

-- | Ask the client to send us these environment variables.
telnetNewEnvironSend :: HasTelnetPtr t => t -> [(Var, ByteString)] -> IO ()

-- | Tell the server about our environment variables.
telnetNewEnviron :: HasTelnetPtr t => t -> IsInfo -> [(Var, ByteString, ByteString)] -> IO ()

-- | Ask the client to give us a terminal type.
telnetTTypeSend :: HasTelnetPtr t => t -> IO ()

-- | Tell the server a terminal type.
telnetTTypeIs :: HasTelnetPtr t => t -> ByteString -> IO ()

-- | Send a ZMP command.
telnetSendZmp :: HasTelnetPtr t => t -> [ByteString] -> IO ()

-- | Send an MSSP status.
telnetSendMssp :: HasTelnetPtr t => t -> [(ByteString, [ByteString])] -> IO ()

-- | Exceptions thrown by the binding, for when something has gone
--   seriously wrong. Errors detected by <tt>libtelnet</tt> are not thrown
--   but instead are passed to the event handler.
data TelnetException
NullTelnetPtr :: TelnetException
UnexpectedEventType :: TelnetEventTypeT -> TelnetException
UnexpectedEnvironCmd :: ECmd -> TelnetException
UnexpectedEnvironVar :: EVar -> TelnetException
UnexpectedTerminalTypeCmd :: TCmd -> TelnetException
instance GHC.Show.Show Network.Telnet.LibTelnet.Event
instance GHC.Generics.Generic Network.Telnet.LibTelnet.Event
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Event
instance GHC.Show.Show Network.Telnet.LibTelnet.Var
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Var
instance GHC.Show.Show Network.Telnet.LibTelnet.IsInfo
instance GHC.Classes.Eq Network.Telnet.LibTelnet.IsInfo
instance GHC.Show.Show Network.Telnet.LibTelnet.Err
instance GHC.Generics.Generic Network.Telnet.LibTelnet.Err
instance GHC.Classes.Eq Network.Telnet.LibTelnet.Err
instance GHC.Show.Show Network.Telnet.LibTelnet.OptionSpec
instance GHC.Generics.Generic Network.Telnet.LibTelnet.OptionSpec
instance GHC.Classes.Eq Network.Telnet.LibTelnet.OptionSpec
instance Network.Telnet.LibTelnet.HasTelnetPtr Network.Telnet.LibTelnet.Telnet
instance Network.Telnet.LibTelnet.HasTelnetPtr Network.Telnet.LibTelnet.TelnetPtr