| 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 (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___VBox_dbggui_h
|
|---|
| 27 | #define ___VBox_dbggui_h
|
|---|
| 28 |
|
|---|
| 29 | #if defined(RT_OS_WINDOWS)
|
|---|
| 30 | # include <VirtualBox.h>
|
|---|
| 31 | #else
|
|---|
| 32 | # include <VirtualBox_XPCOM.h>
|
|---|
| 33 | #endif
|
|---|
| 34 |
|
|---|
| 35 | #include <VBox/types.h>
|
|---|
| 36 |
|
|---|
| 37 | __BEGIN_DECLS
|
|---|
| 38 |
|
|---|
| 39 | /** @defgroup grp_dbggui VirtualBox Debugger GUI
|
|---|
| 40 | * @{
|
|---|
| 41 | */
|
|---|
| 42 |
|
|---|
| 43 | /** Pointer to the debugger GUI instance structure. */
|
|---|
| 44 | typedef struct DBGGUI *PDBGGUI;
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * Creates the debugger GUI.
|
|---|
| 48 | *
|
|---|
| 49 | * @returns VBox status code.
|
|---|
| 50 | * @param pSession The VirtualBox session.
|
|---|
| 51 | * @param ppGui Where to store the pointer to the debugger instance.
|
|---|
| 52 | */
|
|---|
| 53 | DBGDECL(int) DBGGuiCreate(ISession *pSession, PDBGGUI *ppGui);
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * Destroys the debugger GUI.
|
|---|
| 57 | *
|
|---|
| 58 | * @returns VBox status code.
|
|---|
| 59 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 60 | */
|
|---|
| 61 | DBGDECL(int) DBGGuiDestroy(PDBGGUI pGui);
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Notifies the debugger GUI that the console window (or whatever) has changed
|
|---|
| 65 | * size or position.
|
|---|
| 66 | *
|
|---|
| 67 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 68 | * @param x The x-coordinate of the window the debugger is relative to.
|
|---|
| 69 | * @param y The y-coordinate of the window the debugger is relative to.
|
|---|
| 70 | * @param cx The width of the window the debugger is relative to.
|
|---|
| 71 | * @param cy The height of the window the debugger is relative to.
|
|---|
| 72 | */
|
|---|
| 73 | DBGDECL(void) DBGGuiAdjustRelativePos(PDBGGUI pGui, int x, int y, unsigned cx, unsigned cy);
|
|---|
| 74 |
|
|---|
| 75 | /**
|
|---|
| 76 | * Shows the default statistics window.
|
|---|
| 77 | *
|
|---|
| 78 | * @returns VBox status code.
|
|---|
| 79 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 80 | */
|
|---|
| 81 | DBGDECL(int) DBGGuiShowStatistics(PDBGGUI pGui);
|
|---|
| 82 |
|
|---|
| 83 | /**
|
|---|
| 84 | * Shows the default command line window.
|
|---|
| 85 | *
|
|---|
| 86 | * @returns VBox status code.
|
|---|
| 87 | * @param pGui The instance returned by DBGGuiCreate().
|
|---|
| 88 | */
|
|---|
| 89 | DBGDECL(int) DBGGuiShowCommandLine(PDBGGUI pGui);
|
|---|
| 90 |
|
|---|
| 91 | /** @} */
|
|---|
| 92 |
|
|---|
| 93 | __END_DECLS
|
|---|
| 94 |
|
|---|
| 95 | #endif
|
|---|
| 96 |
|
|---|
