rubidium@4261: /* $Id$ */
rubidium@4261: 
rubidium@8636: /** @file date_type.h Types related to the dates in OpenTTD. */
belugas@6451: 
rubidium@8636: #ifndef DATE_TYPE_H
rubidium@8636: #define DATE_TYPE_H
rubidium@5720: 
rubidium@4261: /**
rubidium@4261:  * 1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885. On
rubidium@4261:  *                    an overflow the new day begun and 65535 / 885 = 74.
rubidium@4261:  * 1 tick is approximately 30 ms.
rubidium@4261:  * 1 day is thus about 2 seconds (74 * 30 = 2220) on a machine that can run OpenTTD normally
rubidium@4261:  */
rubidium@4261: #define DAY_TICKS 74
rubidium@4261: 
rubidium@4322: /*
rubidium@4322:  * ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR and DAYS_TILL_ORIGINAL_BASE_YEAR are
rubidium@4322:  * primarily used for loading newgrf and savegame data and returning some
rubidium@4322:  * newgrf (callback) functions that were in the original (TTD) inherited
rubidium@4322:  * format, where '_date == 0' meant that it was 1920-01-01.
rubidium@4322:  */
rubidium@4322: 
rubidium@4322: /** The minimum starting year/base year of the original TTD */
rubidium@4322: #define ORIGINAL_BASE_YEAR 1920
rubidium@4322: /** The maximum year of the original TTD */
rubidium@4322: #define ORIGINAL_MAX_YEAR 2090
rubidium@4322: 
rubidium@4322: /**
rubidium@4322:  * The offset in days from the '_date == 0' till
rubidium@4322:  * 'ConvertYMDToDate(ORIGINAL_BASE_YEAR, 0, 1)'
rubidium@4322:  */
rubidium@4326: #define DAYS_TILL_ORIGINAL_BASE_YEAR (365 * ORIGINAL_BASE_YEAR + ORIGINAL_BASE_YEAR / 4 - ORIGINAL_BASE_YEAR / 100 + ORIGINAL_BASE_YEAR / 400)
rubidium@4322: 
rubidium@4322: /* The absolute minimum & maximum years in OTTD */
rubidium@4326: #define MIN_YEAR 0
rubidium@4326: /* MAX_YEAR, nicely rounded value of the number of years that can
rubidium@4326:  * be encoded in a single 32 bits date, about 2^31 / 366 years. */
rubidium@4326: #define MAX_YEAR 5000000
rubidium@4261: 
rubidium@8636: typedef int32  Date;
rubidium@8636: typedef uint16 DateFract;
rubidium@8636: 
rubidium@8636: typedef int32  Year;
rubidium@4261: typedef uint8  Month;
rubidium@4261: typedef uint8  Day;
rubidium@4261: 
rubidium@6574: struct YearMonthDay {
rubidium@4261: 	Year  year;
frosch@11038: 	Month month; ///< 0 - 11
frosch@11038: 	Day   day;   ///< 1 - 31
rubidium@6574: };
rubidium@4261: 
rubidium@8636: static const Year INVALID_YEAR = -1;
rubidium@8636: static const Date INVALID_DATE = -1;
rubidium@4261: 
rubidium@8636: #endif /* DATE_TYPE_H */