just some comments

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

diff --git a/src/common/timercmn.cpp b/src/common/timercmn.cpp
index f25a81740926454c68a5a3b70b263708965a5406..c350e8ca5bfad362b459eddefc70c83883e88777 100644 (file)
--- a/src/common/timercmn.cpp
+++ b/src/common/timercmn.cpp
@@ -1,210 +1,271 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// 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"

 
 

-#ifdef __SVR4__
-#define __SYSV__
+#if defined(__WIN32__)
+    #include <windows.h>

 #endif
 
 #include <time.h>
 #endif
 
 #include <time.h>

-#include <sys/types.h>
-
-#if (!defined(__SC__) && !defined(__SGI__) && !defined(__GNUWIN32__)) || defined(__MINGW32__)
-#include <sys/timeb.h>
+#ifndef __WXMAC__
+    #include <sys/types.h>      // for time_t

 #endif
 
 #endif
 

-#if defined(__linux__) || defined(__SVR4__) || defined(__SYSV__) || defined(__SGI__) || \
-    defined(__ALPHA__) || defined(__GNUWIN32__) || defined(__FreeBSD__) || defined(__NetBSD__)
-#include <sys/time.h>
+#if defined(HAVE_GETTIMEOFDAY)
+    #include <sys/time.h>
+    #include <unistd.h>
+#elif defined(HAVE_FTIME)
+    #include <sys/timeb.h>

 #endif
 
 #endif
 

-#ifdef __MINGW32__
-#include "windows.h"
-#endif
+// ----------------------------------------------------------------------------
+// wxWin macros
+// ----------------------------------------------------------------------------

 
 

-#if defined(__SUN__) || defined(__OSF__)
-// At least on Sun, ftime is undeclared.
-// Need to be verified on other platforms.
-extern "C" int ftime(struct timeb *tp);
-// 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
-#endif
+IMPLEMENT_DYNAMIC_CLASS(wxTimerEvent, wxEvent)
+
+// ----------------------------------------------------------------------------
+// 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
+
+// ----------------------------------------------------------------------------
+// prototypes
+// ----------------------------------------------------------------------------

 
 

-/*
- * Timer functions
- *
- */
+wxLongLong wxGetLocalTimeMillis();

 
 

-long wxStartTime = 0;
-void wxStartTimer(void)
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxTimerBase
+// ----------------------------------------------------------------------------
+
+void wxTimerBase::Notify()

 {
 {

-#if defined(__xlC__) || defined(__AIX__) || defined(__SVR4__) || defined(__SYSV__) || (defined(__GNUWIN32__) && !defined(__MINGW32__)) // || defined(__AIXV3__)
-  struct timeval tp;
-#ifdef __SYSV__
-  gettimeofday(&tp, (struct timezone *)NULL);
-#else
-  gettimeofday(&tp);
-#endif
-  wxStartTime = 1000*tp.tv_sec + tp.tv_usec/1000;
-#elif (defined(__SC__) || defined(__SGI__) || defined(___BSDI__) || defined(__ALPHA__) || defined(__MINGW32__))
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-  wxStartTime = 1000*(60*(60*tp->tm_hour+tp->tm_min)+tp->tm_sec);
-#else
-  struct timeb tp;
-  ftime(&tp);
-  wxStartTime = 1000*tp.time + tp.millitm;
-#endif
+    // 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);
+}
+
+// ----------------------------------------------------------------------------
+// wxStopWatch
+// ----------------------------------------------------------------------------
+
+void wxStopWatch::Start(long t)
+{
+    m_t0 = wxGetLocalTimeMillis() - t;
+
+    m_pause = 0;
+}
+
+long wxStopWatch::GetElapsedTime() const
+{
+    return (wxGetLocalTimeMillis() - m_t0).GetLo();
+}
+
+long wxStopWatch::Time() const
+{
+    return (m_pause ? m_pause : GetElapsedTime());
+}
+
+// ----------------------------------------------------------------------------
+// old timer functions superceded by wxStopWatch
+// ----------------------------------------------------------------------------
+
+static wxLongLong wxStartTime = 0l;
+
+// starts the global timer
+void wxStartTimer()
+{
+    wxStartTime = wxGetLocalTimeMillis();

 }
 
 // Returns elapsed time in milliseconds
 long wxGetElapsedTime(bool resetTimer)
 {
 }
 
 // Returns elapsed time in milliseconds
 long wxGetElapsedTime(bool resetTimer)
 {

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

 }
 
 }
 

-// EXPERIMENTAL: comment this out if it doesn't compile.
-#ifndef __VMS__
-bool wxGetLocalTime(long *timeZone, int *dstObserved)
+
+// ----------------------------------------------------------------------------
+// the functions to get the current time and timezone info
+// ----------------------------------------------------------------------------
+
+// Get local time as seconds since 00:00:00, Jan 1st 1970
+long wxGetLocalTime()

 {
 {

-#if defined(__MINGW32__) && defined(__EGCS__)
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-  *timeZone = timezone; // tp->tm_gmtoff; // ???
-  *dstObserved = tp->tm_isdst;
-#elif defined(__MINGW32__)
-  time_t t0;
-  struct tm *tp;
-  time(&t0);
-  tp = localtime(&t0);
-  timeb tz;
-  ftime(& tz);
-  *timeZone = tz._timezone;
-  *dstObserved = tp->tm_isdst;
-#else
+    struct tm tm;
+    time_t t0, t1;

 
 

-#if (((defined(__SYSV__) && !defined(__HPUX__)) || defined(__MSDOS__) || defined(__WXMSW__)) && !defined(__GNUWIN32__))
-#ifdef __BORLANDC__
-  /* Borland uses underscores */
-  *timeZone = _timezone;
-  *dstObserved = _daylight;
-#else
-  *timeZone = timezone;
-  *dstObserved = daylight;
-#endif
-#elif defined(__xlC__) || defined(__AIX__) || defined(__SVR4__) || defined(__SYSV__) || (defined(__GNUWIN32__) && !defined(__MINGW32__)) // || defined(__AIXV3__)
-  struct timeval tp;
-#if defined(__SYSV__) || (defined(__GNUWIN32__) && !defined(__MINGW32))
-  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);
-  *timeZone = tp->tm_gmtoff; // ???
-  *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
-#endif
-  // __MINGW32__
-  return TRUE;
+    // 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;

 }
 }

-#endif

 
 

-// Get number of seconds since 00:00:00 GMT, Jan 1st 1970.
-long wxGetCurrentTime(void)
+// Get UTC time as seconds since 00:00:00, Jan 1st 1970
+long wxGetUTCTime()
+{
+    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(_("Failed 2nd mktime"));
+        }
+        wxLogSysError(_("Failed gmtime"));
+    }
+    wxLogSysError(_("Failed to get the UTC system time"));
+    return -1;
+}
+
+
+// Get local time as milliseconds since 00:00:00, Jan 1st 1970
+wxLongLong wxGetLocalTimeMillis()

 {
 {

-#if defined(__xlC__) || defined(__AIX__) || defined(__SVR4__) || defined(__SYSV__) // || defined(__AIXV3__)
-  struct timeval tp;
-#ifdef __SYSV__
-  gettimeofday(&tp, (struct timezone *)NULL);
+    // We use wxGetLocalTime() to get the seconds since
+    // 00:00:00 Jan 1st 1970 and then whatever is available
+    // to get millisecond resolution.
+    //
+    wxLongLong val = 1000l;
+    val *= wxGetLocalTime();
+
+    // If we got here, do not fail even if we can't get
+    // millisecond resolution.
+    //
+#if defined(__WIN32__)
+    SYSTEMTIME st;
+    ::GetLocalTime(&st);
+    return (val + st.wMilliseconds);
+#elif defined(__VISAGECPP__)
+    DATETIME    dt;
+    ::DosGetDateTime(&dt);
+    return (val + dt.hundredths*10);
+#elif defined(HAVE_GETTIMEOFDAY)
+    struct timeval tp;
+    if ( wxGetTimeOfDay(&tp, (struct timezone *)NULL) != -1 )
+    {
+        return (val + (tp.tv_usec / 1000));
+    }
+#elif defined(HAVE_FTIME)
+    struct timeb tp;
+    if ( ftime(&tp) == 0 )
+    {
+        return (val + tp.millitm);
+    }

 #else
 #else

-  gettimeofday(&tp);
+#if !defined(__BORLANDC__) && !(defined(__VISUALC__) && defined(__WIN16__))
+    #warning "wxStopWatch will be up to second resolution!"

 #endif
 #endif

-  return tp.tv_sec;
-#else // (defined(__SC__) || defined(__SGI__) || defined(___BSDI__) || defined(__ALPHA__))
-  return time(0);

 #endif
 #endif

-/*
-#else
-  struct timeb tp;
-  ftime(&tp);
-  return tp.time;
-#endif
-*/
-}

 
 

+    return val;
+}