/usr/include/Wt/WDateTime is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2009 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WDATE_TIME_H_
#define WDATE_TIME_H_
#include <Wt/WDllDefs.h>
#include <Wt/WString>
#include <exception>
#include <boost/date_time/posix_time/posix_time.hpp>
namespace Wt {
/*! \class InvalidDateTimeException Wt/WDateTime Wt/WDateTime
* \brief Exception thrown when calculating with an invalid date.
*
* \sa WDateTime
*/
class WT_API InvalidDateTimeException : public std::exception
{
public:
InvalidDateTimeException();
~InvalidDateTimeException() throw();
/*! \brief Returns a message describing the error.
*/
const char *what() const throw();
};
class WDate;
class WTime;
/*! \class WDateTime Wt/WDateTime Wt/WDateTime
* \brief A calendar date and clock time.
*
* The date time class combines the functionality of a WDate (for a
* calendar date) and WTime (for clock time) into a single class.
*
* Conventionally date time is assumed in UTC, which affects the behaviour
* of the following methods:
* - toTime_t(), setTime_t()
* - currentDateTime()
*
* <h3>i18n</h3>
*
* The strings returned by toString() and timeTo() can be localized.
* If the thread using a WDateTime is bound to a WApplication (i.e.
* WApplication::instance() does not return 0), the strings
* can be localized by overriding the default values for
* the localized string keys in the resource bundles of the WApplication.
* If the thread using a WDateTime is not bound to a WApplication (i.e.
* WApplication::instance() returns 0), english strings will be used.
*
* For toString(), localization is handled through the i18n functionality
* of the WDate class. An invalid WDateTime is converted to a string
* as "Null":
* - Wt.WDateTime.null: Null
*
* The timeTo() method contains the following localized strings:
* - Wt.WDateTime.second: one second
* - Wt.WDateTime.seconds: {1} seconds
* The placeholder {1} will be replaced by the actual number of seconds. The
* same keys also exist for minutes, hours, days, weeks, monts and years.
*
*/
class WT_API WDateTime
{
public:
/*! \brief Creates a <i>Null</i> datetime.
*
* A time for which isNull() returns \c true. A <i>Null</i> datetime
* is also invalid.
*
* \sa isValid(), isNull()
*/
WDateTime();
/*! \brief Creates a datetime given a date.
*
* The time is set to midnight (00:00). The datetime is valid if the
* \p date is valid.
*/
explicit WDateTime(const WDate& date);
/*! \brief Creates a datetime given a date and time.
*
* The datetime is valid if both \p date and \p time are valid.
*/
WDateTime(const WDate& date, const WTime& time);
/*! \brief Sets the time in seconds from the Epoch.
*
* The \p time is the number of seconds since the Epoch (00:00:00
* UTC, January 1, 1970).
*
* \sa toTime_t()
*/
void setTime_t(std::time_t time);
/*! \brief Sets the date time.
*/
void setPosixTime(const boost::posix_time::ptime& time);
/*! \brief Adds milliseconds.
*
* Returns a datetime that is \p ms milliseconds later than this
* datetime. Negative values for \p ms will result in a datetime that
* is as many milliseconds earlier.
*/
WDateTime addMSecs(int ms) const;
/*! \brief Adds seconds.
*
* Returns a datetime that is \p s seconds later than this
* datetime. Negative values for \p s will result in a datetime that
* is as many seconds earlier.
*/
WDateTime addSecs(int s) const;
/*! \brief Adds days.
*
* Returns a datetime that is \p ndays later than this
* datetime. Negative values for \p ndays will result in a datetime
* that is as many days earlier.
*
* \sa addMonths(), addYears()
*/
WDateTime addDays(int ndays) const;
/*! \brief Adds months.
*
* Returns a datetime that is the same day of the month, but \p
* nmonths later than this date. Negative values for \p nmonths will
* result in a datetime that is as many months earlier.
*
* \sa addDays(), addYears()
*/
WDateTime addMonths(int nmonths) const;
/*! \brief Adds years.
*
* Returns a datetime that is \p nyears later than this
* datetime. Negative values for \p nyears will result in a datetime
* that is as many years earlier.
*
* \sa addDays(), addMonths()
*/
WDateTime addYears(int nyears) const;
/*! \brief Returns if this datetime is <i>Null</i>.
*
* A null time is also invalid.
*
* \sa isValid(), WDateTime()
*/
bool isNull() const;
/*! \brief Returns if this datetime is valid.
*
* A date time is only valid if its date and time parts are valid.
*/
bool isValid() const;
/*! \brief Sets the date part.
*
* Changes the date part part, leaving the time unmodified. If no time
* was set, it is set to 00:00.
*
* \sa setTime()
*/
void setDate(const WDate& date);
/*! \brief Returns the date part.
*
* Returns the date part.
*
* \sa time()
*/
WDate date() const;
/*! \brief Sets the time part.
*
* If no valid date is set, the time is not set either.
*
* \sa setDate()
*/
void setTime(const WTime& time);
/*! \brief Returns the time part.
*
* \sa setTime()
*/
WTime time() const;
/*! \brief Returns the number of seconds since the Epoch.
*
* This returns the number of seconds since the Epoch (00:00:00 UTC,
* January 1, 1970) represented by this datetime.
*/
std::time_t toTime_t() const;
/*! \brief Returns the boost time.
*
* \sa fromPosixTime()
*/
boost::posix_time::ptime toPosixTime() const;
/*! \brief Returns the difference between to datetime values (in seconds).
*
* \sa daysTo()
*/
int secsTo(const WDateTime& other) const;
/*! \brief Returns the difference between two datetime values (in days).
*
* \sa secsTo()
*/
int daysTo(const WDateTime& other) const;
/*! \brief Returns the difference between two datetime values (as text).
*
* This returns a textual representation of the approximate
* difference between this time and \p other. The textual
* representation returns the difference as a number of seconds,
* minutes, hours, days, weeks, months, or years, using the coarsest
* unit that is more than \p minValue.
*
* \sa daysTo(), secsTo()
*/
WString timeTo(const WDateTime& other, int minValue = 1) const;
/*! \brief Compares two datetime values.
*/
bool operator< (const WDateTime& other) const;
/*! \brief Compares two datetime values.
*/
bool operator<= (const WDateTime& other) const;
/*! \brief Compares two datetime values.
*/
bool operator> (const WDateTime& other) const;
/*! \brief Compares two datetime values.
*/
bool operator>= (const WDateTime& other) const;
/*! \brief Compares two datetime values.
*/
bool operator== (const WDateTime& other) const;
/*! \brief Compares two datetime values.
*/
bool operator!= (const WDateTime& other) const;
static WT_USTRING defaultFormat();
/*! \brief Formats this datetime to a string using a default format.
*
* The default format is "ddd MMM d hh:mm:ss yyyy".
*/
WT_USTRING toString() const;
/*! \brief Formats this time to a string using a specified format.
*
* The \p format is a string which mixes the format for WDate and
* WTime.
*
* \sa WDate::toString(), WTime::toString()
*/
WT_USTRING toString(const WT_USTRING& format) const;
/*! \brief Parses a string to a time using a default format.
*
* The default format is "ddd MMM d hh:mm:ss yyyy".
*
* \sa WDate::fromString(), WTime::fromString().
*/
static WDateTime fromString(const WT_USTRING& s);
/*! \brief Parses a string to a time using a specified format.
*
* The \p format is a string which mixes the format for WDate and
* WTime.
*
* \sa WDate::fromString(), WTime::toString().
*/
static WDateTime fromString(const WT_USTRING& s, const WT_USTRING& format);
/*! \brief Reports the current UTC datetime.
*
* This method returns the datetime as indicated by the system clock
* of the server, in the UTC timezone.
*/
static WDateTime currentDateTime();
/*! \brief Creates a date time based on a number of seconds since the Epoch.
*
* \sa setTime_t()
*/
static WDateTime fromTime_t(std::time_t seconds);
/*! \brief Creates a date time from boost's date time type.
*
* \sa toPosixTime()
*/
static WDateTime fromPosixTime(const boost::posix_time::ptime& datetime);
private:
boost::posix_time::ptime datetime_;
enum CharState { CharUnhandled, CharHandled, CharInvalid };
WDateTime(boost::posix_time::ptime datetime);
static void fromString(WDate *date, WTime *time, const WString& s,
const WString& format);
static WString toString(const WDate *date, const WTime *time,
const WString& format);
friend class WDate;
friend class WTime;
};
}
#endif // WDATE_TIME_H_
|