Safe Haskell	Trustworthy
Language	Haskell2010

ReWire.Config

Synopsis

interpret :: [Flag] -> Either ErrorMsg Config
data Config
getOutFile :: Config -> FilePath -> FilePath
eidosFile :: Config -> FilePath -> FilePath
synolonFile :: Config -> FilePath -> FilePath
data Language
- = Interpret
- | VHDL
- | Verilog
- | Cryptol
- | RWCore
- | Haskell
data ResetFlag
- = Inverted
- | Synchronous
data OutFlag
- = Flatten
- | Pretty
- | Verbose
data Certify
- = CertifyOff
- | CertifyWarn
- | CertifyRequired
verbose :: Lens' Config Bool
pretty :: Lens' Config Bool
flatten :: Lens' Config Bool
target :: Lens' Config Language
clock :: Lens' Config Text
reset :: Lens' Config Text
resetFlags :: Lens' Config (HashSet ResetFlag)
outFlags :: Lens' Config (HashSet OutFlag)
inputSigs :: Lens' Config [Text]
stateSigs :: Lens' Config [Text]
outputSigs :: Lens' Config [Text]
vhdlPackages :: Lens' Config [Text]
inputsFile :: Lens' Config FilePath
defaultInputsFile :: FilePath
outFile :: Lens' Config (Maybe FilePath)
noWarn :: Lens' Config Bool
wError :: Lens' Config Bool
start :: Lens' Config Text
top :: Lens' Config Text
loadPath :: Lens' Config [FilePath]
cycles :: Lens' Config (Maybe Natural)
depth :: Lens' Config Natural
dump :: Lens' Config (Natural -> Bool)
source :: Lens' Config Language
rtlOpt :: Lens' Config Natural
eidos :: Lens' Config Bool
synolon :: Lens' Config Bool
certify :: Lens' Config Certify
noHalt :: Lens' Config Bool
debugLint :: Lens' Config Bool
testbench :: Lens' Config Bool
stableNames :: Lens' Config Bool
locators :: Lens' Config Bool
noLocators :: Lens' Config Bool
pDebug :: MonadIO m => Config -> Text -> m ()

Documentation

interpret :: [Flag] -> Either ErrorMsg Config Source #

data Config Source #

getOutFile :: Config -> FilePath -> FilePath Source #

eidosFile :: Config -> FilePath -> FilePath Source #

The Eidos IR dump beside the output (the --eidos dump): <out>.eir.

synolonFile :: Config -> FilePath -> FilePath Source #

The Synolon IR dump beside the output — the --synolon dump, and the --certify source artifact (both the writer and the validator invocation compute the path here): <out>.syn.

data Language Source #

Constructors

Interpret
VHDL
Verilog
Cryptol
RWCore
Haskell

Instances

Instances details

Show Language Source #
Instance details Defined in ReWire.Config Methods showsPrec :: Int -> Language -> ShowS # show :: Language -> String # showList :: [Language] -> ShowS #
Eq Language Source #
Instance details Defined in ReWire.Config Methods (==) :: Language -> Language -> Bool # (/=) :: Language -> Language -> Bool #
Ord Language Source #
Instance details Defined in ReWire.Config Methods compare :: Language -> Language -> Ordering # (<) :: Language -> Language -> Bool # (<=) :: Language -> Language -> Bool # (>) :: Language -> Language -> Bool # (>=) :: Language -> Language -> Bool # max :: Language -> Language -> Language # min :: Language -> Language -> Language #

data ResetFlag Source #

Constructors

Inverted
Synchronous

Instances

Instances details

Generic ResetFlag Source #

Instance details

Defined in ReWire.Config

Associated Types

type Rep ResetFlag
Instance details Defined in ReWire.Config type Rep ResetFlag = D1 ('MetaData "ResetFlag" "ReWire.Config" "rewire-base-2.8-FlLB0CaWUZ0C08bXxr65qo" 'False) (C1 ('MetaCons "Inverted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Synchronous" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ResetFlag -> Rep ResetFlag x #

to :: Rep ResetFlag x -> ResetFlag #

Show ResetFlag Source #

Instance details

Defined in ReWire.Config

Methods

showsPrec :: Int -> ResetFlag -> ShowS #

show :: ResetFlag -> String #

showList :: [ResetFlag] -> ShowS #

Eq ResetFlag Source #

Instance details

Defined in ReWire.Config

Methods

(==) :: ResetFlag -> ResetFlag -> Bool #

(/=) :: ResetFlag -> ResetFlag -> Bool #

Ord ResetFlag Source #

Instance details

Defined in ReWire.Config

Methods

compare :: ResetFlag -> ResetFlag -> Ordering #

(<) :: ResetFlag -> ResetFlag -> Bool #

(<=) :: ResetFlag -> ResetFlag -> Bool #

(>) :: ResetFlag -> ResetFlag -> Bool #

(>=) :: ResetFlag -> ResetFlag -> Bool #

max :: ResetFlag -> ResetFlag -> ResetFlag #

min :: ResetFlag -> ResetFlag -> ResetFlag #

Hashable ResetFlag Source #

Instance details

Defined in ReWire.Config

Methods

hashWithSalt :: Int -> ResetFlag -> Int

hash :: ResetFlag -> Int

type Rep ResetFlag Source #

Instance details

Defined in ReWire.Config

type Rep ResetFlag = D1 ('MetaData "ResetFlag" "ReWire.Config" "rewire-base-2.8-FlLB0CaWUZ0C08bXxr65qo" 'False) (C1 ('MetaCons "Inverted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Synchronous" 'PrefixI 'False) (U1 :: Type -> Type))

data OutFlag Source #

Constructors

Flatten
Pretty
Verbose

Instances

Instances details

Generic OutFlag Source #

Instance details

Defined in ReWire.Config

Associated Types

type Rep OutFlag
Instance details Defined in ReWire.Config type Rep OutFlag = D1 ('MetaData "OutFlag" "ReWire.Config" "rewire-base-2.8-FlLB0CaWUZ0C08bXxr65qo" 'False) (C1 ('MetaCons "Flatten" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Pretty" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Verbose" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: OutFlag -> Rep OutFlag x #

to :: Rep OutFlag x -> OutFlag #

Show OutFlag Source #

Instance details

Defined in ReWire.Config

Methods

showsPrec :: Int -> OutFlag -> ShowS #

show :: OutFlag -> String #

showList :: [OutFlag] -> ShowS #

Eq OutFlag Source #

Instance details

Defined in ReWire.Config

Methods

(==) :: OutFlag -> OutFlag -> Bool #

(/=) :: OutFlag -> OutFlag -> Bool #

Ord OutFlag Source #

Instance details

Defined in ReWire.Config

Methods

compare :: OutFlag -> OutFlag -> Ordering #

(<) :: OutFlag -> OutFlag -> Bool #

(<=) :: OutFlag -> OutFlag -> Bool #

(>) :: OutFlag -> OutFlag -> Bool #

(>=) :: OutFlag -> OutFlag -> Bool #

max :: OutFlag -> OutFlag -> OutFlag #

min :: OutFlag -> OutFlag -> OutFlag #

Hashable OutFlag Source #

Instance details

Defined in ReWire.Config

Methods

hashWithSalt :: Int -> OutFlag -> Int

hash :: OutFlag -> Int

type Rep OutFlag Source #

Instance details

Defined in ReWire.Config

type Rep OutFlag = D1 ('MetaData "OutFlag" "ReWire.Config" "rewire-base-2.8-FlLB0CaWUZ0C08bXxr65qo" 'False) (C1 ('MetaCons "Flatten" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Pretty" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Verbose" 'PrefixI 'False) (U1 :: Type -> Type)))

data Certify Source #

--certify: off, best-effort with an unsuppressible status report (--certify=warn), or required (plain --certify: compilation fails unless the validator returns VALIDATED).

Constructors

CertifyOff
CertifyWarn
CertifyRequired

Instances

Instances details

Show Certify Source #
Instance details Defined in ReWire.Config Methods showsPrec :: Int -> Certify -> ShowS # show :: Certify -> String # showList :: [Certify] -> ShowS #
Eq Certify Source #
Instance details Defined in ReWire.Config Methods (==) :: Certify -> Certify -> Bool # (/=) :: Certify -> Certify -> Bool #
Ord Certify Source #
Instance details Defined in ReWire.Config Methods compare :: Certify -> Certify -> Ordering # (<) :: Certify -> Certify -> Bool # (<=) :: Certify -> Certify -> Bool # (>) :: Certify -> Certify -> Bool # (>=) :: Certify -> Certify -> Bool # max :: Certify -> Certify -> Certify # min :: Certify -> Certify -> Certify #