Dino.Pretty

Helpers for pretty printing

Documentation

data Importance

Constructors

Unimportant

Important

Instances

Eq Importance

Defined in Dino.Pretty

Methods

(==) :: Importance -> Importance -> Bool

(/=) :: Importance -> Importance -> Bool

Show Importance

Defined in Dino.Pretty

Methods

showsPrec :: Int -> Importance -> ShowS

show :: Importance -> String

showList :: [Importance] -> ShowS

Generic Importance

Defined in Dino.Pretty

Associated Types

type Rep Importance :: Type -> Type

Methods

from :: Importance -> Rep Importance x

to :: Rep Importance x -> Importance

Semigroup Importance

Returns Important iff. any argument is Important.

Defined in Dino.Pretty

Methods

(<>) :: Importance -> Importance -> Importance

sconcat :: NonEmpty Importance -> Importance

stimes :: Integral b => b -> Importance -> Importance

Hashable Importance

Defined in Dino.Pretty

Methods

hashWithSalt :: Int -> Importance -> Int

hash :: Importance -> Int

type Rep Importance

Defined in Dino.Pretty

type Rep Importance = D1 ('MetaData "Importance" "Dino.Pretty" "dino-0.1.3-IpSliicmrns9EqeuhOgDvM" 'False) (C1 ('MetaCons "Unimportant" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Important" 'PrefixI 'False) (U1 :: Type -> Type))

unchanged :: Doc

Marks a part of a value that hasn't changed

emphasize :: Importance -> Doc -> Doc

Emphasize when Important

underHeader

Arguments

:: Doc

Header

-> Doc

Document to place under the header

-> Doc

Place a document indented under a header:

header
  doc
  doc
  ...

verticalList :: Doc -> Doc -> Doc -> [Doc] -> Doc

Render a list of documents as follows:

[ a
, b
, ...
]

where '[', ',' and ']' are provided as the first three parameters.

newtype Field

A wrapper for String with a Show instance that omits quotes

Useful in situations where show is (ab)used to provide conversion to String rather than for displaying values.

Constructors

Field

Fields

• unField :: String

Instances

Eq Field

Defined in Dino.Pretty

Methods

(==) :: Field -> Field -> Bool

(/=) :: Field -> Field -> Bool

Ord Field

Defined in Dino.Pretty

Methods

compare :: Field -> Field -> Ordering

(<) :: Field -> Field -> Bool

(<=) :: Field -> Field -> Bool

(>) :: Field -> Field -> Bool

(>=) :: Field -> Field -> Bool

max :: Field -> Field -> Field

min :: Field -> Field -> Field

Show Field

Defined in Dino.Pretty

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

IsString Field

Defined in Dino.Pretty

Methods

fromString :: String -> Field

Pretty Field

Defined in Dino.Pretty

Methods

pretty :: Field -> Doc

prettyList :: [Field] -> Doc

Hashable Field

Defined in Dino.Pretty

Methods

hashWithSalt :: Int -> Field -> Int

hash :: Field -> Int

Inspectable a => Inspectable (Mapping Field a)

Defined in Dino.AST

Methods

inspect :: Mapping Field a -> AST Rational

prettyRecord :: (Show k, Ord k) => Importance -> HashMap k Doc -> Doc

Render a record as follows:

{ field1 =
    value1
, field2 =
    value2
,  ...
}

If k is a String-like type, it will be shown with quotes. Use Field to prevent this.