1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "table/strings.h"

     6

#include "table/sprites.h"

     7

#include "functions.h"

     8

#include "window.h"

     9

#include "gui.h"

    10

#include "gfx.h"

    11

#include "player.h"

    12

#include "economy.h"

    13

#include "variables.h"

    14

#include "date.h"

    15

#include "helpers.hpp"

    16

    17

const byte _cargo_colours[NUM_CARGO] = {152, 32, 15, 174, 208, 194, 191, 84, 184, 10, 202, 48};

    18

    19

/* Bitmasks of player and cargo indices that shouldn't be drawn. */

    20

static uint _legend_excluded_players;

    21

static uint _legend_excluded_cargo;

    22

    23

/************************/

    24

/* GENERIC GRAPH DRAWER */

    25

/************************/

    26

    27

enum {

    28

	GRAPH_MAX_DATASETS = 16,

    29

	GRAPH_AXIS_LABEL_COLOUR = 16,

    30

	GRAPH_AXIS_LINE_COLOUR  = 215,

    31

    32

	GRAPH_X_POSITION_BEGINNING  = 44,  // Start the graph 44 pixels from gw->left

    33

	GRAPH_X_POSITION_SEPARATION = 22,  // There are 22 pixels between each X value

    34

    35

	/* How many horizontal lines to draw. 9 is convenient as that means the

    36

	 * distance between them is the height of the graph / 8, which is the same

    37

	 * as height >> 3. */

    38

	GRAPH_NUM_LINES_Y = 9,

    39

};

    40

    41

/* Apparently these don't play well with enums. */

    43

static const uint  INVALID_DATAPOINT_POS = UINT_MAX;  // Used to determine if the previous point was drawn.

    44

    45

typedef struct GraphDrawer {

    46

	uint excluded_data; // bitmask of the datasets that shouldn't be displayed.

    47

	byte num_dataset;

    48

	byte num_on_x_axis;

    49

	bool has_negative_values;

    50

	byte num_vert_lines;

    51

    52

	/* The starting month and year that values are plotted against. If month is

    53

	 * 0xFF, use x_values_start and x_values_increment below instead. */

    54

	byte month;

    55

	Year year;

    56

    57

	/* These values are used if the graph is being plotted against values

    58

	 * rather than the dates specified by month and year. */

    59

	uint16 x_values_start;

    60

	uint16 x_values_increment;

    61

    62

	int left, top;  // Where to start drawing the graph, in pixels.

    63

	uint height;    // The height of the graph in pixels.

    64

	StringID format_str_y_axis;

    65

	byte colors[GRAPH_MAX_DATASETS];

    66

	int64 cost[GRAPH_MAX_DATASETS][24]; // last 2 years

    67

} GraphDrawer;

    68

    69

static void DrawGraph(const GraphDrawer *gw)

    70

{

    71

	uint x, y;            // Reused whenever x and y coordinates are needed.

    72

	int64 highest_value;  // Highest value to be drawn.

    73

	int x_axis_offset;    // Distance from the top of the graph to the x axis.

    74

    75

	/* the colors and cost array of GraphDrawer must accomodate

    76

	 * both values for cargo and players. So if any are higher, quit */

    77

	assert(GRAPH_MAX_DATASETS >= (int)NUM_CARGO && GRAPH_MAX_DATASETS >= (int)MAX_PLAYERS);

    78

	assert(gw->num_vert_lines > 0);

    79

    80

	byte grid_colour = _colour_gradient[14][4];

    81

    82

	/* The coordinates of the opposite edges of the graph. */

    83

	int bottom = gw->top + gw->height - 1;

    84

	int right  = gw->left + GRAPH_X_POSITION_BEGINNING + gw->num_vert_lines * GRAPH_X_POSITION_SEPARATION - 1;

    85

    86

	/* Draw the vertical grid lines. */

    87

    88

	/* Don't draw the first line, as that's where the axis will be. */

    89

	x = gw->left + GRAPH_X_POSITION_BEGINNING + GRAPH_X_POSITION_SEPARATION;

    90

    91

	for (int i = 0; i < gw->num_vert_lines; i++) {

    92

		GfxFillRect(x, gw->top, x, bottom, grid_colour);

    93

		x += GRAPH_X_POSITION_SEPARATION;

    94

	}

    95

    96

	/* Draw the horizontal grid lines. */

    97

	x = gw->left + GRAPH_X_POSITION_BEGINNING;

    98

	y = gw->height + gw->top;

    99

   100

	for (int i = 0; i < GRAPH_NUM_LINES_Y; i++) {

   101

		GfxFillRect(x, y, right, y, grid_colour);

   102

		y -= (gw->height / (GRAPH_NUM_LINES_Y - 1));

   103

	}

   104

   105

	/* Draw the y axis. */

   106

	GfxFillRect(x, gw->top, x, bottom, GRAPH_AXIS_LINE_COLOUR);

   107

   108

	/* Find the distance from the top of the graph to the x axis. */

   109

	x_axis_offset = gw->height;

   110

   111

	/* The graph is currently symmetrical about the x axis. */

   112

	if (gw->has_negative_values) x_axis_offset /= 2;

   113

   114

	/* Draw the x axis. */

   115

	y = x_axis_offset + gw->top;

   116

	GfxFillRect(x, y, right, y, GRAPH_AXIS_LINE_COLOUR);

   117

   118

	/* Find the largest value that will be drawn. */

   119

	if (gw->num_on_x_axis == 0)

   120

		return;

   121

   122

	assert(gw->num_on_x_axis > 0);

   123

	assert(gw->num_dataset > 0);

   124

   125

	/* Start of with a value of twice the height of the graph in pixels. It's a

   126

	 * bit arbitrary, but it makes the cargo payment graph look a little nicer,

   127

	 * and prevents division by zero when calculating where the datapoint

   128

	 * should be drawn. */

   129

	highest_value = x_axis_offset * 2;

   130

   131

	for (int i = 0; i < gw->num_dataset; i++) {

   132

		if (!HASBIT(gw->excluded_data, i)) {

   133

			for (int j = 0; j < gw->num_on_x_axis; j++) {

   134

				int64 datapoint = gw->cost[i][j];

   135

   136

				if (datapoint != INVALID_DATAPOINT) {

   137

					/* For now, if the graph has negative values the scaling is

   138

					 * symmetrical about the x axis, so take the absolute value

   139

					 * of each data point. */

   140

					highest_value = max(highest_value, myabs(datapoint));

   141

				}

   142

			}

   143

		}

   144

	}

   145

   146

	/* Round up highest_value so that it will divide cleanly into the number of

   147

	 * axis labels used. */

   148

	int round_val = highest_value % (GRAPH_NUM_LINES_Y - 1);

   149

	if (round_val != 0) highest_value += (GRAPH_NUM_LINES_Y - 1 - round_val);

   150

   151

	/* draw text strings on the y axis */

   152

	int64 y_label = highest_value;

   153

	int64 y_label_separation = highest_value / (GRAPH_NUM_LINES_Y - 1);

   154

   155

	/* If there are negative values, the graph goes from highest_value to

   156

	 * -highest_value, not highest_value to 0. */

   157

	if (gw->has_negative_values) y_label_separation *= 2;

   158

   159

	x = gw->left + GRAPH_X_POSITION_BEGINNING + 1;

   160

	y = gw->top - 3;

   161

   162

	for (int i = 0; i < GRAPH_NUM_LINES_Y; i++) {

   163

		SetDParam(0, gw->format_str_y_axis);

   164

		SetDParam64(1, y_label);

   165

		DrawStringRightAligned(x, y, STR_0170, GRAPH_AXIS_LABEL_COLOUR);

   166

   167

		y_label -= y_label_separation;

   168

		y += (gw->height / (GRAPH_NUM_LINES_Y - 1));

   169

	}

   170

   171

	/* draw strings on the x axis */

   172

	if (gw->month != 0xFF) {

   173

		x = gw->left + GRAPH_X_POSITION_BEGINNING;

   174

		y = gw->top + gw->height + 1;

   175

		byte month = gw->month;

   176

		Year year  = gw->year;

   177

		for (int i = 0; i < gw->num_on_x_axis; i++) {

   178

			SetDParam(0, month + STR_0162_JAN);

   179

			SetDParam(1, month + STR_0162_JAN + 2);

   180

			SetDParam(2, year);

   181

			DrawString(x, y, month == 0 ? STR_016F : STR_016E, GRAPH_AXIS_LABEL_COLOUR);

   182

   183

			month += 3;

   184

			if (month >= 12) {

   185

				month = 0;

   186

				year++;

   187

			}

   188

			x += GRAPH_X_POSITION_SEPARATION;

   189

		}

   190

	} else {

   191

		/* Draw the label under the data point rather than on the grid line. */

   192

		x = gw->left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2) + 1;

   193

		y = gw->top + gw->height + 1;

   194

		uint16 label = gw->x_values_start;

   195

   196

		for (int i = 0; i < gw->num_on_x_axis; i++) {

   197

			SetDParam(0, label);

   198

			DrawStringCentered(x, y, STR_01CB, GRAPH_AXIS_LABEL_COLOUR);

   199

   200

			label += gw->x_values_increment;

   201

			x += GRAPH_X_POSITION_SEPARATION;

   202

		}

   203

	}

   204

   205

	/* draw lines and dots */

   206

	for (int i = 0; i < gw->num_dataset; i++) {

   207

		if (!HASBIT(gw->excluded_data, i)) {

   208

			/* Centre the dot between the grid lines. */

   209

			x = gw->left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2);

   210

   211

			byte color  = gw->colors[i];

   212

			uint prev_x = INVALID_DATAPOINT_POS;

   213

			uint prev_y = INVALID_DATAPOINT_POS;

   214

   215

			for (int j = 0; j < gw->num_on_x_axis; j++) {

   216

				int64 datapoint = gw->cost[i][j];

   217

   218

				if (datapoint != INVALID_DATAPOINT) {

   219

					/* XXX: This can overflow if x_axis_offset * datapoint is

   220

					 * too big to fit in an int64. */

   221

					y = gw->top + x_axis_offset - (x_axis_offset * datapoint) / highest_value;

   222

   223

					/* Draw the point. */

   224

					GfxFillRect(x-1, y-1, x+1, y+1, color);

   225

   226

					/* Draw the line connected to the previous point. */

   227

					if (prev_x != INVALID_DATAPOINT_POS) GfxDrawLine(prev_x, prev_y, x, y, color);

   228

   229

					prev_x = x;

   230

					prev_y = y;

   231

				} else {

   232

					prev_x = INVALID_DATAPOINT_POS;

   233

					prev_y = INVALID_DATAPOINT_POS;

   234

				}

   235

   236

				x += GRAPH_X_POSITION_SEPARATION;

   237

			}

   238

		}

   239

	}

   240

}

   241

   242

/****************/

   243

/* GRAPH LEGEND */

   244

/****************/

   245

   246

static void GraphLegendWndProc(Window *w, WindowEvent *e)

   247

{

   248

	const Player* p;

   249

   250

	switch (e->event) {

   251

	case WE_CREATE: {

   252

		uint i;

   253

		for (i = 3; i < w->widget_count; i++) {

   254

			if (!HASBIT(_legend_excluded_players, i - 3)) LowerWindowWidget(w, i);

   255

		}

   256

		break;

   257

	}

   258

   259

	case WE_PAINT:

   260

		FOR_ALL_PLAYERS(p) {

   261

			if (!p->is_active) {

   262

				SETBIT(_legend_excluded_players, p->index);

   263

				RaiseWindowWidget(w, p->index + 3);

   264

			}

   265

		}

   266

		DrawWindowWidgets(w);

   267

   268

		FOR_ALL_PLAYERS(p) {

   269

			if (!p->is_active) continue;

   270

   271

			DrawPlayerIcon(p->index, 4, 18+p->index*12);

   272

   273

			SetDParam(0, p->name_1);

   274

			SetDParam(1, p->name_2);

   275

			SetDParam(2, GetPlayerNameString(p->index, 3));

   276

			DrawString(21, 17 + p->index * 12, STR_7021, HASBIT(_legend_excluded_players, p->index) ? 0x10 : 0xC);

   277

		}

   278

		break;

   279

   280

	case WE_CLICK:

   281

		if (IS_INT_INSIDE(e->we.click.widget, 3, 11)) {

   282

			TOGGLEBIT(_legend_excluded_players, e->we.click.widget - 3);

   283

			ToggleWidgetLoweredState(w, e->we.click.widget);

   284

			SetWindowDirty(w);

   285

			InvalidateWindow(WC_INCOME_GRAPH, 0);

   286

			InvalidateWindow(WC_OPERATING_PROFIT, 0);

   287

			InvalidateWindow(WC_DELIVERED_CARGO, 0);

   288

			InvalidateWindow(WC_PERFORMANCE_HISTORY, 0);

   289

			InvalidateWindow(WC_COMPANY_VALUE, 0);

   290

		}

   291

		break;

   292

	}

   293

}

   294

   295

static const Widget _graph_legend_widgets[] = {

   296

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                       STR_018B_CLOSE_WINDOW},

   297

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   249,     0,    13, STR_704E_KEY_TO_COMPANY_GRAPHS, STR_018C_WINDOW_TITLE_DRAG_THIS},

   298

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   249,    14,   113, 0x0,                            STR_NULL},

   299

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    16,    27, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   300

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    28,    39, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   301

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    40,    51, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   302

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    52,    63, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   303

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    64,    75, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   304

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    76,    87, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   305

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,    88,    99, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   306

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   247,   100,   111, 0x0,                            STR_704F_CLICK_HERE_TO_TOGGLE_COMPANY},

   307

{   WIDGETS_END},

   308

};

   309

   310

static const WindowDesc _graph_legend_desc = {

   311

	WDP_AUTO, WDP_AUTO, 250, 114,

   312

	WC_GRAPH_LEGEND,0,

   313

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   314

	_graph_legend_widgets,

   315

	GraphLegendWndProc

   316

};

   317

   318

static void ShowGraphLegend(void)

   319

{

   320

	AllocateWindowDescFront(&_graph_legend_desc, 0);

   321

}

   322

   323

/********************/

   324

/* OPERATING PROFIT */

   325

/********************/

   326

   327

static void SetupGraphDrawerForPlayers(GraphDrawer *gd)

   328

{

   329

	const Player* p;

   330

	uint excluded_players = _legend_excluded_players;

   331

	byte nums;

   332

	int mo,yr;

   333

   334

	// Exclude the players which aren't valid

   335

	FOR_ALL_PLAYERS(p) {

   336

		if (!p->is_active) SETBIT(excluded_players, p->index);

   337

	}

   338

	gd->excluded_data = excluded_players;

   339

	gd->num_vert_lines = 24;

   340

   341

	nums = 0;

   342

	FOR_ALL_PLAYERS(p) {

   343

		if (p->is_active) nums = max(nums,p->num_valid_stat_ent);

   344

	}

   345

	gd->num_on_x_axis = min(nums,24);

   346

   347

	mo = (_cur_month/3-nums)*3;

   348

	yr = _cur_year;

   349

	while (mo < 0) {

   350

		yr--;

   351

		mo += 12;

   352

	}

   353

   354

	gd->year = yr;

   355

	gd->month = mo;

   356

}

   357

   358

static void OperatingProfitWndProc(Window *w, WindowEvent *e)

   359

{

   360

	switch (e->event) {

   361

	case WE_PAINT: {

   362

		GraphDrawer gd;

   363

		const Player* p;

   364

		int i,j;

   365

		int numd;

   366

   367

		DrawWindowWidgets(w);

   368

   369

		gd.left = 2;

   370

		gd.top = 18;

   371

		gd.height = 136;

   372

		gd.has_negative_values = true;

   373

		gd.format_str_y_axis = STR_CURRCOMPACT;

   374

   375

		SetupGraphDrawerForPlayers(&gd);

   376

   377

		numd = 0;

   378

		FOR_ALL_PLAYERS(p) {

   379

			if (p->is_active) {

   380

				gd.colors[numd] = _colour_gradient[p->player_color][6];

   381

				for (j = gd.num_on_x_axis, i = 0; --j >= 0;) {

   382

					gd.cost[numd][i] = (j >= p->num_valid_stat_ent) ? INVALID_DATAPOINT : (p->old_economy[j].income + p->old_economy[j].expenses);

   383

					i++;

   384

				}

   385

			}

   386

			numd++;

   387

		}

   388

   389

		gd.num_dataset = numd;

   390

   391

		DrawGraph(&gd);

   392

	}	break;

   393

	case WE_CLICK:

   394

		if (e->we.click.widget == 2) /* Clicked on Legend */

   395

			ShowGraphLegend();

   396

		break;

   397

	}

   398

}

   399

   400

static const Widget _operating_profit_widgets[] = {

   401

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                        STR_018B_CLOSE_WINDOW},

   402

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   525,     0,    13, STR_7025_OPERATING_PROFIT_GRAPH, STR_018C_WINDOW_TITLE_DRAG_THIS},

   403

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    14,   526,   575,     0,    13, STR_704C_KEY,                    STR_704D_SHOW_KEY_TO_GRAPHS},

   404

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   575,    14,   173, 0x0,                             STR_NULL},

   405

{   WIDGETS_END},

   406

};

   407

   408

static const WindowDesc _operating_profit_desc = {

   409

	WDP_AUTO, WDP_AUTO, 576, 174,

   410

	WC_OPERATING_PROFIT,0,

   411

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   412

	_operating_profit_widgets,

   413

	OperatingProfitWndProc

   414

};

   415

   416

   417

void ShowOperatingProfitGraph(void)

   418

{

   419

	if (AllocateWindowDescFront(&_operating_profit_desc, 0)) {

   420

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   421

	}

   422

}

   423

   424

   425

/****************/

   426

/* INCOME GRAPH */

   427

/****************/

   428

   429

static void IncomeGraphWndProc(Window *w, WindowEvent *e)

   430

{

   431

	switch (e->event) {

   432

	case WE_PAINT: {

   433

		GraphDrawer gd;

   434

		const Player* p;

   435

		int i,j;

   436

		int numd;

   437

   438

		DrawWindowWidgets(w);

   439

   440

		gd.left = 2;

   441

		gd.top = 18;

   442

		gd.height = 104;

   443

		gd.has_negative_values = false;

   444

		gd.format_str_y_axis = STR_CURRCOMPACT;

   445

		SetupGraphDrawerForPlayers(&gd);

   446

   447

		numd = 0;

   448

		FOR_ALL_PLAYERS(p) {

   449

			if (p->is_active) {

   450

				gd.colors[numd] = _colour_gradient[p->player_color][6];

   451

				for (j = gd.num_on_x_axis, i = 0; --j >= 0;) {

   452

					gd.cost[numd][i] = (j >= p->num_valid_stat_ent) ? INVALID_DATAPOINT : p->old_economy[j].income;

   453

					i++;

   454

				}

   455

			}

   456

			numd++;

   457

		}

   458

   459

		gd.num_dataset = numd;

   460

   461

		DrawGraph(&gd);

   462

		break;

   463

	}

   464

   465

	case WE_CLICK:

   466

		if (e->we.click.widget == 2)

   467

			ShowGraphLegend();

   468

		break;

   469

	}

   470

}

   471

   472

static const Widget _income_graph_widgets[] = {

   473

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,              STR_018B_CLOSE_WINDOW},

   474

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   525,     0,    13, STR_7022_INCOME_GRAPH, STR_018C_WINDOW_TITLE_DRAG_THIS},

   475

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    14,   526,   575,     0,    13, STR_704C_KEY,          STR_704D_SHOW_KEY_TO_GRAPHS},

   476

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   575,    14,   141, 0x0,                   STR_NULL},

   477

{   WIDGETS_END},

   478

};

   479

   480

static const WindowDesc _income_graph_desc = {

   481

	WDP_AUTO, WDP_AUTO, 576, 142,

   482

	WC_INCOME_GRAPH,0,

   483

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   484

	_income_graph_widgets,

   485

	IncomeGraphWndProc

   486

};

   487

   488

void ShowIncomeGraph(void)

   489

{

   490

	if (AllocateWindowDescFront(&_income_graph_desc, 0)) {

   491

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   492

	}

   493

}

   494