summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qbytearraylist.cpp
blob: beb6a32df79275d59c9ddff3ef7aff71cb51447f (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
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2014 by Southwest Research Institute (R)
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <qbytearraylist.h>

QT_BEGIN_NAMESPACE

/*! \typedef QByteArrayListIterator
    \relates QByteArrayList

    The QByteArrayListIterator type definition provides a Java-style const
    iterator for QByteArrayList.

    QByteArrayList provides both \l{Java-style iterators} and
    \l{STL-style iterators}. The Java-style const iterator is simply
    a type definition for QListIterator<QByteArray>.

    \sa QMutableByteArrayListIterator, QByteArrayList::const_iterator
*/

/*! \typedef QMutableByteArrayListIterator
    \relates QByteArrayList

    The QByteArrayListIterator type definition provides a Java-style
    non-const iterator for QByteArrayList.

    QByteArrayList provides both \l{Java-style iterators} and
    \l{STL-style iterators}. The Java-style non-const iterator is
    simply a type definition for QMutableListIterator<QByteArray>.

    \sa QByteArrayListIterator, QByteArrayList::iterator
*/

/*!
    \class QByteArrayList
    \inmodule QtCore
    \since 5.4
    \brief The QByteArrayList class provides a list of byte arrays.

    \ingroup tools
    \ingroup shared
    \ingroup string-processing

    \reentrant

    QByteArrayList inherits from QList<QByteArray>. Like QList, QByteArrayList is
    \l{implicitly shared}. It provides fast index-based access as well as fast
    insertions and removals. Passing string lists as value parameters is both
    fast and safe.

    All of QList's functionality also applies to QByteArrayList. For example, you
    can use isEmpty() to test whether the list is empty, and you can call
    functions like append(), prepend(), insert(), replace(), removeAll(),
    removeAt(), removeFirst(), removeLast(), and removeOne() to modify a
    QByteArrayList. In addition, QByteArrayList provides several join()
    methods for concatenating the list into a single QByteArray.

    The purpose of QByteArrayList is quite different from that of QStringList.
    Whereas QStringList has many methods for manipulation of elements within
    the list, QByteArrayList does not.
    Normally, QStringList should be used whenever working with a list of printable
    strings. QByteArrayList should be used to handle and efficiently join large blobs
    of binary data, as when sequentially receiving serialized data through a
    QIODevice.

    \sa QByteArray, QStringList
*/

/*!
    \fn QByteArrayList::QByteArrayList()

    Constructs an empty byte array list.
*/

/*!
    \fn QByteArrayList::QByteArrayList(const QByteArray &ba)

    Constructs a byte array list that contains the given byte array,
    \a ba. Longer lists are easily created like this:

    \snippet qbytearraylist/main.cpp 0

    \sa append()
*/

/*!
    \fn QByteArrayList::QByteArrayList(const QList<QByteArray> &other)

    Constructs a copy of \a other.

    This operation takes \l{constant time}, because QByteArrayList is
    \l{implicitly shared}. This makes returning a QByteArrayList from a
    function very fast. If a shared instance is modified, it will be
    copied (copy-on-write), and that takes \l{linear time}.

    \sa operator=()
*/

/*!
    \fn QByteArrayList::QByteArrayList(QList<QByteArray> &&other)

    \overload

    Move-constructs from \a other.

    This constructor is only enabled if the compiler supports C++11
    move semantics.

    \sa operator=()
*/

/*! \fn QByteArrayList::QByteArrayList(std::initializer_list<QByteArray> args)

    Constructs a list from a std::initializer_list given by \a args.

    This constructor is only enabled if the compiler supports C++11 initializer
    lists.
*/

/*!
    \fn QByteArrayList &QByteArrayList::operator=(const QList<QByteArray> &other)

    Assigns the contents of \a other to this byte array list and returns
    a reference to \c *this.
*/

/*!
    \fn QByteArrayList &QByteArrayList::operator=(QList<QByteArray> &&other)

    \overload

    Move-assigns the contents of \a other to this byte array list and returns
    a reference to \c *this.

    This operator is only enabled if the compiler supports C++11 move
    semantics.
*/

/*!
    \fn QByteArrayList &QByteArrayList::operator=(std::initializer_list<QByteArray> args)

    \overload

    Assigns the byte arrays from the initializer_list \a args to this byte array
    list and returns a reference to \c *this.

    This operator is only enabled if the compiler supports C++11 initializer
    lists.
*/

/*!
    \fn QByteArray QByteArrayList::join() const

    Joins all the byte arrays into a single byte array.
*/

/*!
    \fn QByteArray QByteArrayList::join(const QByteArray &separator) const

    Joins all the byte arrays into a single byte array with each
    element separated by the given \a separator.
*/

/*!
    \fn QByteArray QByteArrayList::join(char separator) const

    Joins all the byte arrays into a single byte array with each
    element separated by the given \a separator.
*/

static int QByteArrayList_joinedSize(const QByteArrayList *that, int seplen)
{
    int totalLength = 0;
    const int size = that->size();

    for (int i = 0; i < size; ++i)
        totalLength += that->at(i).size();

    if (size > 0)
        totalLength += seplen * (size - 1);

    return totalLength;
}

QByteArray QtPrivate::QByteArrayList_join(const QByteArrayList *that, const char *sep, int seplen)
{
    QByteArray res;
    if (const int joinedSize = QByteArrayList_joinedSize(that, seplen))
        res.reserve(joinedSize); // don't call reserve(0) - it allocates one byte for the NUL
    const int size = that->size();
    for (int i = 0; i < size; ++i) {
        if (i)
            res.append(sep, seplen);
        res += that->at(i);
    }
    return res;
}

/*!
    \fn QByteArrayList operator+(const QByteArrayList &list1, const QByteArrayList &list2)
    \fn QByteArrayList operator+(const QByteArrayList &list1, const QList<QByteArray> &list2)
    \fn QByteArrayList operator+(const QList<QByteArray> &list1, const QByteArrayList &list2)
    \fn QByteArrayList operator+(QByteArrayList &&list1, const QByteArrayList &list2)
    \fn QByteArrayList operator+(QByteArrayList &&list1, const QList<QByteArray> &list2)
    \relates QByteArrayList

    Returns a byte array list that is the concatenation of \a list1 and \a list2.
*/

/*!
    \fn QByteArrayList& operator+=(QByteArrayList &list1, const QList<QByteArray> &list2)
    \relates QByteArrayList

    Appends \a list2 (which may be a QByteArrayList itself) to \a
    list1 and returns a reference to \a list1.
*/

/*!
    \fn QByteArrayList &QByteArrayList::operator<<(const QByteArray &ba)

    Appends the given byte array, \a ba, to this byte array list and returns
    a reference to the byte array list.

    \sa append()
*/

/*!
    \fn QByteArrayList &QByteArrayList::operator<<(const QList<QByteArray> &other)

    \overload

    Appends the list of byte arrays \a other (which may be a
    QByteArrayList itself) to this byte array list and returns a
    reference to \c *this.  */

/*!
    \fn QDataStream &operator>>(QDataStream &in, QByteArrayList &list)
    \relates QByteArrayList

    Reads a byte array list from the given \a in stream into the specified
    \a list.

    \sa {Serializing Qt Data Types}
*/

/*!
    \fn QDataStream &operator<<(QDataStream &out, const QByteArrayList &list)
    \relates QByteArrayList

    Writes the given byte array \a list to the specified \a out stream.

    \sa {Serializing Qt Data Types}
*/

QT_END_NAMESPACE