Language.Haskell.Liquid.UX.Tidy

This module contains functions for cleaning up types before they are rendered, e.g. in error messages or annoations, and also some PPrint instances that rely upon tidying.

Tidying functions

tidySpecType :: Tidy -> SpecType -> SpecType

tidySymbol :: Symbol -> Symbol

Tidyness tests

isTmpSymbol :: Symbol -> Bool

Panic and Exit

panicError :: Error -> a

This function is put in this module as it depends on the Exception instance, which depends on the PPrint instance, which depends on tidySpecType.

Show an Error, then crash

Final result

class Result a where

Converting Results To Answers -------------------------------------

Minimal complete definition

result

Methods

result :: a -> FixResult UserError

Instances

Result UserError

Methods

result :: UserError -> FixResult UserError

Result Error

Methods

result :: Error -> FixResult UserError

Result [Error]

Methods

result :: [Error] -> FixResult UserError

Result (FixResult Cinfo)

Methods

result :: FixResult Cinfo -> FixResult UserError

Error to UserError

errorToUserError :: Error -> UserError

MOVE TO TYPES

cinfoError :: Cinfo -> Error

Orphan instances

Show Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Exception Error

Methods

toException :: Error -> SomeException

fromException :: SomeException -> Maybe Error

displayException :: Error -> String

PPrint Error

Methods

pprintTidy :: Tidy -> Error -> Doc

pprintPrec :: Int -> Tidy -> Error -> Doc

Exception [Error]

Methods

toException :: [Error] -> SomeException

fromException :: SomeException -> Maybe [Error]

displayException :: [Error] -> String

PPrint (CtxError Doc)

Pretty Printing Error Messages --------------------------------------------

Need to put PPrint Error instance here (instead of in Types), as it depends on PPrint SpecTypes, which lives in this module.

Methods

pprintTidy :: Tidy -> CtxError Doc -> Doc

pprintPrec :: Int -> Tidy -> CtxError Doc -> Doc

PPrint (CtxError SpecType)

Methods

pprintTidy :: Tidy -> CtxError SpecType -> Doc

pprintPrec :: Int -> Tidy -> CtxError SpecType -> Doc