package merlin-lib

  1. Overview
  2. Docs
Merlin's libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (18)

Authors

  1. T
    The Merlin team

Maintainers

  1. D
    defree@gmail.com

Sources

merlin-5.7-505.preview.tbz
sha256=a3047606d06580e251ee8acbeb67f80f1d059238f879e187e10de40b4ec61be7
sha512=871f4e8f1111d086985172a9157812d5e22fd746edeffa8bdb5363f5c8cef2308da36a57d989ae77becec32eaa6ea4e8ef67f9b0247cbd409537701644db563f

doc/merlin-lib.utils/Merlin_utils/Misc/Utf8_lexeme/index.html

Module Misc.Utf8_lexemeSource

Sourcetype t = string
Sourceval normalize : string -> (t, t) Result.t

Normalize the given UTF-8 encoded string. Invalid UTF-8 sequences results in a error and are replaced by U+FFFD. Identifier characters are put in NFC normalized form. Other Unicode characters are left unchanged.

Sourceval capitalize : string -> (t, t) Result.t

Like normalize, but if the string starts with a lowercase identifier character, it is replaced by the corresponding uppercase character. Subsequent characters are not changed.

Sourceval uncapitalize : string -> (t, t) Result.t

Like normalize, but if the string starts with an uppercase identifier character, it is replaced by the corresponding lowercase character. Subsequent characters are not changed.

Sourceval is_capitalized : t -> bool

Returns true if the given normalized string starts with an uppercase identifier character, false otherwise. May return wrong results if the string is not normalized.

Sourceval is_valid_identifier : t -> bool

Check whether the given normalized string is a valid OCaml identifier:

  • all characters are identifier characters
  • it does not start with a digit or a single quote
Sourceval is_lowercase : t -> bool

Returns true if the given normalized string only contains lowercase identifier character, false otherwise. May return wrong results if the string is not normalized.

Sourcetype validation_result =
  1. | Valid
  2. | Invalid_character of Uchar.t
    (*

    Character not allowed

    *)
  3. | Invalid_beginning of Uchar.t
    (*

    Character not allowed as first char

    *)
Sourceval validate_identifier : ?with_dot:bool -> t -> validation_result

Like is_valid_identifier, but returns a more detailed error code. Dots can be allowed to extend support to path-like identifiers.

Sourceval starts_like_a_valid_identifier : t -> bool

Checks whether the given normalized string starts with an identifier character other than a digit or a single quote. Subsequent characters are not checked.