aboutsummaryrefslogtreecommitdiffstats
path: root/QtVsTools.Wizards/ItemWizard/WidgetsClass/WidgetsClassWizard.cs
blob: d8a1a2b398855ebd8c582b1039fefbb902a16a87 (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
/***************************************************************************************************
 Copyright (C) 2023 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;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Windows.Controls;
using EnvDTE;
using Microsoft.VisualStudio.Shell;

namespace QtVsTools.Wizards.ItemWizard
{
    using Common;
    using Core;
    using ProjectWizard;
    using QtVsTools.Common;
    using Util;

    using static QtVsTools.Common.EnumExt;

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

        protected override Options TemplateType => Options.GUISystem;

        enum NewClass
        {
            [String("safeitemname")] SafeItemName,
            [String("sourcefilename")] SourceFileName,
            [String("headerfilename")] HeaderFileName,
            [String("uifilename")] UiFileName
        }

        enum NewWidgetsItem
        {
            [String("classname")] ClassName,
            [String("baseclass")] BaseClass,
            [String("include")] Include,
            [String("qobject")] QObject,
            [String("ui_hdr")] UiHeaderName,
            [String("centralwidget")] CentralWidget,
            [String("forward_declare_class")] ForwardDeclClass,
            [String("multiple_inheritance")] MultipleInheritance,
            [String("ui_classname")] UiClassName,
            [String("member")] Member
        }

        enum Meta
        {
            [String("namespacebegin")] NamespaceBegin,
            [String("operator")] Operator,
            [String("asterisk")] Asterisk,
            [String("semicolon")] Semicolon,
            [String("new")] New,
            [String("delete")] Delete,
            [String("namespaceend")] NamespaceEnd
        }

        protected override WizardData WizardData => Lazy.Get(() =>
            WizardData, () => new WizardData
            {
                InsertQObjectMacro = true,
                LowerCaseFileNames = false,
                UsePrecompiledHeader = false,
                DefaultModules = new List<string> { "core", "gui", "widgets" }
            });

        protected override WizardWindow WizardWindow => Lazy.Get(() =>
            WizardWindow, () => new WizardWindow(title: "Qt Widgets Class Wizard")
            {
                new WizardIntroPage
                {
                    Data = WizardData,
                    Header = @"Welcome to the Qt Widgets Class Wizard",
                    Message = @"This wizard will add a new Qt Widgets class to your project. "
                        + @"The wizard creates a .h and .cpp file. It also creates a new "
                        + @"empty form." + Environment.NewLine
                        + Environment.NewLine + "To continue, click Next.",
                    PreviousButtonEnabled = false,
                    NextButtonEnabled = true,
                    FinishButtonEnabled = false,
                    CancelButtonEnabled = true
                },
                new GuiPage
                {
                    Data = WizardData,
                    IsClassWizardPage = true,
                    Header = @"Welcome to the Qt Widgets Class Wizard",
                    Message = @"This wizard will add a new Qt Widgets class to your project. "
                        + @"The wizard creates a .h and .cpp file. It also creates a new "
                        + @"empty form.",
                    PreviousButtonEnabled = true,
                    NextButtonEnabled = false,
                    FinishButtonEnabled = true,
                    CancelButtonEnabled = true
                }
            });

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

            WizardData.ClassName = className;
            WizardData.BaseClass = @"QMainWindow";
            WizardData.ClassHeaderFile = className + @".h";
            WizardData.ClassSourceFile = className + @".cpp";
            WizardData.UiFile = WizardData.ClassName + @".ui";
            WizardData.QrcFile = WizardData.ClassName + @".qrc";
            WizardData.UiClassInclusion = UiClassInclusion.Member;

            Parameter[NewWidgetsItem.ForwardDeclClass] = "";
            Parameter[NewWidgetsItem.MultipleInheritance] = "";
            Parameter[NewWidgetsItem.UiClassName] = "";
            Parameter[NewWidgetsItem.Member] = "ui";

            Parameter[Meta.Asterisk] ="";
            Parameter[Meta.Operator] = ".";
            Parameter[Meta.Semicolon] = ";";
            Parameter[Meta.New] = "";
            Parameter[Meta.Delete] = "";
        }

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

            var array = WizardData.ClassName.Split(new[] { "::" },
                StringSplitOptions.RemoveEmptyEntries);
            var className = array.LastOrDefault();

            Parameter[NewWidgetsItem.ClassName] = className;
            Parameter[NewWidgetsItem.BaseClass] = WizardData.BaseClass;

            var include = new StringBuilder();
            var qtProject = HelperFunctions.GetSelectedQtProject(Dte);
            if (qtProject?.UsesPrecompiledHeaders() == true)
                include.AppendLine($"#include \"{qtProject.GetPrecompiledHeaderThrough()}\"");

            include.AppendLine($"#include \"{WizardData.ClassHeaderFile}\"");
            Parameter[NewWidgetsItem.Include] = FormatParam(include);

            Parameter[NewWidgetsItem.QObject] = WizardData.InsertQObjectMacro
                                                    ? "\r\n    Q_OBJECT\r\n" : "";

            Parameter[NewWidgetsItem.UiHeaderName] =
                $"ui_{Path.GetFileNameWithoutExtension(WizardData.UiFile)}.h";

            if (WizardData.BaseClass == "QMainWindow") {
                Parameter[NewWidgetsItem.CentralWidget] = FormatParam(
                      @"  <widget class=""QMenuBar"" name=""menuBar"" />"
                    + @"  <widget class=""QToolBar"" name=""mainToolBar"" />"
                    + @"  <widget class=""QWidget"" name=""centralWidget"" />"
                    + @"  <widget class=""QStatusBar"" name=""statusBar"" />"
                );
            }

            switch (WizardData.UiClassInclusion) {
            case UiClassInclusion.MemberPointer:
                Parameter[NewWidgetsItem.ForwardDeclClass] = "\r\nQT_BEGIN_NAMESPACE\r\n"
                    + $"namespace Ui {{ class {className}Class; }};\r\n" + "QT_END_NAMESPACE\r\n";
                Parameter[Meta.Asterisk] = "*";
                Parameter[Meta.Operator] = "->";
                Parameter[Meta.New] =
                    $"\r\n    , {Parameter[NewWidgetsItem.Member]}(new Ui::{className}Class())";
                Parameter[Meta.Delete] = $"\r\n    delete {Parameter[NewWidgetsItem.Member]};\r\n";
                goto case UiClassInclusion.Member;
            case UiClassInclusion.Member:
                Parameter[NewWidgetsItem.UiClassName] = $"Ui::{className}Class";
                break;
            case UiClassInclusion.MultipleInheritance:
                Parameter[NewWidgetsItem.MultipleInheritance] = $", public Ui::{className}Class";
                Parameter[NewWidgetsItem.Member] = "";
                Parameter[Meta.Operator] = "";
                Parameter[Meta.Semicolon] = "";
                break;
            }

            string nsBegin = string.Empty, nsEnd = string.Empty;
            for (var i = 0; i < array.Length - 1; ++i) {
                nsBegin += "namespace " + array[i] + " {\r\n";
                nsEnd = "} // namespace " + array[i] + "\r\n" + nsEnd;
            }
            Parameter[Meta.NamespaceBegin] = nsBegin;
            Parameter[Meta.NamespaceEnd] = nsEnd;
        }

        protected override void Expand()
        {
            ThreadHelper.ThrowIfNotOnUIThread();
            VCRulePropertyStorageHelper.SetQtModules(Dte, WizardData.DefaultModules);
        }

        public override void ProjectItemFinishedGenerating(ProjectItem projectItem)
        {
            ThreadHelper.ThrowIfNotOnUIThread();
            TextAndWhitespace.Adjust(Dte, projectItem.Properties.Item("FullPath").Value.ToString());
        }
    }
}