package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

A terminal based digital waveform viewer for Hardcaml

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

hardcaml_waveterm-v0.16.0.tar.gz

sha256=20844546139ee69e8d328b75a54369b2c1db91d88e43f7ca9ccfc0cd855be828

doc/hardcaml_waveterm.kernel/Hardcaml_waveterm_kernel/Display_rules/index.html

Module `Hardcaml_waveterm_kernel.Display_rules`Source

A Display_rules.t is an ordered list of rules that specifies the order of ports and the formatting of signals in a waveform.

A port is displayed according to the first rule that it matches, using that rule's wave format. Ports matching rules earlier in the list are displayed above ports matching rules later in the list.

Sourcetype t = Display_rule.t Base.list

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Source

val run_rule : 
  Display_rule.t ->
  Hardcaml_waveterm_kernel__.Port.t ->
  (Wave_format.t * Text_alignment.t) Base.option

Source

val sort_ports_and_formats : 
  t ->
  Hardcaml_waveterm_kernel__.Port.t Base.list ->
  (Hardcaml_waveterm_kernel__.Port.t
   * (Wave_format.t * Text_alignment.t) Base.option)
    Base.list

Construct the port order and formatting from the display rules and ports (derived from a testbench simulation object). Unmatched ports are not shown, unless Rule.default (or a similar custom rule) is included as the last display rule.

Sourceval is_displayed : t -> Hardcaml_waveterm_kernel__.Port.t -> Base.bool

Check if a given port is displayed by any of the rules.

Sourceval is_signal_displayed : t -> Hardcaml.Signal.t -> Base.bool

Check if a given signal (treated as an internal port) is displayed by any of the rules.

Sourcemodule With_interface (I : Hardcaml.Interface.S) : sig ... end

Create rules for each signal in the interface.