OS/2 updates for statusbar processing and easier VA debugging

[wxWidgets.git] / src / common / timercmn.cpp

diff --git a/src/common/timercmn.cpp b/src/common/timercmn.cpp
index 07b66fe957f521ccf8f4ba81ef7bbdfcc25ab91a..e90b5fd4ade7c1fd0cdaa082f304d24588ba9c24 100644 (file)
--- a/src/common/timercmn.cpp
+++ b/src/common/timercmn.cpp
@@ -1,233 +1,336 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        timercmn.cpp
+// Name:        common/timercmn.cpp

 // Purpose:     Common timer implementation
 // Purpose:     Common timer implementation

-// Author:      Julian Smart
+// Author:
+//    Original version by Julian Smart
+//    Vadim Zeitlin got rid of all ifdefs (11.12.99)
+//    Sylvain Bougnoux added wxStopWatch class
+//    Guillermo Rodriguez <guille@iies.es> rewrote from scratch (Dic/99)

 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows license
+//              (c) 1999 Guillermo Rodriguez <guille@iies.es>
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxWin headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-//#pragma implementation "timercmn.h"
-#pragma implementation
+    #pragma implementation "timerbase.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-#include "wx/defs.h"
-#include "wx/list.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"

 #endif
 
 #include "wx/timer.h"
 #endif
 
 #include "wx/timer.h"

+#include "wx/longlong.h"

 
 

-#if defined(__SVR4__) && !defined(__SYSV__)
-#define __SYSV__
-#endif
-
-#include <time.h>
+// ----------------------------------------------------------------------------
+// System headers
+// ----------------------------------------------------------------------------

 
 

-#ifndef __WXMAC__
-#include <sys/types.h>
+#if defined(__WIN32__)
+    #include <windows.h>

 #endif
 
 #endif
 

-#if (!defined(__SC__) && !defined(__SGI__) && !defined(__GNUWIN32__) && !defined(__MWERKS__)) || defined(__MINGW32__)
-#include <sys/timeb.h>
+#if defined(__WIN32__) && !defined(HAVE_FTIME)
+    #define HAVE_FTIME

 #endif
 
 #endif
 

-#if defined(__linux__) || defined(__SVR4__) || defined(__SYSV__) || defined(__SGI__) || \
-    defined(__ALPHA__) || defined(__GNUWIN32__) || defined(__FreeBSD__) || defined(__NetBSD__) || \
-    defined(__SALFORDC__) || defined(__EMX__)
-#include <sys/time.h>
+#if defined(__VISAGECPP__) && !defined(HAVE_FTIME)
+    #define HAVE_FTIME
+#  if __IBMCPP__ >= 400
+    #  define ftime(x) _ftime(x)
+#  endif

 #endif
 
 #endif
 

-#ifdef __MINGW32__
-#include "windows.h"
+#include <time.h>
+#ifndef __WXMAC__
+    #include <sys/types.h>      // for time_t

 #endif
 
 #endif
 

-#if defined(__SUN__) || defined(__OSF__) || defined(__FreeBSD__)
-// At least on Sun, ftime is undeclared.
-// Need to be verified on other platforms.
-extern "C" int ftime(struct timeb *tp);
-//extern "C" int gettimeofday(struct timeval *tp, void *);
-// extern "C" time_t time(time_t);
-// #include <sys/timeb.h>
-#if defined(__SVR4__) && !defined(__ALPHA__)
-// ditto for gettimeofday on Solaris 2.x.
-extern "C" int gettimeofday(struct timeval *tp, void *);
-#endif
+#if defined(HAVE_GETTIMEOFDAY)
+    #include <sys/time.h>
+    #include <unistd.h>
+#elif defined(HAVE_FTIME)
+    #include <sys/timeb.h>

 #endif
 
 #endif
 

-/*
- * Timer functions
- *
- */
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+    IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent)
+#endif // wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+
+// on some really old systems gettimeofday() doesn't have the second argument,
+// define wxGetTimeOfDay() to hide this difference
+#ifdef HAVE_GETTIMEOFDAY
+    #ifdef WX_GETTIMEOFDAY_NO_TZ
+        struct timezone;
+        #define wxGetTimeOfDay(tv, tz)      gettimeofday(tv)
+    #else
+        #define wxGetTimeOfDay(tv, tz)      gettimeofday((tv), (tz))
+    #endif
+#endif // HAVE_GETTIMEOFDAY
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxTimerBase
+// ----------------------------------------------------------------------------

 
 

-long wxStartTime = 0;
-void wxStartTimer(void)
+#if wxUSE_GUI
+
+void wxTimerBase::Notify()

 {
 {

-  wxStartTime=wxGetCurrentMTime();
+    // the base class version generates an event if it has owner - which it
+    // should because otherwise nobody can process timer events
+    wxCHECK_RET( m_owner, _T("wxTimer::Notify() should be overridden.") );
+
+    wxTimerEvent event(m_idTimer, m_milli);
+    (void)m_owner->ProcessEvent(event);

 }
 
 }
 

-// Returns elapsed time in milliseconds
-long wxGetElapsedTime(bool resetTimer)
+bool wxTimerBase::Start(int milliseconds, bool oneShot)

 {
 {

-  long oldTime = wxStartTime;
-  long newTime=wxGetCurrentMTime();
+    if ( IsRunning() )
+    {
+        // not stopping the already running timer might work for some
+        // platforms (no problems under MSW) but leads to mysterious crashes
+        // on the others (GTK), so to be on the safe side do it here
+        Stop();
+    }

 
 

-  if (resetTimer) wxStartTime = newTime;
-  return newTime - oldTime;
+    if ( milliseconds != -1 )
+    {
+        m_milli = milliseconds;
+    }
+
+    m_oneShot = oneShot;
+
+    return TRUE;

 }
 
 }
 

+#endif // wxUSE_GUI

 
 

-// Get number of seconds since 00:00:00 GMT, Jan 1st 1970.
-long wxGetCurrentTime(void)
+// ----------------------------------------------------------------------------
+// wxStopWatch
+// ----------------------------------------------------------------------------
+
+void wxStopWatch::Start(long t)

 {
 {

-  return wxGetCurrentMTime()/1000;
+    m_t0 = wxGetLocalTimeMillis() - t;
+    m_pause = 0;

 }
 
 }
 

-// return GMT time in millisecond
-long wxGetCurrentMTime()
+long wxStopWatch::GetElapsedTime() const

 {
 {

-#if defined(__xlC__) || defined(__AIX__) || defined(__SVR4__) || defined(__SYSV__) || \
-    (defined(__GNUWIN32__) && !defined(__MINGW32__)) // || defined(__AIXV3__)
-  struct timeval tp;
-#if defined(__SYSV__) || (defined (__GNUWIN32__) && !defined (__MINGW32__))
-  gettimeofday(&tp, (struct timezone *)NULL);
-#else
-  gettimeofday(&tp);
-#endif
-  return (1000*tp.tv_sec + tp.tv_usec / 1000);
-#elif (defined(__SC__) || defined(__SGI__) || defined(___BSDI__) || defined(__ALPHA__) || \
-  defined(__MINGW32__)|| defined(__MWERKS__) || defined(__FreeBSD__))
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-  return 1000*(60*(60*tp->tm_hour+tp->tm_min)+tp->tm_sec);
-#else
-  struct timeb tp;
-  ftime(&tp);
-  return (1000*tp.time + tp.millitm);
-#endif
+  return (wxGetLocalTimeMillis() - m_t0).GetLo();

 }
 
 }
 

-//---------------
-// wxChrono class
-// This class encapsulates the above fonctions,
-// such that several wxChrono can be created 
-// simultaneously
-
-wxChrono::wxChrono()
+long wxStopWatch::Time() const

 {
 {

-  Start();
+    return (m_pause ? m_pause : GetElapsedTime());

 }
 
 }
 

-void wxChrono::Start(long t)
+// ----------------------------------------------------------------------------
+// old timer functions superceded by wxStopWatch
+// ----------------------------------------------------------------------------
+
+static wxLongLong wxStartTime = 0l;
+
+// starts the global timer
+void wxStartTimer()

 {
 {

-  m_t0=wxGetCurrentMTime()-t;
-  m_pause=0;
+    wxStartTime = wxGetLocalTimeMillis();

 }
 
 }
 

-void wxChrono::Pause()
+// Returns elapsed time in milliseconds
+long wxGetElapsedTime(bool resetTimer)

 {
 {

-  m_pause=wxGetCurrentMTime()-m_t0;
+    wxLongLong oldTime = wxStartTime;
+    wxLongLong newTime = wxGetLocalTimeMillis();
+
+    if ( resetTimer )
+        wxStartTime = newTime;
+
+    return (newTime - oldTime).GetLo();

 }
 
 }
 

-void wxChrono::Resume()
+
+// ----------------------------------------------------------------------------
+// the functions to get the current time and timezone info
+// ----------------------------------------------------------------------------
+
+// Get local time as seconds since 00:00:00, Jan 1st 1970
+long wxGetLocalTime()

 {
 {

-  m_t0=wxGetCurrentMTime()-m_pause;
-  m_pause=0;
+    struct tm tm;
+    time_t t0, t1;
+
+    // This cannot be made static because mktime can overwrite it.
+    //
+    memset(&tm, 0, sizeof(tm));
+    tm.tm_year  = 70;
+    tm.tm_mon   = 0;
+    tm.tm_mday  = 5;        // not Jan 1st 1970 due to mktime 'feature'
+    tm.tm_hour  = 0;
+    tm.tm_min   = 0;
+    tm.tm_sec   = 0;
+    tm.tm_isdst = -1;       // let mktime guess
+
+    // Note that mktime assumes that the struct tm contains local time.
+    //
+    t1 = time(&t1);         // now
+    t0 = mktime(&tm);       // origin
+
+    // Return the difference in seconds.
+    //
+    if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 ))
+        return (long)difftime(t1, t0) + (60 * 60 * 24 * 4);
+
+    wxLogSysError(_("Failed to get the local system time"));
+    return -1;

 }
 
 }
 

-long wxChrono::Time()
+// Get UTC time as seconds since 00:00:00, Jan 1st 1970
+long wxGetUTCTime()

 {
 {

-  if (m_pause) return m_pause;
-  return wxGetCurrentMTime()-m_t0;
-}
+    struct tm tm, *ptm;
+    time_t t0, t1;

 
 

+    // This cannot be made static because mktime can overwrite it
+    //
+    memset(&tm, 0, sizeof(tm));
+    tm.tm_year  = 70;
+    tm.tm_mon   = 0;
+    tm.tm_mday  = 5;        // not Jan 1st 1970 due to mktime 'feature'
+    tm.tm_hour  = 0;
+    tm.tm_min   = 0;
+    tm.tm_sec   = 0;
+    tm.tm_isdst = -1;       // let mktime guess
+
+    // Note that mktime assumes that the struct tm contains local time.
+    //
+    t1 = time(&t1);         // now
+    t0 = mktime(&tm);       // origin in localtime
+
+    if (( t0 != (time_t)-1 ) && ( t1 != (time_t)-1 ))
+    {
+        // To get t0 as GMT we convert to a struct tm with gmtime,
+        // and then back again.
+        //
+        ptm = gmtime(&t0);
+
+        if (ptm)
+        {
+            memcpy(&tm, ptm, sizeof(tm));
+            t0 = mktime(&tm);
+
+            if (t0 != (time_t)-1 )
+                return (long)difftime(t1, t0) + (60 * 60 * 24 * 4);
+            wxLogSysError(_("mktime() failed"));
+        }
+        else
+        {
+            wxLogSysError(_("gmtime() failed"));
+        }
+    }
+
+    wxLogError(_("Failed to get the UTC system time."));
+
+    return -1;
+}

 
 
 
 

-// EXPERIMENTAL: comment this out if it doesn't compile.
-#if !defined( __VMS__ ) || ( __VMS_VER >= 70000000 )
-bool wxGetLocalTime(long *timeZone, int *dstObserved)
+// Get local time as milliseconds since 00:00:00, Jan 1st 1970
+wxLongLong wxGetLocalTimeMillis()

 {
 {

-#if defined(__MINGW32__)
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-# if __GNUC__ == 2 && __GNUC_MINOR__ <= 8
-  // gcc 2.8.x or earlier
-  timeb tz;
-  ftime(& tz);
-  *timeZone = tz._timezone;
-# else
-  // egcs or gcc 2.95
-  *timeZone = _timezone; // tp->tm_gmtoff; // ???
-# endif
-  *dstObserved = tp->tm_isdst;
-#else
-// not mingw32...
-#if (((defined(__SYSV__) && !defined(__HPUX__)) || defined(__MSDOS__) || defined(__WXMSW__) || defined(__WXPM__)) \
-   && !defined(__GNUWIN32__) && !defined(__MWERKS__) )
-#  if defined(__BORLANDC__)
-  /* Borland uses underscores */
-  *timeZone = _timezone;
-  *dstObserved = _daylight;
-#  elif defined(__SALFORDC__)
-  *timeZone = _timezone;
-  *dstObserved = daylight;
-#  elif defined(__VISAGECPP__)
-  *timeZone = _timezone;
-  *dstObserved = daylight;
-#  else
-  *timeZone = timezone;
-  *dstObserved = daylight;
-#  endif
-#elif defined(__xlC__) || defined(__AIX__) || defined(__SVR4__) || \
-   defined(__SYSV__) || defined(__MWERKS__) || (defined(__GNUWIN32__) && \
-                                                  !defined(__MINGW32__))\
-       || defined( __VMS__ ) // || defined(__AIXV3__)
-#  if defined(__SYSV__) || (defined(__GNUWIN32__) && !defined(__MINGW32))
-#  ifndef __MWERKS__
-  struct timeval tp;
-#  endif
-  struct timezone tz;
-  gettimeofday(&tp, &tz);
-  *timeZone = 60*(tz.tz_minuteswest);
-  *dstObserved = tz.tz_dsttime;
-#  else
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-#  ifndef __MWERKS__
-  *timeZone = tp->tm_gmtoff; // ???
-#  else
-  *timeZone = 0 ;
-#  endif
-  *dstObserved = tp->tm_isdst;
-#endif
-#elif defined(__WXSTUBS__)
-  return FALSE;
-#else
-// #error wxGetLocalTime not implemented.
-  struct timeval tp;
-  struct timezone tz;
-  gettimeofday(&tp, &tz);
-  *timeZone = 60*(tz.tz_minuteswest);
-  *dstObserved = tz.tz_dsttime;
-#endif
+    wxLongLong val = 1000l;
+
+    // If possible, use a functin which avoids conversions from
+    // broken-up time structures to milliseconds,
+
+#if defined(HAVE_GETTIMEOFDAY)
+    struct timeval tp;
+    if ( wxGetTimeOfDay(&tp, (struct timezone *)NULL) != -1 )
+    {
+        val *= tp.tv_sec;
+        return (val + (tp.tv_usec / 1000));
+    }
+    else
+    {
+        wxLogError(_("wxGetTimeOfDay failed."));
+        return 0;
+    }
+#elif defined(HAVE_FTIME)
+    struct timeb tp;
+
+    // ftime() is void and not int in some mingw32 headers, so don't
+    // test the return code (well, it shouldn't fail anyhow...)
+    (void)ftime(&tp);
+    val *= tp.time;
+    return (val + tp.millitm);
+#else // no gettimeofday() nor ftime()
+    // We use wxGetLocalTime() to get the seconds since
+    // 00:00:00 Jan 1st 1970 and then whatever is available
+    // to get millisecond resolution.
+    //
+    // NOTE that this might lead to a problem if the clocks
+    // use different sources, so this approach should be
+    // avoided where possible.
+
+    val *= wxGetLocalTime();
+
+// GRG: This will go soon as all WIN32 seem to have ftime
+#if defined (__WIN32__)
+    // If your platform/compiler needs to use two different functions
+    // to get ms resolution, please do NOT just shut off these warnings,
+    // drop me a line instead at <guille@iies.es>
+    #warning "Possible clock skew bug in wxGetLocalTimeMillis()!"
+
+    SYSTEMTIME st;
+    ::GetLocalTime(&st);
+    val += st.wMilliseconds;
+#else // !Win32
+    // If your platform/compiler does not support ms resolution please
+    // do NOT just shut off these warnings, drop me a line instead at
+    // <guille@iies.es>
+
+    #if defined(__VISUALC__)
+        #pragma message("wxStopWatch will be up to second resolution!")
+    #elif defined(__BORLANDC__)
+        #pragma message "wxStopWatch will be up to second resolution!"
+    #else
+        #warning "wxStopWatch will be up to second resolution!"
+    #endif // compiler

 #endif
 #endif

-  // __MINGW32__
-  return TRUE;
+
+    return val;
+
+#endif // time functions

 }
 }

-#endif