Changeset 6246 in vbox

Timestamp:

Jan 4, 2008 7:18:18 PM (17 years ago)

Author:

vboxsync

Message:

hungarian and doxytalk.

Location:

trunk

Files:

• include/VBox/VBoxGuest.h (modified) (2 diffs)
• src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3Lib.cpp (modified) (13 diffs)

trunk/include/VBox/VBoxGuest.h

@@ -1359 +1359 @@
 # endif
 VBGLR3DECL(int)     VbglR3InterruptEventWaits(void);
-
-/* Shared clipboard */
-
+VBGLR3DECL(int)     VbglR3WriteLog(const char *pch, size_t cb);
+
+/** @name Shared clipboard
+ * @{ */
 VBGLR3DECL(int)     VbglR3ClipboardConnect(uint32_t *pu32ClientId);
 VBGLR3DECL(int)     VbglR3ClipboardDisconnect(uint32_t u32ClientId);
@@ -1368 +1369 @@
 VBGLR3DECL(int)     VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
 VBGLR3DECL(int)     VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
-
-/* Seamless mode */
-
-VBGLR3DECL(int)     VbglR3SeamlessSetCap(bool bState);
+/** @} */
+
+/** @name Seamless mode
+ * @{ */
+VBGLR3DECL(int)     VbglR3SeamlessSetCap(bool fState);
 VBGLR3DECL(int)     VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
 VBGLR3DECL(int)     VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
-
-/* Mouse */
-
-VBGLR3DECL(int)     VbglR3GetMouseStatus(uint32_t *pu32Features, uint32_t *pu32PointerX, uint32_t *pu32PointerY);
-VBGLR3DECL(int)     VbglR3SetMouseStatus(uint32_t u32Features);
-
-/* Backdoor logging */
-
-VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cb);
+/** @}  */
+
+/** @name Mouse
+ * @{ */
+VBGLR3DECL(int)     VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py);
+VBGLR3DECL(int)     VbglR3SetMouseStatus(uint32_t fFeatures);
+/** @}  */
+
 
 __END_DECLS

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3Lib.cpp

@@ -24 +24 @@
 # define INCL_ERRORS
 # include <os2.h>
-#endif 
+#endif
 
 #include <iprt/time.h>
@@ -49 +49 @@
 #if defined(RT_OS_OS2)
     /*
-     * We might wish to compile this with Watcom, so stick to 
-     * the OS/2 APIs all the way. And in any case we have to use 
+     * We might wish to compile this with Watcom, so stick to
+     * the OS/2 APIs all the way. And in any case we have to use
      * DosDevIOCtl for the requests, why not use Dos* for everything.
      */
@@ -107 +107 @@
     g_File = File;
 
-#endif 
+#endif
 
     return VINF_SUCCESS;
@@ -131 +131 @@
 /**
  * Internal wrapper around various OS specific ioctl implemenations.
- * 
+ *
  * @returns VBox status code as returned by VBoxGuestCommonIOCtl, or
  *          an failure returned by the OS specific ioctl APIs.
- * 
+ *
  * @param   iFunction   The requested function.
  * @param   pvData      The input and output data buffer.
  * @param   cbData      The size of the buffer.
- * 
+ *
  * @remark  Exactly how the VBoxGuestCommonIOCtl is ferried back
- *          here is OS specific. On BSD and Darwin we can use errno,  
+ *          here is OS specific. On BSD and Darwin we can use errno,
  *          while on OS/2 we use the 2nd buffer of the IOCtl.
  */
@@ -149 +149 @@
     int32_t vrc = VERR_INTERNAL_ERROR;
     ULONG cbOS2Data = sizeof(vrc);
-    APIRET rc = DosDevIOCtl(g_File, VBOXGUEST_IOCTL_CATEGORY, iFunction, 
+    APIRET rc = DosDevIOCtl(g_File, VBOXGUEST_IOCTL_CATEGORY, iFunction,
                             pvData, cbData, &cbOS2Parm,
                             &vrc, sizeof(vrc), &cbOS2Data);
@@ -157 +157 @@
 
     /* PORTME */
-#else 
+#else
     /* Defalut implementation (linux, solaris). */
     int rc2 = VERR_INTERNAL_ERROR;
@@ -173 +173 @@
 
     AssertPtrReturn(ppReq, VERR_INVALID_PARAMETER);
-    AssertMsgReturn(cb >= sizeof(VMMDevRequestHeader), ("%#x vs %#zx\n", cb, sizeof(VMMDevRequestHeader)), 
+    AssertMsgReturn(cb >= sizeof(VMMDevRequestHeader), ("%#x vs %#zx\n", cb, sizeof(VMMDevRequestHeader)),
                     VERR_INVALID_PARAMETER);
 
@@ -217 +217 @@
 
 
-VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pu32Features, uint32_t *pu32PointerX, uint32_t *pu32PointerY)
+VBGLR3DECL(int) VbglR3GetMouseStatus(uint32_t *pfFeatures, uint32_t *px, uint32_t *py)
 {
     VMMDevReqMouseStatus Req;
@@ -227 +227 @@
     if (RT_SUCCESS(rc))
     {
-        if (pu32Features)
-            *pu32Features = Req.mouseFeatures;
-        if (pu32PointerX)
-            *pu32PointerX = Req.pointerXPos;
-        if (pu32PointerY)
-            *pu32PointerY = Req.pointerYPos;
+        if (pfFeatures)
+            *pfFeatures = Req.mouseFeatures;
+        if (px)
+            *px = Req.pointerXPos;
+        if (py)
+            *py = Req.pointerYPos;
     }
     return rc;
@@ -238 +238 @@
 
 
-VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t u32Features)
+VBGLR3DECL(int) VbglR3SetMouseStatus(uint32_t fFeatures)
 {
     VMMDevReqMouseStatus Req;
     vmmdevInitRequest(&Req.header, VMMDevReq_SetMouseStatus);
-    Req.mouseFeatures = u32Features;
+    Req.mouseFeatures = fFeatures;
     Req.pointerXPos = 0;
     Req.pointerYPos = 0;
@@ -250 +250 @@
 
 /**
- * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return 
+ * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return
  * with a VERR_INTERRUPTED status.
- * 
- * Can be used in combination with a termination flag variable for interrupting 
+ *
+ * Can be used in combination with a termination flag variable for interrupting
  * event loops. Avoiding race conditions is the responsibility of the caller.
  *
@@ -266 +266 @@
 /**
  * Write to the backdoor logger from ring 3 guest code.
- * 
+ *
  * @returns IPRT status code
- * 
+ *
  * @remakes This currently does not accept more than 255 bytes of data at
  *          one time. It should probably be rewritten to use pass a pointer
@@ -275 +275 @@
 VBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cb)
 {
-    /* 
+    /*
      * Solaris does not accept more than 255 bytes of data per ioctl request,
      * so split large string into 128 byte chunks to prevent truncation.