Module Lib

Lib: record of operations, backtrack, low-level sections

This module provides a general mechanism to keep a trace of all operations and to backtrack (undo) those operations. It provides also the section mechanism (at a low level; discharge is not known at this step).

type is_type = bool
type export_flag =
| Export
| Import
type export = (export_flag * Libobject.open_filter) option
val make_foname : Names.Id.t -> Libobject.object_name
type 'summary node =
| CompilingLibrary of Libobject.object_prefix
| OpenedModule of is_type * export * Libobject.object_prefix * 'summary
| OpenedSection of Libobject.object_prefix * 'summary
val node_prefix : 'summary node -> Libobject.object_prefix

Extract the object_prefix component. Note that it is the prefix of the objects *inside* this node, eg in Module M. we have OpenedModule with prefix containing M.

type 'summary library_segment = ('summary node * Libobject.t list) list
...

Adding operations (which call the cache method, and getting the current list of operations (most recent ones coming first).

val add_leaf : Libobject.obj -> unit
val add_discharged_leaf : Libobject.discharged_obj -> unit
...

The function contents gives access to the current entire segment

val contents : unit -> Summary.Interp.frozen library_segment
Functions relative to current path
val prefix : unit -> Libobject.object_prefix

User-side names

cwd() is (prefix()).obj_dir current_mp() is (prefix()).obj_mp

Inside a library A.B module M section S, we have

  • library_dp = A.B
  • cwd = A.B.M.S
  • cwd_except_section = A.B.M
  • current_dirpath true = M.S
  • current_dirpath false = M
  • current_mp = MPdot(MPfile A.B, M)

make_path (resp make_path_except_section) uses cwd (resp cwd_except_section) make_kn uses current_mp

val cwd : unit -> Libnames.full_path
val cwd_except_section : unit -> Libnames.full_path
val current_dirpath : bool -> Names.DirPath.t
val make_path : Names.Id.t -> Libnames.full_path
val make_path_except_section : Names.Id.t -> Libnames.full_path
val current_mp : unit -> Names.ModPath.t

Kernel-side names

val make_kn : Names.Id.t -> Names.KerName.t
val sections_are_opened : unit -> bool

Are we inside an opened section

val sections_depth : unit -> int
val is_module_or_modtype : unit -> bool

Are we inside an opened module type

val is_modtype : unit -> bool
val is_modtype_strict : unit -> bool
val is_module : unit -> bool
type discharged_item =
| DischargedExport of Libobject.ExportObj.t
| DischargedLeaf of Libobject.discharged_obj
type classified_objects = {
substobjs : Libobject.t list;
keepobjs : Libobject.keep_objects;
escapeobjs : Libobject.escape_objects;
anticipateobjs : Libobject.t list;
}
module type StagedLibS = sig ... end

The StagedLibS abstraction describes operations and traversal for Lib at a given stage.

We provide two instances of StagedLibS, corresponding to the Synterp and Interp stages.

Compilation units
val start_compilation : Names.DirPath.t -> Names.ModPath.t -> unit
type compilation_result = {
info : Library_info.t;
synterp_objects : classified_objects;
interp_objects : classified_objects;
}
val end_compilation : Names.DirPath.t -> compilation_result

Finalize the compilation of a library.

val library_dp : unit -> Names.DirPath.t

The function library_dp returns the DirPath.t of the current compiling library (or default_library)

val split_modpath : Names.ModPath.t -> Names.DirPath.t * Names.Id.t list

Extract the library part of a name even if in a section

val library_part : Names.GlobRef.t -> Names.DirPath.t

Compatibility layer

val init : unit -> unit

This also does init_summaries