NumberDate.subproj/CFDate.h

   1 /*
   2  * Copyright (c) 2005 Apple Computer, 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-2005, 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 #if defined(__cplusplus)
  33 extern "C" {
  34 #endif
  35
  36 typedef double CFTimeInterval;
  37 typedef CFTimeInterval CFAbsoluteTime;
  38 /* absolute time is the time interval since the reference date */
  39 /* the reference date (epoch) is 00:00:00 1 January 2001. */
  40
  41 CF_EXPORT
  42 CFAbsoluteTime CFAbsoluteTimeGetCurrent(void);
  43
  44 CF_EXPORT
  45 const CFTimeInterval kCFAbsoluteTimeIntervalSince1970;
  46 CF_EXPORT
  47 const CFTimeInterval kCFAbsoluteTimeIntervalSince1904;
  48
  49 typedef const struct __CFDate * CFDateRef;
  50
  51 CF_EXPORT
  52 CFTypeID CFDateGetTypeID(void);
  53
  54 CF_EXPORT
  55 CFDateRef CFDateCreate(CFAllocatorRef allocator, CFAbsoluteTime at);
  56
  57 CF_EXPORT
  58 CFAbsoluteTime CFDateGetAbsoluteTime(CFDateRef theDate);
  59
  60 CF_EXPORT
  61 CFTimeInterval CFDateGetTimeIntervalSinceDate(CFDateRef theDate, CFDateRef otherDate);
  62
  63 CF_EXPORT
  64 CFComparisonResult CFDateCompare(CFDateRef theDate, CFDateRef otherDate, void *context);
  65
  66 typedef const struct __CFTimeZone * CFTimeZoneRef;
  67
  68 typedef struct {
  69     SInt32 year;
  70     SInt8 month;
  71     SInt8 day;
  72     SInt8 hour;
  73     SInt8 minute;
  74     double second;
  75 } CFGregorianDate;
  76
  77 typedef struct {
  78     SInt32 years;
  79     SInt32 months;
  80     SInt32 days;
  81     SInt32 hours;
  82     SInt32 minutes;
  83     double seconds;
  84 } CFGregorianUnits;
  85
  86 typedef enum {
  87     kCFGregorianUnitsYears = (1 << 0),
  88     kCFGregorianUnitsMonths = (1 << 1),
  89     kCFGregorianUnitsDays = (1 << 2),
  90     kCFGregorianUnitsHours = (1 << 3),
  91     kCFGregorianUnitsMinutes = (1 << 4),
  92     kCFGregorianUnitsSeconds = (1 << 5),
  93 #if 0
  94     kCFGregorianUnitsTimeZone = (1 << 8),
  95     kCFGregorianUnitsDayOfWeek = (1 << 9),
  96 #endif
  97     kCFGregorianAllUnits = 0x00FFFFFF
  98 } CFGregorianUnitFlags;
  99
 100 CF_EXPORT
 101 Boolean CFGregorianDateIsValid(CFGregorianDate gdate, CFOptionFlags unitFlags);
 102
 103 CF_EXPORT
 104 CFAbsoluteTime CFGregorianDateGetAbsoluteTime(CFGregorianDate gdate, CFTimeZoneRef tz);
 105
 106 CF_EXPORT
 107 CFGregorianDate CFAbsoluteTimeGetGregorianDate(CFAbsoluteTime at, CFTimeZoneRef tz);
 108
 109 CF_EXPORT
 110 CFAbsoluteTime CFAbsoluteTimeAddGregorianUnits(CFAbsoluteTime at, CFTimeZoneRef tz, CFGregorianUnits units);
 111
 112 CF_EXPORT
 113 CFGregorianUnits CFAbsoluteTimeGetDifferenceAsGregorianUnits(CFAbsoluteTime at1, CFAbsoluteTime at2, CFTimeZoneRef tz, CFOptionFlags unitFlags);
 114
 115 CF_EXPORT
 116 SInt32 CFAbsoluteTimeGetDayOfWeek(CFAbsoluteTime at, CFTimeZoneRef tz);
 117
 118 CF_EXPORT
 119 SInt32 CFAbsoluteTimeGetDayOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 120
 121 CF_EXPORT
 122 SInt32 CFAbsoluteTimeGetWeekOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 123
 124 #if defined(__cplusplus)
 125 }
 126 #endif
 127
 128 #endif /* ! __COREFOUNDATION_CFDATE__ */
 129