]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/time.h
Ensure that key events are sent to focused window first in wxGTK.
[wxWidgets.git] / include / wx / time.h
index 4e4bdf1535997988547f531ab6794210e0fcf22c..8b79d3ec578f61f0da085ccd9bc98e5b8ce63450 100644 (file)
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/time.h
-// Purpose:     wxTime class, from NIHCL: this class is deprecated, use
-//              wxDateTime instead
-// Author:      Julian Smart, after K. E. Gorlen
-// Modified by: 18.12.99 by VZ to use the new wxDateTime class
-// Created:     01/02/97
-// RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
+// Purpose:     Miscellaneous time-related functions.
+// Author:      Vadim Zeitlin
+// Created:     2011-11-26
+// RCS-ID:      $Id: wxhead.h,v 1.12 2010-04-22 12:44:51 zeitlin Exp $
+// Copyright:   (c) 2011 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_TIMEH__
-#define _WX_TIMEH__
+#ifndef _WX_TIME_H_
+#define _WX_TIME_H_
 
-#include "wx/defs.h"
+#include "wx/longlong.h"
 
-#if wxUSE_TIMEDATE
+// Returns the difference between UTC and local time in seconds.
+WXDLLIMPEXP_BASE int wxGetTimeZone();
 
-#include "wx/object.h"
-#include "wx/datetime.h"
-#include "wx/date.h"
+// Get number of seconds since local time 00:00:00 Jan 1st 1970.
+extern long WXDLLIMPEXP_BASE wxGetLocalTime();
 
-#ifdef __GNUG__
-    #pragma interface "time.h"
-#endif
+// Get number of seconds since GMT 00:00:00, Jan 1st 1970.
+extern long WXDLLIMPEXP_BASE wxGetUTCTime();
 
-class WXDLLEXPORT wxDate;
+#if wxUSE_LONGLONG
+    typedef wxLongLong wxMilliClock_t;
+    inline long wxMilliClockToLong(wxLongLong ll) { return ll.ToLong(); }
+#else
+    typedef double wxMilliClock_t;
+    inline long wxMilliClockToLong(double d) { return wx_truncate_cast(long, d); }
+#endif // wxUSE_LONGLONG
 
-typedef unsigned short hourTy;
-typedef unsigned short minuteTy;
-typedef unsigned short secondTy;
-typedef unsigned long clockTy;
+// Get number of milliseconds since local time 00:00:00 Jan 1st 1970
+extern wxMilliClock_t WXDLLIMPEXP_BASE wxGetLocalTimeMillis();
 
-// seconds from 1/1/01 to 1/1/70
-#define wxTIME_EPOCH_DIFF 2177452800UL
+#if wxUSE_LONGLONG
 
-class WXDLLEXPORT wxTime : public wxObject
-{
-public:
-    // type definitions
-    enum tFormat { wx12h, wx24h };
-    enum tPrecision { wxStdMinSec, wxStdMin };
+// Get the number of milliseconds or microseconds since the Epoch.
+wxLongLong WXDLLIMPEXP_BASE wxGetUTCTimeMillis();
+wxLongLong WXDLLIMPEXP_BASE wxGetUTCTimeUSec();
 
-public:
-    // current time 
-    wxTime() : m_time(wxDateTime::Now()) { }
-    wxTime(clockTy s) : m_time((time_t)(s - wxTIME_EPOCH_DIFF)) { }
-    void operator=(const wxTime& t) { m_time = t.m_time; }
-    wxTime(const wxTime& t) : wxObject() { *this = t; }
-    wxTime(hourTy h, minuteTy m, secondTy s = 0, bool WXUNUSED(dst) = FALSE)
-        : m_time(h, m, s) { }
+#endif // wxUSE_LONGLONG
 
-    wxTime(const wxDate& d, hourTy h = 0, minuteTy m = 0, secondTy s = 0,
-           bool WXUNUSED(dst) = FALSE)
-           : m_time(d.GetDay(), (wxDateTime::Month)d.GetMonth(), d.GetYear(),
-                    h, m, s) { }
+#define wxGetCurrentTime() wxGetLocalTime()
 
-    wxTime(const wxDateTime& time) : m_time(time) { }
+// 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
+        #define wxGetTimeOfDay(tv)      gettimeofday(tv)
+    #else
+        #define wxGetTimeOfDay(tv)      gettimeofday((tv), NULL)
+    #endif
+#endif // HAVE_GETTIMEOFDAY
 
-    // Convert to string
-#ifndef __SALFORDC__
-    operator wxChar *() const { return FormatTime(); }
-    operator wxDate() const { return wxDate(m_time); }
+/* Two wrapper functions for thread safety */
+#ifdef HAVE_LOCALTIME_R
+#define wxLocaltime_r localtime_r
+#else
+WXDLLIMPEXP_BASE struct tm *wxLocaltime_r(const time_t*, struct tm*);
+#if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
+     // On Windows, localtime _is_ threadsafe!
+#warning using pseudo thread-safe wrapper for localtime to emulate localtime_r
+#endif
 #endif
 
-    bool operator< (const wxTime& t) const { return m_time < t.m_time; }
-    bool operator<=(const wxTime& t) const { return m_time <= t.m_time; }
-    bool operator> (const wxTime& t) const { return m_time > t.m_time; }
-    bool operator>=(const wxTime& t) const { return m_time >= t.m_time; }
-    bool operator==(const wxTime& t) const { return m_time == t.m_time; }
-    bool operator!=(const wxTime& t) const { return m_time != t.m_time; }
-
-    friend wxTime WXDLLEXPORT operator+(const wxTime& t, long s)
-        { return wxTime(t.m_time + wxTimeSpan::Seconds((int)s)); }
-    friend wxTime WXDLLEXPORT operator+(long s, const wxTime& t)
-        { return wxTime(t.m_time + wxTimeSpan::Seconds((int)s)); }
-
-    long operator-(const wxTime& t) const
-        { return (m_time - t.m_time).GetValue().ToLong(); }
-    wxTime operator-(long s) const
-        { return wxTime(m_time - wxTimeSpan::Seconds((int)s)); }
-    void operator+=(long s) { m_time += wxTimeSpan::Seconds((int)s); }
-    void operator-=(long s) { m_time -= wxTimeSpan::Seconds((int)s); }
-    bool IsBetween(const wxTime& a, const wxTime& b) const
-        { return *this >= a && *this <= b; }
-
-    // Get day
-    int GetDay() const { return m_time.GetDay(); }
-    // Get month
-    int GetMonth() const { return m_time.GetMonth(); }
-    // Get year
-    int GetYear() const { return m_time.GetYear(); }
-    // Get day of week (0=Sunday 6=Saturday)
-    int GetDayOfWeek() const { return m_time.GetWeekDay(); }
-
-    hourTy GetHour() const { return (hourTy)m_time.GetHour(); }
-    hourTy GetHourGMT() const { return (hourTy)m_time.GetHour(wxDateTime::GMT0); }
-    minuteTy GetMinute() const { return (hourTy)m_time.GetMinute(); }
-    minuteTy GetMinuteGMT() const { return (hourTy)m_time.GetMinute(wxDateTime::GMT0); }
-    secondTy GetSecond() const { return (hourTy)m_time.GetSecond(); }
-    secondTy GetSecondGMT() const { return (hourTy)m_time.GetSecond(wxDateTime::GMT0); }
-
-    clockTy GetSeconds() const { return (clockTy)m_time.GetValue().ToLong(); }
-
-    wxTime Max(const wxTime& t) const { return (t < *this) ? *this : t; }
-    wxTime Min(const wxTime& t) const { return (t > *this) ? *this : t; }
-
-    static void SetFormat(const tFormat lFormat = wx12h,
-                          const tPrecision lPrecision = wxStdMinSec)
-    {
-        ms_Format    = lFormat;
-        ms_Precision  = lPrecision;
-    }
-
-    // (VZ: DANGER: returns pointer to static buffer)
-    wxChar *FormatTime() const
-    {
-        static const wxChar *formats[2][2] =
-        {
-            // wxStdMinSec          wxStdMin
-            { _T("%I:%M:%S %p"), _T("%I:%M %p") },  // wx12h
-            { _T("%H:%M:%S"),    _T("%H:%M")    }   // wx24h
-        };
-
-        wxStrncpy(ms_bufTime, m_time.Format(formats[ms_Format][ms_Precision]),
-                  WXSIZEOF(ms_bufTime));
-
-        return ms_bufTime;
-    }
-
-private:
-    static tFormat      ms_Format;
-    static tPrecision   ms_Precision;
-    static wxChar       ms_bufTime[128];
-
-#if 0 // old wxTime members unused any more
-    clockTy    sec;        /* seconds since 1/1/1901 */
-
-    bool IsDST() const;
-    wxTime GetLocalTime() const;
-
-    // static member functions
-    static wxTime GetLocalTime(const wxDate& date, hourTy h=0, minuteTy m=0, secondTy s=0);
-    static wxTime GetBeginDST(unsigned year);
-    static wxTime GetEndDST(unsigned year);
-#endif // 0
-
-    wxDateTime m_time;
-
-    DECLARE_DYNAMIC_CLASS(wxTime)
-};
-
+#ifdef HAVE_GMTIME_R
+#define wxGmtime_r gmtime_r
+#else
+WXDLLIMPEXP_BASE struct tm *wxGmtime_r(const time_t*, struct tm*);
+#if wxUSE_THREADS && !defined(__WINDOWS__) && !defined(__WATCOMC__)
+     // On Windows, gmtime _is_ threadsafe!
+#warning using pseudo thread-safe wrapper for gmtime to emulate gmtime_r
 #endif
-  // wxUSE_TIMEDATE
 #endif
-    // _WX_TIMEH__
 
+#endif // _WX_TIME_H_