1

/* $Id$ */

     2

     3

/** @file date.cpp Handling of dates in our native format and transforming them to something human readable. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "settings_type.h"

     9

#include "network/network.h"

    10

#include "network/network_data.h"

    11

#include "network/network_server.h"

    12

#include "currency.h"

    13

#include "window_func.h"

    14

#include "functions.h"

    15

#include "date_func.h"

    16

#include "vehicle_base.h"

    17

#include "debug.h"

    18

#include "rail_gui.h"

    19

#ifdef DEBUG_DUMP_COMMANDS

    20

#include "saveload.h"

    21

#endif

    22

    23

Year      _cur_year;

    24

Month     _cur_month;

    25

Date      _date;

    26

DateFract _date_fract;

    27

    28

    29

void SetDate(Date date)

    30

{

    31

	YearMonthDay ymd;

    32

    33

	_date = date;

    34

	ConvertDateToYMD(date, &ymd);

    35

	_cur_year = ymd.year;

    36

	_cur_month = ymd.month;

    37

#ifdef ENABLE_NETWORK

    38

	_network_last_advertise_frame = 0;

    39

	_network_need_advertise = true;

    40

#endif /* ENABLE_NETWORK */

    41

}

    42

    43

#define M(a, b) ((a << 5) | b)

    44

static const uint16 _month_date_from_year_day[] = {

    45

	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),

    46

	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),

    47

	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),

    48

	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),

    49

	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),

    50

	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),

    51

	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),

    52

	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),

    53

	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),

    54

	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),

    55

	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),

    56

	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),

    57

};

    58

#undef M

    59

    60

enum {

    61

	ACCUM_JAN = 0,

    62

	ACCUM_FEB = ACCUM_JAN + 31,

    63

	ACCUM_MAR = ACCUM_FEB + 29,

    64

	ACCUM_APR = ACCUM_MAR + 31,

    65

	ACCUM_MAY = ACCUM_APR + 30,

    66

	ACCUM_JUN = ACCUM_MAY + 31,

    67

	ACCUM_JUL = ACCUM_JUN + 30,

    68

	ACCUM_AUG = ACCUM_JUL + 31,

    69

	ACCUM_SEP = ACCUM_AUG + 31,

    70

	ACCUM_OCT = ACCUM_SEP + 30,

    71

	ACCUM_NOV = ACCUM_OCT + 31,

    72

	ACCUM_DEC = ACCUM_NOV + 30,

    73

};

    74

    75

static const uint16 _accum_days_for_month[] = {

    76

	ACCUM_JAN, ACCUM_FEB, ACCUM_MAR, ACCUM_APR,

    77

	ACCUM_MAY, ACCUM_JUN, ACCUM_JUL, ACCUM_AUG,

    78

	ACCUM_SEP, ACCUM_OCT, ACCUM_NOV, ACCUM_DEC,

    79

};

    80

    81

static inline bool IsLeapYear(Year yr)

    82

{

    83

	return yr % 4 == 0 && (yr % 100 != 0 || yr % 400 == 0);

    84

}

    85

    86

/**

    87

 * Converts a Date to a Year, Month & Day.

    88

 * @param date the date to convert from

    89

 * @param ymd  the year, month and day to write to

    90

 */

    91

void ConvertDateToYMD(Date date, YearMonthDay *ymd)

    92

{

    93

	/*

    94

	 * Year determination in multiple steps to account for leap

    95

	 * years. First do the large steps, then the smaller ones.

    96

	 */

    97

    98

	/* There are 97 leap years in 400 years */

    99

	Year yr = 400 * (date / (365 * 400 + 97));

   100

	int rem = date % (365 * 400 + 97);

   101

	uint16 x;

   102

   103

	if (rem >= 365 * 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 -= 365 * 100 + 25;

   108

   109

		/* There are 24 leap years in the next couple of 100 years */

   110

		yr += 100 * (rem / (365 * 100 + 24));

   111

		rem = (rem % (365 * 100 + 24));

   112

	}

   113

   114

	if (!IsLeapYear(yr) && rem >= 365 * 4) {

   115

		/* The first 4 year of the century are not always a leap year */

   116

		yr  += 4;

   117

		rem -= 365 * 4;

   118

	}

   119

   120

	/* There is 1 leap year every 4 years */

   121

	yr += 4 * (rem / (365 * 4 + 1));

   122

	rem = rem % (365 * 4 + 1);

   123

   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) ? 366 : 365)) {

   127

		rem -= IsLeapYear(yr) ? 366 : 365;

   128

		yr++;

   129

	}

   130

   131

	/* Skip the 29th of February in non-leap years */

   132

	if (!IsLeapYear(yr) && rem >= ACCUM_MAR - 1) rem++;

   133

   134

	ymd->year = yr;

   135

   136

	x = _month_date_from_year_day[rem];

   137

	ymd->month = x >> 5;

   138

	ymd->day = x & 0x1F;

   139

}

   140

   141

/**

   142

 * Converts a tupe 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

   146

 */

   147

Date ConvertYMDToDate(Year year, Month month, Day day)

   148

{

   149

	/*

   150

	 * Each passed leap year adds one day to the 'day count'.

   151

	 *

   152

	 * A special case for the year 0 as no year has been passed,

   153

	 * but '(year - 1) / 4' does not yield '-1' to counteract the

   154

	 * '+1' at the end of the formula as divisions round to zero.

   155

	 */

   156

	int nr_of_leap_years = (year == 0) ? 0 : ((year - 1) / 4 - (year - 1) / 100 + (year - 1) / 400 + 1);

   157

   158

	/* Day-offset in a leap year */

   159

	int days = _accum_days_for_month[month] + day - 1;

   160

   161

	/* Account for the missing of the 29th of February in non-leap years */

   162

	if (!IsLeapYear(year) && days >= ACCUM_MAR) days--;

   163

   164

	return year * 365 + nr_of_leap_years + days;

   165

}

   166

   167

/** Functions used by the IncreaseDate function */

   168

   169

extern void WaypointsDailyLoop();

   170

extern void ChatMessageDailyLoop();

   171

extern void EnginesDailyLoop();

   172

extern void DisasterDailyLoop();

   173

   174

extern void PlayersMonthlyLoop();

   175

extern void EnginesMonthlyLoop();

   176

extern void TownsMonthlyLoop();

   177

extern void IndustryMonthlyLoop();

   178

extern void StationMonthlyLoop();

   179

   180

extern void PlayersYearlyLoop();

   181

extern void TrainsYearlyLoop();

   182

extern void RoadVehiclesYearlyLoop();

   183

extern void AircraftYearlyLoop();

   184

extern void ShipsYearlyLoop();

   185

   186

extern void ShowEndGameChart();

   187

   188

   189

static const Month _autosave_months[] = {

   190

	 0, ///< never

   191

	 1, ///< every month

   192

	 3, ///< every 3 months

   193

	 6, ///< every 6 months

   194

	12, ///< every 12 months

   195

};

   196

   197

/**

   198

 * Runs the day_proc for every DAY_TICKS vehicle starting at daytick.

   199

 */

   200

static void RunVehicleDayProc(uint daytick)

   201

{

   202

	uint total = GetMaxVehicleIndex() + 1;

   203

	uint i;

   204

   205

	for (i = daytick; i < total; i += DAY_TICKS) {

   206

		Vehicle *v = GetVehicle(i);

   207

   208

		if (v->IsValid()) {

   209

			/* Call the 32-day callback if needed */

   210

			CheckVehicle32Day(v);

   211

			v->OnNewDay();

   212

		}

   213

	}

   214

}

   215

   216

void IncreaseDate()

   217

{

   218

	YearMonthDay ymd;

   219

   220

	if (_game_mode == GM_MENU) {

   221

		_tick_counter++;

   222

		return;

   223

	}

   224

   225

	RunVehicleDayProc(_date_fract);

   226

   227

	/* increase day, and check if a new day is there? */

   228

	_tick_counter++;

   229

   230

	_date_fract++;

   231

	if (_date_fract < DAY_TICKS) return;

   232

	_date_fract = 0;

   233

   234

	/* yeah, increase day counter and call various daily loops */

   235

	_date++;

   236

   237

	ChatMessageDailyLoop();

   238

   239

	DisasterDailyLoop();

   240

	WaypointsDailyLoop();

   241

   242

	if (_game_mode != GM_MENU) {

   243

		InvalidateWindowWidget(WC_STATUS_BAR, 0, 0);

   244

		EnginesDailyLoop();

   245

	}

   246

   247

	/* check if we entered a new month? */

   248

	ConvertDateToYMD(_date, &ymd);

   249

	if (ymd.month == _cur_month) return;

   250

	_cur_month = ymd.month;

   251

   252

	/* yes, call various monthly loops */

   253

	if (_game_mode != GM_MENU) {

   254

#ifdef DEBUG_DUMP_COMMANDS

   255

		char name[MAX_PATH];

   256

		snprintf(name, lengthof(name), "dmp_cmds_%d.sav", _date);

   257

		SaveOrLoad(name, SL_SAVE, AUTOSAVE_DIR);

   258

		DebugDumpCommands("ddc:save:%s\n", name);

   259

#endif /* DUMP_COMMANDS */

   260

		if (_opt.autosave != 0 && (_cur_month % _autosave_months[_opt.autosave]) == 0) {

   261

			_do_autosave = true;

   262

			RedrawAutosave();

   263

		}

   264

   265

		InvalidateWindowClasses(WC_CHEATS);

   266

		PlayersMonthlyLoop();

   267

		EnginesMonthlyLoop();

   268

		TownsMonthlyLoop();

   269

		IndustryMonthlyLoop();

   270

		StationMonthlyLoop();

   271

		if (_network_server) NetworkServerMonthlyLoop();

   272

	}

   273

   274

	/* check if we entered a new year? */

   275

	if (ymd.year == _cur_year) return;

   276

	_cur_year = ymd.year;

   277

   278

	/* yes, call various yearly loops */

   279

	PlayersYearlyLoop();

   280

	TrainsYearlyLoop();

   281

	RoadVehiclesYearlyLoop();

   282

	AircraftYearlyLoop();

   283

	ShipsYearlyLoop();

   284

	if (_network_server) NetworkServerYearlyLoop();

   285

   287

   288

	/* check if we reached end of the game */

   290

			ShowEndGameChart();

   291

	/* check if we reached the maximum year, decrement dates by a year */

   292

	} else if (_cur_year == MAX_YEAR + 1) {

   293

		Vehicle *v;

   294

		uint days_this_year;

   295

   296

		_cur_year--;

   297

		days_this_year = IsLeapYear(_cur_year) ? 366 : 365;

   298

		_date -= days_this_year;

   299

		FOR_ALL_VEHICLES(v) v->date_of_last_service -= days_this_year;

   300

   301

		/* Because the _date wraps here, and text-messages expire by game-days, we have to clean out

   302

		 *  all of them if the date is set back, else those messages will hang for ever */

   303

		InitChatMessage();

   304

	}

   305

   307

}