src/common/timercmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        common/timercmn.cpp
   3 // Purpose:     Common timer implementation
   4 // Author:
   5 //    Original version by Julian Smart
   6 //    Vadim Zeitlin got rid of all ifdefs (11.12.99)
   7 //    Sylvain Bougnoux added wxStopWatch class
   8 //    Guillermo Rodriguez <guille@iies.es> rewrote from scratch (Dic/99)
   9 // Modified by:
  10 // Created:     04/01/98
  11 // RCS-ID:      $Id$
  12 // Copyright:   (c) Julian Smart and Markus Holzem
  13 //              (c) 1999 Guillermo Rodriguez <guille@iies.es>
  14 // Licence:     wxWindows license
  15 /////////////////////////////////////////////////////////////////////////////
  16
  17 // ============================================================================
  18 // declarations
  19 // ============================================================================
  20
  21 // ----------------------------------------------------------------------------
  22 // wxWin headers
  23 // ----------------------------------------------------------------------------
  24
  25 #ifdef __GNUG__
  26     #pragma implementation "timerbase.h"
  27 #endif
  28
  29 // For compilers that support precompilation, includes "wx.h".
  30 #include "wx/wxprec.h"
  31
  32 #ifdef __BORLANDC__
  33     #pragma hdrstop
  34 #endif
  35
  36 #ifndef WX_PRECOMP
  37     #include "wx/intl.h"
  38     #include "wx/log.h"
  39 #endif
  40
  41 #include "wx/timer.h"
  42 #include "wx/longlong.h"
  43
  44 // ----------------------------------------------------------------------------
  45 // System headers
  46 // ----------------------------------------------------------------------------
  47
  48 #if defined(__WIN32__)
  49     #include <windows.h>
  50 #endif
  51
  52 #if defined(__WIN32__) && !defined(HAVE_FTIME)
  53     #define HAVE_FTIME
  54 #endif
  55
  56 #if defined(__VISAGECPP__) && !defined(HAVE_FTIME)
  57     #define HAVE_FTIME
  58 #  if __IBMCPP__ >= 400
  59     #  define ftime(x) _ftime(x)
  60 #  endif
  61 #endif
  62
  63 #if defined(__MWERKS__) && defined(__WXMSW__)
  64 #   undef HAVE_FTIME
  65 #   undef HAVE_GETTIMEOFDAY
  66 #endif
  67
  68 #include <time.h>
  69 #ifndef __WXMAC__
  70     #include <sys/types.h>      // for time_t
  71 #endif
  72
  73 #if defined(HAVE_GETTIMEOFDAY)
  74     #include <sys/time.h>
  75     #include <unistd.h>
  76 #elif defined(HAVE_FTIME)
  77     #include <sys/timeb.h>
  78 #endif
  79
  80 // ----------------------------------------------------------------------------
  81 // wxWin macros
  82 // ----------------------------------------------------------------------------
  83
  84 #if wxUSE_GUI && wxUSE_TIMER
  85     IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent)
  86 #endif // wxUSE_GUI
  87
  88 // ----------------------------------------------------------------------------
  89 // macros
  90 // ----------------------------------------------------------------------------
  91
  92 // on some really old systems gettimeofday() doesn't have the second argument,
  93 // define wxGetTimeOfDay() to hide this difference
  94 #ifdef HAVE_GETTIMEOFDAY
  95     #ifdef WX_GETTIMEOFDAY_NO_TZ
  96         struct timezone;
  97         #define wxGetTimeOfDay(tv, tz)      gettimeofday(tv)
  98     #else
  99         #define wxGetTimeOfDay(tv, tz)      gettimeofday((tv), (tz))
 100     #endif
 101 #endif // HAVE_GETTIMEOFDAY
 102
 103 // ============================================================================
 104 // implementation
 105 // ============================================================================
 106
 107 // ----------------------------------------------------------------------------
 108 // wxTimerBase
 109 // ----------------------------------------------------------------------------
 110
 111 #if wxUSE_GUI && wxUSE_TIMER
 112
 113 void wxTimerBase::Notify()
 114 {
 115     // the base class version generates an event if it has owner - which it
 116     // should because otherwise nobody can process timer events
 117     wxCHECK_RET( m_owner, _T("wxTimer::Notify() should be overridden.") );
 118
 119     wxTimerEvent event(m_idTimer, m_milli);
 120     (void)m_owner->ProcessEvent(event);
 121 }
 122
 123 bool wxTimerBase::Start(int milliseconds, bool oneShot)
 124 {
 125     if ( IsRunning() )
 126     {
 127         // not stopping the already running timer might work for some
 128         // platforms (no problems under MSW) but leads to mysterious crashes
 129         // on the others (GTK), so to be on the safe side do it here
 130         Stop();
 131     }
 132
 133     if ( milliseconds != -1 )
 134     {
 135         m_milli = milliseconds;
 136     }
 137
 138     m_oneShot = oneShot;
 139
 140     return TRUE;
 141 }
 142
 143 #endif // wxUSE_GUI
 144
 145 // ----------------------------------------------------------------------------
 146 // wxStopWatch
 147 // ----------------------------------------------------------------------------
 148
 149 #if wxUSE_LONGLONG
 150
 151 void wxStopWatch::Start(long t)
 152 {
 153     m_t0 = wxGetLocalTimeMillis() - t;
 154     m_pause = 0;
 155 }
 156
 157 long wxStopWatch::GetElapsedTime() const
 158 {
 159   return (wxGetLocalTimeMillis() - m_t0).GetLo();
 160 }
 161
 162 long wxStopWatch::Time() const
 163 {
 164     return (m_pause ? m_pause : GetElapsedTime());
 165 }
 166
 167 #endif // wxUSE_LONGLONG
 168
 169 // ----------------------------------------------------------------------------
 170 // old timer functions superceded by wxStopWatch
 171 // ----------------------------------------------------------------------------
 172
 173 #if wxUSE_LONGLONG
 174
 175 static wxLongLong wxStartTime = 0l;
 176
 177 // starts the global timer
 178 void wxStartTimer()
 179 {
 180     wxStartTime = wxGetLocalTimeMillis();
 181 }
 182
 183 // Returns elapsed time in milliseconds
 184 long wxGetElapsedTime(bool resetTimer)
 185 {
 186     wxLongLong oldTime = wxStartTime;
 187     wxLongLong newTime = wxGetLocalTimeMillis();
 188
 189     if ( resetTimer )
 190         wxStartTime = newTime;
 191
 192     return (newTime - oldTime).GetLo();
 193 }
 194
 195 #endif // wxUSE_LONGLONG
 196
 197 // ----------------------------------------------------------------------------
 198 // the functions to get the current time and timezone info
 199 // ----------------------------------------------------------------------------
 200
 201 // Get local time as seconds since 00:00:00, Jan 1st 1970
 202 long wxGetLocalTime()
 203 {
 204     struct tm tm;
 205     time_t t0, t1;
 206
 207     // This cannot be made static because mktime can overwrite it.
 208     //
 209     memset(&tm, 0, sizeof(tm));
 210     tm.tm_year  = 70;
 211     tm.tm_mon   = 0;
 212     tm.tm_mday  = 5;        // not Jan 1st 1970 due to mktime 'feature'
 213     tm.tm_hour  = 0;
 214     tm.tm_min   = 0;
 215     tm.tm_sec   = 0;
 216     tm.tm_isdst = -1;       // let mktime guess
 217
 218     // Note that mktime assumes that the struct tm contains local time.
 219     //
 220     t1 = time(&t1);         // now
 221     t0 = mktime(&tm);       // origin
 222
 223     // Return the difference in seconds.
 224     //
 225     if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 ))
 226         return (long)difftime(t1, t0) + (60 * 60 * 24 * 4);
 227
 228     wxLogSysError(_("Failed to get the local system time"));
 229     return -1;
 230 }
 231
 232 // Get UTC time as seconds since 00:00:00, Jan 1st 1970
 233 long wxGetUTCTime()
 234 {
 235     struct tm tm;
 236     struct tm *ptm;
 237     time_t t0, t1;
 238
 239     // This cannot be made static because mktime can overwrite it
 240     //
 241     memset(&tm, 0, sizeof(tm));
 242     tm.tm_year  = 70;
 243     tm.tm_mon   = 0;
 244     tm.tm_mday  = 5;        // not Jan 1st 1970 due to mktime 'feature'
 245     tm.tm_hour  = 0;
 246     tm.tm_min   = 0;
 247     tm.tm_sec   = 0;
 248     tm.tm_isdst = -1;       // let mktime guess
 249
 250     // Note that mktime assumes that the struct tm contains local time.
 251     //
 252     t1 = time(&t1);         // now
 253     t0 = mktime(&tm);       // origin in localtime
 254
 255     if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 ))
 256     {
 257         // To get t0 as GMT we convert to a struct tm with gmtime,
 258         // and then back again.
 259         //
 260         ptm = gmtime(&t0);
 261
 262         if (ptm)
 263         {
 264             memcpy(&tm, ptm, sizeof(tm));
 265             t0 = mktime(&tm);
 266
 267             if (t0 != (time_t)-1 )
 268                 return (long)difftime(t1, t0) + (60 * 60 * 24 * 4);
 269             wxLogSysError(_("mktime() failed"));
 270         }
 271         else
 272         {
 273             wxLogSysError(_("gmtime() failed"));
 274         }
 275     }
 276
 277     wxLogError(_("Failed to get the UTC system time."));
 278
 279     return -1;
 280 }
 281
 282 #if wxUSE_LONGLONG
 283
 284 // Get local time as milliseconds since 00:00:00, Jan 1st 1970
 285 wxLongLong wxGetLocalTimeMillis()
 286 {
 287     wxLongLong val = 1000l;
 288
 289     // If possible, use a function which avoids conversions from
 290     // broken-up time structures to milliseconds
 291
 292 #if defined(HAVE_GETTIMEOFDAY)
 293     struct timeval tp;
 294     if ( wxGetTimeOfDay(&tp, (struct timezone *)NULL) != -1 )
 295     {
 296         val *= tp.tv_sec;
 297         return (val + (tp.tv_usec / 1000));
 298     }
 299     else
 300     {
 301         wxLogError(_("wxGetTimeOfDay failed."));
 302         return 0;
 303     }
 304 #elif defined(HAVE_FTIME)
 305     struct timeb tp;
 306
 307     // ftime() is void and not int in some mingw32 headers, so don't
 308     // test the return code (well, it shouldn't fail anyhow...)
 309     (void)ftime(&tp);
 310     val *= tp.time;
 311     return (val + tp.millitm);
 312 #else // no gettimeofday() nor ftime()
 313     // We use wxGetLocalTime() to get the seconds since
 314     // 00:00:00 Jan 1st 1970 and then whatever is available
 315     // to get millisecond resolution.
 316     //
 317     // NOTE that this might lead to a problem if the clocks
 318     // use different sources, so this approach should be
 319     // avoided where possible.
 320
 321     val *= wxGetLocalTime();
 322
 323 // GRG: This will go soon as all WIN32 seem to have ftime
 324 #if defined (__WIN32__)
 325     // If your platform/compiler needs to use two different functions
 326     // to get ms resolution, please do NOT just shut off these warnings,
 327     // drop me a line instead at <guille@iies.es>
 328     #warning "Possible clock skew bug in wxGetLocalTimeMillis()!"
 329
 330     SYSTEMTIME st;
 331     ::GetLocalTime(&st);
 332     val += st.wMilliseconds;
 333 #else // !Win32
 334     // If your platform/compiler does not support ms resolution please
 335     // do NOT just shut off these warnings, drop me a line instead at
 336     // <guille@iies.es>
 337
 338     #if defined(__VISUALC__) || defined (__WATCOMC__)
 339         #pragma message("wxStopWatch will be up to second resolution!")
 340     #elif defined(__BORLANDC__)
 341         #pragma message "wxStopWatch will be up to second resolution!"
 342     #else
 343         #warning "wxStopWatch will be up to second resolution!"
 344     #endif // compiler
 345 #endif
 346
 347     return val;
 348
 349 #endif // time functions
 350 }
 351
 352 #endif // wxUSE_LONGLONG
 353