Changeset 65 for trunk/src/helpers/cctl_tooltip.c

Timestamp:

Apr 29, 2001, 2:10:31 PM (24 years ago)

Author:

umoeller

Message:

Misc fixes.

File:

• trunk/src/helpers/cctl_tooltip.c (modified) (18 diffs)

trunk/src/helpers/cctl_tooltip.c

@@ -96 +96 @@
 // linked list of all tools which were subclassed for tooltip
 HMTX        G_hmtxSubclassedTools = NULLHANDLE;
-PLINKLIST   G_pllSubclassedTools = NULL;      // linked list of SUBCLASSEDTOOL items
+LINKLIST    G_llSubclassedTools;        // linked list of SUBCLASSEDTOOL items
 
 /* ******************************************************************
@@ -126 +126 @@
 }
 
+/* ******************************************************************
+ *
+ *   Subclassing
+ *
+ ********************************************************************/
+
+/*
+ *@@ LockSubclassedTools:
+ *      locks the global list of subclassed tools.
+ *
+ *@@added V0.9.12 (2001-04-28) [umoeller]
+ */
+
+BOOL LockSubclassedTools(VOID)
+{
+    if (!G_hmtxSubclassedTools)
+    {
+        // first call:
+
+        // initialize the list
+        lstInit(&G_llSubclassedTools,
+                TRUE);      // auto-free
+
+        // create mutex and request it right away
+        return (!DosCreateMutexSem(NULL,
+                                   &G_hmtxSubclassedTools,
+                                   0,
+                                   TRUE));      // request!
+    }
+
+    return (!WinRequestMutexSem(G_hmtxSubclassedTools, SEM_INDEFINITE_WAIT));
+}
+
+/*
+ *@@ UnlockSubclassedTools:
+ *      unlocks the global list of subclassed tools.
+ *
+ *@@added V0.9.12 (2001-04-28) [umoeller]
+ */
+
+VOID UnlockSubclassedTools(VOID)
+{
+}
+
 /*
  *@@ SUBCLASSEDTOOL:
@@ -143 +187 @@
 
 /*
- *@@ ctl_fnwpSubclassedTool:
- *      window procedure for tools which were subclassed
- *      to support tooltips.
- *
- *@@added V0.9.0 [umoeller]
+ *@@ FindSubclassedTool:
+ *      returns the SUBCLASSEDTOOL struct from the
+ *      global list which matches hwndTool or NULL
+ *      if not found.
+ *
+ *      Preconditions: Caller must hold the subclassed
+ *      tools mutex.
+ *
+ *@@added V0.9.12 (2001-04-28) [umoeller]
  */
 
-MRESULT EXPENTRY ctl_fnwpSubclassedTool(HWND hwndTool, ULONG msg, MPARAM mp1, MPARAM mp2)
+PSUBCLASSEDTOOL FindSubclassedTool(HWND hwndTool)
 {
-    MRESULT mrc = 0;
-
-    PSUBCLASSEDTOOL pst = NULL;
-
-    PLISTNODE pNode = lstQueryFirstNode(G_pllSubclassedTools);
+    PLISTNODE pNode = lstQueryFirstNode(&G_llSubclassedTools);
     while (pNode)
     {
@@ -162 +206 @@
         if (pstThis->hwndTool == hwndTool)
         {
-            pst = pstThis;
-            break;
+            return (pstThis);
         }
         pNode = pNode->pNext;
     }
 
-    switch (msg)
+    return (NULL);
+}
+
+/*
+ *@@ ctl_fnwpSubclassedTool:
+ *      window procedure for tools which were subclassed
+ *      to support tooltips.
+ *
+ *@@added V0.9.0 [umoeller]
+ *@@changed V0.9.12 (2001-04-28) [umoeller]: added mutex protection
+ */
+
+MRESULT EXPENTRY ctl_fnwpSubclassedTool(HWND hwndTool, ULONG msg, MPARAM mp1, MPARAM mp2)
+{
+    MRESULT mrc = 0;
+
+    PFNWP           pfnwpOrig = NULL;
+
+    if (LockSubclassedTools())
     {
-        case WM_MOUSEMOVE:
-        case WM_BUTTON1DOWN:
-        case WM_BUTTON1UP:
-        case WM_BUTTON2DOWN:
-        case WM_BUTTON2UP:
-        case WM_BUTTON3DOWN:
-        case WM_BUTTON3UP:
+        PSUBCLASSEDTOOL pst = FindSubclassedTool(hwndTool);
+
+        switch (msg)
         {
-            QMSG qmsg;
-            qmsg.hwnd = hwndTool;
-            qmsg.msg = msg;
-            qmsg.mp1 = mp1;
-            qmsg.mp2 = mp2;
-            // _Pmpf((__FUNCTION__ ": sending TTM_RELAYEVENT"));
-            WinSendMsg(pst->hwndTooltip,
-                       TTM_RELAYEVENT,
-                       (MPARAM)0,
-                       (MPARAM)&qmsg);
-            mrc = (pst->pfnwpOrig)(hwndTool, msg, mp1, mp2);
-        break; }
-
-        case WM_DESTROY:
-            lstRemoveItem(G_pllSubclassedTools, pst);         // this frees the item
-            if (lstCountItems(G_pllSubclassedTools) == 0)
+            case WM_MOUSEMOVE:
+            case WM_BUTTON1DOWN:
+            case WM_BUTTON1UP:
+            case WM_BUTTON2DOWN:
+            case WM_BUTTON2UP:
+            case WM_BUTTON3DOWN:
+            case WM_BUTTON3UP:
             {
-                // last item: destroy list
-                lstFree(G_pllSubclassedTools);
-                G_pllSubclassedTools = NULL;
-                // _Pmpf((__FUNCTION__ ": removed hwnd 0x%lX", hwndTool));
-            }
-            mrc = (pst->pfnwpOrig)(hwndTool, msg, mp1, mp2);
-        break;
-
-        default:
-            mrc = (pst->pfnwpOrig)(hwndTool, msg, mp1, mp2);
+                QMSG qmsg;
+                qmsg.hwnd = hwndTool;
+                qmsg.msg = msg;
+                qmsg.mp1 = mp1;
+                qmsg.mp2 = mp2;
+                // _Pmpf((__FUNCTION__ ": sending TTM_RELAYEVENT"));
+                WinSendMsg(pst->hwndTooltip,
+                           TTM_RELAYEVENT,
+                           (MPARAM)0,
+                           (MPARAM)&qmsg);
+                pfnwpOrig = pst->pfnwpOrig;     // call default
+            break; }
+
+            case WM_DESTROY:
+                lstRemoveItem(&G_llSubclassedTools, pst);         // this frees the item
+                pfnwpOrig = pst->pfnwpOrig;     // call default
+            break;
+
+            default:
+                pfnwpOrig = pst->pfnwpOrig;     // call default
+        }
+
+        UnlockSubclassedTools();
     }
+
+    if (pfnwpOrig)
+        mrc = (pfnwpOrig)(hwndTool, msg, mp1, mp2);
 
     return (mrc);
@@ -211 +275 @@
 
 /*
- *@@ SubclassToolForToolinfo:
+ *@@ SubclassTool:
  *      this gets called from ctl_fnwpTooltip if a control
  *      is to be subclassed to support mouse messaging
  *      (TTF_SUBCLASS flag).
  *
+ *      Preconditions: Caller must hold the subclassed
+ *      tools mutex.
+ *
  *@@added V0.9.0 [umoeller]
+ *@@changed V0.9.12 (2001-04-28) [umoeller]: renamed from SubclassToolForToolInfo
  */
 
-BOOL SubclassToolForToolinfo(HWND hwndTooltip,
-                             HWND hwndTool)
+BOOL SubclassTool(HWND hwndTooltip,
+                  HWND hwndTool)
 {
     BOOL    brc = FALSE;
-    PFNWP   pfnwpOrig = WinSubclassWindow(hwndTool,
-                                          ctl_fnwpSubclassedTool);
-    if (pfnwpOrig)
+
+    // make sure the tool is not on the list yet
+    // V0.9.12 (2001-04-28) [umoeller]
+    if (!FindSubclassedTool(hwndTool))
     {
-        PSUBCLASSEDTOOL pst = (PSUBCLASSEDTOOL)malloc(sizeof(SUBCLASSEDTOOL));
-        if (pst)
+        PFNWP   pfnwpOrig = WinSubclassWindow(hwndTool,
+                                              ctl_fnwpSubclassedTool);
+        if (pfnwpOrig)
         {
-            pst->pfnwpOrig = pfnwpOrig;
-            pst->hwndTooltip = hwndTooltip;
-            pst->hwndTool = hwndTool;
-            pst->hab = WinQueryAnchorBlock(hwndTool);
-
-            if (G_pllSubclassedTools == NULL)
-                G_pllSubclassedTools = lstCreate(TRUE);   // auto-free items
-
-            lstAppendItem(G_pllSubclassedTools, pst);
-            // _Pmpf((__FUNCTION__ ": subclassed hwnd 0x%lX", hwndTool));
+            PSUBCLASSEDTOOL pst = (PSUBCLASSEDTOOL)malloc(sizeof(SUBCLASSEDTOOL));
+            if (pst)
+            {
+                pst->pfnwpOrig = pfnwpOrig;
+                pst->hwndTooltip = hwndTooltip;
+                pst->hwndTool = hwndTool;
+                pst->hab = WinQueryAnchorBlock(hwndTool);
+
+                brc = !!lstAppendItem(&G_llSubclassedTools, pst);
+            }
         }
     }
+
     return (brc);
 }
+
+/*
+ *@@ UnSubclassTool:
+ *      un-subclasses a tool previously subclassed by
+ *      SubclassToolForToolinfo.
+ *
+ *      Preconditions: Caller must hold the subclassed
+ *      tools mutex.
+ *
+ *@@added V0.9.12 (2001-04-28) [umoeller]
+ */
+
+BOOL UnSubclassTool(HWND hwndTool)
+{
+    PSUBCLASSEDTOOL pst = FindSubclassedTool(hwndTool);
+    if (pst)
+    {
+        WinSubclassWindow(hwndTool,
+                          pst->pfnwpOrig);
+                            // orig winproc == un-subclass
+        return (lstRemoveItem(&G_llSubclassedTools, pst));
+                    // this frees the item
+    }
+
+    return (FALSE);
+}
+
+/* ******************************************************************
+ *
+ *   Implementation
+ *
+ ********************************************************************/
 
 /*
@@ -654 +757 @@
  *
  *      To clarify: There is usually one tooltip control, which is hidden
- *      most of the time, for many tools (parts of a visible window).
+ *      most of the time, for many "tools" (parts of a visible window).
  *      When the user puts the cursor on a tool and leaves it there for
  *      approximately one-half second, the tooltip control is set up for
@@ -728 +831 @@
  *
  *@@added V0.9.0 [umoeller]
+ *@@changed V0.9.12 (2001-04-28) [umoeller]: various fixes WRT subclassing
  */
 
@@ -826 +930 @@
                 if (pttd->pszPaintText)
                     free(pttd->pszPaintText);
+
+                // un-subclass all tools that we subclassed
+                // V0.9.12 (2001-04-28) [umoeller]
+                if (LockSubclassedTools())
+                {
+                    PLISTNODE pNode;
+                    PSUBCLASSEDTOOL pst;
+                    for (pNode = lstQueryFirstNode(&pttd->llTools);
+                         pNode;
+                         pNode = pNode->pNext)
+                    {
+                        PTOOLINFO pti = (PTOOLINFO)pNode->pItemData;
+                        if (pst = FindSubclassedTool(pti->hwndTool))
+                            UnSubclassTool(pti->hwndTool);
+                    }
+
+                    UnlockSubclassedTools();
+                }
+                // end V0.9.12 (2001-04-28) [umoeller]
+
                 lstClear(&pttd->llTools);
+
                 free(pttd);
 
@@ -963 +1088 @@
              *      rectangular areas within a window's client area.
              *
-             *      --  When you add a tool implemented as a rectangular area, the
-             *          "hwndToolOwner" member of TOOLINFO must specify the handle
-             *          of the window that contains the area, and the "rect" member must
-             *          specify the client coordinates of the area's bounding
-             *          rectangle.
-             *
-             *      --  When you add a tool implemented as a window, the "hwndTool"
-             *          member of TOOLINFO must contain the window handle of the
-             *          tool. hwndToolOwner should be the owner of the tool.
+             *      --  When you add a tool implemented as a rectangular
+             *          area, the "hwndToolOwner" member of TOOLINFO must
+             *          specify the handle of the window that contains the
+             *          area, and the "rect" member must specify the client
+             *          coordinates of the area's bounding rectangle.
+             *
+             *      --  When you add a tool implemented as a window, the
+             *          "hwndTool" member of TOOLINFO must contain the
+             *          window handle of the tool. hwndToolOwner should be
+             *          the owner of the tool.
              *
              *      When you add a tool to a tooltip control, the "pszText"
@@ -1004 +1130 @@
                                       ptiNew);
 
-                        if (ptiPassed->ulFlags & TTF_SUBCLASS)
-                            SubclassToolForToolinfo(hwndTooltip,
-                                                    ptiPassed->hwndTool);
+                        if (    (ptiPassed->ulFlags & TTF_SUBCLASS)
+                             && (LockSubclassedTools()) // V0.9.12 (2001-04-28) [umoeller]
+                           )
+                        {
+                            // caller wants this tool to be subclassed:
+                            // well, do it then
+                            SubclassTool(hwndTooltip,
+                                         ptiPassed->hwndTool);
+
+                            UnlockSubclassedTools();
+                        }
 
                         mrc = (MPARAM)TRUE;
@@ -1040 +1174 @@
                         {
                             // found:
+
+                            // V0.9.12 (2001-04-28) [umoeller]
+                            // unsubclass if this was subclassed
+                            if (ptiThis->ulFlags & TTF_SUBCLASS)
+                            {
+                                if (LockSubclassedTools())
+                                {
+                                    UnSubclassTool(ptiSearch->hwndTool);
+                                }
+                            }
+
+                            // remove the tool from the list
                             lstRemoveNode(&pttd->llTools, pToolNode);
+
                             break;
                         }
@@ -1072 +1219 @@
 
             case TTM_NEWTOOLRECT:
+
             break;
 
@@ -1209 +1357 @@
 
             /*
+             *@@ TTM_GETDELAYTIME:
+             *      returns the current value of the specified
+             *      timeout value. See TTM_SETDELAYTIME.
+             *
+             *      Parameters:
+             *
+             *      -- USHORT mp1: timer value to query. One of:
+             *              -- TTDT_AUTOPOP
+             *              -- TTDT_INITIAL
+             *              -- TTDT_RESHOW
+             *
+             *      Returns: ULONG timeout value.
+             *
+             *@@added V0.9.12 (2001-04-28) [umoeller]
+             */
+
+            case TTM_GETDELAYTIME:
+                switch ((USHORT)mp1)
+                {
+                    case TTDT_AUTOPOP:
+                        mrc = (MRESULT)pttd->ulTimeoutAutopop;
+                    break;
+
+                    case TTDT_INITIAL:
+                        mrc = (MRESULT)pttd->ulTimeoutInitial;
+                    break;
+
+                    case TTDT_RESHOW:
+                        mrc = (MRESULT)pttd->ulTimeoutReshow;
+                    break;
+                }
+            break;
+
+            /*
              *@@ TTM_SETDELAYTIME:
              *      overrides a few default timeout values for the
@@ -1232 +1414 @@
              *      -- USHORT mp1: parameter selection. One of the following:
              *              -- TTDT_AUTOMATIC: automatically calculates the initial,
-             *                 reshow, and autopopup durations based on the value of iDelay.
+             *                 reshow, and autopopup durations based on the value of mp2.
              *              -- TTDT_AUTOPOP: sets the length of time before the tooltip
              *                  window is hidden if the cursor remains stationary
@@ -1279 +1461 @@
              *      Parameters:
              *      -- mp1: always 0
-             *      -- PTOOLINFO mp2: pointer to a TOOLINFO structure. When sending the
-             *          message, the hwnd and uId members identify a tool. If the tooltip
-             *          control includes the tool, the lpszText member receives the pointer
-             *          to the string.
+             *      -- PTOOLINFO mp2: pointer to a TOOLINFO structure.
+             *         When sending the message, the hwnd and uId members
+             *         identify a tool. If the tooltip control includes
+             *         the tool, the lpszText member receives the pointer
+             *         to the string.
              *
              *      Return value: 0 always.
@@ -1289 +1472 @@
              *      this sends the TTN_NEEDTEXT notification to TOOLINFO.hwnd.
              *
-             *@@todo add TTFMT_STRINGRES
              */
 
@@ -1322 +1504 @@
 
                         case TTFMT_STRINGRES:
-
+                                // @@todo
                         break;
                     }
@@ -1334 +1516 @@
              *      Parameters:
              *      -- mp1: always 0.
-             *      -- PTOOLINFO mp2: pointer to a TOOLINFO structure. The "hinst"
-             *          and "lpszText" members must specify the instance handle and
-             *          the pointer to the text.
-             *          The "hwnd" and "uId" members identify the tool to update.
+             *      -- PTOOLINFO mp2: pointer to a TOOLINFO structure.
+             *         The "hinst" and "lpszText" members must specify
+             *         the instance handle and the pointer to the text.
+             *         The "hwnd" and "uId" members identify the tool
+             *         to update.
              */