Module `Lib`Source

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).

Sourcetype is_type = bool

Sourcetype export_flag =

| Export
| Import

Sourcetype export = (export_flag * Libobject.open_filter) option

Sourceval make_oname : Nametab.object_prefix -> Names.Id.t -> Libobject.object_name

Sourceval make_foname : Names.Id.t -> Libobject.object_name

Sourceval oname_prefix : Libobject.object_name -> Nametab.object_prefix

Sourcetype node =

| CompilingLibrary of Nametab.object_prefix
| OpenedModule of is_type * export * Nametab.object_prefix * Summary.frozen
| OpenedSection of Nametab.object_prefix * Summary.frozen

Sourceval node_prefix : node -> Nametab.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.

Sourcetype library_segment = (node * Libobject.t list) list

Sourcetype classified_objects = {

substobjs : Libobject.t list;
keepobjs : Libobject.t list;
anticipateobjs : Libobject.t list;

}

...

Low-level adding operations (does not cache)

Sourceval add_entry : node -> unit

Sourceval add_leaf_entry : Libobject.t -> unit

...

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

Sourceval add_leaf : Libobject.obj -> unit

...

The function contents gives access to the current entire segment

Sourceval contents : unit -> library_segment

Functions relative to current path

Sourceval prefix : unit -> Nametab.object_prefix

User-side names

Sourceval cwd : unit -> Names.DirPath.t

Sourceval cwd_except_section : unit -> Names.DirPath.t

Sourceval current_dirpath : bool -> Names.DirPath.t

Sourceval make_path : Names.Id.t -> Libnames.full_path

Sourceval make_path_except_section : Names.Id.t -> Libnames.full_path

Sourceval current_mp : unit -> Names.ModPath.t

Kernel-side names

Sourceval make_kn : Names.Id.t -> Names.KerName.t

Sourceval sections_are_opened : unit -> bool

Are we inside an opened section

deprecated Use Global.sections_are_opened

Sourceval sections_depth : unit -> int

Sourceval is_module_or_modtype : unit -> bool

Are we inside an opened module type

Sourceval is_modtype : unit -> bool

Sourceval is_modtype_strict : unit -> bool

Sourceval is_module : unit -> bool

Sourceval find_opening_node : Names.Id.t -> node

Returns the opening node of a given name

Modules and module types

Source

val start_module : 
  export ->
  Names.module_ident ->
  Names.ModPath.t ->
  Summary.frozen ->
  Nametab.object_prefix

Source

val start_modtype : 
  Names.module_ident ->
  Names.ModPath.t ->
  Summary.frozen ->
  Nametab.object_prefix

Source

val end_module : 
  unit ->
  Nametab.object_prefix * Summary.frozen * classified_objects

Source

val end_modtype : 
  unit ->
  Nametab.object_prefix * Summary.frozen * classified_objects

Compilation units

Sourceval start_compilation : Names.DirPath.t -> Names.ModPath.t -> unit

Source

val end_compilation : 
  Names.DirPath.t ->
  Nametab.object_prefix * classified_objects

Sourceval library_dp : unit -> Names.DirPath.t

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

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

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

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

Sections

Sourceval open_section : Names.Id.t -> unit

Sourceval close_section : unit -> unit

We can get and set the state of the operations (used in `States`).

Sourcetype frozen

Sourceval freeze : unit -> frozen

Sourceval unfreeze : frozen -> unit

Sourceval drop_objects : frozen -> frozen

Keep only the libobject structure, not the objects themselves

Sourceval init : unit -> unit

Sourceval section_segment_of_constant : Names.Constant.t -> Cooking.cooking_info

Section management for discharge

Sourceval section_segment_of_inductive : Names.MutInd.t -> Cooking.cooking_info

Sourceval section_segment_of_reference : Names.GlobRef.t -> Cooking.cooking_info

Sourceval section_instance : Names.GlobRef.t -> Constr.t array

Sourceval is_in_section : Names.GlobRef.t -> bool

Discharge: decrease the section level if in the current section

Sourceval discharge_proj_repr : Names.Projection.Repr.t -> Names.Projection.Repr.t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/coq-core.library/Lib/index.html

Module `Lib`Source

...

...

...

Functions relative to current path

Modules and module types

Compilation units

Sections

We can get and set the state of the operations (used in `States`).

Discharge: decrease the section level if in the current section

package coq-core

Install

Dune Dependency

Authors

Maintainers

Sources

doc/coq-core.library/Lib/index.html

Module LibSource

...

...

...

Functions relative to current path

Modules and module types

Compilation units

Sections

We can get and set the state of the operations (used in States).

Discharge: decrease the section level if in the current section

Module `Lib`Source

We can get and set the state of the operations (used in `States`).