CFDate.h

   1 /*
   2  * Copyright (c) 2012 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
  24 /*      CFDate.h
  25         Copyright (c) 1998-2012, Apple Inc. All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFDATE__)
  29 #define __COREFOUNDATION_CFDATE__ 1
  30
  31 #include <CoreFoundation/CFBase.h>
  32
  33 CF_IMPLICIT_BRIDGING_ENABLED
  34 CF_EXTERN_C_BEGIN
  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 CF_IMPLICIT_BRIDGING_DISABLED
  67
  68 typedef const struct __CFTimeZone * CFTimeZoneRef;
  69
  70 typedef struct {
  71     SInt32 year;
  72     SInt8 month;
  73     SInt8 day;
  74     SInt8 hour;
  75     SInt8 minute;
  76     double second;
  77 } CFGregorianDate;
  78
  79 typedef struct {
  80     SInt32 years;
  81     SInt32 months;
  82     SInt32 days;
  83     SInt32 hours;
  84     SInt32 minutes;
  85     double seconds;
  86 } CFGregorianUnits;
  87
  88 typedef CF_OPTIONS(CFOptionFlags, CFGregorianUnitFlags) {
  89     kCFGregorianUnitsYears = (1UL << 0),
  90     kCFGregorianUnitsMonths = (1UL << 1),
  91     kCFGregorianUnitsDays = (1UL << 2),
  92     kCFGregorianUnitsHours = (1UL << 3),
  93     kCFGregorianUnitsMinutes = (1UL << 4),
  94     kCFGregorianUnitsSeconds = (1UL << 5),
  95     kCFGregorianAllUnits = 0x00FFFFFF
  96 };
  97
  98 CF_EXPORT
  99 Boolean CFGregorianDateIsValid(CFGregorianDate gdate, CFOptionFlags unitFlags);
 100
 101 CF_EXPORT
 102 CFAbsoluteTime CFGregorianDateGetAbsoluteTime(CFGregorianDate gdate, CFTimeZoneRef tz);
 103
 104 CF_EXPORT
 105 CFGregorianDate CFAbsoluteTimeGetGregorianDate(CFAbsoluteTime at, CFTimeZoneRef tz);
 106
 107 CF_EXPORT
 108 CFAbsoluteTime CFAbsoluteTimeAddGregorianUnits(CFAbsoluteTime at, CFTimeZoneRef tz, CFGregorianUnits units);
 109
 110 CF_EXPORT
 111 CFGregorianUnits CFAbsoluteTimeGetDifferenceAsGregorianUnits(CFAbsoluteTime at1, CFAbsoluteTime at2, CFTimeZoneRef tz, CFOptionFlags unitFlags);
 112
 113 CF_EXPORT
 114 SInt32 CFAbsoluteTimeGetDayOfWeek(CFAbsoluteTime at, CFTimeZoneRef tz);
 115
 116 CF_EXPORT
 117 SInt32 CFAbsoluteTimeGetDayOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 118
 119 CF_EXPORT
 120 SInt32 CFAbsoluteTimeGetWeekOfYear(CFAbsoluteTime at, CFTimeZoneRef tz);
 121
 122 CF_EXTERN_C_END
 123
 124 #endif /* ! __COREFOUNDATION_CFDATE__ */
 125