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 class LocalTime
  65 {
  66 public:
  67         /** Construct a LocalTime from the current time */
  68         LocalTime ();
  69
  70         explicit LocalTime (struct tm tm);
  71
  72         /** Construct a LocalTime from a boost::posix_time::ptime using the local
  73          *  time zone
  74          */
  75         explicit LocalTime (boost::posix_time::ptime);
  76
  77         /** Construct a LocalTime from a boost::posix_time::ptime and a time zone offset */
  78         LocalTime(boost::posix_time::ptime, UTCOffset offset);
  79
  80         /** @param s A string of the form 2013-01-05T18:06:59[.123][+04:00] */
  81         explicit LocalTime (std::string s);
  82
  83         LocalTime(int year, int month, int day, int hour, int minute, UTCOffset offset)
  84                 : _year(year)
  85                 , _month(month)
  86                 , _day(day)
  87                 , _hour(hour)
  88                 , _minute(minute)
  89                 , _offset(offset)
  90         {}
  91
  92         /** @return A string of the form 2013-01-05T18:06:59+04:00 or 2013-01-05T18:06:59.123+04:00 */
  93         std::string as_string (bool with_millisecond = false) const;
  94
  95         /** @return The date in the form YYYY-MM-DD */
  96         std::string date () const;
  97
  98         /** @return The time in the form HH:MM:SS or HH:MM:SS.mmm */
  99         std::string time_of_day (bool with_second, bool with_millisecond) const;
 100
 101         int day () const {
 102                 return _day;
 103         }
 104
 105         int month () const {
 106                 return _month;
 107         }
 108
 109         int year () const {
 110                 return _year;
 111         }
 112
 113         int hour () const {
 114                 return _hour;
 115         }
 116
 117         int minute () const {
 118                 return _minute;
 119         }
 120
 121         int second () const {
 122                 return _second;
 123         }
 124
 125         void set_year (int y) {
 126                 _year = y;
 127         }
 128
 129         void add_days (int d);
 130         void add_months (int a);
 131         void add_minutes (int a);
 132
 133         void add(boost::posix_time::time_duration duration);
 134
 135         static LocalTime from_asn1_utc_time (std::string time);
 136         static LocalTime from_asn1_generalized_time (std::string time);
 137
 138         bool operator== (LocalTime const & other) const;
 139         bool operator!= (LocalTime const & other) const;
 140         bool operator< (LocalTime const & other) const;
 141
 142 private:
 143         friend struct ::local_time_basic_test;
 144
 145         void set (struct tm const * tm);
 146         void set (boost::posix_time::ptime);
 147         void set_local_time_zone ();
 148
 149         /* Local time */
 150         int _year = 0;        ///< year
 151         int _month = 0;       ///< month number of the year (1-12)
 152         int _day = 0;         ///< day number of the month (1-31)
 153         int _hour = 0;        ///< hour number of the day (0-23)
 154         int _minute = 0;      ///< minute number of the hour (0-59)
 155         int _second = 0;      ///< second number of the minute (0-59)
 156         int _millisecond = 0; ///< millisecond number of the second (0-999)
 157
 158         UTCOffset _offset;
 159 };
 160
 161
 162 std::ostream&
 163 operator<< (std::ostream& s, LocalTime const & t);
 164
 165
 166 }
 167
 168
 169 #endif