package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

hardcaml_waveterm
- CHANGES
- LICENSE
- README
- Library hardcaml_waveterm
  - Hardcaml_waveterm
    
    Data
    
    Display_rules
    
    Rule
    
    Draw
    
    Style
    
    Primitives
    
    S
    
    Make
    
    In_memory
    
    Port
    
    Type
    
    Port_name
    
    Render
    
    Styles
    
    Bounds
    
    Make
    
    Static
    
    R
    
    Sim
    
    Wave
    
    Wave_format
    
    Waveform
    
    Waves
    
    Config
    
    Write
- Library hardcaml_waveterm.interactive
  - Hardcaml_waveterm_interactive
    
    Draw_notty
    
    Scroll
    
    Adjustment
    
    Scroll_bar_mode
    
    Mouse_mode
    
    Scroll_bar_style
    
    Orientation
    
    Scrollable
    
    Scrollbar
    
    HScrollbar
    
    VScrollbar
    
    Widget
- Sources
  - hardcaml_waveterm
    
    data.ml
    
    display_rules.ml
    
    draw.ml
    
    hardcaml_waveterm.ml
    
    hardcaml_waveterm__.ml
    
    import.ml
    
    port.ml
    
    port_name.ml
    
    render.ml
    
    sim.ml
    
    wave.ml
    
    wave_format.ml
    
    waveform.ml
    
    waves.ml
    
    write.ml
  - hardcaml_waveterm.interactive
    
    draw_notty.ml
    
    hardcaml_waveterm_interactive.ml
    
    hardcaml_waveterm_interactive__.ml
    
    import.ml
    
    scroll.ml
    
    widget.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Hardcaml_waveterm.Display_rules`Source

A Display_rules.t is an ordered list of rules that specifies the order of ports and the formatting of signals in a waveform.

A port is displayed according to the first rule that it matches, using that rule's wave format. Ports matching rules earlier in the list are displayed above ports matching rules later in the list.

Sourcemodule Rule : sig ... end

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

Sourcetype t

Sourceval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t

Sourceval empty : t

Sourceval add_above : t -> Rule.t -> t

add_above t rule returns rules where ports matching rule appear above ports matching the rules in t.

Sourceval add_below : t -> Rule.t -> t

add_below t rule returns rules where ports matching rule appear below ports matching the rules in t.

Sourceval of_list : Rule.t Base.List.t -> t

Sourceval combine : above:t -> below:t -> t

combine ~above ~below returns rules where ports matching the rules in above appear above ports matching the rules in below.

Source

val sort_ports_and_formats : 
  t ->
  Port.t Base.List.t ->
  (Port.t * Wave_format.t * Wave_format.alignment) Base.List.t

Construct the port order and formatting from the display rules and ports (derived from a testbench simulation object). Unmatched ports are not shown, unless Rule.default (or a similar custom rule) is included as the last display rule.

Sourceval is_displayed : t -> Port.t -> Base.Bool.t

Check if a given port is displayed by any of the rules.

Sourceval is_signal_displayed : t -> Hardcaml.Signal.t -> Base.Bool.t

Check if a given signal (treated as an internal port) is displayed by any of the rules.

package hardcaml_waveterm

Module Hardcaml_waveterm.Display_rulesSource

Module `Hardcaml_waveterm.Display_rules`Source