Module Hardcaml.ScopeSource

Scopes control the process of hierarchical circuit generation.

They track a circuit database of instantiated modules, and a scheme for managing the naming of signals within the design.

Sourcemodule Path : sig ... end
Sourcemodule Naming_scheme : sig ... end

Control of name generation in a hierarchy of modules. The position of a module within a hierarchy is determined by a path which leads back to the (single) top most parent module. Signal names may be pre-pended with some represtation of that path.

Sourcetype t
Sourceval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
Sourceval create : ?flatten_design:Base.Bool.t -> ?naming_scheme:Naming_scheme.t -> ?name:Base.String.t -> Base.Unit.t -> t

create ?flatten_design ?naming_scheme ?name () creates a new scope. If flatten_design is true, then all module instantions are inlined. Names for wires are determiend by naming_scheme.

Sourceval sub_scope : t -> Base.String.t -> t

sub_scope t label returns a new scope with label appended to its hierarchical path

Sourceval path : t -> Path.t

path t returns the Path.t associated with t. This will determine the prefix used when naming modules that are associated with this scope.

Sourceval circuit_database : t -> Circuit_database.t

circuit_database t returns the circuit database associated with t. Note that circuit databases are shared among sub_scopes.

Sourceval flatten_design : t -> Base.Bool.t

flatten_design t returns true when HardCaml will inline all module instantiations.

Sourceval naming_scheme : t -> Naming_scheme.t

naming_scheme t returns the Naming.t that t was constructed with.

name ?sep t signal string creates a heirarchical name based on the path of t and string. sep, when provided, determines the separator for path components in the heirarchical name (default is $).

Sourceval naming : ?sep:Base.String.t -> t -> Signal.t -> Base.String.t -> Signal.t

Creates a hierarchical name, built with name, and applies it to the signal.

This is typically used as a partial application to construct a new signal naming operator, .e.g:

  let (--) = naming scope in
  (* ... other code ... *)
  let named_signal = some_signal -- "data" in
  (* ... more code ... *)