summaryrefslogtreecommitdiffstats
path: root/xpcom/glue/nsStringAPI.h
blob: d5e36869573262c33884cd0a268c359fd3d22042 (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
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
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * This header provides wrapper classes around the frozen string API
 * which are roughly equivalent to the internal string classes.
 */

#ifdef MOZILLA_INTERNAL_API
#error nsStringAPI.h is only usable from non-MOZILLA_INTERNAL_API code!
#endif

#ifndef nsStringAPI_h__
#define nsStringAPI_h__

#include "mozilla/Attributes.h"
#include "mozilla/Char16.h"

#include "nsXPCOMStrings.h"
#include "nsISupportsImpl.h"
#include "mozilla/Logging.h"
#include "nsTArray.h"

/**
 * Comparison function for use with nsACString::Equals
 */
NS_HIDDEN_(int32_t) CaseInsensitiveCompare(const char* aStrA, const char* aStrB,
                                           uint32_t aLength);

class nsAString
{
public:
  typedef char16_t  char_type;
  typedef nsAString self_type;
  typedef uint32_t  size_type;
  typedef uint32_t  index_type;

  /**
   * Returns the length, beginning, and end of a string in one operation.
   */
  NS_HIDDEN_(uint32_t) BeginReading(const char_type** aBegin,
                                    const char_type** aEnd = nullptr) const;

  NS_HIDDEN_(const char_type*) BeginReading() const;
  NS_HIDDEN_(const char_type*) EndReading() const;

  NS_HIDDEN_(char_type) CharAt(uint32_t aPos) const
  {
    NS_ASSERTION(aPos < Length(), "Out of bounds");
    return BeginReading()[aPos];
  }
  NS_HIDDEN_(char_type) operator [](uint32_t aPos) const
  {
    return CharAt(aPos);
  }
  NS_HIDDEN_(char_type) First() const
  {
    return CharAt(0);
  }
  NS_HIDDEN_(char_type) Last() const
  {
    const char_type* data;
    uint32_t dataLen = NS_StringGetData(*this, &data);
    return data[dataLen - 1];
  }

  /**
   * Get the length, begin writing, and optionally set the length of a
   * string all in one operation.
   *
   * @param   newSize Size the string to this length. Pass UINT32_MAX
   *                  to leave the length unchanged.
   * @return  The new length of the string, or 0 if resizing failed.
   */
  NS_HIDDEN_(uint32_t) BeginWriting(char_type** aBegin,
                                    char_type** aEnd = nullptr,
                                    uint32_t aNewSize = UINT32_MAX);

  NS_HIDDEN_(char_type*) BeginWriting(uint32_t = UINT32_MAX);
  NS_HIDDEN_(char_type*) EndWriting();

  NS_HIDDEN_(bool) SetLength(uint32_t aLen);

  NS_HIDDEN_(size_type) Length() const
  {
    const char_type* data;
    return NS_StringGetData(*this, &data);
  }

  NS_HIDDEN_(bool) IsEmpty() const { return Length() == 0; }

  NS_HIDDEN_(void) SetIsVoid(bool aVal) { NS_StringSetIsVoid(*this, aVal); }
  NS_HIDDEN_(bool) IsVoid() const { return NS_StringGetIsVoid(*this); }

  NS_HIDDEN_(void) Assign(const self_type& aString)
  {
    NS_StringCopy(*this, aString);
  }
  NS_HIDDEN_(void) Assign(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_StringSetData(*this, aData, aLength);
  }
  NS_HIDDEN_(void) Assign(char_type aChar)
  {
    NS_StringSetData(*this, &aChar, 1);
  }
#ifdef MOZ_USE_CHAR16_WRAPPER
  NS_HIDDEN_(void) Assign(char16ptr_t aData, size_type aLength = UINT32_MAX)
  {
    NS_StringSetData(*this, aData, aLength);
  }
#endif

  NS_HIDDEN_(void) AssignLiteral(const char* aStr);
  NS_HIDDEN_(void) AssignASCII(const char* aStr)
  {
    AssignLiteral(aStr);
  }

  NS_HIDDEN_(self_type&) operator=(const self_type& aString)
  {
    Assign(aString);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator=(const char_type* aPtr)
  {
    Assign(aPtr);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator=(char_type aChar)
  {
    Assign(aChar);
    return *this;
  }
#ifdef MOZ_USE_CHAR16_WRAPPER
  NS_HIDDEN_(self_type&) operator=(char16ptr_t aPtr)
  {
    Assign(aPtr);
    return *this;
  }
#endif

  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           const char_type* aData,
                           size_type aLength = size_type(-1))
  {
    NS_StringSetDataRange(*this, aCutStart, aCutLength, aData, aLength);
  }
  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           char_type aChar)
  {
    Replace(aCutStart, aCutLength, &aChar, 1);
  }
  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           const self_type& aReadable)
  {
    const char_type* data;
    uint32_t dataLen = NS_StringGetData(aReadable, &data);
    NS_StringSetDataRange(*this, aCutStart, aCutLength, data, dataLen);
  }
  NS_HIDDEN_(void) SetCharAt(char_type aChar, index_type aPos)
  {
    Replace(aPos, 1, &aChar, 1);
  }

  NS_HIDDEN_(void) Append(char_type aChar)
  {
    Replace(size_type(-1), 0, aChar);
  }
  NS_HIDDEN_(void) Append(const char_type* aData,
                          size_type aLength = size_type(-1))
  {
    Replace(size_type(-1), 0, aData, aLength);
  }
#ifdef MOZ_USE_CHAR16_WRAPPER
  NS_HIDDEN_(void) Append(char16ptr_t aData, size_type aLength = size_type(-1))
  {
    Append(static_cast<const char16_t*>(aData), aLength);
  }
#endif
  NS_HIDDEN_(void) Append(const self_type& aReadable)
  {
    Replace(size_type(-1), 0, aReadable);
  }
  NS_HIDDEN_(void) AppendLiteral(const char* aASCIIStr);
  NS_HIDDEN_(void) AppendASCII(const char* aASCIIStr)
  {
    AppendLiteral(aASCIIStr);
  }

  NS_HIDDEN_(self_type&) operator+=(char_type aChar)
  {
    Append(aChar);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator+=(const char_type* aData)
  {
    Append(aData);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator+=(const self_type& aReadable)
  {
    Append(aReadable);
    return *this;
  }

  NS_HIDDEN_(void) Insert(char_type aChar, index_type aPos)
  {
    Replace(aPos, 0, aChar);
  }
  NS_HIDDEN_(void) Insert(const char_type* aData, index_type aPos,
                          size_type aLength = size_type(-1))
  {
    Replace(aPos, 0, aData, aLength);
  }
  NS_HIDDEN_(void) Insert(const self_type& aReadable, index_type aPos)
  {
    Replace(aPos, 0, aReadable);
  }

  NS_HIDDEN_(void) Cut(index_type aCutStart, size_type aCutLength)
  {
    Replace(aCutStart, aCutLength, nullptr, 0);
  }

  NS_HIDDEN_(void) Truncate(size_type aNewLength = 0)
  {
    NS_ASSERTION(aNewLength <= Length(), "Truncate cannot make string longer");
    SetLength(aNewLength);
  }

  /**
   * Remove all occurences of characters in aSet from the string.
   */
  NS_HIDDEN_(void) StripChars(const char* aSet);

  /**
   * Strip whitespace characters from the string.
   */
  NS_HIDDEN_(void) StripWhitespace() { StripChars("\b\t\r\n "); }

  NS_HIDDEN_(void) Trim(const char* aSet, bool aLeading = true,
                        bool aTrailing = true);

  /**
   * Compare strings of characters. Return 0 if the characters are equal,
   */
  typedef int32_t (*ComparatorFunc)(const char_type* aStrA,
                                    const char_type* aStrB,
                                    uint32_t aLength);

  static NS_HIDDEN_(int32_t) DefaultComparator(const char_type* aStrA,
                                               const char_type* aStrB,
                                               uint32_t aLength);

  NS_HIDDEN_(int32_t) Compare(const char_type* aOther,
                              ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(int32_t) Compare(const self_type& aOther,
                              ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) Equals(const char_type* aOther,
                          ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) Equals(const self_type& aOther,
                          ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) operator<(const self_type& aOther) const
  {
    return Compare(aOther) < 0;
  }
  NS_HIDDEN_(bool) operator<(const char_type* aOther) const
  {
    return Compare(aOther) < 0;
  }

  NS_HIDDEN_(bool) operator<=(const self_type& aOther) const
  {
    return Compare(aOther) <= 0;
  }
  NS_HIDDEN_(bool) operator<=(const char_type* aOther) const
  {
    return Compare(aOther) <= 0;
  }

  NS_HIDDEN_(bool) operator==(const self_type& aOther) const
  {
    return Equals(aOther);
  }
  NS_HIDDEN_(bool) operator==(const char_type* aOther) const
  {
    return Equals(aOther);
  }
#ifdef MOZ_USE_CHAR16_WRAPPER
  NS_HIDDEN_(bool) operator==(char16ptr_t aOther) const
  {
    return Equals(aOther);
  }
#endif

  NS_HIDDEN_(bool) operator>=(const self_type& aOther) const
  {
    return Compare(aOther) >= 0;
  }
  NS_HIDDEN_(bool) operator>=(const char_type* aOther) const
  {
    return Compare(aOther) >= 0;
  }

  NS_HIDDEN_(bool) operator>(const self_type& aOther) const
  {
    return Compare(aOther) > 0;
  }
  NS_HIDDEN_(bool) operator>(const char_type* aOther) const
  {
    return Compare(aOther) > 0;
  }

  NS_HIDDEN_(bool) operator!=(const self_type& aOther) const
  {
    return !Equals(aOther);
  }
  NS_HIDDEN_(bool) operator!=(const char_type* aOther) const
  {
    return !Equals(aOther);
  }

  NS_HIDDEN_(bool) EqualsLiteral(const char* aASCIIString) const;
  NS_HIDDEN_(bool) EqualsASCII(const char* aASCIIString) const
  {
    return EqualsLiteral(aASCIIString);
  }

  /**
   * Case-insensitive match this string to a lowercase ASCII string.
   */
  NS_HIDDEN_(bool) LowerCaseEqualsLiteral(const char* aASCIIString) const;

  /**
   * Find the first occurrence of aStr in this string.
   *
   * @return the offset of aStr, or -1 if not found
   */
  NS_HIDDEN_(int32_t) Find(const self_type& aStr,
                           ComparatorFunc aComparator = DefaultComparator) const
  {
    return Find(aStr, 0, aComparator);
  }

  /**
   * Find the first occurrence of aStr in this string, beginning at aOffset.
   *
   * @return the offset of aStr, or -1 if not found
   */
  NS_HIDDEN_(int32_t) Find(const self_type& aStr, uint32_t aOffset,
                           ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find an ASCII string within this string.
   *
   * @return the offset of aStr, or -1 if not found.
   */
  NS_HIDDEN_(int32_t) Find(const char* aStr, bool aIgnoreCase = false) const
  {
    return Find(aStr, 0, aIgnoreCase);
  }

  NS_HIDDEN_(int32_t) Find(const char* aStr, uint32_t aOffset,
                           bool aIgnoreCase = false) const;

  /**
   * Find the last occurrence of aStr in this string.
   *
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const self_type& aStr,
                            ComparatorFunc aComparator = DefaultComparator) const
  {
    return RFind(aStr, -1, aComparator);
  }

  /**
   * Find the last occurrence of aStr in this string, beginning at aOffset.
   *
   * @param aOffset the offset from the beginning of the string to begin
   *        searching. If aOffset < 0, search from end of this string.
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const self_type& aStr, int32_t aOffset,
                            ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find the last occurrence of an ASCII string within this string.
   *
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const char* aStr, bool aIgnoreCase = false) const
  {
    return RFind(aStr, -1, aIgnoreCase);
  }

  /**
   * Find the last occurrence of an ASCII string beginning at aOffset.
   *
   * @param aOffset the offset from the beginning of the string to begin
   *        searching. If aOffset < 0, search from end of this string.
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const char* aStr, int32_t aOffset,
                            bool aIgnoreCase) const;

  /**
   * Search for the offset of the first occurrence of a character in a
   * string.
   *
   * @param aOffset the offset from the beginning of the string to begin
   *        searching
   * @return The offset of the character from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) FindChar(char_type aChar, uint32_t aOffset = 0) const;

  /**
   * Search for the offset of the last occurrence of a character in a
   * string.
   *
   * @return The offset of the character from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFindChar(char_type aChar) const;

  /**
   * Append a string representation of a number.
   */
  NS_HIDDEN_(void) AppendInt(int aInt, int32_t aRadix = 10);

#ifndef XPCOM_GLUE_AVOID_NSPR
  /**
   * Convert this string to an integer.
   *
   * @param aErrorCode pointer to contain result code.
   * @param aRadix must be 10 or 16
   */
  NS_HIDDEN_(int32_t) ToInteger(nsresult* aErrorCode,
                                uint32_t aRadix = 10) const;
  /**
   * Convert this string to a 64-bit integer.
   *
   * @param aErrorCode pointer to contain result code.
   * @param aRadix must be 10 or 16
   */
  NS_HIDDEN_(int64_t) ToInteger64(nsresult* aErrorCode,
                                  uint32_t aRadix = 10) const;
#endif // XPCOM_GLUE_AVOID_NSPR

protected:
  // Prevent people from allocating a nsAString directly.
  ~nsAString() {}
};

class nsACString
{
public:
  typedef char       char_type;
  typedef nsACString self_type;
  typedef uint32_t   size_type;
  typedef uint32_t   index_type;

  /**
   * Returns the length, beginning, and end of a string in one operation.
   */
  NS_HIDDEN_(uint32_t) BeginReading(const char_type** aBegin,
                                    const char_type** aEnd = nullptr) const;

  NS_HIDDEN_(const char_type*) BeginReading() const;
  NS_HIDDEN_(const char_type*) EndReading() const;

  NS_HIDDEN_(char_type) CharAt(uint32_t aPos) const
  {
    NS_ASSERTION(aPos < Length(), "Out of bounds");
    return BeginReading()[aPos];
  }
  NS_HIDDEN_(char_type) operator [](uint32_t aPos) const
  {
    return CharAt(aPos);
  }
  NS_HIDDEN_(char_type) First() const
  {
    return CharAt(0);
  }
  NS_HIDDEN_(char_type) Last() const
  {
    const char_type* data;
    uint32_t dataLen = NS_CStringGetData(*this, &data);
    return data[dataLen - 1];
  }

  /**
   * Get the length, begin writing, and optionally set the length of a
   * string all in one operation.
   *
   * @param   newSize Size the string to this length. Pass UINT32_MAX
   *                  to leave the length unchanged.
   * @return  The new length of the string, or 0 if resizing failed.
   */
  NS_HIDDEN_(uint32_t) BeginWriting(char_type** aBegin,
                                    char_type** aEnd = nullptr,
                                    uint32_t aNewSize = UINT32_MAX);

  NS_HIDDEN_(char_type*) BeginWriting(uint32_t aLen = UINT32_MAX);
  NS_HIDDEN_(char_type*) EndWriting();

  NS_HIDDEN_(bool) SetLength(uint32_t aLen);

  NS_HIDDEN_(size_type) Length() const
  {
    const char_type* data;
    return NS_CStringGetData(*this, &data);
  }

  NS_HIDDEN_(bool) IsEmpty() const { return Length() == 0; }

  NS_HIDDEN_(void) SetIsVoid(bool aVal) { NS_CStringSetIsVoid(*this, aVal); }
  NS_HIDDEN_(bool) IsVoid() const { return NS_CStringGetIsVoid(*this); }

  NS_HIDDEN_(void) Assign(const self_type& aString)
  {
    NS_CStringCopy(*this, aString);
  }
  NS_HIDDEN_(void) Assign(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_CStringSetData(*this, aData, aLength);
  }
  NS_HIDDEN_(void) Assign(char_type aChar)
  {
    NS_CStringSetData(*this, &aChar, 1);
  }
  NS_HIDDEN_(void) AssignLiteral(const char_type* aData)
  {
    Assign(aData);
  }
  NS_HIDDEN_(void) AssignASCII(const char_type* aData)
  {
    Assign(aData);
  }

  NS_HIDDEN_(self_type&) operator=(const self_type& aString)
  {
    Assign(aString);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator=(const char_type* aPtr)
  {
    Assign(aPtr);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator=(char_type aChar)
  {
    Assign(aChar);
    return *this;
  }

  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           const char_type* aData,
                           size_type aLength = size_type(-1))
  {
    NS_CStringSetDataRange(*this, aCutStart, aCutLength, aData, aLength);
  }
  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           char_type aChar)
  {
    Replace(aCutStart, aCutLength, &aChar, 1);
  }
  NS_HIDDEN_(void) Replace(index_type aCutStart, size_type aCutLength,
                           const self_type& aReadable)
  {
    const char_type* data;
    uint32_t dataLen = NS_CStringGetData(aReadable, &data);
    NS_CStringSetDataRange(*this, aCutStart, aCutLength, data, dataLen);
  }
  NS_HIDDEN_(void) SetCharAt(char_type aChar, index_type aPos)
  {
    Replace(aPos, 1, &aChar, 1);
  }

  NS_HIDDEN_(void) Append(char_type aChar)
  {
    Replace(size_type(-1), 0, aChar);
  }
  NS_HIDDEN_(void) Append(const char_type* aData,
                          size_type aLength = size_type(-1))
  {
    Replace(size_type(-1), 0, aData, aLength);
  }
  NS_HIDDEN_(void) Append(const self_type& aReadable)
  {
    Replace(size_type(-1), 0, aReadable);
  }
  NS_HIDDEN_(void) AppendLiteral(const char* aASCIIStr)
  {
    Append(aASCIIStr);
  }
  NS_HIDDEN_(void) AppendASCII(const char* aASCIIStr)
  {
    Append(aASCIIStr);
  }

  NS_HIDDEN_(self_type&) operator+=(char_type aChar)
  {
    Append(aChar);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator+=(const char_type* aData)
  {
    Append(aData);
    return *this;
  }
  NS_HIDDEN_(self_type&) operator+=(const self_type& aReadable)
  {
    Append(aReadable);
    return *this;
  }

  NS_HIDDEN_(void) Insert(char_type aChar, index_type aPos)
  {
    Replace(aPos, 0, aChar);
  }
  NS_HIDDEN_(void) Insert(const char_type* aData, index_type aPos,
                          size_type aLength = size_type(-1))
  {
    Replace(aPos, 0, aData, aLength);
  }
  NS_HIDDEN_(void) Insert(const self_type& aReadable, index_type aPos)
  {
    Replace(aPos, 0, aReadable);
  }

  NS_HIDDEN_(void) Cut(index_type aCutStart, size_type aCutLength)
  {
    Replace(aCutStart, aCutLength, nullptr, 0);
  }

  NS_HIDDEN_(void) Truncate(size_type aNewLength = 0)
  {
    NS_ASSERTION(aNewLength <= Length(), "Truncate cannot make string longer");
    SetLength(aNewLength);
  }

  /**
   * Remove all occurences of characters in aSet from the string.
   */
  NS_HIDDEN_(void) StripChars(const char* aSet);

  /**
   * Strip whitespace characters from the string.
   */
  NS_HIDDEN_(void) StripWhitespace() { StripChars("\b\t\r\n "); }

  NS_HIDDEN_(void) Trim(const char* aSet, bool aLeading = true,
                        bool aTrailing = true);

  /**
   * Compare strings of characters. Return 0 if the characters are equal,
   */
  typedef int32_t (*ComparatorFunc)(const char_type* a,
                                    const char_type* b,
                                    uint32_t length);

  static NS_HIDDEN_(int32_t) DefaultComparator(const char_type* aStrA,
                                               const char_type* aStrB,
                                               uint32_t aLength);

  NS_HIDDEN_(int32_t) Compare(const char_type* aOther,
                              ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(int32_t) Compare(const self_type& aOther,
                              ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) Equals(const char_type* aOther,
                          ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) Equals(const self_type& aOther,
                          ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(bool) operator<(const self_type& aOther) const
  {
    return Compare(aOther) < 0;
  }
  NS_HIDDEN_(bool) operator<(const char_type* aOther) const
  {
    return Compare(aOther) < 0;
  }

  NS_HIDDEN_(bool) operator<=(const self_type& aOther) const
  {
    return Compare(aOther) <= 0;
  }
  NS_HIDDEN_(bool) operator<=(const char_type* aOther) const
  {
    return Compare(aOther) <= 0;
  }

  NS_HIDDEN_(bool) operator==(const self_type& aOther) const
  {
    return Equals(aOther);
  }
  NS_HIDDEN_(bool) operator==(const char_type* aOther) const
  {
    return Equals(aOther);
  }

  NS_HIDDEN_(bool) operator>=(const self_type& aOther) const
  {
    return Compare(aOther) >= 0;
  }
  NS_HIDDEN_(bool) operator>=(const char_type* aOther) const
  {
    return Compare(aOther) >= 0;
  }

  NS_HIDDEN_(bool) operator>(const self_type& aOther) const
  {
    return Compare(aOther) > 0;
  }
  NS_HIDDEN_(bool) operator>(const char_type* aOther) const
  {
    return Compare(aOther) > 0;
  }

  NS_HIDDEN_(bool) operator!=(const self_type& aOther) const
  {
    return !Equals(aOther);
  }
  NS_HIDDEN_(bool) operator!=(const char_type* aOther) const
  {
    return !Equals(aOther);
  }

  NS_HIDDEN_(bool) EqualsLiteral(const char_type* aOther) const
  {
    return Equals(aOther);
  }
  NS_HIDDEN_(bool) EqualsASCII(const char_type* aOther) const
  {
    return Equals(aOther);
  }

  /**
   * Case-insensitive match this string to a lowercase ASCII string.
   */
  NS_HIDDEN_(bool) LowerCaseEqualsLiteral(const char* aASCIIString) const
  {
    return Equals(aASCIIString, CaseInsensitiveCompare);
  }

  /**
   * Find the first occurrence of aStr in this string.
   *
   * @return the offset of aStr, or -1 if not found
   */
  NS_HIDDEN_(int32_t) Find(const self_type& aStr,
                           ComparatorFunc aComparator = DefaultComparator) const
  {
    return Find(aStr, 0, aComparator);
  }

  /**
   * Find the first occurrence of aStr in this string, beginning at aOffset.
   *
   * @return the offset of aStr, or -1 if not found
   */
  NS_HIDDEN_(int32_t) Find(const self_type& aStr, uint32_t aOffset,
                           ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find the first occurrence of aStr in this string.
   *
   * @return the offset of aStr, or -1 if not found
   */
  NS_HIDDEN_(int32_t) Find(const char_type* aStr,
                           ComparatorFunc aComparator = DefaultComparator) const;

  NS_HIDDEN_(int32_t) Find(const char_type* aStr, uint32_t aLen,
                           ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find the last occurrence of aStr in this string.
   *
   * @return The offset of the character from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const self_type& aStr,
                            ComparatorFunc aComparator = DefaultComparator) const
  {
    return RFind(aStr, -1, aComparator);
  }

  /**
   * Find the last occurrence of aStr in this string, beginning at aOffset.
   *
   * @param aOffset the offset from the beginning of the string to begin
   *        searching. If aOffset < 0, search from end of this string.
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const self_type& aStr, int32_t aOffset,
                            ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find the last occurrence of aStr in this string.
   *
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const char_type* aStr,
                            ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Find the last occurrence of an ASCII string in this string,
   * beginning at aOffset.
   *
   * @param aLen is the length of aStr
   * @return The offset of aStr from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFind(const char_type* aStr, int32_t aLen,
                            ComparatorFunc aComparator = DefaultComparator) const;

  /**
   * Search for the offset of the first occurrence of a character in a
   * string.
   *
   * @param aOffset the offset from the beginning of the string to begin
   *        searching
   * @return The offset of the character from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) FindChar(char_type aChar, uint32_t aOffset = 0) const;

  /**
   * Search for the offset of the last occurrence of a character in a
   * string.
   *
   * @return The offset of the character from the beginning of the string,
   *         or -1 if not found.
   */
  NS_HIDDEN_(int32_t) RFindChar(char_type aChar) const;

  /**
   * Append a string representation of a number.
   */
  NS_HIDDEN_(void) AppendInt(int aInt, int32_t aRadix = 10);

#ifndef XPCOM_GLUE_AVOID_NSPR
  /**
   * Convert this string to an integer.
   *
   * @param aErrorCode pointer to contain result code.
   * @param aRadix must be 10 or 16
   */
  NS_HIDDEN_(int32_t) ToInteger(nsresult* aErrorCode,
                                uint32_t aRadix = 10) const;
  /**
   * Convert this string to a 64-bit integer.
   *
   * @param aErrorCode pointer to contain result code.
   * @param aRadix must be 10 or 16
   */
  NS_HIDDEN_(int64_t) ToInteger64(nsresult* aErrorCode,
                                  uint32_t aRadix = 10) const;
#endif // XPCOM_GLUE_AVOID_NSPR

protected:
  // Prevent people from allocating a nsAString directly.
  ~nsACString() {}
};

/* ------------------------------------------------------------------------- */

/**
 * Below we define nsStringContainer and nsCStringContainer.  These classes
 * have unspecified structure.  In most cases, your code should use
 * nsString/nsCString instead of these classes; if you prefer C-style
 * programming, then look no further.
 */

class nsStringContainer
  : public nsAString
  , private nsStringContainer_base
{
};

class nsCStringContainer
  : public nsACString
  , private nsStringContainer_base
{
};

/**
 * The following classes are C++ helper classes that make the frozen string
 * API easier to use.
 */

/**
 * Rename symbols to avoid conflicting with internal versions.
 */
#define nsString                       nsString_external
#define nsCString                      nsCString_external
#define nsDependentString              nsDependentString_external
#define nsDependentCString             nsDependentCString_external
#define NS_ConvertASCIItoUTF16         NS_ConvertASCIItoUTF16_external
#define NS_ConvertUTF8toUTF16          NS_ConvertUTF8toUTF16_external
#define NS_ConvertUTF16toUTF8          NS_ConvertUTF16toUTF8_external
#define NS_LossyConvertUTF16toASCII    NS_LossyConvertUTF16toASCII_external
#define nsGetterCopies                 nsGetterCopies_external
#define nsCGetterCopies                nsCGetterCopies_external
#define nsDependentSubstring           nsDependentSubstring_external
#define nsDependentCSubstring          nsDependentCSubstring_external

/**
 * basic strings
 */

class nsString : public nsStringContainer
{
public:
  typedef nsString         self_type;
  typedef nsAString        abstract_string_type;

  nsString()
  {
    NS_StringContainerInit(*this);
  }

  nsString(const self_type& aString)
  {
    NS_StringContainerInit(*this);
    NS_StringCopy(*this, aString);
  }

  explicit nsString(const abstract_string_type& aReadable)
  {
    NS_StringContainerInit(*this);
    NS_StringCopy(*this, aReadable);
  }

  explicit nsString(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_StringContainerInit2(*this, aData, aLength, 0);
  }

#ifdef MOZ_USE_CHAR16_WRAPPER
  explicit nsString(char16ptr_t aData, size_type aLength = UINT32_MAX)
    : nsString(static_cast<const char16_t*>(aData), aLength)
  {
  }
#endif

  ~nsString()
  {
    NS_StringContainerFinish(*this);
  }

  char16ptr_t get() const
  {
    return char16ptr_t(BeginReading());
  }

  self_type& operator=(const self_type& aString)
  {
    Assign(aString);
    return *this;
  }
  self_type& operator=(const abstract_string_type& aReadable)
  {
    Assign(aReadable);
    return *this;
  }
  self_type& operator=(const char_type* aPtr)
  {
    Assign(aPtr);
    return *this;
  }
  self_type& operator=(char_type aChar)
  {
    Assign(aChar);
    return *this;
  }

  void Adopt(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_StringContainerFinish(*this);
    NS_StringContainerInit2(*this, aData, aLength,
                            NS_STRING_CONTAINER_INIT_ADOPT);
  }

protected:
  nsString(const char_type* aData, size_type aLength, uint32_t aFlags)
  {
    NS_StringContainerInit2(*this, aData, aLength, aFlags);
  }
};

class nsCString : public nsCStringContainer
{
public:
  typedef nsCString        self_type;
  typedef nsACString       abstract_string_type;

  nsCString()
  {
    NS_CStringContainerInit(*this);
  }

  nsCString(const self_type& aString)
  {
    NS_CStringContainerInit(*this);
    NS_CStringCopy(*this, aString);
  }

  explicit nsCString(const abstract_string_type& aReadable)
  {
    NS_CStringContainerInit(*this);
    NS_CStringCopy(*this, aReadable);
  }

  explicit nsCString(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_CStringContainerInit(*this);
    NS_CStringSetData(*this, aData, aLength);
  }

  ~nsCString()
  {
    NS_CStringContainerFinish(*this);
  }

  const char_type* get() const
  {
    return BeginReading();
  }

  self_type& operator=(const self_type& aString)
  {
    Assign(aString);
    return *this;
  }
  self_type& operator=(const abstract_string_type& aReadable)
  {
    Assign(aReadable);
    return *this;
  }
  self_type& operator=(const char_type* aPtr)
  {
    Assign(aPtr);
    return *this;
  }
  self_type& operator=(char_type aChar)
  {
    Assign(aChar);
    return *this;
  }

  void Adopt(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_CStringContainerFinish(*this);
    NS_CStringContainerInit2(*this, aData, aLength,
                             NS_CSTRING_CONTAINER_INIT_ADOPT);
  }

protected:
  nsCString(const char_type* aData, size_type aLength, uint32_t aFlags)
  {
    NS_CStringContainerInit2(*this, aData, aLength, aFlags);
  }
};


/**
 * dependent strings
 */

class nsDependentString : public nsString
{
public:
  typedef nsDependentString         self_type;

  nsDependentString() {}

  explicit nsDependentString(const char_type* aData,
                             size_type aLength = UINT32_MAX)
    : nsString(aData, aLength, NS_CSTRING_CONTAINER_INIT_DEPEND)
  {
  }

#ifdef MOZ_USE_CHAR16_WRAPPER
  explicit nsDependentString(char16ptr_t aData, size_type aLength = UINT32_MAX)
    : nsDependentString(static_cast<const char16_t*>(aData), aLength)
  {
  }
#endif

  void Rebind(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_StringContainerFinish(*this);
    NS_StringContainerInit2(*this, aData, aLength,
                            NS_STRING_CONTAINER_INIT_DEPEND);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};

class nsDependentCString : public nsCString
{
public:
  typedef nsDependentCString        self_type;

  nsDependentCString() {}

  explicit nsDependentCString(const char_type* aData,
                              size_type aLength = UINT32_MAX)
    : nsCString(aData, aLength, NS_CSTRING_CONTAINER_INIT_DEPEND)
  {
  }

  void Rebind(const char_type* aData, size_type aLength = UINT32_MAX)
  {
    NS_CStringContainerFinish(*this);
    NS_CStringContainerInit2(*this, aData, aLength,
                             NS_CSTRING_CONTAINER_INIT_DEPEND);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};


/**
 * conversion classes
 */

inline void
CopyUTF16toUTF8(const nsAString& aSource, nsACString& aDest)
{
  NS_UTF16ToCString(aSource, NS_CSTRING_ENCODING_UTF8, aDest);
}

inline void
CopyUTF8toUTF16(const nsACString& aSource, nsAString& aDest)
{
  NS_CStringToUTF16(aSource, NS_CSTRING_ENCODING_UTF8, aDest);
}

inline void
LossyCopyUTF16toASCII(const nsAString& aSource, nsACString& aDest)
{
  NS_UTF16ToCString(aSource, NS_CSTRING_ENCODING_ASCII, aDest);
}

inline void
CopyASCIItoUTF16(const nsACString& aSource, nsAString& aDest)
{
  NS_CStringToUTF16(aSource, NS_CSTRING_ENCODING_ASCII, aDest);
}

char*
ToNewUTF8String(const nsAString& aSource);

class NS_ConvertASCIItoUTF16 : public nsString
{
public:
  typedef NS_ConvertASCIItoUTF16    self_type;

  explicit NS_ConvertASCIItoUTF16(const nsACString& aStr)
  {
    NS_CStringToUTF16(aStr, NS_CSTRING_ENCODING_ASCII, *this);
  }

  explicit NS_ConvertASCIItoUTF16(const char* aData,
                                  uint32_t aLength = UINT32_MAX)
  {
    NS_CStringToUTF16(nsDependentCString(aData, aLength),
                      NS_CSTRING_ENCODING_ASCII, *this);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};

class NS_ConvertUTF8toUTF16 : public nsString
{
public:
  typedef NS_ConvertUTF8toUTF16    self_type;

  explicit NS_ConvertUTF8toUTF16(const nsACString& aStr)
  {
    NS_CStringToUTF16(aStr, NS_CSTRING_ENCODING_UTF8, *this);
  }

  explicit NS_ConvertUTF8toUTF16(const char* aData,
                                 uint32_t aLength = UINT32_MAX)
  {
    NS_CStringToUTF16(nsDependentCString(aData, aLength),
                      NS_CSTRING_ENCODING_UTF8, *this);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};

class NS_ConvertUTF16toUTF8 : public nsCString
{
public:
  typedef NS_ConvertUTF16toUTF8    self_type;

  explicit NS_ConvertUTF16toUTF8(const nsAString& aStr)
  {
    NS_UTF16ToCString(aStr, NS_CSTRING_ENCODING_UTF8, *this);
  }

  explicit NS_ConvertUTF16toUTF8(const char16ptr_t aData,
                                 uint32_t aLength = UINT32_MAX)
  {
    NS_UTF16ToCString(nsDependentString(aData, aLength),
                      NS_CSTRING_ENCODING_UTF8, *this);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};

class NS_LossyConvertUTF16toASCII : public nsCString
{
public:
  typedef NS_LossyConvertUTF16toASCII    self_type;

  explicit NS_LossyConvertUTF16toASCII(const nsAString& aStr)
  {
    NS_UTF16ToCString(aStr, NS_CSTRING_ENCODING_ASCII, *this);
  }

  explicit NS_LossyConvertUTF16toASCII(const char16ptr_t aData,
                                       uint32_t aLength = UINT32_MAX)
  {
    NS_UTF16ToCString(nsDependentString(aData, aLength),
                      NS_CSTRING_ENCODING_ASCII, *this);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};


/**
 * literal strings
 */
static_assert(sizeof(char16_t) == 2, "size of char16_t must be 2");
static_assert(char16_t(-1) > char16_t(0), "char16_t must be unsigned");

#define NS_MULTILINE_LITERAL_STRING(s) \
  nsDependentString(reinterpret_cast<const nsAString::char_type*>(s), \
                    uint32_t((sizeof(s) / 2) - 1))
#define NS_MULTILINE_LITERAL_STRING_INIT(n, s) \
  n(reinterpret_cast<const nsAString::char_type*>(s), \
    uint32_t((sizeof(s) / 2) - 1))
#define NS_NAMED_MULTILINE_LITERAL_STRING(n,s) \
  const nsDependentString n(reinterpret_cast<const nsAString::char_type*>(s), \
                            uint32_t((sizeof(s) / 2) - 1))
typedef nsDependentString nsLiteralString;

#define NS_LITERAL_STRING(s) \
  static_cast<const nsString&>(NS_MULTILINE_LITERAL_STRING(u"" s))
#define NS_LITERAL_STRING_INIT(n, s) \
  NS_MULTILINE_LITERAL_STRING_INIT(n, (u"" s))
#define NS_NAMED_LITERAL_STRING(n, s) \
  NS_NAMED_MULTILINE_LITERAL_STRING(n, (u"" s))

#define NS_LITERAL_CSTRING(s) \
  static_cast<const nsDependentCString&>(nsDependentCString(s, uint32_t(sizeof(s) - 1)))
#define NS_LITERAL_CSTRING_INIT(n, s) \
  n(s, uint32_t(sizeof(s)-1))
#define NS_NAMED_LITERAL_CSTRING(n, s) \
  const nsDependentCString n(s, uint32_t(sizeof(s)-1))

typedef nsDependentCString nsLiteralCString;


/**
 * getter_Copies support
 *
 *    NS_IMETHOD GetBlah(char16_t**);
 *
 *    void some_function()
 *    {
 *      nsString blah;
 *      GetBlah(getter_Copies(blah));
 *      // ...
 *    }
 */

class nsGetterCopies
{
public:
  typedef char16_t char_type;

  explicit nsGetterCopies(nsString& aStr)
    : mString(aStr)
    , mData(nullptr)
  {
  }

  ~nsGetterCopies() { mString.Adopt(mData); }

  operator char_type**() { return &mData; }

private:
  nsString&  mString;
  char_type* mData;
};

inline nsGetterCopies
getter_Copies(nsString& aString)
{
  return nsGetterCopies(aString);
}

class nsCGetterCopies
{
public:
  typedef char char_type;

  explicit nsCGetterCopies(nsCString& aStr)
    : mString(aStr)
    , mData(nullptr)
  {
  }

  ~nsCGetterCopies() { mString.Adopt(mData); }

  operator char_type**() { return &mData; }

private:
  nsCString& mString;
  char_type* mData;
};

inline nsCGetterCopies
getter_Copies(nsCString& aString)
{
  return nsCGetterCopies(aString);
}


/**
* substrings
*/

class nsDependentSubstring : public nsStringContainer
{
public:
  typedef nsDependentSubstring self_type;
  typedef nsAString            abstract_string_type;

  ~nsDependentSubstring() { NS_StringContainerFinish(*this); }
  nsDependentSubstring() { NS_StringContainerInit(*this); }

  nsDependentSubstring(const char_type* aStart, uint32_t aLength)
  {
    NS_StringContainerInit2(*this, aStart, aLength,
                            NS_STRING_CONTAINER_INIT_DEPEND |
                            NS_STRING_CONTAINER_INIT_SUBSTRING);
  }

  nsDependentSubstring(const abstract_string_type& aStr,
                       uint32_t aStartPos);
  nsDependentSubstring(const abstract_string_type& aStr,
                       uint32_t aStartPos, uint32_t aLength);

  void Rebind(const char_type* aStart, uint32_t aLength)
  {
    NS_StringContainerFinish(*this);
    NS_StringContainerInit2(*this, aStart, aLength,
                            NS_STRING_CONTAINER_INIT_DEPEND |
                            NS_STRING_CONTAINER_INIT_SUBSTRING);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};

class nsDependentCSubstring : public nsCStringContainer
{
public:
  typedef nsDependentCSubstring self_type;
  typedef nsACString            abstract_string_type;

  ~nsDependentCSubstring() { NS_CStringContainerFinish(*this); }
  nsDependentCSubstring() { NS_CStringContainerInit(*this); }

  nsDependentCSubstring(const char_type* aStart, uint32_t aLength)
  {
    NS_CStringContainerInit2(*this, aStart, aLength,
                             NS_CSTRING_CONTAINER_INIT_DEPEND |
                             NS_CSTRING_CONTAINER_INIT_SUBSTRING);
  }

  nsDependentCSubstring(const abstract_string_type& aStr,
                        uint32_t aStartPos);
  nsDependentCSubstring(const abstract_string_type& aStr,
                        uint32_t aStartPos, uint32_t aLength);

  void Rebind(const char_type* aStart, uint32_t aLength)
  {
    NS_CStringContainerFinish(*this);
    NS_CStringContainerInit2(*this, aStart, aLength,
                             NS_CSTRING_CONTAINER_INIT_DEPEND |
                             NS_CSTRING_CONTAINER_INIT_SUBSTRING);
  }

private:
  self_type& operator=(const self_type& aString) = delete;
};


/**
 * Various nsDependentC?Substring constructor functions
 */

// char16_t
inline const nsDependentSubstring
Substring(const nsAString& aStr, uint32_t aStartPos)
{
  return nsDependentSubstring(aStr, aStartPos);
}

inline const nsDependentSubstring
Substring(const nsAString& aStr, uint32_t aStartPos, uint32_t aLength)
{
  return nsDependentSubstring(aStr, aStartPos, aLength);
}

inline const nsDependentSubstring
Substring(const char16_t* aStart, const char16_t* aEnd)
{
  MOZ_ASSERT(uint32_t(aEnd - aStart) == uintptr_t(aEnd - aStart),
             "string too long");
  return nsDependentSubstring(aStart, uint32_t(aEnd - aStart));
}

inline const nsDependentSubstring
Substring(const char16_t* aStart, uint32_t aLength)
{
  return nsDependentSubstring(aStart, aLength);
}

inline const nsDependentSubstring
StringHead(const nsAString& aStr, uint32_t aCount)
{
  return nsDependentSubstring(aStr, 0, aCount);
}

inline const nsDependentSubstring
StringTail(const nsAString& aStr, uint32_t aCount)
{
  return nsDependentSubstring(aStr, aStr.Length() - aCount, aCount);
}

// char
inline const nsDependentCSubstring
Substring(const nsACString& aStr, uint32_t aStartPos)
{
  return nsDependentCSubstring(aStr, aStartPos);
}

inline const nsDependentCSubstring
Substring(const nsACString& aStr, uint32_t aStartPos, uint32_t aLength)
{
  return nsDependentCSubstring(aStr, aStartPos, aLength);
}

inline const nsDependentCSubstring
Substring(const char* aStart, const char* aEnd)
{
  MOZ_ASSERT(uint32_t(aEnd - aStart) == uintptr_t(aEnd - aStart),
             "string too long");
  return nsDependentCSubstring(aStart, uint32_t(aEnd - aStart));
}

inline const nsDependentCSubstring
Substring(const char* aStart, uint32_t aLength)
{
  return nsDependentCSubstring(aStart, aLength);
}

inline const nsDependentCSubstring
StringHead(const nsACString& aStr, uint32_t aCount)
{
  return nsDependentCSubstring(aStr, 0, aCount);
}

inline const nsDependentCSubstring
StringTail(const nsACString& aStr, uint32_t aCount)
{
  return nsDependentCSubstring(aStr, aStr.Length() - aCount, aCount);
}


inline bool
StringBeginsWith(const nsAString& aSource, const nsAString& aSubstring,
                 nsAString::ComparatorFunc aComparator = nsAString::DefaultComparator)
{
  return aSubstring.Length() <= aSource.Length() &&
    StringHead(aSource, aSubstring.Length()).Equals(aSubstring, aComparator);
}

inline bool
StringEndsWith(const nsAString& aSource, const nsAString& aSubstring,
               nsAString::ComparatorFunc aComparator = nsAString::DefaultComparator)
{
  return aSubstring.Length() <= aSource.Length() &&
    StringTail(aSource, aSubstring.Length()).Equals(aSubstring, aComparator);
}

inline bool
StringBeginsWith(const nsACString& aSource, const nsACString& aSubstring,
                 nsACString::ComparatorFunc aComparator = nsACString::DefaultComparator)
{
  return aSubstring.Length() <= aSource.Length() &&
    StringHead(aSource, aSubstring.Length()).Equals(aSubstring, aComparator);
}

inline bool
StringEndsWith(const nsACString& aSource, const nsACString& aSubstring,
               nsACString::ComparatorFunc aComparator = nsACString::DefaultComparator)
{
  return aSubstring.Length() <= aSource.Length() &&
    StringTail(aSource, aSubstring.Length()).Equals(aSubstring, aComparator);
}

/**
 * Trim whitespace from the beginning and end of a string; then compress
 * remaining runs of whitespace characters to a single space.
 */
NS_HIDDEN_(void) CompressWhitespace(nsAString& aString);

#define EmptyCString() nsCString()
#define EmptyString() nsString()

/**
 * Convert an ASCII string to all upper/lowercase (a-z,A-Z only). As a bonus,
 * returns the string length.
 */
NS_HIDDEN_(uint32_t) ToLowerCase(nsACString& aStr);

NS_HIDDEN_(uint32_t) ToUpperCase(nsACString& aStr);

NS_HIDDEN_(uint32_t) ToLowerCase(const nsACString& aSrc, nsACString& aDest);

NS_HIDDEN_(uint32_t) ToUpperCase(const nsACString& aSrc, nsACString& aDest);

/**
 * The following declarations are *deprecated*, and are included here only
 * to make porting from existing code that doesn't use the frozen string API
 * easier. They may disappear in the future.
 */

inline char*
ToNewCString(const nsACString& aStr)
{
  return NS_CStringCloneData(aStr);
}

inline char16_t*
ToNewUnicode(const nsAString& aStr)
{
  return NS_StringCloneData(aStr);
}

typedef nsString PromiseFlatString;
typedef nsCString PromiseFlatCString;

typedef nsCString nsAutoCString;
typedef nsString nsAutoString;

NS_HIDDEN_(bool) ParseString(const nsACString& aAstring, char aDelimiter,
                             nsTArray<nsCString>& aArray);

#endif // nsStringAPI_h__