blob: 47f42ebdfeeace7c6f0e40c2a499c64c82c141f6 (
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
|
/* $Id: VBoxDbgGui.h $ */
/** @file
* VBox Debugger GUI - The Manager.
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef DEBUGGER_INCLUDED_SRC_VBoxDbgGui_h
#define DEBUGGER_INCLUDED_SRC_VBoxDbgGui_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
// VirtualBox COM interfaces declarations (generated header)
#ifdef VBOX_WITH_XPCOM
# include <VirtualBox_XPCOM.h>
#else
# include <iprt/win/windows.h> /* Include via cleanup wrapper before VirtualBox.h includes it via rpc.h. */
# include <VirtualBox.h>
#endif
#include "VBoxDbgStatsQt.h"
#include "VBoxDbgConsole.h"
/**
* The Debugger GUI manager class.
*
* It's job is to provide a C callable external interface and manage the
* windows and bit making up the debugger GUI.
*/
class VBoxDbgGui : public QObject
{
Q_OBJECT;
public:
/**
* Create a default VBoxDbgGui object.
*/
VBoxDbgGui();
/**
* Initializes a VBoxDbgGui object by ISession.
*
* @returns VBox status code.
* @param pSession VBox Session object.
*/
int init(ISession *pSession);
/**
* Initializes a VBoxDbgGui object by VM handle.
*
* @returns VBox status code.
* @param pUVM The user mode VM handle. The caller's reference will be
* consumed on success.
* @param pVMM The VMM function table.
*/
int init(PUVM pUVM, PCVMMR3VTABLE pVMM);
/**
* Destroys the VBoxDbgGui object.
*/
virtual ~VBoxDbgGui();
/**
* Sets the parent widget.
*
* @param pParent New parent widget.
* @remarks This only affects new windows.
*/
void setParent(QWidget *pParent);
/**
* Sets the menu object.
*
* @param pMenu New menu object.
* @remarks This only affects new menu additions.
*/
void setMenu(QMenu *pMenu);
/**
* Show the default statistics window, creating it if necessary.
*
* @returns VBox status code.
* @param pszFilter Filter pattern.
* @param pszExpand Expand pattern.
*/
int showStatistics(const char *pszFilter, const char *pszExpand);
/**
* Repositions and resizes (optionally) the statistics to its defaults
*
* @param fResize If set (default) the size of window is also changed.
*/
void repositionStatistics(bool fResize = true);
/**
* Show the console window (aka. command line), creating it if necessary.
*
* @returns VBox status code.
*/
int showConsole();
/**
* Repositions and resizes (optionally) the console to its defaults
*
* @param fResize If set (default) the size of window is also changed.
*/
void repositionConsole(bool fResize = true);
/**
* Update the desktop size.
* This is called whenever the reference window changes position.
*/
void updateDesktopSize();
/**
* Notifies the debugger GUI that the console window (or whatever) has changed
* size or position.
*
* @param x The x-coordinate of the window the debugger is relative to.
* @param y The y-coordinate of the window the debugger is relative to.
* @param cx The width of the window the debugger is relative to.
* @param cy The height of the window the debugger is relative to.
*/
void adjustRelativePos(int x, int y, unsigned cx, unsigned cy);
/**
* Gets the user mode VM handle.
* @returns The UVM handle.
*/
PUVM getUvmHandle() const
{
return m_pUVM;
}
/**
* Gets the VMM function table.
* @returns The VMM function table.
*/
PCVMMR3VTABLE getVMMFunctionTable() const
{
return m_pVMM;
}
/**
* @returns The name of the machine.
*/
QString getMachineName() const;
protected slots:
/**
* Notify that a child object (i.e. a window is begin destroyed).
* @param pObj The object which is being destroyed.
*/
void notifyChildDestroyed(QObject *pObj);
protected:
/** The debugger statistics. */
VBoxDbgStats *m_pDbgStats;
/** The debugger console (aka. command line). */
VBoxDbgConsole *m_pDbgConsole;
/** The VirtualBox session. */
ISession *m_pSession;
/** The VirtualBox console. */
IConsole *m_pConsole;
/** The VirtualBox Machine Debugger. */
IMachineDebugger *m_pMachineDebugger;
/** The VirtualBox Machine. */
IMachine *m_pMachine;
/** The VM instance. */
PVM m_pVM;
/** The user mode VM handle. */
PUVM m_pUVM;
/** The VMM function table. */
PCVMMR3VTABLE m_pVMM;
/** The parent widget. */
QWidget *m_pParent;
/** The menu object for the 'debug' menu. */
QMenu *m_pMenu;
/** The x-coordinate of the window we're relative to. */
int m_x;
/** The y-coordinate of the window we're relative to. */
int m_y;
/** The width of the window we're relative to. */
unsigned m_cx;
/** The height of the window we're relative to. */
unsigned m_cy;
/** The x-coordinate of the desktop. */
int m_xDesktop;
/** The y-coordinate of the desktop. */
int m_yDesktop;
/** The size of the desktop. */
unsigned m_cxDesktop;
/** The size of the desktop. */
unsigned m_cyDesktop;
};
#endif /* !DEBUGGER_INCLUDED_SRC_VBoxDbgGui_h */
|
