Penny.Shield

Shield - the Penny runtime environment

Both Cabin and Copper can benefit from knowing information about the Penny runtime environment, such as environment variables and whether standard output is a terminal. That information is provided by the Runtime type. In the future this module may also provide information about the POSIX locale configuration. For now, that information would require reaching into the FFI and so it is not implemented.

Documentation

data ScreenLines

Instances

Show ScreenLines

unScreenLines :: ScreenLines -> Int

data ScreenWidth

Instances

Show ScreenWidth

unScreenWidth :: ScreenWidth -> Int

data Output

Constructors

IsTTY

NotTTY

Instances

Eq Output

Ord Output

Show Output

data Runtime

Information about the runtime environment.

environment :: Runtime -> [(String, String)]

currentTime :: Runtime -> DateTime

output :: Runtime -> Output

screenLines :: Runtime -> Maybe ScreenLines

screenWidth :: Runtime -> Maybe ScreenWidth

data Term

Instances

Show Term

term :: Runtime -> Maybe Term

runtime :: IO Runtime

termFromEnv :: Runtime -> Term

Determines which Chunk Term to use based on the TERM environment variable, regardless of whether standard output is a terminal. Uses Dumb if TERM is not set.

autoTerm :: Runtime -> Term

Determines which Chunk Term to use based on whether standard output is a terminal. Uses Dumb if standard output is not a terminal; otherwise, uses the TERM environment variable.