13
0
livetrax/libs/glibmm2/glib/glibmm/timeval.h
Paul Davis 449aab3c46 rollback to 3428, before the mysterious removal of libs/* at 3431/3432
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
2008-06-02 21:41:35 +00:00

234 lines
5.4 KiB
C++

// -*- c++ -*-
#ifndef _GLIBMM_TIMEVAL_H
#define _GLIBMM_TIMEVAL_H
/* $Id: timeval.h 2 2003-01-07 16:59:16Z murrayc $ */
/* timeval.h
*
* Copyright (C) 2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glib/gtypes.h>
#include <glib/gtimer.h>
namespace Glib
{
/** Glib::TimeVal is a wrapper around the glib structure GTimeVal.
* The glib structure GTimeVal itself is equivalent to struct timeval,
* which is returned by the gettimeofday() UNIX call. Additionally
* this wrapper provides an assortment of time manipulation functions.
*/
struct TimeVal : public GTimeVal
{
inline TimeVal();
inline TimeVal(long seconds, long microseconds);
inline TimeVal(const GTimeVal& gtimeval);
inline TimeVal& operator=(const GTimeVal& gtimeval);
/** Assigns the current time to the TimeVal instance.
* Equivalent to the UNIX gettimeofday() function, but is portable and
* works also on Win32.
*/
void assign_current_time();
void add(const TimeVal& rhs);
void subtract(const TimeVal& rhs);
void add_seconds(long seconds);
void subtract_seconds(long seconds);
void add_milliseconds(long milliseconds);
void subtract_milliseconds(long milliseconds);
void add_microseconds(long microseconds);
void subtract_microseconds(long microseconds);
inline TimeVal& operator+=(const TimeVal& gtimeval);
inline TimeVal& operator-=(const TimeVal& gtimeval);
inline TimeVal& operator+=(long seconds);
inline TimeVal& operator-=(long seconds);
/** Returns a double representation of the time interval.
* This member function converts the time interval, that is
* internally stored as two long values for seconds and microseconds,
* to a double representation, whose unit is seconds.
*/
inline double as_double() const;
inline bool negative() const;
/** Checks whether the stored time interval is positive.
* Returns true if the stored time / time interval is positive.
*/
inline bool valid() const;
};
inline
TimeVal::TimeVal()
{
tv_sec = 0;
tv_usec = 0;
}
inline
TimeVal::TimeVal(long seconds, long microseconds)
{
tv_sec = seconds;
tv_usec = microseconds;
}
inline
TimeVal::TimeVal(const GTimeVal& gtimeval)
{
tv_sec = gtimeval.tv_sec;
tv_usec = gtimeval.tv_usec;
}
inline
TimeVal& TimeVal::operator=(const GTimeVal& gtimeval)
{
tv_sec = gtimeval.tv_sec;
tv_usec = gtimeval.tv_usec;
return *this;
}
inline
TimeVal& TimeVal::operator+=(const TimeVal& gtimeval)
{
add(gtimeval);
return *this;
}
inline
TimeVal& TimeVal::operator-=(const TimeVal& gtimeval)
{
subtract(gtimeval);
return *this;
}
inline
TimeVal& TimeVal::operator+=(long seconds)
{
add_seconds(seconds);
return *this;
}
inline
TimeVal& TimeVal::operator-=(long seconds)
{
subtract_seconds(seconds);
return *this;
}
inline
double TimeVal::as_double() const
{
return tv_sec + ((double) tv_usec / (double) G_USEC_PER_SEC);
}
inline
bool TimeVal::negative() const
{
return (tv_sec < 0);
}
inline
bool TimeVal::valid() const
{
return (tv_usec >= 0 && tv_usec < G_USEC_PER_SEC);
}
/** @relates Glib::TimeVal */
inline
TimeVal operator+(const TimeVal& lhs, const TimeVal& rhs)
{ return TimeVal(lhs) += rhs; }
/** @relates Glib::TimeVal */
inline
TimeVal operator+(const TimeVal& lhs, long seconds)
{ return TimeVal(lhs) += seconds; }
/** @relates Glib::TimeVal */
inline
TimeVal operator-(const TimeVal& lhs, const TimeVal& rhs)
{ return TimeVal(lhs) -= rhs; }
/** @relates Glib::TimeVal */
inline
TimeVal operator-(const TimeVal& lhs, long seconds)
{ return TimeVal(lhs) -= seconds; }
/** @relates Glib::TimeVal */
inline
bool operator==(const TimeVal& lhs, const TimeVal& rhs)
{
return (lhs.tv_sec == rhs.tv_sec && lhs.tv_usec == rhs.tv_usec);
}
/** @relates Glib::TimeVal */
inline
bool operator!=(const TimeVal& lhs, const TimeVal& rhs)
{
return (lhs.tv_sec != rhs.tv_sec || lhs.tv_usec != rhs.tv_usec);
}
/** @relates Glib::TimeVal */
inline
bool operator<(const TimeVal& lhs, const TimeVal& rhs)
{
return ((lhs.tv_sec < rhs.tv_sec) ||
(lhs.tv_sec == rhs.tv_sec && lhs.tv_usec < rhs.tv_usec));
}
/** @relates Glib::TimeVal */
inline
bool operator>(const TimeVal& lhs, const TimeVal& rhs)
{
return ((lhs.tv_sec > rhs.tv_sec) ||
(lhs.tv_sec == rhs.tv_sec && lhs.tv_usec > rhs.tv_usec));
}
/** @relates Glib::TimeVal */
inline
bool operator<=(const TimeVal& lhs, const TimeVal& rhs)
{
return ((lhs.tv_sec < rhs.tv_sec) ||
(lhs.tv_sec == rhs.tv_sec && lhs.tv_usec <= rhs.tv_usec));
}
/** @relates Glib::TimeVal */
inline
bool operator>=(const TimeVal& lhs, const TimeVal& rhs)
{
return ((lhs.tv_sec > rhs.tv_sec) ||
(lhs.tv_sec == rhs.tv_sec && lhs.tv_usec >= rhs.tv_usec));
}
} // namespace Glib
#endif /* _GLIBMM_TIMEVAL_H */