hardcaml_waveterm v0.12.0 · OCaml Package

Parameters

module G : Draw.S

Signature

val get_wave_width : (Import.int * Wave.t) -> Import.int * Import.int

get width code and actual width in chars

val get_wave_height : (Import.int * Wave.t) -> Import.int * Import.int

get height code and actual height in chars

val get_max_signal_width : Waves.t -> Import.int

max width of name window

val get_max_value_width : Waves.t -> Import.int

max width of values window. Needs to evaluate the entire waveform.

val get_estimated_max_value_width : Waves.t -> Import.int

gets an estimate fo the max with of values. Inaccruate for the constructors U, S and F.

val get_max_cycles : Waves.t -> Import.int

max no of wave cycles

val get_max_signals : Waves.t -> Import.int

max no of wave cycles

val get_max_wave_width : Waves.t -> Import.int

max width of wave window

val get_max_wave_height : Waves.t -> Import.int -> Import.int

max height of wave window

val draw_clock_cycle : 
  ctx:G.ctx ->
  style:G.style ->
  bounds:Draw.rect ->
  w:Import.int ->
  h:Import.int ->
  c:Import.int ->
  Import.unit

draws one clock cycle

val draw_clock_cycles : 
  ctx:G.ctx ->
  style:G.style ->
  bounds:Draw.rect ->
  w:Import.int ->
  waw:Import.int ->
  h:Import.int ->
  cnt:Import.int ->
  Import.unit

draws cnt clock cycles

val draw_binary_data : 
  ctx:G.ctx ->
  style:G.style ->
  bounds:Draw.rect ->
  w:Import.int ->
  h:Import.int ->
  data:Data.t ->
  off:Import.int ->
  Import.unit

draw binary waveform data

val draw_data : 
  ctx:G.ctx ->
  style:G.style ->
  bounds:Draw.rect ->
  to_str:(Import.Bits.t -> Import.string) ->
  w:Import.int ->
  h:Import.int ->
  data:Data.t ->
  off:Import.int ->
  Import.unit

draw arbitrary waveform data

type 'a draw_item =
  ?style:Draw.Style.t ->
  ctx:G.ctx ->
  bounds:Draw.rect ->
  Waves.t ->
  'a

val with_border : 
  draw:'a draw_item ->
  label:Import.string ->
  ?border:Draw.Style.t ->
  'a draw_item

val draw_cursor : ctx:G.ctx -> bounds:Draw.rect -> state:Waves.t -> Import.unit

draw cursor

val draw_wave : Import.unit draw_item

draw waveforms

val draw_signals : Import.unit draw_item

draw signal names

val draw_values : Import.int draw_item

draw signal values

val draw_status : Import.unit draw_item

val draw_ui : 
  ?style:Styles.t ->
  ?bounds:Bounds.t ->
  ctx:G.ctx ->
  Waves.t ->
  Import.unit

draw standard user inferface (names, values, waveforms left to right

type pick =

| Wave of Import.int * Import.int
| Value of Import.int
| Signal of Import.int
| Status
| No_pick

val pick : bounds:Bounds.t -> r:Import.int -> c:Import.int -> Waves.t -> pick