1

/* $Id$ */

     2

     3

/** @file graph_gui.cpp GUI that shows performance graphs. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "player_base.h"

    10

#include "player_gui.h"

    11

#include "economy_func.h"

    12

#include "variables.h"

    13

#include "cargotype.h"

    14

#include "strings_func.h"

    15

#include "core/alloc_func.hpp"

    16

#include "window_func.h"

    17

#include "date_func.h"

    18

#include "gfx_func.h"

    19

    20

#include "table/strings.h"

    21

#include "table/sprites.h"

    22

    23

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

    24

static uint _legend_excluded_players;

    25

static uint _legend_excluded_cargo;

    26

    27

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

    28

static const OverflowSafeInt64 INVALID_DATAPOINT(INT64_MAX); // Value used for a datapoint that shouldn't be drawn.

    29

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

    30

    31

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

    32

/* GRAPH LEGEND */

    33

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

    34

    35

struct GraphLegendWindow : Window {

    36

	GraphLegendWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

    37

	{

    38

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

    39

			if (!HasBit(_legend_excluded_players, i - 3)) this->LowerWidget(i);

    40

		}

    41

    42

		this->FindWindowPlacementAndResize(desc);

    43

	}

    44

    45

	virtual void OnPaint()

    46

	{

    47

		const Player *p;

    48

    49

		FOR_ALL_PLAYERS(p) {

    50

			if (p->is_active) continue;

    51

    52

			SetBit(_legend_excluded_players, p->index);

    53

			this->RaiseWidget(p->index + 3);

    54

		}

    55

    56

		this->DrawWidgets();

    57

    58

		FOR_ALL_PLAYERS(p) {

    59

			if (!p->is_active) continue;

    60

    61

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

    62

    63

			SetDParam(0, p->index);

    64

			SetDParam(1, p->index);

    65

			DrawString(21, 17 + p->index * 12, STR_7021, HasBit(_legend_excluded_players, p->index) ? TC_BLACK : TC_WHITE);

    66

		}

    67

	}

    68

    69

	virtual void OnClick(Point pt, int widget)

    70

	{

    71

		if (!IsInsideMM(widget, 3, 11)) return;

    72

    73

		ToggleBit(_legend_excluded_players, widget - 3);

    74

		this->ToggleWidgetLoweredState(widget);

    75

		this->SetDirty();

    76

		InvalidateWindow(WC_INCOME_GRAPH, 0);

    77

		InvalidateWindow(WC_OPERATING_PROFIT, 0);

    78

		InvalidateWindow(WC_DELIVERED_CARGO, 0);

    79

		InvalidateWindow(WC_PERFORMANCE_HISTORY, 0);

    80

		InvalidateWindow(WC_COMPANY_VALUE, 0);

    81

	}

    82

};

    83

    84

static const Widget _graph_legend_widgets[] = {

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

{   WIDGETS_END},

    97

};

    98

    99

static const WindowDesc _graph_legend_desc = {

   100

	WDP_AUTO, WDP_AUTO, 250, 114, 250, 114,

   101

	WC_GRAPH_LEGEND, WC_NONE,

   102

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   103

	_graph_legend_widgets,

   104

};

   105

   106

static void ShowGraphLegend()

   107

{

   108

	AllocateWindowDescFront<GraphLegendWindow>(&_graph_legend_desc, 0);

   109

}

   110

   111

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

   112

/* BASE OF GRAPHS */

   113

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

   114

   115

struct BaseGraphWindow : Window {

   116

protected:

   117

	enum {

   118

		GRAPH_MAX_DATASETS = 32,

   119

		GRAPH_AXIS_LABEL_COLOUR = TC_BLACK,

   120

		GRAPH_AXIS_LINE_COLOUR  = 215,

   121

   122

		GRAPH_X_POSITION_BEGINNING  = 44,  ///< Start the graph 44 pixels from gd_left

   123

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

   124

   125

		GRAPH_NUM_LINES_Y = 9, ///< How many horizontal lines to draw.

   126

		/* 9 is convenient as that means the distance between them is the gd_height of the graph / 8,

   127

		* which is the same

   128

		* as height >> 3. */

   129

	};

   130

   131

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

   132

	byte num_dataset;

   133

	byte num_on_x_axis;

   134

	bool has_negative_values;

   135

	byte num_vert_lines;

   136

   137

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

   138

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

   139

	byte month;

   140

	Year year;

   141

   142

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

   143

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

   144

	uint16 x_values_start;

   145

	uint16 x_values_increment;

   146

   147

	int gd_left, gd_top;  ///< Where to start drawing the graph, in pixels.

   148

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

   149

	StringID format_str_y_axis;

   150

	byte colors[GRAPH_MAX_DATASETS];

   151

	OverflowSafeInt64 cost[GRAPH_MAX_DATASETS][24]; ///< last 2 years

   152

   153

	void DrawGraph() const

   154

	{

   155

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

   156

		OverflowSafeInt64 highest_value; ///< Highest value to be drawn.

   157

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

   158

   159

		/* the colors and cost array of GraphDrawer must accomodate

   160

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

   161

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

   162

		assert(this->num_vert_lines > 0);

   163

   164

		byte grid_colour = _colour_gradient[14][4];

   165

   166

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

   167

		int bottom = this->gd_top + this->gd_height - 1;

   168

		int right  = this->gd_left + GRAPH_X_POSITION_BEGINNING + this->num_vert_lines * GRAPH_X_POSITION_SEPARATION - 1;

   169

   170

		/* Draw the vertical grid lines. */

   171

   172

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

   173

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING + GRAPH_X_POSITION_SEPARATION;

   174

   175

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

   176

			GfxFillRect(x, this->gd_top, x, bottom, grid_colour);

   177

			x += GRAPH_X_POSITION_SEPARATION;

   178

		}

   179

   180

		/* Draw the horizontal grid lines. */

   181

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING;

   182

		y = this->gd_height + this->gd_top;

   183

   184

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

   185

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

   186

			y -= (this->gd_height / (GRAPH_NUM_LINES_Y - 1));

   187

		}

   188

   189

		/* Draw the y axis. */

   190

		GfxFillRect(x, this->gd_top, x, bottom, GRAPH_AXIS_LINE_COLOUR);

   191

   192

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

   193

		x_axis_offset = this->gd_height;

   194

   195

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

   196

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

   197

   198

		/* Draw the x axis. */

   199

		y = x_axis_offset + this->gd_top;

   200

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

   201

   202

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

   203

		if (this->num_on_x_axis == 0)

   204

			return;

   205

   206

		assert(this->num_on_x_axis > 0);

   207

		assert(this->num_dataset > 0);

   208

   209

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

   210

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

   211

		* and prevents division by zero when calculating where the datapoint

   212

		* should be drawn. */

   213

		highest_value = x_axis_offset * 2;

   214

   215

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

   216

			if (!HasBit(this->excluded_data, i)) {

   217

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

   218

					OverflowSafeInt64 datapoint = this->cost[i][j];

   219

   220

					if (datapoint != INVALID_DATAPOINT) {

   221

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

   222

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

   223

						* of each data point. */

   224

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

   225

					}

   226

				}

   227

			}

   228

		}

   229

   230

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

   231

		* axis labels used. */

   232

		int round_val = highest_value % (GRAPH_NUM_LINES_Y - 1);

   233

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

   234

   235

		/* draw text strings on the y axis */

   236

		int64 y_label = highest_value;

   237

		int64 y_label_separation = highest_value / (GRAPH_NUM_LINES_Y - 1);

   238

   239

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

   240

		* -highest_value, not highest_value to 0. */

   241

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

   242

   243

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING + 1;

   244

		y = this->gd_top - 3;

   245

   246

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

   247

			SetDParam(0, this->format_str_y_axis);

   248

			SetDParam(1, y_label);

   249

			DrawStringRightAligned(x, y, STR_0170, GRAPH_AXIS_LABEL_COLOUR);

   250

   251

			y_label -= y_label_separation;

   252

			y += (this->gd_height / (GRAPH_NUM_LINES_Y - 1));

   253

		}

   254

   255

		/* draw strings on the x axis */

   256

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

   257

			x = this->gd_left + GRAPH_X_POSITION_BEGINNING;

   258

			y = this->gd_top + this->gd_height + 1;

   259

			byte month = this->month;

   260

			Year year  = this->year;

   261

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

   262

				SetDParam(0, month + STR_0162_JAN);

   263

				SetDParam(1, month + STR_0162_JAN + 2);

   264

				SetDParam(2, year);

   265

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

   266

   267

				month += 3;

   268

				if (month >= 12) {

   269

					month = 0;

   270

					year++;

   271

				}

   272

				x += GRAPH_X_POSITION_SEPARATION;

   273

			}

   274

		} else {

   275

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

   276

			x = this->gd_left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2) + 1;

   277

			y = this->gd_top + this->gd_height + 1;

   278

			uint16 label = this->x_values_start;

   279

   280

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

   281

				SetDParam(0, label);

   282

				DrawStringCentered(x, y, STR_01CB, GRAPH_AXIS_LABEL_COLOUR);

   283

   284

				label += this->x_values_increment;

   285

				x += GRAPH_X_POSITION_SEPARATION;

   286

			}

   287

		}

   288

   289

		/* draw lines and dots */

   290

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

   291

			if (!HasBit(this->excluded_data, i)) {

   292

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

   293

				x = this->gd_left + GRAPH_X_POSITION_BEGINNING + (GRAPH_X_POSITION_SEPARATION / 2);

   294

   295

				byte color  = this->colors[i];

   296

				uint prev_x = INVALID_DATAPOINT_POS;

   297

				uint prev_y = INVALID_DATAPOINT_POS;

   298

   299

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

   300

					OverflowSafeInt64 datapoint = this->cost[i][j];

   301

   302

					if (datapoint != INVALID_DATAPOINT) {

   303

						/*

   304

						* Check whether we need to reduce the 'accuracy' of the

   305

						* datapoint value and the highest value to splut overflows.

   306

						* And when 'drawing' 'one million' or 'one million and one'

   307

						* there is no significant difference, so the least

   308

						* significant bits can just be removed.

   309

						*

   310

						* If there are more bits needed than would fit in a 32 bits

   311

						* integer, so at about 31 bits because of the sign bit, the

   312

						* least significant bits are removed.

   313

						*/

   314

						int mult_range = FindLastBit(x_axis_offset) + FindLastBit(abs(datapoint));

   315

						int reduce_range = max(mult_range - 31, 0);

   316

   317

						/* Handle negative values differently (don't shift sign) */

   318

						if (datapoint < 0) {

   319

							datapoint = -(abs(datapoint) >> reduce_range);

   320

						} else {

   321

							datapoint >>= reduce_range;

   322

						}

   323

   324

						y = this->gd_top + x_axis_offset - (x_axis_offset * datapoint) / (highest_value >> reduce_range);

   325

   326

						/* Draw the point. */

   327

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

   328

   329

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

   330

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

   331

   332

						prev_x = x;

   333

						prev_y = y;

   334

					} else {

   335

						prev_x = INVALID_DATAPOINT_POS;

   336

						prev_y = INVALID_DATAPOINT_POS;

   337

					}

   338

   339

					x += GRAPH_X_POSITION_SEPARATION;

   340

				}

   341

			}

   342

		}

   343

	}

   344

   345

   346

	BaseGraphWindow(const WindowDesc *desc, WindowNumber window_number, int left,

   347

									int top, int height, bool has_negative_values, StringID format_str_y_axis) :

   348

			Window(desc, window_number), has_negative_values(has_negative_values),

   349

			gd_left(left), gd_top(top), gd_height(height), format_str_y_axis(format_str_y_axis)

   350

	{

   351

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   352

	}

   353

   354

public:

   355

	virtual void OnPaint()

   356

	{

   357

		this->DrawWidgets();

   358

   359

		uint excluded_players = _legend_excluded_players;

   360

   361

		/* Exclude the players which aren't valid */

   362

		const Player* p;

   363

		FOR_ALL_PLAYERS(p) {

   364

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

   365

		}

   366

		this->excluded_data = excluded_players;

   367

		this->num_vert_lines = 24;

   368

   369

		byte nums = 0;

   370

		FOR_ALL_PLAYERS(p) {

   371

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

   372

		}

   373

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

   374

   375

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

   376

		int yr = _cur_year;

   377

		while (mo < 0) {

   378

			yr--;

   379

			mo += 12;

   380

		}

   381

   382

		this->year = yr;

   383

		this->month = mo;

   384

   385

		int numd = 0;

   386

		FOR_ALL_PLAYERS(p) {

   387

			if (p->is_active) {

   388

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

   389

				for (int j = this->num_on_x_axis, i = 0; --j >= 0;) {

   390

					this->cost[numd][i] = (j >= p->num_valid_stat_ent) ? INVALID_DATAPOINT : GetGraphData(p, j);

   391

					i++;

   392

				}

   393

			}

   394

			numd++;

   395

		}

   396

   397

		this->num_dataset = numd;

   398

   399

		this->DrawGraph();

   400

	}

   401

   402

	virtual OverflowSafeInt64 GetGraphData(const Player *p, int j)

   403

	{

   404

		return INVALID_DATAPOINT;

   405

	}

   406

   407

	virtual void OnClick(Point pt, int widget)

   408

	{

   409

		/* Clicked on legend? */

   410

		if (widget == 2) ShowGraphLegend();

   411

	}

   412

};

   413

   414

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

   415

/* OPERATING PROFIT */

   416

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

   417

   418

struct OperatingProfitGraphWindow : BaseGraphWindow {

   419

	OperatingProfitGraphWindow(const WindowDesc *desc, WindowNumber window_number) :

   420

			BaseGraphWindow(desc, window_number, 2, 18, 136, true, STR_CURRCOMPACT)

   421

	{

   422

		this->FindWindowPlacementAndResize(desc);

   423

	}

   424

   425

	virtual OverflowSafeInt64 GetGraphData(const Player *p, int j)

   426

	{

   427

		return p->old_economy[j].income + p->old_economy[j].expenses;

   428

	}

   429

};

   430

   431

static const Widget _operating_profit_widgets[] = {

   432

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

   433

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

   434

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

   435

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

   436

{   WIDGETS_END},

   437

};

   438

   439

static const WindowDesc _operating_profit_desc = {

   440

	WDP_AUTO, WDP_AUTO, 576, 174, 576, 174,

   441

	WC_OPERATING_PROFIT, WC_NONE,

   442

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   443

	_operating_profit_widgets,

   444

};

   445

   446

   447

void ShowOperatingProfitGraph()

   448

{

   449

	AllocateWindowDescFront<OperatingProfitGraphWindow>(&_operating_profit_desc, 0);

   450

}

   451

   452

   453

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

   454

/* INCOME GRAPH */

   455

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

   456

   457

struct IncomeGraphWindow : BaseGraphWindow {

   458

	IncomeGraphWindow(const WindowDesc *desc, WindowNumber window_number) :

   459

			BaseGraphWindow(desc, window_number, 2, 18, 104, false, STR_CURRCOMPACT)

   460

	{

   461

		this->FindWindowPlacementAndResize(desc);

   462

	}

   463

   464

	virtual OverflowSafeInt64 GetGraphData(const Player *p, int j)

   465

	{

   466

		return p->old_economy[j].income;

   467

	}

   468

};

   469

   470

static const Widget _income_graph_widgets[] = {

   471

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

   472

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

   473

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

   474

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

   475

{   WIDGETS_END},

   476

};

   477

   478

static const WindowDesc _income_graph_desc = {

   479

	WDP_AUTO, WDP_AUTO, 576, 142, 576, 142,

   480

	WC_INCOME_GRAPH, WC_NONE,

   481

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   482

	_income_graph_widgets,

   483

};

   484

   485

void ShowIncomeGraph()

   486

{

   487

	AllocateWindowDescFront<IncomeGraphWindow>(&_income_graph_desc, 0);

   488

}

   489

   490

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

   491

/* DELIVERED CARGO */

   492

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

   493

   494

struct DeliveredCargoGraphWindow : BaseGraphWindow {

   495

	DeliveredCargoGraphWindow(const WindowDesc *desc, WindowNumber window_number) :