package hardcaml_waveterm

  1. Overview
  2. Docs
A terminal based digital waveform viewer for Hardcaml

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=a6780e4310f46cd71ff8a3cdf12bb51afdf0eaea5e84645a148a4ecd0f02920b

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

Module Hardcaml_waveterm_kernel.Display_ruleSource

A Rule.t is a predicate on Port.ts that specifies the display format of matching ports.

Sourcetype t =
  1. | Default
  2. | Regexp of {
    1. re : Re.re;
    2. wave_format : Hardcaml.Wave_format.t Base.option;
    3. alignment : Text_alignment.t;
    }
  3. | Names of {
    1. names : Port_name.t Base.list;
    2. wave_format : Hardcaml.Wave_format.t Base.option;
    3. alignment : Text_alignment.t;
    }
  4. | Custom of Port.t -> Hardcaml.Wave_format.t Base.option
  5. | Custom_with_alignment of Port.t -> (Hardcaml.Wave_format.t * Text_alignment.t) Base.option
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval default : t

Default formatting - binary for 1 bit signals, hex otherwise.

Sourceval port_name_matches : ?alignment:Text_alignment.t -> ?wave_format:Hardcaml.Wave_format.t -> Re.re -> t

Use given format for ports whose name match the regular expression re.

Sourceval port_name_is : ?alignment:Text_alignment.t -> ?wave_format:Hardcaml.Wave_format.t -> Base.string -> t

Use format for ports with given name.

Sourceval port_name_is_one_of : ?alignment:Text_alignment.t -> ?wave_format:Hardcaml.Wave_format.t -> Base.string Base.list -> t

Match any one of a list of names.

In custom f, f returns None to signify no match, or Some format to specify a display format.

Sourceval custom_with_alignment : f:(Port.t -> (Hardcaml.Wave_format.t * Text_alignment.t) Base.option) -> t

Similar tp f, but allows the user to specify the alignment of the wave.

Sourcemodule type States = sig ... end
Sourceval states : ?onehot:Base.bool -> ?alignment:Text_alignment.t -> (module States) -> Base.string -> t

For use with statemachines. Derives state names from the variant describing the states of the state machine.