package hardcaml_waveterm

You can search for identifiers within the package.

in-package search v0.2.0

hardcaml_waveterm
- Hardcaml_waveterm
  - Data
  - Display_rules
    
    Rule
  - Draw
    
    In_memory
    
    Make
    
    B
    
    Primitives
    
    S
    
    Style
  - Port
    
    Type
  - Port_name
  - Render
    
    Bounds
    
    Make
    
    G
    
    Static
    
    R
    
    Styles
  - Sim
  - Wave
  - Wave_format
  - Waveform
  - Waves
    
    Config
  - Write
hardcaml_waveterm.interactive
- Hardcaml_waveterm_interactive
  - Draw_notty
  - Scroll
    
    Adjustment
    
    HScrollbar
    
    Mouse_mode
    
    Orientation
    
    Scroll_bar_mode
    
    Scroll_bar_style
    
    Scrollable
    
    Scrollbar
    
    VScrollbar
  - Widget

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

val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t

val default : t

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

val port_name_matches : Re.re -> wave_format:Wave_format.t -> t

Use given format for ports whose name match the regular expression re.

val port_name_is : 
  ?alignment:Wave_format.alignment ->
  Hardcaml_waveterm__.Import.String.t ->
  wave_format:Wave_format.t ->
  t

Use format for ports with given name.

val port_name_is_one_of : 
  ?alignment:Wave_format.alignment ->
  wave_format:Wave_format.t ->
  Hardcaml_waveterm__.Import.String.t Hardcaml_waveterm__.Import.List.t ->
  t

Match any one of a list of names.

val custom : 
  f:(Port.t -> Wave_format.t Hardcaml_waveterm__.Import.Option.t) ->
  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 ->
      (Wave_format.t * Wave_format.alignment)
        Hardcaml_waveterm__.Import.Option.t) ->
  t

Similar tp f, but allows the user to specify the alignment of the wave.