| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Cli.Extras.TerminalString
Description
Types and functions dealing with strings to be printed on terminal.
Synopsis
- data TerminalString
- render :: Bool -> Maybe Int -> [TerminalString] -> Text
- putStrWithSGR :: MonadIO m => [SGR] -> Handle -> Bool -> Text -> m ()
- getTerminalWidth :: IO (Maybe Int)
- enquiryCode :: String
Documentation
data TerminalString Source #
Printable text on terminals
Represents text with an optional color code.
Constructors
| TerminalString_Normal Text | |
| TerminalString_Colorized Color Text |
Instances
| Eq TerminalString Source # | |
Defined in Cli.Extras.TerminalString Methods (==) :: TerminalString -> TerminalString -> Bool # (/=) :: TerminalString -> TerminalString -> Bool # | |
| Ord TerminalString Source # | |
Defined in Cli.Extras.TerminalString Methods compare :: TerminalString -> TerminalString -> Ordering # (<) :: TerminalString -> TerminalString -> Bool # (<=) :: TerminalString -> TerminalString -> Bool # (>) :: TerminalString -> TerminalString -> Bool # (>=) :: TerminalString -> TerminalString -> Bool # max :: TerminalString -> TerminalString -> TerminalString # min :: TerminalString -> TerminalString -> TerminalString # | |
| Show TerminalString Source # | |
Defined in Cli.Extras.TerminalString Methods showsPrec :: Int -> TerminalString -> ShowS # show :: TerminalString -> String # showList :: [TerminalString] -> ShowS # | |
Arguments
| :: Bool | with color |
| -> Maybe Int | optionally, trim to maximum width |
| -> [TerminalString] | |
| -> Text |
putStrWithSGR :: MonadIO m => [SGR] -> Handle -> Bool -> Text -> m () Source #
Safely print the string with the given ANSI control codes, resetting in the end.
enquiryCode :: String Source #
Code for https://en.wikipedia.org/wiki/Enquiry_character. On VT-100 descendants (most modern UNIX terminal emulators), an ENQ character can be generated by pressing Ctrl+E.