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