1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 // IWYU pragma: private, include "nsString.h"
7
8 #ifndef nsTDependentSubstring_h
9 #define nsTDependentSubstring_h
10
11 #include "nsTSubstring.h"
12 #include "nsTLiteralString.h"
13 #include "mozilla/Span.h"
14
15 /**
16 * nsTDependentSubstring_CharT
17 *
18 * A string class which wraps an external array of string characters. It
19 * is the client code's responsibility to ensure that the external buffer
20 * remains valid for a long as the string is alive.
21 *
22 * NAMES:
23 * nsDependentSubstring for wide characters
24 * nsDependentCSubstring for narrow characters
25 */
26 template <typename T>
27 class nsTDependentSubstring : public nsTSubstring<T> {
28 public:
29 typedef nsTDependentSubstring<T> self_type;
30 typedef nsTSubstring<T> substring_type;
31 typedef typename substring_type::fallible_t fallible_t;
32
33 typedef typename substring_type::char_type char_type;
34 typedef typename substring_type::char_traits char_traits;
35 typedef
36 typename substring_type::incompatible_char_type incompatible_char_type;
37
38 typedef typename substring_type::substring_tuple_type substring_tuple_type;
39
40 typedef typename substring_type::const_iterator const_iterator;
41 typedef typename substring_type::iterator iterator;
42
43 typedef typename substring_type::comparator_type comparator_type;
44
45 typedef typename substring_type::const_char_iterator const_char_iterator;
46
47 typedef typename substring_type::index_type index_type;
48 typedef typename substring_type::size_type size_type;
49
50 // These are only for internal use within the string classes:
51 typedef typename substring_type::DataFlags DataFlags;
52 typedef typename substring_type::ClassFlags ClassFlags;
53
54 public:
55 void Rebind(const substring_type&, size_type aStartPos,
56 size_type aLength = size_type(-1));
57
58 void Rebind(const char_type* aData, size_type aLength);
59
60 void Rebind(const char_type* aStart, const char_type* aEnd);
61
62 nsTDependentSubstring(const substring_type& aStr, size_type aStartPos,
63 size_type aLength = size_type(-1))
substring_type()64 : substring_type() {
65 Rebind(aStr, aStartPos, aLength);
66 }
67
nsTDependentSubstring(const char_type * aData,size_type aLength)68 nsTDependentSubstring(const char_type* aData, size_type aLength)
69 : substring_type(const_cast<char_type*>(aData), aLength, DataFlags(0),
70 ClassFlags(0)) {}
71
nsTDependentSubstring(mozilla::Span<const char_type> aData)72 explicit nsTDependentSubstring(mozilla::Span<const char_type> aData)
73 : nsTDependentSubstring(aData.Elements(), aData.Length()) {}
74
75 nsTDependentSubstring(const char_type* aStart, const char_type* aEnd);
76
77 #if defined(MOZ_USE_CHAR16_WRAPPER)
78 template <typename Q = T, typename EnableIfChar16 = mozilla::Char16OnlyT<Q>>
nsTDependentSubstring(char16ptr_t aData,size_type aLength)79 nsTDependentSubstring(char16ptr_t aData, size_type aLength)
80 : nsTDependentSubstring(static_cast<const char16_t*>(aData), aLength) {}
81
82 template <typename Q = T, typename EnableIfChar16 = mozilla::Char16OnlyT<Q>>
83 nsTDependentSubstring(char16ptr_t aStart, char16ptr_t aEnd);
84 #endif
85
86 nsTDependentSubstring(const const_iterator& aStart,
87 const const_iterator& aEnd);
88
89 // Create a nsTDependentSubstring to be bound later
nsTDependentSubstring()90 nsTDependentSubstring() : substring_type() {}
91
92 // auto-generated copy-constructor OK (XXX really?? what about base class
93 // copy-ctor?)
94 nsTDependentSubstring(const nsTDependentSubstring&) = default;
95
96 private:
97 // NOT USED
98 void operator=(const self_type&) =
99 delete; // we're immutable, you can't assign into a substring
100 };
101
102 extern template class nsTDependentSubstring<char>;
103 extern template class nsTDependentSubstring<char16_t>;
104
105 template <typename T>
106 inline const nsTDependentSubstring<T> Substring(const nsTSubstring<T>& aStr,
107 size_t aStartPos,
108 size_t aLength = size_t(-1)) {
109 return nsTDependentSubstring<T>(aStr, aStartPos, aLength);
110 }
111
112 template <typename T>
113 inline const nsTDependentSubstring<T> Substring(const nsTLiteralString<T>& aStr,
114 size_t aStartPos,
115 size_t aLength = size_t(-1)) {
116 return nsTDependentSubstring<T>(aStr, aStartPos, aLength);
117 }
118
119 template <typename T>
Substring(const nsReadingIterator<T> & aStart,const nsReadingIterator<T> & aEnd)120 inline const nsTDependentSubstring<T> Substring(
121 const nsReadingIterator<T>& aStart, const nsReadingIterator<T>& aEnd) {
122 return nsTDependentSubstring<T>(aStart.get(), aEnd.get());
123 }
124
125 template <typename T>
Substring(const T * aData,size_t aLength)126 inline const nsTDependentSubstring<T> Substring(const T* aData,
127 size_t aLength) {
128 return nsTDependentSubstring<T>(aData, aLength);
129 }
130
131 template <typename T>
132 const nsTDependentSubstring<T> Substring(const T* aStart, const T* aEnd);
133
134 extern template const nsTDependentSubstring<char> Substring(const char* aStart,
135 const char* aEnd);
136
137 extern template const nsTDependentSubstring<char16_t> Substring(
138 const char16_t* aStart, const char16_t* aEnd);
139
140 #if defined(MOZ_USE_CHAR16_WRAPPER)
141 inline const nsTDependentSubstring<char16_t> Substring(char16ptr_t aData,
142 size_t aLength);
143
144 const nsTDependentSubstring<char16_t> Substring(char16ptr_t aStart,
145 char16ptr_t aEnd);
146 #endif
147
148 template <typename T>
StringHead(const nsTSubstring<T> & aStr,size_t aCount)149 inline const nsTDependentSubstring<T> StringHead(const nsTSubstring<T>& aStr,
150 size_t aCount) {
151 return nsTDependentSubstring<T>(aStr, 0, aCount);
152 }
153
154 template <typename T>
StringTail(const nsTSubstring<T> & aStr,size_t aCount)155 inline const nsTDependentSubstring<T> StringTail(const nsTSubstring<T>& aStr,
156 size_t aCount) {
157 return nsTDependentSubstring<T>(aStr, aStr.Length() - aCount, aCount);
158 }
159
160 #endif
161