src/local_time.h

   1 /*
   2     Copyright (C) 2014-2020 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 /** @file  src/local_time.h
  35  *  @brief LocalTime class.
  36  */
  37
  38 #ifndef LIBDCP_LOCAL_TIME_H
  39 #define LIBDCP_LOCAL_TIME_H
  40
  41 #include <boost/date_time/posix_time/posix_time.hpp>
  42 #include <string>
  43
  44 class local_time_basic_test;
  45
  46 namespace dcp {
  47
  48 /** @class LocalTime
  49  *  @brief A representation of a local time (down to the second), including its offset
  50  *  from GMT (equivalent to xs:dateTime).
  51  *
  52  *  I tried to use boost for this, really I did, but I could not get it
  53  *  to parse strings of the required format (those that include time zones).
  54  *
  55  *  See http://www.w3.org/TR/xmlschema-2/#dateTime
  56  */
  57 class LocalTime
  58 {
  59 public:
  60         LocalTime ();
  61         explicit LocalTime (struct tm tm);
  62         explicit LocalTime (boost::posix_time::ptime);
  63         LocalTime (boost::posix_time::ptime, int tz_hour, int tz_minute);
  64         explicit LocalTime (std::string);
  65
  66         std::string as_string (bool with_millisecond = false) const;
  67         std::string date () const;
  68         std::string time_of_day (bool with_second, bool with_millisecond) const;
  69
  70         int day () const {
  71                 return _day;
  72         }
  73
  74         int month () const {
  75                 return _month;
  76         }
  77
  78         int year () const {
  79                 return _year;
  80         }
  81
  82         void set_year (int y) {
  83                 _year = y;
  84         }
  85
  86         void add_days (int d);
  87         void add_months (int a);
  88         void add_minutes (int a);
  89
  90         bool operator== (LocalTime const & other) const;
  91         bool operator!= (LocalTime const & other) const;
  92         bool operator< (LocalTime const & other) const;
  93
  94 private:
  95         friend class ::local_time_basic_test;
  96
  97         void set (struct tm const * tm);
  98         void set (boost::posix_time::ptime);
  99         void set_local_time_zone ();
 100
 101         /* Local time */
 102         int _year;   ///< year
 103         int _month;  ///< month number of the year (1-12)
 104         int _day;    ///< day number of the month (1-31)
 105         int _hour;   ///< hour number of the day (0-23)
 106         int _minute; ///< minute number of the hour (0-59)
 107         int _second; ///< second number of the minute (0-59)
 108         int _millisecond; ///< millisecond number of the second (0-999)
 109
 110         int _tz_hour; ///< hours by which this time is offset from UTC; can be negative
 111         /** Minutes by which this time is offset from UTC; if _tz_hour is negative
 112          *  this will be either 0 or negative.
 113          */
 114         int _tz_minute;
 115 };
 116
 117 std::ostream&
 118 operator<< (std::ostream& s, LocalTime const & t);
 119
 120 }
 121
 122 #endif