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

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

type t =

| Default
| Regexp of {
1. re : Re.re;
2. wave_format : Hardcaml.Wave_format.t Base.option;
3. alignment : Text_alignment.t;
}
| Names of {
1. names : Port_name.t Base.list;
2. wave_format : Hardcaml.Wave_format.t Base.option;
3. alignment : Text_alignment.t;
}
| Custom of Port.t -> Hardcaml.Wave_format.t Base.option
| Custom_with_alignment of Port.t -> (Hardcaml.Wave_format.t * Text_alignment.t) Base.option

val sexp_of_t : t -> Sexplib0.Sexp.t

val default : t

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

val 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.

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

Use format for ports with given name.

val 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.

val custom : f:(Port.t -> Hardcaml.Wave_format.t Base.option) -> t

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

val 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.

module type States = sig ... end

val 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.