package ocaml-compiler
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=22c1dd9de21bf43b62d1909041fb5fad648905227bf69550a6a6bef31e654f38
doc/compiler-libs.common/Misc/Utf8_lexeme/index.html
Module Misc.Utf8_lexeme
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.
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.
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.
val 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.
val 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
val 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.
val 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.
val 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.