include/QtCore/qbitarray.h

0001 // Copyright (C) 2020 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003 // Qt-Security score:significant reason:default
0004
0005 #ifndef QBITARRAY_H
0006 #define QBITARRAY_H
0007
0008 #include <QtCore/qbytearray.h>
0009
0010 QT_BEGIN_NAMESPACE
0011
0012 class QBitRef;
0013 class Q_CORE_EXPORT QBitArray
0014 {
0015     Q_CORE_EXPORT friend QBitArray operator&(const QBitArray &a1, const QBitArray &a2);
0016     friend QBitArray operator&(QBitArray &&a1, const QBitArray &a2)
0017     { return a1 &= a2; }
0018     friend QBitArray operator&(const QBitArray &a1, QBitArray &&a2)
0019     { return a2 &= a1; }
0020     friend QBitArray operator&(QBitArray &&a1, QBitArray &&a2)
0021     { return a1 &= a2; }
0022
0023     Q_CORE_EXPORT friend QBitArray operator|(const QBitArray &a1, const QBitArray &a2);
0024     friend QBitArray operator|(QBitArray &&a1, const QBitArray &a2)
0025     { return a1 |= a2; }
0026     friend QBitArray operator|(const QBitArray &a1, QBitArray &&a2)
0027     { return a2 |= a1; }
0028     friend QBitArray operator|(QBitArray &&a1, QBitArray &&a2)
0029     { return a1 |= a2; }
0030
0031     Q_CORE_EXPORT friend QBitArray operator^(const QBitArray &a1, const QBitArray &a2);
0032     friend QBitArray operator^(QBitArray &&a1, const QBitArray &a2)
0033     { return a1 ^= a2; }
0034     friend QBitArray operator^(const QBitArray &a1, QBitArray &&a2)
0035     { return a2 ^= a1; }
0036     friend QBitArray operator^(QBitArray &&a1, QBitArray &&a2)
0037     { return a1 ^= a2; }
0038
0039 #ifndef QT_NO_DATASTREAM
0040     friend Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QBitArray &);
0041     friend Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QBitArray &);
0042 #endif
0043     friend Q_CORE_EXPORT size_t qHash(const QBitArray &key, size_t seed) noexcept;
0044     friend QBitArray operator~(QBitArray a)
0045     { return std::move(a).inverted_inplace(); }
0046     QByteArray d;
0047
0048     QBitArray(QByteArrayData &&dd) : d(std::move(dd)) {}
0049
0050     template <typename BitArray> static auto bitLocation(BitArray &ba, qsizetype i)
0051     {
0052         Q_ASSERT(size_t(i) < size_t(ba.size()));
0053         struct R {
0054             decltype(ba.d[1]) byte;
0055             uchar bitMask;
0056         };
0057         qsizetype byteIdx = i >> 3;
0058         qsizetype bitIdx = i & 7;
0059         return R{ ba.d[1 + byteIdx], uchar(1U << bitIdx) };
0060     }
0061
0062     QBitArray inverted_inplace() &&;
0063
0064 public:
0065     inline QBitArray() noexcept {}
0066     explicit QBitArray(qsizetype size, bool val = false);
0067     // Rule Of Zero applies
0068 #if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)
0069     QBitArray(const QBitArray &other) noexcept : d(other.d) {}
0070     inline QBitArray &operator=(const QBitArray &other) noexcept { d = other.d; return *this; }
0071     inline QBitArray(QBitArray &&other) noexcept : d(std::move(other.d)) {}
0072     QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QBitArray)
0073 #endif // Qt 6
0074
0075     void swap(QBitArray &other) noexcept { d.swap(other.d); }
0076
0077     qsizetype size() const { return qsizetype((size_t(d.size()) << 3) - *d.constData()); }
0078     qsizetype count() const { return size(); }
0079     qsizetype count(bool on) const;
0080
0081     inline bool isEmpty() const { return d.isEmpty(); }
0082     inline bool isNull() const { return d.isNull(); }
0083
0084     void resize(qsizetype size);
0085
0086     inline void detach() { d.detach(); }
0087     inline bool isDetached() const { return d.isDetached(); }
0088     inline void clear() { d.clear(); }
0089
0090     bool testBit(qsizetype i) const
0091     { auto r = bitLocation(*this, i); return r.byte & r.bitMask; }
0092     void setBit(qsizetype i)
0093     { auto r = bitLocation(*this, i); r.byte |= r.bitMask; }
0094     void setBit(qsizetype i, bool val)
0095     { if (val) setBit(i); else clearBit(i); }
0096     void clearBit(qsizetype i)
0097     { auto r = bitLocation(*this, i); r.byte &= ~r.bitMask; }
0098     bool toggleBit(qsizetype i)
0099     {
0100         auto r = bitLocation(*this, i);
0101         bool cl = r.byte & r.bitMask;
0102         r.byte ^= r.bitMask;
0103         return cl;
0104     }
0105
0106     bool at(qsizetype i) const { return testBit(i); }
0107     inline QBitRef operator[](qsizetype i);
0108     bool operator[](qsizetype i) const { return testBit(i); }
0109
0110     QBitArray &operator&=(QBitArray &&);
0111     QBitArray &operator|=(QBitArray &&);
0112     QBitArray &operator^=(QBitArray &&);
0113     QBitArray &operator&=(const QBitArray &);
0114     QBitArray &operator|=(const QBitArray &);
0115     QBitArray &operator^=(const QBitArray &);
0116 #if QT_CORE_REMOVED_SINCE(6, 7)
0117     QBitArray operator~() const;
0118 #endif
0119
0120 #if QT_CORE_REMOVED_SINCE(6, 8)
0121     inline bool operator==(const QBitArray &other) const { return comparesEqual(d, other.d); }
0122     inline bool operator!=(const QBitArray &other) const { return !operator==(other); }
0123 #endif
0124
0125     bool fill(bool aval, qsizetype asize = -1)
0126     { *this = QBitArray((asize < 0 ? this->size() : asize), aval); return true; }
0127     void fill(bool val, qsizetype first, qsizetype last);
0128
0129     inline void truncate(qsizetype pos) { if (pos < size()) resize(pos); }
0130
0131     const char *bits() const { return isEmpty() ? nullptr : d.constData() + 1; }
0132     static QBitArray fromBits(const char *data, qsizetype len);
0133
0134     quint32 toUInt32(QSysInfo::Endian endianness, bool *ok = nullptr) const noexcept;
0135
0136 public:
0137     typedef QByteArray::DataPointer DataPtr;
0138     inline DataPtr &data_ptr() { return d.data_ptr(); }
0139     inline const DataPtr &data_ptr() const { return d.data_ptr(); }
0140
0141 private:
0142     friend bool comparesEqual(const QBitArray &lhs, const QBitArray &rhs) noexcept
0143     {
0144         return lhs.d == rhs.d;
0145     }
0146     Q_DECLARE_EQUALITY_COMPARABLE(QBitArray)
0147 };
0148
0149 class QT6_ONLY(Q_CORE_EXPORT) QBitRef
0150 {
0151 private:
0152     QBitArray &a;
0153     qsizetype i;
0154     inline QBitRef(QBitArray &array, qsizetype idx) : a(array), i(idx) { }
0155     friend class QBitArray;
0156
0157 public:
0158     inline operator bool() const { return a.testBit(i); }
0159     inline bool operator!() const { return !a.testBit(i); }
0160     QBitRef &operator=(const QBitRef &val) { a.setBit(i, val); return *this; }
0161     QBitRef &operator=(bool val) { a.setBit(i, val); return *this; }
0162 };
0163
0164 QBitRef QBitArray::operator[](qsizetype i)
0165 { Q_ASSERT(i >= 0); return QBitRef(*this, i); }
0166
0167 #ifndef QT_NO_DATASTREAM
0168 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QBitArray &);
0169 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QBitArray &);
0170 #endif
0171
0172 #ifndef QT_NO_DEBUG_STREAM
0173 Q_CORE_EXPORT QDebug operator<<(QDebug, const QBitArray &);
0174 #endif
0175
0176 Q_DECLARE_SHARED(QBitArray)
0177
0178 QT_END_NAMESPACE
0179
0180 #endif // QBITARRAY_H