blob: c2b7abc53cd02e4e161f84a03aee7c7de1ad2b10 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Daniel C. Buenzli *)
(* *)
(* Copyright 2014 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
(** Unicode characters.
@since 4.03 *)
type t
[@@immediate]
(** The type for Unicode characters.
A value of this type represents a Unicode
{{:http://unicode.org/glossary/#unicode_scalar_value}scalar
value} which is an integer in the ranges [0x0000]...[0xD7FF] or
[0xE000]...[0x10FFFF]. *)
val min : t
(** [min] is U+0000. *)
val max : t
(** [max] is U+10FFFF. *)
val bom : t
(** [bom] is U+FEFF, the
{{:http://unicode.org/glossary/#byte_order_mark}byte order mark} (BOM)
character.
@since 4.06 *)
val rep : t
(** [rep] is U+FFFD, the
{{:http://unicode.org/glossary/#replacement_character}replacement}
character.
@since 4.06 *)
val succ : t -> t
(** [succ u] is the scalar value after [u] in the set of Unicode scalar
values.
@raise Invalid_argument if [u] is {!max}. *)
val pred : t -> t
(** [pred u] is the scalar value before [u] in the set of Unicode scalar
values.
@raise Invalid_argument if [u] is {!min}. *)
val is_valid : int -> bool
(** [is_valid n] is [true] if and only if [n] is a Unicode scalar value
(i.e. in the ranges [0x0000]...[0xD7FF] or [0xE000]...[0x10FFFF]).*)
val of_int : int -> t
(** [of_int i] is [i] as a Unicode character.
@raise Invalid_argument if [i] does not satisfy {!is_valid}. *)
(**/**)
val unsafe_of_int : int -> t
(**/**)
val to_int : t -> int
(** [to_int u] is [u] as an integer. *)
val is_char : t -> bool
(** [is_char u] is [true] if and only if [u] is a latin1 OCaml character. *)
val of_char : char -> t
(** [of_char c] is [c] as a Unicode character. *)
val to_char : t -> char
(** [to_char u] is [u] as an OCaml latin1 character.
@raise Invalid_argument if [u] does not satisfy {!is_char}. *)
(**/**)
val unsafe_to_char : t -> char
(**/**)
val equal : t -> t -> bool
(** [equal u u'] is [u = u']. *)
val compare : t -> t -> int
(** [compare u u'] is [Stdlib.compare u u']. *)
val hash : t -> int
(** [hash u] associates a non-negative integer to [u]. *)
(** {1:utf UTF codecs tools}
@since 4.14 *)
type utf_decode [@@immediate]
(** The type for UTF decode results. Values of this type represent
the result of a Unicode Transformation Format decoding attempt. *)
val utf_decode_is_valid : utf_decode -> bool
(** [utf_decode_is_valid d] is [true] if and only if [d] holds a valid
decode. *)
val utf_decode_uchar : utf_decode -> t
(** [utf_decode_uchar d] is the Unicode character decoded by [d] if
[utf_decode_is_valid d] is [true] and {!Uchar.rep} otherwise. *)
val utf_decode_length : utf_decode -> int
(** [utf_decode_length d] is the number of elements from the source
that were consumed by the decode [d]. This is always strictly
positive and smaller or equal to [4]. The kind of source elements
depends on the actual decoder; for the decoders of the standard
library this function always returns a length in bytes. *)
val utf_decode : int -> t -> utf_decode
(** [utf_decode n u] is a valid UTF decode for [u] that consumed [n]
elements from the source for decoding. [n] must be positive and
smaller or equal to [4] (this is not checked by the module). *)
val utf_decode_invalid : int -> utf_decode
(** [utf_decode_invalid n] is an invalid UTF decode that consumed [n]
elements from the source to error. [n] must be positive and
smaller or equal to [4] (this is not checked by the module). The
resulting decode has {!rep} as the decoded Unicode character. *)
val utf_8_byte_length : t -> int
(** [utf_8_byte_length u] is the number of bytes needed to encode
[u] in UTF-8. *)
val utf_16_byte_length : t -> int
(** [utf_16_byte_length u] is the number of bytes needed to encode
[u] in UTF-16. *)
|
