aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/ru/BH_Unicode.pod
blob: d3233e5114c43ce0733d8b0139ead7721a18a65b (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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
=encoding UTF-8


=head1 НАИМЕНОВАНИЕ

BH_Unicode - Работа с Unicode и UTF кодировками


=head1 СИНТАКСИС

 #include <BH/Math.h>

 cc prog.c -o prog -lbh


=head1 ОПИСАНИЕ

Библиотека BH_Unicode предоставляет набор функций для работы с различными
кодировками Unicode, включая UTF-8, UTF-16 и UTF-32. Она позволяет
преобразовывать символы в верхний и нижний регистр, а также кодировать и
декодировать строки в указанных кодировках.


=head1 API ВЫЗОВЫ


=head2 BH_UnicodeLower

 uint32_t BH_UnicodeLower(uint32_t unit);

Преобразует Unicode-код I<unit> в нижний регистр.

Преобразование выполняется для символов в Basic Multilingual Plane (т. е. первые
65 536 кодов).


=head2 BH_UnicodeUpper

 uint32_t BH_UnicodeUpper(uint32_t unit);

Преобразует Unicode-код I<unit> в верхний регистр.

Преобразование выполняется для символов в Basic Multilingual Plane (т. е. первые
65 536 кодов).


=head2 BH_UnicodeDecodeUtf8

 size_t BH_UnicodeDecodeUtf8(const char *string,
                             size_t size,
                             uint32_t *unit);

Декодирует UTF-8 последовательность из I<string> (с заданной длиной I<size>) и
записывает код в I<unit>.

Недопустимые последовательности UTF-8 будут преобразованы к коду -1.

В случае успеха функция возвращает количество прочитанных байтов или 0, если
I<string> содержит только часть последовательности.


=head2 BH_UnicodeEncodeUtf8

 size_t BH_UnicodeEncodeUtf8(uint32_t unit,
                             char *string);

Кодирует UTF-8 последовательность в I<string> из кода I<unit>.

Предполагается, что строка содержит 4 байта свободного места.

В случае успеха функция возвращает количество записанных байтов или 0.


=head2 BH_UnicodeDecodeUtf16LE

 size_t BH_UnicodeDecodeUtf16LE(const char *string,
                                size_t size,
                                uint32_t *unit);

Декодирует UTF-16LE последовательность из I<string> (с заданной длиной I<size>)
и записывает код в I<unit>.

Недопустимые последовательности UTF-16LE будут преобразованы к коду -1.

В случае успеха функция возвращает количество прочитанных байтов или 0, если
I<string> содержит только часть последовательности.


=head2 BH_UnicodeDecodeUtf16BE

 size_t BH_UnicodeDecodeUtf16BE(const char *string,
                                size_t size,
                                uint32_t *unit);

Декодирует UTF-16BE последовательность из I<string> (с заданной длиной I<size>)
и записывает код в I<unit>.

Недопустимые последовательности UTF-16BE будут преобразованы к коду -1.

В случае успеха функция возвращает количество прочитанных байтов или 0, если
I<string> содержит только часть последовательности.


=head2 BH_UnicodeEncodeUtf16LE

 size_t BH_UnicodeEncodeUtf16LE(uint32_t unit,
                                char *string);

Кодирует UTF-16LE последовательность в I<string> из кода I<unit>.

Предполагается, что строка содержит 4 байта свободного места.

В случае успеха функция возвращает количество записанных байтов или 0.


=head2 BH_UnicodeEncodeUtf16BE

 size_t BH_UnicodeEncodeUtf16BE(uint32_t unit,
                                char *string);

Кодирует UTF-16BE последовательность в I<string> из кода I<unit>.

Предполагается, что строка содержит 4 байта свободного места.

В случае успеха функция возвращает количество записанных байтов или 0.


=head2 BH_UnicodeDecodeUtf32LE

 size_t BH_UnicodeDecodeUtf32LE(const char *string,
                                size_t size,
                                uint32_t *unit);

Декодирует UTF-32LE последовательность из I<string> (с заданной длиной I<size>)
и записывает код в I<unit>.

Недопустимые последовательности UTF-32LE будут преобразованы к коду -1.

В случае успеха функция возвращает количество прочитанных байтов или 0, если
I<string> содержит только часть последовательности.


=head2 BH_UnicodeDecodeUtf32BE

 size_t BH_UnicodeDecodeUtf32BE(const char *string,
                                size_t size,
                                uint32_t *unit);

Декодирует UTF-32BE последовательность из I<string> (с заданной длиной I<size>)
и записывает код в I<unit>.

Недопустимые последовательности UTF-32BE будут преобразованы к коду -1.

В случае успеха функция возвращает количество прочитанных байтов или 0, если
I<string> содержит только часть последовательности.


=head2 BH_UnicodeEncodeUtf32LE

 size_t BH_UnicodeEncodeUtf32LE(uint32_t unit,
                                char *string);

Кодирует UTF-32LE последовательность в I<string> из кода I<unit>.

Предполагается, что строка содержит 4 байта свободного места.

В случае успеха функция возвращает количество записанных байтов или 0.


=head2 BH_UnicodeEncodeUtf32BE

 size_t BH_UnicodeEncodeUtf32BE(uint32_t unit,
                                char *string);

Кодирует UTF-32BE последовательность в I<string> из кода I<unit>.

Предполагается, что строка содержит 4 байта свободного места.

В случае успеха функция возвращает количество записанных байтов или 0.


=head1 СМ. ТАКЖЕ

L<BH>