Module Structured_mangling

Structured name mangling for OxCaml symbols.

This module implements a mangling scheme that encodes OxCaml identifiers into a restricted character set (ASCII alphanumeric and underscore) suitable for use in linker symbols. The scheme preserves the lexical structure of the source program by encoding each scope (compilation unit, module, function, etc.) as a tagged path item.

Mangled symbol format

A mangled symbol has the form _Caml<path> where <path> is a sequence of tagged, length-prefixed identifiers:

For example, Foo.Bar.baz in compilation unit Foo mangles to _CamlU3FooM3BarF3baz.

type path_item =
  1. | Compilation_unit of Compilation_unit.t
    (*

    A compilation unit (file)

    *)
  2. | Inline_marker
    (*

    A separator (between destination and source) to track inlining

    *)
  3. | Module of string
    (*

    A named module

    *)
  4. | Anonymous_module of int * int * string option
    (*

    struct ... end at (line, col, file)

    *)
  5. | Class of string
    (*

    A class definition

    *)
  6. | Function of string
    (*

    A named function

    *)
  7. | Anonymous_function of int * int * string option
    (*

    fun ... -> ... at (line, col, file)

    *)
  8. | Partial_function of int * int * string option
    (*

    A partial application at (line, col, file)

    *)

A path item represents a single lexical scope in the mangling path.

type path = path_item list

A mangling path is a list of path items representing the full lexical context of an identifier.

val mangle_ident : Compilation_unit.t -> path -> string

Transform a Compilation_unit.t and a path into a mangled name suitable for creating a LinkageName.t