Documentation

Worker function of splitTopEntityT

Remove constraints such as 'a ~ 3'.

Given a list of all found top entities and _maybe_ a top entity (+dependencies) passed in by '-main-is', return the list of top entities Clash needs to compile.

Get modification data of current clash binary.

Create a set of target HDL files for a set of functions

Whether a function should be interpreted as a BlackBoxFunction or a TemplateFunction.

A single function that needs to be interpreted with Hint in order to compile a primitive. Multiple primitives referencing the same function map to the same request, so interpreting the distinct requests of a primitive map compiles each function exactly once.

Module the function of an InterpretFunctionRequest lives in, as a qualified module name

The result of interpreting an InterpretFunctionRequest

Language extensions in effect when interpreting inline primitive sources

The functions a primitive needs interpreted before it can be compiled by compilePrimitiveWith. Functions in knownBlackBoxFunctions or knownTemplateFunctions need no interpretation and yield no request.

Interpret the given functions in a single shared Hint session. Starting a session is expensive (it initializes a full GHC session, including reading all package databases), so sharing one session over all requests is much faster than a session per function. For each request this action tries two things:

1. Interpret without explicitly loading the module. This will succeed if the module can be found in the package databases (passed in as -package-db interpreter arguments).
2. If (1) fails, try to load the module explicitly: either from the inline source a primitive provided, or from the import directories. If this also fails, an error is recorded for the request.

All (1) attempts run before the first (2) attempt, so that interpreting against the package databases is never influenced by locally loaded modules. Note that loadModules resets previously loaded modules, so (2) attempts cannot see each other's modules either.

List of known BlackBoxFunctions used to prevent Hint from firing. This improves Clash startup times.

List of known TemplateFunctions used to prevent Hint from firing. This improves Clash startup times.

Compiles the blackbox functions of and parses the blackbox templates in a primitive map. All blackbox functions are interpreted in a single shared Hint session (see interpretFunctions), and every distinct function is interpreted exactly once, no matter how many primitives reference it.

Compiles a single primitive. Provided for backwards compatibility; when compiling multiple primitives, compilePrimitives only pays the cost of starting a Hint session once.

Look up the interpreter result of a request. All requests are interpreted before primitives are compiled, so a missing result is an internal error: neededInterpRequests diverged from the requests compilePrimitiveWith consumes.

Compiles the blackbox functions of and parses the blackbox templates in a primitive, given an action that produces the interpreted functions the primitive needs (see neededInterpRequests).

Pretty print Components to HDL Documents

Create an Edalize metadata file for using Edalize to build the project.

TODO: Handle libraries. Also see: https://github.com/olofk/edalize/issues/220

Prepares directory for writing HDL files.

Write a file to disk in chunks. Returns SHA256 sum of file contents.

Writes a HDL file to the given directory. Returns SHA256 hash of written file.

Copy given files

Copy data files added with ~FILE, assumes the files are canonicalized already. Throws an error on relative paths as sanity check.

Normalize a complete hierarchy

Reverse topologically sort given top entities. Also returns a mapping that maps a top entity to its reverse topologically sorted transitive dependencies.