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.cyclesim/Hardcaml_waveterm_cyclesim/Render/Make/index.html

Module Render.MakeSource

Parameters

module G : sig ... end

Signature

Sourceval get_wave_width : (Base.int * Wave.t) -> Base.int * Base.int

get width code and actual width in chars

Sourceval get_wave_height : (Base.int * Wave.t) -> Base.int * Base.int

get height code and actual height in chars

Sourceval get_max_signal_width : Waves.t -> Base.int

max width of name window

Sourceval get_max_value_width : Waves.t -> Base.int

max width of values window. Needs to evaluate the entire waveform.

Sourceval get_estimated_max_value_width : Waves.t -> Base.int

gets an estimate fo the max with of values. Inaccruate for the constructors U, S and F.

Sourceval get_max_cycles : Waves.t -> Base.int

max no of wave cycles

Sourceval get_max_signals : Waves.t -> Base.int

max no of wave cycles

Sourceval get_max_wave_width : Waves.t -> Base.int

max width of wave window

Sourceval get_max_wave_height : Waves.t -> Base.int -> Base.int

max height of wave window

Sourceval draw_clock_cycle : ctx:G.ctx -> style:G.style -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> h:Base.int -> c:Base.int -> Base.unit

draws one clock cycle

Sourceval draw_clock_cycles : ctx:G.ctx -> style:G.style -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> waw:Base.int -> h:Base.int -> cnt:Base.int -> Base.unit

draws cnt clock cycles

Sourceval draw_binary_data : ctx:G.ctx -> style:G.style -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> w:Base.int -> h:Base.int -> data:Data.t -> off:Base.int -> Base.unit

draw binary waveform data

Sourceval draw_data : ctx:G.ctx -> style:G.style -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> to_str:(Hardcaml.Bits.t -> Base.string) -> alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> w:Base.int -> h:Base.int -> data:Data.t -> off:Base.int -> Base.unit

draw arbitrary waveform data

Sourcetype 'a draw_item = ?style:Hardcaml_waveterm_kernel__.Draw.Style.t -> ctx:G.ctx -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> Waves.t -> 'a
Sourceval with_border : draw:'a draw_item -> label:Base.string -> ?border:Hardcaml_waveterm_kernel__.Draw.Style.t -> 'a draw_item
Sourceval draw_cursor : ctx:G.ctx -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> state:Waves.t -> Base.unit

draw cursor

Sourceval draw_wave : Base.unit draw_item

draw waveforms

Sourceval draw_signals : ?alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> ?style:Hardcaml_waveterm_kernel__.Draw.Style.t -> selected_wave_index:Base.int Base.option -> ctx:G.ctx -> bounds:Hardcaml_waveterm_kernel__.Draw.rect -> Waves.t -> Base.unit

draw signal names

Sourceval draw_values : Base.int draw_item

draw signal values

Sourceval draw_status : Base.unit draw_item
Sourceval draw_ui : ?signals_alignment:Hardcaml_waveterm_kernel.Text_alignment.t -> ?style:Styles.t -> ?bounds:Bounds.t -> ctx:G.ctx -> Waves.t -> Base.unit

draw standard user inferface (names, values, waveforms left to right

Sourcetype pick =
  1. | Wave of Base.int * Base.int
  2. | Value of Base.int
  3. | Signal of Base.int
  4. | Status
  5. | No_pick
Sourceval pick : bounds:Bounds.t -> r:Base.int -> c:Base.int -> Waves.t -> pick