Changeset 281

Timestamp:

Nov 2, 2009, 11:32:16 PM (16 years ago)

Author:

Dmitry A. Kuminov

Message:

3rdparty: os2/xsystray: Implemented array of HMQ to track HK_INPUT hook installation/removal.

Location:

trunk/src/3rdparty/os2/xsystray

Files:

• xsystray.c (modified) (7 diffs)
• xsystray.h (modified) (2 diffs)
• xsystray_api.c (modified) (14 diffs)

trunk/src/3rdparty/os2/xsystray/xsystray.c

@@ -1071 +1071 @@
 
 static
-BOOL WgtXSysTrayControl(HWND hwnd, PXCENTERWIDGET pWidget,
-                        PSYSTRAYCTLDATA pCtlData)
-{
-    BOOL brc = FALSE;
+ULONG WgtXSysTrayControl(HWND hwnd, PXCENTERWIDGET pWidget,
+                         PSYSTRAYCTLDATA pCtlData)
+{
+    BOOL    brc = FALSE;
+    ULONG   xrc = XST_FAIL;
+
     PSYSTRAYDATA pSysTrayData = (PSYSTRAYDATA)pWidget->pUser;
 
@@ -1087 +1089 @@
             pCtlData->u.version.ulMajor = XSYSTRAY_VERSION_MINOR;
             pCtlData->u.version.ulRevision = XSYSTRAY_VERSION_REVISION;
-            brc = TRUE;
+            xrc = XST_OK;
         }
         break;
@@ -1112 +1114 @@
             hIcon = WinCreatePointerIndirect(HWND_DESKTOP, &Info);
             if (hIcon == NULLHANDLE)
-            {
-                brc = FALSE;
                 break;
-            }
 
             pData = FindIconData(pSysTrayData, pCtlData->hwndSender,
@@ -1129 +1128 @@
                 // we didn't change the number of icons so simply invalidate
                 WinInvalidateRect(pWidget->hwndWidget, NULL, FALSE);
+
+                xrc = XST_REPLACED;
             }
             else
@@ -1166 +1167 @@
 
                 WgtXSysTrayUpdateAfterIconAddRemove(pWidget);
+
+                xrc = XST_OK;
             }
-
-            brc = TRUE;
         }
         break;
@@ -1201 +1202 @@
                 WgtXSysTrayUpdateAfterIconAddRemove(pWidget);
 
-                brc = TRUE;
+                xrc = XST_OK;
             }
             else
@@ -1213 +1214 @@
 
     LOGF(("return %d (WinGetLastError is %x)\n",
-          brc, WinGetLastError(pWidget->habWidget)));
-
-    return brc;
+          xrc, WinGetLastError(pWidget->habWidget)));
+
+    return xrc;
 }
 

trunk/src/3rdparty/os2/xsystray/xsystray.h

@@ -40 +40 @@
 
 #define WM_XST_CONTROL  (WM_USER + 0)
-
+        // message sent to the system tray server to request an action
+
+// server action commands
 typedef enum
 {
@@ -50 +52 @@
     SYSTRAYCMD_HIDEBALLOON,
 } SYSTRAYCMD;
+
+// server responses to WM_XST_CONTROL
+#define XST_OK          0   // command succeeded
+#define XST_FAIL        1   // command failed
+#define XST_REPLACED    2   // SYSTRAYCMD_ADDICON replaced the existing icon
 
 /*

trunk/src/3rdparty/os2/xsystray/xsystray_api.c

@@ -26 +26 @@
 #define INCL_WINPOINTERS
 #define INCL_WINHOOKS
+#define INCL_WINWINDOWMGR
 #include <os2.h>
 
@@ -33 +34 @@
 #include <string.h>
 #include <sys/builtin.h>        // atomics
+#include <sys/fmutex.h>         // fast mutex
+#include <sys/smutex.h>         // simple mutex
 
 static ULONG WM_XST_CREATED = 0;
@@ -56 +59 @@
         // sounds sane
 
+typedef struct
+{
+    HMQ         hmq;
+    unsigned    cRefs;
+} HMQREFS, *PHMQREFS;
+
+static PHMQREFS G_pHmqRefs = NULL;
+                // array of references to each HMQ that we make
+static size_t   G_cHmqRefs = 0;
+                // number of elements in G_pHmqRefs
+static size_t   G_cHmqRefsMax = 0;
+                // maximum number of elements in G_pHmqRefs
+static _fmutex  G_fmtx;
+                // fast mutex to protect
+static _smutex  G_smtx = 0;
+                // simple mutex for xstAddSysTrayIcon()
+#define         HMQREFS_GROW 4
+                // how fast G_pHmqRefs grows when more space is necessary
+
 // @todo to be on the safe side with casting in __atomic_cmpxchg32() we need
 // compile-time assertions like this:
@@ -78 +100 @@
 }
 
-static BOOL SendSysTrayCtlMsg(PSYSTRAYCTLDATA pData)
+static ULONG SendSysTrayCtlMsg(PSYSTRAYCTLDATA pData)
 {
     APIRET arc;
@@ -112 +134 @@
 
         mrc = WinSendMsg(G_hwndSysTray, WM_XST_CONTROL, pData, NULL);
-        if (mrc == (MRESULT)TRUE && pData->bAcknowledged)
-            return TRUE;
+        if (pData->bAcknowledged)
+            return (ULONG)mrc;
 
         // if we failed to send the message, it may mean that XCenter was restarted
@@ -126 +148 @@
         break;
     }
-    while (TRUE);
-
-    return FALSE;
+    while (1);
+
+    return XST_FAIL;
 }
 
@@ -183 +205 @@
 /*
  *@@ InputHook:
- *      This is used to intercept posted XST_NOTIFY messages and apply special
- *      processing to them (compose a client window-specific notification
- *      message, free the NOTIFYDATA structure and post the composed message to
- *      the target window).
+ *      This is used to intercept posted WM_XST_NOTIFY messages and apply
+ *      special processing to them (compose a client window-specific
+ *      notification message, free the NOTIFYDATA structure and post the
+ *      composed message to the target window).
  */
 
@@ -243 +265 @@
     pData->hwndSender = NULLHANDLE;
 
-    brc = SendSysTrayCtlMsg(pData);
+    brc = SendSysTrayCtlMsg(pData) == XST_OK;
     if (brc)
     {
@@ -302 +324 @@
                        ULONG ulFlags)   // in: flags (not currently used, must be 0)
 {
-    BOOL brc;
-    PPIB ppib;
+    BOOL    brc;
+    ULONG   xrc;
+    PPIB    ppib;
+    HAB     hab;
+    HMQ     hmq;
+    size_t  i;
+
     PSYSTRAYCTLDATA pData = AllocSysTrayCtlDataPtr();
     if (!pData)
         return FALSE;
 
-    // install the message hook if not already done so
-    // @todo the code is temporary and incorrect, it's just for testing
-    // (we should use an array of HMQ to check if we already installed the filter)
     if (WM_XST_NOTIFY == 0)
-    {
         WM_XST_NOTIFY = WinAddAtom(WinQuerySystemAtomTable(),
                                    WM_XST_NOTIFY_ATOM);
 
-        brc = WinSetHook(WinQueryAnchorBlock(hwnd),
-                         HMQ_CURRENT, HK_INPUT, (PFN)InputHook, NULLHANDLE);
-        if (!brc)
+    hab = WinQueryAnchorBlock(hwnd);
+    hmq = WinQueryWindowULong(hwnd, QWL_HMQ);
+    if (hmq == NULLHANDLE)
+        return FALSE;
+
+    // initialize the HMQ refs array
+    // @todo remove _smutex usage when we get into the DLL and initialize
+    // _fmutex + array in the DLL init routine
+    _smutex_request(&G_smtx);
+    if (!G_pHmqRefs)
+    {
+        if (_fmutex_create(&G_fmtx, 0))
             return FALSE;
-    }
+        G_pHmqRefs = malloc(sizeof(*G_pHmqRefs) * HMQREFS_GROW);
+        if (!G_pHmqRefs)
+            return FALSE;
+        G_cHmqRefs = 0;
+        G_cHmqRefsMax = HMQREFS_GROW;
+    }
+    _smutex_release(&G_smtx);
 
     // give all processes temporary access to hIcon
@@ -332 +370 @@
         pData->u.icon.ulMsgId = ulMsgId;
 
-        brc = SendSysTrayCtlMsg(pData);
+        xrc = SendSysTrayCtlMsg(pData);
+        brc = xrc == XST_OK || xrc == XST_REPLACED;
 
         // revoke temporary access to hIcon
@@ -341 +380 @@
     FreeSysTrayCtlDataPtr(pData);
 
+    if (xrc == XST_OK)
+    {
+        // install the message hook for the new icon to intercept WM_XST_NOTIFY
+        // messages or increase the reference count if already done so
+        brc = FALSE;
+        _fmutex_request(&G_fmtx, _FMR_IGNINT);
+        do
+        {
+            for (i = 0; i < G_cHmqRefs; ++i)
+                if (G_pHmqRefs[i].hmq == hmq)
+                    break;
+            if (i < G_cHmqRefs)
+                ++G_pHmqRefs[i].cRefs;
+            else
+            {
+                if (i == G_cHmqRefsMax)
+                {
+                    PHMQREFS pNewRefs = realloc(G_pHmqRefs,
+                                                sizeof(*G_pHmqRefs) *
+                                                (G_cHmqRefsMax + HMQREFS_GROW));
+                    if (!pNewRefs)
+                        break;
+                    G_pHmqRefs = pNewRefs;
+                    G_cHmqRefsMax += HMQREFS_GROW;
+                }
+                brc = WinSetHook(hab, hmq, HK_INPUT, (PFN)InputHook, NULLHANDLE);
+                if (!brc)
+                    break;
+                ++G_cHmqRefs;
+                G_pHmqRefs[i].hmq = hmq;
+                G_pHmqRefs[i].cRefs = 1;
+            }
+            brc = TRUE;
+        }
+        while (0);
+        _fmutex_release(&G_fmtx);
+
+        if (!brc)
+            xstRemoveSysTrayIcon(hwnd, usId);
+    }
+
     return brc;
 }
@@ -355 +435 @@
 BOOL xstRemoveSysTrayIcon(HWND hwnd,    // in: window handle associated with the icon
                           USHORT usId)  // in: icon ID to remove
+{
+    BOOL brc;
+    HAB     hab;
+    HMQ     hmq;
+    size_t  i;
+
+    PSYSTRAYCTLDATA pData = AllocSysTrayCtlDataPtr();
+    if (!pData)
+        return FALSE;
+
+    hab = WinQueryAnchorBlock(hwnd);
+    hmq = WinQueryWindowULong(hwnd, QWL_HMQ);
+    if (hmq == NULLHANDLE)
+        return FALSE;
+
+    pData->ulCommand = SYSTRAYCMD_REMOVEICON;
+    pData->hwndSender = hwnd;
+    pData->u.icon.usId = usId;
+
+    brc = SendSysTrayCtlMsg(pData) == XST_OK;
+
+    FreeSysTrayCtlDataPtr(pData);
+
+    if (brc)
+    {
+        // remove the message hook if it's the last reference to the HMQ
+        _fmutex_request(&G_fmtx, _FMR_IGNINT);
+        do
+        {
+            for (i = 0; i < G_cHmqRefs; ++i)
+                if (G_pHmqRefs[i].hmq == hmq)
+                    break;
+            if (i == G_cHmqRefs)
+                // unknown HMQ??
+                break;
+
+            if (--G_pHmqRefs[i].cRefs == 0)
+                WinReleaseHook(hab, hmq, HK_INPUT, (PFN)InputHook, NULLHANDLE);
+        }
+        while (0);
+        _fmutex_release(&G_fmtx);
+    }
+
+    return brc;
+}
+
+/*
+ *@@ xstSetSysTrayIconToolTip:
+ *
+ *      Sets the tooltip text for the given icon in the system tray. This text
+ *      is shown when the mouse pointer is held still over the icon area for
+ *      some time.
+ *
+ *      If pszText is NULL, the tooltip text is reset and will not be shown next
+ *      time. The old tooltip is hidden if it is being currently shown.
+ *
+ *      Returns TRUE on success and FALSE otherwise.
+ *
+ *      NOTE: The maximum tooltip text length (including terminating null) is
+ *      limited to a value returned by xstGetSysTrayMaxTextLen(). If the
+ *      supplied string is longer, it will be truncated.
+ */
+
+BOOL xstSetSysTrayIconToolTip(HWND hwnd,    // in: window handle associated with the icon
+                              USHORT usId,  // in: icon ID to set the tooltip for
+                              PSZ pszText)  // in: tooltip text
 {
     BOOL brc;
@@ -361 +507 @@
         return FALSE;
 
-    pData->ulCommand = SYSTRAYCMD_REMOVEICON;
-    pData->hwndSender = hwnd;
-    pData->u.icon.usId = usId;
-
-    brc = SendSysTrayCtlMsg(pData);
-
-    FreeSysTrayCtlDataPtr(pData);
-
-    return brc;
-}
-
-/*
- *@@ xstSetSysTrayIconToolTip:
- *
- *      Sets the tooltip text for the given icon in the system tray. This text
- *      is shown when the mouse pointer is held still over the icon area for
- *      some time.
- *
- *      If pszText is NULL, the tooltip text is reset and will not be shown next
- *      time. The old tooltip is hidden if it is being currently shown.
- *
- *      Returns TRUE on success and FALSE otherwise.
- *
- *      NOTE: The maximum tooltip text length (including terminating null) is
- *      limited to a value returned by xstGetSysTrayMaxTextLen(). If the
- *      supplied string is longer, it will be truncated.
- */
-
-BOOL xstSetSysTrayIconToolTip(HWND hwnd,    // in: window handle associated with the icon
-                              USHORT usId,  // in: icon ID to set the tooltip for
-                              PSZ pszText)  // in: tooltip text
-{
-    BOOL brc;
-    PSYSTRAYCTLDATA pData = AllocSysTrayCtlDataPtr();
-    if (!pData)
-        return FALSE;
-
     pData->ulCommand = SYSTRAYCMD_SETTOOLTIP;
     pData->hwndSender = hwnd;
@@ -412 +521 @@
     }
 
-    brc = SendSysTrayCtlMsg(pData);
+    brc = SendSysTrayCtlMsg(pData) == XST_OK;
 
     FreeSysTrayCtlDataPtr(pData);