rubidium@4261: /* $Id$ */
rubidium@4261: 
belugas@6451: /** @file date.cpp */
belugas@6451: 
rubidium@4261: #include "stdafx.h"
rubidium@4261: #include "openttd.h"
rubidium@4261: #include "variables.h"
rubidium@8766: #include "settings_type.h"
rubidium@5720: #include "network/network.h"
rubidium@5720: #include "network/network_data.h"
rubidium@5720: #include "network/network_server.h"
rubidium@8627: #include "currency.h"
rubidium@8627: #include "window_func.h"
rubidium@4261: #include "functions.h"
rubidium@8636: #include "date_func.h"
rubidium@8640: #include "vehicle_base.h"
rubidium@8743: #include "debug.h"
smatz@9305: #include "rail_gui.h"
rubidium@7683: #ifdef DEBUG_DUMP_COMMANDS
rubidium@7683: #include "saveload.h"
rubidium@7683: #endif
rubidium@4261: 
rubidium@4261: Year      _cur_year;
rubidium@4261: Month     _cur_month;
rubidium@4261: Date      _date;
rubidium@4261: DateFract _date_fract;
rubidium@4261: 
rubidium@4261: 
rubidium@4261: void SetDate(Date date)
rubidium@4261: {
rubidium@4261: 	YearMonthDay ymd;
rubidium@4261: 
rubidium@4261: 	_date = date;
rubidium@4288: 	ConvertDateToYMD(date, &ymd);
rubidium@4261: 	_cur_year = ymd.year;
rubidium@4261: 	_cur_month = ymd.month;
rubidium@4261: #ifdef ENABLE_NETWORK
rubidium@4261: 	_network_last_advertise_frame = 0;
rubidium@4261: 	_network_need_advertise = true;
rubidium@4261: #endif /* ENABLE_NETWORK */
rubidium@4261: }
rubidium@4261: 
rubidium@4261: #define M(a, b) ((a << 5) | b)
rubidium@4261: static const uint16 _month_date_from_year_day[] = {
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4344: 	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),
rubidium@4261: };
rubidium@4261: #undef M
rubidium@4261: 
rubidium@4261: enum {
rubidium@4261: 	ACCUM_JAN = 0,
rubidium@4261: 	ACCUM_FEB = ACCUM_JAN + 31,
rubidium@4261: 	ACCUM_MAR = ACCUM_FEB + 29,
rubidium@4261: 	ACCUM_APR = ACCUM_MAR + 31,
rubidium@4261: 	ACCUM_MAY = ACCUM_APR + 30,
rubidium@4261: 	ACCUM_JUN = ACCUM_MAY + 31,
rubidium@4261: 	ACCUM_JUL = ACCUM_JUN + 30,
rubidium@4261: 	ACCUM_AUG = ACCUM_JUL + 31,
rubidium@4261: 	ACCUM_SEP = ACCUM_AUG + 31,
rubidium@4261: 	ACCUM_OCT = ACCUM_SEP + 30,
rubidium@4261: 	ACCUM_NOV = ACCUM_OCT + 31,
rubidium@4261: 	ACCUM_DEC = ACCUM_NOV + 30,
rubidium@4261: };
rubidium@4261: 
rubidium@4261: static const uint16 _accum_days_for_month[] = {
rubidium@4261: 	ACCUM_JAN, ACCUM_FEB, ACCUM_MAR, ACCUM_APR,
rubidium@4261: 	ACCUM_MAY, ACCUM_JUN, ACCUM_JUL, ACCUM_AUG,
rubidium@4261: 	ACCUM_SEP, ACCUM_OCT, ACCUM_NOV, ACCUM_DEC,
rubidium@4261: };
rubidium@4261: 
rubidium@4326: static inline bool IsLeapYear(Year yr)
rubidium@4326: {
rubidium@4326: 	return yr % 4 == 0 && (yr % 100 != 0 || yr % 400 == 0);
rubidium@4326: }
rubidium@4261: 
rubidium@4326: /**
rubidium@4326:  * Converts a Date to a Year, Month & Day.
rubidium@4326:  * @param date the date to convert from
rubidium@4326:  * @param ymd  the year, month and day to write to
rubidium@4326:  */
rubidium@4288: void ConvertDateToYMD(Date date, YearMonthDay *ymd)
rubidium@4261: {
rubidium@4326: 	/*
rubidium@4326: 	 * Year determination in multiple steps to account for leap
rubidium@4326: 	 * years. First do the large steps, then the smaller ones.
rubidium@4326: 	 */
rubidium@4261: 
rubidium@4326: 	/* There are 97 leap years in 400 years */
rubidium@4326: 	Year yr = 400 * (date / (365 * 400 + 97));
rubidium@4326: 	int rem = date % (365 * 400 + 97);
rubidium@4326: 	uint16 x;
rubidium@4326: 
rubidium@5713: 	if (rem >= 365 * 100 + 25) {
rubidium@5713: 		/* There are 25 leap years in the first 100 years after
rubidium@5713: 		 * every 400th year, as every 400th year is a leap year */
rubidium@5713: 		yr  += 100;
rubidium@5713: 		rem -= 365 * 100 + 25;
rubidium@5713: 
rubidium@5713: 		/* There are 24 leap years in the next couple of 100 years */
rubidium@5713: 		yr += 100 * (rem / (365 * 100 + 24));
rubidium@5713: 		rem = (rem % (365 * 100 + 24));
rubidium@5713: 	}
rubidium@5713: 
rubidium@5713: 	if (!IsLeapYear(yr) && rem >= 365 * 4) {
rubidium@5713: 		/* The first 4 year of the century are not always a leap year */
rubidium@5713: 		yr  += 4;
rubidium@5713: 		rem -= 365 * 4;
rubidium@5713: 	}
rubidium@4326: 
rubidium@4326: 	/* There is 1 leap year every 4 years */
rubidium@4326: 	yr += 4 * (rem / (365 * 4 + 1));
rubidium@4326: 	rem = rem % (365 * 4 + 1);
rubidium@4326: 
rubidium@4326: 	/* The last (max 3) years to account for; the first one
rubidium@4326: 	 * can be, but is not necessarily a leap year */
rubidium@4326: 	while (rem >= (IsLeapYear(yr) ? 366 : 365)) {
rubidium@4326: 		rem -= IsLeapYear(yr) ? 366 : 365;
rubidium@4326: 		yr++;
rubidium@4261: 	}
rubidium@4261: 
rubidium@4326: 	/* Skip the 29th of February in non-leap years */
rubidium@4326: 	if (!IsLeapYear(yr) && rem >= ACCUM_MAR - 1) rem++;
rubidium@4326: 
rubidium@4326: 	ymd->year = yr;
rubidium@4261: 
rubidium@4261: 	x = _month_date_from_year_day[rem];
rubidium@4261: 	ymd->month = x >> 5;
rubidium@4261: 	ymd->day = x & 0x1F;
rubidium@4261: }
rubidium@4261: 
rubidium@4261: /**
rubidium@4261:  * Converts a tupe of Year, Month and Day to a Date.
rubidium@4326:  * @param year  is a number between 0..MAX_YEAR
rubidium@4261:  * @param month is a number between 0..11
rubidium@4261:  * @param day   is a number between 1..31
rubidium@4261:  */
rubidium@4288: Date ConvertYMDToDate(Year year, Month month, Day day)
rubidium@4261: {
rubidium@4326: 	/*
rubidium@4326: 	 * Each passed leap year adds one day to the 'day count'.
rubidium@4326: 	 *
rubidium@4326: 	 * A special case for the year 0 as no year has been passed,
rubidium@4326: 	 * but '(year - 1) / 4' does not yield '-1' to counteract the
rubidium@4326: 	 * '+1' at the end of the formula as divisions round to zero.
rubidium@4326: 	 */
rubidium@4326: 	int nr_of_leap_years = (year == 0) ? 0 : ((year - 1) / 4 - (year - 1) / 100 + (year - 1) / 400 + 1);
rubidium@4261: 
rubidium@4326: 	/* Day-offset in a leap year */
rubidium@4326: 	int days = _accum_days_for_month[month] + day - 1;
rubidium@4261: 
rubidium@4326: 	/* Account for the missing of the 29th of February in non-leap years */
rubidium@4326: 	if (!IsLeapYear(year) && days >= ACCUM_MAR) days--;
rubidium@4261: 
rubidium@4326: 	return year * 365 + nr_of_leap_years + days;
rubidium@4261: }
rubidium@4261: 
rubidium@4261: /** Functions used by the IncreaseDate function */
rubidium@4261: 
rubidium@6573: extern void WaypointsDailyLoop();
rubidium@7950: extern void ChatMessageDailyLoop();
rubidium@6573: extern void EnginesDailyLoop();
rubidium@6573: extern void DisasterDailyLoop();
rubidium@4261: 
rubidium@6573: extern void PlayersMonthlyLoop();
rubidium@6573: extern void EnginesMonthlyLoop();
rubidium@6573: extern void TownsMonthlyLoop();
rubidium@6573: extern void IndustryMonthlyLoop();
rubidium@6573: extern void StationMonthlyLoop();
rubidium@4261: 
rubidium@6573: extern void PlayersYearlyLoop();
rubidium@6573: extern void TrainsYearlyLoop();
rubidium@6573: extern void RoadVehiclesYearlyLoop();
rubidium@6573: extern void AircraftYearlyLoop();
rubidium@6573: extern void ShipsYearlyLoop();
rubidium@4261: 
rubidium@6573: extern void ShowEndGameChart();
rubidium@4261: 
rubidium@4261: 
rubidium@4261: static const Month _autosave_months[] = {
belugas@6451: 	 0, ///< never
belugas@6451: 	 1, ///< every month
belugas@6451: 	 3, ///< every 3 months
belugas@6451: 	 6, ///< every 6 months
belugas@6451: 	12, ///< every 12 months
rubidium@4261: };
rubidium@4261: 
rubidium@4261: /**
rubidium@4261:  * Runs the day_proc for every DAY_TICKS vehicle starting at daytick.
rubidium@4261:  */
rubidium@4261: static void RunVehicleDayProc(uint daytick)
rubidium@4261: {
matthijs@5249: 	uint total = GetMaxVehicleIndex() + 1;
rubidium@4261: 	uint i;
rubidium@4261: 
rubidium@4261: 	for (i = daytick; i < total; i += DAY_TICKS) {
rubidium@4261: 		Vehicle *v = GetVehicle(i);
rubidium@4261: 
glx@8299: 		if (v->IsValid()) {
glx@8299: 			/* Call the 32-day callback if needed */
glx@8299: 			CheckVehicle32Day(v);
glx@8963: 			v->OnNewDay();
glx@8299: 		}
rubidium@4261: 	}
rubidium@4261: }
rubidium@4261: 
rubidium@6573: void IncreaseDate()
rubidium@4261: {
rubidium@4261: 	YearMonthDay ymd;
rubidium@4261: 
rubidium@4261: 	if (_game_mode == GM_MENU) {
rubidium@4261: 		_tick_counter++;
rubidium@4261: 		return;
rubidium@4261: 	}
rubidium@4261: 
rubidium@4261: 	RunVehicleDayProc(_date_fract);
rubidium@4261: 
rubidium@4261: 	/* increase day, and check if a new day is there? */
rubidium@4261: 	_tick_counter++;
rubidium@4261: 
rubidium@4261: 	_date_fract++;
rubidium@4261: 	if (_date_fract < DAY_TICKS) return;
rubidium@4261: 	_date_fract = 0;
rubidium@4261: 
rubidium@4261: 	/* yeah, increase day counter and call various daily loops */
rubidium@4261: 	_date++;
rubidium@4261: 
rubidium@7950: 	ChatMessageDailyLoop();
rubidium@4261: 
rubidium@4261: 	DisasterDailyLoop();
rubidium@4261: 	WaypointsDailyLoop();
rubidium@4261: 
rubidium@4261: 	if (_game_mode != GM_MENU) {
rubidium@4261: 		InvalidateWindowWidget(WC_STATUS_BAR, 0, 0);
rubidium@4261: 		EnginesDailyLoop();
rubidium@4261: 	}
rubidium@4261: 
rubidium@4261: 	/* check if we entered a new month? */
rubidium@4288: 	ConvertDateToYMD(_date, &ymd);
rubidium@4261: 	if (ymd.month == _cur_month) return;
rubidium@4261: 	_cur_month = ymd.month;
rubidium@4261: 
rubidium@4261: 	/* yes, call various monthly loops */
rubidium@4261: 	if (_game_mode != GM_MENU) {
rubidium@7683: #ifdef DEBUG_DUMP_COMMANDS
rubidium@7683: 		char name[MAX_PATH];
rubidium@7683: 		snprintf(name, lengthof(name), "dmp_cmds_%d.sav", _date);
rubidium@7683: 		SaveOrLoad(name, SL_SAVE, AUTOSAVE_DIR);
rubidium@8743: 		DebugDumpCommands("ddc:save:%s\n", name);
rubidium@7683: #endif /* DUMP_COMMANDS */
rubidium@4261: 		if (_opt.autosave != 0 && (_cur_month % _autosave_months[_opt.autosave]) == 0) {
rubidium@4261: 			_do_autosave = true;
rubidium@4261: 			RedrawAutosave();
rubidium@4261: 		}
rubidium@4261: 
truelight@7743: 		InvalidateWindowClasses(WC_CHEATS);
rubidium@4261: 		PlayersMonthlyLoop();
rubidium@4261: 		EnginesMonthlyLoop();
rubidium@4261: 		TownsMonthlyLoop();
rubidium@4261: 		IndustryMonthlyLoop();
rubidium@4261: 		StationMonthlyLoop();
rubidium@4261: 		if (_network_server) NetworkServerMonthlyLoop();
rubidium@4261: 	}
rubidium@4261: 
rubidium@4261: 	/* check if we entered a new year? */
rubidium@4261: 	if (ymd.year == _cur_year) return;
rubidium@4261: 	_cur_year = ymd.year;
rubidium@4261: 
rubidium@4261: 	/* yes, call various yearly loops */
rubidium@4261: 	PlayersYearlyLoop();
rubidium@4261: 	TrainsYearlyLoop();
rubidium@4261: 	RoadVehiclesYearlyLoop();
rubidium@4261: 	AircraftYearlyLoop();
rubidium@4261: 	ShipsYearlyLoop();
rubidium@4261: 	if (_network_server) NetworkServerYearlyLoop();
rubidium@4261: 
smatz@9305: 	if (_cur_year == _patches.semaphore_build_before) ResetSignalVariant();
smatz@9305: 
rubidium@4261: 	/* check if we reached end of the game */
rubidium@4293: 	if (_cur_year == _patches.ending_year) {
rubidium@4261: 			ShowEndGameChart();
rubidium@4261: 	/* check if we reached the maximum year, decrement dates by a year */
rubidium@4293: 	} else if (_cur_year == MAX_YEAR + 1) {
rubidium@4261: 		Vehicle *v;
rubidium@4326: 		uint days_this_year;
rubidium@4261: 
rubidium@4286: 		_cur_year--;
rubidium@4326: 		days_this_year = IsLeapYear(_cur_year) ? 366 : 365;
rubidium@4326: 		_date -= days_this_year;
rubidium@4326: 		FOR_ALL_VEHICLES(v) v->date_of_last_service -= days_this_year;
rubidium@4261: 
rubidium@4261: 		/* Because the _date wraps here, and text-messages expire by game-days, we have to clean out
rubidium@4261: 		 *  all of them if the date is set back, else those messages will hang for ever */
rubidium@7950: 		InitChatMessage();
rubidium@4261: 	}
rubidium@4261: 
rubidium@4261: 	if (_patches.auto_euro) CheckSwitchToEuro();
rubidium@4261: }