Clash.Netlist.BlackBox.Util

Utilties to verify blackbox contexts against templates and rendering filled in templates

Documentation

verifyBlackBoxContext

Arguments

:: BlackBoxContext

Blackbox to verify

-> BlackBoxTemplate

Template to check against

-> Bool

Determine if the number of normalliteralfunction inputs of a blackbox context at least matches the number of argument that is expected by the template.

extractLiterals :: BlackBoxContext -> [Expr]

setSym :: BlackBoxContext -> BlackBoxTemplate -> NetlistMonad (BlackBoxTemplate, [Declaration])

Update all the symbol references in a template, and increment the symbol counter for every newly encountered symbol.

setCompName :: Identifier -> BlackBoxTemplate -> BlackBoxTemplate

findAndSetDataFiles :: BlackBoxContext -> [(String, FilePath)] -> BlackBoxTemplate -> ([(String, FilePath)], BlackBoxTemplate)

renderFilePath :: [(String, FilePath)] -> String -> ([(String, FilePath)], Element)

renderTemplate

Arguments

:: Backend backend

=> BlackBoxContext

Context used to fill in the hole

-> BlackBoxTemplate

Blackbox template

-> State backend (Int -> Text)

Render a blackbox given a certain context. Returns a filled out template and a list of hidden inputs that must be added to the encompassing component.

renderBlackBox :: Backend backend => [BlackBoxTemplate] -> [BlackBoxTemplate] -> Maybe ((Text, Text), BlackBoxTemplate) -> BlackBoxTemplate -> BlackBoxContext -> State backend (Int -> Doc)

setSimpleVar :: BlackBoxContext -> BlackBoxTemplate -> BlackBoxTemplate

Assign Var holes in the context of a primitive HDL template that is passed as an argument of a higher-order HDL template. For the general case, use setSym

This functions errors when the Var hole cannot be filled with a variable, as it is (currently) impossible to create unique names this late in the pipeline.

renderElem :: Backend backend => BlackBoxContext -> Element -> State backend (Int -> Text)

Render a single template element

parseFail :: Text -> BlackBoxTemplate

idToExpr :: (Text, HWType) -> (Expr, HWType, Bool)

lineToIdentifier :: Backend backend => BlackBoxContext -> BlackBoxTemplate -> State backend Text

Fill out the template corresponding to an output/input assignment of a component instantiation, and turn it into a single identifier so it can be used for a new blackbox context.

lineToType :: BlackBoxContext -> BlackBoxTemplate -> HWType

renderTag :: Backend backend => BlackBoxContext -> Element -> State backend Text

Give a context and a tagged hole (of a template), returns part of the context that matches the tag of the hole.

exprToText :: Expr -> Maybe Text

prettyBlackBox :: Monad m => BlackBoxTemplate -> Mon m Text

prettyElem :: Monad m => Element -> Mon m Text

usedArguments :: BlackBoxTemplate -> [Int]