Changeset 74 for trunk/src/helpers/timer.c

Timestamp:

May 24, 2001, 5:21:06 PM (24 years ago)

Author:

umoeller

Message:

Misc updates

File:

• trunk/src/helpers/timer.c (modified) (7 diffs)

trunk/src/helpers/timer.c

@@ -233 +233 @@
 }
 
-/* ******************************************************************
- *
- *   Exported functions
- *
- ********************************************************************/
-
-/*
- *@@ tmrCreateSet:
- *      creates a "timer set" for use with the XTimer functions.
- *      This is the first step if you want to use the XTimers.
- *
- *      hwndOwner must specify the "owner window", the target
- *      window for the master PM timer. This window must respond
- *      to a WM_TIMER message with the specified usPMTimerID and
- *      invoke tmrTimerTick then.
- *
- *      Note that the master timer is not started until an XTimer
- *      is started.
- *
- *      Use tmrDestroySet to free all resources again.
- *
- *@@added V0.9.9 (2001-02-28) [umoeller]
- */
-
-PXTIMERSET tmrCreateSet(HWND hwndOwner,         // in: owner window
-                        USHORT usPMTimerID)
-{
-    PXTIMERSET pSet = NULL;
-
-    pSet = (PXTIMERSET)malloc(sizeof(*pSet));
-    if (pSet)
-    {
-        pSet->hab = WinQueryAnchorBlock(hwndOwner);
-        pSet->hwndOwner = hwndOwner;
-        pSet->idPMTimer = usPMTimerID;
-        pSet->idPMTimerRunning = 0;
-        pSet->ulPMTimeout = 0;
-
-        pSet->pvllXTimers = (PVOID)lstCreate(TRUE);
-    }
-
-    return (pSet);
-}
-
-/*
- *@@ tmrDestroySet:
- *      destroys a timer set previously created using
- *      tmrCreateSet.
- *
- *      Of course, this will stop all XTimers which
- *      might still be running with this set.
- *
- *@@added V0.9.9 (2001-02-28) [umoeller]
- *@@changed V0.9.12 (2001-05-12) [umoeller]: added mutex protection
- */
-
-VOID tmrDestroySet(PXTIMERSET pSet)     // in: timer set (from tmrCreateSet)
-{
-    if (pSet)
-    {
-        if (pSet->pvllXTimers)
-        {
-            if (LockTimers())
-            {
-                PLINKLIST pllXTimers = (PLINKLIST)pSet->pvllXTimers;
-
-                PLISTNODE pTimerNode;
-
-                while (pTimerNode = lstQueryFirstNode(pllXTimers))
-                {
-                    PXTIMER pTimer = (PXTIMER)pTimerNode->pItemData;
-                    RemoveTimer(pSet, pTimer);
-                }
-
-                lstFree(pllXTimers);
-
-                UnlockTimers();
-            }
-        }
-
-        if (pSet->idPMTimerRunning)
-            WinStopTimer(pSet->hab,
-                         pSet->hwndOwner,
-                         pSet->idPMTimer);
-
-        free(pSet);
-    }
-}
-
 /*
  *@@ AdjustPMTimer:
@@ -378 +289 @@
 }
 
+/* ******************************************************************
+ *
+ *   Exported functions
+ *
+ ********************************************************************/
+
+/*
+ *@@ tmrCreateSet:
+ *      creates a "timer set" for use with the XTimer functions.
+ *      This is the first step if you want to use the XTimers.
+ *
+ *      hwndOwner must specify the "owner window", the target
+ *      window for the master PM timer. This window must respond
+ *      to a WM_TIMER message with the specified usPMTimerID and
+ *      invoke tmrTimerTick then.
+ *
+ *      Note that the master timer is not started until an XTimer
+ *      is started.
+ *
+ *      Use tmrDestroySet to free all resources again.
+ *
+ *@@added V0.9.9 (2001-02-28) [umoeller]
+ */
+
+PXTIMERSET tmrCreateSet(HWND hwndOwner,         // in: owner window
+                        USHORT usPMTimerID)
+{
+    PXTIMERSET pSet = NULL;
+
+    pSet = (PXTIMERSET)malloc(sizeof(*pSet));
+    if (pSet)
+    {
+        pSet->hab = WinQueryAnchorBlock(hwndOwner);
+        pSet->hwndOwner = hwndOwner;
+        pSet->idPMTimer = usPMTimerID;
+        pSet->idPMTimerRunning = 0;
+        pSet->ulPMTimeout = 0;
+
+        pSet->pvllXTimers = (PVOID)lstCreate(TRUE);
+    }
+
+    return (pSet);
+}
+
+/*
+ *@@ tmrDestroySet:
+ *      destroys a timer set previously created using
+ *      tmrCreateSet.
+ *
+ *      Of course, this will stop all XTimers which
+ *      might still be running with this set.
+ *
+ *@@added V0.9.9 (2001-02-28) [umoeller]
+ *@@changed V0.9.12 (2001-05-12) [umoeller]: added mutex protection
+ */
+
+VOID tmrDestroySet(PXTIMERSET pSet)     // in: timer set (from tmrCreateSet)
+{
+    if (LockTimers())
+    {
+        if (pSet)
+        {
+            PLINKLIST pllXTimers = (PLINKLIST)pSet->pvllXTimers;
+            if (pllXTimers)
+            {
+                PLISTNODE pTimerNode = lstQueryFirstNode(pllXTimers);
+                while (pTimerNode)
+                {
+                    PLISTNODE pNext = pTimerNode->pNext;
+                    PXTIMER pTimer = (PXTIMER)pTimerNode->pItemData;
+                    RemoveTimer(pSet, pTimer);
+                    pTimerNode = pNext;
+                }
+
+                lstFree(&pllXTimers);
+                pSet->pvllXTimers = NULL;
+            }
+        }
+
+        if (pSet->idPMTimerRunning)
+        {
+            WinStopTimer(pSet->hab,
+                         pSet->hwndOwner,
+                         pSet->idPMTimer);
+            pSet->idPMTimerRunning = 0;
+        }
+
+        free(pSet);
+
+        UnlockTimers();
+    }
+}
+
 /*
  *@@ tmrTimerTick:
@@ -391 +395 @@
  *@@added V0.9.9 (2001-02-28) [umoeller]
  *@@changed V0.9.12 (2001-05-12) [umoeller]: added mutex protection
+ *@@changed V0.9.12 (2001-05-24) [umoeller]: fixed crash if timer was deleted during winproc's WM_TIMER processing
  */
 
 VOID tmrTimerTick(PXTIMERSET pSet)      // in: timer set (from tmrCreateSet)
 {
-    if (pSet && pSet->pvllXTimers)
-    {
-        if (LockTimers())
+    if (LockTimers())
+    {
+        if (pSet)
         {
             PLINKLIST pllXTimers = (PLINKLIST)pSet->pvllXTimers;
-            // go thru all XTimers and see which one
-            // has elapsed; for all of these, post WM_TIMER
-            // to the target window proc
-            PLISTNODE pTimerNode = lstQueryFirstNode(pllXTimers);
-
-            if (!pTimerNode)
+            if (pllXTimers)
             {
-                // no timers left:
-                if (pSet->idPMTimerRunning)
+                // go thru all XTimers and see which one
+                // has elapsed; for all of these, post WM_TIMER
+                // to the target window proc
+                PLISTNODE pTimerNode = lstQueryFirstNode(pllXTimers);
+
+                if (!pTimerNode)
                 {
-                    // but PM timer running:
-                    // stop it
-                    WinStopTimer(pSet->hab,
-                                 pSet->hwndOwner,
-                                 pSet->idPMTimer);
-                    pSet->idPMTimerRunning = 0;
+                    // no timers left:
+                    if (pSet->idPMTimerRunning)
+                    {
+                        // but PM timer running:
+                        // stop it
+                        WinStopTimer(pSet->hab,
+                                     pSet->hwndOwner,
+                                     pSet->idPMTimer);
+                        pSet->idPMTimerRunning = 0;
+                    }
+
+                    pSet->ulPMTimeout = 0;
                 }
-
-                pSet->ulPMTimeout = 0;
-            }
-            else
-            {
-                // we have timers:
-                BOOL    fFoundInvalid = FALSE;
-
-                ULONG   // ulInterval = 100,
-                        ulTimeNow = 0;
-
-                // linked list of timers found to be invalid;
-                // this holds LISTNODE pointers from the global
-                // list to be removed
-                LINKLIST    llInvalidTimers;
-                lstInit(&llInvalidTimers,
-                        FALSE);     // no auto-free
-
-                // get current time
-                DosQuerySysInfo(QSV_MS_COUNT, QSV_MS_COUNT,
-                                &ulTimeNow, sizeof(ulTimeNow));
-
-                while (pTimerNode)
+                else
                 {
-                    PXTIMER pTimer = (PXTIMER)pTimerNode->pItemData;
-
-                    if (    (pTimer)
-                         && (pTimer->ulNextFire < ulTimeNow)
-                       )
+                    // we have timers:
+                    BOOL    fFoundInvalid = FALSE;
+
+                    // get current time
+                    ULONG   ulTimeNow = 0;
+                    DosQuerySysInfo(QSV_MS_COUNT, QSV_MS_COUNT,
+                                    &ulTimeNow, sizeof(ulTimeNow));
+
+                    while (pTimerNode)
                     {
-                        // this timer has elapsed:
-                        // fire!
-                        if (WinIsWindow(pSet->hab,
-                                        pTimer->hwndTarget))
+                        // get next node first because the
+                        // list can get modified while processing
+                        // V0.9.12 (2001-05-24) [umoeller]
+                        PLISTNODE pNext = pTimerNode->pNext;
+
+                        PXTIMER pTimer = (PXTIMER)pTimerNode->pItemData;
+
+                        if (    (pTimer)
+                             && (pTimer->ulNextFire < ulTimeNow)
+                           )
                         {
-                            // window still valid:
-                            // get the window's window proc
-                            PFNWP pfnwp = (PFNWP)WinQueryWindowPtr(pTimer->hwndTarget,
-                                                                   QWP_PFNWP);
-                            // call the window proc DIRECTLY
-                            pfnwp(pTimer->hwndTarget,
-                                  WM_TIMER,
-                                  (MPARAM)pTimer->usTimerID,
-                                  0);
-                            pTimer->ulNextFire = ulTimeNow + pTimer->ulTimeout;
-                        }
-                        else
-                        {
-                            // window has been destroyed:
-                            lstAppendItem(&llInvalidTimers,
-                                          (PVOID)pTimerNode);
-                            fFoundInvalid = TRUE;
-                        }
-                    } // end if (pTimer->ulNextFire < ulTimeNow)
-
-                    // next timer
-                    pTimerNode = pTimerNode->pNext;
-                } // end while (pTimerNode)
-
-                // destroy invalid timers, if any
-                if (fFoundInvalid)
-                {
-                    PLISTNODE pNodeNode = lstQueryFirstNode(&llInvalidTimers);
-                    while (pNodeNode)
-                    {
-                        PLISTNODE pNode2Remove = (PLISTNODE)pNodeNode->pItemData;
-                        lstRemoveNode(pllXTimers,
-                                      pNode2Remove);
-                        pNodeNode = pNodeNode->pNext;
-                    }
-                    lstClear(&llInvalidTimers);
-
-                    AdjustPMTimer(pSet);
-                }
-            } // end else if (!pTimerNode)
-
-            UnlockTimers();
-        } // end if (LockTimers())
-    } // end if (pSet && pSet->pvllXTimers)
+                            // this timer has elapsed:
+                            // fire!
+                            if (WinIsWindow(pSet->hab,
+                                            pTimer->hwndTarget))
+                            {
+                                // window still valid:
+                                // get the window's window proc
+                                PFNWP pfnwp = (PFNWP)WinQueryWindowPtr(pTimer->hwndTarget,
+                                                                       QWP_PFNWP);
+                                // call the window proc DIRECTLY
+                                pfnwp(pTimer->hwndTarget,
+                                      WM_TIMER,
+                                      (MPARAM)pTimer->usTimerID,
+                                      0);
+                                    // V0.9.12 (2001-05-24) [umoeller]
+                                    // if the winproc chooses to start or
+                                    // stop a timer, pNext still points
+                                    // to a valid node...
+                                    // -- if a timer is removed, that's OK
+                                    // -- if a timer is added, it is added to
+                                    //    the list, so we'll see it in this loop
+
+                                pTimer->ulNextFire = ulTimeNow + pTimer->ulTimeout;
+                            }
+                            else
+                            {
+                                // window has been destroyed:
+                                lstRemoveNode(pllXTimers,
+                                              pTimerNode);
+                                    // pNext is still valid
+
+                                fFoundInvalid = TRUE;
+                            }
+
+                        } // end if (pTimer->ulNextFire < ulTimeNow)
+
+                        // next timer
+                        pTimerNode = pNext; // V0.9.12 (2001-05-24) [umoeller]
+                    } // end while (pTimerNode)
+
+                    // destroy invalid timers, if any
+                    if (fFoundInvalid)
+                        AdjustPMTimer(pSet);
+
+                } // end else if (!pTimerNode)
+            } // end if (pllXTimers)
+        } // end if (pSet)
+
+        UnlockTimers();
+    } // end if (LockTimers())
 }
 
@@ -527 +531 @@
     // _Pmpf((__FUNCTION__ ": entering"));
 
-    if (pSet && pSet->pvllXTimers)
-    {
-        if (LockTimers())
+    if (LockTimers())
+    {
+        if (pSet)
         {
             PLINKLIST pllXTimers = (PLINKLIST)pSet->pvllXTimers;
 
-            if ((hwnd) && (ulTimeout))
+            if ((pllXTimers) && (hwnd) && (ulTimeout))
             {
                 PXTIMER pTimer;
@@ -571 +575 @@
 
                 if (usrc)
-                {
                     // timer created or reset:
                     AdjustPMTimer(pSet);
-                }
+
             } // if ((hwnd) && (ulTimeout))
-
-            UnlockTimers();
         }
+
+        UnlockTimers();
     }
 
@@ -601 +604 @@
 {
     BOOL brc = FALSE;
-    if (pSet && pSet->pvllXTimers)
-    {
-        if (LockTimers())
+    if (LockTimers())
+    {
+        if (pSet && pSet->pvllXTimers)
         {
             PLINKLIST pllXTimers = (PLINKLIST)pSet->pvllXTimers;
@@ -618 +621 @@
                 brc = TRUE;
             }
-
-            UnlockTimers();
         }
+
+        UnlockTimers();
     }