OFDate.h

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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 Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFMessagePackRepresentation.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFString;
@class OFConstantString;
 
@interface OFDate: OFObject <OFCopying, OFComparing,
    OFMessagePackRepresentation>
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) OFDate *distantFuture;
@property (class, readonly, nonatomic) OFDate *distantPast;
#endif
 
@property (readonly, nonatomic) unsigned long microsecond;
 
@property (readonly, nonatomic) unsigned char second;
 
@property (readonly, nonatomic) unsigned char minute;
 
@property (readonly, nonatomic) unsigned char localMinute;
 
@property (readonly, nonatomic) unsigned char hour;
 
@property (readonly, nonatomic) unsigned char localHour;
 
@property (readonly, nonatomic) unsigned char dayOfMonth;
 
@property (readonly, nonatomic) unsigned char localDayOfMonth;
 
@property (readonly, nonatomic) unsigned char monthOfYear;
 
@property (readonly, nonatomic) unsigned char localMonthOfYear;
 
@property (readonly, nonatomic) unsigned short year;
 
@property (readonly, nonatomic) unsigned short localYear;
 
@property (readonly, nonatomic) unsigned char dayOfWeek;
 
@property (readonly, nonatomic) unsigned char localDayOfWeek;
 
@property (readonly, nonatomic) unsigned short dayOfYear;
 
@property (readonly, nonatomic) unsigned short localDayOfYear;
 
@property (readonly, nonatomic) OFTimeInterval timeIntervalSince1970;
 
@property (readonly, nonatomic) OFTimeInterval timeIntervalSinceNow;
 
+ (instancetype)date;
 
+ (instancetype)dateWithTimeIntervalSince1970: (OFTimeInterval)seconds;
 
+ (instancetype)dateWithTimeIntervalSinceNow: (OFTimeInterval)seconds;
 
+ (instancetype)dateWithDateString: (OFString *)string
                format: (OFString *)format;
 
+ (instancetype)dateWithLocalDateString: (OFString *)string
                 format: (OFString *)format;
 
+ (instancetype)distantFuture;
 
+ (instancetype)distantPast;
 
- (instancetype)initWithTimeIntervalSince1970: (OFTimeInterval)seconds
    OF_DESIGNATED_INITIALIZER;
 
- (instancetype)initWithTimeIntervalSinceNow: (OFTimeInterval)seconds;
 
- (instancetype)initWithDateString: (OFString *)string
                format: (OFString *)format;
 
- (instancetype)initWithLocalDateString: (OFString *)string
                 format: (OFString *)format;
 
- (OFComparisonResult)compare: (OFDate *)date;
 
- (OFString *)dateStringWithFormat: (OFConstantString *)format;
 
- (OFString *)localDateStringWithFormat: (OFConstantString *)format;
 
- (OFDate *)earlierDate: (nullable OFDate *)otherDate;
 
- (OFDate *)laterDate: (nullable OFDate *)otherDate;
 
- (OFTimeInterval)timeIntervalSinceDate: (OFDate *)otherDate;
 
- (OFDate *)dateByAddingTimeInterval: (OFTimeInterval)seconds;
@end
 
OF_ASSUME_NONNULL_END