Copyright	Copyright (c) 2020-2024 Travis Cardwell
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

Redact.Monad.Terminal

Contents

MonadTerminal
API
Internal

Description

Synopsis

class Monad m => MonadTerminal (m :: Type -> Type) where
- putStr :: Text -> m ()
- putStrLn :: Text -> m ()
- setSGR :: [SGR] -> m ()
redactSGRs :: Color -> ColorIntensity -> [SGR]
resetSGRs :: [SGR]
reset :: MonadTerminal m => m ()
putLines :: MonadTerminal m => [SGR] -> [Line] -> m ()
initialize :: MonadTerminal m => [SGR] -> Line -> m ()
putLine :: MonadTerminal m => [SGR] -> Line -> Maybe Line -> m ()

MonadTerminal

class Monad m => MonadTerminal (m :: Type -> Type) where Source #

Terminal output

Since: 0.4.0.0

Methods

putStr :: Text -> m () Source #

Write a string to the terminal

putStrLn :: Text -> m () Source #

Write a string to the terminal, appending a newline

setSGR :: [SGR] -> m () Source #

Set Select Graphic Rendition mode

Instances

Instances details

MonadTerminal IO Source #
Instance details Defined in Redact.Monad.Terminal Methods putStr :: Text -> IO () Source # putStrLn :: Text -> IO () Source # setSGR :: [SGR] -> IO () Source #

API

redactSGRs :: Color -> ColorIntensity -> [SGR] Source #

Construct SGRs for redacted text

Since: 0.4.0.0

resetSGRs :: [SGR] Source #

SGRs for resetting to normal mode

Since: 0.4.0.0

reset :: MonadTerminal m => m () Source #

Reset the terminal color mode and go to the next line

Since: 0.4.0.0

putLines :: MonadTerminal m => [SGR] -> [Line] -> m () Source #

Put redacted text to the terminal

It is assumed that the terminal is set to display normal colors when this function is called. If the first Line is a RedactLine, then an extra blank line is first output in order to set the colors. The terminal is set to display normal colors when this function exits.

Since: 0.4.0.0

Internal

initialize Source #

Arguments

:: MonadTerminal m
=> [SGR]	`SGR`s for redacted text
-> Line	first line
-> m ()

Initialize the terminal colors

When the first line is a RedactLine, an extra blank line is output in order to set the terminal colors.

putLine Source #

Arguments

:: MonadTerminal m
=> [SGR]	`SGR`s for redacted text
-> Line	line to put
-> Maybe Line	`Just` next line or `Nothing` if end
-> m ()

Put a line of redacted text to the terminal

The colors for the line is assumed to be already set. Be sure to call initialize before putting the first line.