diff options
Diffstat (limited to 'src/lib')
20 files changed, 292 insertions, 67 deletions
diff --git a/src/lib/corelib/CMakeLists.txt b/src/lib/corelib/CMakeLists.txt index a6efd0ff3..7c358722d 100644 --- a/src/lib/corelib/CMakeLists.txt +++ b/src/lib/corelib/CMakeLists.txt @@ -306,6 +306,7 @@ set(TOOLS_SOURCES cleanoptions.cpp codelocation.cpp commandechomode.cpp + deprecationwarningmode.cpp dynamictypecheck.h error.cpp executablefinder.cpp @@ -389,6 +390,7 @@ set(TOOLS_HEADERS cleanoptions.h codelocation.h commandechomode.h + deprecationwarningmode.h error.h generateoptions.h installoptions.h diff --git a/src/lib/corelib/corelib.qbs b/src/lib/corelib/corelib.qbs index cf3c45cda..91532c14e 100644 --- a/src/lib/corelib/corelib.qbs +++ b/src/lib/corelib/corelib.qbs @@ -410,6 +410,7 @@ QbsLibrary { "cleanoptions.cpp", "codelocation.cpp", "commandechomode.cpp", + "deprecationwarningmode.cpp", "dynamictypecheck.h", "error.cpp", "executablefinder.cpp", @@ -495,6 +496,7 @@ QbsLibrary { "cleanoptions.h", "codelocation.h", "commandechomode.h", + "deprecationwarningmode.h", "error.h", "generateoptions.h", "installoptions.h", diff --git a/src/lib/corelib/language/deprecationinfo.h b/src/lib/corelib/language/deprecationinfo.h index 89cd07f4a..2f9bfc103 100644 --- a/src/lib/corelib/language/deprecationinfo.h +++ b/src/lib/corelib/language/deprecationinfo.h @@ -39,6 +39,11 @@ #ifndef QBS_DEPRECATIONINFO_H #define QBS_DEPRECATIONINFO_H +#include <api/languageinfo.h> +#include <logging/logger.h> +#include <logging/translator.h> +#include <tools/deprecationwarningmode.h> +#include <tools/error.h> #include <tools/version.h> #include <QtCore/qstring.h> @@ -58,7 +63,46 @@ public: bool isValid() const { return m_removalVersion.isValid(); } Version removalVersion() const { return m_removalVersion; } - QString additionalUserInfo() const { return m_additionalUserInfo; } + + ErrorInfo checkForDeprecation(DeprecationWarningMode mode, const QString &name, + const CodeLocation &loc, bool isItem, Logger &logger) const + { + if (!isValid()) + return {}; + const Version qbsVersion = LanguageInfo::qbsVersion(); + if (removalVersion() <= qbsVersion) { + const QString msgTemplate = isItem + ? Tr::tr("The item '%1' can no longer be used. It was removed in Qbs %2.") + : Tr::tr("The property '%1' can no longer be used. It was removed in Qbs %2."); + ErrorInfo error(msgTemplate.arg(name, removalVersion().toString()), loc); + if (!m_additionalUserInfo.isEmpty()) + error.append(m_additionalUserInfo); + return error; + } + const QString msgTemplate = isItem + ? Tr::tr("The item '%1' is deprecated and will be removed in Qbs %2.") + : Tr::tr("The property '%1' is deprecated and will be removed in Qbs %2."); + ErrorInfo error(msgTemplate.arg(name, removalVersion().toString()), loc); + if (!m_additionalUserInfo.isEmpty()) + error.append(m_additionalUserInfo); + switch (mode) { + case DeprecationWarningMode::Error: + return error; + case DeprecationWarningMode::On: + logger.printWarning(error); + break; + case DeprecationWarningMode::BeforeRemoval: { + const Version next(qbsVersion.majorVersion(), qbsVersion.minorVersion() + 1); + if (removalVersion() == next || removalVersion().minorVersion() == 0) + logger.printWarning(error); + break; + } + case DeprecationWarningMode::Off: + break; + } + + return {}; + } private: Version m_removalVersion; diff --git a/src/lib/corelib/language/item.cpp b/src/lib/corelib/language/item.cpp index 178a34b00..c58d2058d 100644 --- a/src/lib/corelib/language/item.cpp +++ b/src/lib/corelib/language/item.cpp @@ -246,7 +246,7 @@ bool Item::isPresentModule() const return v && v->type() == Value::JSSourceValueType; } -void Item::setupForBuiltinType(Logger &logger) +void Item::setupForBuiltinType(DeprecationWarningMode deprecationMode, Logger &logger) { const BuiltinDeclarations &builtins = BuiltinDeclarations::instance(); const auto properties = builtins.declarationsForType(type()).properties(); @@ -263,23 +263,9 @@ void Item::setupForBuiltinType(Logger &logger) ? StringConstants::undefinedValue() : pd.initialValueSource()); m_properties.insert(pd.name(), sourceValue); - } else if (pd.isDeprecated()) { - const DeprecationInfo &di = pd.deprecationInfo(); - if (di.removalVersion() <= LanguageInfo::qbsVersion()) { - QString message = Tr::tr("The property '%1' is no longer valid for %2 items. " - "It was removed in qbs %3.") - .arg(pd.name(), typeName(), di.removalVersion().toString()); - ErrorInfo error(message, value->location()); - if (!di.additionalUserInfo().isEmpty()) - error.append(di.additionalUserInfo()); - throw error; - } - QString warning = Tr::tr("The property '%1' is deprecated and will be removed in " - "qbs %2.").arg(pd.name(), di.removalVersion().toString()); - ErrorInfo error(warning, value->location()); - if (!di.additionalUserInfo().isEmpty()) - error.append(di.additionalUserInfo()); - logger.printWarning(error); + } else if (ErrorInfo error = pd.checkForDeprecation(deprecationMode, value->location(), + logger); error.hasError()) { + throw error; } } } diff --git a/src/lib/corelib/language/item.h b/src/lib/corelib/language/item.h index 22cf6b810..60d74a3f4 100644 --- a/src/lib/corelib/language/item.h +++ b/src/lib/corelib/language/item.h @@ -46,6 +46,7 @@ #include "qualifiedid.h" #include <parser/qmljsmemorypool_p.h> #include <tools/codelocation.h> +#include <tools/deprecationwarningmode.h> #include <tools/error.h> #include <tools/version.h> @@ -144,7 +145,7 @@ public: static void removeChild(Item *parent, Item *child); void dump() const; bool isPresentModule() const; - void setupForBuiltinType(Logger &logger); + void setupForBuiltinType(DeprecationWarningMode deprecationMode, Logger &logger); void copyProperty(const QString &propertyName, Item *target) const; void overrideProperties( const QVariantMap &config, diff --git a/src/lib/corelib/language/itemdeclaration.cpp b/src/lib/corelib/language/itemdeclaration.cpp index d7230e9d6..eb9fd84a6 100644 --- a/src/lib/corelib/language/itemdeclaration.cpp +++ b/src/lib/corelib/language/itemdeclaration.cpp @@ -60,5 +60,11 @@ bool ItemDeclaration::isChildTypeAllowed(ItemType type) const return m_allowedChildTypes.contains(type); } +ErrorInfo ItemDeclaration::checkForDeprecation(DeprecationWarningMode mode, const QString &name, + const CodeLocation &loc, Logger &logger) const +{ + return deprecationInfo().checkForDeprecation(mode, name, loc, true, logger); +} + } // namespace Internal } // namespace qbs diff --git a/src/lib/corelib/language/itemdeclaration.h b/src/lib/corelib/language/itemdeclaration.h index 6da699d28..1fbd7e456 100644 --- a/src/lib/corelib/language/itemdeclaration.h +++ b/src/lib/corelib/language/itemdeclaration.h @@ -71,6 +71,9 @@ public: const TypeNames &allowedChildTypes() const { return m_allowedChildTypes; } bool isChildTypeAllowed(ItemType type) const; + ErrorInfo checkForDeprecation(DeprecationWarningMode mode, const QString &name, + const CodeLocation &loc, Logger &logger) const; + private: ItemType m_type; Properties m_properties; diff --git a/src/lib/corelib/language/itemreader.cpp b/src/lib/corelib/language/itemreader.cpp index 1abc5caf9..a29b36320 100644 --- a/src/lib/corelib/language/itemreader.cpp +++ b/src/lib/corelib/language/itemreader.cpp @@ -143,5 +143,10 @@ void ItemReader::setEnableTiming(bool on) m_elapsedTime = on ? 0 : -1; } +void ItemReader::setDeprecationWarningMode(DeprecationWarningMode mode) +{ + m_visitorState->setDeprecationWarningMode(mode); +} + } // namespace Internal } // namespace qbs diff --git a/src/lib/corelib/language/itemreader.h b/src/lib/corelib/language/itemreader.h index 3dc5329d2..6b2531cf2 100644 --- a/src/lib/corelib/language/itemreader.h +++ b/src/lib/corelib/language/itemreader.h @@ -40,8 +40,8 @@ #ifndef QBS_ITEMREADER_H #define QBS_ITEMREADER_H -#include "forward_decls.h" #include <logging/logger.h> +#include <tools/deprecationwarningmode.h> #include <tools/set.h> #include <QtCore/qstringlist.h> @@ -87,6 +87,8 @@ public: void setEnableTiming(bool on); qint64 elapsedTime() const { return m_elapsedTime; } + void setDeprecationWarningMode(DeprecationWarningMode mode); + private: ItemPool *m_pool = nullptr; QStringList m_searchPaths; diff --git a/src/lib/corelib/language/itemreaderastvisitor.cpp b/src/lib/corelib/language/itemreaderastvisitor.cpp index f22a1c4e8..721f24079 100644 --- a/src/lib/corelib/language/itemreaderastvisitor.cpp +++ b/src/lib/corelib/language/itemreaderastvisitor.cpp @@ -173,7 +173,7 @@ bool ItemReaderASTVisitor::visit(AST::UiObjectDefinition *ast) // Only the item at the top of the inheritance chain is a built-in item. // We cannot do this in "part 1", because then the visitor would complain about duplicate // bindings. - item->setupForBuiltinType(m_logger); + item->setupForBuiltinType(m_visitorState.deprecationWarningMode(), m_logger); } return false; @@ -369,24 +369,10 @@ void ItemReaderASTVisitor::checkDeprecationStatus(ItemType itemType, const QStri const CodeLocation &itemLocation) { const ItemDeclaration itemDecl = BuiltinDeclarations::instance().declarationsForType(itemType); - const DeprecationInfo &di = itemDecl.deprecationInfo(); - if (!di.isValid()) - return; - if (di.removalVersion() <= LanguageInfo::qbsVersion()) { - QString message = Tr::tr("The item '%1' cannot be used anymore. " - "It was removed in qbs %2.") - .arg(itemName, di.removalVersion().toString()); - ErrorInfo error(message, itemLocation); - if (!di.additionalUserInfo().isEmpty()) - error.append(di.additionalUserInfo()); + const ErrorInfo error = itemDecl.checkForDeprecation(m_visitorState.deprecationWarningMode(), + itemName, itemLocation, m_logger); + if (error.hasError()) throw error; - } - QString warning = Tr::tr("The item '%1' is deprecated and will be removed in " - "qbs %2.").arg(itemName, di.removalVersion().toString()); - ErrorInfo error(warning, itemLocation); - if (!di.additionalUserInfo().isEmpty()) - error.append(di.additionalUserInfo()); - m_logger.printWarning(error); } void ItemReaderASTVisitor::doCheckItemTypes(const Item *item) diff --git a/src/lib/corelib/language/itemreadervisitorstate.h b/src/lib/corelib/language/itemreadervisitorstate.h index 3901be16e..90f88cd5e 100644 --- a/src/lib/corelib/language/itemreadervisitorstate.h +++ b/src/lib/corelib/language/itemreadervisitorstate.h @@ -40,6 +40,7 @@ #define QBS_ITEMREADERVISITORSTATE_H #include <logging/logger.h> +#include <tools/deprecationwarningmode.h> #include <tools/set.h> #include <QtCore/qstringlist.h> @@ -67,7 +68,11 @@ public: Item *mostDerivingItem() const; void setMostDerivingItem(Item *item); + void setDeprecationWarningMode(DeprecationWarningMode mode) { m_deprecationWarningMode = mode; } + DeprecationWarningMode deprecationWarningMode() const { return m_deprecationWarningMode; } + private: + DeprecationWarningMode m_deprecationWarningMode = defaultDeprecationWarningMode(); Logger &m_logger; Set<QString> m_filesRead; QHash<QString, QStringList> m_directoryEntries; diff --git a/src/lib/corelib/language/moduleloader.cpp b/src/lib/corelib/language/moduleloader.cpp index f17a4e200..86553916b 100644 --- a/src/lib/corelib/language/moduleloader.cpp +++ b/src/lib/corelib/language/moduleloader.cpp @@ -290,6 +290,7 @@ ModuleLoaderResult ModuleLoader::load(const SetupProjectParameters ¶meters) m_modulePrototypeEnabledInfo.clear(); m_parameterDeclarations.clear(); m_disabledItems.clear(); + m_reader->setDeprecationWarningMode(parameters.deprecationWarningMode()); m_reader->clearExtraSearchPathsStack(); m_reader->setEnableTiming(parameters.logElapsedTime()); m_moduleProviderLoader->setProjectParameters(m_parameters); @@ -500,28 +501,10 @@ private: continue; const PropertyDeclaration decl = item->propertyDeclaration(it.key()); if (decl.isValid()) { - if (!decl.isDeprecated()) - continue; - const DeprecationInfo &di = decl.deprecationInfo(); - QString message; - bool warningOnly; - if (decl.isExpired()) { - message = Tr::tr("The property '%1' can no longer be used. " - "It was removed in Qbs %2.") - .arg(decl.name(), di.removalVersion().toString()); - warningOnly = false; - } else { - message = Tr::tr("The property '%1' is deprecated and will be removed " - "in Qbs %2.").arg(decl.name(), di.removalVersion().toString()); - warningOnly = true; - } - ErrorInfo error(message, it.value()->location()); - if (!di.additionalUserInfo().isEmpty()) - error.append(di.additionalUserInfo()); - if (warningOnly) - m_logger.printWarning(error); - else - handlePropertyError(error, m_params, m_logger); + const ErrorInfo deprecationError = decl.checkForDeprecation( + m_params.deprecationWarningMode(), it.value()->location(), m_logger); + if (deprecationError.hasError()) + handlePropertyError(deprecationError, m_params, m_logger); continue; } m_currentName = it.key(); @@ -979,7 +962,7 @@ QList<Item *> ModuleLoader::multiplexProductItem(ProductContext *dummyContext, I dependsItem->setProperty(StringConstants::profilesProperty(), VariantValue::create(QStringList())); dependsItem->setFile(aggregator->file()); - dependsItem->setupForBuiltinType(m_logger); + dependsItem->setupForBuiltinType(m_parameters.deprecationWarningMode(), m_logger); Item::addChild(aggregator, dependsItem); } } @@ -1289,13 +1272,13 @@ void ModuleLoader::prepareProduct(ProjectContext *projectContext, Item *productI importer->setFile(productItem->file()); importer->setLocation(productItem->location()); importer->setScope(projectContext->scope); - importer->setupForBuiltinType(m_logger); + importer->setupForBuiltinType(m_parameters.deprecationWarningMode(), m_logger); Item * const dependsItem = Item::create(productItem->pool(), ItemType::Depends); dependsItem->setProperty(QStringLiteral("name"), VariantValue::create(productContext.name)); dependsItem->setProperty(QStringLiteral("required"), VariantValue::create(false)); dependsItem->setFile(importer->file()); dependsItem->setLocation(importer->location()); - dependsItem->setupForBuiltinType(m_logger); + dependsItem->setupForBuiltinType(m_parameters.deprecationWarningMode(), m_logger); Item::addChild(importer, dependsItem); Item::addChild(productItem, importer); prepareProduct(projectContext, importer); @@ -1973,7 +1956,7 @@ bool ModuleLoader::mergeExportItems(const ProductContext &productContext) merged->setLocation(exportItems.empty() ? productContext.item->location() : exportItems.back()->location()); Item::addChild(productContext.item, merged); - merged->setupForBuiltinType(m_logger); + merged->setupForBuiltinType(m_parameters.deprecationWarningMode(), m_logger); pmi.exportItem = merged; pmi.multiplexId = productContext.multiplexConfigurationId; productContext.project->topLevelProject->productModules.insert(productContext.name, pmi); @@ -3501,7 +3484,7 @@ Item *ModuleLoader::wrapInProjectIfNecessary(Item *item) Item::addChild(prj, item); prj->setFile(item->file()); prj->setLocation(item->location()); - prj->setupForBuiltinType(m_logger); + prj->setupForBuiltinType(m_parameters.deprecationWarningMode(), m_logger); return prj; } diff --git a/src/lib/corelib/language/projectresolver.cpp b/src/lib/corelib/language/projectresolver.cpp index 4d2d38fc3..208f2c5a6 100644 --- a/src/lib/corelib/language/projectresolver.cpp +++ b/src/lib/corelib/language/projectresolver.cpp @@ -490,7 +490,7 @@ void ProjectResolver::resolveProductFully(Item *item, ProjectContext *projectCon item->property(StringConstants::excludeFilesProperty())); fakeGroup->setProperty(StringConstants::overrideTagsProperty(), VariantValue::falseValue()); - fakeGroup->setupForBuiltinType(m_logger); + fakeGroup->setupForBuiltinType(m_setupParams.deprecationWarningMode(), m_logger); subItems.prepend(fakeGroup); } diff --git a/src/lib/corelib/language/propertydeclaration.cpp b/src/lib/corelib/language/propertydeclaration.cpp index 2dbe41afd..05b2a7f55 100644 --- a/src/lib/corelib/language/propertydeclaration.cpp +++ b/src/lib/corelib/language/propertydeclaration.cpp @@ -275,6 +275,12 @@ void PropertyDeclaration::setDeprecationInfo(const DeprecationInfo &deprecationI d->deprecationInfo = deprecationInfo; } +ErrorInfo PropertyDeclaration::checkForDeprecation(DeprecationWarningMode mode, + const CodeLocation &loc, Logger &logger) const +{ + return deprecationInfo().checkForDeprecation(mode, name(), loc, false, logger); +} + // see also: EvaluatorScriptClass::convertToPropertyType() QVariant PropertyDeclaration::convertToPropertyType(const QVariant &v, Type t, const QStringList &namePrefix, const QString &key) diff --git a/src/lib/corelib/language/propertydeclaration.h b/src/lib/corelib/language/propertydeclaration.h index 137315d14..d1e114296 100644 --- a/src/lib/corelib/language/propertydeclaration.h +++ b/src/lib/corelib/language/propertydeclaration.h @@ -40,6 +40,8 @@ #ifndef QBS_PROPERTYDECLARATION_H #define QBS_PROPERTYDECLARATION_H +#include <tools/deprecationwarningmode.h> + #include <QtCore/qshareddata.h> #include <QtCore/qstring.h> @@ -48,9 +50,12 @@ class QVariant; QT_END_NAMESPACE namespace qbs { +class CodeLocation; +class ErrorInfo; namespace Internal { class DeprecationInfo; class PropertyDeclarationData; +class Logger; class PropertyDeclaration { @@ -116,6 +121,8 @@ public: bool isExpired() const; const DeprecationInfo &deprecationInfo() const; void setDeprecationInfo(const DeprecationInfo &deprecationInfo); + ErrorInfo checkForDeprecation(DeprecationWarningMode mode, const CodeLocation &loc, + Logger &logger) const; static QVariant convertToPropertyType( const QVariant &v, Type t, const QStringList &namePrefix, const QString &key); diff --git a/src/lib/corelib/tools/deprecationwarningmode.cpp b/src/lib/corelib/tools/deprecationwarningmode.cpp new file mode 100644 index 000000000..e140e3e49 --- /dev/null +++ b/src/lib/corelib/tools/deprecationwarningmode.cpp @@ -0,0 +1,98 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qbs. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "deprecationwarningmode.h" + +/*! + * \enum DeprecationWarningMode + * This enum type specifies how \QBS should behave on encountering deprecated items or properties. + * \value DeprecationWarningMode::Error Project resolving will stop with an error message. + * \value DeprecationWarningMode::On A warning will be printed. + * \value DeprecationWarningMode::BeforeRemoval A warning will be printed if and only if this is + * the last \QBS version before the removal version. This is the default behavior. + * \note If the removal version's minor version number is zero, the behavior is + * the same as for ErrorHandlingMode::On. + * \value DeprecationWarningMode::Off No warnings will be emitted for deprecated constructs. + */ + +namespace qbs { + +DeprecationWarningMode defaultDeprecationWarningMode() +{ + return DeprecationWarningMode::BeforeRemoval; +} + +QString deprecationWarningModeName(DeprecationWarningMode mode) +{ + switch (mode) { + case DeprecationWarningMode::Error: + return QStringLiteral("error"); + case DeprecationWarningMode::On: + return QStringLiteral("on"); + case DeprecationWarningMode::BeforeRemoval: + return QStringLiteral("before-removal"); + case DeprecationWarningMode::Off: + return QStringLiteral("off"); + default: + break; + } + return {}; +} + +DeprecationWarningMode deprecationWarningModeFromName(const QString &name) +{ + DeprecationWarningMode mode = defaultDeprecationWarningMode(); + for (int i = 0; i <= int(DeprecationWarningMode::Sentinel); ++i) { + if (deprecationWarningModeName(static_cast<DeprecationWarningMode>(i)) == name) { + mode = static_cast<DeprecationWarningMode>(i); + break; + } + } + return mode; +} + +QStringList allDeprecationWarningModeStrings() +{ + QStringList result; + for (int i = 0; i <= int(DeprecationWarningMode::Sentinel); ++i) + result << deprecationWarningModeName(static_cast<DeprecationWarningMode>(i)); + return result; +} + +} // namespace qbs diff --git a/src/lib/corelib/tools/deprecationwarningmode.h b/src/lib/corelib/tools/deprecationwarningmode.h new file mode 100644 index 000000000..bb2a14155 --- /dev/null +++ b/src/lib/corelib/tools/deprecationwarningmode.h @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2022 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qbs. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QBS_DEPRECATIONWARNINGMODE_H +#define QBS_DEPRECATIONWARNINGMODE_H + +#include "qbs_export.h" + +#include <QtCore/qstringlist.h> + +namespace qbs { + +enum class DeprecationWarningMode { Error, On, BeforeRemoval, Off, Sentinel = Off }; + +QBS_EXPORT DeprecationWarningMode defaultDeprecationWarningMode(); +QBS_EXPORT QString deprecationWarningModeName(DeprecationWarningMode mode); +QBS_EXPORT DeprecationWarningMode deprecationWarningModeFromName(const QString &name); +QBS_EXPORT QStringList allDeprecationWarningModeStrings(); + +} // namespace qbs + +#endif // QBS_DEPRECATIONWARNINGMODE_H + diff --git a/src/lib/corelib/tools/setupprojectparameters.cpp b/src/lib/corelib/tools/setupprojectparameters.cpp index a06ffc4bd..564ebe873 100644 --- a/src/lib/corelib/tools/setupprojectparameters.cpp +++ b/src/lib/corelib/tools/setupprojectparameters.cpp @@ -98,6 +98,7 @@ public: SetupProjectParameters::RestoreBehavior restoreBehavior; ErrorHandlingMode propertyCheckingMode; ErrorHandlingMode productErrorMode; + DeprecationWarningMode deprecationWarningMode = defaultDeprecationWarningMode(); QProcessEnvironment environment; }; @@ -125,6 +126,11 @@ template<> ErrorHandlingMode fromJson(const QJsonValue &v) return ErrorHandlingMode::Strict; } +template<> DeprecationWarningMode fromJson(const QJsonValue &v) +{ + return deprecationWarningModeFromName(v.toString()); +} + template<> SetupProjectParameters::RestoreBehavior fromJson(const QJsonValue &v) { const QString value = v.toString(); @@ -154,6 +160,7 @@ SetupProjectParameters SetupProjectParameters::fromJson(const QJsonObject &data) setValueFromJson(params.d->environment, data, "environment"); setValueFromJson(params.d->restoreBehavior, data, "restore-behavior"); setValueFromJson(params.d->propertyCheckingMode, data, "error-handling-mode"); + setValueFromJson(params.d->deprecationWarningMode, data, "deprecation-warning-mode"); params.d->productErrorMode = params.d->propertyCheckingMode; return params; } @@ -688,4 +695,20 @@ void SetupProjectParameters::setProductErrorMode(ErrorHandlingMode mode) d->productErrorMode = mode; } +/*! + * \brief Indicates how deprecated constructs are handled. + */ +DeprecationWarningMode SetupProjectParameters::deprecationWarningMode() const +{ + return d->deprecationWarningMode; +} + +/*! + * \brief Specifies the behavior on encountering deprecated constructs. + */ +void SetupProjectParameters::setDeprecationWarningMode(DeprecationWarningMode mode) +{ + d->deprecationWarningMode = mode; +} + } // namespace qbs diff --git a/src/lib/corelib/tools/setupprojectparameters.h b/src/lib/corelib/tools/setupprojectparameters.h index 2617a34cd..5c7bf3715 100644 --- a/src/lib/corelib/tools/setupprojectparameters.h +++ b/src/lib/corelib/tools/setupprojectparameters.h @@ -41,6 +41,7 @@ #include "qbs_export.h" +#include <tools/deprecationwarningmode.h> #include <tools/error.h> #include <QtCore/qshareddata.h> @@ -144,6 +145,9 @@ public: ErrorHandlingMode productErrorMode() const; void setProductErrorMode(ErrorHandlingMode mode); + DeprecationWarningMode deprecationWarningMode() const; + void setDeprecationWarningMode(DeprecationWarningMode mode); + private: QSharedDataPointer<Internal::SetupProjectParametersPrivate> d; }; diff --git a/src/lib/corelib/tools/tools.pri b/src/lib/corelib/tools/tools.pri index 1fdacc016..835fbbfda 100644 --- a/src/lib/corelib/tools/tools.pri +++ b/src/lib/corelib/tools/tools.pri @@ -13,6 +13,7 @@ HEADERS += \ $$PWD/clangclinfo.h \ $$PWD/codelocation.h \ $$PWD/commandechomode.h \ + $$PWD/deprecationwarningmode.h \ $$PWD/dynamictypecheck.h \ $$PWD/error.h \ $$PWD/executablefinder.h \ @@ -73,6 +74,7 @@ SOURCES += \ $$PWD/clangclinfo.cpp \ $$PWD/codelocation.cpp \ $$PWD/commandechomode.cpp \ + $$PWD/deprecationwarningmode.cpp \ $$PWD/error.cpp \ $$PWD/executablefinder.cpp \ $$PWD/fileinfo.cpp \ @@ -127,6 +129,7 @@ osx { $$PWD/cleanoptions.h \ $$PWD/codelocation.h \ $$PWD/commandechomode.h \ + $$PWD/deprecationwarningmode.h \ $$PWD/error.h \ $$PWD/generateoptions.h \ $$PWD/installoptions.h \ |