/
batChar.mli
118 lines (89 loc) · 3.8 KB
/
batChar.mli
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
(*
* ExtChar - Additional character operations
* Copyright (C) 1996 Xavier Leroy
* 2008 David Teller
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version,
* with the special exception on linking described in file LICENSE.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Operations on characters.
Characters range upon Latin-1 encoding, i.e. languages used in
Western Europe and North America. For international characters,
another, richer, module is provided: {!UChar}.
This module extends Stdlib's
{{:http://caml.inria.fr/pub/docs/manual-ocaml/libref/Char.html}Char}
module, go there for documentation on the rest of the functions
and types.
@author Xavier Leroy (base module)
@author David Teller
*)
val is_whitespace : char -> bool
(** Determine if a character is a whitespace.
Whitespace characters are defined as
[' '], ['\010'], ['\013'], ['\009'], ['\026']
and ['\012']. *)
val is_uppercase : char -> bool
(** Determine if a character is uppercase ASCII.
A character is uppercase ASCII if it is between
['A'] and ['Z'] *)
val is_lowercase : char -> bool
(** Determine if a character is lowercase ASCII.
A character is lowercase ASCII if it is between
['a'] and ['z'] *)
val is_uppercase_latin1: char -> bool
(** Determine if a character is uppercase Latin 1.
A character is uppercase ASCII if it is between
['A'] and ['Z'], between ['À'] and ['Ö'] or
between ['Ø'] and ['Ý'] *)
val is_lowercase_latin1: char -> bool
(** Determine if a character is lowercase Latin 1.
A character is lowercase ASCII if it is between
['a'] and ['z'], between ['Þ'] and ['ö'] or
between ['ø'] and ['ÿ']*)
val is_latin1: char -> bool
(** Determine if a character is a Latin 1 letter.
A character is a Latin 1 letter if it is either
an uppercase or a lowercase Latin 1 character.*)
val is_digit : char -> bool
(** Determine if a character represents a digit. Digits are ['0'],
['1'], ... ['9']. *)
val is_symbol : char -> bool
(** Determine if a character represents a (OCaml-style)
symbol. Symbols are ['!'], ['%'], ['&'], ['$'], ['#'], ['+'],
['-'], ['/'], [':'], ['<'], ['='] ['>'], ['?'], ['@'], ['\\'],
['~'], ['^'], ['|'], ['*'] *)
val is_letter : char -> bool
(** Determine if a character represents a ASCII letter.*)
val is_newline : char -> bool
(** Determine if a character is a newline.
Newline characters are defined as ['\010']
and ['\013']*)
val of_digit : int -> char
(** Return the character representing a given digit.
Raise [Invalid_argument "Char.of_digit"] if the
argument is outside the range 0--9*)
val enum: unit -> char BatEnum.t
(** Produce the enumeration of all characters *)
val range: ?until:char -> char -> char BatEnum.t
val ( -- ): char -> char -> char BatEnum.t
(** Produce the enumeration of a segment of characters.
['a' -- 'z'] is the enumeration of all characters
between ['a'] and ['z'] included.*)
(** {6 Boilerplate code}*)
(** {7 Printing}*)
val print: 'a BatInnerIO.output -> Char.t -> unit
(**/**)
external unsafe_chr : int -> char = "%identity"
external unsafe_int : char-> int = "%identity"