---

more/sys/date.h

Go to the documentation of this file.

//  more/sys/date.h
//  Copyright (C) 2001  Petter Urkedal (petter.urkedal@matfys.lth.se)
//
//  This file is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This file is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  As a special exception, you may use this file as part of a free
//  software library without restriction.  Specifically, if other files
//  instantiate templates or use macros or inline functions from this
//  file, or you compile this file and link it with other files to
//  produce an executable, this file does not by itself cause the
//  resulting executable to be covered by the GNU General Public
//  License.  This exception does not however invalidate any other
//  reasons why the executable file might be covered by the GNU General
//  Public License.
//
//  $Id: date.h,v 1.1 2002/05/30 18:01:40 petter_urkedal Exp $


#ifndef MORE_SYS_DATE_H
#define MORE_SYS_DATE_H

#include <more/sys/time.h>
#include <more/io/fwd.h>


namespace more {
namespace sys {

  /** cultural notion of time. That is, year, month, ..., h, min, s. */
  struct date
  {
      /** an arithmetic type with implicit conversion to time_t, used
       * to express the timezone. */
      typedef long timezone_type;
      /** used to specify the precision of the date. */
      enum precision_type {
          undefined,
          within_1_year, within_1_month, within_1_day,
          within_1_h, within_1_min, within_1_s
      };
      /** trivial default constructor. */
      date() : m_prec(undefined) {}
      // date(date cosnt&) = implicit;
      // date& operator=(date const&) = implicit;
      /** construct a date from time_t. Use m_tz = 0 to make an UTC date. */
      date(time_t t, precision_type tp, timezone_type tz);
      /** construct the a local date from a time_t. */
      date(time_t, precision_type tp = within_1_s);
      /** construct from tm data. */
      date(tm* c_tm) : m_tm(*c_tm) {}
      /** Construct local date from year, month, ..., down to given
          precision. */
      date(int year, int month = -1, int day = -1,
           int h = -1, int min = -1, int s = -1);

      /** True unless an unchanged default constructed object or a
          copy of such. */
      bool is_defined() const { return m_prec != undefined; }

      /** seconds, 0..59. */
      int s() const { return m_tm.tm_sec; }
      /** minutes, 0..59. */
      int min() const { return m_tm.tm_min; }
      /** hours, 0..23. */
      int h() const { return m_tm.tm_hour; }
      /** day of the month 1..31. */
      int day() const { return m_tm.tm_mday; }
      /** month of the year 1..12. */
      int month() const { return m_tm.tm_mon + 1; }
      /** the year. */
      int year() const { return m_tm.tm_year + 1900; }
      /** days passed since previus new year. */
      int day_of_year() const { return m_tm.tm_yday; }
      /** days passed since previous sunday. */
      int day_of_week() const { return m_tm.tm_wday; }
      /** true if daylight saving time is in effect. */
      bool is_dst() const { return m_tm.tm_isdst; }

      operator time_t() const { return std::mktime(&m_tm) - timezone(); }

      /** returns tm data for interfacing C functions. */
      std::tm const* c_tm() const { return &m_tm; }

      /** returns the difference between UTC and the timezone for this date. */
      timezone_type timezone() const { return m_tz; }

      /** used by more::io::syncstream, don't call directly. */
      void sync(more::io::syncstream&);

    private:
      mutable tm m_tm;
      long m_tz;
      precision_type m_prec;

      template<typename CharT, typename Traits>
        friend std::basic_istream<CharT, Traits>&
        operator>>(std::basic_istream<CharT, Traits>& is, date& d);
      template<typename CharT, typename Traits>
        friend std::basic_ostream<CharT, Traits>&
        operator<<(std::basic_ostream<CharT, Traits>&, date const&);
  };

}} // more::sys

#endif

---