package coq

  1. Overview
  2. Docs
package coq
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module MltopSource

Toplevel management
Sourcetype toplevel = {
  1. load_obj : string -> unit;
  2. add_dir : string -> unit;
  3. ml_loop : unit -> unit;
}

If there is a toplevel under Coq, it is described by the following record.

Sourceval set_top : toplevel -> unit

Sets and initializes a toplevel (if any)

Sourceval remove : unit -> unit

Removes the toplevel (if any)

Sourceval is_ocaml_top : unit -> bool

Tests if an Ocaml toplevel runs under Coq

Sourceval ocaml_toploop : unit -> unit

Starts the Ocaml toplevel loop

Sourceval add_ml_dir : string -> unit

Adds a dir to the plugin search path

Tests if we can load ML files

Sourceval add_known_module : string -> unit

List of modules linked to the toplevel

Sourceval module_is_known : string -> bool
Initialization functions
Sourceval add_known_plugin : (unit -> unit) -> string -> unit

Declare a plugin and its initialization function. A plugin is just an ML module with an initialization function. Adding a known plugin implies adding it as a known ML module. The initialization function is granted to be called after Coq is fully bootstrapped, even if the plugin is statically linked with the toplevel

Sourceval init_known_plugins : unit -> unit

Calls all initialization functions in a non-specified order

Sourceval declare_cache_obj : (unit -> unit) -> string -> unit

Register a callback that will be called when the module is declared with the Declare ML Module command. This is useful to define Coq objects at that time only. Several functions can be defined for one module; they will be called in the order of declaration, and after the ML module has been properly initialized.

Declaring modules
Sourceval declare_ml_modules : Vernacexpr.locality_flag -> string list -> unit
Utilities
Sourceval print_ml_path : unit -> Pp.t
Sourceval print_ml_modules : unit -> Pp.t
Sourceval print_gc : unit -> Pp.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct