src/Time/lowleveltime.h

   1 /* -*- Mode: C++ -*- *****************************************************
   2  * lowleveltime.h
   3  * Written by various people (I"ll look up the exact credits later)
   4  * Modified by Durk Talsma, July 1999 for use in FlightGear
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  *
  20  **************************************************************************/
  21
  22 /********************************************************************
  23  * This file redefines some low-level Unix-like time functions for  *
  24  * use with FlightGear. Most notably, localtime() is adapted to use *
  25  * a custom timezone, in order to get the 'local' time for a given  *
  26  * aircraft's position, and not only for the current location of the*
  27  * computer running the sim.                                        *
  28  *                                                                  *
  29  * Software adapted from glibc functions, by Durk Talsma. Started   *
  30  * July, 17, 1999.                                                  *
  31  ********************************************************************/
  32
  33 #ifndef _LOWLEVELTIME_H_
  34 #define _LOWLEVELTIME_H_
  35
  36 #include <time.h>
  37
  38 /* adapted from zdump.c */
  39 void show (const char *zone, time_t t, int v);
  40
  41 /* adapted from <time.h> */
  42 struct tm * fgLocaltime (const time_t *t, const char *tzName);
  43
  44 /* Prototype for the internal function to get information based on TZ.  */
  45 extern struct tm *fgtz_convert (const time_t *t, int use_localtime,
  46                                      struct tm *tp, const char *tzName);
  47
  48 /* This structure contains all the information about a
  49    timezone given in the POSIX standard TZ envariable.  */
  50 typedef struct
  51   {
  52     const char *name;
  53
  54     /* When to change.  */
  55     enum { J0, J1, M } type;    /* Interpretation of:  */
  56     unsigned short int m, n, d; /* Month, week, day.  */
  57     unsigned int secs;          /* Time of day.  */
  58
  59     long int offset;            /* Seconds east of GMT (west if < 0).  */
  60
  61     /* We cache the computed time of change for a
  62        given year so we don't have to recompute it.  */
  63     time_t change;      /* When to change to this zone.  */
  64     int computed_for;   /* Year above is computed for.  */
  65   } fgtz_rule;
  66
  67 struct tzhead {
  68         char    tzh_magic[4];           /* TZ_MAGIC */
  69         char    tzh_reserved[16];       /* reserved for future use */
  70         char    tzh_ttisgmtcnt[4];      /* coded number of trans. time flags */
  71         char    tzh_ttisstdcnt[4];      /* coded number of trans. time flags */
  72         char    tzh_leapcnt[4];         /* coded number of leap seconds */
  73         char    tzh_timecnt[4];         /* coded number of transition times */
  74         char    tzh_typecnt[4];         /* coded number of local time types */
  75         char    tzh_charcnt[4];         /* coded number of abbr. chars */
  76 };
  77
  78
  79 /* Defined in mktime.c.  */
  80 extern const unsigned short int mon_yday[2][13];
  81
  82 #ifndef TZDIR
  83 #define TZDIR   "/usr/local/etc/zoneinfo" /* Time zone object file directory */
  84 #endif /* !defined TZDIR */
  85
  86
  87
  88 #ifndef TZDEFAULT
  89 #define TZDEFAULT       "localtime"
  90 #endif /* !defined TZDEFAULT */
  91
  92 #define SECSPERMIN      60
  93 #define MINSPERHOUR     60
  94 #define HOURSPERDAY     24
  95 #define DAYSPERWEEK     7
  96 #define DAYSPERNYEAR    365
  97 #define DAYSPERLYEAR    366
  98 #define SECSPERHOUR     (SECSPERMIN * MINSPERHOUR)
  99 #define SECSPERDAY      ((long) SECSPERHOUR * HOURSPERDAY)
 100 #define MONSPERYEAR     12
 101
 102 #define TM_SUNDAY       0
 103 #define TM_MONDAY       1
 104 #define TM_TUESDAY      2
 105 #define TM_WEDNESDAY    3
 106 #define TM_THURSDAY     4
 107 #define TM_FRIDAY       5
 108 #define TM_SATURDAY     6
 109
 110 #define TM_JANUARY      0
 111 #define TM_FEBRUARY     1
 112 #define TM_MARCH        2
 113 #define TM_APRIL        3
 114 #define TM_MAY          4
 115 #define TM_JUNE         5
 116 #define TM_JULY         6
 117 #define TM_AUGUST       7
 118 #define TM_SEPTEMBER    8
 119 #define TM_OCTOBER      9
 120 #define TM_NOVEMBER     10
 121 #define TM_DECEMBER     11
 122
 123 #define TM_YEAR_BASE    1900
 124
 125 #define EPOCH_YEAR      1970
 126 #define EPOCH_WDAY      TM_THURSDAY
 127
 128 #endif