Index of values

abs x is the absolute value of x.

Addition.

Add a directory to the end of the load path (i.e.

Convert item documentation to attributes and add them to an attribute list

Convert field info to attributes and add them to an attribute list

Same as add_ppx_context_str, but for signatures.

Extract information from the current environment and encode it into an attribute which is prepended to the list of structure items in order to pass the information to an external processor.

Convert text to attributes and add them to an attribute list

Whether afl-fuzz instrumentation is generated by default

Whether afl-fuzz instrumentation is generated by default

Whether afl-fuzz instrumentation is generated by default

Prints an arbitrary alert.

Hook for intercepting alerts.

append_dir d adds d to the end of the load path (i.e.

Apply a mapper (parametrized by the unit name) to a dumped parsetree found in the source file and put the result in the target file.

If restore = true (the default), cookies set by external rewriters will be kept for later calls.

Name of the ar command, or "" if not needed (MSVC)

Name of the ar command, or "" if not needed (MSVC)

Name of the ar command, or "" if not needed (MSVC)

Name of processor type for the native-code compiler

Name of processor type for the native-code compiler

Name of processor type for the native-code compiler

Whether the assembler supports --debug-prefix-map

Whether the assembler supports --debug-prefix-map

Whether the assembler supports --debug-prefix-map

The assembler (and flags) to use for assembling ocamlopt-generated code.

The assembler (and flags) to use for assembling ocamlopt-generated code.

The assembler (and flags) to use for assembling ocamlopt-generated code.

Whether assembler understands CFI directives

Whether assembler understands CFI directives

Whether assembler understands CFI directives

Magic number for file holding an implementation syntax tree

Magic number for file holding an implementation syntax tree

Magic number for file holding an implementation syntax tree

Magic number for file holding an interface syntax tree

Magic number for file holding an interface syntax tree

Magic number for file holding an interface syntax tree

Encode a warning message into an 'ocaml.ppwarning' attribute which can be inserted in a generated Parsetree.

Detects the terminal capabilities and selects an adequate printer

The directory containing the binary programs

The directory containing the binary programs

The directory containing the binary programs

The C libraries to link with custom runtimes

The C libraries to link with custom runtimes

The C libraries to link with custom runtimes

The compiler to use for compiling C files

The compiler to use for compiling C files

The compiler to use for compiling C files

Whether the C compiler supports -fdebug-prefix-map

Whether the C compiler supports -fdebug-prefix-map

Whether the C compiler supports -fdebug-prefix-map

Name of the option of the C compiler for specifying the output file

Name of the option of the C compiler for specifying the output file

Name of the option of the C compiler for specifying the output file

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

The "kind" of the C compiler, assembler and linker used: one of "cc" (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)

check_current kind info checks that the provided magic info is the current version of kind's magic header.

Magic number for archive files

Magic number for archive files

Magic number for archive files

Magic number for compiled interface files

Magic number for compiled interface files

Magic number for compiled interface files

Magic number for object bytecode files

Magic number for object bytecode files

Magic number for object bytecode files

Magic number for compiled interface files

Magic number for compiled interface files

Magic number for compiled interface files

Magic number for compilation unit descriptions

Magic number for compilation unit descriptions

Magic number for compilation unit descriptions

Magic number for libraries of compilation unit descriptions

Magic number for libraries of compilation unit descriptions

Magic number for libraries of compilation unit descriptions

Magic number for dynamically-loadable plugins

Magic number for dynamically-loadable plugins

Magic number for dynamically-loadable plugins

The comparison function for target integers, with the same specification as Stdlib.compare.

The lexicographic order supported by the provided order.

the configuration value of a variable, if it exists

the configuration value of a variable, if it exists

the configuration value of a variable, if it exists

This function parses a syntactically valid path for a variant constructor.

Get the location of the current token from the lexbuf.

the current magic number of each kind

the current version of each kind

String.cut_at s c returns a pair containing the sub-string before the first occurrence of c in s, and the sub-string after the first occurrence of c in s.

Returns the list of --debug-prefix-map flags to be passed to the assembler, built from the BUILD_PATH_PREFIX_MAP environment variable.

Original alert reporter for use in hooks.

Name of executable produced by linking if none is given with -o, e.g.

Name of executable produced by linking if none is given with -o, e.g.

Name of executable produced by linking if none is given with -o, e.g.

A default iterator, which implements a "do not do anything" mapping.

Default value for all optional location arguments.

A default mapper, which implements a "deep identity" mapping.

Original report printer for use in hooks.

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)

Original warning reporter for use in hooks.

delete_eol_spaces s returns a fresh copy of s with any end of line spaces removed.

Prints a deprecation alert.

did_you_mean ppf get_choices hints that the user may have meant one of the option returned by calling get_choices.

diff state l r computes the optimal patch between l and r, using the initial state state.

disjoint_union m1 m2 contains all bindings from m1 and m2.

Integer division.

Create a docstring

Get the text of a docstring

Get the location of a docstring

domain a is a fresh copy of an initial segment of the array a whose length is extent a.

Same as drop_ppx_context_str, but for signatures.

Drop the ocaml.ppx.context attribute from a structure.

edit_distance a b cutoff computes the edit distance between strings a and b.

The equal function for target ints.

Returns true if and only if the given lists have the same length and content with respect to the given equality function.

Magic number for bytecode executable files

Magic number for bytecode executable files

Magic number for bytecode executable files

Same as Array.exists2 from the standard library.

Produces an explanation for a parse error.

Provides an explanation of the unexpected_error.

Extension for assembler files, e.g.

Extension for assembler files, e.g.

Extension for assembler files, e.g.

Extension for dynamically-loaded libraries, e.g.

Extension for dynamically-loaded libraries, e.g.

Extension for dynamically-loaded libraries, e.g.

Extension for executable programs, e.g.

Extension for executable programs, e.g.

Extension for executable programs, e.g.

Extension for library files, e.g.

Extension for library files, e.g.

Extension for library files, e.g.

Extension for object files, e.g.

Extension for object files, e.g.

Extension for object files, e.g.

This function parse syntactically valid path for an extended module.

Encode an error into an 'ocaml.error' extension node which can be inserted in a generated Parsetree.

extent a is the length of an initial segment of the array a that is sufficiently large to contain all set operations ever performed.

All the files in that directory.

Locate a file in the load path.

Returns the longest list that, with respect to the provided equality function, is a prefix of both of the given lists.

Same as find, but search also for uncapitalized name, i.e.

Whether the compiler was configured for flambda

Whether the compiler was configured for flambda

Whether the compiler was configured for flambda

Whether the compiler and runtime automagically flatten float arrays

Whether the compiler and runtime automagically flatten float arrays

Whether the compiler and runtime automagically flatten float arrays

Directories needed for the FlexDLL objects

Directories needed for the FlexDLL objects

Directories needed for the FlexDLL objects

Same as Array.for_all from the standard library, but the function is applied with the index of the element as first argument, and the element itself as second argument.

Force runtime-variant to be "i" at configure time when ocamlc or ocamlopt link executables.

Force runtime-variant to be "i" at configure time when ocamlc or ocamlopt link executables.

Force runtime-variant to be "i" at configure time when ocamlc or ocamlopt link executables.

Returns a fresh instance of the store.

Whether the compiler was configured to generate each function in a separate section

Whether the compiler was configured to generate each function in a separate section

Whether the compiler was configured to generate each function in a separate section

Same as get_paths (), except that it returns a Dir.t list.

get a i returns the element contained at offset i in the array a.

Returns the map encoded in the BUILD_PATH_PREFIX_MAP environment variable.

The string list argument of the following functions is a list of alternative names for the attribute we are looking for.

Return the list of directories passed to add_dir so far.

file, line, char

Whether the compiler is a cross-compiler

Whether the compiler is a cross-compiler

Whether the compiler is a cross-compiler

a user-meaningful name for a kind, eg.

Return an empty ghost range located in a given file.

init l is the same as reset (); List.iter add_dir (List.rev l)

Set the file name and line number of the lexbuf to be the start of the named file.

(Re)Initialise all docstring state

Suffix for interface file names

Suffix for interface file names

Suffix for interface file names

Returns true when a store is active (i.e.

True for Location.none, false any other location

Returns true if and only if the given list, with respect to the given equality function on list members, is a prefix of the list of_.

Normally the same as Obj.lazy_tag.

Normally the same as Obj.lazy_tag.

Normally the same as Obj.lazy_tag.

Magic number for Linear internal representation files

Magic number for Linear internal representation files

Magic number for Linear internal representation files

Bitwise logical and.

Bitwise logical negation.

Bitwise logical or.

Bitwise logical exclusive or.

The function longident is guaranteed to parse all subclasses of Longident.t used in OCaml: values, constructors, simple or extended module paths, and types or module types.

all magic numbers take the same number of bytes

make x creates an infinite array, where every slot contains x.

let r1, r2 = map2_prefix f l1 l2 If l1 is of length n and l2 = h2 @ t2 with h2 of length n, r1 is List.map2 f l1 h1 and r2 is t2.

Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)

Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)

Mark the item documentation for the current symbol (for ambiguity warnings).

Mark the item documentation for the current symbol (for ambiguity warnings).

The greatest representable target integer, either 2³¹ - 1 on a 32-bit platform, or 2⁶³ - 1 on a 64-bit platform.

Biggest tag that can be stored in the header of a regular block.

Biggest tag that can be stored in the header of a regular block.

Biggest tag that can be stored in the header of a regular block.

Maximal size of arrays that are directly allocated in the minor heap

Maximal size of arrays that are directly allocated in the minor heap

Maximal size of arrays that are directly allocated in the minor heap

The smallest representable target integer, either -2³¹ on a 32-bit platform, or -2⁶³ on a 64-bit platform.

The target integer -1.

Like Lazy.of_fun, but the function is applied with the warning/alert settings at the time mk_lazy is called.

The linker command line to build dynamic libraries.

The linker command line to build dynamic libraries.

The linker command line to build dynamic libraries.

The linker command line to build executables.

The linker command line to build executables.

The linker command line to build executables.

The linker command line to build main programs as dlls.

The linker command line to build main programs as dlls.

The linker command line to build main programs as dlls.

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)

Name of processor submodel for the native-code compiler

Name of processor submodel for the native-code compiler

Name of processor submodel for the native-code compiler

Multiplication.

Whether the runtime supports naked pointers

Whether the runtime supports naked pointers

Whether the runtime supports naked pointers

The C libraries to link with native-code programs

The C libraries to link with native-code programs

The C libraries to link with native-code programs

the native object file configuration of the active/configured compiler.

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).

Unary negation.

An arbitrary value of type t; describes an empty ghost range.

normalise_eol s returns a fresh copy of s with any '\r' characters removed.

The flags ocamlc should pass to the C compiler

The flags ocamlc should pass to the C compiler

The flags ocamlc should pass to the C compiler

The flags ocamlc should pass to the C preprocessor

The flags ocamlc should pass to the C preprocessor

The flags ocamlc should pass to the C preprocessor

Convert the given floating-point number to a target integer, discarding the fractional part (truncate towards 0).

Convert the given integer (type int) to a target integer (type t), module the target word size.

Convert the given 32-bit integer (type int32) to a target integer.

Convert the given 64-bit integer (type int64) to a target integer.

Convert the given integer (type int) to a target integer (type t).

Convert the given string to a target integer.

The target integer 1.

ordinal_suffix n is the appropriate suffix to append to the numeral n as an ordinal number: 1 -> "st", 2 -> "nd", 3 -> "rd", 4 -> "th", and so on.

Parses a raw magic number

Disable/enable alerts based on the parameter to the -alert command-line option.

parse a raw kind into a kind

dependencies found by preprocessing tools

pp_two_columns ?sep ?max_lines ppf l prints the lines in l as two columns separated by sep ("|" by default).

Predecessor.

prepend_dir d adds d to the start of the load path (i.e.

Same as print_alert, but uses !formatter_for_warnings as output formatter.

Same as print_warning, but uses !formatter_for_warnings as output formatter.

Print a target integer to a formatter.

Prints the selected recorded profiling information to the formatter.

Prints an alert.

Access to configuration values

Access to configuration values

Access to configuration values

print_if ppf flag fmt x prints x with fmt on ppf if b is true.

Display an error or warning report.

Prints a warning.

Whether the compiler was configured for profiling

Whether the compiler was configured for profiling

Whether the compiler was configured for profiling

How many bits are to be used in values' headers for profiling information

How many bits are to be used in values' headers for profiling information

How many bits are to be used in values' headers for profiling information

protect_refs l f temporarily sets r to v for each R (r, v) in l while executing f.

Open the given filename for writing (in binary mode), pass the out_channel to the given function, then close the channel.

A valid raw representation of the magic number.

the current raw representation of a kind.

Read a magic number as read_info, and check that it is the current version as its kind.

Read a raw magic number from an input channel.

record pass f arg records the profile information of f arg

record_call pass f calls f and records its profile information.

Register a docstring

Apply the register_function.

Each compiler module which defines a custom type of exception which can surface as a user-visible error should register a "printer" for this exception using register_error_of_exn.

Integer remainder.

Remove a directory from the load path

report_alert loc w produces a report for the given alert w, or None if the alert is not to be printed.

Reraise the exception if it is unknown.

Hook for redefining the printer of reports.

report_warning loc w produces a report for the given warning w, or None if the warning is not to be printed.

The concrete representation of a native integer.

reraise_preserving_backtrace e f is (f (); raise e) except that the current backtrace is preserved, even if f uses exceptions internally.

erase all recorded profile information

Resets all the references to the initial snapshot (i.e.

Remove all directories

rewrite absolute path to honor the BUILD_PATH_PREFIX_MAP variable (https://reproducible-builds.org/specs/build-path-prefix-map/) if it is set.

rewrite_opt map path tries to find a source in map that is a prefix of the input path.

Fetch the item documentation for the symbols between two positions.

Fetch the item documentation for the symbols between two positions.

Fetch the field info following the symbol at a given position.

Fetch the field info following the symbol at a given position.

rhs_loc n returns the location of the symbol at position n, starting at 1, in the current parser rule.

Fetch additional text following the symbol at the given position

Fetch additional text following the symbol at the given position

Fetch text following the symbol at the given position

Fetch text following the symbol at the given position

Fetch additional text preceding the symbol at the given position

Fetch additional text preceding the symbol at the given position

Fetch the text preceding the symbol at the given position.

Fetch the text preceding the symbol at the given position.

Entry point to call to implement a standalone -ppx rewriter from a mapper, parametrized by the command line arguments.

Similar to Stdlib.ref, except the allocated reference is registered into the store.

Used to register hash tables.

set a i x sets the element contained at offset i in the array a to x.

Docstrings not immediately adjacent to a token

Docstrings immediately following a token

Docstrings immediately preceding the token which follows this one

Docstrings immediately preceding a token

Docstrings immediately following the token which precedes this one

Targetint.shift_left x y shifts x to the left by y bits.

Targetint.shift_right x y shifts x to the right by y bits.

Targetint.shift_right_logical x y shifts x to the right by y bits.

configuration variables

In -absname mode, return the absolute path for this filename.

This function parses a syntactically valid path for a module.

The size in bits of a target native integer.

If all elements of the given list are Some _ then Some xs is returned with the xs being the contents of those Somes, with order preserved.

spellcheck env name takes a list of names env that exist in the current environment and an erroneous name, and returns a list of suggestions taken from env, that are close enough to name that it may be a typo for one of them.

split_at n l returns the pair before, after where before is the n first elements of l and after the remaining ones.

Size in words of the safety margin between the bottom of the stack and the stack pointer.

Size in words of the safety margin between the bottom of the stack and the stack pointer.

Size in words of the safety margin between the bottom of the stack and the stack pointer.

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

Size in words of safe area at bottom of VM stack, see runtime/caml/config.h

The directory containing the standard libraries

The directory containing the standard libraries

The directory containing the standard libraries

a user-printable string for a kind, eg.

Subtraction.

Successor.

Whether shared libraries are supported

Whether shared libraries are supported

Whether shared libraries are supported

Fetch the item documentation for the current symbol.

Fetch the item documentation for the current symbol.

Fetch the field info for the current symbol.

Fetch the field info for the current symbol.

Fetch additional text following the current symbol

Fetch additional text following the current symbol

Fetch additional text preceding the current symbol

Fetch additional text preceding the current symbol

Fetch the text preceding the current symbol.

Fetch the text preceding the current symbol.

Name of operating system for the native-code compiler

Name of operating system for the native-code compiler

Name of operating system for the native-code compiler

Whether the system thread library is implemented

Whether the system thread library is implemented

Whether the system thread library is implemented

Whether the compiler is a cross-compiler

Whether the compiler is a cross-compiler

Whether the compiler is a cross-compiler

test st xl xr tests if the elements xl and xr are co mpatible (Ok) or not (Error).

Convert the given target integer to a floating-point number.

Convert the given target integer (type t) to an integer (type int).

Convert the given target integer to a 32-bit integer (type int32).

Convert the given target integer to a 64-bit integer (type int64).

Return the string representation of its argument, in decimal.

Can be used within a ppx preprocessor to know which tool is calling it "ocamlc", "ocamlopt", "ocamldoc", "ocamldep", "ocaml", ...

try_finally work ~always ~exceptionally is designed to run code in work that may fail with an exception, and has two kind of cleanup routines: always, that must be run after any execution of the function (typically, freeing system resources), and exceptionally, that should be run only if work or always failed with an exception (typically, undoing user-visible state changes that would only make sense if the function completes correctly).

This function parse syntactically valid path for a type or a module type.

Print a type variable name, taking care of the special treatment required for the single quote character in second position.

For a non-empty list l, unflatten l is Some lid where lid is the long identifier created by concatenating the elements of l with Ldot.

union_left m1 m2 = union_right m2 m1

union_right m1 m2 contains all bindings from m1 and m2.

Same as Targetint.compare, except that arguments are interpreted as unsigned integers.

Same as Targetint.div, except that arguments and result are interpreted as unsigned integers.

Same as Targetint.rem, except that arguments and result are interpreted as unsigned integers.

update ch st returns the new state after applying a change.

Set all the inlining arguments for a round.

This function parses a syntactically valid path for a value.

varify_constructors newtypes te is type expression te, of which any of nullary type constructor tc is replaced by type variable of the same name, if tc's name appears in newtypes.

The current version number of the system

The current version number of the system

The current version number of the system

Emit warnings for unattached and ambiguous docstrings

Apply warning settings from the specified attribute.

Hook for intercepting warnings.

Execute a function in a new scope for warning settings.

weight ch returns the weight of the change ch.

Whether Windows Unicode runtime is enabled

Whether Windows Unicode runtime is enabled

Whether Windows Unicode runtime is enabled

Whether the invariants checks for Cmm are enabled

Whether the invariants checks for Cmm are enabled

Whether the invariants checks for Cmm are enabled

Set the default_loc within the scope of the execution of the provided function.

Whether the invariants checks for flambda are enabled

Whether the invariants checks for flambda are enabled

Whether the invariants checks for flambda are enabled

Whether assembler should maintain frame pointers

Whether assembler should maintain frame pointers

Whether assembler should maintain frame pointers

with_store s f resets all the registered references to the value they have in s for the run of f.

Run the thunk with all warnings and alerts disabled.

The target integer 0.

zero_to_n n is the set of numbers {0, ..., n} (inclusive).