author | rubidium |
Thu, 01 Mar 2007 13:35:40 +0000 | |
changeset 6182 | 7337aca829f1 |
parent 6125 | a6fff965707c |
child 6248 | e4a2ed7e5613 |
permissions | -rw-r--r-- |
4261
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
1 |
/* $Id$ */ |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
2 |
|
6125
a6fff965707c
(svn r8862) -Cleanup: doxygen changes, again. Mostly @files missing tags and a few comments style.
belugas
parents:
5475
diff
changeset
|
3 |
/** @file date.h */ |
a6fff965707c
(svn r8862) -Cleanup: doxygen changes, again. Mostly @files missing tags and a few comments style.
belugas
parents:
5475
diff
changeset
|
4 |
|
4666
172a0cdf28a6
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4329
diff
changeset
|
5 |
#ifndef DATE_H |
172a0cdf28a6
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4329
diff
changeset
|
6 |
#define DATE_H |
172a0cdf28a6
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4329
diff
changeset
|
7 |
|
5469
7edfc643abbc
(svn r7751) -Codechange: move network_* to a new network map. Furthermore move the low level network functions to network/core, so they can be reused by the masterserver and website-serverlist-updater.
rubidium
parents:
4666
diff
changeset
|
8 |
#include "openttd.h" |
7edfc643abbc
(svn r7751) -Codechange: move network_* to a new network map. Furthermore move the low level network functions to network/core, so they can be reused by the masterserver and website-serverlist-updater.
rubidium
parents:
4666
diff
changeset
|
9 |
|
4261
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
10 |
/** |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
11 |
* 1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885. On |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
12 |
* an overflow the new day begun and 65535 / 885 = 74. |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
13 |
* 1 tick is approximately 30 ms. |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
14 |
* 1 day is thus about 2 seconds (74 * 30 = 2220) on a machine that can run OpenTTD normally |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
15 |
*/ |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
16 |
#define DAY_TICKS 74 |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
17 |
|
4322
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
18 |
/* |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
19 |
* ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR and DAYS_TILL_ORIGINAL_BASE_YEAR are |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
20 |
* primarily used for loading newgrf and savegame data and returning some |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
21 |
* newgrf (callback) functions that were in the original (TTD) inherited |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
22 |
* format, where '_date == 0' meant that it was 1920-01-01. |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
23 |
*/ |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
24 |
|
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
25 |
/** The minimum starting year/base year of the original TTD */ |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
26 |
#define ORIGINAL_BASE_YEAR 1920 |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
27 |
/** The maximum year of the original TTD */ |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
28 |
#define ORIGINAL_MAX_YEAR 2090 |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
29 |
|
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
30 |
/** |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
31 |
* The offset in days from the '_date == 0' till |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
32 |
* 'ConvertYMDToDate(ORIGINAL_BASE_YEAR, 0, 1)' |
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
33 |
*/ |
4326
2e2c9d21ed96
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4322
diff
changeset
|
34 |
#define DAYS_TILL_ORIGINAL_BASE_YEAR (365 * ORIGINAL_BASE_YEAR + ORIGINAL_BASE_YEAR / 4 - ORIGINAL_BASE_YEAR / 100 + ORIGINAL_BASE_YEAR / 400) |
4322
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
35 |
|
f40bbdf476b3
(svn r5975) -Cleanup: use ORIGINAL_BASE_YEAR & ORIGINAL_MAX_YEAR where the functions really depend on the original date format.
rubidium
parents:
4295
diff
changeset
|
36 |
/* The absolute minimum & maximum years in OTTD */ |
4326
2e2c9d21ed96
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4322
diff
changeset
|
37 |
#define MIN_YEAR 0 |
2e2c9d21ed96
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4322
diff
changeset
|
38 |
/* MAX_YEAR, nicely rounded value of the number of years that can |
2e2c9d21ed96
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4322
diff
changeset
|
39 |
* be encoded in a single 32 bits date, about 2^31 / 366 years. */ |
2e2c9d21ed96
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4322
diff
changeset
|
40 |
#define MAX_YEAR 5000000 |
4261
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
41 |
|
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
42 |
/* Year and Date are defined elsewhere */ |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
43 |
typedef uint8 Month; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
44 |
typedef uint8 Day; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
45 |
typedef uint16 DateFract; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
46 |
|
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
47 |
typedef struct YearMonthDay { |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
48 |
Year year; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
49 |
Month month; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
50 |
Day day; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
51 |
} YearMonthDay; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
52 |
|
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
53 |
extern Year _cur_year; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
54 |
extern Month _cur_month; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
55 |
extern Date _date; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
56 |
extern DateFract _date_fract; |
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
57 |
|
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
58 |
|
28670f743746
(svn r5887) -Cleanup: move date related functions, defines and variables to date.[ch]
rubidium
parents:
diff
changeset
|
59 |
void SetDate(Date date); |
4288
393de75451b1
(svn r5918) -Cleanup: rename ConvertDayToYMD/ConvertYMDToDay as they really convert a Date to/from a YearMonthDay.
rubidium
parents:
4286
diff
changeset
|
60 |
void ConvertDateToYMD(Date date, YearMonthDay *ymd); |
393de75451b1
(svn r5918) -Cleanup: rename ConvertDayToYMD/ConvertYMDToDay as they really convert a Date to/from a YearMonthDay.
rubidium
parents:
4286
diff
changeset
|
61 |
Date ConvertYMDToDate(Year year, Month month, Day day); |
4666
172a0cdf28a6
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4329
diff
changeset
|
62 |
|
172a0cdf28a6
(svn r6560) - Codechange: Minor fix; add missing #include guards and comments, and correct svn properties on bmp.[ch]
peter1138
parents:
4329
diff
changeset
|
63 |
#endif /* DATE_H */ |