aboutsummaryrefslogtreecommitdiffstats
path: root/QtVsTools.Wizards/ProjectWizard/Designer/DesignerWizard.cs
blob: eb49fc2712b8895709d963683bdea8f79732e4ff (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
/***************************************************************************************************
 Copyright (C) 2024 The Qt Company Ltd.
 SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
***************************************************************************************************/

using System.Collections.Generic;
using System.Text;
using System.Text.RegularExpressions;
using System.Windows.Controls;
using Microsoft.VisualStudio.VCProjectEngine;

namespace QtVsTools.Wizards.ProjectWizard
{
    using Common;
    using Core.MsBuild;
    using QtVsTools.Common;

    using static QtVsTools.Common.EnumExt;

    public class DesignerWizard : ProjectTemplateWizard
    {
        LazyFactory Lazy { get; } = new();

        protected override Options TemplateType =>
            Options.PluginProject | Options.DynamicLibrary | Options.GUISystem;

        enum NewClass
        {
            [String("classname")] ClassName,
            [String("baseclass")] BaseClass,
            [String("sourcefilename")] SourceFileName,
            [String("headerfilename")] HeaderFileName,
            [String("include")] Include
        }

        enum NewDesignerPlugin
        {
            [String("plugin_class")] ClassName,
            [String("objname")] ObjectName,
            [String("pluginsourcefilename")] SourceFileName,
            [String("pluginheaderfilename")] HeaderFileName,
            [String("plugin_json")] JsonFileName
        }

        protected override WizardData WizardData => Lazy.Get(() =>
            WizardData, () => new WizardData
            {
                DefaultModules = new List<string> {
                    "QtCore", "QtGui", "QtWidgets", "QtDesigner"
                }
            });

        protected override WizardWindow WizardWindow => Lazy.Get(() =>
            WizardWindow, () => new WizardWindow(title: "Qt Designer Custom Widget Wizard")
            {
                new WizardIntroPage {
                    Data = WizardData,
                    Header = @"Welcome to the Qt Designer Custom Widget Wizard",
                    Message = @"This wizard generates a designer custom widget which can be "
                        + @"used in Qt Designer or Visual Studio."
                        + System.Environment.NewLine + System.Environment.NewLine
                        + "To continue, click Next.",
                    PreviousButtonEnabled = false,
                    NextButtonEnabled = true,
                    FinishButtonEnabled = false,
                    CancelButtonEnabled = true
                },
                new ConfigPage {
                    Data = WizardData,
                    Header = @"Welcome to the Qt Designer Custom Widget Wizard",
                    Message =
                            @"Setup the configurations you want to include in your project. "
                            + @"The recommended settings for this project are selected by default.",
                    PreviousButtonEnabled = true,
                    NextButtonEnabled = true,
                    FinishButtonEnabled = false,
                    CancelButtonEnabled = true,
                    ValidateConfigs = ValidateConfigsForDesignerWidget
                },
                new DesignerPage {
                    Data = WizardData,
                    Header = @"Welcome to the Qt Designer Custom Widget Wizard",
                    Message = @"This wizard generates a designer custom widget which can be "
                        + @"used in Qt Designer or Visual Studio.",
                    PreviousButtonEnabled = true,
                    NextButtonEnabled = false,
                    FinishButtonEnabled = true,
                    CancelButtonEnabled = true
                }
            }
        );

        string ValidateConfigsForDesignerWidget(IEnumerable<IWizardConfiguration> configs)
        {
            foreach (var config in configs) {
                if (config.Target.EqualTo(ProjectTargets.WindowsStore)) {
                    return "Custom Designer Widget project not available for the "
                        + $"'{config.Target}' target.";
                }
            }
            return string.Empty;
        }

        protected override void BeforeWizardRun()
        {
            var className = Parameter[NewProject.SafeName];
            className = Regex.Replace(className, @"[^a-zA-Z0-9_]", string.Empty);
            className = Regex.Replace(className, @"^[\d-]*\s*", string.Empty);
            var result = new Util.ClassNameValidationRule().Validate(className, null);
            if (result != ValidationResult.ValidResult)
                className = @"MyDesignerWidget";

            WizardData.ClassName = className;
            WizardData.BaseClass = @"QWidget";
            WizardData.ClassHeaderFile = className + @".h";
            WizardData.ClassSourceFile = className + @".cpp";

            WizardData.PluginClass = className + @"Plugin";
            WizardData.PluginHeaderFile = WizardData.PluginClass + @".h";
            WizardData.PluginSourceFile = WizardData.PluginClass + @".cpp";
        }

        protected override void BeforeTemplateExpansion()
        {
            Parameter[NewClass.ClassName] = WizardData.ClassName;
            Parameter[NewClass.BaseClass] = WizardData.BaseClass;
            Parameter[NewClass.HeaderFileName] = WizardData.ClassHeaderFile;
            Parameter[NewClass.SourceFileName] = WizardData.ClassSourceFile;

            var include = new StringBuilder();
            if (UsePrecompiledHeaders)
                include.AppendLine($"#include \"{PrecompiledHeader.Include}\"");
            include.AppendLine($"#include \"{WizardData.ClassHeaderFile}\"");
            Parameter[NewClass.Include] = FormatParam(include);

            Parameter[NewDesignerPlugin.ClassName] = WizardData.PluginClass;
            Parameter[NewDesignerPlugin.HeaderFileName] = WizardData.PluginHeaderFile;
            Parameter[NewDesignerPlugin.SourceFileName] = WizardData.PluginSourceFile;
            Parameter[NewDesignerPlugin.JsonFileName] = WizardData.PluginClass.ToLower() + ".json";
            Parameter[NewDesignerPlugin.ObjectName] =
                $"{WizardData.ClassName[0]}{WizardData.ClassName.Substring(1)}";
        }

        protected override void OnProjectGenerated(EnvDTE.Project dteProject)
        {
            Microsoft.VisualStudio.Shell.ThreadHelper.ThrowIfNotOnUIThread();
            if (MsBuildProject.GetOrAdd(dteProject.Object as VCProject) is {} project)
                project.MarkAsQtPlugin();
        }
    }
}