Cryptol.Utils.PP

Documentation

data NameDisp

How to display names, inspired by the GHC Outputable module. Getting a value of Nothing from the NameDisp function indicates that the display has no opinion on how this name should be displayed, and some other display should be tried out.

Constructors

EmptyNameDisp

NameDisp (ModName -> Ident -> Maybe NameFormat)

Instances

Show NameDisp

Defined in Cryptol.Utils.PP

Methods

showsPrec :: Int -> NameDisp -> ShowS

show :: NameDisp -> String

showList :: [NameDisp] -> ShowS

Generic NameDisp

Defined in Cryptol.Utils.PP

Associated Types

type Rep NameDisp :: Type -> Type

Methods

from :: NameDisp -> Rep NameDisp x

to :: Rep NameDisp x -> NameDisp

Semigroup NameDisp

Defined in Cryptol.Utils.PP

Methods

(<>) :: NameDisp -> NameDisp -> NameDisp

sconcat :: NonEmpty NameDisp -> NameDisp

stimes :: Integral b => b -> NameDisp -> NameDisp

Monoid NameDisp

Defined in Cryptol.Utils.PP

Methods

mempty :: NameDisp

mappend :: NameDisp -> NameDisp -> NameDisp

mconcat :: [NameDisp] -> NameDisp

NFData NameDisp

Defined in Cryptol.Utils.PP

Methods

rnf :: NameDisp -> ()

type Rep NameDisp

Defined in Cryptol.Utils.PP

type Rep NameDisp = D1 ('MetaData "NameDisp" "Cryptol.Utils.PP" "cryptol-2.10.0-Bsi6VMfJ6GCFlOdda30jWW" 'False) (C1 ('MetaCons "EmptyNameDisp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NameDisp" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ModName -> Ident -> Maybe NameFormat))))

data NameFormat

Constructors

UnQualified

Qualified !ModName

NotInScope

Instances

Show NameFormat

Defined in Cryptol.Utils.PP

Methods

showsPrec :: Int -> NameFormat -> ShowS

show :: NameFormat -> String

showList :: [NameFormat] -> ShowS

neverQualifyMod :: ModName -> NameDisp

Never qualify names from this module.

alwaysQualify :: NameDisp

neverQualify :: NameDisp

fmtModName :: ModName -> NameFormat -> Text

extend :: NameDisp -> NameDisp -> NameDisp

Compose two naming environments, preferring names from the left environment.

getNameFormat :: ModName -> Ident -> NameDisp -> NameFormat

Get the format for a name. When Nothing is returned, the name is not currently in scope.

withNameDisp :: (NameDisp -> Doc) -> Doc

Produce a document in the context of the current NameDisp.

fixNameDisp :: NameDisp -> Doc -> Doc

Fix the way that names are displayed inside of a doc.

newtype Doc

Constructors

Doc (NameDisp -> Doc)

Instances

Show Doc

Defined in Cryptol.Utils.PP

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

IsString Doc

Defined in Cryptol.Utils.PP

Methods

fromString :: String -> Doc

Generic Doc

Defined in Cryptol.Utils.PP

Associated Types

type Rep Doc :: Type -> Type

Methods

from :: Doc -> Rep Doc x

to :: Rep Doc x -> Doc

Semigroup Doc

Defined in Cryptol.Utils.PP

Methods

(<>) :: Doc -> Doc -> Doc

sconcat :: NonEmpty Doc -> Doc

stimes :: Integral b => b -> Doc -> Doc

Monoid Doc

Defined in Cryptol.Utils.PP

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

NFData Doc

Defined in Cryptol.Utils.PP

Methods

rnf :: Doc -> ()

type Rep Doc

Defined in Cryptol.Utils.PP

type Rep Doc = D1 ('MetaData "Doc" "Cryptol.Utils.PP" "cryptol-2.10.0-Bsi6VMfJ6GCFlOdda30jWW" 'True) (C1 ('MetaCons "Doc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NameDisp -> Doc))))

runDoc :: NameDisp -> Doc -> Doc

render :: Doc -> String

renderOneLine :: Doc -> String

class PP a where

Methods

ppPrec :: Int -> a -> Doc

Instances

PP Text

Defined in Cryptol.Utils.PP

Methods

ppPrec :: Int -> Text -> Doc

PP Fixity

Defined in Cryptol.Utils.PP

Methods

ppPrec :: Int -> Fixity -> Doc

PP Assoc

Defined in Cryptol.Utils.PP

Methods

ppPrec :: Int -> Assoc -> Doc

PP Ident

Defined in Cryptol.Utils.PP

Methods

ppPrec :: Int -> Ident -> Doc

PP ModName

Defined in Cryptol.Utils.PP

Methods

ppPrec :: Int -> ModName -> Doc

PP Selector

Defined in Cryptol.Parser.Selector

Methods

ppPrec :: Int -> Selector -> Doc

PP Range

Defined in Cryptol.Parser.Position

Methods

ppPrec :: Int -> Range -> Doc

PP Position

Defined in Cryptol.Parser.Position

Methods

ppPrec :: Int -> Position -> Doc

PP PName

Defined in Cryptol.Parser.Name

Methods

ppPrec :: Int -> PName -> Doc

PP Token

Defined in Cryptol.Parser.LexerUtils

Methods

ppPrec :: Int -> Token -> Doc

PP Name

Defined in Cryptol.ModuleSystem.Name

Methods

ppPrec :: Int -> Name -> Doc

PP TFun

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> TFun -> Doc

PP UserTC

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> UserTC -> Doc

PP TC

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> TC -> Doc

PP PC

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> PC -> Doc

PP TCon

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> TCon -> Doc

PP Kind

Defined in Cryptol.TypeCheck.TCon

Methods

ppPrec :: Int -> Kind -> Doc

PP Newtype

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> Newtype -> Doc

PP TySyn

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> TySyn -> Doc

PP ArgDescr

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> ArgDescr -> Doc

PP TypeSource

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> TypeSource -> Doc

PP TVarInfo

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> TVarInfo -> Doc

PP TVar

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> TVar -> Doc

PP Type

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> Type -> Doc

PP TParam

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> TParam -> Doc

PP Schema

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> Schema -> Doc

PP Kind

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Kind -> Doc

PP UpdHow

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> UpdHow -> Doc

PP Literal

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Literal -> Doc

PP Pragma

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Pragma -> Doc

PP ImportSpec

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> ImportSpec -> Doc

PP Import

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Import -> Doc

PP Error

Defined in Cryptol.Parser.NoPat

Methods

ppPrec :: Int -> Error -> Doc

PP Decl

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> Decl -> Doc

PP DeclGroup

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> DeclGroup -> Doc

PP Match

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> Match -> Doc

PP Expr

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> Expr -> Doc

PP Module

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> Module -> Doc

PP Solved

Defined in Cryptol.TypeCheck.Solver.Types

Methods

ppPrec :: Int -> Solved -> Doc

PP Subst

Defined in Cryptol.TypeCheck.Subst

Methods

ppPrec :: Int -> Subst -> Doc

PP ConstraintSource

Defined in Cryptol.TypeCheck.InferTypes

Methods

ppPrec :: Int -> ConstraintSource -> Doc

PP Error

Defined in Cryptol.TypeCheck.Error

Methods

ppPrec :: Int -> Error -> Doc

PP Warning

Defined in Cryptol.TypeCheck.Error

Methods

ppPrec :: Int -> Warning -> Doc

PP Unsupported

Defined in Cryptol.Backend.Monad

Methods

ppPrec :: Int -> Unsupported -> Doc

PP EvalError

Defined in Cryptol.Backend.Monad

Methods

ppPrec :: Int -> EvalError -> Doc

PP RenamerWarning

Defined in Cryptol.ModuleSystem.Renamer

Methods

ppPrec :: Int -> RenamerWarning -> Doc

PP RenamerError

Defined in Cryptol.ModuleSystem.Renamer

Methods

ppPrec :: Int -> RenamerError -> Doc

PP ModulePath

Defined in Cryptol.ModuleSystem.Env

Methods

ppPrec :: Int -> ModulePath -> Doc

PP ModuleWarning

Defined in Cryptol.ModuleSystem.Monad

Methods

ppPrec :: Int -> ModuleWarning -> Doc

PP ModuleError

Defined in Cryptol.ModuleSystem.Monad

Methods

ppPrec :: Int -> ModuleError -> Doc

PP ImportSource

Defined in Cryptol.ModuleSystem.Monad

Methods

ppPrec :: Int -> ImportSource -> Doc

PP Smoke

Defined in Cryptol.REPL.Monad

Methods

ppPrec :: Int -> Smoke -> Doc

PP REPLException

Defined in Cryptol.REPL.Monad

Methods

ppPrec :: Int -> REPLException -> Doc

PP (WithNames Newtype)

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames Newtype -> Doc

PP (WithNames TySyn)

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames TySyn -> Doc

PP (WithNames TVar)

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames TVar -> Doc

PP (WithNames Type)

The precedence levels used by this pretty-printing instance correspond with parser non-terminals as follows:

• 0-1: type
• 2: infix_type
• 3: app_type
• 4: dimensions atype
• 5: atype

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames Type -> Doc

PP (WithNames TParam)

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames TParam -> Doc

PP (WithNames Schema)

Defined in Cryptol.TypeCheck.Type

Methods

ppPrec :: Int -> WithNames Schema -> Doc

PP (WithNames DeclDef)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames DeclDef -> Doc

PP (WithNames Decl)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames Decl -> Doc

PP (WithNames DeclGroup)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames DeclGroup -> Doc

PP (WithNames Match)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames Match -> Doc

PP (WithNames Expr)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames Expr -> Doc

PP (WithNames Module)

Defined in Cryptol.TypeCheck.AST

Methods

ppPrec :: Int -> WithNames Module -> Doc

PP (WithNames Subst)

Defined in Cryptol.TypeCheck.Subst

Methods

ppPrec :: Int -> WithNames Subst -> Doc

PP (WithNames DelayedCt)

Defined in Cryptol.TypeCheck.InferTypes

Methods

ppPrec :: Int -> WithNames DelayedCt -> Doc

PP (WithNames Goal)

Defined in Cryptol.TypeCheck.InferTypes

Methods

ppPrec :: Int -> WithNames Goal -> Doc

PP (WithNames Error)

Defined in Cryptol.TypeCheck.Error

Methods

ppPrec :: Int -> WithNames Error -> Doc

PP (WithNames Warning)

Defined in Cryptol.TypeCheck.Error

Methods

ppPrec :: Int -> WithNames Warning -> Doc

PP a => PP (Located a)

Defined in Cryptol.Parser.Position

Methods

ppPrec :: Int -> Located a -> Doc

PPName name => PP (Prop name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Prop name -> Doc

PPName name => PP (Type name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Type name -> Doc

PPName name => PP (TParam name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> TParam name -> Doc

PPName name => PP (Schema name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Schema name -> Doc

PPName name => PP (Pattern name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Pattern name -> Doc

(Show name, PPName name) => PP (Match name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Match name -> Doc

PPName name => PP (TypeInst name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> TypeInst name -> Doc

(Show name, PPName name) => PP (UpdField name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> UpdField name -> Doc

(Show name, PPName name) => PP (Expr name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Expr name -> Doc

PP a => PP (TopLevel a)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> TopLevel a -> Doc

(Show name, PPName name) => PP (PrimType name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> PrimType name -> Doc

PPName name => PP (Newtype name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Newtype name -> Doc

(Show name, PPName name) => PP (BindDef name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> BindDef name -> Doc

(Show name, PPName name) => PP (Bind name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Bind name -> Doc

PPName name => PP (PropSyn name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> PropSyn name -> Doc

PPName name => PP (TySyn name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> TySyn name -> Doc

(Show name, PPName name) => PP (ParameterFun name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> ParameterFun name -> Doc

(Show name, PPName name) => PP (ParameterType name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> ParameterType name -> Doc

(Show name, PPName name) => PP (Decl name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Decl name -> Doc

(Show name, PPName name) => PP (TopDecl name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> TopDecl name -> Doc

(Show name, PPName name) => PP (Module name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Module name -> Doc

(Show name, PPName name) => PP (Program name)

Defined in Cryptol.Parser.AST

Methods

ppPrec :: Int -> Program name -> Doc

class PP a => PPName a where

Methods

ppNameFixity :: a -> Maybe Fixity

Fixity information for infix operators

ppPrefixName :: a -> Doc

Print a name in prefix: f a b or (+) a b)

ppInfixName :: a -> Doc

Print a name as an infix operator: a + b

Instances

PPName PName

Defined in Cryptol.Parser.Name

Methods

ppNameFixity :: PName -> Maybe Fixity

ppPrefixName :: PName -> Doc

ppInfixName :: PName -> Doc

PPName Name

Defined in Cryptol.ModuleSystem.Name

Methods

ppNameFixity :: Name -> Maybe Fixity

ppPrefixName :: Name -> Doc

ppInfixName :: Name -> Doc

PPName a => PPName (Located a)

Defined in Cryptol.Parser.Position

Methods

ppNameFixity :: Located a -> Maybe Fixity

ppPrefixName :: Located a -> Doc

ppInfixName :: Located a -> Doc

pp :: PP a => a -> Doc

pretty :: PP a => a -> String

optParens :: Bool -> Doc -> Doc

data Infix op thing

Information about an infix expression of some sort.

Constructors

Infix

Fields

• ieOp :: op

  operator

• ieLeft :: thing

  left argument

• ieRight :: thing

  right argument

• ieFixity :: Fixity

  operator fixity

commaSep :: [Doc] -> Doc

ppInfix

Arguments

:: (PP thing, PP op)

=> Int

Non-infix leaves are printed with this precedence

-> (thing -> Maybe (Infix op thing))

pattern to check if sub-thing is also infix

-> Infix op thing

Pretty print this infix expression

-> Doc

Pretty print an infix expression of some sort.

ordinal :: (Integral a, Show a, Eq a) => a -> Doc

Display a numeric value as an ordinal (e.g., 2nd)

ordSuffix :: (Integral a, Eq a) => a -> String

The suffix to use when displaying a number as an oridinal

liftPJ :: Doc -> Doc

liftPJ1 :: (Doc -> Doc) -> Doc -> Doc

liftPJ2 :: (Doc -> Doc -> Doc) -> Doc -> Doc -> Doc

liftSep :: ([Doc] -> Doc) -> [Doc] -> Doc

(<.>) :: Doc -> Doc -> Doc infixl 6

(<+>) :: Doc -> Doc -> Doc infixl 6

($$) :: Doc -> Doc -> Doc infixl 5

sep :: [Doc] -> Doc

fsep :: [Doc] -> Doc

hsep :: [Doc] -> Doc

hcat :: [Doc] -> Doc

vcat :: [Doc] -> Doc

hang :: Doc -> Int -> Doc -> Doc

nest :: Int -> Doc -> Doc

parens :: Doc -> Doc

braces :: Doc -> Doc

brackets :: Doc -> Doc

quotes :: Doc -> Doc

backticks :: Doc -> Doc

punctuate :: Doc -> [Doc] -> [Doc]

text :: String -> Doc

char :: Char -> Doc

integer :: Integer -> Doc

int :: Int -> Doc

comma :: Doc

empty :: Doc

colon :: Doc