package ocaml-compiler

  1. Overview
  2. Docs
Official release of OCaml 5.5.0

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (17)

Authors

  1. Xavier Leroy
  2. Damien Doligez
  3. Alain Frisch
  4. Jacques Garrigue
  5. Didier Rémy
  6. K
    KC Sivaramakrishnan
  7. J
    Jérôme Vouillon

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

ocaml-5.5.0.tar.gz
sha256=c018052c8264a3791a8f54f84179e6bcc78ed82eb889bacc2773df445259aed3

doc/compiler-libs.common/Compile_common/index.html

Module Compile_common

Common compilation pipeline between bytecode and native.

Initialization

type info = {
  1. target : Unit_info.t;
  2. env : Env.t;
  3. ppf_dump : Format.formatter;
  4. tool_name : string;
  5. native : bool;
}

Information needed to compile a file.

val with_info : native:bool -> tool_name:string -> dump_ext:string -> Unit_info.t -> (info -> 'a) -> 'a

with_info ~native ~tool_name ~dump_ext unit_info k invokes its continuation k with an info structure passed as input, after initializing various global variables. This info structure and the initialized global state are not valid anymore after the continuation returns.

Due to current implementation limitations in the compiler, it is unsafe to try to compile several distinct compilation units by calling with_info several times.

Interfaces

val parse_intf : info -> Parsetree.signature

parse_intf info parses an interface (usually an .mli file).

typecheck_intf info parsetree typechecks an interface and returns the typedtree of the associated signature, together with the alerts appearing at the top of the signature (before any other non-attribute item).

val emit_signature : info -> Misc.alerts -> Typedtree.signature -> unit

emit_signature info alerts typedtree emits the .cmi file containing the given signature and compilation unit alerts (as returned eg by typecheck_intf above).

val interface : info -> unit

The complete compilation pipeline for interfaces.

Implementations

val parse_impl : info -> Parsetree.structure

parse_impl info parses an implementation (usually an .ml file).

typecheck_impl info parsetree typechecks an implementation and returns the typedtree of the associated module, its public interface, and a coercion against that public interface.

val implementation : info -> backend:(info -> Typedtree.implementation -> unit) -> unit

The complete compilation pipeline for implementations.