Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-09-15 09:07:31

0001 // Copyright (C) 2022 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 QMARGINS_H
0005 #define QMARGINS_H
0006 
0007 #include <QtCore/qcompare.h>
0008 #include <QtCore/qnamespace.h>
0009 
0010 #include <QtCore/q20type_traits.h>
0011 #include <QtCore/q23utility.h>
0012 
0013 QT_BEGIN_NAMESPACE
0014 
0015 QT_ENABLE_P0846_SEMANTICS_FOR(get)
0016 
0017 class QDataStream;
0018 class QMarginsF;
0019 
0020 /*****************************************************************************
0021   QMargins class
0022  *****************************************************************************/
0023 
0024 class QMargins
0025 {
0026 public:
0027     constexpr QMargins() noexcept;
0028     constexpr QMargins(int left, int top, int right, int bottom) noexcept;
0029 
0030     constexpr bool isNull() const noexcept;
0031 
0032     constexpr int left() const noexcept;
0033     constexpr int top() const noexcept;
0034     constexpr int right() const noexcept;
0035     constexpr int bottom() const noexcept;
0036 
0037     constexpr void setLeft(int left) noexcept;
0038     constexpr void setTop(int top) noexcept;
0039     constexpr void setRight(int right) noexcept;
0040     constexpr void setBottom(int bottom) noexcept;
0041 
0042     constexpr QMargins &operator+=(const QMargins &margins) noexcept;
0043     constexpr QMargins &operator-=(const QMargins &margins) noexcept;
0044     constexpr QMargins &operator+=(int) noexcept;
0045     constexpr QMargins &operator-=(int) noexcept;
0046     constexpr QMargins &operator*=(int) noexcept;
0047     constexpr QMargins &operator/=(int);
0048     constexpr QMargins &operator*=(qreal) noexcept;
0049     constexpr QMargins &operator/=(qreal);
0050 
0051     [[nodiscard]] constexpr inline QMarginsF toMarginsF() const noexcept;
0052 
0053 private:
0054     int m_left;
0055     int m_top;
0056     int m_right;
0057     int m_bottom;
0058 
0059     friend constexpr bool comparesEqual(const QMargins &lhs, const QMargins &rhs) noexcept
0060     {
0061         return lhs.m_left == rhs.m_left
0062                 && lhs.m_top == rhs.m_top
0063                 && lhs.m_right == rhs.m_right
0064                 && lhs.m_bottom == rhs.m_bottom;
0065     }
0066     Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMargins)
0067 
0068     template <std::size_t I,
0069               typename M,
0070               std::enable_if_t<(I < 4), bool> = true,
0071               std::enable_if_t<std::is_same_v<q20::remove_cvref_t<M>, QMargins>, bool> = true>
0072     friend constexpr decltype(auto) get(M &&m) noexcept
0073     {
0074         if constexpr (I == 0)
0075             return q23::forward_like<M>(m.m_left);
0076         else if constexpr (I == 1)
0077             return q23::forward_like<M>(m.m_top);
0078         else if constexpr (I == 2)
0079             return q23::forward_like<M>(m.m_right);
0080         else if constexpr (I == 3)
0081             return q23::forward_like<M>(m.m_bottom);
0082     }
0083 };
0084 
0085 Q_DECLARE_TYPEINFO(QMargins, Q_RELOCATABLE_TYPE);
0086 
0087 /*****************************************************************************
0088   QMargins stream functions
0089  *****************************************************************************/
0090 #ifndef QT_NO_DATASTREAM
0091 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QMargins &);
0092 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QMargins &);
0093 #endif
0094 
0095 /*****************************************************************************
0096   QMargins inline functions
0097  *****************************************************************************/
0098 
0099 constexpr inline QMargins::QMargins() noexcept : m_left(0), m_top(0), m_right(0), m_bottom(0) {}
0100 
0101 constexpr inline QMargins::QMargins(int aleft, int atop, int aright, int abottom) noexcept
0102     : m_left(aleft), m_top(atop), m_right(aright), m_bottom(abottom) {}
0103 
0104 constexpr inline bool QMargins::isNull() const noexcept
0105 { return m_left==0 && m_top==0 && m_right==0 && m_bottom==0; }
0106 
0107 constexpr inline int QMargins::left() const noexcept
0108 { return m_left; }
0109 
0110 constexpr inline int QMargins::top() const noexcept
0111 { return m_top; }
0112 
0113 constexpr inline int QMargins::right() const noexcept
0114 { return m_right; }
0115 
0116 constexpr inline int QMargins::bottom() const noexcept
0117 { return m_bottom; }
0118 
0119 
0120 constexpr inline void QMargins::setLeft(int aleft) noexcept
0121 { m_left = aleft; }
0122 
0123 constexpr inline void QMargins::setTop(int atop) noexcept
0124 { m_top = atop; }
0125 
0126 constexpr inline void QMargins::setRight(int aright) noexcept
0127 { m_right = aright; }
0128 
0129 constexpr inline void QMargins::setBottom(int abottom) noexcept
0130 { m_bottom = abottom; }
0131 
0132 constexpr inline QMargins operator+(const QMargins &m1, const QMargins &m2) noexcept
0133 {
0134     return QMargins(m1.left() + m2.left(), m1.top() + m2.top(),
0135                     m1.right() + m2.right(), m1.bottom() + m2.bottom());
0136 }
0137 
0138 constexpr inline QMargins operator-(const QMargins &m1, const QMargins &m2) noexcept
0139 {
0140     return QMargins(m1.left() - m2.left(), m1.top() - m2.top(),
0141                     m1.right() - m2.right(), m1.bottom() - m2.bottom());
0142 }
0143 
0144 constexpr inline QMargins operator+(const QMargins &lhs, int rhs) noexcept
0145 {
0146     return QMargins(lhs.left() + rhs, lhs.top() + rhs,
0147                     lhs.right() + rhs, lhs.bottom() + rhs);
0148 }
0149 
0150 constexpr inline QMargins operator+(int lhs, const QMargins &rhs) noexcept
0151 {
0152     return QMargins(rhs.left() + lhs, rhs.top() + lhs,
0153                     rhs.right() + lhs, rhs.bottom() + lhs);
0154 }
0155 
0156 constexpr inline QMargins operator-(const QMargins &lhs, int rhs) noexcept
0157 {
0158     return QMargins(lhs.left() - rhs, lhs.top() - rhs,
0159                     lhs.right() - rhs, lhs.bottom() - rhs);
0160 }
0161 
0162 constexpr inline QMargins operator*(const QMargins &margins, int factor) noexcept
0163 {
0164     return QMargins(margins.left() * factor, margins.top() * factor,
0165                     margins.right() * factor, margins.bottom() * factor);
0166 }
0167 
0168 constexpr inline QMargins operator*(int factor, const QMargins &margins) noexcept
0169 {
0170     return QMargins(margins.left() * factor, margins.top() * factor,
0171                     margins.right() * factor, margins.bottom() * factor);
0172 }
0173 
0174 constexpr inline QMargins operator*(const QMargins &margins, qreal factor) noexcept
0175 {
0176     return QMargins(qRound(margins.left() * factor), qRound(margins.top() * factor),
0177                     qRound(margins.right() * factor), qRound(margins.bottom() * factor));
0178 }
0179 
0180 constexpr inline QMargins operator*(qreal factor, const QMargins &margins) noexcept
0181 {
0182     return QMargins(qRound(margins.left() * factor), qRound(margins.top() * factor),
0183                     qRound(margins.right() * factor), qRound(margins.bottom() * factor));
0184 }
0185 
0186 constexpr inline QMargins operator/(const QMargins &margins, int divisor)
0187 {
0188     return QMargins(margins.left() / divisor, margins.top() / divisor,
0189                     margins.right() / divisor, margins.bottom() / divisor);
0190 }
0191 
0192 constexpr inline QMargins operator/(const QMargins &margins, qreal divisor)
0193 {
0194     return QMargins(qRound(margins.left() / divisor), qRound(margins.top() / divisor),
0195                     qRound(margins.right() / divisor), qRound(margins.bottom() / divisor));
0196 }
0197 
0198 constexpr inline QMargins operator|(const QMargins &m1, const QMargins &m2) noexcept
0199 {
0200     return QMargins(qMax(m1.left(), m2.left()), qMax(m1.top(), m2.top()),
0201                     qMax(m1.right(), m2.right()), qMax(m1.bottom(), m2.bottom()));
0202 }
0203 
0204 constexpr inline QMargins &QMargins::operator+=(const QMargins &margins) noexcept
0205 {
0206     return *this = *this + margins;
0207 }
0208 
0209 constexpr inline QMargins &QMargins::operator-=(const QMargins &margins) noexcept
0210 {
0211     return *this = *this - margins;
0212 }
0213 
0214 constexpr inline QMargins &QMargins::operator+=(int margin) noexcept
0215 {
0216     m_left += margin;
0217     m_top += margin;
0218     m_right += margin;
0219     m_bottom += margin;
0220     return *this;
0221 }
0222 
0223 constexpr inline QMargins &QMargins::operator-=(int margin) noexcept
0224 {
0225     m_left -= margin;
0226     m_top -= margin;
0227     m_right -= margin;
0228     m_bottom -= margin;
0229     return *this;
0230 }
0231 
0232 constexpr inline QMargins &QMargins::operator*=(int factor) noexcept
0233 {
0234     return *this = *this * factor;
0235 }
0236 
0237 constexpr inline QMargins &QMargins::operator/=(int divisor)
0238 {
0239     return *this = *this / divisor;
0240 }
0241 
0242 constexpr inline QMargins &QMargins::operator*=(qreal factor) noexcept
0243 {
0244     return *this = *this * factor;
0245 }
0246 
0247 constexpr inline QMargins &QMargins::operator/=(qreal divisor)
0248 {
0249     return *this = *this / divisor;
0250 }
0251 
0252 constexpr inline QMargins operator+(const QMargins &margins) noexcept
0253 {
0254     return margins;
0255 }
0256 
0257 constexpr inline QMargins operator-(const QMargins &margins) noexcept
0258 {
0259     return QMargins(-margins.left(), -margins.top(), -margins.right(), -margins.bottom());
0260 }
0261 
0262 #ifndef QT_NO_DEBUG_STREAM
0263 Q_CORE_EXPORT QDebug operator<<(QDebug, const QMargins &);
0264 #endif
0265 
0266 /*****************************************************************************
0267   QMarginsF class
0268  *****************************************************************************/
0269 
0270 class QMarginsF
0271 {
0272 public:
0273     constexpr QMarginsF() noexcept;
0274     constexpr QMarginsF(qreal left, qreal top, qreal right, qreal bottom) noexcept;
0275     constexpr QMarginsF(const QMargins &margins) noexcept;
0276 
0277     constexpr bool isNull() const noexcept;
0278 
0279     constexpr qreal left() const noexcept;
0280     constexpr qreal top() const noexcept;
0281     constexpr qreal right() const noexcept;
0282     constexpr qreal bottom() const noexcept;
0283 
0284     constexpr void setLeft(qreal aleft) noexcept;
0285     constexpr void setTop(qreal atop) noexcept;
0286     constexpr void setRight(qreal aright) noexcept;
0287     constexpr void setBottom(qreal abottom) noexcept;
0288 
0289     constexpr QMarginsF &operator+=(const QMarginsF &margins) noexcept;
0290     constexpr QMarginsF &operator-=(const QMarginsF &margins) noexcept;
0291     constexpr QMarginsF &operator+=(qreal addend) noexcept;
0292     constexpr QMarginsF &operator-=(qreal subtrahend) noexcept;
0293     constexpr QMarginsF &operator*=(qreal factor) noexcept;
0294     constexpr QMarginsF &operator/=(qreal divisor);
0295 
0296     constexpr inline QMargins toMargins() const noexcept;
0297 
0298 private:
0299     qreal m_left;
0300     qreal m_top;
0301     qreal m_right;
0302     qreal m_bottom;
0303 
0304     QT_WARNING_PUSH
0305     QT_WARNING_DISABLE_FLOAT_COMPARE
0306     friend constexpr bool qFuzzyCompare(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0307     {
0308         return ((!lhs.m_left || !rhs.m_left) ? qFuzzyIsNull(lhs.m_left - rhs.m_left)
0309                                              : qFuzzyCompare(lhs.m_left, rhs.m_left))
0310                 && ((!lhs.m_top || !rhs.m_top) ? qFuzzyIsNull(lhs.m_top - rhs.m_top)
0311                                                : qFuzzyCompare(lhs.m_top, rhs.m_top))
0312                 && ((!lhs.m_right || !rhs.m_right) ? qFuzzyIsNull(lhs.m_right - rhs.m_right)
0313                                                    : qFuzzyCompare(lhs.m_right, rhs.m_right))
0314                 && ((!lhs.m_bottom || !rhs.m_bottom) ? qFuzzyIsNull(lhs.m_bottom - rhs.m_bottom)
0315                                                      : qFuzzyCompare(lhs.m_bottom, rhs.m_bottom));
0316     }
0317     QT_WARNING_POP
0318     friend constexpr bool qFuzzyIsNull(const QMarginsF &m) noexcept
0319     {
0320         return qFuzzyIsNull(m.m_left) && qFuzzyIsNull(m.m_top)
0321                 && qFuzzyIsNull(m.m_right) && qFuzzyIsNull(m.m_bottom);
0322     }
0323 
0324     friend constexpr bool comparesEqual(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0325     {
0326         return qFuzzyCompare(lhs, rhs);
0327     }
0328     Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMarginsF)
0329 
0330     friend constexpr bool comparesEqual(const QMarginsF &lhs, const QMargins &rhs) noexcept
0331     { return comparesEqual(lhs, rhs.toMarginsF()); }
0332     Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMarginsF, QMargins)
0333 
0334     template <std::size_t I,
0335               typename M,
0336               std::enable_if_t<(I < 4), bool> = true,
0337               std::enable_if_t<std::is_same_v<q20::remove_cvref_t<M>, QMarginsF>, bool> = true>
0338     friend constexpr decltype(auto) get(M &&m) noexcept
0339     {
0340         if constexpr (I == 0)
0341             return q23::forward_like<M>(m.m_left);
0342         else if constexpr (I == 1)
0343             return q23::forward_like<M>(m.m_top);
0344         else if constexpr (I == 2)
0345             return q23::forward_like<M>(m.m_right);
0346         else if constexpr (I == 3)
0347             return q23::forward_like<M>(m.m_bottom);
0348     }
0349 };
0350 
0351 Q_DECLARE_TYPEINFO(QMarginsF, Q_RELOCATABLE_TYPE);
0352 
0353 /*****************************************************************************
0354   QMarginsF stream functions
0355  *****************************************************************************/
0356 
0357 #ifndef QT_NO_DATASTREAM
0358 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QMarginsF &);
0359 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QMarginsF &);
0360 #endif
0361 
0362 /*****************************************************************************
0363   QMarginsF inline functions
0364  *****************************************************************************/
0365 
0366 constexpr inline QMarginsF::QMarginsF() noexcept
0367     : m_left(0), m_top(0), m_right(0), m_bottom(0) {}
0368 
0369 constexpr inline QMarginsF::QMarginsF(qreal aleft, qreal atop, qreal aright, qreal abottom) noexcept
0370     : m_left(aleft), m_top(atop), m_right(aright), m_bottom(abottom) {}
0371 
0372 constexpr inline QMarginsF::QMarginsF(const QMargins &margins) noexcept
0373     : m_left(margins.left()), m_top(margins.top()), m_right(margins.right()), m_bottom(margins.bottom()) {}
0374 
0375 constexpr inline bool QMarginsF::isNull() const noexcept
0376 { return qFuzzyIsNull(m_left) && qFuzzyIsNull(m_top) && qFuzzyIsNull(m_right) && qFuzzyIsNull(m_bottom); }
0377 
0378 constexpr inline qreal QMarginsF::left() const noexcept
0379 { return m_left; }
0380 
0381 constexpr inline qreal QMarginsF::top() const noexcept
0382 { return m_top; }
0383 
0384 constexpr inline qreal QMarginsF::right() const noexcept
0385 { return m_right; }
0386 
0387 constexpr inline qreal QMarginsF::bottom() const noexcept
0388 { return m_bottom; }
0389 
0390 
0391 constexpr inline void QMarginsF::setLeft(qreal aleft) noexcept
0392 { m_left = aleft; }
0393 
0394 constexpr inline void QMarginsF::setTop(qreal atop) noexcept
0395 { m_top = atop; }
0396 
0397 constexpr inline void QMarginsF::setRight(qreal aright) noexcept
0398 { m_right = aright; }
0399 
0400 constexpr inline void QMarginsF::setBottom(qreal abottom) noexcept
0401 { m_bottom = abottom; }
0402 
0403 constexpr inline QMarginsF operator+(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0404 {
0405     return QMarginsF(lhs.left() + rhs.left(), lhs.top() + rhs.top(),
0406                      lhs.right() + rhs.right(), lhs.bottom() + rhs.bottom());
0407 }
0408 
0409 constexpr inline QMarginsF operator-(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0410 {
0411     return QMarginsF(lhs.left() - rhs.left(), lhs.top() - rhs.top(),
0412                      lhs.right() - rhs.right(), lhs.bottom() - rhs.bottom());
0413 }
0414 
0415 constexpr inline QMarginsF operator+(const QMarginsF &lhs, qreal rhs) noexcept
0416 {
0417     return QMarginsF(lhs.left() + rhs, lhs.top() + rhs,
0418                      lhs.right() + rhs, lhs.bottom() + rhs);
0419 }
0420 
0421 constexpr inline QMarginsF operator+(qreal lhs, const QMarginsF &rhs) noexcept
0422 {
0423     return QMarginsF(rhs.left() + lhs, rhs.top() + lhs,
0424                      rhs.right() + lhs, rhs.bottom() + lhs);
0425 }
0426 
0427 constexpr inline QMarginsF operator-(const QMarginsF &lhs, qreal rhs) noexcept
0428 {
0429     return QMarginsF(lhs.left() - rhs, lhs.top() - rhs,
0430                      lhs.right() - rhs, lhs.bottom() - rhs);
0431 }
0432 
0433 constexpr inline QMarginsF operator*(const QMarginsF &lhs, qreal rhs) noexcept
0434 {
0435     return QMarginsF(lhs.left() * rhs, lhs.top() * rhs,
0436                      lhs.right() * rhs, lhs.bottom() * rhs);
0437 }
0438 
0439 constexpr inline QMarginsF operator*(qreal lhs, const QMarginsF &rhs) noexcept
0440 {
0441     return QMarginsF(rhs.left() * lhs, rhs.top() * lhs,
0442                      rhs.right() * lhs, rhs.bottom() * lhs);
0443 }
0444 
0445 constexpr inline QMarginsF operator/(const QMarginsF &lhs, qreal divisor)
0446 {
0447     Q_ASSERT(divisor < 0 || divisor > 0);
0448     return QMarginsF(lhs.left() / divisor, lhs.top() / divisor,
0449                      lhs.right() / divisor, lhs.bottom() / divisor);
0450 }
0451 
0452 constexpr inline QMarginsF operator|(const QMarginsF &m1, const QMarginsF &m2) noexcept
0453 {
0454     return QMarginsF(qMax(m1.left(), m2.left()), qMax(m1.top(), m2.top()),
0455                      qMax(m1.right(), m2.right()), qMax(m1.bottom(), m2.bottom()));
0456 }
0457 
0458 constexpr inline QMarginsF &QMarginsF::operator+=(const QMarginsF &margins) noexcept
0459 {
0460     return *this = *this + margins;
0461 }
0462 
0463 constexpr inline QMarginsF &QMarginsF::operator-=(const QMarginsF &margins) noexcept
0464 {
0465     return *this = *this - margins;
0466 }
0467 
0468 constexpr inline QMarginsF &QMarginsF::operator+=(qreal addend) noexcept
0469 {
0470     m_left += addend;
0471     m_top += addend;
0472     m_right += addend;
0473     m_bottom += addend;
0474     return *this;
0475 }
0476 
0477 constexpr inline QMarginsF &QMarginsF::operator-=(qreal subtrahend) noexcept
0478 {
0479     m_left -= subtrahend;
0480     m_top -= subtrahend;
0481     m_right -= subtrahend;
0482     m_bottom -= subtrahend;
0483     return *this;
0484 }
0485 
0486 constexpr inline QMarginsF &QMarginsF::operator*=(qreal factor) noexcept
0487 {
0488     return *this = *this * factor;
0489 }
0490 
0491 constexpr inline QMarginsF &QMarginsF::operator/=(qreal divisor)
0492 {
0493     return *this = *this / divisor;
0494 }
0495 
0496 constexpr inline QMarginsF operator+(const QMarginsF &margins) noexcept
0497 {
0498     return margins;
0499 }
0500 
0501 constexpr inline QMarginsF operator-(const QMarginsF &margins) noexcept
0502 {
0503     return QMarginsF(-margins.left(), -margins.top(), -margins.right(), -margins.bottom());
0504 }
0505 
0506 constexpr QMarginsF QMargins::toMarginsF() const noexcept { return *this; }
0507 
0508 constexpr inline QMargins QMarginsF::toMargins() const noexcept
0509 {
0510     return QMargins(qRound(m_left), qRound(m_top), qRound(m_right), qRound(m_bottom));
0511 }
0512 
0513 #ifndef QT_NO_DEBUG_STREAM
0514 Q_CORE_EXPORT QDebug operator<<(QDebug, const QMarginsF &);
0515 #endif
0516 
0517 QT_END_NAMESPACE
0518 
0519 /*****************************************************************************
0520   QMargins/QMarginsF tuple protocol
0521  *****************************************************************************/
0522 
0523 namespace std {
0524     template <>
0525     class tuple_size<QT_PREPEND_NAMESPACE(QMargins)> : public integral_constant<size_t, 4> {};
0526     template <>
0527     class tuple_element<0, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0528     template <>
0529     class tuple_element<1, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0530     template <>
0531     class tuple_element<2, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0532     template <>
0533     class tuple_element<3, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0534 
0535     template <>
0536     class tuple_size<QT_PREPEND_NAMESPACE(QMarginsF)> : public integral_constant<size_t, 4> {};
0537     template <>
0538     class tuple_element<0, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0539     template <>
0540     class tuple_element<1, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0541     template <>
0542     class tuple_element<2, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0543     template <>
0544     class tuple_element<3, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0545 }
0546 
0547 #endif // QMARGINS_H