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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt VS Tools.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Microsoft.VisualStudio;
using Microsoft.VisualStudio.Debugger.Interop;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using Microsoft.VisualStudio.VCProjectEngine;
using QtProjectLib;
using QtProjectLib.QtMsBuild;
namespace QtVsTools.Qml.Debug
{
using AD7;
using VisualStudio;
class Launcher : Disposable, IDebugEventCallback2
{
public static Launcher Instance { get; private set; }
IVsDebugger debugger;
IVsDebugger4 debugger4;
IVsOutputWindowPane debugOutput;
public static void Initialize()
{
Instance = new Launcher();
Instance.debugger = VsServiceProvider.GetService<IVsDebugger>();
Instance.debugger4 = VsServiceProvider.GetService<IVsDebugger, IVsDebugger4>();
if (Instance.debugger != null && Instance.debugger4 != null)
Instance.debugger.AdviseDebugEventCallback(Instance);
var outputWindow = VsServiceProvider.GetService<SVsOutputWindow, IVsOutputWindow>();
if (outputWindow != null) {
var debugOutputGuid = VSConstants.OutputWindowPaneGuid.DebugPane_guid;
var result = outputWindow.GetPane(ref debugOutputGuid, out Instance.debugOutput);
if (result != VSConstants.S_OK || Instance.debugOutput == null) {
Messages.PaneMessageSafe(Vsix.Instance.Dte,
"Unable to get reference to output window debug pane.", 5000);
}
} else {
Messages.PaneMessageSafe(Vsix.Instance.Dte,
"Unable to get reference to output window.", 5000);
}
}
private Launcher()
{ }
protected override void DisposeManaged()
{
if (debugger != null)
debugger.UnadviseDebugEventCallback(this);
}
int IDebugEventCallback2.Event(
IDebugEngine2 pEngine,
IDebugProcess2 pProcess,
IDebugProgram2 pProgram,
IDebugThread2 pThread,
IDebugEvent2 pEvent,
ref Guid riidEvent,
uint dwAttrib)
{
var evLoadComplete = pEvent as IDebugLoadCompleteEvent2;
if (evLoadComplete == null)
return VSConstants.S_OK;
if (pProgram == null)
return VSConstants.S_OK;
if (pProcess == null && pProgram.GetProcess(out pProcess) != VSConstants.S_OK)
return VSConstants.S_OK;
if (!IsNativeProgram(pProgram))
return VSConstants.S_OK;
string execPath;
uint procId;
if (!GetProcessInfo(pProcess, out execPath, out procId))
return VSConstants.S_OK;
string execCmd;
IEnumerable<string> rccItems;
if (!GetProjectInfo(execPath, out execCmd, out rccItems))
return VSConstants.S_OK;
LaunchDebug(execPath, execCmd, procId, rccItems);
return VSConstants.S_OK;
}
bool IsNativeProgram(IDebugProgram2 pProgram)
{
string engineName;
Guid engineGuid;
if (pProgram.GetEngineInfo(out engineName, out engineGuid) != VSConstants.S_OK)
return false;
return (engineGuid == NativeEngine.Id);
}
bool GetProcessInfo(IDebugProcess2 pProcess, out string execPath, out uint procId)
{
execPath = "";
procId = 0;
string fileName;
if (pProcess.GetName(enum_GETNAME_TYPE.GN_FILENAME, out fileName) != VSConstants.S_OK)
return false;
var pProcessId = new AD_PROCESS_ID[1];
if (pProcess.GetPhysicalProcessId(pProcessId) != VSConstants.S_OK)
return false;
execPath = Path.GetFullPath(fileName);
procId = pProcessId[0].dwProcessId;
return true;
}
bool GetProjectInfo(string execPath, out string execCmd, out IEnumerable<string> rccItems)
{
execCmd = "";
rccItems = null;
foreach (var project in HelperFunctions.ProjectsInSolution(Vsix.Instance.Dte)) {
var vcProject = project.Object as VCProject;
if (vcProject == null)
continue;
var vcConfigs = vcProject.Configurations as IVCCollection;
if (vcConfigs == null)
continue;
var activeConfig = project.ConfigurationManager.ActiveConfiguration;
if (activeConfig == null)
continue;
var activeConfigId = string.Format("{0}|{1}",
activeConfig.ConfigurationName, activeConfig.PlatformName);
var vcConfig = vcConfigs.Item(activeConfigId) as VCConfiguration;
if (vcConfig == null)
continue;
var props = vcProject as IVCBuildPropertyStorage;
var debugCommand = props.GetPropertyValue("LocalDebuggerCommand",
vcConfig.Name, "UserFile");
bool sameFile = string.Equals(execPath, Path.GetFullPath(debugCommand),
StringComparison.InvariantCultureIgnoreCase);
if (!sameFile)
continue;
var qtProject = QtProject.Create(vcProject);
if (qtProject == null || !qtProject.IsQtMsBuildEnabled())
continue;
OutputWriteLine(string.Format("Debugging project '{0}'", vcProject.Name));
var execArgs = props.GetPropertyValue("LocalDebuggerCommandArguments",
vcConfig.Name, "UserFile");
if (string.IsNullOrEmpty(execArgs))
continue;
var cmd = execPath + " " + execArgs;
if (!QmlDebugger.CheckCommandLine(execPath, cmd))
continue;
OutputWriteLine("QML debugging enabled");
execCmd = cmd;
rccItems = ((IVCCollection)vcProject.Files).Cast<VCFile>()
.Where(x => x.ItemType == QtRcc.ItemTypeName)
.Select(x => x.FullPath);
return true;
}
OutputWriteLine("QML debugging disabled");
return false;
}
void OutputWriteLine(string msg)
{
if (debugOutput != null)
debugOutput.OutputString(string.Format("Qt VS Tools: {0}\r\n", msg));
}
void LaunchDebug(
string execPath,
string execCmd,
uint procId,
IEnumerable<string> rccItems)
{
var targets = new[] { new VsDebugTargetInfo4
{
dlo = (uint)DEBUG_LAUNCH_OPERATION.DLO_CreateProcess,
bstrExe = new Uri(execPath).LocalPath,
bstrArg = execCmd,
bstrOptions = procId.ToString(),
bstrEnv = "QTRCC=" + string.Join(";", rccItems),
guidLaunchDebugEngine = QmlEngine.Id,
LaunchFlags = (uint)__VSDBGLAUNCHFLAGS5.DBGLAUNCH_BreakOneProcess,
}};
OutputWriteLine("Starting QML debug engine...");
var processInfo = new VsDebugTargetProcessInfo[targets.Length];
try {
debugger4.LaunchDebugTargets4((uint)targets.Length, targets, processInfo);
} catch (Exception e) {
OutputWriteLine(e.Message + "\r\n\r\nStacktrace:\r\n" + e.StackTrace);
}
}
}
}
|
