Changeset 41561 in vbox for trunk/include

Timestamp:

Jun 4, 2012 12:10:19 PM (13 years ago)

Author:

vboxsync

Message:

DBGC: Made the parse cope with functions.

Location:

trunk/include/VBox

Files:

• dbg.h (modified) (3 diffs)
• err.h (modified) (1 diff)

trunk/include/VBox/dbg.h

@@ -365 +365 @@
 
 
-/** Pointer to command descriptor. */
+/** Pointer to a command descriptor. */
 typedef struct DBGCCMD *PDBGCCMD;
-/** Pointer to const command descriptor. */
+/** Pointer to a const command descriptor. */
 typedef const struct DBGCCMD *PCDBGCCMD;
+
+/** Pointer to a function descriptor. */
+typedef struct DBGCFUNC *PDBGCFUNC;
+/** Pointer to a const function descriptor. */
+typedef const struct DBGCFUNC *PCDBGCFUNC;
 
 /** Pointer to helper functions for commands. */
@@ -887 +892 @@
 /**
  * DBGC command descriptor.
- *
- * If a pResultDesc is specified the command can be called and used
- * as a function too. If it's a pure function, set fFlags to
- * DBGCCMD_FLAGS_FUNCTION.
  */
 typedef struct DBGCCMD
@@ -920 +921 @@
 
 
+/**
+ * Function handler.
+ *
+ * The console will call the handler for a command once it's finished
+ * parsing the user input.  The command handler function is responsible
+ * for executing the command itself.
+ *
+ * @returns VBox status.
+ * @param   pCmd        Pointer to the command descriptor (as registered).
+ * @param   pCmdHlp     Pointer to command helper functions.
+ * @param   pVM         Pointer to the current VM (if any).
+ * @param   paArgs      Pointer to (readonly) array of arguments.
+ * @param   cArgs       Number of arguments in the array.
+ * @param   pResult     Where to return the result.
+ */
+typedef DECLCALLBACK(int) FNDBGCFUNC(PCDBGCFUNC pFunc, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs,
+                                     PDBGCVAR pResult);
+/** Pointer to a FNDBGCFUNC() function. */
+typedef FNDBGCFUNC *PFNDBGCFUNC;
+
+/**
+ * DBGC function descriptor.
+ */
+typedef struct DBGCFUNC
+{
+    /** Command string. */
+    const char     *pszFuncNm;
+    /** Minimum number of arguments. */
+    unsigned        cArgsMin;
+    /** Max number of arguments. */
+    unsigned        cArgsMax;
+    /** Argument descriptors (array). */
+    PCDBGCVARDESC   paArgDescs;
+    /** Number of argument descriptors. */
+    unsigned        cArgDescs;
+    /** flags. (reserved for now) */
+    unsigned        fFlags;
+    /** Handler function. */
+    PFNDBGCFUNC     pfnHandler;
+    /** Function syntax. */
+    const char     *pszSyntax;
+    /** Function description. */
+    const char     *pszDescription;
+} DBGCFUNC;
+
+
 
 /** Pointer to a DBGC backend. */

trunk/include/VBox/err.h

@@ -2166 +2166 @@
 /** Syntax error - Command not found. */
 #define VERR_DBGC_PARSE_COMMAND_NOT_FOUND           (VERR_DBGC_PARSE_LOWEST + 24)
+/** Syntax error - buggy parser. */
+#define VERR_DBGC_PARSE_BUG                         (VERR_DBGC_PARSE_LOWEST + 25)