package ocamlformat-lib

You can search for identifiers within the package.

in-package search v0.2.0

Auto-formatter for OCaml code

Install

Dune Dependency

github.com Readme Changelog MIT; LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (5)

Authors

J

Josh Berdine <jjb@fb.com>

Maintainers

O

OCamlFormat Team <ocamlformat-dev@lists.ocaml.org>

Sources

ocamlformat-0.26.0.tbz

sha256=031494ab770cef10a8f6aa1cbeb5660e46c3aa6c0cd457b110fec859a75e877d

sha512=35c0131f04c2c8ceb94f0f400e4b56690405ddebb482aec0c9962163001d9fd5b593455df08b508394949f2740ba28f1714dff9e1f17b618bdec62fd26fae281

doc/ocamlformat-lib.ocaml_common/Ocaml_common/Longident/index.html

Module `Ocaml_common.Longident`Source

Long identifiers, used in parsetree.

Warning: this module is unstable and part of compiler-libs.

To print a longident, see Pprintast.longident, using Format.asprintf to convert to a string.

Sourcetype t =

| Lident of string
| Ldot of t * string
| Lapply of t * t

Sourceval flatten : t -> string list

Sourceval unflatten : string list -> t option

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. unflatten [] is None.

Sourceval last : t -> string

Sourceval parse : string -> t

This function is broken on identifiers that are not just "Word.Word.word"; for example, it returns incorrect results on infix operators and extended module paths.

If you want to generate long identifiers that are a list of dot-separated identifiers, the function unflatten is safer and faster. unflatten is available since OCaml 4.06.0.

If you want to parse any identifier correctly, use the long-identifiers functions from the Parse module, in particular Parse.longident. They are available since OCaml 4.11, and also provide proper input-location support.

deprecated this function may misparse its input, use "Parse.longident" or "Longident.unflatten"