CFDate.h

   1 /*
   2  * Copyright (c) 2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFDate.h
  24         Copyright (c) 1998-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFDATE__)
  28 #define __COREFOUNDATION_CFDATE__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31
  32 CF_EXTERN_C_BEGIN
  33
  34 typedef double CFTimeInterval;
  35 typedef CFTimeInterval CFAbsoluteTime;
  36 /* absolute time is the time interval since the reference date */
  37 /* the reference date (epoch) is 00:00:00 1 January 2001. */
  38
  39 CF_EXPORT
  40 CFAbsoluteTime CFAbsoluteTimeGetCurrent(void);
  41
  42 CF_EXPORT
  43 const CFTimeInterval kCFAbsoluteTimeIntervalSince1970;
  44 CF_EXPORT
  45 const CFTimeInterval kCFAbsoluteTimeIntervalSince1904;
  46
  47 typedef const struct __CFDate * CFDateRef;
  48
  49 CF_EXPORT
  50 CFTypeID CFDateGetTypeID(void);
  51
  52 CF_EXPORT
  53 CFDateRef CFDateCreate(CFAllocatorRef allocator, CFAbsoluteTime at);
  54
  55 CF_EXPORT
  56 CFAbsoluteTime CFDateGetAbsoluteTime(CFDateRef theDate);
  57
  58 CF_EXPORT
  59 CFTimeInterval CFDateGetTimeIntervalSinceDate(CFDateRef theDate, CFDateRef otherDate);
  60
  61 CF_EXPORT
  62 CFComparisonResult CFDateCompare(CFDateRef theDate, CFDateRef otherDate, void *context);
  63
  64 typedef const struct __CFTimeZone * CFTimeZoneRef;
  65
  66 typedef struct {
  67     SInt32 year;
  68     SInt8 month;
  69     SInt8 day;
  70     SInt8 hour;
  71     SInt8 minute;
  72     double second;
  73 } CFGregorianDate;
  74
  75 typedef struct {
  76     SInt32 years;
  77     SInt32 months;
  78     SInt32 days;
  79     SInt32 hours;
  80     SInt32 minutes;
  81     double seconds;
  82 } CFGregorianUnits;
  83
  84 enum {
  85     kCFGregorianUnitsYears = (1 << 0),
  86     kCFGregorianUnitsMonths = (1 << 1),
  87     kCFGregorianUnitsDays = (1 << 2),
  88     kCFGregorianUnitsHours = (1 << 3),
  89     kCFGregorianUnitsMinutes = (1 << 4),
  90     kCFGregorianUnitsSeconds = (1 << 5),
  91     kCFGregorianAllUnits = 0x00FFFFFF
  92 };
  93 typedef CFOptionFlags CFGregorianUnitFlags;
  94
  95 CF_EXPORT
  96 Boolean CFGregorianDateIsValid(CFGregorianDate gdate, CFOptionFlags unitFlags);
  97
  98 CF_EXPORT
  99 CFAbsoluteTime CFGregorianDateGetAbsoluteTime(CFGregorianDate gdate, CFTimeZoneRef tz);
 100
 101 CF_EXPORT
 102 CFGregorianDate CFAbsoluteTimeGetGregorianDate(CFAbsoluteTime at, CFTimeZoneRef tz);
 103
 104 CF_EXPORT
 105 CFAbsoluteTime CFAbsoluteTimeAddGregorianUnits(CFAbsoluteTime at, CFTimeZoneRef tz, CFGregorianUnits units);
 106
 107 CF_EXPORT
 108 CFGregorianUnits CFAbsoluteTimeGetDifferenceAsGregorianUnits(CFAbsoluteTime at1, CFAbsoluteTime at2, CFTimeZoneRef tz, CFOptionFlags unitFlags);
 109
 110 CF_EXPORT
 111 SInt32 CFAbsoluteTimeGetDayOfWeek(CFAbsoluteTime at, CFTimeZoneRef tz);
 112
 113 CF_EXPORT
 114 SInt32 CFAbsoluteTimeGetDayOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 115
 116 CF_EXPORT
 117 SInt32 CFAbsoluteTimeGetWeekOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 118
 119 CF_EXTERN_C_END
 120
 121 #endif /* ! __COREFOUNDATION_CFDATE__ */
 122