package dolmen

  1. Overview
  2. Docs
package dolmen
Legend:
Library
Module
Module type
Parameter
Class
Class type

Paths

Paths are used to identify constants and variables after typechecking. They are meant to identify the abstract location of where constants and variables come from. Variables are always local, whereas constants are identified by a full absolute path including all module names leading to the module defining the constant.

Type definition

type path = string list

A path of module names. A path identifies a module, or the toplevel/implicitly global module if empty.

type t = private
  1. | Local of {
    1. name : string;
    }
    (*

    A local path, mainly used for variables.

    *)
  2. | Absolute of {
    1. path : path;
    2. name : string;
    }
    (*

    An absolute path, containing a path to a module, and a basename.

    *)

Paths used for variables and constants.

Std functions

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

Printing function.

Creation function

val local : string -> t

Create a local path.

val global : string -> t

Create a global path.

val absolute : path -> string -> t

Create an absolute path.

val rename : (string -> string) -> t -> t

Change the basename of a path.

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