aboutsummaryrefslogtreecommitdiff
path: root/doc/Manual/en/BH_String.pod
blob: a88d7963ad801e786aba2b4d061f73886728961e (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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
=encoding UTF-8


=head1 NAME

BH_String - Working with strings


=head1 SYNTAX

 #include <BH/Math.h>

 cc prog.c -o prog -lbh


=head1 DESCRIPTION

The BH_String library provides a set of functions for working with strings,
including converting numbers to strings and back.


=head1 DEFINING THE BASE

The functions of the I<StringToInt> family have an algorithm for determining
the base of a number by string prefixes:

=over

=item *

If the prefix I<0b>, then base 2

=item *

If the prefix I<0>, then base 8

=item *

If the prefix I<0x>, then base 16

=item *

Otherwise, base 10.

=back


=head1 API CALLS


=head2 BH_StringFromDouble

 int BH_StringFromDouble(char *string,
                         size_t size,
                         double value,
                         char format,
                         int precision,
                         size_t *actual);


Formats a real number I<value> into a null-terminated string I<string>
(with a length limit of I<size>).

The I<format> parameter specifies the format for converting a number to a
string. Acceptable formats:

=over

=item B<f>, B<F>

Fixed format: [-]ddd.ddd

=item B<e>, B<E>

Scientific format: [-]d.dddedd

=item B<g>, B<G>

Fixed or scientific format, depending on which one is shorter.

=back

The I<precision> parameter sets the precision of converting a number to a
string. If the accuracy value is negative, the conversion will be performed with
the minimum required accuracy so that the reverse conversion results in the
original number.

The optional parameter I<actual> returns the length of the recorded string.

This function follows the IEEE 754 rule of rounding to an even number.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt8s

 int BH_StringFromInt8s(char *string,
                        size_t size,
                        int8_t value,
                        int base,
                        size_t *actual);

Formats an 8-bit signed integer I<value> into a null-terminated string
I<string> (with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt16s

 int BH_StringFromInt16s(char *string,
                         size_t size,
                         int16_t value,
                         int base,
                         size_t *actual);

Formats a 16-bit signed integer I<value> into a null-terminated string I<string>
(with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt32s

 int BH_StringFromInt32s(char *string,
                         size_t size,
                         int32_t value,
                         int base,
                         size_t *actual);

Formats a 32-bit signed integer I<value> into a null-terminated string I<string>
(with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt64s

 int BH_StringFromInt64s(char *string,
                         size_t size,
                         int64_t value,
                         int base,
                         size_t *actual);

Formats a 64-bit signed integer I<value> into a null-terminated string I<string>
(with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt8u

 int BH_StringFromInt8u(char *string,
                        size_t size,
                        uint8_t value,
                        int base,
                        size_t *actual);

Formats an 8-bit unsigned integer I<value> into a null-terminated string
I<string> (with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt16u

 int BH_StringFromInt16u(char *string,
                         size_t size,
                         uint16_t value,
                         int base,
                         size_t *actual);

Formats a 16-bit unsigned integer I<value> into a null-terminated string
I<string> (with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt32u

 int BH_StringFromInt32u(char *string,
                         size_t size,
                         uint32_t value,
                         int base,
                         size_t *actual);

Formats a 32-bit unsigned integer I<value> into a null-terminated string
I<string> (with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringFromInt64u

 int BH_StringFromInt64u(char *string,
                         size_t size,
                         uint64_t value,
                         int base,
                         size_t *actual);

Formats a 64-bit unsigned integer I<value> into a null-terminated string
I<string> (with a length limit of I<size>).

The I<base> parameter sets the base for the conversion.

The optional parameter I<actual> returns the length of the recorded string.

If successful, it returns 0 or an error code.


=head2 BH_StringToDouble

 double BH_StringToDouble(const char *string,
                          size_t *size);

Converts the string I<string> to a real number.

The optional parameter I<size> returns the number of characters read from the
string.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt8s

 int8_t BH_StringToInt8s(const char *string,
                         size_t *size,
                         int base);

Converts the string I<string> to an 8-bit signed integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt16s

 int16_t BH_StringToInt16s(const char *string,
                           size_t *size,
                           int base);

Converts the string I<string> to a signed 16-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt32s

 int32_t BH_StringToInt32s(const char *string,
                           size_t *size,
                           int base);

Converts the string I<string> to a signed 32-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt64s

 int64_t BH_StringToInt64s(const char *string,
                           size_t *size,
                           int base);

Converts the string I<string> to a signed 64-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt8u

 uint8_t BH_StringToInt8u(const char *string,
                          size_t *size,
                          int base);

Converts the string I<string> to an unsigned 8-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt16u

 uint16_t BH_StringToInt16u(const char *string,
                            size_t *size,
                            int base);

Converts the string I<string> to an unsigned 16-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt32u

 uint32_t BH_StringToInt32u(const char *string,
                            size_t *size,
                            int base);

Converts the string I<string> to an unsigned 32-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringToInt64u

 uint64_t BH_StringToInt64u(const char *string,
                            size_t *size,
                            int base);

Converts the string I<string> to an unsigned 64-bit integer.

The optional parameter I<size> returns the number of characters read from the
string.

The optional parameter I<base> specifies the base of the number.

If successful, it returns the converted number or 0.


=head2 BH_StringDup

 char *BH_StringDup(const char *string);

Creates duplicate of the I<string> (simular to strdup).


=head2 BH_StringCompare

 int BH_StringCompare(const char *s1,
                      const char *s2);

Compares two strings.


=head2 BH_StringCompareCaseless

 int BH_StringCompareCaseless(const char *s1,
                              const char *s2);

Compares two case-insensitive strings.


=head1 SEE ALSO

L<BH>