jon.recoil.org

Module Alloc_mode.For_applications

type t = private
  1. | Heap
    (*

    Normal allocation on the OCaml heap.

    *)
  2. | Local of {
    1. region : Flambda2_identifiers.Variable.t;
    2. ghost_region : Flambda2_identifiers.Variable.t;
    }
    (*

    Allocation on the local allocation stack in the given region.

    *)

Decisions on allocation locations for application expressions.

val compare : t -> t -> int
val heap : t

Returns Heap if stack allocation is disabled!

val as_type : t -> For_types.t
val from_lambda : Lambda.locality_mode -> current_region:Flambda2_identifiers.Variable.t option -> current_ghost_region:Flambda2_identifiers.Variable.t option -> t
include Flambda2_nominal.Contains_names.S with type t := t
include Flambda2_nominal.Contains_ids.S with type t := t
include Flambda2_nominal.Bindable.S with type t := t
include Flambda2_nominal.Contains_names.S with type t := t

Compute the free names of a term. Such computation covers all kinds of bindable names (variables, continuations, ...)

val apply_renaming : t -> Flambda2_nominal.Renaming.t -> t

Apply a renaming throughout a term.

include Flambda2_nominal.Contains_ids.S with type t := t
val ids_for_export : t -> Flambda2_nominal.Ids_for_export.t

Gather all table identifiers to export them.

val print : Format.formatter -> t -> unit
val rename : t -> t

Freshen the given name.

val is_renamed_version_of : t -> t -> bool

Equivalence relation on renamed variables.

is_renamed_version_of x y is true if there exists a bindable z such that x and y are renamed versions of z.

Note: this function can return true in other cases (if there are some name collisions for instance), this is (at least currently) only used for a sanity check, so users should not rely too much on its expected semantics.

val renaming : t -> guaranteed_fresh:t -> Flambda2_nominal.Renaming.t

renaming stale ~guaranteed_fresh:fresh is to create a renaming that turns all occurrences of the name stale into fresh (in a capture-avoiding manner, but that is inherent in Renaming).