DateTimeUtils.h

Go to the documentation of this file.

 
#ifndef __DATETIMEUTILS__
#define __DATETIMEUTILS__
 
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
  typedef SInt16 ToggleResults;
  enum
  {
    toggleUndefined = 0,
    toggleOK = 1,
    toggleBadField = 2,
    toggleBadDelta = 3,
    toggleBadChar = 4,
    toggleUnknown = 5,
    toggleBadNum = 6,
    toggleOutOfRange = 7, 
    toggleErr3 = 7,
    toggleErr4 = 8,
    toggleErr5 = 9
  };
 
  enum
  {
    smallDateBit = 31,     
    togChar12HourBit = 30, 
    togCharZCycleBit =
        29, 
    togDelta12HourBit =
        28,               
    genCdevRangeBit = 27, 
    validDateFields = -1,
    maxDateField = 10
  };
 
  enum
  {
    eraMask = 0x0001,
    yearMask = 0x0002,
    monthMask = 0x0004,
    dayMask = 0x0008,
    hourMask = 0x0010,
    minuteMask = 0x0020,
    secondMask = 0x0040,
    dayOfWeekMask = 0x0080,
    dayOfYearMask = 0x0100,
    weekOfYearMask = 0x0200,
    pmMask = 0x0400,
    dateStdMask =
        0x007F 
  };
 
  typedef SInt8 LongDateField;
  enum
  {
    eraField = 0,
    yearField = 1,
    monthField = 2,
    dayField = 3,
    hourField = 4,
    minuteField = 5,
    secondField = 6,
    dayOfWeekField = 7,
    dayOfYearField = 8,
    weekOfYearField = 9,
    pmField = 10,
    res1Field = 11,
    res2Field = 12,
    res3Field = 13
  };
 
  typedef SInt8 DateForm;
  enum
  {
    shortDate = 0,
    longDate = 1,
    abbrevDate = 2
  };
 
  enum
  {
    fatalDateTime =
        0x8000,        
    longDateFound = 1, 
    leftOverChars =
        2, 
    sepNotIntlSep =
        4, 
    fieldOrderNotIntl =
        8, 
    extraneousStrings =
        16, 
    tooManySeps =
        32, 
    sepNotConsistent =
        64, 
    tokenErr =
        0x8100, 
    cantReadUtilities = 0x8200,
    dateTimeNotFound = 0x8400,
    dateTimeInvalid = 0x8800
  };
 
  typedef short StringToDateStatus;
  typedef StringToDateStatus String2DateStatus;
  struct DateCacheRecord
  {
    short hidden[256]; 
  };
  typedef struct DateCacheRecord DateCacheRecord;
  typedef DateCacheRecord *DateCachePtr;
  struct DateTimeRec
  {
    short year;
    short month;
    short day;
    short hour;
    short minute;
    short second;
    short dayOfWeek;
  };
  typedef struct DateTimeRec DateTimeRec;
 
  typedef SInt64 LongDateTime;
  union LongDateCvt
  {
    SInt64 c;
    struct
    {
      UInt32 lHigh;
      UInt32 lLow;
    } hl;
  };
  typedef union LongDateCvt LongDateCvt;
  union LongDateRec
  {
    short era;        
    short year;       
    short month;      
    short day;        
    short hour;       
    short minute;     
    short second;     
    short dayOfWeek;  
    short dayOfYear;  
    short weekOfYear; 
    short pm;         
    short res;        
    short res;        
    short res;        
  } ld;               
  typedef union LongDateRec LongDateRec;
 
  typedef SInt8 DateDelta;
  struct TogglePB
  {
    long togFlags;   
    ResType amChars; 
    ResType pmChars; 
    long reserved[4];
  };
  typedef struct TogglePB TogglePB;
  void
  DateString(long dateTime, DateForm longFlag, Str255 result, Handle intlHandle);
 
  void
  TimeString(long dateTime, Boolean wantSeconds, Str255 result, Handle intlHandle);
 
  void
  LongDateString(const LongDateTime *dateTime, DateForm longFlag, Str255 result,
                 Handle intlHandle);
 
  void
  LongTimeString(const LongDateTime *dateTime, Boolean wantSeconds, Str255 result,
                 Handle intlHandle);
 
  OSErr
  InitDateCache(DateCachePtr theCache);
 
  StringToDateStatus
  StringToDate(Ptr textPtr, long textLen, DateCachePtr theCache, long *lengthUsed,
               LongDateRec *dateTime);
 
  StringToDateStatus
  StringToTime(Ptr textPtr, long textLen, DateCachePtr theCache, long *lengthUsed,
               LongDateRec *dateTime);
 
  void
  LongDateToSeconds(const LongDateRec *lDate, LongDateTime *lSecs);
 
  void
  LongSecondsToDate(const LongDateTime *lSecs, LongDateRec *lDate);
 
  ToggleResults
  ToggleDate(LongDateTime *lSecs, LongDateField field, DateDelta delta, short ch,
             const TogglePB *params);
 
  short
  ValidDate(const LongDateRec *vDate, long flags, LongDateTime *newSecs);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 ReadDateTime(__A0)
#endif
  OSErr
  ReadDateTime(unsigned long *time);
 
  secs = Time;
It is recommended that you obtain the value using the GetDateTime trap
rather than using the low-memory variable however, as it is possible that
low-memory variables may change in the future.
You can convert the secs value to a more understandable value (i.e., a
DateTimeRec ) via Secs2Date .
The ReadDateTime function may return a slightly more accurate value
since it is possible for the Time variable to lose seconds when interrupts
get disabled for very long.
Since the base date for the "raw seconds" value is 1/1/1904 and since secs
is a 32-bit value, you won't be able to calculate with dates beyond February
6, 2040.
</pre>
 * \copyright THINK Reference © 1991-1992 Symantec Corporation
             *    \non_carbon_cfm   in InterfaceLib 7.1 and later
 *    \carbon_lib        in CarbonLib 1.0 and later
 *    \mac_os_x         in version 10.0 and later
 */
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter GetDateTime(__A0)
#endif
void
GetDateTime(unsigned long *secs);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 SetDateTime(__D0)
#endif
OSErr
SetDateTime(unsigned long time);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter SetTime(__A0)
#endif
void
SetTime(const DateTimeRec *d);
 
GetTime(&now);
printf("Today is %d/%d/%d\n", now.month, now.day, now.year);
printf("The first day of the rest of your life. . . ");
</ pre>
            * \copyright THINK Reference © 1991 - 1992 Symantec Corporation
                                                      *    \non_carbon_cfm in InterfaceLib 7.1 and
    later
        *    \carbon_lib in CarbonLib 1.0 and
    later
        *    \mac_os_x in version 10.0 and
    later
            * /
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter GetTime(__A0)
#endif
        void
            GetTime(DateTimeRec *d);
 
void
DateToSeconds(const DateTimeRec *d, unsigned long *secs);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter SecondsToDate(__D0, __A0)
#endif
  void
  SecondsToDate(unsigned long secs, DateTimeRec *d);
 
#if CALL_NOT_IN_CARBON
  void
  IUDateString(long dateTime, DateForm longFlag, Str255 result);
 
  IUTimeString(nowNum, TRUE, nowStr); /* exclude seconds */
  DrawString("\pThe time is: ");
  DrawString(nowStr);
  </ pre>
              * \copyright THINK Reference © 1991 - 1992 Symantec Corporation
                                                        *    \non_carbon_cfm in InterfaceLib 7.1 and
      later
              *    \carbon_lib not available *    \mac_os_x not available *
          /
          void
              IUTimeString(long dateTime, Boolean wantSeconds, Str255 result);
 
  void
  IUDatePString(long dateTime, DateForm longFlag, Str255 result,
                Handle intlHandle);
 
  long nowNum;
  Str255 nowStr;
  Intl0Hndl i0h;                 /* handle to an Intl0Rec */
  i0h = (Intl0Hndl)IUGetIntl(0); /* get current settings */
  (*i0h)->timeCycle = 0;         /* 24-hr format */
  (*i0h)->timeFmt |= secLeadingZ | minLeadingZ | hrLeadingZ;
  </ pre>
              * \copyright THINK Reference © 1991 - 1992 Symantec Corporation
                                                        *    \non_carbon_cfm in InterfaceLib 7.1 and
      later
              *    \carbon_lib not available *    \mac_os_x not available *
          /
          void
              IUTimePString(long dateTime, Boolean wantSeconds, Str255 result,
                            Handle intlHandle);
 
  void
  IULDateString(LongDateTime *dateTime, DateForm longFlag, Str255 result,
                Handle intlHandle);
 
  void
  IULTimeString(LongDateTime *dateTime, Boolean wantSeconds, Str255 result,
                Handle intlHandle);
 
#endif /** CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON
#define DateString(dateTime, longFlag, result, intlHandle) \
  IUDatePString(dateTime, longFlag, result, intlHandle)
#define TimeString(dateTime, wantSeconds, result, intlHandle) \
  IUTimePString(dateTime, wantSeconds, result, intlHandle)
#define LongDateString(dateTime, longFlag, result, intlHandle) \
  IULDateString(dateTime, longFlag, result, intlHandle)
#define LongTimeString(dateTime, wantSeconds, result, intlHandle) \
  IULTimeString(dateTime, wantSeconds, result, intlHandle)
#endif /** CALL_NOT_IN_CARBON */
#if OLDROUTINENAMES
#define String2Date(textPtr, textLen, theCache, lengthUsed, dateTime) \
  StringToDate(textPtr, textLen, theCache, lengthUsed, dateTime)
#define String2Time(textPtr, textLen, theCache, lengthUsed, dateTime) \
  StringToTime(textPtr, textLen, theCache, lengthUsed, dateTime)
#define LongDate2Secs(lDate, lSecs) LongDateToSeconds(lDate, lSecs)
#define LongSecs2Date(lSecs, lDate) LongSecondsToDate(lSecs, lDate)
#define Date2Secs(d, secs) DateToSeconds(d, secs)
#define Secs2Date(secs, d) SecondsToDate(secs, d)
#endif /** OLDROUTINENAMES */
 
#if CALL_NOT_IN_CARBON
  void
  iudatestring(long dateTime, DateForm longFlag, char *result);
 
  void
  iudatepstring(long dateTime, DateForm longFlag, char *result,
                Handle intlHandle);
 
  void
  iutimestring(long dateTime, Boolean wantSeconds, char *result);
 
  void
  iutimepstring(long dateTime, Boolean wantSeconds, char *result,
                Handle intlHandle);
 
  void
  iuldatestring(LongDateTime *dateTime, DateForm longFlag, char *result,
                Handle intlHandle);
 
  void
  iultimestring(LongDateTime *dateTime, Boolean wantSeconds, char *result,
                Handle intlHandle);
 
#endif /** CALL_NOT_IN_CARBON */
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif            /** __DATETIMEUTILS__ */
* /*/*/ * /*/*/ * /*/*/