package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

hardcaml_waveterm
- Hardcaml_waveterm
  - Expert
    
    M
    
    Data
    
    S
    
    Expect
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Serialize
    
    Wave
    
    Waveform
    
    Waves
    
    Config
    
    Make
    
    Data
    
    Expect
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Serialize
    
    Wave
    
    Waveform
    
    Waves
    
    Config
  - For_cyclesim
    
    Expect
    
    Serialize
    
    Waveform
hardcaml_waveterm.cyclesim
- Hardcaml_waveterm_cyclesim
  - Expert
  - Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
  - Wave
  - Waveform
  - Waves
    
    Config
hardcaml_waveterm.event_store
- Hardcaml_waveterm_event_store
  - Bits_store
    
    Data
    
    Event_store
    
    Time
  - Event_store
    
    Make
    
    Data
    
    Time
  - Event_store_intf
    
    Data
    
    Event_store
    
    Make
    
    Data
    
    Time
    
    M
    
    Data
    
    S
    
    Time
    
    Time
hardcaml_waveterm.interactive
- Hardcaml_waveterm_interactive
  - Draw_notty
  - Scroll
    
    Adjustment
    
    HScrollbar
    
    Mouse_mode
    
    Orientation
    
    Scroll_bar_mode
    
    Scroll_bar_style
    
    Scrollable
    
    Scrollbar
    
    VScrollbar
  - Widget
    
    Make
    
    Data
    
    M
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waveform
    
    Waves
    
    Config
hardcaml_waveterm.kernel
- Hardcaml_waveterm_kernel
  - Display_rule
    
    States
  - Display_rules
    
    With_interface
    
    I
    
    All
    
    Comb
    
    Make_comb
    
    Comb
    
    Signed
    
    Sop
    
    Typed_math
    
    Unsigned
    
    Uop
    
    Names_and_widths
    
    Of_always
    
    Of_bits
    
    Of_signal
    
    Unsafe_assoc_by_port_name
  - Expert
    
    Data
    
    S
    
    Draw
    
    In_memory
    
    Make
    
    B
    
    Primitives
    
    S
    
    Style
    
    M
    
    Data
    
    S
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waveform
    
    Waves
    
    Config
    
    Make
    
    Data
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waveform
    
    Waves
    
    Config
    
    Render
    
    M
    
    Data
    
    S
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waves
    
    Config
    
    Make
    
    Bounds
    
    Data
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waves
    
    Config
    
    S
    
    Bounds
    
    Data
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waves
    
    Config
    
    Wave
    
    M
    
    Data
    
    S
    
    Make
    
    Data
    
    S
    
    Data
    
    Waveform
    
    M
    
    Data
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    S
    
    Wave
    
    Waves
    
    Config
    
    Make
    
    Data
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waves
    
    Config
    
    S
    
    Data
    
    Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
    
    Wave
    
    Waves
    
    Config
    
    Waves
    
    M
    
    Data
    
    S
    
    Config
    
    Wave
    
    Make
    
    Config
    
    Data
    
    Wave
    
    S
    
    Config
    
    Data
    
    Wave
    
    Write
  - Port
    
    Type
  - Port_name
  - Text_alignment

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Data : Hardcaml_waveterm_kernel.Expert.Data.S

module M : Hardcaml_waveterm_kernel.Expert.M(Data).S

Signature

val run_waves : 
  ?ui_state_file:Base.string ->
  M.Waves.t ->
  Base.unit Async.Deferred.t

val run_and_return : ?ui_state_file:Base.string -> M.Waves.t -> Base.unit

Run the waveform viewer and return. Calls into Async/LWT so MUST NOT BE CALLED from within an Async or LWT deferred.

val run_and_close : ?ui_state_file:Base.string -> M.Waves.t -> Base.unit

Run the waveform viewer and close the program on exit.

val run : 
  ?ui_state_file:Base.string ->
  ?signals_width:Base.int ->
  ?values_width:Base.int ->
  ?start_cycle:Base.int ->
  ?wave_width:Base.int ->
  ?display_rules:Hardcaml_waveterm_kernel.Display_rules.t ->
  M.Waveform.t ->
  Base.unit

Run interactive waveterm viewer. ESC to quit.