OFDate.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFSerialization.h"

OF_ASSUME_NONNULL_BEGIN

@class OFString;
@class OFConstantString;

@interface OFDate: OFObject <OFCopying, OFComparing, OFSerialization>
{
    of_time_interval_t _seconds;
}

+ (instancetype)date;

+ (instancetype)dateWithTimeIntervalSince1970: (of_time_interval_t)seconds;

+ (instancetype)dateWithTimeIntervalSinceNow: (of_time_interval_t)seconds;

+ (instancetype)dateWithDateString: (OFString *)string
                format: (OFString *)format;

+ (instancetype)dateWithLocalDateString: (OFString *)string
                 format: (OFString *)format;

+ (instancetype)distantFuture;

+ (instancetype)distantPast;

- initWithTimeIntervalSince1970: (of_time_interval_t)seconds;

- initWithTimeIntervalSinceNow: (of_time_interval_t)seconds;

- initWithDateString: (OFString *)string
          format: (OFString *)format;

- initWithLocalDateString: (OFString *)string
           format: (OFString *)format;

- (uint32_t)microsecond;

- (uint8_t)second;

- (uint8_t)minute;

- (uint8_t)localMinute;

- (uint8_t)hour;

- (uint8_t)localHour;

- (uint8_t)dayOfMonth;

- (uint8_t)localDayOfMonth;

- (uint8_t)monthOfYear;

- (uint8_t)localMonthOfYear;

- (uint16_t)year;

- (uint16_t)localYear;

- (uint8_t)dayOfWeek;

- (uint8_t)localDayOfWeek;

- (uint16_t)dayOfYear;

- (uint16_t)localDayOfYear;

- (OFString *)dateStringWithFormat: (OFConstantString *)format;

- (OFString *)localDateStringWithFormat: (OFConstantString *)format;

- (OFDate *)earlierDate: (nullable OFDate *)otherDate;

- (OFDate *)laterDate: (nullable OFDate *)otherDate;

- (of_time_interval_t)timeIntervalSince1970;

- (of_time_interval_t)timeIntervalSinceDate: (OFDate *)otherDate;

- (of_time_interval_t)timeIntervalSinceNow;

- (OFDate *)dateByAddingTimeInterval: (of_time_interval_t)seconds;
@end

OF_ASSUME_NONNULL_END