Revision control
Copy as Markdown
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#ifndef QSIZE_H
#define QSIZE_H
#include <QtCore/qcheckedint_impl.h>
#include <QtCore/qnamespace.h>
#include <QtCore/qhashfunctions.h>
#include <QtCore/qmargins.h>
#include <QtCore/q20type_traits.h>
#include <QtCore/q23utility.h>
#if defined(Q_OS_DARWIN) || defined(Q_QDOC)
struct CGSize;
#endif
QT_BEGIN_NAMESPACE
// QT_ENABLE_P0846_SEMANTICS_FOR(get) // from qmargins.h
class QSizeF;
class Q_CORE_EXPORT QSize
{
public:
constexpr QSize() noexcept;
constexpr QSize(int w, int h) noexcept;
constexpr inline bool isNull() const noexcept;
constexpr inline bool isEmpty() const noexcept;
constexpr inline bool isValid() const noexcept;
constexpr inline int width() const noexcept;
constexpr inline int height() const noexcept;
constexpr inline void setWidth(int w) noexcept;
constexpr inline void setHeight(int h) noexcept;
void transpose() noexcept;
[[nodiscard]] constexpr inline QSize transposed() const noexcept;
inline void scale(int w, int h, Qt::AspectRatioMode mode) noexcept;
inline void scale(const QSize &s, Qt::AspectRatioMode mode) noexcept;
[[nodiscard]] QSize scaled(int w, int h, Qt::AspectRatioMode mode) const noexcept;
[[nodiscard]] QSize scaled(const QSize &s, Qt::AspectRatioMode mode) const noexcept;
[[nodiscard]] constexpr inline QSize expandedTo(const QSize &) const noexcept;
[[nodiscard]] constexpr inline QSize boundedTo(const QSize &) const noexcept;
[[nodiscard]] constexpr QSize grownBy(QMargins m) const noexcept
{ return {wd + m.left() + m.right(), ht + m.top() + m.bottom()}; }
[[nodiscard]] constexpr QSize shrunkBy(QMargins m) const noexcept
{ return {wd - m.left() - m.right(), ht - m.top() - m.bottom()}; }
constexpr inline int &rwidth() noexcept;
constexpr inline int &rheight() noexcept;
constexpr inline QSize &operator+=(const QSize &) noexcept;
constexpr inline QSize &operator-=(const QSize &) noexcept;
constexpr inline QSize &operator*=(qreal c) noexcept;
inline QSize &operator/=(qreal c);
private:
friend constexpr bool comparesEqual(const QSize &s1, const QSize &s2) noexcept
{ return s1.wd == s2.wd && s1.ht == s2.ht; }
Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QSize)
friend inline constexpr QSize operator+(const QSize &s1, const QSize &s2) noexcept
{ return QSize(s1.wd + s2.wd, s1.ht + s2.ht); }
friend inline constexpr QSize operator-(const QSize &s1, const QSize &s2) noexcept
{ return QSize(s1.wd - s2.wd, s1.ht - s2.ht); }
friend inline constexpr QSize operator*(const QSize &s, qreal c) noexcept
{ return QSize(QtPrivate::qSaturateRound(s.width() * c), QtPrivate::qSaturateRound(s.height() * c)); }
friend inline constexpr QSize operator*(qreal c, const QSize &s) noexcept
{ return s * c; }
friend inline QSize operator/(const QSize &s, qreal c)
{
Q_ASSERT(!qFuzzyIsNull(c));
return QSize(QtPrivate::qSaturateRound(s.width() / c), QtPrivate::qSaturateRound(s.height() / c));
}
friend inline constexpr size_t qHash(const QSize &, size_t) noexcept;
public:
#if defined(Q_OS_DARWIN) || defined(Q_QDOC)
[[nodiscard]] CGSize toCGSize() const noexcept;
#endif
[[nodiscard]] inline constexpr QSizeF toSizeF() const noexcept;
private:
using Representation = QtPrivate::QCheckedIntegers::QCheckedInt<int>;
constexpr QSize(Representation w, Representation h) noexcept
: wd(w), ht(h)
{}
Representation wd;
Representation ht;
template <std::size_t I,
typename S,
std::enable_if_t<(I < 2), bool> = true,
std::enable_if_t<std::is_same_v<q20::remove_cvref_t<S>, QSize>, bool> = true>
friend constexpr decltype(auto) get(S &&s) noexcept
{
if constexpr (I == 0)
return q23::forward_like<S>(s.wd).as_underlying();
else if constexpr (I == 1)
return q23::forward_like<S>(s.ht).as_underlying();
}
};
Q_DECLARE_TYPEINFO(QSize, Q_RELOCATABLE_TYPE);
/*****************************************************************************
QSize stream functions
*****************************************************************************/
#ifndef QT_NO_DATASTREAM
Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QSize &);
Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QSize &);
#endif
/*****************************************************************************
QSize inline functions
*****************************************************************************/
constexpr inline QSize::QSize() noexcept : wd(-1), ht(-1) {}
constexpr inline QSize::QSize(int w, int h) noexcept : wd(w), ht(h) {}
constexpr inline bool QSize::isNull() const noexcept
{ return wd == 0 && ht == 0; }
constexpr inline bool QSize::isEmpty() const noexcept
{ return wd < 1 || ht < 1; }
constexpr inline bool QSize::isValid() const noexcept
{ return wd >= 0 && ht >= 0; }
constexpr inline int QSize::width() const noexcept
{ return wd.value(); }
constexpr inline int QSize::height() const noexcept
{ return ht.value(); }
constexpr inline void QSize::setWidth(int w) noexcept
{ wd.setValue(w); }
constexpr inline void QSize::setHeight(int h) noexcept
{ ht.setValue(h); }
constexpr inline QSize QSize::transposed() const noexcept
{ return QSize(ht, wd); }
inline void QSize::scale(int w, int h, Qt::AspectRatioMode mode) noexcept
{ scale(QSize(w, h), mode); }
inline void QSize::scale(const QSize &s, Qt::AspectRatioMode mode) noexcept
{ *this = scaled(s, mode); }
inline QSize QSize::scaled(int w, int h, Qt::AspectRatioMode mode) const noexcept
{ return scaled(QSize(w, h), mode); }
constexpr inline int &QSize::rwidth() noexcept
{ return wd.as_underlying(); }
constexpr inline int &QSize::rheight() noexcept
{ return ht.as_underlying(); }
constexpr inline QSize &QSize::operator+=(const QSize &s) noexcept
{
wd += s.wd;
ht += s.ht;
return *this;
}
constexpr inline QSize &QSize::operator-=(const QSize &s) noexcept
{
wd -= s.wd;
ht -= s.ht;
return *this;
}
constexpr inline QSize &QSize::operator*=(qreal c) noexcept
{
wd.setValue(QtPrivate::qSaturateRound(width() * c));
ht.setValue(QtPrivate::qSaturateRound(height() * c));
return *this;
}
constexpr inline size_t qHash(const QSize &s, size_t seed = 0) noexcept
{ return qHashMulti(seed, s.width(), s.height()); }
inline QSize &QSize::operator/=(qreal c)
{
Q_ASSERT(!qFuzzyIsNull(c));
wd.setValue(QtPrivate::qSaturateRound(width() / c));
ht.setValue(QtPrivate::qSaturateRound(height() / c));
return *this;
}
constexpr inline QSize QSize::expandedTo(const QSize & otherSize) const noexcept
{
return QSize(qMax(wd,otherSize.wd), qMax(ht,otherSize.ht));
}
constexpr inline QSize QSize::boundedTo(const QSize & otherSize) const noexcept
{
return QSize(qMin(wd,otherSize.wd), qMin(ht,otherSize.ht));
}
#ifndef QT_NO_DEBUG_STREAM
Q_CORE_EXPORT QDebug operator<<(QDebug, const QSize &);
#endif
class Q_CORE_EXPORT QSizeF
{
public:
constexpr QSizeF() noexcept;
constexpr QSizeF(const QSize &sz) noexcept;
constexpr QSizeF(qreal w, qreal h) noexcept;
inline bool isNull() const noexcept;
constexpr inline bool isEmpty() const noexcept;
constexpr inline bool isValid() const noexcept;
constexpr inline qreal width() const noexcept;
constexpr inline qreal height() const noexcept;
constexpr inline void setWidth(qreal w) noexcept;
constexpr inline void setHeight(qreal h) noexcept;
void transpose() noexcept;
[[nodiscard]] constexpr inline QSizeF transposed() const noexcept;
inline void scale(qreal w, qreal h, Qt::AspectRatioMode mode) noexcept;
inline void scale(const QSizeF &s, Qt::AspectRatioMode mode) noexcept;
[[nodiscard]] QSizeF scaled(qreal w, qreal h, Qt::AspectRatioMode mode) const noexcept;
[[nodiscard]] QSizeF scaled(const QSizeF &s, Qt::AspectRatioMode mode) const noexcept;
[[nodiscard]] constexpr inline QSizeF expandedTo(const QSizeF &) const noexcept;
[[nodiscard]] constexpr inline QSizeF boundedTo(const QSizeF &) const noexcept;
[[nodiscard]] constexpr QSizeF grownBy(QMarginsF m) const noexcept
{ return {width() + m.left() + m.right(), height() + m.top() + m.bottom()}; }
[[nodiscard]] constexpr QSizeF shrunkBy(QMarginsF m) const noexcept
{ return {width() - m.left() - m.right(), height() - m.top() - m.bottom()}; }
constexpr inline qreal &rwidth() noexcept;
constexpr inline qreal &rheight() noexcept;
constexpr inline QSizeF &operator+=(const QSizeF &) noexcept;
constexpr inline QSizeF &operator-=(const QSizeF &) noexcept;
constexpr inline QSizeF &operator*=(qreal c) noexcept;
inline QSizeF &operator/=(qreal c);
private:
friend constexpr bool qFuzzyCompare(const QSizeF &s1, const QSizeF &s2) noexcept
{
return QtPrivate::fuzzyCompare(s1.wd, s2.wd)
&& QtPrivate::fuzzyCompare(s1.ht, s2.ht);
}
friend constexpr bool qFuzzyIsNull(const QSizeF &size) noexcept
{ return qFuzzyIsNull(size.wd) && qFuzzyIsNull(size.ht); }
friend constexpr bool comparesEqual(const QSizeF &lhs, const QSizeF &rhs) noexcept
{ return qFuzzyCompare(lhs, rhs); }
Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QSizeF)
friend constexpr bool comparesEqual(const QSizeF &lhs, const QSize &rhs) noexcept
{ return comparesEqual(lhs, rhs.toSizeF()); }
Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QSizeF, QSize)
friend constexpr inline QSizeF operator+(const QSizeF &s1, const QSizeF &s2) noexcept
{ return QSizeF(s1.wd + s2.wd, s1.ht + s2.ht); }
friend constexpr inline QSizeF operator-(const QSizeF &s1, const QSizeF &s2) noexcept
{ return QSizeF(s1.wd - s2.wd, s1.ht - s2.ht); }
friend constexpr inline QSizeF operator*(const QSizeF &s, qreal c) noexcept
{ return QSizeF(s.wd * c, s.ht * c); }
friend constexpr inline QSizeF operator*(qreal c, const QSizeF &s) noexcept
{ return s * c; }
friend inline QSizeF operator/(const QSizeF &s, qreal c)
{ Q_ASSERT(!qFuzzyIsNull(c)); return QSizeF(s.wd / c, s.ht / c); }
public:
constexpr inline QSize toSize() const noexcept;
#if defined(Q_OS_DARWIN) || defined(Q_QDOC)
[[nodiscard]] static QSizeF fromCGSize(CGSize size) noexcept;
[[nodiscard]] CGSize toCGSize() const noexcept;
#endif
private:
qreal wd;
qreal ht;
template <std::size_t I,
typename S,
std::enable_if_t<(I < 2), bool> = true,
std::enable_if_t<std::is_same_v<q20::remove_cvref_t<S>, QSizeF>, bool> = true>
friend constexpr decltype(auto) get(S &&s) noexcept
{
if constexpr (I == 0)
return q23::forward_like<S>(s.wd);
else if constexpr (I == 1)
return q23::forward_like<S>(s.ht);
}
};
Q_DECLARE_TYPEINFO(QSizeF, Q_RELOCATABLE_TYPE);
/*****************************************************************************
QSizeF stream functions
*****************************************************************************/
#ifndef QT_NO_DATASTREAM
Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QSizeF &);
Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QSizeF &);
#endif
/*****************************************************************************
QSizeF inline functions
*****************************************************************************/
constexpr inline QSizeF::QSizeF() noexcept : wd(-1.), ht(-1.) {}
constexpr inline QSizeF::QSizeF(const QSize &sz) noexcept : wd(sz.width()), ht(sz.height()) {}
constexpr inline QSizeF::QSizeF(qreal w, qreal h) noexcept : wd(w), ht(h) {}
inline bool QSizeF::isNull() const noexcept
{ return qIsNull(wd) && qIsNull(ht); }
constexpr inline bool QSizeF::isEmpty() const noexcept
{ return wd <= 0. || ht <= 0.; }
constexpr inline bool QSizeF::isValid() const noexcept
{ return wd >= 0. && ht >= 0.; }
constexpr inline qreal QSizeF::width() const noexcept
{ return wd; }
constexpr inline qreal QSizeF::height() const noexcept
{ return ht; }
constexpr inline void QSizeF::setWidth(qreal w) noexcept
{ wd = w; }
constexpr inline void QSizeF::setHeight(qreal h) noexcept
{ ht = h; }
constexpr inline QSizeF QSizeF::transposed() const noexcept
{ return QSizeF(ht, wd); }
inline void QSizeF::scale(qreal w, qreal h, Qt::AspectRatioMode mode) noexcept
{ scale(QSizeF(w, h), mode); }
inline void QSizeF::scale(const QSizeF &s, Qt::AspectRatioMode mode) noexcept
{ *this = scaled(s, mode); }
inline QSizeF QSizeF::scaled(qreal w, qreal h, Qt::AspectRatioMode mode) const noexcept
{ return scaled(QSizeF(w, h), mode); }
constexpr inline qreal &QSizeF::rwidth() noexcept
{ return wd; }
constexpr inline qreal &QSizeF::rheight() noexcept
{ return ht; }
constexpr inline QSizeF &QSizeF::operator+=(const QSizeF &s) noexcept
{
wd += s.wd;
ht += s.ht;
return *this;
}
constexpr inline QSizeF &QSizeF::operator-=(const QSizeF &s) noexcept
{
wd -= s.wd;
ht -= s.ht;
return *this;
}
constexpr inline QSizeF &QSizeF::operator*=(qreal c) noexcept
{
wd *= c;
ht *= c;
return *this;
}
inline QSizeF &QSizeF::operator/=(qreal c)
{
Q_ASSERT(!qFuzzyIsNull(c) && qIsFinite(c));
wd = wd / c;
ht = ht / c;
return *this;
}
constexpr inline QSizeF QSizeF::expandedTo(const QSizeF &otherSize) const noexcept
{
return QSizeF(qMax(wd, otherSize.wd), qMax(ht, otherSize.ht));
}
constexpr inline QSizeF QSizeF::boundedTo(const QSizeF &otherSize) const noexcept
{
return QSizeF(qMin(wd, otherSize.wd), qMin(ht, otherSize.ht));
}
constexpr inline QSize QSizeF::toSize() const noexcept
{
return QSize(QtPrivate::qSaturateRound(wd), QtPrivate::qSaturateRound(ht));
}
constexpr QSizeF QSize::toSizeF() const noexcept { return *this; }
#ifndef QT_NO_DEBUG_STREAM
Q_CORE_EXPORT QDebug operator<<(QDebug, const QSizeF &);
#endif
QT_END_NAMESPACE
/*****************************************************************************
QSize/QSizeF tuple protocol
*****************************************************************************/
namespace std {
template <>
class tuple_size<QT_PREPEND_NAMESPACE(QSize)> : public integral_constant<size_t, 2> {};
template <>
class tuple_element<0, QT_PREPEND_NAMESPACE(QSize)> { public: using type = int; };
template <>
class tuple_element<1, QT_PREPEND_NAMESPACE(QSize)> { public: using type = int; };
template <>
class tuple_size<QT_PREPEND_NAMESPACE(QSizeF)> : public integral_constant<size_t, 2> {};
template <>
class tuple_element<0, QT_PREPEND_NAMESPACE(QSizeF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
template <>
class tuple_element<1, QT_PREPEND_NAMESPACE(QSizeF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
}
#endif // QSIZE_H