src/local_time.h

   1 /*
   2     Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/local_time.h
  36  *  @brief LocalTime class
  37  */
  38
  39
  40 #ifndef LIBDCP_LOCAL_TIME_H
  41 #define LIBDCP_LOCAL_TIME_H
  42
  43
  44 #include <boost/date_time/posix_time/posix_time.hpp>
  45 #include <string>
  46
  47
  48 class local_time_basic_test;
  49
  50
  51 namespace dcp {
  52
  53
  54 /** @class LocalTime
  55  *  @brief A representation of a local time (down to the second), including its offset
  56  *  from GMT (equivalent to xs:dateTime).
  57  *
  58  *  I tried to use boost for this, really I did, but I could not get it
  59  *  to parse strings of the required format (those that include time zones).
  60  *
  61  *  See http://www.w3.org/TR/xmlschema-2/#dateTime
  62  */
  63 class LocalTime
  64 {
  65 public:
  66         /** Construct a LocalTime from the current time */
  67         LocalTime ();
  68
  69         explicit LocalTime (struct tm tm);
  70
  71         /** Construct a LocalTime from a boost::posix_time::ptime using the local
  72          *  time zone
  73          */
  74         explicit LocalTime (boost::posix_time::ptime);
  75
  76         /** Construct a LocalTime from a boost::posix_time::ptime and a time zone offset
  77          *  @param tz_minute Offset from UTC in minutes; if the timezone is behind UTC this may be negative,
  78          *  e.g. -04:30 would have tz_hour=-1 and tz_minute=-30.
  79          */
  80         LocalTime (boost::posix_time::ptime, int tz_hour, int tz_minute);
  81
  82         /** @param s A string of the form 2013-01-05T18:06:59[.123][+04:00] */
  83         explicit LocalTime (std::string s);
  84
  85         /** @return A string of the form 2013-01-05T18:06:59+04:00 or 2013-01-05T18:06:59.123+04:00 */
  86         std::string as_string (bool with_millisecond = false) const;
  87
  88         /** @return The date in the form YYYY-MM-DD */
  89         std::string date () const;
  90
  91         /** @return The time in the form HH:MM:SS or HH:MM:SS.mmm */
  92         std::string time_of_day (bool with_second, bool with_millisecond) const;
  93
  94         int day () const {
  95                 return _day;
  96         }
  97
  98         int month () const {
  99                 return _month;
 100         }
 101
 102         int year () const {
 103                 return _year;
 104         }
 105
 106         void set_year (int y) {
 107                 _year = y;
 108         }
 109
 110         void add_days (int d);
 111         void add_months (int a);
 112         void add_minutes (int a);
 113
 114         bool operator== (LocalTime const & other) const;
 115         bool operator!= (LocalTime const & other) const;
 116         bool operator< (LocalTime const & other) const;
 117
 118 private:
 119         friend class ::local_time_basic_test;
 120
 121         void set (struct tm const * tm);
 122         void set (boost::posix_time::ptime);
 123         void set_local_time_zone ();
 124
 125         /* Local time */
 126         int _year = 0;        ///< year
 127         int _month = 0;       ///< month number of the year (1-12)
 128         int _day = 0;         ///< day number of the month (1-31)
 129         int _hour = 0;        ///< hour number of the day (0-23)
 130         int _minute = 0;      ///< minute number of the hour (0-59)
 131         int _second = 0;      ///< second number of the minute (0-59)
 132         int _millisecond = 0; ///< millisecond number of the second (0-999)
 133
 134         int _tz_hour = 0;     ///< hours by which this time is offset from UTC; can be negative
 135         /** Minutes by which this time is offset from UTC; if _tz_hour is negative
 136          *  this will be either 0 or negative.
 137          */
 138         int _tz_minute = 0;
 139 };
 140
 141
 142 std::ostream&
 143 operator<< (std::ostream& s, LocalTime const & t);
 144
 145
 146 }
 147
 148
 149 #endif