]> Dogcows Code - chaz/yoink/blobdiff - src/Moof/Timer.cc
sockets documentation and cleanup
[chaz/yoink] / src / Moof / Timer.cc
index d17882a9b3e5b13645e75d91650febedb074293f..3e42818962d5df7e124f7edc96ed4384ca3dc171 100644 (file)
@@ -1,35 +1,19 @@
 
-/*******************************************************************************
-
- Copyright (c) 2009, Charles McGarvey
- All rights reserved.
- Redistribution   and   use  in  source  and  binary  forms,  with  or  without
- modification, are permitted provided that the following conditions are met:
-   * Redistributions  of  source  code  must retain the above copyright notice,
-     this list of conditions and the following disclaimer.
-   * Redistributions  in binary form must reproduce the above copyright notice,
-     this  list of conditions and the following disclaimer in the documentation
-     and/or other materials provided with the distribution.
- THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-*******************************************************************************/
+/*]  Copyright (c) 2009-2010, Charles McGarvey  [**************************
+**]  All rights reserved.
+*
+* vi:ts=4 sw=4 tw=75
+*
+* Distributable under the terms and conditions of the 2-clause BSD license;
+* see the file COPYING for a complete text of the license.
+*
+**************************************************************************/
 
 #include <cerrno>
 #include <ctime>
 #include <limits>
-#include <stdexcept>
+
+#include <SDL/SDL.h>
 
 #include "Log.hh"
 #include "Timer.hh"
 #include "config.h"
 #endif
 
-#include <SDL/SDL.h>
-
 
 namespace Mf {
 
 
-Scalar Timer::nextFire_ = std::numeric_limits<Scalar>::max();
-std::map<unsigned,Timer&> Timer::timers_;
+Scalar Timer::gNextFire = std::numeric_limits<Scalar>::max();
+std::map<unsigned,Timer*> Timer::gTimers;
 
 
 unsigned Timer::getNewID()
@@ -65,7 +47,7 @@ void Timer::init(const Function& function, Scalar seconds, Mode mode)
        {
                mFunction = function;
 
-               if (mode == ABSOLUTEE)
+               if (mode == ACTUAL)
                {
                        mAbsolute = seconds;
                }
@@ -76,9 +58,9 @@ void Timer::init(const Function& function, Scalar seconds, Mode mode)
                }
 
                mId = getNewID();
-               timers_.insert(std::pair<unsigned,Timer&>(mId, *this));
+               gTimers.insert(std::pair<unsigned,Timer*>(mId, this));
 
-               if (mAbsolute < nextFire_) nextFire_ = mAbsolute;
+               if (mAbsolute < gNextFire) gNextFire = mAbsolute;
        }
 }
 
@@ -92,10 +74,10 @@ void Timer::invalidate()
 {
        if (mMode != INVALID)
        {
-               timers_.erase(mId);
+               gTimers.erase(mId);
                mMode = INVALID;
 
-               if (isEqual(mAbsolute, nextFire_)) nextFire_ = findNextFire();
+               if (isEqual(mAbsolute, gNextFire)) gNextFire = findNextFire();
        }
 }
 
@@ -113,7 +95,7 @@ void Timer::fire()
                if (isEqual(mAbsolute, t, 1.0)) mAbsolute += mInterval;
                else mAbsolute = mInterval + t;
 
-               if (isEqual(absolute, nextFire_)) nextFire_ = findNextFire();
+               if (isEqual(absolute, gNextFire)) gNextFire = findNextFire();
        }
        else
        {
@@ -124,12 +106,12 @@ void Timer::fire()
 
 Scalar Timer::findNextFire()
 {
-       std::map<unsigned,Timer&>::iterator it;
+       std::map<unsigned,Timer*>::iterator it;
        Scalar nextFire = std::numeric_limits<Scalar>::max();
 
-       for (it = timers_.begin(); it != timers_.end(); ++it)
+       for (it = gTimers.begin(); it != gTimers.end(); ++it)
        {
-               Scalar absolute = (*it).second.mAbsolute;
+               Scalar absolute = (*it).second->mAbsolute;
                if (absolute < nextFire) nextFire = absolute;
        }
 
@@ -153,28 +135,33 @@ bool Timer::isRepeating() const
 }
 
 
+void Timer::fireIfExpired()
+{
+       fireIfExpired(getTicks());
+}
+
 void Timer::fireIfExpired(Scalar t)
 {
-       std::map<unsigned,Timer&>::iterator it;
+       std::map<unsigned,Timer*>::iterator it;
 
-       if (nextFire_ > t) return;
+       if (gNextFire > t) return;
 
-       for (it = timers_.begin(); it != timers_.end(); ++it)
+       for (it = gTimers.begin(); it != gTimers.end(); ++it)
        {
-               Timer& timer = (*it).second;
-               if (timer.isExpired()) timer.fire();
+               Timer* timer = (*it).second;
+               if (timer->isExpired()) timer->fire();
        }
 }
 
 
 #if HAVE_CLOCK_GETTIME
 
-// Since the monotonic clock will provide us with the timer since the computer
-// started, the number of seconds since that time could easily become so large
-// that it cannot be accurately stored in a float (even with as little two days
-// uptime), therefore we need to start from a more recent reference (when the
-// program starts).  Of course this isn't much of an issue if scalar is a
-// double-precision number.
+// Since the monotonic clock will provide us with the time since the
+// computer started, the number of seconds since that time could easily
+// become so large that it cannot be accurately stored in a float (even
+// with as little two days uptime), therefore we need to start from a more
+// recent reference (when the program starts).  Of course this isn't much
+// of an issue if scalar is a double-precision number.
 
 static time_t setReference_()
 {
@@ -195,20 +182,19 @@ Scalar Timer::getTicks()
 {
        struct timespec ts;
 
-       if (clock_gettime(CLOCK_MONOTONIC, &ts) != 0)
-       {
-               throw std::runtime_error("cannot access monotonic clock");
-       }
+       int result = clock_gettime(CLOCK_MONOTONIC, &ts);
+       ASSERT(result == 0 && "cannot access clock");
 
-       return Scalar(ts.tv_sec - reference) + Scalar(ts.tv_nsec) / 1000000000.0;
+       return Scalar(ts.tv_sec - reference) +
+                  Scalar(ts.tv_nsec) / 1000000000.0;
 }
 
-void Timer::sleep(Scalar seconds, bool absolute)
+void Timer::sleep(Scalar seconds, Mode mode)
 {
        struct timespec ts;
        int ret;
 
-       if (absolute) seconds -= getTicks();
+       if (mode == ACTUAL) seconds -= getTicks();
        ts.tv_sec = time_t(seconds);
        ts.tv_nsec = long((seconds - Scalar(ts.tv_sec)) * 1000000000.0);
 
@@ -223,9 +209,9 @@ void Timer::sleep(Scalar seconds, bool absolute)
 #else // ! HAVE_CLOCK_GETTIME
 
 
-// If we don't have posix timers, we'll have to use a different timing method.
-// SDL only promises centisecond accuracy, but that's better than a kick in the
-// butt.
+// If we don't have posix timers, we'll have to use a different timing
+// method.  SDL only promises centisecond accuracy, but that's better than
+// a kick in the pants.
 
 Scalar Timer::getTicks()
 {
@@ -233,9 +219,9 @@ Scalar Timer::getTicks()
        return Scalar(ms / 1000) + Scalar(ms % 1000) / 1000.0;
 }
 
-void Timer::sleep(Scalar seconds, bool absolute)
+void Timer::sleep(Scalar seconds, Mode mode)
 {
-       if (absolute) seconds -= getTicks();
+       if (mode == ACTUAL) seconds -= getTicks();
        SDL_Delay(Uint32(cml::clamp(int(seconds * 1000.0), 0, 1000)));
 }
 
@@ -244,5 +230,3 @@ void Timer::sleep(Scalar seconds, bool absolute)
 
 } // namespace Mf
 
-/** vim: set ts=4 sw=4 tw=80: *************************************************/
-
This page took 0.023128 seconds and 4 git commands to generate.