(MonadIO m, MonadMask m) => MonadHaskeline (InputT m) Source #
Instance details Defined in Effects.Haskeline Methods haveTerminalUI :: InputT m Bool Source # getInputLine :: String -> InputT m (Maybe String) Source # getInputLineWithInitial :: String -> (String, String) -> InputT m (Maybe String) Source # getInputChar :: String -> InputT m (Maybe Char) Source # getPassword :: Maybe Char -> String -> InputT m (Maybe String) Source # waitForAnyKey :: String -> InputT m Bool Source # outputStr :: String -> InputT m () Source # outputStrLn :: String -> InputT m () Source # getHistory :: InputT m History Source # putHistory :: History -> InputT m () Source # modifyHistory :: (History -> History) -> InputT m () Source # withInterrupt :: HasCallStack => InputT m a -> InputT m a Source # handleInterrupt :: HasCallStack => InputT m a -> InputT m a -> InputT m a Source #
MonadHaskeline m => MonadHaskeline (ReaderT e m) Source #
Instance details Defined in Effects.Haskeline Methods haveTerminalUI :: ReaderT e m Bool Source # getInputLine :: String -> ReaderT e m (Maybe String) Source # getInputLineWithInitial :: String -> (String, String) -> ReaderT e m (Maybe String) Source # getInputChar :: String -> ReaderT e m (Maybe Char) Source # getPassword :: Maybe Char -> String -> ReaderT e m (Maybe String) Source # waitForAnyKey :: String -> ReaderT e m Bool Source # outputStr :: String -> ReaderT e m () Source # outputStrLn :: String -> ReaderT e m () Source # getHistory :: ReaderT e m History Source # putHistory :: History -> ReaderT e m () Source # modifyHistory :: (History -> History) -> ReaderT e m () Source # withInterrupt :: HasCallStack => ReaderT e m a -> ReaderT e m a Source # handleInterrupt :: HasCallStack => ReaderT e m a -> ReaderT e m a -> ReaderT e m a Source #

IO Runners

runInputT :: (MonadIO m, MonadMask m) => Settings m -> InputT m a -> m a #

Run a line-reading application. This function should suffice for most applications.

This function is equivalent to runInputTBehavior defaultBehavior. It uses terminal-style interaction if stdin is connected to a terminal and has echoing enabled. Otherwise (e.g., if stdin is a pipe), it uses file-style interaction.

If it uses terminal-style interaction, Prefs will be read from the user's ~/.haskeline file (if present). If it uses file-style interaction, Prefs are not relevant and will not be read.

runInputTBehavior :: (MonadIO m, MonadMask m) => Behavior -> Settings m -> InputT m a -> m a #

Run a line-reading application according to the given behavior.

If it uses terminal-style interaction, Prefs will be read from the user's ~/.haskeline file (if present). If it uses file-style interaction, Prefs are not relevant and will not be read.

runInputTBehaviorWithPrefs :: (MonadIO m, MonadMask m) => Behavior -> Prefs -> Settings m -> InputT m a -> m a #

Run a line-reading application.

Config

defaultSettings :: forall (m :: Type -> Type). MonadIO m => Settings m #

A useful default. In particular:

defaultSettings = Settings {
          complete = completeFilename,
          historyFile = Nothing,
          autoAddHistory = True
          }

defaultBehavior :: Behavior #

Read input from stdin. Use terminal-style interaction if stdin is connected to a terminal and has echoing enabled. Otherwise (e.g., if stdin is a pipe), use file-style interaction.

This behavior should suffice for most applications.

defaultPrefs :: Prefs #

The default preferences which may be overwritten in the .haskeline file.