package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

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
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    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

val expect : 
  (?show_digest:Base.bool ->
    ?serialize_to:Base.string ->
    Waveform.t ->
    Base.unit)
    Waveform.with_options

Print waveforms in expect tests. This is very similar to print except it always outputs to stdout and will optionally serialize the waveform to disk for offline viewing.

Waveforms are serialized if:

environment variable EXPECT_TEST_WAVEFORM=1 and the serialize_to filename is set.
EXPECT_TEST_WAVEFORM=digest then the waveform file will be named by the digest of the waveform (serialize_to is not used regardless of if it is set or not).

Simulation digests are shown by default.