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 name is not in scope.

Constructors

EmptyNameDisp

NameDisp (ModName -> Ident -> Maybe NameFormat)

Instances

Show NameDisp

Methods

showsPrec :: Int -> NameDisp -> ShowS

show :: NameDisp -> String

showList :: [NameDisp] -> ShowS

Generic NameDisp

Associated Types

type Rep NameDisp :: * -> *

Methods

from :: NameDisp -> Rep NameDisp x

to :: Rep NameDisp x -> NameDisp

Monoid NameDisp

Methods

mempty :: NameDisp

mappend :: NameDisp -> NameDisp -> NameDisp

mconcat :: [NameDisp] -> NameDisp

NFData NameDisp

Methods

rnf :: NameDisp -> ()

type Rep NameDisp

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

data NameFormat

Constructors

UnQualified

Qualified !ModName

NotInScope

Instances

Show NameFormat

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 -> ModName

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

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

IsString Doc

Methods

fromString :: String -> Doc

Generic Doc

Associated Types

type Rep Doc :: * -> *

Methods

from :: Doc -> Rep Doc x

to :: Rep Doc x -> Doc

Monoid Doc

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

NFData Doc

Methods

rnf :: Doc -> ()

DebugLog Doc

Methods

debugLog :: Solver -> Doc -> IO ()

debugLogList :: Solver -> [Doc] -> IO ()

type Rep Doc

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

runDoc :: NameDisp -> Doc -> Doc

render :: Doc -> String

class PP a where

Minimal complete definition

ppPrec

Methods

ppPrec :: Int -> a -> Doc

Instances

PP Text

Methods

ppPrec :: Int -> Text -> Doc

PP Ident

Methods

ppPrec :: Int -> Ident -> Doc

PP Range

Methods

ppPrec :: Int -> Range -> Doc

PP Position

Methods

ppPrec :: Int -> Position -> Doc

PP Token

Methods

ppPrec :: Int -> Token -> Doc

PP PName

Methods

ppPrec :: Int -> PName -> Doc

PP TFun

Methods

ppPrec :: Int -> TFun -> Doc

PP Kind

Methods

ppPrec :: Int -> Kind -> Doc

PP Selector

Methods

ppPrec :: Int -> Selector -> Doc

PP Literal

Methods

ppPrec :: Int -> Literal -> Doc

PP Pragma

Methods

ppPrec :: Int -> Pragma -> Doc

PP ImportSpec

Methods

ppPrec :: Int -> ImportSpec -> Doc

PP Import

Methods

ppPrec :: Int -> Import -> Doc

PP Name

Methods

ppPrec :: Int -> Name -> Doc

PP Decl

Methods

ppPrec :: Int -> Decl -> Doc

PP DeclGroup

Methods

ppPrec :: Int -> DeclGroup -> Doc

PP Match

Methods

ppPrec :: Int -> Match -> Doc

PP Expr

Methods

ppPrec :: Int -> Expr -> Doc

PP UserTC

Methods

ppPrec :: Int -> UserTC -> Doc

PP TC

Methods

ppPrec :: Int -> TC -> Doc

PP PC

Methods

ppPrec :: Int -> PC -> Doc

PP TCon

Methods

ppPrec :: Int -> TCon -> Doc

PP TVar

Methods

ppPrec :: Int -> TVar -> Doc

PP Type

Methods

ppPrec :: Int -> Type -> Doc

PP TParam

Methods

ppPrec :: Int -> TParam -> Doc

PP TySyn

Methods

ppPrec :: Int -> TySyn -> Doc

PP Schema

Methods

ppPrec :: Int -> Schema -> Doc

PP Kind

Methods

ppPrec :: Int -> Kind -> Doc

PP Module

Methods

ppPrec :: Int -> Module -> Doc

PP EvalError

Methods

ppPrec :: Int -> EvalError -> Doc

PP Subst

Methods

ppPrec :: Int -> Subst -> Doc

PP Error

Methods

ppPrec :: Int -> Error -> Doc

PP TyFunName

Methods

ppPrec :: Int -> TyFunName -> Doc

PP ConstraintSource

Methods

ppPrec :: Int -> ConstraintSource -> Doc

PP Error

Methods

ppPrec :: Int -> Error -> Doc

PP Warning

Methods

ppPrec :: Int -> Warning -> Doc

PP Solved

Methods

ppPrec :: Int -> Solved -> Doc

PP ParseError

Methods

ppPrec :: Int -> ParseError -> Doc

PP RenamerWarning

Methods

ppPrec :: Int -> RenamerWarning -> Doc

PP RenamerError

Methods

ppPrec :: Int -> RenamerError -> Doc

PP ModuleWarning

Methods

ppPrec :: Int -> ModuleWarning -> Doc

PP ModuleError

Methods

ppPrec :: Int -> ModuleError -> Doc

PP ImportSource

Methods

ppPrec :: Int -> ImportSource -> Doc

PP Smoke

Methods

ppPrec :: Int -> Smoke -> Doc

PP REPLException

Methods

ppPrec :: Int -> REPLException -> Doc

PP a => PP (Located a)

Methods

ppPrec :: Int -> Located a -> Doc

PP (WithNames DeclDef)

Methods

ppPrec :: Int -> WithNames DeclDef -> Doc

PP (WithNames Decl)

Methods

ppPrec :: Int -> WithNames Decl -> Doc

PP (WithNames DeclGroup)

Methods

ppPrec :: Int -> WithNames DeclGroup -> Doc

PP (WithNames Match)

Methods

ppPrec :: Int -> WithNames Match -> Doc

PP (WithNames Expr)

Methods

ppPrec :: Int -> WithNames Expr -> Doc

PP (WithNames TVar)

Methods

ppPrec :: Int -> WithNames TVar -> Doc

PP (WithNames Type)

Methods

ppPrec :: Int -> WithNames Type -> Doc

PP (WithNames TParam)

Methods

ppPrec :: Int -> WithNames TParam -> Doc

PP (WithNames TySyn)

Methods

ppPrec :: Int -> WithNames TySyn -> Doc

PP (WithNames Schema)

Methods

ppPrec :: Int -> WithNames Schema -> Doc

PP (WithNames Module)

Methods

ppPrec :: Int -> WithNames Module -> Doc

PP (WithNames Subst)

Methods

ppPrec :: Int -> WithNames Subst -> Doc

PP (WithNames Error)

Methods

ppPrec :: Int -> WithNames Error -> Doc

PP (WithNames Warning)

Methods

ppPrec :: Int -> WithNames Warning -> Doc

PP (WithNames DelayedCt)

Methods

ppPrec :: Int -> WithNames DelayedCt -> Doc

PP (WithNames Goal)

Methods

ppPrec :: Int -> WithNames Goal -> Doc

PPName name => PP (Prop name)

Methods

ppPrec :: Int -> Prop name -> Doc

PPName name => PP (Type name)

Methods

ppPrec :: Int -> Type name -> Doc

PPName name => PP (TParam name)

Methods

ppPrec :: Int -> TParam name -> Doc

PPName name => PP (Schema name)

Methods

ppPrec :: Int -> Schema name -> Doc

PPName name => PP (Pattern name)

Methods

ppPrec :: Int -> Pattern name -> Doc

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

Methods

ppPrec :: Int -> Match name -> Doc

PPName name => PP (TypeInst name)

Methods

ppPrec :: Int -> TypeInst name -> Doc

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

Methods

ppPrec :: Int -> Expr name -> Doc

PP a => PP (TopLevel a)

Methods

ppPrec :: Int -> TopLevel a -> Doc

PPName name => PP (Newtype name)

Methods

ppPrec :: Int -> Newtype name -> Doc

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

Methods

ppPrec :: Int -> BindDef name -> Doc

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

Methods

ppPrec :: Int -> Bind name -> Doc

PPName name => PP (TySyn name)

Methods

ppPrec :: Int -> TySyn name -> Doc

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

Methods

ppPrec :: Int -> Decl name -> Doc

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

Methods

ppPrec :: Int -> TopDecl name -> Doc

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

Methods

ppPrec :: Int -> Module name -> Doc

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

Methods

ppPrec :: Int -> Program name -> Doc

PP (WithBase Value)

Methods

ppPrec :: Int -> WithBase Value -> Doc

PP (WithBase EvalEnv)

Methods

ppPrec :: Int -> WithBase EvalEnv -> Doc

class PP a => PPName a where

Minimal complete definition

ppNameFixity, ppPrefixName, ppInfixName

Methods

ppNameFixity :: a -> Maybe (Assoc, Int)

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

Methods

ppNameFixity :: PName -> Maybe (Assoc, Int)

ppPrefixName :: PName -> Doc

ppInfixName :: PName -> Doc

PPName TFun

Methods

ppNameFixity :: TFun -> Maybe (Assoc, Int)

ppPrefixName :: TFun -> Doc

ppInfixName :: TFun -> Doc

PPName Name

Methods

ppNameFixity :: Name -> Maybe (Assoc, Int)

ppPrefixName :: Name -> Doc

ppInfixName :: Name -> Doc

PPName a => PPName (Located a)

Methods

ppNameFixity :: Located a -> Maybe (Assoc, Int)

ppPrefixName :: Located a -> Doc

ppInfixName :: Located a -> Doc

pp :: PP a => a -> Doc

pretty :: PP a => a -> String

optParens :: Bool -> Doc -> Doc

data Assoc

Information about associativity.

Constructors

LeftAssoc

RightAssoc

NonAssoc

Instances

Eq Assoc

Methods

(==) :: Assoc -> Assoc -> Bool

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

Show Assoc

Methods

showsPrec :: Int -> Assoc -> ShowS

show :: Assoc -> String

showList :: [Assoc] -> ShowS

Generic Assoc

Associated Types

type Rep Assoc :: * -> *

Methods

from :: Assoc -> Rep Assoc x

to :: Rep Assoc x -> Assoc

NFData Assoc

Methods

rnf :: Assoc -> ()

type Rep Assoc

type Rep Assoc = D1 (MetaData "Assoc" "Cryptol.Utils.PP" "cryptol-2.4.0-AtabUoGsZJn8kSvO8P84NP" False) ((:+:) (C1 (MetaCons "LeftAssoc" PrefixI False) U1) ((:+:) (C1 (MetaCons "RightAssoc" PrefixI False) U1) (C1 (MetaCons "NonAssoc" PrefixI False) U1)))

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 argumrnt

• iePrec :: Int

  operator precedence

• ieAssoc :: Assoc

  operator associativity

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 values as an ordinar (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

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

text :: String -> Doc

char :: Char -> Doc

integer :: Integer -> Doc

int :: Int -> Doc

comma :: Doc

empty :: Doc

colon :: Doc