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
|
/** @file
* DBGGUI - The VirtualBox Debugger GUI. (VBoxDbg)
*/
/*
* Copyright (C) 2006-2024 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>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_dbggui_h
#define VBOX_INCLUDED_dbggui_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/types.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_dbggui VirtualBox Debugger GUI
* @ingroup grp_dbg
* @{
*/
#ifdef RT_OS_WINDOWS
struct ISession;
#else
class ISession;
#endif
/** Pointer to the debugger GUI instance structure. */
typedef struct DBGGUI *PDBGGUI;
/** Virtual method table for the debugger GUI. */
typedef struct DBGGUIVT
{
/** The version. (DBGGUIVT_VERSION) */
uint32_t u32Version;
/** @copydoc DBGGuiDestroy */
DECLCALLBACKMEMBER(int, pfnDestroy,(PDBGGUI pGui));
/** @copydoc DBGGuiAdjustRelativePos */
DECLCALLBACKMEMBER(void, pfnAdjustRelativePos,(PDBGGUI pGui, int x, int y, unsigned cx, unsigned cy));
/** @copydoc DBGGuiShowStatistics */
DECLCALLBACKMEMBER(int, pfnShowStatistics,(PDBGGUI pGui, const char *pszFilter, const char *pszExpand, const char *pszConfig));
/** @copydoc DBGGuiShowCommandLine */
DECLCALLBACKMEMBER(int, pfnShowCommandLine,(PDBGGUI pGui));
/** @copydoc DBGGuiSetParent */
DECLCALLBACKMEMBER(void, pfnSetParent,(PDBGGUI pGui, void *pvParent));
/** @copydoc DBGGuiSetMenu */
DECLCALLBACKMEMBER(void, pfnSetMenu,(PDBGGUI pGui, void *pvMenu));
/** The end version. (DBGGUIVT_VERSION) */
uint32_t u32EndVersion;
} DBGGUIVT;
/** Pointer to the virtual method table for the debugger GUI. */
typedef DBGGUIVT const *PCDBGGUIVT;
/** The u32Version value.
* The first byte is the minor version, the 2nd byte is major version number.
* The high 16-bit word is a magic. */
#define DBGGUIVT_VERSION UINT32_C(0xbead0200)
/** Macro for determining whether two versions are compatible or not.
* @returns boolean result.
* @param uVer1 The first version number.
* @param uVer2 The second version number.
*/
#define DBGGUIVT_ARE_VERSIONS_COMPATIBLE(uVer1, uVer2) \
( ((uVer1) & UINT32_C(0xffffff00)) == ((uVer2) & UINT32_C(0xffffff00)) )
/**
* Creates the debugger GUI.
*
* @returns VBox status code.
* @param pSession The VirtualBox session.
* @param ppGui Where to store the pointer to the debugger instance.
* @param ppGuiVT Where to store the virtual method table pointer.
* Optional.
*/
DBGDECL(int) DBGGuiCreate(ISession *pSession, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
/** @copydoc DBGGuiCreate */
typedef DECLCALLBACKTYPE(int, FNDBGGUICREATE,(ISession *pSession, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT));
/** Pointer to DBGGuiCreate. */
typedef FNDBGGUICREATE *PFNDBGGUICREATE;
/**
* Creates the debugger GUI given a VM handle.
*
* @returns VBox status code.
* @param pUVM The VM handle.
* @param pVMM The VMM function table.
* @param ppGui Where to store the pointer to the debugger instance.
* @param ppGuiVT Where to store the virtual method table pointer.
* Optional.
*/
DBGDECL(int) DBGGuiCreateForVM(PUVM pUVM, PCVMMR3VTABLE pVMM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT);
/** @copydoc DBGGuiCreateForVM */
typedef DECLCALLBACKTYPE(int, FNDBGGUICREATEFORVM,(PUVM pUVM, PCVMMR3VTABLE pVMM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT));
/** Pointer to DBGGuiCreateForVM. */
typedef FNDBGGUICREATEFORVM *PFNDBGGUICREATEFORVM;
/**
* Destroys the debugger GUI.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
*/
DBGDECL(int) DBGGuiDestroy(PDBGGUI pGui);
/**
* Notifies the debugger GUI that the console window (or whatever) has changed
* size or position.
*
* @param pGui The instance returned by DBGGuiCreate().
* @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.
*/
DBGDECL(void) DBGGuiAdjustRelativePos(PDBGGUI pGui, int x, int y, unsigned cx, unsigned cy);
/**
* Shows the default statistics window.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
* @param pszFilter Filter pattern.
* @param pszExpand Expand pattern.
* @param pszConfig Advanced filter configuration (min/max/regexp on
* sub-trees) and more.
*/
DBGDECL(int) DBGGuiShowStatistics(PDBGGUI pGui, const char *pszFilter, const char *pszExpand, const char *pszConfig);
/**
* Shows the default command line window.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
*/
DBGDECL(int) DBGGuiShowCommandLine(PDBGGUI pGui);
/**
* Sets the parent windows.
*
* @param pGui The instance returned by DBGGuiCreate().
* @param pvParent Pointer to a QWidget object.
*
* @remarks This will no affect any existing windows, so call it right after
* creating the thing.
*/
DBGDECL(void) DBGGuiSetParent(PDBGGUI pGui, void *pvParent);
/**
* Sets the debug menu object.
*
* @param pGui The instance returned by DBGGuiCreate().
* @param pvMenu Pointer to a QMenu object.
*
* @remarks Call right after creation or risk losing menu item.
*/
DBGDECL(void) DBGGuiSetMenu(PDBGGUI pGui, void *pvMenu);
/** @} */
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_dbggui_h */
|
