aboutsummaryrefslogtreecommitdiffstats
path: root/src/qtvstools/QML/Debugging/AD7/QmlDebugAD7Events.cs
blob: 6743499ec7409fae3cfeb6307e3a969231aa86b0 (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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/****************************************************************************
**
** 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 Microsoft.VisualStudio;
using Microsoft.VisualStudio.Debugger.Interop;
using System;

namespace QtVsTools.Qml.Debug.AD7
{
    abstract class DebugEvent :

        IDebugEvent2 // "This interface is used to communicate both critical debug information,
                     //  such as stopping at a breakpoint, and non-critical information, such as a
                     //  debugging message."
    {
        public Guid InterfaceId { get; protected set; }
        public uint Attributes { get; protected set; }

        protected const uint ASYNCHRONOUS = (uint)enum_EVENTATTRIBUTES.EVENT_ASYNCHRONOUS;
        protected const uint STOPPING = (uint)enum_EVENTATTRIBUTES.EVENT_ASYNC_STOP;
        protected const uint SYNCHRONOUS = (uint)enum_EVENTATTRIBUTES.EVENT_SYNCHRONOUS;
        protected const uint SYNCHRONOUS_STOPPING =
              (uint)enum_EVENTATTRIBUTES.EVENT_STOPPING
            | (uint)enum_EVENTATTRIBUTES.EVENT_SYNCHRONOUS;

        protected QmlEngine Engine { get; set; }
        protected IDebugProgram2 Program { get; set; }
        protected IDebugThread2 Thread { get; set; }
        protected IDebugEventCallback2 Callback { get; set; }

        protected DebugEvent(
            QmlEngine engine,
            Guid interfaceId,
            uint attributes,
            IDebugProgram2 program = null,
            IDebugThread2 thread = null,
            IDebugEventCallback2 callback = null)
        {
            InterfaceId = interfaceId;
            Attributes = attributes;
            Engine = engine;
            Program = program;
            Thread = thread;
            Callback = (callback != null) ? callback : engine;
        }

        protected void Send()
        {
            if (Callback != null) {
                var interfaceId = InterfaceId;
                Callback.Event(
                    Engine, null, Program, Thread,
                    this, ref interfaceId, Attributes);
            }
        }

        public int /*IDebugEvent2*/ GetAttributes(out uint eventAttributes)
        {
            eventAttributes = Attributes;
            return VSConstants.S_OK;
        }

        public static void Send(DebugEvent debugEvent)
        {
            debugEvent.Send();
        }
    }

    class EngineCreateEvent : DebugEvent, IDebugEngineCreateEvent2
    {
        public EngineCreateEvent(QmlEngine engine)
        : base(engine, typeof(IDebugEngineCreateEvent2).GUID, ASYNCHRONOUS)
        { }

        int IDebugEngineCreateEvent2.GetEngine(out IDebugEngine2 pEngine)
        {
            pEngine = Engine as IDebugEngine2;
            return VSConstants.S_OK;
        }
    }

    class ProgramCreateEvent : DebugEvent, IDebugProgramCreateEvent2
    {
        public ProgramCreateEvent(Program program)
        : base(program.Engine, typeof(IDebugProgramCreateEvent2).GUID,
              ASYNCHRONOUS, program)
        { }
    }

    class ProgramDestroyEvent : DebugEvent, IDebugProgramDestroyEvent2
    {
        uint exitCode;
        public new Program Program { get; private set; }

        public ProgramDestroyEvent(Program program, uint exitCode)
        : base(program.Engine, typeof(IDebugProgramDestroyEvent2).GUID,
              SYNCHRONOUS, program)
        {
            Program = program;
            this.exitCode = exitCode;
        }

        int IDebugProgramDestroyEvent2.GetExitCode(out uint exitCode)
        {
            exitCode = this.exitCode;
            return VSConstants.S_OK;
        }
    }

    class ThreadCreateEvent : DebugEvent, IDebugThreadCreateEvent2
    {
        public ThreadCreateEvent(Program program)
        : base(program.Engine, typeof(IDebugThreadCreateEvent2).GUID,
              ASYNCHRONOUS, program, program)
        { }
    }

    class ThreadDestroyEvent : DebugEvent, IDebugThreadDestroyEvent2
    {
        uint exitCode;

        public ThreadDestroyEvent(Program program, uint exitCode)
        : base(program.Engine, typeof(IDebugThreadDestroyEvent2).GUID,
              SYNCHRONOUS, program, program)
        {
            this.exitCode = exitCode;
        }

        int IDebugThreadDestroyEvent2.GetExitCode(out uint exitCode)
        {
            exitCode = this.exitCode;
            return VSConstants.S_OK;
        }
    }

    class LoadCompleteEvent : DebugEvent, IDebugLoadCompleteEvent2
    {
        public LoadCompleteEvent(Program program)
        : base(program.Engine, typeof(IDebugLoadCompleteEvent2).GUID,
              STOPPING, program, program)
        { }
    }

    class EntryPointEvent : DebugEvent, IDebugEntryPointEvent2
    {
        public EntryPointEvent(Program program)
        : base(program.Engine, typeof(IDebugEntryPointEvent2).GUID,
              STOPPING, program, program)
        { }
    }

    class BreakpointBoundEvent : DebugEvent, IDebugBreakpointBoundEvent2
    {
        public Breakpoint Breakpoint { get; private set; }
        public BreakpointBoundEvent(Breakpoint breakpoint)
        : base(breakpoint.Program.Engine, typeof(IDebugBreakpointBoundEvent2).GUID,
              ASYNCHRONOUS, breakpoint.Program, breakpoint.Program)
        {
            Breakpoint = breakpoint;
        }

        int IDebugBreakpointBoundEvent2.GetPendingBreakpoint(
            out IDebugPendingBreakpoint2 ppPendingBP)
        {
            ppPendingBP = Breakpoint.Parent;
            return VSConstants.S_OK;
        }

        int IDebugBreakpointBoundEvent2.EnumBoundBreakpoints(
            out IEnumDebugBoundBreakpoints2 ppEnum)
        {
            ppEnum = BoundBreakpointsEnum.Create(Breakpoint);
            return VSConstants.S_OK;
        }
    }

    class BreakpointEvent : DebugEvent, IDebugBreakpointEvent2
    {
        IEnumDebugBoundBreakpoints2 boundBreakpoints;

        public BreakpointEvent(Program program,
            IEnumDebugBoundBreakpoints2 boundBreakpoints)
        : base(program.Engine, typeof(IDebugBreakpointEvent2).GUID,
              STOPPING, program, program)
        {
            this.boundBreakpoints = boundBreakpoints;
        }

        int IDebugBreakpointEvent2.EnumBreakpoints(out IEnumDebugBoundBreakpoints2 ppEnum)
        {
            ppEnum = boundBreakpoints;
            return VSConstants.S_OK;
        }
    }

    class StepCompleteEvent : DebugEvent, IDebugStepCompleteEvent2
    {
        public StepCompleteEvent(Program program)
        : base(program.Engine, typeof(IDebugStepCompleteEvent2).GUID,
              STOPPING, program, program)
        { }
    }

    class ExpressionEvaluationCompleteEvent : DebugEvent, IDebugExpressionEvaluationCompleteEvent2
    {
        public Expression Expression { get; private set; }
        public Property Property { get; private set; }

        public ExpressionEvaluationCompleteEvent(
            IDebugEventCallback2 callback,
            Expression expression,
            Property property)
            : base(expression.Engine, typeof(IDebugExpressionEvaluationCompleteEvent2).GUID,
                SYNCHRONOUS, expression.Program, expression.Program, callback)
        {
            Expression = expression;
            Property = property;
        }

        int IDebugExpressionEvaluationCompleteEvent2.GetExpression(out IDebugExpression2 ppExpr)
        {
            ppExpr = Expression;
            return VSConstants.S_OK;
        }

        int IDebugExpressionEvaluationCompleteEvent2.GetResult(out IDebugProperty2 ppResult)
        {
            ppResult = Property;
            return VSConstants.S_OK;
        }
    }
}