| 1 | /** @file
|
|---|
| 2 | * DBGGUI - The VirtualBox Debugger GUI.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2007 innotek GmbH
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License as published by the Free Software Foundation,
|
|---|
| 12 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 13 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 14 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 17 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 18 | * license agreement apply instead of the previous paragraph.
|
|---|
| 19 | */
|
|---|
| 20 |
|
|---|
| 21 | #ifndef __VBox_dbggui_h__
|
|---|
| 22 | #define __VBox_dbggui_h__
|
|---|
| 23 |
|
|---|
| 24 | #if defined(__WIN__)
|
|---|
| 25 | # include <VirtualBox.h>
|
|---|
| 26 | #else
|
|---|
| 27 | # include <VirtualBox_XPCOM.h>
|
|---|
| 28 | #endif
|
|---|
| 29 |
|
|---|
| 30 | #include <VBox/types.h>
|
|---|
| 31 |
|
|---|
| 32 | __BEGIN_DECLS
|
|---|
| 33 |
|
|---|
| 34 | /** @defgroup grp_dbggui VirtualBox Debugger GUI
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /** Pointer to the debugger GUI instance structure. */
|
|---|
| 39 | typedef struct DBGGUI *PDBGGUI;
|
|---|
| 40 |
|
|---|
| 41 | /**
|
|---|
| 42 | * Creates the debugger GUI.
|
|---|
| 43 | *
|
|---|
| 44 | * @returns VBox status code.
|
|---|
| 45 | * @param pSession The VirtualBox session.
|
|---|
| 46 | * @param ppGui Where to store the pointer to the debugger instance.
|
|---|
| 47 | */
|
|---|
| 48 | DBGDECL(int) DBGGuiCreate(ISession *pSession, PDBGGUI *ppGui);
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * Destroys the debugger GUI.
|
|---|
| 52 | *
|
|---|
| 53 | * @returns VBox status code.
|
|---|
| 54 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 55 | */
|
|---|
| 56 | DBGDECL(int) DBGGuiDestroy(PDBGGUI pGui);
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Notifies the debugger GUI that the console window (or whatever) has changed
|
|---|
| 60 | * size or position.
|
|---|
| 61 | *
|
|---|
| 62 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 63 | * @param x The x-coordinate of the window the debugger is relative to.
|
|---|
| 64 | * @param y The y-coordinate of the window the debugger is relative to.
|
|---|
| 65 | * @param cx The width of the window the debugger is relative to.
|
|---|
| 66 | * @param cy The height of the window the debugger is relative to.
|
|---|
| 67 | */
|
|---|
| 68 | DBGDECL(void) DBGGuiAdjustRelativePos(PDBGGUI pGui, int x, int y, unsigned cx, unsigned cy);
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * Shows the default statistics window.
|
|---|
| 72 | *
|
|---|
| 73 | * @returns VBox status code.
|
|---|
| 74 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 75 | */
|
|---|
| 76 | DBGDECL(int) DBGGuiShowStatistics(PDBGGUI pGui);
|
|---|
| 77 |
|
|---|
| 78 | /**
|
|---|
| 79 | * Shows the default command line window.
|
|---|
| 80 | *
|
|---|
| 81 | * @returns VBox status code.
|
|---|
| 82 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 83 | */
|
|---|
| 84 | DBGDECL(int) DBGGuiShowCommandLine(PDBGGUI pGui);
|
|---|
| 85 |
|
|---|
| 86 | /** @} */
|
|---|
| 87 |
|
|---|
| 88 | __END_DECLS
|
|---|
| 89 |
|
|---|
| 90 | #endif
|
|---|
| 91 |
|
|---|
