CMakePM: Add include presets support

Fixes: QTCREATORBUG-28894
Change-Id: I9359cb85c230f2db02f08427af9832f168a32c41
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

src/plugins/cmakeprojectmanager/cmakeproject.cpp

@@ -208,12 +208,51 @@ void CMakeProject::readPresets()
         return data;
     };
 
+    std::function<void(Internal::PresetsData & presetData, Utils::FilePaths & inclueStack)>
+        resolveIncludes = [&](Internal::PresetsData &presetData, Utils::FilePaths &includeStack) {
+            if (presetData.include) {
+                for (const QString &path : presetData.include.value()) {
+                    Utils::FilePath includePath = Utils::FilePath::fromUserInput(path);
+                    if (!includePath.isAbsolutePath())
+                        includePath = presetData.fileDir.resolvePath(path);
+
+                    Internal::PresetsData includeData = parsePreset(includePath);
+                    if (includeData.include) {
+                        if (includeStack.contains(includePath)) {
+                            TaskHub::addTask(BuildSystemTask(
+                                Task::TaskType::Warning,
+                                Tr::tr("Attempt to include %1 which was already parsed.")
+                                    .arg(includePath.path()),
+                                Utils::FilePath(),
+                                -1));
+                            TaskHub::requestPopup();
+                        } else {
+                            resolveIncludes(includeData, includeStack);
+                        }
+                    }
+
+                    presetData.configurePresets = includeData.configurePresets
+                                                  + presetData.configurePresets;
+                    presetData.buildPresets = includeData.buildPresets + presetData.buildPresets;
+
+                    includeStack << includePath;
+                }
+            }
+        };
+
     const Utils::FilePath cmakePresetsJson = projectDirectory().pathAppended("CMakePresets.json");
     const Utils::FilePath cmakeUserPresetsJson = projectDirectory().pathAppended("CMakeUserPresets.json");
 
     Internal::PresetsData cmakePresetsData = parsePreset(cmakePresetsJson);
     Internal::PresetsData cmakeUserPresetsData = parsePreset(cmakeUserPresetsJson);
 
+    // resolve the include
+    Utils::FilePaths includeStack = {cmakePresetsJson};
+    resolveIncludes(cmakePresetsData, includeStack);
+
+    includeStack = {cmakeUserPresetsJson};
+    resolveIncludes(cmakeUserPresetsData, includeStack);
+
     m_presetsData = combinePresets(cmakePresetsData, cmakeUserPresetsData);
     setupBuildPresets(m_presetsData);
 }

src/plugins/cmakeprojectmanager/presetsmacros.cpp

@@ -38,6 +38,7 @@ static void expandAllButEnv(const PresetsDetails::ConfigurePreset &preset,
     value.replace("${sourceDirName}", sourceDirectory.fileName());
 
     value.replace("${presetName}", preset.name);
+    value.replace("${fileDir}", preset.fileDir.path());
     if (preset.generator)
         value.replace("${generator}", preset.generator.value());
 
@@ -51,6 +52,7 @@ static void expandAllButEnv(const PresetsDetails::BuildPreset &preset,
     value.replace("${dollar}", "$");
 
     value.replace("${sourceDir}", sourceDirectory.toString());
+    value.replace("${fileDir}", preset.fileDir.path());
     value.replace("${sourceParentDir}", sourceDirectory.parentDir().toString());
     value.replace("${sourceDirName}", sourceDirectory.fileName());
 

src/plugins/cmakeprojectmanager/presetsparser.cpp

@@ -36,6 +36,22 @@ bool parseCMakeMinimumRequired(const QJsonValue &jsonValue, QVersionNumber &vers
     return true;
 }
 
+std::optional<QStringList> parseInclude(const QJsonValue &jsonValue)
+{
+    std::optional<QStringList> includes;
+
+    if (!jsonValue.isUndefined()) {
+        if (jsonValue.isArray()) {
+            includes = QStringList();
+            const QJsonArray includeArray = jsonValue.toArray();
+            for (const QJsonValue &includeValue : includeArray)
+                includes.value() << includeValue.toString();
+        }
+    }
+
+    return includes;
+}
+
 std::optional<PresetsDetails::Condition> parseCondition(const QJsonValue &jsonValue)
 {
     std::optional<PresetsDetails::Condition> condition;
@@ -133,7 +149,8 @@ std::optional<PresetsDetails::Condition> parseCondition(const QJsonValue &jsonVa
 }
 
 bool parseConfigurePresets(const QJsonValue &jsonValue,
-                           QList<PresetsDetails::ConfigurePreset> &configurePresets)
+                           QList<PresetsDetails::ConfigurePreset> &configurePresets,
+                           const Utils::FilePath &fileDir)
 {
     // The whole section is optional
     if (jsonValue.isUndefined())
@@ -151,6 +168,7 @@ bool parseConfigurePresets(const QJsonValue &jsonValue,
         PresetsDetails::ConfigurePreset preset;
 
         preset.name = object.value("name").toString();
+        preset.fileDir = fileDir;
         preset.hidden = object.value("hidden").toBool();
 
         QJsonValue inherits = object.value("inherits");
@@ -291,7 +309,8 @@ bool parseConfigurePresets(const QJsonValue &jsonValue,
 }
 
 bool parseBuildPresets(const QJsonValue &jsonValue,
-                       QList<PresetsDetails::BuildPreset> &buildPresets)
+                       QList<PresetsDetails::BuildPreset> &buildPresets,
+                       const Utils::FilePath &fileDir)
 {
     // The whole section is optional
     if (jsonValue.isUndefined())
@@ -309,6 +328,7 @@ bool parseBuildPresets(const QJsonValue &jsonValue,
         PresetsDetails::BuildPreset preset;
 
         preset.name = object.value("name").toString();
+        preset.fileDir = fileDir;
         preset.hidden = object.value("hidden").toBool();
 
         QJsonValue inherits = object.value("inherits");
@@ -416,6 +436,8 @@ bool PresetsParser::parse(const Utils::FilePath &jsonFile, QString &errorMessage
 
     QJsonObject root = jsonDoc.object();
 
+    m_presetsData.fileDir = jsonFile.parentDir();
+
     if (!parseVersion(root.value("version"), m_presetsData.version)) {
         errorMessage = Tr::tr("Invalid \"version\" in file \"%1\".").arg(jsonFile.fileName());
         return false;
@@ -426,14 +448,21 @@ bool PresetsParser::parse(const Utils::FilePath &jsonFile, QString &errorMessage
                               m_presetsData.cmakeMinimimRequired);
 
     // optional
-    if (!parseConfigurePresets(root.value("configurePresets"), m_presetsData.configurePresets)) {
+    m_presetsData.include = parseInclude(root.value("include"));
+
+    // optional
+    if (!parseConfigurePresets(root.value("configurePresets"),
+                               m_presetsData.configurePresets,
+                               jsonFile.parentDir())) {
         errorMessage
             = Tr::tr("Invalid \"configurePresets\" section in %1 file").arg(jsonFile.fileName());
         return false;
     }
 
     // optional
-    if (!parseBuildPresets(root.value("buildPresets"), m_presetsData.buildPresets)) {
+    if (!parseBuildPresets(root.value("buildPresets"),
+                           m_presetsData.buildPresets,
+                           jsonFile.parentDir())) {
         errorMessage
             = Tr::tr("Invalid \"buildPresets\" section in %1 file").arg(jsonFile.fileName());
         return false;

src/plugins/cmakeprojectmanager/presetsparser.h

@@ -90,6 +90,7 @@ public:
     void inheritFrom(const ConfigurePreset &other);
 
     QString name;
+    Utils::FilePath fileDir;
     std::optional<bool> hidden = false;
     std::optional<QStringList> inherits;
     std::optional<Condition> condition;
@@ -115,6 +116,7 @@ public:
     void inheritFrom(const BuildPreset &other);
 
     QString name;
+    Utils::FilePath fileDir;
     std::optional<bool> hidden = false;
     std::optional<QStringList> inherits;
     std::optional<Condition> condition;
@@ -140,6 +142,8 @@ public:
     int version = 0;
     QVersionNumber cmakeMinimimRequired;
     QHash<QString, QString> vendor;
+    std::optional<QStringList> include;
+    Utils::FilePath fileDir;
     QList<PresetsDetails::ConfigurePreset> configurePresets;
     QList<PresetsDetails::BuildPreset> buildPresets;
 };