add install-includes: field
[packages/pretty.git] / GHC / ConsoleHandler.hs
index 1654163..3c3d2f4 100644 (file)
@@ -36,6 +36,7 @@ import Foreign
 import Foreign.C
 import GHC.IOBase
 import GHC.Handle
+import Data.Typeable
 
 data Handler
  = Default
@@ -49,7 +50,27 @@ data ConsoleEvent
     -- these are sent to Services only.
  | Logoff
  | Shutdown
+ deriving (Eq, Ord, Enum, Show, Read, Typeable)
 
+-- | Allows Windows console events to be caught and handled.  To
+-- handle a console event, call 'installHandler' passing the
+-- appropriate 'Handler' value.  When the event is received, if the
+-- 'Handler' value is @Catch f@, then a new thread will be spawned by
+-- the system to execute @f e@, where @e@ is the 'ConsoleEvent' that
+-- was received.
+--
+-- Note that console events can only be received by an application
+-- running in a Windows console.  Certain environments that look like consoles
+-- do not support console events, these include:
+--
+--  * Cygwin shells with @CYGWIN=tty@ set (if you don't set @CYGWIN=tty@,
+--    then a Cygwin shell behaves like a Windows console).
+--  * Cygwin xterm and rxvt windows
+--  * MSYS rxvt windows
+--
+-- In order for your application to receive console events, avoid running
+-- it in one of these environments.
+--
 installHandler :: Handler -> IO Handler
 installHandler handler = 
   alloca $ \ p_sp -> do