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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_STRING_H_
#define _RTL_STRING_H_
#include <sal/types.h>
#include <osl/interlck.h>
#include <rtl/textcvt.h>
#ifdef __cplusplus
extern "C" {
#endif
/* ======================================================================= */
/** Return the length of a string.
The length is equal to the number of 8-bit characters in the string,
without the terminating NUL character.
@param str
a null-terminated string.
@return
the length of the sequence of characters represented by this string,
excluding the terminating NUL character.
*/
sal_Int32 SAL_CALL rtl_str_getLength( const sal_Char * str ) SAL_THROW_EXTERN_C();
/** Compare two strings.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. This function
cannot be used for language-specific sorting. Both strings must be
null-terminated.
@param first
the first null-terminated string to be compared.
@param second
the second null-terminated string which is compared with the first one.
@return
0 if both strings are equal, a value less than 0 if the first string is
less than the second string, and a value greater than 0 if the first
string is greater than the second string.
*/
sal_Int32 SAL_CALL rtl_str_compare( const sal_Char * first, const sal_Char * second ) SAL_THROW_EXTERN_C();
/** Compare two strings.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. This function
cannot be used for language-specific sorting.
@param first
the first string to be compared. Need not be null-terminated, but must be
at least as long as the specified firstLen.
@param firstLen
the length of the first string.
@param second
the second string which is compared with the first one. Need not be
null-terminated, but must be at least as long as the specified secondLen.
@param secondLen
the length of the second string.
@return
0 if both strings are equal, a value less than 0 if the first string is
less than the second string, and a value greater than 0 if the first
string is greater than the second string.
*/
sal_Int32 SAL_CALL rtl_str_compare_WithLength( const sal_Char * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C();
/** Compare two strings with a maximum count of characters.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. This function
cannot be used for language-specific sorting.
@param first
the first string to be compared. Need not be null-terminated, but must be
at least as long as the specified firstLen.
@param firstLen
the length of the first string.
@param second
the second string which is compared with the first one. Need not be
null-terminated, but must be at least as long as the specified secondLen.
@param secondLen
the length of the second string.
@param shortenedLen
the maximum number of characters to compare. This length can be greater
or smaller than the lengths of the two strings.
@return
0 if both substrings are equal, a value less than 0 if the first substring
is less than the second substring, and a value greater than 0 if the first
substring is greater than the second substring.
*/
sal_Int32 SAL_CALL rtl_str_shortenedCompare_WithLength( const sal_Char * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C();
/** Compare two strings from back to front.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. This function
cannot be used for language-specific sorting.
@param first
the first string to be compared. Need not be null-terminated, but must be
at least as long as the specified firstLen.
@param firstLen
the length of the first string.
@param second
the second string which is compared with the first one. Need not be
null-terminated, but must be at least as long as the specified secondLen.
@param secondLen
the length of the second string.
@return
0 if both strings are equal, a value less than 0 if the first string
compares less than the second string, and a value greater than 0 if the
first string compares greater than the second string.
*/
sal_Int32 SAL_CALL rtl_str_reverseCompare_WithLength( const sal_Char * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C();
/** Compare two strings, ignoring the case of ASCII characters.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. Character
values between 65 and 90 (ASCII A--Z) are interpreted as values between 97
and 122 (ASCII a--z). This function cannot be used for language-specific
sorting. Both strings must be null-terminated.
@param first
the first null-terminated string to be compared.
@param second
the second null-terminated string which is compared with the first one.
@return
0 if both strings are equal, a value less than 0 if the first string is
less than the second string, and a value greater than 0 if the first
string is greater than the second string.
*/
sal_Int32 SAL_CALL rtl_str_compareIgnoreAsciiCase( const sal_Char * first, const sal_Char * second ) SAL_THROW_EXTERN_C();
/** Compare two strings, ignoring the case of ASCII characters.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. Character
values between 65 and 90 (ASCII A--Z) are interpreted as values between 97
and 122 (ASCII a--z). This function cannot be used for language-specific
sorting.
@param first
the first string to be compared. Need not be null-terminated, but must be
at least as long as the specified firstLen.
@param firstLen
the length of the first string.
@param second
the second string which is compared with the first one. Need not be
null-terminated, but must be at least as long as the specified secondLen.
@param secondLen
the length of the second string.
@return
0 if both strings are equal, a value less than 0 if the first string is
less than the second string, and a value greater than 0 if the first
string is greater than the second string.
*/
sal_Int32 SAL_CALL rtl_str_compareIgnoreAsciiCase_WithLength( const sal_Char * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen ) SAL_THROW_EXTERN_C();
/** Compare two strings with a maximum count of characters, ignoring the case
of ASCII characters.
The comparison is based on the numeric value of each character in the
strings and returns a value indicating their relationship. Character
values between 65 and 90 (ASCII A--Z) are interpreted as values between 97
and 122 (ASCII a--z). This function cannot be used for language-specific
sorting.
@param first
the first string to be compared. Need not be null-terminated, but must be
at least as long as the specified firstLen.
@param firstLen
the length of the first string.
@param second
the second string which is compared with the first one. Need not be
null-terminated, but must be at least as long as the specified secondLen.
@param secondLen
the length of the second string.
@param shortenedLen
the maximum number of characters to compare. This length can be greater
or smaller than the lengths of the two strings.
@return
0 if both substrings are equal, a value less than 0 if the first substring
is less than the second substring, and a value greater than 0 if the first
substring is greater than the second substring.
*/
sal_Int32 SAL_CALL rtl_str_shortenedCompareIgnoreAsciiCase_WithLength( const sal_Char * first, sal_Int32 firstLen, const sal_Char * second, sal_Int32 secondLen, sal_Int32 shortenedLen ) SAL_THROW_EXTERN_C();
/** Return a hash code for a string.
It is not allowed to store the hash code persistently, because later
versions could return other hash codes. The string must be
null-terminated.
@param str
a null-terminated string.
@return
a hash code for the given string.
*/
sal_Int32 SAL_CALL rtl_str_hashCode( const sal_Char * str ) SAL_THROW_EXTERN_C();
/** Return a hash code for a string.
It is not allowed to store the hash code persistently, because later
versions could return other hash codes.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@return
a hash code for the given string.
*/
sal_Int32 SAL_CALL rtl_str_hashCode_WithLength( const sal_Char * str, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Search for the first occurrence of a character within a string.
The string must be null-terminated.
@param str
a null-terminated string.
@param ch
the character to be searched for.
@return
the index (starting at 0) of the first occurrence of the character in the
string, or -1 if the character does not occur.
*/
sal_Int32 SAL_CALL rtl_str_indexOfChar( const sal_Char * str, sal_Char ch ) SAL_THROW_EXTERN_C();
/** Search for the first occurrence of a character within a string.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@param ch
the character to be searched for.
@return
the index (starting at 0) of the first occurrence of the character in the
string, or -1 if the character does not occur.
*/
sal_Int32 SAL_CALL rtl_str_indexOfChar_WithLength( const sal_Char * str, sal_Int32 len, sal_Char ch ) SAL_THROW_EXTERN_C();
/** Search for the last occurrence of a character within a string.
The string must be null-terminated.
@param str
a null-terminated string.
@param ch
the character to be searched for.
@return
the index (starting at 0) of the last occurrence of the character in the
string, or -1 if the character does not occur. The returned value is
always smaller than the string length.
*/
sal_Int32 SAL_CALL rtl_str_lastIndexOfChar( const sal_Char * str, sal_Char ch ) SAL_THROW_EXTERN_C();
/** Search for the last occurrence of a character within a string.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@param ch
the character to be searched for.
@return
the index (starting at 0) of the last occurrence of the character in the
string, or -1 if the character does not occur. The returned value is
always smaller than the string length.
*/
sal_Int32 SAL_CALL rtl_str_lastIndexOfChar_WithLength( const sal_Char * str, sal_Int32 len, sal_Char ch ) SAL_THROW_EXTERN_C();
/** Search for the first occurrence of a substring within a string.
If subStr is empty, or both str and subStr are empty, -1 is returned.
Both strings must be null-terminated.
@param str
a null-terminated string.
@param subStr
the null-terminated substring to be searched for.
@return
the index (starting at 0) of the first character of the first occurrence
of the substring within the string, or -1 if the substring does not occur.
*/
sal_Int32 SAL_CALL rtl_str_indexOfStr( const sal_Char * str, const sal_Char * subStr ) SAL_THROW_EXTERN_C();
/** Search for the first occurrence of a substring within a string.
If subStr is empty, or both str and subStr are empty, -1 is returned.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@param subStr
the substring to be searched for. Need not be null-terminated, but must
be at least as long as the specified subLen.
@param subLen
the length of the substring.
@return
the index (starting at 0) of the first character of the first occurrence
of the substring within the string, or -1 if the substring does not occur.
*/
sal_Int32 SAL_CALL rtl_str_indexOfStr_WithLength( const sal_Char * str, sal_Int32 len, const sal_Char * subStr, sal_Int32 subLen ) SAL_THROW_EXTERN_C();
/** Search for the last occurrence of a substring within a string.
If subStr is empty, or both str and subStr are empty, -1 is returned.
Both strings must be null-terminated.
@param str
a null-terminated string.
@param subStr
the null-terminated substring to be searched for.
@return
the index (starting at 0) of the first character of the last occurrence
of the substring within the string, or -1 if the substring does not occur.
*/
sal_Int32 SAL_CALL rtl_str_lastIndexOfStr( const sal_Char * str, const sal_Char * subStr ) SAL_THROW_EXTERN_C();
/** Search for the last occurrence of a substring within a string.
If subStr is empty, or both str and subStr are empty, -1 is returned.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@param subStr
the substring to be searched for. Need not be null-terminated, but must
be at least as long as the specified subLen.
@param subLen
the length of the substring.
@return
the index (starting at 0) of the first character of the first occurrence
of the substring within the string, or -1 if the substring does not occur.
*/
sal_Int32 SAL_CALL rtl_str_lastIndexOfStr_WithLength( const sal_Char * str, sal_Int32 len, const sal_Char * subStr, sal_Int32 subLen ) SAL_THROW_EXTERN_C();
/** Replace all occurrences of a single character within a string.
If oldChar does not occur within str, then the string is not modified.
The string must be null-terminated.
@param str
a null-terminated string.
@param oldChar
the old character.
@param newChar
the new character.
*/
void SAL_CALL rtl_str_replaceChar( sal_Char * str, sal_Char oldChar, sal_Char newChar ) SAL_THROW_EXTERN_C();
/** Replace all occurrences of a single character within a string.
If oldChar does not occur within str, then the string is not modified.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
@param oldChar
the old character.
@param newChar
the new character.
*/
void SAL_CALL rtl_str_replaceChar_WithLength( sal_Char * str, sal_Int32 len, sal_Char oldChar, sal_Char newChar ) SAL_THROW_EXTERN_C();
/** Convert all ASCII uppercase letters to lowercase within a string.
The characters with values between 65 and 90 (ASCII A--Z) are replaced
with values between 97 and 122 (ASCII a--z). The string must be
null-terminated.
@param str
a null-terminated string.
*/
void SAL_CALL rtl_str_toAsciiLowerCase( sal_Char * str ) SAL_THROW_EXTERN_C();
/** Convert all ASCII uppercase letters to lowercase within a string.
The characters with values between 65 and 90 (ASCII A--Z) are replaced
with values between 97 and 122 (ASCII a--z).
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
*/
void SAL_CALL rtl_str_toAsciiLowerCase_WithLength( sal_Char * str, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Convert all ASCII lowercase letters to uppercase within a string.
The characters with values between 97 and 122 (ASCII a--z) are replaced
with values between 65 and 90 (ASCII A--Z). The string must be
null-terminated.
@param str
a null-terminated string.
*/
void SAL_CALL rtl_str_toAsciiUpperCase( sal_Char * str ) SAL_THROW_EXTERN_C();
/** Convert all ASCII lowercase letters to uppercase within a string.
The characters with values between 97 and 122 (ASCII a--z) are replaced
with values between 65 and 90 (ASCII A--Z).
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the length of the string.
*/
void SAL_CALL rtl_str_toAsciiUpperCase_WithLength( sal_Char * str, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Remove white space from both ends of a string.
All characters with values less than or equal to 32 (the space character)
are considered to be white space. This function cannot be used for
language-specific operations. The string must be null-terminated.
@param str
a null-terminated string.
@return
the new length of the string.
*/
sal_Int32 SAL_CALL rtl_str_trim( sal_Char * str ) SAL_THROW_EXTERN_C();
/** Remove white space from both ends of the string.
All characters with values less than or equal to 32 (the space character)
are considered to be white space. This function cannot be used for
language-specific operations. The string must be null-terminated.
@param str
a string. Need not be null-terminated, but must be at least as long as
the specified len.
@param len
the original length of the string.
@return
the new length of the string.
*/
sal_Int32 SAL_CALL rtl_str_trim_WithLength( sal_Char * str, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Create the string representation of a boolean.
If b is true, the buffer is filled with the string "true" and 5 is
returned. If b is false, the buffer is filled with the string "false" and
6 is returned. This function cannot be used for language-specific
operations.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFBOOLEAN define to create
a buffer that is big enough.
@param b
a boolean value.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfBoolean( sal_Char * str, sal_Bool b ) SAL_THROW_EXTERN_C();
#define RTL_STR_MAX_VALUEOFBOOLEAN 6
/** Create the string representation of a character.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFCHAR define to create a
buffer that is big enough.
@param ch
a character value.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfChar( sal_Char * str, sal_Char ch ) SAL_THROW_EXTERN_C();
#define RTL_STR_MAX_VALUEOFCHAR 2
/** Create the string representation of an integer.
This function cannot be used for language-specific operations.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFINT32 define to create a
buffer that is big enough.
@param i
an integer value.
@param radix
the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX
(36), inclusive.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfInt32( sal_Char * str, sal_Int32 i, sal_Int16 radix ) SAL_THROW_EXTERN_C();
#define RTL_STR_MIN_RADIX 2
#define RTL_STR_MAX_RADIX 36
#define RTL_STR_MAX_VALUEOFINT32 33
/** Create the string representation of a long integer.
This function cannot be used for language-specific operations.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFINT64 define to create a
buffer that is big enough.
@param l
a long integer value.
@param radix
the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX
(36), inclusive.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfInt64( sal_Char * str, sal_Int64 l, sal_Int16 radix ) SAL_THROW_EXTERN_C();
#define RTL_STR_MAX_VALUEOFINT64 65
/** Create the string representation of a float.
This function cannot be used for language-specific conversion.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFFLOAT define to create a
buffer that is big enough.
@param f
a float value.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfFloat( sal_Char * str, float f ) SAL_THROW_EXTERN_C();
#define RTL_STR_MAX_VALUEOFFLOAT 15
/** Create the string representation of a double.
This function cannot be used for language-specific conversion.
@param str
a buffer that is big enough to hold the result and the terminating NUL
character. You should use the RTL_STR_MAX_VALUEOFDOUBLE define to create
a buffer that is big enough.
@param d
a double value.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_str_valueOfDouble( sal_Char * str, double d ) SAL_THROW_EXTERN_C();
#define RTL_STR_MAX_VALUEOFDOUBLE 25
/** Interpret a string as a boolean.
This function cannot be used for language-specific conversion. The string
must be null-terminated.
@param str
a null-terminated string.
@return
true if the string is "1" or "true" in any ASCII case, false otherwise.
*/
sal_Bool SAL_CALL rtl_str_toBoolean( const sal_Char * str ) SAL_THROW_EXTERN_C();
/** Interpret a string as an integer.
This function cannot be used for language-specific conversion. The string
must be null-terminated.
@param str
a null-terminated string.
@param radix
the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX
(36), inclusive.
@return
the integer value represented by the string, or 0 if the string does not
represent an integer.
*/
sal_Int32 SAL_CALL rtl_str_toInt32( const sal_Char * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();
/** Interpret a string as a long integer.
This function cannot be used for language-specific conversion. The string
must be null-terminated.
@param str
a null-terminated string.
@param radix
the radix. Must be between RTL_STR_MIN_RADIX (2) and RTL_STR_MAX_RADIX
(36), inclusive.
@return
the long integer value represented by the string, or 0 if the string does
not represent a long integer.
*/
sal_Int64 SAL_CALL rtl_str_toInt64( const sal_Char * str, sal_Int16 radix ) SAL_THROW_EXTERN_C();
/** Interpret a string as a float.
This function cannot be used for language-specific conversion. The string
must be null-terminated.
@param str
a null-terminated string.
@return
the float value represented by the string, or 0.0 if the string does not
represent a float.
*/
float SAL_CALL rtl_str_toFloat( const sal_Char * str ) SAL_THROW_EXTERN_C();
/** Interpret a string as a double.
This function cannot be used for language-specific conversion. The string
must be null-terminated.
@param str
a null-terminated string.
@return
the float value represented by the string, or 0.0 if the string does not
represent a double.
*/
double SAL_CALL rtl_str_toDouble( const sal_Char * str ) SAL_THROW_EXTERN_C();
/* ======================================================================= */
#ifdef SAL_W32
# pragma pack(push, 8)
#endif
/** The implementation of a byte string.
@internal
*/
typedef struct _rtl_String
{
oslInterlockedCount refCount; /* opaque */
sal_Int32 length;
sal_Char buffer[1];
} rtl_String;
#if defined(SAL_W32)
#pragma pack(pop)
#endif
/* ----------------------------------------------------------------------- */
/** Increment the reference count of a string.
@param str
a string.
*/
void SAL_CALL rtl_string_acquire( rtl_String * str ) SAL_THROW_EXTERN_C();
/** Decrement the reference count of a string.
If the count goes to zero than the string data is deleted.
@param str
a string.
*/
void SAL_CALL rtl_string_release( rtl_String * str ) SAL_THROW_EXTERN_C();
/** Allocate a new string containing no characters.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
*/
void SAL_CALL rtl_string_new( rtl_String ** newStr ) SAL_THROW_EXTERN_C();
/** Allocate a new string containing space for a given number of characters.
If len is greater than zero, the reference count of the new string will be
1. The values of all characters are set to 0 and the length of the string
is 0. This function does not handle out-of-memory conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param len
the number of characters.
*/
void SAL_CALL rtl_string_new_WithLength( rtl_String ** newStr, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Allocate a new string that contains a copy of another string.
If the length of value is greater than zero, the reference count of the
new string will be 1. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param value
a valid string.
*/
void SAL_CALL rtl_string_newFromString( rtl_String ** newStr, const rtl_String * value ) SAL_THROW_EXTERN_C();
/** Allocate a new string that contains a copy of a character array.
If the length of value is greater than zero, the reference count of the
new string will be 1. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param value
a null-terminated character array.
*/
void SAL_CALL rtl_string_newFromStr( rtl_String ** newStr, const sal_Char * value ) SAL_THROW_EXTERN_C();
/** Allocate a new string that contains a copy of a character array.
If the length of value is greater than zero, the reference count of the
new string will be 1. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param value
a character array. Need not be null-terminated, but must be at least as
long as the specified len.
@param len
the length of the character array.
*/
void SAL_CALL rtl_string_newFromStr_WithLength( rtl_String ** newStr, const sal_Char * value, sal_Int32 len ) SAL_THROW_EXTERN_C();
/** Assign a new value to a string.
First releases any value str might currently hold, then acquires
rightValue.
@param str
pointer to the string. The pointed-to data must be null or a valid
string.
@param rightValue
a valid string.
*/
void SAL_CALL rtl_string_assign( rtl_String ** str, rtl_String * rightValue ) SAL_THROW_EXTERN_C();
/** Return the length of a string.
The length is equal to the number of characters in the string.
@param str
a valid string.
@return
the length of the string.
*/
sal_Int32 SAL_CALL rtl_string_getLength( const rtl_String * str ) SAL_THROW_EXTERN_C();
/** Return a pointer to the underlying character array of a string.
@param str
a valid string.
@return
a pointer to the null-terminated character array.
*/
sal_Char * SAL_CALL rtl_string_getStr( rtl_String * str ) SAL_THROW_EXTERN_C();
/** Create a new string that is the concatenation of two other strings.
The new string does not necessarily have a reference count of 1 (in cases
where one of the two other strings is empty), so it must not be modified
without checking the reference count. This function does not handle
out-of-memory conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param left
a valid string.
@param right
a valid string.
*/
void SAL_CALL rtl_string_newConcat( rtl_String ** newStr, rtl_String * left, rtl_String * right ) SAL_THROW_EXTERN_C();
/** Create a new string by replacing a substring of another string.
The new string results from replacing a number of characters (count),
starting at the specified position (index) in the original string (str),
with some new substring (subStr). If subStr is null, than only a number
of characters is deleted.
The new string does not necessarily have a reference count of 1, so it
must not be modified without checking the reference count. This function
does not handle out-of-memory conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a valid string.
@param index
the index into str at which to start replacement. Must be between 0 and
the length of str, inclusive.
@param count
the number of charcters to remove. Must not be negative, and the sum of
index and count must not exceed the length of str.
@param subStr
either null or a valid string to be inserted.
*/
void SAL_CALL rtl_string_newReplaceStrAt( rtl_String ** newStr, rtl_String * str, sal_Int32 idx, sal_Int32 count, rtl_String * subStr ) SAL_THROW_EXTERN_C();
/** Create a new string by replacing all occurrences of a single character
within another string.
The new string results from replacing all occurrences of oldChar in str
with newChar.
The new string does not necessarily have a reference count of 1 (in cases
where oldChar does not occur in str), so it must not be modified without
checking the reference count. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a valid string.
@param oldChar
the old character.
@param newChar
the new character.
*/
void SAL_CALL rtl_string_newReplace( rtl_String ** newStr, rtl_String * str, sal_Char oldChar, sal_Char newChar ) SAL_THROW_EXTERN_C();
/** Create a new string by converting all ASCII uppercase letters to lowercase
within another string.
The new string results from replacing all characters with values between
65 and 90 (ASCII A--Z) by values between 97 and 122 (ASCII a--z).
This function cannot be used for language-specific conversion. The new
string does not necessarily have a reference count of 1 (in cases where
no characters need to be converted), so it must not be modified without
checking the reference count. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a valid string.
*/
void SAL_CALL rtl_string_newToAsciiLowerCase( rtl_String ** newStr, rtl_String * str ) SAL_THROW_EXTERN_C();
/** Create a new string by converting all ASCII lowercase letters to uppercase
within another string.
The new string results from replacing all characters with values between
97 and 122 (ASCII a--z) by values between 65 and 90 (ASCII A--Z).
This function cannot be used for language-specific conversion. The new
string does not necessarily have a reference count of 1 (in cases where
no characters need to be converted), so it must not be modified without
checking the reference count. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a valid string.
*/
void SAL_CALL rtl_string_newToAsciiUpperCase( rtl_String ** newStr, rtl_String * str ) SAL_THROW_EXTERN_C();
/** Create a new string by removing white space from both ends of another
string.
The new string results from removing all characters with values less than
or equal to 32 (the space character) form both ends of str.
This function cannot be used for language-specific conversion. The new
string does not necessarily have a reference count of 1 (in cases where
no characters need to be removed), so it must not be modified without
checking the reference count. This function does not handle out-of-memory
conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a valid string.
*/
void SAL_CALL rtl_string_newTrim( rtl_String ** newStr, rtl_String * str ) SAL_THROW_EXTERN_C();
/** Create a new string by extracting a single token from another string.
Starting at index, the token's next token is searched for. If there is no
such token, the result is an empty string. Otherwise, all characters from
the start of that token and up to, but not including the next occurrence
of cTok make up the resulting token. The return value is the position of
the next token, or -1 if no more tokens follow.
Example code could look like
rtl_String * pToken = NULL;
sal_Int32 nIndex = 0;
do
{
...
nIndex = rtl_string_getToken(&pToken, pStr, 0, ';', nIndex);
...
}
while (nIndex >= 0);
The new string does not necessarily have a reference count of 1, so it
must not be modified without checking the reference count. This function
does not handle out-of-memory conditions.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string. If either token or index is negative, an empty token is stored in
newStr (and -1 is returned).
@param str
a valid string.
@param token
the number of the token to return, starting at index.
@param cTok
the character that seperates the tokens.
@param index
the position at which searching for the token starts. Must not be greater
than the length of str.
@return
the index of the next token, or -1 if no more tokens follow.
*/
sal_Int32 SAL_CALL rtl_string_getToken( rtl_String ** newStr , rtl_String * str, sal_Int32 token, sal_Char cTok, sal_Int32 idx ) SAL_THROW_EXTERN_C();
/* ======================================================================= */
/** Supply an ASCII string literal together with its length.
This macro can be used to compute (some of) the arguments in function calls
like rtl::OString(RTL_CONSTASCII_STRINGPARAM("foo")) or
rtl::OUString::equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("foo")).
@param constAsciiStr
must be an expression of type "(possibly cv-qualified reference to) array of
(possibly cv-qualified) char." Each element of the referenced array must
represent an ASCII value in the range 0x00--0x7F. The last element of the
referenced array is not considered part of the represented ASCII string, and
its value should be 0x00. Depending on where this macro is used, the nature
of the supplied expression might be further restricted.
*/
#define RTL_CONSTASCII_STRINGPARAM( constAsciiStr ) constAsciiStr, ((sal_Int32)SAL_N_ELEMENTS(constAsciiStr)-1)
/** Supply the length of an ASCII string literal.
This macro can be used to compute arguments in function calls like
rtl::OUString::match(other, RTL_CONSTASCII_LENGTH("prefix")).
@param constAsciiStr
must be an expression of type "(possibly cv-qualified reference to) array of
(possibly cv-qualified) char." Each element of the referenced array must
represent an ASCII value in the range 0x00--0x7F. The last element of the
referenced array is not considered part of the represented ASCII string, and
its value should be 0x00. Depending on where this macro is used, the nature
of the supplied expression might be further restricted.
*/
#define RTL_CONSTASCII_LENGTH( constAsciiStr ) ((sal_Int32)(SAL_N_ELEMENTS(constAsciiStr)-1))
/* ======================================================================= */
/* predefined constants for String-Conversion */
#define OUSTRING_TO_OSTRING_CVTFLAGS (RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT |\
RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT |\
RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACE |\
RTL_UNICODETOTEXT_FLAGS_PRIVATE_MAPTO0 |\
RTL_UNICODETOTEXT_FLAGS_NOCOMPOSITE)
/* ----------------------------------------------------------------------- */
/** Create a new byte string by converting a Unicode string, using a specific
text encoding.
The lengths of the byte string and the Unicode string may differ (e.g.,
for double-byte encodings, UTF-7, UTF-8).
If the length of the Unicode string is greater than zero, the reference
count of the new string will be 1.
If an out-of-memory condition occurs, newStr will point to a null pointer
upon return.
@param newStr
pointer to the new string. The pointed-to data must be null or a valid
string.
@param str
a Unicode character array. Need not be null-terminated, but must be at
least as long as the specified len.
@param len
the length of the Unicode character array.
@param encoding
the text encoding to use for conversion.
@param convertFlags
flags which control the conversion. Either use
OUSTRING_TO_OSTRING_CVTFLAGS, or see
<http://udk.openoffice.org/cpp/man/spec/textconversion.html> for more
details.
*/
void SAL_CALL rtl_uString2String( rtl_String ** newStr, const sal_Unicode * str, sal_Int32 len, rtl_TextEncoding encoding, sal_uInt32 convertFlags ) SAL_THROW_EXTERN_C();
/**
Converts a Unicode string to a byte string, signalling failure.
@param pTarget
An out parameter receiving the converted string. Must not be null itself, and
must contain either null or a pointer to a valid rtl_String; the contents are
not modified if conversion fails (rtl_convertUStringToString returns false).
@param pSource
The Unicode string. May only be null if nLength is zero.
@param nLength
The length of the Unicode string. Must be non-negative.
@param nEncoding
The text encoding to convert into. Must be an octet encoding (i.e.,
rtl_isOctetTextEncoding(nEncoding) must return true).
@param nFlags
A combination of RTL_UNICODETOTEXT_FLAGS that detail how to do the conversion
(see rtl_convertUnicodeToText). RTL_UNICODETOTEXT_FLAGS_FLUSH need not be
included, it is implicitly assumed. Typical uses are either
RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR |
RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR (fail if a Unicode character cannot be
converted to the target nEncoding) or OUSTRING_TO_OSTRING_CVTFLAGS (make a
best efforts conversion).
@return
True if the conversion succeeded, false otherwise.
*/
sal_Bool SAL_CALL rtl_convertUStringToString(rtl_String ** pTarget,
sal_Unicode const * pSource,
sal_Int32 nLength,
rtl_TextEncoding nEncoding,
sal_uInt32 nFlags)
SAL_THROW_EXTERN_C();
#ifdef __cplusplus
}
#endif
#endif /* _RTL_STRING_H_ */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|