Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Gibberish.Formatting

Synopsis

data FormatOpts = FormatOpts {
- optMaxLen :: MaxLen
- optMaxHeight :: MaxHeight
- optSeparator :: Separator
- optExactWords :: Maybe ExactNumberWords
}
newtype MaxLen = MaxLen {
- unMaxLen :: Int
}
newtype MaxHeight = MaxHeight {
- unMaxHeight :: Int
}
newtype Separator = Separator {
- unSeparator :: Text
}
newtype ExactNumberWords = ExactNumberWords {
- unExactWords :: Int
}
formatWords :: FormatOpts -> [Word] -> Text
formatLine :: FormatOpts -> [Word] -> FormatLine

Documentation

data FormatOpts Source #

Constructors

FormatOpts
Fields optMaxLen :: MaxLen optMaxHeight :: MaxHeight optSeparator :: Separator optExactWords :: Maybe ExactNumberWords

Instances

Instances details

Show FormatOpts Source #
Instance details Defined in Data.Gibberish.Formatting Methods showsPrec :: Int -> FormatOpts -> ShowS # show :: FormatOpts -> String # showList :: [FormatOpts] -> ShowS #
Eq FormatOpts Source #
Instance details Defined in Data.Gibberish.Formatting Methods (==) :: FormatOpts -> FormatOpts -> Bool # (/=) :: FormatOpts -> FormatOpts -> Bool #

newtype MaxLen Source #

Constructors

MaxLen
Fields unMaxLen :: Int

Instances

Instances details

Enum MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods succ :: MaxLen -> MaxLen # pred :: MaxLen -> MaxLen # toEnum :: Int -> MaxLen # fromEnum :: MaxLen -> Int # enumFrom :: MaxLen -> [MaxLen] # enumFromThen :: MaxLen -> MaxLen -> [MaxLen] # enumFromTo :: MaxLen -> MaxLen -> [MaxLen] # enumFromThenTo :: MaxLen -> MaxLen -> MaxLen -> [MaxLen] #
Num MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods (+) :: MaxLen -> MaxLen -> MaxLen # (-) :: MaxLen -> MaxLen -> MaxLen # (*) :: MaxLen -> MaxLen -> MaxLen # negate :: MaxLen -> MaxLen # abs :: MaxLen -> MaxLen # signum :: MaxLen -> MaxLen # fromInteger :: Integer -> MaxLen #
Integral MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods quot :: MaxLen -> MaxLen -> MaxLen # rem :: MaxLen -> MaxLen -> MaxLen # div :: MaxLen -> MaxLen -> MaxLen # mod :: MaxLen -> MaxLen -> MaxLen # quotRem :: MaxLen -> MaxLen -> (MaxLen, MaxLen) # divMod :: MaxLen -> MaxLen -> (MaxLen, MaxLen) # toInteger :: MaxLen -> Integer #
Real MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods toRational :: MaxLen -> Rational #
Show MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods showsPrec :: Int -> MaxLen -> ShowS # show :: MaxLen -> String # showList :: [MaxLen] -> ShowS #
Eq MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods (==) :: MaxLen -> MaxLen -> Bool # (/=) :: MaxLen -> MaxLen -> Bool #
Ord MaxLen Source #
Instance details Defined in Data.Gibberish.Formatting Methods compare :: MaxLen -> MaxLen -> Ordering # (<) :: MaxLen -> MaxLen -> Bool # (<=) :: MaxLen -> MaxLen -> Bool # (>) :: MaxLen -> MaxLen -> Bool # (>=) :: MaxLen -> MaxLen -> Bool # max :: MaxLen -> MaxLen -> MaxLen # min :: MaxLen -> MaxLen -> MaxLen #

newtype MaxHeight Source #

Constructors

MaxHeight
Fields unMaxHeight :: Int

Instances

Instances details

Enum MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods succ :: MaxHeight -> MaxHeight # pred :: MaxHeight -> MaxHeight # toEnum :: Int -> MaxHeight # fromEnum :: MaxHeight -> Int # enumFrom :: MaxHeight -> [MaxHeight] # enumFromThen :: MaxHeight -> MaxHeight -> [MaxHeight] # enumFromTo :: MaxHeight -> MaxHeight -> [MaxHeight] # enumFromThenTo :: MaxHeight -> MaxHeight -> MaxHeight -> [MaxHeight] #
Num MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods (+) :: MaxHeight -> MaxHeight -> MaxHeight # (-) :: MaxHeight -> MaxHeight -> MaxHeight # (*) :: MaxHeight -> MaxHeight -> MaxHeight # negate :: MaxHeight -> MaxHeight # abs :: MaxHeight -> MaxHeight # signum :: MaxHeight -> MaxHeight # fromInteger :: Integer -> MaxHeight #
Integral MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods quot :: MaxHeight -> MaxHeight -> MaxHeight # rem :: MaxHeight -> MaxHeight -> MaxHeight # div :: MaxHeight -> MaxHeight -> MaxHeight # mod :: MaxHeight -> MaxHeight -> MaxHeight # quotRem :: MaxHeight -> MaxHeight -> (MaxHeight, MaxHeight) # divMod :: MaxHeight -> MaxHeight -> (MaxHeight, MaxHeight) # toInteger :: MaxHeight -> Integer #
Real MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods toRational :: MaxHeight -> Rational #
Show MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods showsPrec :: Int -> MaxHeight -> ShowS # show :: MaxHeight -> String # showList :: [MaxHeight] -> ShowS #
Eq MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods (==) :: MaxHeight -> MaxHeight -> Bool # (/=) :: MaxHeight -> MaxHeight -> Bool #
Ord MaxHeight Source #
Instance details Defined in Data.Gibberish.Formatting Methods compare :: MaxHeight -> MaxHeight -> Ordering # (<) :: MaxHeight -> MaxHeight -> Bool # (<=) :: MaxHeight -> MaxHeight -> Bool # (>) :: MaxHeight -> MaxHeight -> Bool # (>=) :: MaxHeight -> MaxHeight -> Bool # max :: MaxHeight -> MaxHeight -> MaxHeight # min :: MaxHeight -> MaxHeight -> MaxHeight #

newtype Separator Source #

Constructors

Separator
Fields unSeparator :: Text

Instances

Instances details

Show Separator Source #
Instance details Defined in Data.Gibberish.Formatting Methods showsPrec :: Int -> Separator -> ShowS # show :: Separator -> String # showList :: [Separator] -> ShowS #
Eq Separator Source #
Instance details Defined in Data.Gibberish.Formatting Methods (==) :: Separator -> Separator -> Bool # (/=) :: Separator -> Separator -> Bool #

newtype ExactNumberWords Source #

Constructors

ExactNumberWords
Fields unExactWords :: Int

Instances

Instances details

Enum ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods succ :: ExactNumberWords -> ExactNumberWords # pred :: ExactNumberWords -> ExactNumberWords # toEnum :: Int -> ExactNumberWords # fromEnum :: ExactNumberWords -> Int # enumFrom :: ExactNumberWords -> [ExactNumberWords] # enumFromThen :: ExactNumberWords -> ExactNumberWords -> [ExactNumberWords] # enumFromTo :: ExactNumberWords -> ExactNumberWords -> [ExactNumberWords] # enumFromThenTo :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords -> [ExactNumberWords] #
Num ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods (+) :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # (-) :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # (*) :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # negate :: ExactNumberWords -> ExactNumberWords # abs :: ExactNumberWords -> ExactNumberWords # signum :: ExactNumberWords -> ExactNumberWords # fromInteger :: Integer -> ExactNumberWords #
Integral ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods quot :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # rem :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # div :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # mod :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # quotRem :: ExactNumberWords -> ExactNumberWords -> (ExactNumberWords, ExactNumberWords) # divMod :: ExactNumberWords -> ExactNumberWords -> (ExactNumberWords, ExactNumberWords) # toInteger :: ExactNumberWords -> Integer #
Real ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods toRational :: ExactNumberWords -> Rational #
Show ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods showsPrec :: Int -> ExactNumberWords -> ShowS # show :: ExactNumberWords -> String # showList :: [ExactNumberWords] -> ShowS #
Eq ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods (==) :: ExactNumberWords -> ExactNumberWords -> Bool # (/=) :: ExactNumberWords -> ExactNumberWords -> Bool #
Ord ExactNumberWords Source #
Instance details Defined in Data.Gibberish.Formatting Methods compare :: ExactNumberWords -> ExactNumberWords -> Ordering # (<) :: ExactNumberWords -> ExactNumberWords -> Bool # (<=) :: ExactNumberWords -> ExactNumberWords -> Bool # (>) :: ExactNumberWords -> ExactNumberWords -> Bool # (>=) :: ExactNumberWords -> ExactNumberWords -> Bool # max :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords # min :: ExactNumberWords -> ExactNumberWords -> ExactNumberWords #

formatWords :: FormatOpts -> [Word] -> Text Source #

Format a list of words to a text blob

formatLine :: FormatOpts -> [Word] -> FormatLine Source #

Format a single line of words, up to maxLen characters