mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 08:26:27 +00:00
20db4a26dd
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@39452 72102866-910b-0410-8b05-ffd578937521
252 lines
7 KiB
Objective-C
252 lines
7 KiB
Objective-C
/* NSCalendar.h
|
|
|
|
Copyright (C) 2010 Free Software Foundation, Inc.
|
|
|
|
Written by: Stefan Bidigaray
|
|
Date: December, 2010
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library 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 for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; see the file COPYING.LIB.
|
|
If not, see <http://www.gnu.org/licenses/> or write to the
|
|
Free Software Foundation, 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __NSCalendar_h_GNUSTEP_BASE_INCLUDE
|
|
#define __NSCalendar_h_GNUSTEP_BASE_INCLUDE
|
|
|
|
#import <GNUstepBase/GSVersionMacros.h>
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST)
|
|
|
|
#include <Foundation/NSObject.h>
|
|
#include <Foundation/NSGeometry.h>
|
|
|
|
@class NSDate;
|
|
@class NSCalendar;
|
|
@class NSLocale;
|
|
@class NSString;
|
|
@class NSTimeZone;
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef NSUInteger NSCalendarUnit;
|
|
enum
|
|
{
|
|
NSEraCalendarUnit = (1UL << 1),
|
|
NSYearCalendarUnit = (1UL << 2),
|
|
NSMonthCalendarUnit = (1UL << 3),
|
|
NSDayCalendarUnit = (1UL << 4),
|
|
NSHourCalendarUnit = (1UL << 5),
|
|
NSMinuteCalendarUnit = (1UL << 6),
|
|
NSSecondCalendarUnit = (1UL << 7),
|
|
NSWeekCalendarUnit = (1UL << 8),
|
|
NSWeekdayCalendarUnit = (1UL << 9),
|
|
NSWeekdayOrdinalCalendarUnit = (1UL << 10),
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_6, GS_API_LATEST)
|
|
NSQuarterCalendarUnit = (1UL << 11),
|
|
#endif
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_7, GS_API_LATEST)
|
|
NSWeekOfMonthCalendarUnit = (1UL << 12),
|
|
NSWeekOfYearCalendarUnit = (1UL << 13),
|
|
NSYearForWeekOfYearCalendarUnit = (1UL << 14),
|
|
#endif
|
|
};
|
|
|
|
enum
|
|
{
|
|
NSWrapCalendarComponents = (1UL << 0)
|
|
};
|
|
|
|
enum
|
|
{
|
|
NSDateComponentUndefined = NSIntegerMax,
|
|
NSUndefinedDateComponent = NSDateComponentUndefined
|
|
};
|
|
|
|
|
|
|
|
@interface NSDateComponents : NSObject <NSCopying>
|
|
{
|
|
@private
|
|
void *_NSDateComponentsInternal;
|
|
/* FIXME ... remove dummy fields at next binary incompatible release
|
|
*/
|
|
void *_dummy1;
|
|
void *_dummy2;
|
|
void *_dummy3;
|
|
void *_dummy4;
|
|
void *_dummy5;
|
|
void *_dummy6;
|
|
void *_dummy7;
|
|
void *_dummy8;
|
|
void *_dummy9;
|
|
void *_dummy10;
|
|
void *_dummy11;
|
|
void *_dummy12;
|
|
}
|
|
|
|
- (NSInteger) day;
|
|
- (NSInteger) era;
|
|
- (NSInteger) hour;
|
|
- (NSInteger) minute;
|
|
- (NSInteger) month;
|
|
- (NSInteger) second;
|
|
- (NSInteger) week;
|
|
- (NSInteger) weekday;
|
|
- (NSInteger) weekdayOrdinal;
|
|
- (NSInteger) year;
|
|
|
|
- (void) setDay: (NSInteger) v;
|
|
- (void) setEra: (NSInteger) v;
|
|
- (void) setHour: (NSInteger) v;
|
|
- (void) setMinute: (NSInteger) v;
|
|
- (void) setMonth: (NSInteger) v;
|
|
- (void) setSecond: (NSInteger) v;
|
|
- (void) setWeek: (NSInteger) v;
|
|
- (void) setWeekday: (NSInteger) v;
|
|
- (void) setWeekdayOrdinal: (NSInteger) v;
|
|
- (void) setYear: (NSInteger) v;
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_6, GS_API_LATEST)
|
|
- (NSInteger) quarter;
|
|
- (void) setQuarter: (NSInteger) v;
|
|
#endif
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_7, GS_API_LATEST)
|
|
- (NSCalendar *) calendar;
|
|
- (NSTimeZone *) timeZone;
|
|
- (void) setCalendar: (NSCalendar *) cal;
|
|
- (void) setTimeZone: (NSTimeZone *) tz;
|
|
|
|
/**
|
|
* <p>
|
|
* Computes a date by using the components set in this NSDateComponents
|
|
* instance.
|
|
* </p>
|
|
* <p>
|
|
* A calendar (and optionally a time zone) must be set prior to
|
|
* calling this method.
|
|
* </p>
|
|
*/
|
|
- (NSDate *) date;
|
|
|
|
/** Returns the number of the week in this month. */
|
|
- (NSInteger) weekOfMonth;
|
|
/**
|
|
* Returns the number of the week in this year.
|
|
* Identical to calling <code>week</code>. */
|
|
- (NSInteger) weekOfYear;
|
|
/**
|
|
* The year corresponding to the current week.
|
|
* This value may differ from year around the end of the year.
|
|
*
|
|
* For example, for 2012-12-31, the year number is 2012, but
|
|
* yearForWeekOfYear is 2013, since it's already week 1 in 2013.
|
|
*/
|
|
- (NSInteger) yearForWeekOfYear;
|
|
|
|
/** Sets the number of the week in this month. */
|
|
- (void) setWeekOfMonth: (NSInteger) v;
|
|
|
|
/**
|
|
* Sets the number of the week in this year.
|
|
* Identical to calling <code>-setWeek</code>. */
|
|
- (void) setWeekOfYear: (NSInteger) v;
|
|
|
|
/**
|
|
* Sets the year number for the current week.
|
|
* See the explanation at <code>-yearForWeekOfYear</code>.
|
|
*/
|
|
- (void) setYearForWeekOfYear: (NSInteger) v;
|
|
|
|
#endif
|
|
@end
|
|
|
|
|
|
|
|
@interface NSCalendar : NSObject <NSCoding, NSCopying>
|
|
{
|
|
@private
|
|
void *_NSCalendarInternal;
|
|
/* FIXME ... remove dummy fields at next binary incompatible release
|
|
*/
|
|
void *_dummy1;
|
|
void *_dummy2;
|
|
void *_dummy3;
|
|
}
|
|
|
|
+ (id) currentCalendar;
|
|
|
|
- (id) initWithCalendarIdentifier: (NSString *) string;
|
|
- (NSString *) calendarIdentifier;
|
|
|
|
- (NSDateComponents *) components: (NSUInteger) unitFlags
|
|
fromDate: (NSDate *) date;
|
|
/**
|
|
* Compute the different between the specified components in the two dates.
|
|
* Values are summed up as long as now higher-granularity unit is specified.
|
|
* That means if you want to extract the year and the day from two dates
|
|
* which are 13 months + 1 day apart, you will get 1 as the result for the year
|
|
* but the rest of the difference in days. (29 <= x <= 32, depending on the
|
|
* month).
|
|
*
|
|
* Please note that the NSWrapCalendarComponents option that should affect the
|
|
* calculations is not presently supported.
|
|
*/
|
|
- (NSDateComponents *) components: (NSUInteger) unitFlags
|
|
fromDate: (NSDate *) startingDate
|
|
toDate: (NSDate *) resultDate
|
|
options: (NSUInteger) opts;
|
|
- (NSDate *) dateByAddingComponents: (NSDateComponents *) comps
|
|
toDate: (NSDate *) date
|
|
options: (NSUInteger) opts;
|
|
- (NSDate *) dateFromComponents: (NSDateComponents *) comps;
|
|
|
|
- (NSLocale *) locale;
|
|
- (void)setLocale: (NSLocale *) locale;
|
|
- (NSUInteger) firstWeekday;
|
|
- (void) setFirstWeekday: (NSUInteger) weekday;
|
|
- (NSUInteger) minimumDaysInFirstWeek;
|
|
- (void) setMinimumDaysInFirstWeek: (NSUInteger) mdw;
|
|
- (NSTimeZone *) timeZone;
|
|
- (void) setTimeZone: (NSTimeZone *) tz;
|
|
|
|
- (NSRange) maximumRangeOfUnit: (NSCalendarUnit) unit;
|
|
- (NSRange) minimumRangeofUnit: (NSCalendarUnit) unit;
|
|
- (NSUInteger) ordinalityOfUnit: (NSCalendarUnit) smaller
|
|
inUnit: (NSCalendarUnit) larger
|
|
forDate: (NSDate *) date;
|
|
- (NSRange) rangeOfUnit: (NSCalendarUnit) smaller
|
|
inUnit: (NSCalendarUnit) larger
|
|
forDate: (NSDate *) date;
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_5, GS_API_LATEST)
|
|
+ (id) autoupdatingCurrentCalendar;
|
|
|
|
- (BOOL) rangeOfUnit: (NSCalendarUnit) unit
|
|
startDate: (NSDate **) datep
|
|
interval: (NSTimeInterval *)tip
|
|
forDate: (NSDate *)date;
|
|
#endif
|
|
@end
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST) */
|
|
|
|
#endif /* __NSCalendar_h_GNUSTEP_BASE_INCLUDE */
|