CMakePM: Add support for configure CMake presets

This patchset will add support for version 1 of the CMakePresets
feature that has been implemented in CMake 3.19

https://cmake.org/cmake/help/v3.19/manual/cmake-presets.7.html

The tests/manual/cmakepresets contains a manual test example for this
feature.

Task-number: QTCREATORBUG-24555
Change-Id: I93aba1ab4f090613d0b21d970b5b651d12c922af
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>

src/plugins/cmakeprojectmanager/cmakeproject.cpp

@@ -15,6 +15,7 @@
 #include <projectexplorer/projectexplorerconstants.h>
 #include <projectexplorer/projectnodes.h>
 #include <projectexplorer/target.h>
+#include <projectexplorer/taskhub.h>
 
 using namespace ProjectExplorer;
 using namespace Utils;
@@ -34,6 +35,8 @@ CMakeProject::CMakeProject(const FilePath &fileName)
     setDisplayName(projectDirectory().fileName());
     setCanBuildProducts();
     setHasMakeInstallEquivalent(true);
+
+    readPresets();
 }
 
 CMakeProject::~CMakeProject()
@@ -59,7 +62,7 @@ Tasks CMakeProject::projectIssues(const Kit *k) const
 ProjectImporter *CMakeProject::projectImporter() const
 {
     if (!m_projectImporter)
-        m_projectImporter = new CMakeProjectImporter(projectFilePath());
+        m_projectImporter = new CMakeProjectImporter(projectFilePath(), m_presetsData);
     return m_projectImporter;
 }
 
@@ -73,6 +76,100 @@ void CMakeProject::clearIssues()
     m_issues.clear();
 }
 
+PresetsData CMakeProject::presetsData() const
+{
+    return m_presetsData;
+}
+
+Internal::PresetsData CMakeProject::combinePresets(Internal::PresetsData &cmakePresetsData,
+                                                   Internal::PresetsData &cmakeUserPresetsData)
+{
+    Internal::PresetsData result;
+    result.version = cmakePresetsData.version;
+    result.cmakeMinimimRequired = cmakePresetsData.cmakeMinimimRequired;
+
+    QHash<QString, PresetsDetails::ConfigurePreset> configurePresets;
+
+    // Populate the hash map with the CMakePresets
+    for (const PresetsDetails::ConfigurePreset &p: cmakePresetsData.configurePresets)
+        configurePresets.insert(p.name, p);
+
+    auto resolveInherits =
+        [configurePresets](std::vector<PresetsDetails::ConfigurePreset> &configurePresetsList) {
+            for (PresetsDetails::ConfigurePreset &cp : configurePresetsList) {
+                if (!cp.inherits)
+                    continue;
+
+                for (const QString &inheritFromName : cp.inherits.value())
+                    if (configurePresets.contains(inheritFromName))
+                        cp.inheritFrom(configurePresets[inheritFromName]);
+            }
+        };
+
+    // First resolve the CMakePresets
+    resolveInherits(cmakePresetsData.configurePresets);
+
+    // Add the CMakeUserPresets to the resolve hash map
+    for (const PresetsDetails::ConfigurePreset &cp : cmakeUserPresetsData.configurePresets) {
+        if (configurePresets.contains(cp.name)) {
+            TaskHub::addTask(BuildSystemTask(
+                Task::TaskType::Error,
+                tr("CMakeUserPresets.json cannot re-define the configure preset: %1").arg(cp.name),
+                "CMakeUserPresets.json"));
+            TaskHub::requestPopup();
+        } else {
+            configurePresets.insert(cp.name, cp);
+        }
+    }
+
+    // Then resolve the CMakeUserPresets
+    resolveInherits(cmakeUserPresetsData.configurePresets);
+
+    // Get both CMakePresets and CMakeUserPresets into the result
+    result.configurePresets = cmakePresetsData.configurePresets;
+
+    // std::vector doesn't have append
+    std::copy(cmakeUserPresetsData.configurePresets.begin(),
+              cmakeUserPresetsData.configurePresets.end(),
+              std::back_inserter(result.configurePresets));
+
+    return result;
+}
+
+void CMakeProject::readPresets()
+{
+    auto parsePreset = [](const Utils::FilePath &presetFile) -> Internal::PresetsData {
+        Internal::PresetsData data;
+        Internal::PresetsParser parser;
+
+        QString errorMessage;
+        int errorLine = -1;
+
+        if (presetFile.exists()) {
+            if (parser.parse(presetFile, errorMessage, errorLine)) {
+                data = parser.presetsData();
+            } else {
+                TaskHub::addTask(BuildSystemTask(Task::TaskType::Error,
+                                                 tr("Failed to load %1: %2")
+                                                     .arg(presetFile.fileName())
+                                                     .arg(errorMessage),
+                                                 presetFile,
+                                                 errorLine));
+                TaskHub::requestPopup();
+            }
+        }
+        return data;
+    };
+
+    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);
+
+    m_presetsData = combinePresets(cmakePresetsData, cmakeUserPresetsData);
+}
+
 bool CMakeProject::setupTarget(Target *t)
 {
     t->updateDefaultBuildConfigurations();