Clash.Core.Pretty

PrettyPrec printing class and instances for CoreHW

Documentation

class PrettyPrec p where

PrettyPrec printing Show-like typeclass

Minimal complete definition

pprPrec

Methods

pprPrec :: Monad m => Rational -> p -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> p -> m ClashDoc

Instances

PrettyPrec Text

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Text -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Text -> m ClashDoc

PrettyPrec SrcSpan

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> SrcSpan -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> SrcSpan -> m ClashDoc

PrettyPrec TyCon

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> TyCon -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> TyCon -> m ClashDoc

PrettyPrec Type

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Type -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Type -> m ClashDoc

PrettyPrec Term

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Term -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Term -> m ClashDoc

PrettyPrec DataCon

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> DataCon -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> DataCon -> m ClashDoc

PrettyPrec Literal

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Literal -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Literal -> m ClashDoc

PrettyPrec LitTy

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> LitTy -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> LitTy -> m ClashDoc

PrettyPrec Pat

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Pat -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Pat -> m ClashDoc

PrettyPrec TickInfo

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> TickInfo -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> TickInfo -> m ClashDoc

PrettyPrec a => PrettyPrec [a]

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> [a] -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> [a] -> m ClashDoc

PrettyPrec (Name a)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Name a -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Name a -> m ClashDoc

PrettyPrec (Var a)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> Var a -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> Var a -> m ClashDoc

PrettyPrec (Id, Term)

Defined in Clash.Core.Pretty

Methods

pprPrec :: Monad m => Rational -> (Id, Term) -> m ClashDoc

pprPrec' :: Monad m => PrettyOptions -> Rational -> (Id, Term) -> m ClashDoc

data PrettyOptions

Options for the pretty-printer, controlling which elements to hide.

Constructors

PrettyOptions

Fields

• displayUniques :: Bool

  whether to display unique identifiers

• displayTypes :: Bool

  whether to display type information

• displayQualifiers :: Bool

  whether to display module qualifiers

Instances

Default PrettyOptions

Defined in Clash.Core.Pretty

Methods

def :: PrettyOptions

type ClashDoc = Doc ClashAnnotation

Clash's specialized Doc type holds metadata of type ClashAnnotation.

data ClashAnnotation

Annotations carried on pretty-printed code.

Constructors

AnnContext CoreContext

marking navigation to a different context

AnnSyntax SyntaxElement

marking a specific sort of syntax

Instances

Eq ClashAnnotation

Defined in Clash.Core.Pretty

Methods

(==) :: ClashAnnotation -> ClashAnnotation -> Bool

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

data SyntaxElement

Specific places in the program syntax.

Constructors

Keyword

LitS

Type

Unique

Qualifier

Instances

Eq SyntaxElement

Defined in Clash.Core.Pretty

Methods

(==) :: SyntaxElement -> SyntaxElement -> Bool

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

Show SyntaxElement

Defined in Clash.Core.Pretty

Methods

showsPrec :: Int -> SyntaxElement -> ShowS

show :: SyntaxElement -> String

showList :: [SyntaxElement] -> ShowS

ppr :: PrettyPrec p => p -> ClashDoc

ppr' :: PrettyPrec p => PrettyOptions -> p -> ClashDoc

showPpr :: PrettyPrec p => p -> String

Print a PrettyPrec thing to a String

showPpr' :: PrettyPrec p => PrettyOptions -> p -> String

tracePprId :: PrettyPrec p => p -> p

tracePpr :: PrettyPrec p => p -> a -> a

fromPpr :: PrettyPrec a => a -> Doc ()

Orphan instances

Pretty LitTy

Methods

pretty :: LitTy -> Doc ann

prettyList :: [LitTy] -> Doc ann

ClashPretty Type

Methods

clashPretty :: Type -> Doc ()

ClashPretty Term

Methods

clashPretty :: Term -> Doc ()

ClashPretty (Name a)

Methods

clashPretty :: Name a -> Doc ()

ClashPretty (Var a)

Methods

clashPretty :: Var a -> Doc ()