Translations update
[openttd/fttd.git] / src / date.cpp
blob800e4faeaf6f199bdecd1032969b98f3385a874f
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file date.cpp Handling of dates in our native format and transforming them to something human readable. */
12 #include "stdafx.h"
13 #include "network/network.h"
14 #include "network/network_func.h"
15 #include "currency.h"
16 #include "window_func.h"
17 #include "settings_type.h"
18 #include "date_func.h"
19 #include "vehicle_base.h"
20 #include "rail_gui.h"
21 #include "linkgraph/linkgraph.h"
22 #include "saveload/saveload.h"
24 Year _cur_year; ///< Current year, starting at 0
25 Month _cur_month; ///< Current month (0..11)
26 Date _date; ///< Current date in days (day counter)
27 DateFract _date_fract; ///< Fractional part of the day.
28 uint16 _tick_counter; ///< Ever incrementing (and sometimes wrapping) tick counter for setting off various events
30 /**
31 * Set the date.
32 * @param date New date
33 * @param fract The number of ticks that have passed on this date.
35 void SetDate(Date date, DateFract fract)
37 assert(fract < DAY_TICKS);
39 YearMonthDay ymd;
41 _date = date;
42 _date_fract = fract;
43 ConvertDateToYMD(date, &ymd);
44 _cur_year = ymd.year;
45 _cur_month = ymd.month;
48 #define M(a, b) ((a << 5) | b)
49 static const uint16 _month_date_from_year_day[] = {
50 M( 0, 1), M( 0, 2), M( 0, 3), M( 0, 4), M( 0, 5), M( 0, 6), M( 0, 7), M( 0, 8), M( 0, 9), M( 0, 10), M( 0, 11), M( 0, 12), M( 0, 13), M( 0, 14), M( 0, 15), M( 0, 16), M( 0, 17), M( 0, 18), M( 0, 19), M( 0, 20), M( 0, 21), M( 0, 22), M( 0, 23), M( 0, 24), M( 0, 25), M( 0, 26), M( 0, 27), M( 0, 28), M( 0, 29), M( 0, 30), M( 0, 31),
51 M( 1, 1), M( 1, 2), M( 1, 3), M( 1, 4), M( 1, 5), M( 1, 6), M( 1, 7), M( 1, 8), M( 1, 9), M( 1, 10), M( 1, 11), M( 1, 12), M( 1, 13), M( 1, 14), M( 1, 15), M( 1, 16), M( 1, 17), M( 1, 18), M( 1, 19), M( 1, 20), M( 1, 21), M( 1, 22), M( 1, 23), M( 1, 24), M( 1, 25), M( 1, 26), M( 1, 27), M( 1, 28), M( 1, 29),
52 M( 2, 1), M( 2, 2), M( 2, 3), M( 2, 4), M( 2, 5), M( 2, 6), M( 2, 7), M( 2, 8), M( 2, 9), M( 2, 10), M( 2, 11), M( 2, 12), M( 2, 13), M( 2, 14), M( 2, 15), M( 2, 16), M( 2, 17), M( 2, 18), M( 2, 19), M( 2, 20), M( 2, 21), M( 2, 22), M( 2, 23), M( 2, 24), M( 2, 25), M( 2, 26), M( 2, 27), M( 2, 28), M( 2, 29), M( 2, 30), M( 2, 31),
53 M( 3, 1), M( 3, 2), M( 3, 3), M( 3, 4), M( 3, 5), M( 3, 6), M( 3, 7), M( 3, 8), M( 3, 9), M( 3, 10), M( 3, 11), M( 3, 12), M( 3, 13), M( 3, 14), M( 3, 15), M( 3, 16), M( 3, 17), M( 3, 18), M( 3, 19), M( 3, 20), M( 3, 21), M( 3, 22), M( 3, 23), M( 3, 24), M( 3, 25), M( 3, 26), M( 3, 27), M( 3, 28), M( 3, 29), M( 3, 30),
54 M( 4, 1), M( 4, 2), M( 4, 3), M( 4, 4), M( 4, 5), M( 4, 6), M( 4, 7), M( 4, 8), M( 4, 9), M( 4, 10), M( 4, 11), M( 4, 12), M( 4, 13), M( 4, 14), M( 4, 15), M( 4, 16), M( 4, 17), M( 4, 18), M( 4, 19), M( 4, 20), M( 4, 21), M( 4, 22), M( 4, 23), M( 4, 24), M( 4, 25), M( 4, 26), M( 4, 27), M( 4, 28), M( 4, 29), M( 4, 30), M( 4, 31),
55 M( 5, 1), M( 5, 2), M( 5, 3), M( 5, 4), M( 5, 5), M( 5, 6), M( 5, 7), M( 5, 8), M( 5, 9), M( 5, 10), M( 5, 11), M( 5, 12), M( 5, 13), M( 5, 14), M( 5, 15), M( 5, 16), M( 5, 17), M( 5, 18), M( 5, 19), M( 5, 20), M( 5, 21), M( 5, 22), M( 5, 23), M( 5, 24), M( 5, 25), M( 5, 26), M( 5, 27), M( 5, 28), M( 5, 29), M( 5, 30),
56 M( 6, 1), M( 6, 2), M( 6, 3), M( 6, 4), M( 6, 5), M( 6, 6), M( 6, 7), M( 6, 8), M( 6, 9), M( 6, 10), M( 6, 11), M( 6, 12), M( 6, 13), M( 6, 14), M( 6, 15), M( 6, 16), M( 6, 17), M( 6, 18), M( 6, 19), M( 6, 20), M( 6, 21), M( 6, 22), M( 6, 23), M( 6, 24), M( 6, 25), M( 6, 26), M( 6, 27), M( 6, 28), M( 6, 29), M( 6, 30), M( 6, 31),
57 M( 7, 1), M( 7, 2), M( 7, 3), M( 7, 4), M( 7, 5), M( 7, 6), M( 7, 7), M( 7, 8), M( 7, 9), M( 7, 10), M( 7, 11), M( 7, 12), M( 7, 13), M( 7, 14), M( 7, 15), M( 7, 16), M( 7, 17), M( 7, 18), M( 7, 19), M( 7, 20), M( 7, 21), M( 7, 22), M( 7, 23), M( 7, 24), M( 7, 25), M( 7, 26), M( 7, 27), M( 7, 28), M( 7, 29), M( 7, 30), M( 7, 31),
58 M( 8, 1), M( 8, 2), M( 8, 3), M( 8, 4), M( 8, 5), M( 8, 6), M( 8, 7), M( 8, 8), M( 8, 9), M( 8, 10), M( 8, 11), M( 8, 12), M( 8, 13), M( 8, 14), M( 8, 15), M( 8, 16), M( 8, 17), M( 8, 18), M( 8, 19), M( 8, 20), M( 8, 21), M( 8, 22), M( 8, 23), M( 8, 24), M( 8, 25), M( 8, 26), M( 8, 27), M( 8, 28), M( 8, 29), M( 8, 30),
59 M( 9, 1), M( 9, 2), M( 9, 3), M( 9, 4), M( 9, 5), M( 9, 6), M( 9, 7), M( 9, 8), M( 9, 9), M( 9, 10), M( 9, 11), M( 9, 12), M( 9, 13), M( 9, 14), M( 9, 15), M( 9, 16), M( 9, 17), M( 9, 18), M( 9, 19), M( 9, 20), M( 9, 21), M( 9, 22), M( 9, 23), M( 9, 24), M( 9, 25), M( 9, 26), M( 9, 27), M( 9, 28), M( 9, 29), M( 9, 30), M( 9, 31),
60 M(10, 1), M(10, 2), M(10, 3), M(10, 4), M(10, 5), M(10, 6), M(10, 7), M(10, 8), M(10, 9), M(10, 10), M(10, 11), M(10, 12), M(10, 13), M(10, 14), M(10, 15), M(10, 16), M(10, 17), M(10, 18), M(10, 19), M(10, 20), M(10, 21), M(10, 22), M(10, 23), M(10, 24), M(10, 25), M(10, 26), M(10, 27), M(10, 28), M(10, 29), M(10, 30),
61 M(11, 1), M(11, 2), M(11, 3), M(11, 4), M(11, 5), M(11, 6), M(11, 7), M(11, 8), M(11, 9), M(11, 10), M(11, 11), M(11, 12), M(11, 13), M(11, 14), M(11, 15), M(11, 16), M(11, 17), M(11, 18), M(11, 19), M(11, 20), M(11, 21), M(11, 22), M(11, 23), M(11, 24), M(11, 25), M(11, 26), M(11, 27), M(11, 28), M(11, 29), M(11, 30), M(11, 31),
63 #undef M
65 enum DaysTillMonth {
66 ACCUM_JAN = 0,
67 ACCUM_FEB = ACCUM_JAN + 31,
68 ACCUM_MAR = ACCUM_FEB + 29,
69 ACCUM_APR = ACCUM_MAR + 31,
70 ACCUM_MAY = ACCUM_APR + 30,
71 ACCUM_JUN = ACCUM_MAY + 31,
72 ACCUM_JUL = ACCUM_JUN + 30,
73 ACCUM_AUG = ACCUM_JUL + 31,
74 ACCUM_SEP = ACCUM_AUG + 31,
75 ACCUM_OCT = ACCUM_SEP + 30,
76 ACCUM_NOV = ACCUM_OCT + 31,
77 ACCUM_DEC = ACCUM_NOV + 30,
80 /** Number of days to pass from the first day in the year before reaching the first of a month. */
81 static const uint16 _accum_days_for_month[] = {
82 ACCUM_JAN, ACCUM_FEB, ACCUM_MAR, ACCUM_APR,
83 ACCUM_MAY, ACCUM_JUN, ACCUM_JUL, ACCUM_AUG,
84 ACCUM_SEP, ACCUM_OCT, ACCUM_NOV, ACCUM_DEC,
87 /**
88 * Converts a Date to a Year, Month & Day.
89 * @param date the date to convert from
90 * @param ymd the year, month and day to write to
92 void ConvertDateToYMD(Date date, YearMonthDay *ymd)
94 /* Year determination in multiple steps to account for leap
95 * years. First do the large steps, then the smaller ones.
98 /* There are 97 leap years in 400 years */
99 Year yr = 400 * (date / (DAYS_IN_YEAR * 400 + 97));
100 int rem = date % (DAYS_IN_YEAR * 400 + 97);
101 uint16 x;
103 if (rem >= DAYS_IN_YEAR * 100 + 25) {
104 /* There are 25 leap years in the first 100 years after
105 * every 400th year, as every 400th year is a leap year */
106 yr += 100;
107 rem -= DAYS_IN_YEAR * 100 + 25;
109 /* There are 24 leap years in the next couple of 100 years */
110 yr += 100 * (rem / (DAYS_IN_YEAR * 100 + 24));
111 rem = (rem % (DAYS_IN_YEAR * 100 + 24));
114 if (!IsLeapYear(yr) && rem >= DAYS_IN_YEAR * 4) {
115 /* The first 4 year of the century are not always a leap year */
116 yr += 4;
117 rem -= DAYS_IN_YEAR * 4;
120 /* There is 1 leap year every 4 years */
121 yr += 4 * (rem / (DAYS_IN_YEAR * 4 + 1));
122 rem = rem % (DAYS_IN_YEAR * 4 + 1);
124 /* The last (max 3) years to account for; the first one
125 * can be, but is not necessarily a leap year */
126 while (rem >= (IsLeapYear(yr) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR)) {
127 rem -= IsLeapYear(yr) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR;
128 yr++;
131 /* Skip the 29th of February in non-leap years */
132 if (!IsLeapYear(yr) && rem >= ACCUM_MAR - 1) rem++;
134 ymd->year = yr;
136 x = _month_date_from_year_day[rem];
137 ymd->month = x >> 5;
138 ymd->day = x & 0x1F;
142 * Converts a tuple of Year, Month and Day to a Date.
143 * @param year is a number between 0..MAX_YEAR
144 * @param month is a number between 0..11
145 * @param day is a number between 1..31
147 Date ConvertYMDToDate(Year year, Month month, Day day)
149 /* Day-offset in a leap year */
150 int days = _accum_days_for_month[month] + day - 1;
152 /* Account for the missing of the 29th of February in non-leap years */
153 if (!IsLeapYear(year) && days >= ACCUM_MAR) days--;
155 return DAYS_TILL(year) + days;
158 /** Functions used by the IncreaseDate function */
160 extern void EnginesDailyLoop();
161 extern void DisasterDailyLoop();
162 extern void IndustryDailyLoop();
164 extern void CompaniesMonthlyLoop();
165 extern void EnginesMonthlyLoop();
166 extern void TownsMonthlyLoop();
167 extern void IndustryMonthlyLoop();
168 extern void StationMonthlyLoop();
169 extern void SubsidyMonthlyLoop();
171 extern void CompaniesYearlyLoop();
172 extern void VehiclesYearlyLoop();
173 extern void TownsYearlyLoop();
175 extern void ShowEndGameChart();
178 /** Available settings for autosave intervals. */
179 static const Month _autosave_months[] = {
180 0, ///< never
181 1, ///< every month
182 3, ///< every 3 months
183 6, ///< every 6 months
184 12, ///< every 12 months
188 * Runs various procedures that have to be done yearly
190 static void OnNewYear()
192 CompaniesYearlyLoop();
193 VehiclesYearlyLoop();
194 TownsYearlyLoop();
195 InvalidateWindowClassesData(WC_BUILD_STATION);
196 #ifdef ENABLE_NETWORK
197 if (_network_server) NetworkServerYearlyLoop();
198 #endif /* ENABLE_NETWORK */
200 if (_cur_year == _settings_client.gui.semaphore_build_before) ResetSignalVariant();
202 /* check if we reached end of the game */
203 if (_cur_year == ORIGINAL_END_YEAR) {
204 ShowEndGameChart();
205 /* check if we reached the maximum year, decrement dates by a year */
206 } else if (_cur_year == MAX_YEAR + 1) {
207 Vehicle *v;
208 int days_this_year;
210 _cur_year--;
211 days_this_year = IsLeapYear(_cur_year) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR;
212 _date -= days_this_year;
213 FOR_ALL_VEHICLES(v) v->date_of_last_service -= days_this_year;
215 LinkGraph *lg;
216 FOR_ALL_LINK_GRAPHS(lg) lg->ShiftDates(-days_this_year);
218 #ifdef ENABLE_NETWORK
219 /* Because the _date wraps here, and text-messages expire by game-days, we have to clean out
220 * all of them if the date is set back, else those messages will hang for ever */
221 NetworkInitChatMessage();
222 #endif /* ENABLE_NETWORK */
225 if (_settings_client.gui.auto_euro) CheckSwitchToEuro();
229 * Runs various procedures that have to be done monthly
231 static void OnNewMonth()
233 if (_settings_client.gui.autosave != 0 && (_cur_month % _autosave_months[_settings_client.gui.autosave]) == 0) {
234 _do_autosave = true;
235 SetWindowDirty(WC_STATUS_BAR, 0);
238 SetWindowClassesDirty(WC_CHEATS);
239 CompaniesMonthlyLoop();
240 EnginesMonthlyLoop();
241 TownsMonthlyLoop();
242 IndustryMonthlyLoop();
243 SubsidyMonthlyLoop();
244 StationMonthlyLoop();
245 #ifdef ENABLE_NETWORK
246 if (_network_server) NetworkServerMonthlyLoop();
247 #endif /* ENABLE_NETWORK */
251 * Runs various procedures that have to be done daily
253 static void OnNewDay()
255 #ifdef ENABLE_NETWORK
256 if (_network_server) NetworkServerDailyLoop();
257 #endif /* ENABLE_NETWORK */
259 DisasterDailyLoop();
260 IndustryDailyLoop();
262 SetWindowWidgetDirty(WC_STATUS_BAR, 0, 0);
263 EnginesDailyLoop();
265 /* Refresh after possible snowline change */
266 SetWindowClassesDirty(WC_TOWN_VIEW);
270 * Increases the tick counter, increases date and possibly calls
271 * procedures that have to be called daily, monthly or yearly.
273 void IncreaseDate()
275 /* increase day, and check if a new day is there? */
276 _tick_counter++;
278 if (_game_mode == GM_MENU) return;
280 _date_fract++;
281 if (_date_fract < DAY_TICKS) return;
282 _date_fract = 0;
284 /* increase day counter */
285 _date++;
287 YearMonthDay ymd;
288 ConvertDateToYMD(_date, &ymd);
290 /* check if we entered a new month? */
291 bool new_month = ymd.month != _cur_month;
293 /* check if we entered a new year? */
294 bool new_year = ymd.year != _cur_year;
296 /* update internal variables before calling the daily/monthly/yearly loops */
297 _cur_month = ymd.month;
298 _cur_year = ymd.year;
300 /* yes, call various daily loops */
301 OnNewDay();
303 /* yes, call various monthly loops */
304 if (new_month) OnNewMonth();
306 /* yes, call various yearly loops */
307 if (new_year) OnNewYear();