include/QtCore/qtdeprecationmarkers.h

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 QTDEPRECATIONMARKERS_H
0005 #define QTDEPRECATIONMARKERS_H
0006
0007 #include <QtCore/qtconfigmacros.h>
0008 #include <QtCore/qtversionchecks.h>
0009 #include <QtCore/qcompilerdetection.h> // for Q_DECL_DEPRECATED
0010
0011 #if 0
0012 #pragma qt_class(QtDeprecationMarkers)
0013 #pragma qt_sync_stop_processing
0014 #endif
0015
0016 QT_BEGIN_NAMESPACE
0017
0018 #if defined(QT_NO_DEPRECATED)
0019 #  undef QT_DEPRECATED
0020 #  undef QT_DEPRECATED_X
0021 #  undef QT_DEPRECATED_VARIABLE
0022 #  undef QT_DEPRECATED_CONSTRUCTOR
0023 #elif !defined(QT_NO_DEPRECATED_WARNINGS)
0024 #  undef QT_DEPRECATED
0025 #  define QT_DEPRECATED Q_DECL_DEPRECATED
0026 #  undef QT_DEPRECATED_X
0027 #  define QT_DEPRECATED_X(text) Q_DECL_DEPRECATED_X(text)
0028 #  undef QT_DEPRECATED_VARIABLE
0029 #  define QT_DEPRECATED_VARIABLE Q_DECL_VARIABLE_DEPRECATED
0030 #  undef QT_DEPRECATED_CONSTRUCTOR
0031 #  define QT_DEPRECATED_CONSTRUCTOR Q_DECL_CONSTRUCTOR_DEPRECATED explicit
0032 #else
0033 #  undef QT_DEPRECATED
0034 #  define QT_DEPRECATED
0035 #  undef QT_DEPRECATED_X
0036 #  define QT_DEPRECATED_X(text)
0037 #  undef QT_DEPRECATED_VARIABLE
0038 #  define QT_DEPRECATED_VARIABLE
0039 #  undef QT_DEPRECATED_CONSTRUCTOR
0040 #  define QT_DEPRECATED_CONSTRUCTOR
0041 #  undef Q_DECL_ENUMERATOR_DEPRECATED
0042 #  define Q_DECL_ENUMERATOR_DEPRECATED
0043 #  undef Q_DECL_ENUMERATOR_DEPRECATED_X
0044 #  define Q_DECL_ENUMERATOR_DEPRECATED_X(ignored)
0045 #endif
0046
0047 // If the deprecated macro is defined, use its value
0048 #if !defined(QT_DISABLE_DEPRECATED_UP_TO) && defined(QT_DISABLE_DEPRECATED_BEFORE)
0049 #  define QT_DISABLE_DEPRECATED_UP_TO QT_DISABLE_DEPRECATED_BEFORE
0050 #endif
0051
0052 // If the deprecated macro is defined, use its value
0053 #if !defined(QT_WARN_DEPRECATED_UP_TO) && defined(QT_DEPRECATED_WARNINGS_SINCE)
0054 #  define QT_WARN_DEPRECATED_UP_TO QT_DEPRECATED_WARNINGS_SINCE
0055 #endif
0056
0057 #ifndef QT_WARN_DEPRECATED_UP_TO
0058 # ifdef QT_DISABLE_DEPRECATED_UP_TO
0059 #  define QT_WARN_DEPRECATED_UP_TO QT_DISABLE_DEPRECATED_UP_TO
0060 # else
0061 #  define QT_WARN_DEPRECATED_UP_TO QT_VERSION
0062 # endif
0063 #endif
0064
0065 #ifndef QT_DISABLE_DEPRECATED_UP_TO
0066 #define QT_DISABLE_DEPRECATED_UP_TO QT_VERSION_CHECK(5, 0, 0)
0067 #endif
0068
0069 /*
0070     QT_DEPRECATED_SINCE(major, minor) evaluates as true if the Qt version is greater than
0071     the deprecation point specified.
0072
0073     Use it to specify from which version of Qt a function or class has been deprecated
0074
0075     Example:
0076         #if QT_DEPRECATED_SINCE(5,1)
0077             QT_DEPRECATED void deprecatedFunction(); //function deprecated since Qt 5.1
0078         #endif
0079
0080 */
0081 #ifdef QT_DEPRECATED
0082 #define QT_DEPRECATED_SINCE(major, minor) (QT_VERSION_CHECK(major, minor, 0) > QT_DISABLE_DEPRECATED_UP_TO)
0083 #else
0084 #define QT_DEPRECATED_SINCE(major, minor) 0
0085 #endif
0086
0087 /*
0088   QT_DEPRECATED_VERSION(major, minor) and QT_DEPRECATED_VERSION_X(major, minor, text)
0089   outputs a deprecation warning if QT_WARN_DEPRECATED_UP_TO is equal to or greater
0090   than the version specified as major, minor. This makes it possible to deprecate a
0091   function without annoying a user who needs to stay compatible with a specified minimum
0092   version and therefore can't use the new function.
0093 */
0094 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(5, 12, 0)
0095 # define QT_DEPRECATED_VERSION_X_5_12(text) QT_DEPRECATED_X(text)
0096 # define QT_DEPRECATED_VERSION_5_12         QT_DEPRECATED
0097 #else
0098 # define QT_DEPRECATED_VERSION_X_5_12(text)
0099 # define QT_DEPRECATED_VERSION_5_12
0100 #endif
0101
0102 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(5, 13, 0)
0103 # define QT_DEPRECATED_VERSION_X_5_13(text) QT_DEPRECATED_X(text)
0104 # define QT_DEPRECATED_VERSION_5_13         QT_DEPRECATED
0105 #else
0106 # define QT_DEPRECATED_VERSION_X_5_13(text)
0107 # define QT_DEPRECATED_VERSION_5_13
0108 #endif
0109
0110 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(5, 14, 0)
0111 # define QT_DEPRECATED_VERSION_X_5_14(text) QT_DEPRECATED_X(text)
0112 # define QT_DEPRECATED_VERSION_5_14         QT_DEPRECATED
0113 #else
0114 # define QT_DEPRECATED_VERSION_X_5_14(text)
0115 # define QT_DEPRECATED_VERSION_5_14
0116 #endif
0117
0118 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(5, 15, 0)
0119 # define QT_DEPRECATED_VERSION_X_5_15(text) QT_DEPRECATED_X(text)
0120 # define QT_DEPRECATED_VERSION_5_15         QT_DEPRECATED
0121 #else
0122 # define QT_DEPRECATED_VERSION_X_5_15(text)
0123 # define QT_DEPRECATED_VERSION_5_15
0124 #endif
0125
0126 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 0, 0)
0127 # define QT_DEPRECATED_VERSION_X_6_0(text) QT_DEPRECATED_X(text)
0128 # define QT_DEPRECATED_VERSION_6_0         QT_DEPRECATED
0129 #else
0130 # define QT_DEPRECATED_VERSION_X_6_0(text)
0131 # define QT_DEPRECATED_VERSION_6_0
0132 #endif
0133
0134 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 1, 0)
0135 # define QT_DEPRECATED_VERSION_X_6_1(text) QT_DEPRECATED_X(text)
0136 # define QT_DEPRECATED_VERSION_6_1         QT_DEPRECATED
0137 #else
0138 # define QT_DEPRECATED_VERSION_X_6_1(text)
0139 # define QT_DEPRECATED_VERSION_6_1
0140 #endif
0141
0142 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 2, 0)
0143 # define QT_DEPRECATED_VERSION_X_6_2(text) QT_DEPRECATED_X(text)
0144 # define QT_DEPRECATED_VERSION_6_2         QT_DEPRECATED
0145 #else
0146 # define QT_DEPRECATED_VERSION_X_6_2(text)
0147 # define QT_DEPRECATED_VERSION_6_2
0148 #endif
0149
0150 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 3, 0)
0151 # define QT_DEPRECATED_VERSION_X_6_3(text) QT_DEPRECATED_X(text)
0152 # define QT_DEPRECATED_VERSION_6_3         QT_DEPRECATED
0153 #else
0154 # define QT_DEPRECATED_VERSION_X_6_3(text)
0155 # define QT_DEPRECATED_VERSION_6_3
0156 #endif
0157
0158 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 4, 0)
0159 # define QT_DEPRECATED_VERSION_X_6_4(text) QT_DEPRECATED_X(text)
0160 # define QT_DEPRECATED_VERSION_6_4         QT_DEPRECATED
0161 #else
0162 # define QT_DEPRECATED_VERSION_X_6_4(text)
0163 # define QT_DEPRECATED_VERSION_6_4
0164 #endif
0165
0166 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 5, 0)
0167 # define QT_DEPRECATED_VERSION_X_6_5(text) QT_DEPRECATED_X(text)
0168 # define QT_DEPRECATED_VERSION_6_5         QT_DEPRECATED
0169 #else
0170 # define QT_DEPRECATED_VERSION_X_6_5(text)
0171 # define QT_DEPRECATED_VERSION_6_5
0172 #endif
0173
0174 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 6, 0)
0175 # define QT_DEPRECATED_VERSION_X_6_6(text) QT_DEPRECATED_X(text)
0176 # define QT_DEPRECATED_VERSION_6_6         QT_DEPRECATED
0177 #else
0178 # define QT_DEPRECATED_VERSION_X_6_6(text)
0179 # define QT_DEPRECATED_VERSION_6_6
0180 #endif
0181
0182 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 7, 0)
0183 # define QT_DEPRECATED_VERSION_X_6_7(text) QT_DEPRECATED_X(text)
0184 # define QT_DEPRECATED_VERSION_6_7         QT_DEPRECATED
0185 #else
0186 # define QT_DEPRECATED_VERSION_X_6_7(text)
0187 # define QT_DEPRECATED_VERSION_6_7
0188 #endif
0189
0190 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 8, 0)
0191 # define QT_DEPRECATED_VERSION_X_6_8(text) QT_DEPRECATED_X(text)
0192 # define QT_DEPRECATED_VERSION_6_8         QT_DEPRECATED
0193 #else
0194 # define QT_DEPRECATED_VERSION_X_6_8(text)
0195 # define QT_DEPRECATED_VERSION_6_8
0196 #endif
0197
0198 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 9, 0)
0199 # define QT_DEPRECATED_VERSION_X_6_9(text) QT_DEPRECATED_X(text)
0200 # define QT_DEPRECATED_VERSION_6_9         QT_DEPRECATED
0201 #else
0202 # define QT_DEPRECATED_VERSION_X_6_9(text)
0203 # define QT_DEPRECATED_VERSION_6_9
0204 #endif
0205
0206 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 10, 0)
0207 # define QT_DEPRECATED_VERSION_X_6_10(text) QT_DEPRECATED_X(text)
0208 # define QT_DEPRECATED_VERSION_6_10         QT_DEPRECATED
0209 #else
0210 # define QT_DEPRECATED_VERSION_X_6_10(text)
0211 # define QT_DEPRECATED_VERSION_6_10
0212 #endif
0213
0214 #if QT_WARN_DEPRECATED_UP_TO >= QT_VERSION_CHECK(6, 11, 0)
0215 # define QT_DEPRECATED_VERSION_X_6_11(text) QT_DEPRECATED_X(text)
0216 # define QT_DEPRECATED_VERSION_6_11         QT_DEPRECATED
0217 #else
0218 # define QT_DEPRECATED_VERSION_X_6_11(text)
0219 # define QT_DEPRECATED_VERSION_6_11
0220 #endif
0221
0222 #define QT_DEPRECATED_VERSION_X_5(minor, text)      QT_DEPRECATED_VERSION_X_5_##minor(text)
0223 #define QT_DEPRECATED_VERSION_X(major, minor, text) QT_DEPRECATED_VERSION_X_##major##_##minor(text)
0224
0225 #define QT_DEPRECATED_VERSION_5(minor)      QT_DEPRECATED_VERSION_5_##minor
0226 #define QT_DEPRECATED_VERSION(major, minor) QT_DEPRECATED_VERSION_##major##_##minor
0227
0228 /*
0229     QT_IF_DEPRECATED_SINCE(major, minor, whenTrue, whenFalse) expands to
0230     \a whenTrue if the specified (\a major, \a minor) version is less than or
0231     equal to the deprecation version defined by QT_DISABLE_DEPRECATED_UP_TO,
0232     and to \a whenFalse otherwise.
0233
0234     Currently used for QT_INLINE_SINCE(maj, min), but can also be helpful for
0235     other macros of that kind.
0236
0237     The implementation uses QT_DEPRECATED_SINCE(maj, min) to define a bunch of
0238     helper QT_IF_DEPRECATED_SINCE_X_Y macros, which expand to \a whenTrue or
0239     \a whenFalse depending on the value of QT_DEPRECATED_SINCE.
0240
0241     If you need to use QT_IF_DEPRECATED_SINCE() for a (major, minor) version,
0242     that is not yet covered by the list below, you need to copy the definition
0243     and change the major and minor versions accordingly. For example, for
0244     version (X, Y), you will need to add
0245
0246     \code
0247     #if QT_DEPRECATED_SINCE(X, Y)
0248     # define QT_IF_DEPRECATED_SINCE_X_Y(whenTrue, whenFalse) whenFalse
0249     #else
0250     # define QT_IF_DEPRECATED_SINCE_X_Y(whenTrue, whenFalse) whenTrue
0251     #endif
0252     \endcode
0253 */
0254
0255 #define QT_IF_DEPRECATED_SINCE(major, minor, whenTrue, whenFalse) \
0256     QT_IF_DEPRECATED_SINCE_ ## major ## _ ## minor(whenTrue, whenFalse)
0257
0258 #if QT_DEPRECATED_SINCE(6, 0)
0259 # define QT_IF_DEPRECATED_SINCE_6_0(whenTrue, whenFalse) whenFalse
0260 #else
0261 # define QT_IF_DEPRECATED_SINCE_6_0(whenTrue, whenFalse) whenTrue
0262 #endif
0263
0264 #if QT_DEPRECATED_SINCE(6, 1)
0265 # define QT_IF_DEPRECATED_SINCE_6_1(whenTrue, whenFalse) whenFalse
0266 #else
0267 # define QT_IF_DEPRECATED_SINCE_6_1(whenTrue, whenFalse) whenTrue
0268 #endif
0269
0270 #if QT_DEPRECATED_SINCE(6, 2)
0271 # define QT_IF_DEPRECATED_SINCE_6_2(whenTrue, whenFalse) whenFalse
0272 #else
0273 # define QT_IF_DEPRECATED_SINCE_6_2(whenTrue, whenFalse) whenTrue
0274 #endif
0275
0276 #if QT_DEPRECATED_SINCE(6, 3)
0277 # define QT_IF_DEPRECATED_SINCE_6_3(whenTrue, whenFalse) whenFalse
0278 #else
0279 # define QT_IF_DEPRECATED_SINCE_6_3(whenTrue, whenFalse) whenTrue
0280 #endif
0281
0282 #if QT_DEPRECATED_SINCE(6, 4)
0283 # define QT_IF_DEPRECATED_SINCE_6_4(whenTrue, whenFalse) whenFalse
0284 #else
0285 # define QT_IF_DEPRECATED_SINCE_6_4(whenTrue, whenFalse) whenTrue
0286 #endif
0287
0288 #if QT_DEPRECATED_SINCE(6, 5)
0289 # define QT_IF_DEPRECATED_SINCE_6_5(whenTrue, whenFalse) whenFalse
0290 #else
0291 # define QT_IF_DEPRECATED_SINCE_6_5(whenTrue, whenFalse) whenTrue
0292 #endif
0293
0294 #if QT_DEPRECATED_SINCE(6, 6)
0295 # define QT_IF_DEPRECATED_SINCE_6_6(whenTrue, whenFalse) whenFalse
0296 #else
0297 # define QT_IF_DEPRECATED_SINCE_6_6(whenTrue, whenFalse) whenTrue
0298 #endif
0299
0300 #if QT_DEPRECATED_SINCE(6, 7)
0301 # define QT_IF_DEPRECATED_SINCE_6_7(whenTrue, whenFalse) whenFalse
0302 #else
0303 # define QT_IF_DEPRECATED_SINCE_6_7(whenTrue, whenFalse) whenTrue
0304 #endif
0305
0306 #if QT_DEPRECATED_SINCE(6, 8)
0307 # define QT_IF_DEPRECATED_SINCE_6_8(whenTrue, whenFalse) whenFalse
0308 #else
0309 # define QT_IF_DEPRECATED_SINCE_6_8(whenTrue, whenFalse) whenTrue
0310 #endif
0311
0312 #if QT_DEPRECATED_SINCE(6, 9)
0313 # define QT_IF_DEPRECATED_SINCE_6_9(whenTrue, whenFalse) whenFalse
0314 #else
0315 # define QT_IF_DEPRECATED_SINCE_6_9(whenTrue, whenFalse) whenTrue
0316 #endif
0317
0318 #if QT_DEPRECATED_SINCE(6, 10)
0319 # define QT_IF_DEPRECATED_SINCE_6_10(whenTrue, whenFalse) whenFalse
0320 #else
0321 # define QT_IF_DEPRECATED_SINCE_6_10(whenTrue, whenFalse) whenTrue
0322 #endif
0323
0324 #if QT_DEPRECATED_SINCE(6, 11)
0325 # define QT_IF_DEPRECATED_SINCE_6_11(whenTrue, whenFalse) whenFalse
0326 #else
0327 # define QT_IF_DEPRECATED_SINCE_6_11(whenTrue, whenFalse) whenTrue
0328 #endif
0329
0330 #ifdef __cplusplus
0331 // A tag to help mark stuff deprecated (cf. QStringViewLiteral)
0332 namespace QtPrivate {
0333 enum class Deprecated_t {};
0334 constexpr inline Deprecated_t Deprecated = {};
0335 }
0336 #endif
0337
0338 #ifdef QT_ASCII_CAST_WARNINGS
0339 #  define QT_ASCII_CAST_WARN \
0340     Q_DECL_DEPRECATED_X("Use fromUtf8, QStringLiteral, or QLatin1StringView")
0341 #else
0342 #  define QT_ASCII_CAST_WARN
0343 #endif
0344
0345 QT_END_NAMESPACE
0346
0347 #endif // QTDEPRECATIONMARKERS_H