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 "utc_offset.h"
  45 #include <boost/date_time/posix_time/posix_time.hpp>
  46 #include <string>
  47
  48
  49 struct local_time_basic_test;
  50
  51
  52 namespace dcp {
  53
  54
  55 /** @class LocalTime
  56  *  @brief A representation of a local time (down to the second), including its offset
  57  *  from GMT (equivalent to xs:dateTime).
  58  *
  59  *  I tried to use boost for this, really I did, but I could not get it
  60  *  to parse strings of the required format (those that include time zones).
  61  *
  62  *  See http://www.w3.org/TR/xmlschema-2/#dateTime
  63  *
  64  *  Note that operator== for this class will return true for times that have different
  65  *  offsets but are the same actual time.
  66  */
  67 class LocalTime
  68 {
  69 public:
  70         /** Construct a LocalTime from the current time */
  71         LocalTime ();
  72
  73         explicit LocalTime (struct tm tm);
  74
  75         /** Construct a LocalTime from a boost::posix_time::ptime using the local
  76          *  time zone
  77          */
  78         explicit LocalTime (boost::posix_time::ptime);
  79
  80         /** Construct a LocalTime from a boost::posix_time::ptime and a time zone offset */
  81         LocalTime(boost::posix_time::ptime, UTCOffset offset);
  82
  83         /** @param s A string of the form 2013-01-05T18:06:59[.123][+04:00] */
  84         explicit LocalTime (std::string s);
  85
  86         LocalTime(int year, int month, int day, int hour, int minute, UTCOffset offset)
  87                 : _year(year)
  88                 , _month(month)
  89                 , _day(day)
  90                 , _hour(hour)
  91                 , _minute(minute)
  92                 , _offset(offset)
  93         {}
  94
  95         /** @return A string of the form 2013-01-05T18:06:59+04:00, 2013-01-05T18:06:59.123+04:00
  96          *  2013-01-05T18:06:59 or 2013-01-05T18:06:59.123
  97          */
  98         std::string as_string(bool with_millisecond = false, bool with_timezone = true) const;
  99
 100         /** @return The date in the form YYYY-MM-DD */
 101         std::string date () const;
 102
 103         /** @return The time in the form HH:MM:SS or HH:MM:SS.mmm */
 104         std::string time_of_day (bool with_second, bool with_millisecond) const;
 105
 106         int day () const {
 107                 return _day;
 108         }
 109
 110         int month () const {
 111                 return _month;
 112         }
 113
 114         int year () const {
 115                 return _year;
 116         }
 117
 118         int hour () const {
 119                 return _hour;
 120         }
 121
 122         int minute () const {
 123                 return _minute;
 124         }
 125
 126         int second () const {
 127                 return _second;
 128         }
 129
 130         int millisecond() const {
 131                 return _millisecond;
 132         }
 133
 134         void set_day(int d) {
 135                 _day = d;
 136         }
 137
 138         void set_month(int m) {
 139                 _month = m;
 140         }
 141
 142         void set_year (int y) {
 143                 _year = y;
 144         }
 145
 146         void set_offset(UTCOffset offset) {
 147                 _offset = offset;
 148         }
 149
 150         void add_days (int d);
 151         void add_months (int a);
 152         void add_minutes (int a);
 153
 154         void add(boost::posix_time::time_duration duration);
 155
 156         static LocalTime from_asn1_utc_time (std::string time);
 157         static LocalTime from_asn1_generalized_time (std::string time);
 158
 159         bool operator== (LocalTime const & other) const;
 160         bool operator!= (LocalTime const & other) const;
 161         bool operator< (LocalTime const & other) const;
 162         bool operator<=(LocalTime const & other) const;
 163         bool operator>(LocalTime const & other) const;
 164         bool operator>=(LocalTime const & other) const;
 165
 166 private:
 167         friend struct ::local_time_basic_test;
 168
 169         void set (struct tm const * tm);
 170         void set (boost::posix_time::ptime);
 171         void set_local_time_zone ();
 172         dcp::LocalTime as_utc() const;
 173
 174         /* Local time */
 175         int _year = 0;        ///< year
 176         int _month = 0;       ///< month number of the year (1-12)
 177         int _day = 0;         ///< day number of the month (1-31)
 178         int _hour = 0;        ///< hour number of the day (0-23)
 179         int _minute = 0;      ///< minute number of the hour (0-59)
 180         int _second = 0;      ///< second number of the minute (0-59)
 181         int _millisecond = 0; ///< millisecond number of the second (0-999)
 182
 183         UTCOffset _offset;
 184 };
 185
 186
 187 std::ostream&
 188 operator<< (std::ostream& s, LocalTime const & t);
 189
 190
 191 }
 192
 193
 194 #endif