DateTime.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
  DateTime.h

  Qore programming language

  Copyright (C) 2003 - 2014 David Nichols

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.

  Note that the Qore library is released under a choice of three open-source
  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
  information.
*/

#ifndef QORE_DATETIME_H

#define QORE_DATETIME_H

#include <time.h>

class AbstractQoreZoneInfo;

struct qore_tm {
   int year, month, day, hour, minute, second, us, utc_secs_east;
   bool dst;
   const char *zone_name;
   const AbstractQoreZoneInfo *zone;

   DLLLOCAL void clear() {
      year = 0;
      month = 0;
      day = 0;
      hour = 0;
      minute = 0;
      second = 0;
      us = 0;
      utc_secs_east = 0;
      dst = false;
      zone_name = 0;
      zone = 0;
   }

   DLLLOCAL bool isTimeNull() const {
      return !hour && !minute && !second && !us;
   }

   DLLEXPORT int secsEast() const;

   DLLEXPORT const char *regionName() const;
};


class DateTime {
   friend class DateTimeNode;

protected:
   class qore_date_private *priv;

   DLLLOCAL void setDateLiteral(int64 date);
   DLLLOCAL void setRelativeDateLiteral(int64 date);

   DLLLOCAL DateTime& operator=(const DateTime&);
   
   DLLLOCAL DateTime(qore_date_private *n_priv);
      
public:

   DLLEXPORT DateTime(bool r = false);


   DLLEXPORT DateTime(int n_year, int n_month, int n_day, int n_hour = 0, int n_minute = 0, int n_second = 0, short n_ms = 0, bool n_relative = false);


   DLLEXPORT DateTime(int64 seconds);


   DLLEXPORT DateTime(int64 seconds, int ms);


   DLLEXPORT DateTime(const char *date);


   DLLEXPORT DateTime(const AbstractQoreZoneInfo *zone, const char *date);


   DLLEXPORT DateTime(const struct tm *tms);

   DLLEXPORT DateTime(const DateTime &dt);

   DLLEXPORT ~DateTime();

   DLLEXPORT void getTM(struct tm *tms) const;


   DLLEXPORT void setNow();


   DLLEXPORT void setNow(const AbstractQoreZoneInfo *zone);


   DLLEXPORT void setDate(int64 seconds);


   DLLEXPORT void setDate(int64 seconds, int ms);


   DLLEXPORT void setDate(const AbstractQoreZoneInfo *zone, int64 seconds, int us);


   DLLEXPORT void setLocalDate(const AbstractQoreZoneInfo *zone, int64 seconds, int us);

   DLLEXPORT void setDate(const AbstractQoreZoneInfo *n_zone, int n_year, int n_month, int n_day, int n_hour = 0, int n_minute = 0, int n_second = 0, int n_us = 0);


   DLLEXPORT void setDate(const char *str);


   DLLEXPORT void setDate(const AbstractQoreZoneInfo *zone, const char *str);

   DLLEXPORT void setRelativeDate(const char *str);

   DLLEXPORT void setDate(const struct tm *tms, short ms = 0);

   DLLEXPORT void setDate(const DateTime &date);


   DLLEXPORT void setTime(int h, int m, int s, short ms = 0);

   DLLEXPORT bool checkValidity() const;
   DLLEXPORT bool isEqual(const DateTime *dt) const;
   DLLEXPORT DateTime *add(const DateTime *dt) const;
   DLLEXPORT DateTime *subtractBy(const DateTime *dt) const;


   DLLEXPORT int64 getEpochSeconds() const;


   DLLEXPORT int64 getEpochSecondsUTC() const;


   DLLEXPORT int64 getEpochMicrosecondsUTC() const;


   DLLEXPORT int64 getEpochMillisecondsUTC() const;


   DLLEXPORT int getDayNumber() const;


   DLLEXPORT int getDayOfWeek() const;
      

   DLLEXPORT void getISOWeek(int &year, int &week, int &day) const;


   DLLEXPORT void format(QoreString &str, const char *fmt) const;


   DLLEXPORT bool isRelative() const;


   DLLEXPORT bool isAbsolute() const;


   DLLEXPORT short getYear() const;


   DLLEXPORT int getMonth() const;


   DLLEXPORT int getDay() const;


   DLLEXPORT int getHour() const;


   DLLEXPORT int getMinute() const;


   DLLEXPORT int getSecond() const;


   DLLEXPORT int getMillisecond() const;


   DLLEXPORT int getMicrosecond() const;


   DLLEXPORT int64 getRelativeSeconds() const;


   DLLEXPORT int64 getRelativeMilliseconds() const;


   DLLEXPORT int64 getRelativeMicroseconds() const;

   DLLEXPORT bool hasValue() const;

   DLLEXPORT DateTime *unaryMinus() const;

   DLLEXPORT void unaryMinusInPlace();

   DLLEXPORT void getInfo(const AbstractQoreZoneInfo *n_zone, qore_tm &info) const;

   DLLEXPORT void getInfo(qore_tm &info) const;

   DLLEXPORT void setZone(const AbstractQoreZoneInfo *n_zone);

   DLLEXPORT const AbstractQoreZoneInfo* getZone() const;

   // static methods
   DLLEXPORT static bool isLeapYear(int year);

   DLLEXPORT static int getLastDayOfMonth(int month, int year);


   DLLEXPORT static DateTime *getDateFromISOWeek(int year, int week, int day, ExceptionSink *xsink);

   DLLEXPORT static int compareDates(const DateTime *left, const DateTime *right);

   DLLEXPORT static DateTime *makeAbsolute(const AbstractQoreZoneInfo *n_zone, int n_year, int n_month, int n_day, int n_hour = 0, int n_minute = 0, int n_second = 0, int n_us = 0);


   DLLEXPORT static DateTime *makeAbsolute(const AbstractQoreZoneInfo *zone, int64 seconds, int us = 0);


   DLLEXPORT static DateTime *makeAbsoluteLocal(const AbstractQoreZoneInfo *zone, int64 seconds, int us = 0);

   DLLEXPORT static DateTime *makeRelative(int n_year, int n_month, int n_day, int n_hour = 0, int n_minute = 0, int n_second = 0, int n_us = 0);
};

#endif