aboutsummaryrefslogtreecommitdiffstats
path: root/QtVsTools.Wizards/ProjectWizard/ProjectTemplateWizard.CMake.cs
blob: a05fd5b4d0cfe168733ea360c9c76a043cfaacbf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/***************************************************************************************************
 Copyright (C) 2024 The Qt Company Ltd.
 SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
***************************************************************************************************/

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.Serialization;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.TemplateWizard;

namespace QtVsTools.Wizards.ProjectWizard
{
    using Core;
    using Core.CMake;
    using Json;
    using VisualStudio;
    using static Core.Common.Utils;
    using static QtVsTools.Common.EnumExt;

    public abstract partial class ProjectTemplateWizard : IWizard
    {
        protected enum CMake
        {
            // Parameters for expanding CMake project files
            [String("cmake_user_presets")] UserPresets,
            [String("cmake_qt_modules")] Modules,
            [String("cmake_qt_libs")] Libs,
            [String("cmake_qt_helper")] Helper,
            [String("cmake_project_sources")] ProjectSources
        }

        [DataContract]
        protected class CMakeConfigPreset
        {
            [DataMember(Name = "name", Order = 0)]
            public string Name { get; set; }

            [DataMember(Name = "displayName", EmitDefaultValue = false, Order = 1)]
            public string DisplayName { get; set; }

            [DataMember(Name = "inherits", EmitDefaultValue = false, Order = 2)]
            public List<string> Inherits { get; set; }

            [DataMember(Name = "binaryDir", EmitDefaultValue = false, Order = 3)]
            public string BinaryDir { get; set; }

            [DataContract]
            public class ConfigCacheVariables
            {
                [DataMember(Name = "CMAKE_BUILD_TYPE", EmitDefaultValue = false)]
                public string CMakeBuildType { get; set; }

                [DataMember(Name = "CMAKE_CXX_FLAGS", EmitDefaultValue = false)]
                public string CxxFlags { get; set; }

                [DataMember(Name = "QT_MODULES", EmitDefaultValue = false)]
                public string QtModules { get; set; }
            }

            [DataMember(Name = "cacheVariables", EmitDefaultValue = false, Order = 6)]
            public ConfigCacheVariables CacheVariables { get; set; }

            [DataContract]
            public class ConfigEnvironment
            {
                [DataMember(Name = "QTDIR", EmitDefaultValue = false, Order = 0)]
                public string QtDir { get; set; }

                [DataMember(Name = "PATH", EmitDefaultValue = false, Order = 1)]
                public string Path { get; set; }

                [DataMember(Name = "QML_DEBUG_ARGS", EmitDefaultValue = false, Order = 2)]
                public string QmlDebugArgs { get; set; }
            }

            [DataMember(Name = "environment", EmitDefaultValue = false, Order = 7)]
            public ConfigEnvironment Environment { get; set; }
        }

        [DataContract]
        protected class CMakePresets : Serializable<CMakePresets>
        {
            [DataMember(Name = "version", Order = 0)]
            public int Version { get; set; } = 3;

            [DataMember(Name = "configurePresets", Order = 1)]
            public List<CMakeConfigPreset> ConfigurePresets { get; set; }

            public CMakePresets()
            {
                ConfigurePresets = new List<CMakeConfigPreset>();
            }
        }

        protected bool UseQtCMakeHelper { get; set; } = true;

        private bool IsCMakeFile(string fileName)
        {
            return fileName.Equals("CMakeLists.txt", IgnoreCase)
                || fileName.Equals("CMakeUserPresets.json", IgnoreCase)
                || !UseQtCMakeHelper || fileName.Equals("qt.cmake", IgnoreCase);
        }

        private void ExpandCMake()
        {
            ThreadHelper.ThrowIfNotOnUIThread();

            Parameter[NewProject.ProjectItems] += string.Join(string.Empty,
                "<None Include=\"CMakeLists.txt\" />\r\n",
                "<None Include=\"CMakeUserPresets.json\" />\r\n",
                UseQtCMakeHelper ? "<None Include=\"qt.cmake\" />\r\n" : "");

            Parameter[CMake.ProjectSources] = "";
            if (Parameter[NewProject.ResourceFile] is { Length: > 0 } rcFile)
                Parameter[CMake.ProjectSources] += $"    {rcFile}\r\n";

            var userPresets = new CMakePresets();
            var qtModules = new SortedSet<string>();
            foreach (IWizardConfiguration config in Configurations) {
                var modules = QtModules.Instance
                    .GetAvailableModules(config.QtVersion.qtMajor)
                    .Join(config.Modules,
                        x => x.proVarQT, y => y, comparer: CaseIgnorer,
                        resultSelector: (x, y) => x.LibraryPrefix.Substring(2));
                foreach (var module in modules)
                    qtModules.Add(module);
                userPresets.ConfigurePresets.Add(ConfigureCMakePreset(config));
            }
            if (!qtModules.Any())
                qtModules.Add("QtCore");
            Parameter[CMake.UserPresets] = userPresets.ToJsonString();
            Parameter[CMake.Modules] = string.Join("\r\n        ", qtModules);
            Parameter[CMake.Libs] = string.Join("\r\n        ",
                qtModules.Select(module => $"Qt::{module}"));
            Parameter[CMake.Helper] = QtCMakeHelper;
            Parameter[NewProject.Globals] += @"<QT_CMAKE_TEMPLATE>true</QT_CMAKE_TEMPLATE>";
        }

        protected virtual CMakeConfigPreset ConfigureCMakePreset(IWizardConfiguration config)
        {
            var configPreset = new CMakeConfigPreset
            {
                Name = $"{config.Name}-{config.Platform}",
                DisplayName = $"{config.Name} ({config.Platform})",
                BinaryDir = "${sourceDir}/out/build",
                CacheVariables = new CMakeConfigPreset.ConfigCacheVariables
                {
                    CMakeBuildType = config.IsDebug ? "Debug" : "Release"
                }
            };
            return configPreset;
        }

        protected virtual void OpenCMakeProject()
        {
            ThreadHelper.ThrowIfNotOnUIThread();

            var solutionDir = new Uri(
                Path.Combine(Path.GetFullPath(Parameter[NewProject.SolutionDirectory]), "."));
            var projectDir = new Uri(
                Path.Combine(Path.GetFullPath(Parameter[NewProject.DestinationDirectory]), "."));
            if (!Directory.Exists(solutionDir.LocalPath) || !solutionDir.IsBaseOf(projectDir))
                solutionDir = projectDir;

            if (solutionDir != projectDir) {
                File.Move(
                    Path.Combine(projectDir.LocalPath, "CMakeUserPresets.json"),
                    Path.Combine(solutionDir.LocalPath, "CMakeUserPresets.json"));
                var project = Path.GetFileName(solutionDir.LocalPath
                    .TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar));
                var subDir = solutionDir.MakeRelativeUri(projectDir).ToString()
                    .TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
                File.WriteAllText(Path.Combine(solutionDir.LocalPath, "CMakeLists.txt"), $@"
cmake_minimum_required(VERSION 3.16)

project(""{project}"")

add_subdirectory(""{subDir}"")
".Trim('\r', '\n'));
            }
            CMakeProject.Convert(solutionDir.LocalPath);
            Dte.ExecuteCommand("File.OpenFolder", solutionDir.LocalPath);

            // Hack: Manually open OpenInEditor items.
            var template = new VsTemplate(ParameterValues["$templatepath$"]);
            var openInEditorItems = template.ProjectItems.Where(x => x.OpenInEditor);
            foreach (var item in openInEditorItems) {
                string fileName;
                if (item.TargetFileName != null) {
                    fileName = item.TargetFileName;
                    if (ParameterValues.TryGetValue("$sourcefilename$", out var value))
                        fileName = fileName.Replace("$sourcefilename$", value);
                }
                else {
                    fileName = item.TemplateFileName;
                }
                VsEditor.Open(Path.Combine(projectDir.LocalPath, fileName));
            }
        }

        private static string QtCMakeHelper { get; } = @"
if(QT_VERSION VERSION_LESS 6.3)
    macro(qt_standard_project_setup)
        set(CMAKE_AUTOMOC ON)
        set(CMAKE_AUTORCC ON)
        set(CMAKE_AUTOUIC ON)
    endmacro()
endif()

if(QT_VERSION VERSION_LESS 6.0)
    macro(qt_add_executable name)
         if(ANDROID)
            add_library(name SHARED ${ARGN})
        else()
            add_executable(${ARGV})
        endif()
    endmacro()
endif()
".Trim('\r', '\n');
    }
}