clash-lib-1.8.1: Clash: a functional hardware description language - As a library

Safe Haskell | Safe-Inferred
Language | Haskell2010

Clash.Pretty

Synopsis

- unsafeLookupEnvWord :: HasCallStack => String -> Word -> Word
- defaultPprWidth :: Int
- showDoc :: Doc ann -> String
- removeAnnotations :: Doc ann -> Doc ()
- class ClashPretty a where
  - clashPretty :: a -> Doc ()
- fromPretty :: Pretty a => a -> Doc ()

# Documentation

unsafeLookupEnvWord :: HasCallStack => String -> Word -> Word Source #

defaultPprWidth :: Int Source #

showDoc :: Doc ann -> String Source #

removeAnnotations :: Doc ann -> Doc () Source #

class ClashPretty a where Source #

A variant of `Pretty` that is not polymorphic on the type of annotations. This is needed to derive instances from Clash's pretty printer (PrettyPrec), which annotates documents with Clash-specific information and, therefore, fixes the type of annotations.

Methods

clashPretty :: a -> Doc () Source #

#### Instances

Instances details

ClashPretty StackFrame Source # |
Instance details Defined in Clash.Core.Evaluator.Types Methods clashPretty :: StackFrame -> Doc () Source #
ClashPretty TvSubst Source # |
Instance details Defined in Clash.Core.Subst Methods clashPretty :: TvSubst -> Doc () Source #
ClashPretty Term Source # |
Instance details Defined in Clash.Core.Pretty Methods clashPretty :: Term -> Doc () Source #
ClashPretty Type Source # |
Instance details Defined in Clash.Core.Pretty Methods clashPretty :: Type -> Doc () Source #
ClashPretty InScopeSet Source # |
Instance details Defined in Clash.Core.VarEnv Methods clashPretty :: InScopeSet -> Doc () Source #
ClashPretty (Name a) Source # |
Instance details Defined in Clash.Core.Pretty Methods clashPretty :: Name a -> Doc () Source #
ClashPretty (Var a) Source # |
Instance details Defined in Clash.Core.Pretty Methods clashPretty :: Var a -> Doc () Source #
ClashPretty a => ClashPretty (UniqMap a) Source # |
Instance details Defined in Clash.Data.UniqMap Methods clashPretty :: UniqMap a -> Doc () Source #

fromPretty :: Pretty a => a -> Doc () Source #