src/date.cpp

   1 /* $Id: date.cpp 25333 2013-06-08 13:22:06Z frosch $ */
   2
   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  */
   9
  10 /** @file date.cpp Handling of dates in our native format and transforming them to something human readable. */
  11
  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"
  23
  24 #include "safeguards.h"
  25
  26 Year      _cur_year;   ///< Current year, starting at 0
  27 Month     _cur_month;  ///< Current month (0..11)
  28 YearMonthDay _cur_date_ymd; ///< Current date as YearMonthDay struct
  29 Date      _date;       ///< Current date in days (day counter)
  30 DateFract _date_fract; ///< Fractional part of the day.
  31 uint16 _tick_counter;  ///< Ever incrementing (and sometimes wrapping) tick counter for setting off various events
  32
  33 /**
  34  * Set the date.
  35  * @param date  New date
  36  * @param fract The number of ticks that have passed on this date.
  37  */
  38 void SetDate(Date date, DateFract fract)
  39 {
  40         assert(fract < DAY_TICKS);
  41
  42         YearMonthDay ymd;
  43
  44         _date = date;
  45         _date_fract = fract;
  46         ConvertDateToYMD(date, &ymd);
  47         _cur_year = ymd.year;
  48         _cur_month = ymd.month;
  49         _cur_date_ymd = ymd;
  50 }
  51
  52 #define M(a, b) ((a << 5) | b)
  53 static const uint16 _month_date_from_year_day[] = {
  54         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),
  55         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),
  56         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),
  57         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),
  58         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),
  59         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),
  60         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),
  61         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),
  62         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),
  63         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),
  64         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),
  65         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),
  66 };
  67 #undef M
  68
  69 enum DaysTillMonth {
  70         ACCUM_JAN = 0,
  71         ACCUM_FEB = ACCUM_JAN + 31,
  72         ACCUM_MAR = ACCUM_FEB + 29,
  73         ACCUM_APR = ACCUM_MAR + 31,
  74         ACCUM_MAY = ACCUM_APR + 30,
  75         ACCUM_JUN = ACCUM_MAY + 31,
  76         ACCUM_JUL = ACCUM_JUN + 30,
  77         ACCUM_AUG = ACCUM_JUL + 31,
  78         ACCUM_SEP = ACCUM_AUG + 31,
  79         ACCUM_OCT = ACCUM_SEP + 30,
  80         ACCUM_NOV = ACCUM_OCT + 31,
  81         ACCUM_DEC = ACCUM_NOV + 30,
  82 };
  83
  84 /** Number of days to pass from the first day in the year before reaching the first of a month. */
  85 static const uint16 _accum_days_for_month[] = {
  86         ACCUM_JAN, ACCUM_FEB, ACCUM_MAR, ACCUM_APR,
  87         ACCUM_MAY, ACCUM_JUN, ACCUM_JUL, ACCUM_AUG,
  88         ACCUM_SEP, ACCUM_OCT, ACCUM_NOV, ACCUM_DEC,
  89 };
  90
  91 /**
  92  * Converts a Date to a Year, Month & Day.
  93  * @param date the date to convert from
  94  * @param ymd  the year, month and day to write to
  95  */
  96 void ConvertDateToYMD(Date date, YearMonthDay *ymd)
  97 {
  98         /* Year determination in multiple steps to account for leap
  99          * years. First do the large steps, then the smaller ones.
 100          */
 101
 102         /* There are 97 leap years in 400 years */
 103         Year yr = 400 * (date / (DAYS_IN_YEAR * 400 + 97));
 104         int rem = date % (DAYS_IN_YEAR * 400 + 97);
 105         uint16 x;
 106
 107         if (rem >= DAYS_IN_YEAR * 100 + 25) {
 108                 /* There are 25 leap years in the first 100 years after
 109                  * every 400th year, as every 400th year is a leap year */
 110                 yr  += 100;
 111                 rem -= DAYS_IN_YEAR * 100 + 25;
 112
 113                 /* There are 24 leap years in the next couple of 100 years */
 114                 yr += 100 * (rem / (DAYS_IN_YEAR * 100 + 24));
 115                 rem = (rem % (DAYS_IN_YEAR * 100 + 24));
 116         }
 117
 118         if (!IsLeapYear(yr) && rem >= DAYS_IN_YEAR * 4) {
 119                 /* The first 4 year of the century are not always a leap year */
 120                 yr  += 4;
 121                 rem -= DAYS_IN_YEAR * 4;
 122         }
 123
 124         /* There is 1 leap year every 4 years */
 125         yr += 4 * (rem / (DAYS_IN_YEAR * 4 + 1));
 126         rem = rem % (DAYS_IN_YEAR * 4 + 1);
 127
 128         /* The last (max 3) years to account for; the first one
 129          * can be, but is not necessarily a leap year */
 130         while (rem >= (IsLeapYear(yr) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR)) {
 131                 rem -= IsLeapYear(yr) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR;
 132                 yr++;
 133         }
 134
 135         /* Skip the 29th of February in non-leap years */
 136         if (!IsLeapYear(yr) && rem >= ACCUM_MAR - 1) rem++;
 137
 138         ymd->year = yr;
 139
 140         x = _month_date_from_year_day[rem];
 141         ymd->month = x >> 5;
 142         ymd->day = x & 0x1F;
 143 }
 144
 145 /**
 146  * Converts a tuple of Year, Month and Day to a Date.
 147  * @param year  is a number between 0..MAX_YEAR
 148  * @param month is a number between 0..11
 149  * @param day   is a number between 1..31
 150  */
 151 Date ConvertYMDToDate(Year year, Month month, Day day)
 152 {
 153         /* Day-offset in a leap year */
 154         int days = _accum_days_for_month[month] + day - 1;
 155
 156         /* Account for the missing of the 29th of February in non-leap years */
 157         if (!IsLeapYear(year) && days >= ACCUM_MAR) days--;
 158
 159         return DAYS_TILL(year) + days;
 160 }
 161
 162 /**
 163   * Converts the current day counter and date fraction into an absolute tick value.
 164   * @returns current time as ticks
 165   */
 166 Ticks GetCurrentTickCount()
 167 {
 168         return _date * DAY_TICKS + _date_fract;
 169 }
 170
 171
 172 /** Functions used by the IncreaseDate function */
 173
 174 extern void EnginesDailyLoop();
 175 extern void DisasterDailyLoop();
 176 extern void IndustryDailyLoop();
 177 extern void StationDailyLoop();
 178
 179 extern void CompaniesMonthlyLoop();
 180 extern void EnginesMonthlyLoop();
 181 extern void TownsMonthlyLoop();
 182 extern void IndustryMonthlyLoop();
 183 extern void StationMonthlyLoop();
 184 extern void SubsidyMonthlyLoop();
 185
 186 extern void CompaniesYearlyLoop();
 187 extern void VehiclesYearlyLoop();
 188 extern void TownsYearlyLoop();
 189
 190 extern void ShowEndGameChart();
 191
 192
 193 /** Available settings for autosave intervals. */
 194 static const Month _autosave_months[] = {
 195          0, ///< never
 196          1, ///< every month
 197          3, ///< every 3 months
 198          6, ///< every 6 months
 199         12, ///< every 12 months
 200 };
 201
 202 /**
 203  * Runs various procedures that have to be done yearly
 204  */
 205 static void OnNewYear()
 206 {
 207         CompaniesYearlyLoop();
 208         VehiclesYearlyLoop();
 209         TownsYearlyLoop();
 210         InvalidateWindowClassesData(WC_BUILD_STATION);
 211 #ifdef ENABLE_NETWORK
 212         if (_network_server) NetworkServerYearlyLoop();
 213 #endif /* ENABLE_NETWORK */
 214
 215         if (_cur_year == _settings_client.gui.semaphore_build_before) ResetSignalVariant();
 216
 217         /* check if we reached end of the game */
 218         if (_cur_year == ORIGINAL_END_YEAR) {
 219                 ShowEndGameChart();
 220         /* check if we reached the maximum year, decrement dates by a year */
 221         } else if (_cur_year == MAX_YEAR + 1) {
 222                 Vehicle *v;
 223                 int days_this_year;
 224
 225                 _cur_year--;
 226                 days_this_year = IsLeapYear(_cur_year) ? DAYS_IN_LEAP_YEAR : DAYS_IN_YEAR;
 227                 _date -= days_this_year;
 228                 FOR_ALL_VEHICLES(v) v->date_of_last_service -= days_this_year;
 229
 230                 LinkGraph *lg;
 231                 FOR_ALL_LINK_GRAPHS(lg) lg->ShiftDates(-days_this_year);
 232
 233 #ifdef ENABLE_NETWORK
 234                 /* Because the _date wraps here, and text-messages expire by game-days, we have to clean out
 235                  *  all of them if the date is set back, else those messages will hang for ever */
 236                 NetworkInitChatMessage();
 237 #endif /* ENABLE_NETWORK */
 238         }
 239
 240         if (_settings_client.gui.auto_euro) CheckSwitchToEuro();
 241 }
 242
 243 /**
 244  * Runs various procedures that have to be done monthly
 245  */
 246 static void OnNewMonth()
 247 {
 248         if (_settings_client.gui.autosave != 0 && (_cur_month % _autosave_months[_settings_client.gui.autosave]) == 0) {
 249                 _do_autosave = true;
 250                 SetWindowDirty(WC_STATUS_BAR, 0);
 251         }
 252
 253         SetWindowClassesDirty(WC_CHEATS);
 254         CompaniesMonthlyLoop();
 255         EnginesMonthlyLoop();
 256         TownsMonthlyLoop();
 257         IndustryMonthlyLoop();
 258         SubsidyMonthlyLoop();
 259         StationMonthlyLoop();
 260 #ifdef ENABLE_NETWORK
 261         if (_network_server) NetworkServerMonthlyLoop();
 262 #endif /* ENABLE_NETWORK */
 263 }
 264
 265 /**
 266  * Runs various procedures that have to be done daily
 267  */
 268 static void OnNewDay()
 269 {
 270 #ifdef ENABLE_NETWORK
 271         if (_network_server) NetworkServerDailyLoop();
 272 #endif /* ENABLE_NETWORK */
 273
 274         DisasterDailyLoop();
 275         IndustryDailyLoop();
 276         StationDailyLoop();
 277
 278         SetWindowWidgetDirty(WC_STATUS_BAR, 0, 0);
 279         EnginesDailyLoop();
 280
 281         /* Refresh after possible snowline change */
 282         SetWindowClassesDirty(WC_TOWN_VIEW);
 283 }
 284
 285 /**
 286  * Increases the tick counter, increases date  and possibly calls
 287  * procedures that have to be called daily, monthly or yearly.
 288  */
 289 void IncreaseDate()
 290 {
 291         /* increase day, and check if a new day is there? */
 292         _tick_counter++;
 293
 294         if (_game_mode == GM_MENU || _game_mode == GM_BOOTSTRAP) return;
 295
 296         _date_fract++;
 297         if (_date_fract < DAY_TICKS) return;
 298         _date_fract = 0;
 299
 300         /* increase day counter */
 301         _date++;
 302
 303         YearMonthDay ymd;
 304         ConvertDateToYMD(_date, &ymd);
 305
 306         /* check if we entered a new month? */
 307         bool new_month = ymd.month != _cur_month;
 308
 309         /* check if we entered a new year? */
 310         bool new_year = ymd.year != _cur_year;
 311
 312         /* update internal variables before calling the daily/monthly/yearly loops */
 313         _cur_date_ymd = ymd;
 314         _cur_month = ymd.month;
 315         _cur_year  = ymd.year;
 316
 317         /* yes, call various daily loops */
 318         OnNewDay();
 319
 320         /* yes, call various monthly loops */
 321         if (new_month) OnNewMonth();
 322
 323         /* yes, call various yearly loops */
 324         if (new_year) OnNewYear();
 325 }