Make (hardcaml_waveterm.hardcaml_waveterm.kernel.Hardcaml_waveterm

Parameters

module Data : sig ... end

module Wave : sig ... end

module Waves : sig ... end

module Render : sig ... end

Signature

type t

val sexp_of_t : t -> Sexplib0.Sexp.t

include Ppx_compare_lib.Equal.S with type t := t

val equal : t -> t -> bool

include Ppx_compare_lib.Equal.S__local with type t := t

val create_from_data : waves:Wave.t Base.list -> ports:Port.t Base.list -> t

val waves : t -> Wave.t Base.array

val update_waves : t -> Wave.t Base.array -> t

val combine : t -> t -> t

Combine two waveforms into one waveform

type 'a with_options =
  ?display_rules:Display_rules.t ->
  ?display_width:Base.int ->
  ?display_height:Base.int ->
  ?display_values:Base.bool ->
  ?wave_width:Base.int ->
  ?signals_width:Base.int ->
  ?start_cycle:Base.int ->
  ?signals_alignment:Text_alignment.t ->
  'a

Waveform configuration options.

display_rules see Display_rules. A waveform may be constructed once and displayed multiple times with differing options.

wave_width sets the number of chars used to render each clock cycle.

n>=0 ((n+1)*2) characters per cycle. This ensures that the clock is properly rendered when n=0. The default of 3 allows up to 7 chars per cycle to be rendered to represent data values in the waveform.

n<0 (-n) cycles per character. Characters in the waveform within which multiple transitions occur are displayed with a double veritical bar.

display_width and display_height set the overall size of the displayed waveform. An auto scaling routine assigns approximately 1/3 of the display for the signals and values windows. The default size is 70 characters wide with the height automatically inferred (upto a max of 256). The minimum size is 7 characters wide and 3 high and an exception is raised otherwise.

signals_alignment changes the text alignment of the displayed signals names. By default this is Wave_format.Left.

val sort_ports_and_formats : 
  t ->
  Display_rules.t Base.option ->
  Wave.t Base.array

val to_buffer : (t -> Base.Buffer.t) with_options

Write waveform into a Buffer.t.

val to_string : (t -> Base.string) with_options

Convert waveform to a string.

val print : (?channel:Stdio.Out_channel.t -> t -> Base.unit) with_options

Print waveform to channel

val look_for_nth_instance_of_condition_in_waveform : 
  n:Base.int ->
  conditions:Wave_condition.t Base.list ->
  t ->
  Base.int Base.option

General function to look up the nth cycle where the set of conditions given are met.