Documentation

Get a Render from a Value using WSDefault and precedence 11.

Wrap a Translator in a TStyled variant translator with the provided style.

Wrap a Translator in a TDuplicate variant translator with the provided subsignal name.

Generate a translator reference for a type. Also checks whether the translator width matches the value of bitSize for the type: if not, the function errors.

Create a constant translator that consumes 0 bits and has no subsignals.

Create a LUT translator for a type, using either the static LUT or the translation function specified in WaveformLUT

Create a LUT translator for a type, using the translation function of WaveformLUT.

Create a LUT translator for a type, using the static LUT in WaveformLUT.

Waveform is the main class for making types displayable in the waveform viewer. The class is responsible for defining an appropriate translator and subsignal structure, as well as registering types.

To make a LUT approache possible, the class must also be able to translate values, and to register individual values.

By default, Generic is used to automatically derive this behaviour. Extra classes are provided to help implement lookup tables or common types, like numerical translators. Custom implementations are also very possible.

Return the default translator that is derived for a data type. This default can be modified to obtain a slightly different translator.

Function to translate values. This function creates a translation from the binary representation of the data using translateBin, and the translator.

Translate binary data. Normally, this simply translates the value according to the translator. For LUTs, this involves translating the value back to the original type and translating it using a specially defined translation function.

Register this type and all its subtypes.

Helper function that fills the constructorStyles list with WSDefault.

Check if the type requires values to be added to LUTs.

Return the structure of a type.

Add all (sub) values that use TLut to their respective LUTs.

Remove constructor subsignals from a (generated) translator. This results in all constructor field subsignals becoming direct subsignals of the toplevel signal. Set rename to True to add the constructor's name as a prefix to the signal name.

Essentially, this function searches through TStyled and TSum for any TDuplicate translators to remove. If renaming subsignals, it then searches through TStyled to rename subsignals in TProduct.

Rename constructor fields. This is particularly useful for non-record types. The input is a list of a list of field names, per constructor. Errors if the number of constructors/fields does not match the structure of the Translator. For translators other than TProduct, use an empty list of fieldnames.

Rename the constructors subsignals of a data type. Errors if the number of constructor subsignal names provided is incorrect, or when called on a translator that does not have a sum translator.

Wrap constructors with a single field in the WSInherit 0 style. Ignores any structures that are wrapped in a TStyled translator.

Apply constructor styles. This wraps TProduct translators and modifies the style of TConst translators. Does nothing if the list of styles is empty. Otherwise, errors if the number of styles does not match the number of constructors.

A class for obtaining the required behaviour of Waveform through GHC.Generics. The exact details might change later; use at your own risk.

Lazily get left field.

Lazily get right field.

Class for easily defining custom translations for a type by using LUTs. To use this class, a type must derive Waveform via WaveformForLut.

Bye default, the implementation uses Generic for defining subsignals and operator precedence, and Show for displaying the value.

Return the static LUT of a type with WaveformLUT

Turn a list of (value,translation) pairs into a LUT

Translate a value from a type with a static LUT

Make sure a Translation is fully defined. If not, return a Translation with "undefined".

Given a function that renders a value, and a function that (given this Render) prodices the subsignals, create a translation. If rendering fails, "undefined" is displayed. If creating the subsignals fails, no subsignals are shown.

Display a value with Show, the default wave style, and operator precedence determined using Generic.

Display a value with the provided functions for creating the text value, style and operator precedence.

Display an atomic value (such as a number) using the provided function to obtain the value. (normal wavestyle, precedence 11).

Display an atomic value (like a number) with Show. See translateAtomWith.

Render an atomic value representing a signed number. If the render value is found to start with -, the precedence is set to 0.

Render an atomic value representing a signed number using show. See translateAtomSigWith.

Create subsignals for the constructors and fields. Constructor translations are a copy of the toplevel render value provided.

Create no subsignals for this type.

Get the operator precedence of a value.

Type for deriving Waveform for types implementing WaveformLUT.

type T = ... deriving (...)
deriving via WaveformForLut T instance Waveform T

isntance WaveformLUT T where
  ...

Helper class for determining the precedence and number of fields of a value's constructor.

Class for obtaining the runtime precedence of a typelevel fixity value.

Helper class for defining a constant translation value. To use this, derive Waveform via WaveformForConst.

Helper class for deriving Waveform for types implementing WaveformConst.

Helper class for deriving Waveform for numerical types. Options are provided at the type level (signed, format).

Example: deriving via WaveformForNumber NFSig ('Just '(3,"_")) instance Waveform (Signed 3)

Pair of a Nat and Symbol, used for type-level spacer values.

Default spacer for decimal values (_ every 3 digits)

Default spacer for hexadecimal values (_ every 2 digits)

Default spacer for octal values (_ every 4 digits)

Default spacer for binary values (_ every 8 digits)

Add _ every n digits.

Do not add spacers.

Class for turning a type level NumberFormat into a runtime value.

Type to get the runtime value of a type-level number spacer.

Helper family for implementing Waveform for RTree.

Helper class for implementing Waveform for RTree.

A translator for displaying values with zero or more fields like tuples. This function will error if called for a type that has more than one constructor!