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"

    20

    21

#include "table/strings.h"

    22

#include "table/sprites.h"

    23

    24

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

    25

static uint _legend_excluded_players;

    26

static uint _legend_excluded_cargo;

    27

    28

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

    29

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

    30

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

    31

    32

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

    33

/* GRAPH LEGEND */

    34

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

    35

    36

struct GraphLegendWindow : Window {

    37

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

    38

	{

    39

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

    40

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

    41

		}

    42

    43

		this->FindWindowPlacementAndResize(desc);

    44

	}

    45

    46

	virtual void OnPaint()

    47

	{

    48

		const Player *p;

    49

    50

		FOR_ALL_PLAYERS(p) {

    51

			if (p->is_active) continue;

    52

    53

			SetBit(_legend_excluded_players, p->index);

    54

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

    55

		}

    56

    57

		this->DrawWidgets();

    58

    59

		FOR_ALL_PLAYERS(p) {

    60

			if (!p->is_active) continue;

    61

    62

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

    63

    64

			SetDParam(0, p->index);

    65

			SetDParam(1, p->index);

    66

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

    67

		}

    68

	}

    69

    70

	virtual void OnClick(Point pt, int widget)

    71

	{

    72

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

    73

    74

		ToggleBit(_legend_excluded_players, widget - 3);

    75

		this->ToggleWidgetLoweredState(widget);

    76

		this->SetDirty();

    77

		InvalidateWindow(WC_INCOME_GRAPH, 0);

    78

		InvalidateWindow(WC_OPERATING_PROFIT, 0);

    79

		InvalidateWindow(WC_DELIVERED_CARGO, 0);

    80

		InvalidateWindow(WC_PERFORMANCE_HISTORY, 0);

    81

		InvalidateWindow(WC_COMPANY_VALUE, 0);

    82

	}

    83

};

    84

    85

static const Widget _graph_legend_widgets[] = {

    86

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

    87

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

    88

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

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

{   WIDGETS_END},

    98

};

    99

   100

static const WindowDesc _graph_legend_desc = {

   101

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

   102

	WC_GRAPH_LEGEND, WC_NONE,

   103

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   104

	_graph_legend_widgets,

   105

};

   106

   107

static void ShowGraphLegend()

   108

{

   109

	AllocateWindowDescFront<GraphLegendWindow>(&_graph_legend_desc, 0);

   110

}

   111

   112

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

   113

/* BASE OF GRAPHS */

   114

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

   115

   116

struct BaseGraphWindow : Window {

   117

protected:

   118

	enum {

   119

		GRAPH_MAX_DATASETS = 32,

   120

		GRAPH_AXIS_LABEL_COLOUR = TC_BLACK,

   121

		GRAPH_AXIS_LINE_COLOUR  = 215,

   122

   123

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

   124

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

   125

   126

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

   127

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

   128

		* which is the same

   129

		* as height >> 3. */

   130

	};

   131

   132

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

   133

	byte num_dataset;

   134

	byte num_on_x_axis;

   135

	bool has_negative_values;

   136

	byte num_vert_lines;

   137

   138

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

   139

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

   140

	byte month;

   141

	Year year;

   142

   143

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

   144

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

   145

	uint16 x_values_start;

   146

	uint16 x_values_increment;

   147

   148

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

   149

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

   150

	StringID format_str_y_axis;

   151

	byte colors[GRAPH_MAX_DATASETS];

   152

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

   153

   154

	void DrawGraph() const

   155

	{

   156

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

   157

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

   158

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

   159

   160

		/* the colors and cost array of GraphDrawer must accomodate

   161

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

   162

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

   163

		assert(this->num_vert_lines > 0);

   164

   165

		byte grid_colour = _colour_gradient[14][4];

   166

   167

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

   168

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

   169

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

   170

   171

		/* Draw the vertical grid lines. */

   172

   173

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

   174

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING + GRAPH_X_POSITION_SEPARATION;

   175

   176

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

   177

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

   178

			x += GRAPH_X_POSITION_SEPARATION;

   179

		}

   180

   181

		/* Draw the horizontal grid lines. */

   182

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING;

   183

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

   184

   185

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

   186

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

   187

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

   188

		}

   189

   190

		/* Draw the y axis. */

   191

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

   192

   193

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

   194

		x_axis_offset = this->gd_height;

   195

   196

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

   197

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

   198

   199

		/* Draw the x axis. */

   200

		y = x_axis_offset + this->gd_top;

   201

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

   202

   203

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

   204

		if (this->num_on_x_axis == 0)

   205

			return;

   206

   207

		assert(this->num_on_x_axis > 0);

   208

		assert(this->num_dataset > 0);

   209

   210

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

   211

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

   212

		* and prevents division by zero when calculating where the datapoint

   213

		* should be drawn. */

   214

		highest_value = x_axis_offset * 2;

   215

   216

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

   217

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

   218

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

   219

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

   220

   221

					if (datapoint != INVALID_DATAPOINT) {

   222

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

   223

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

   224

						* of each data point. */

   225

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

   226

					}

   227

				}

   228

			}

   229

		}

   230

   231

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

   232

		* axis labels used. */

   233

		int round_val = highest_value % (GRAPH_NUM_LINES_Y - 1);

   234

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

   235

   236

		/* draw text strings on the y axis */

   237

		int64 y_label = highest_value;

   238

		int64 y_label_separation = highest_value / (GRAPH_NUM_LINES_Y - 1);

   239

   240

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

   241

		* -highest_value, not highest_value to 0. */

   242

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

   243

   244

		x = this->gd_left + GRAPH_X_POSITION_BEGINNING + 1;

   245

		y = this->gd_top - 3;

   246

   247

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

   248

			SetDParam(0, this->format_str_y_axis);

   249

			SetDParam(1, y_label);

   250

			DrawStringRightAligned(x, y, STR_0170, GRAPH_AXIS_LABEL_COLOUR);

   251

   252

			y_label -= y_label_separation;

   253

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

   254

		}

   255

   256

		/* draw strings on the x axis */

   257

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

   258

			x = this->gd_left + GRAPH_X_POSITION_BEGINNING;

   259

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

   260

			byte month = this->month;

   261

			Year year  = this->year;

   262

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

   263

				SetDParam(0, month + STR_0162_JAN);

   264

				SetDParam(1, month + STR_0162_JAN + 2);

   265

				SetDParam(2, year);

   266

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

   267

   268

				month += 3;

   269

				if (month >= 12) {

   270

					month = 0;

   271

					year++;

   272

				}

   273

				x += GRAPH_X_POSITION_SEPARATION;

   274

			}

   275

		} else {

   276

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

   277

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

   278

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

   279

			uint16 label = this->x_values_start;

   280

   281

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

   282

				SetDParam(0, label);

   283

				DrawStringCentered(x, y, STR_01CB, GRAPH_AXIS_LABEL_COLOUR);

   284

   285

				label += this->x_values_increment;

   286

				x += GRAPH_X_POSITION_SEPARATION;

   287

			}

   288

		}

   289

   290

		/* draw lines and dots */

   291

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

   292

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

   293

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

   294

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

   295

   296

				byte color  = this->colors[i];

   297

				uint prev_x = INVALID_DATAPOINT_POS;

   298

				uint prev_y = INVALID_DATAPOINT_POS;

   299

   300

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

   301

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

   302

   303

					if (datapoint != INVALID_DATAPOINT) {

   304

						/*

   305

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

   306

						* datapoint value and the highest value to splut overflows.

   307

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

   308

						* there is no significant difference, so the least

   309

						* significant bits can just be removed.

   310

						*

   311

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

   312

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

   313

						* least significant bits are removed.

   314

						*/

   315

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

   316

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

   317

   318

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

   319

						if (datapoint < 0) {

   320

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

   321

						} else {

   322

							datapoint >>= reduce_range;

   323

						}

   324

   325

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

   326

   327

						/* Draw the point. */

   328

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

   329

   330

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

   331

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

   332

   333

						prev_x = x;

   334

						prev_y = y;

   335

					} else {

   336

						prev_x = INVALID_DATAPOINT_POS;

   337

						prev_y = INVALID_DATAPOINT_POS;

   338

					}

   339

   340

					x += GRAPH_X_POSITION_SEPARATION;

   341

				}

   342

			}

   343

		}

   344

	}

   345

   346

   347

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

   348

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

   349

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

   350

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

   351

	{

   352

		InvalidateWindow(WC_GRAPH_LEGEND, 0);

   353

	}

   354

   355

public:

   356

	virtual void OnPaint()

   357

	{

   358

		this->DrawWidgets();

   359

   360

		uint excluded_players = _legend_excluded_players;

   361

   362

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

   363

		const Player* p;

   364

		FOR_ALL_PLAYERS(p) {

   365

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

   366

		}

   367

		this->excluded_data = excluded_players;

   368

		this->num_vert_lines = 24;

   369

   370

		byte nums = 0;

   371

		FOR_ALL_PLAYERS(p) {

   372

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

   373

		}

   374

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

   375

   376

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

   377

		int yr = _cur_year;

   378

		while (mo < 0) {

   379

			yr--;

   380

			mo += 12;

   381

		}

   382

   383

		this->year = yr;

   384

		this->month = mo;

   385

   386

		int numd = 0;

   387

		FOR_ALL_PLAYERS(p) {

   388

			if (p->is_active) {

   389

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

   390

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

   391

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

   392

					i++;

   393

				}

   394

			}

   395

			numd++;

   396

		}

   397

   398

		this->num_dataset = numd;

   399

   400

		this->DrawGraph();

   401

	}

   402

   403

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

   404

	{

   405

		return INVALID_DATAPOINT;

   406

	}

   407

   408

	virtual void OnClick(Point pt, int widget)

   409

	{

   410

		/* Clicked on legend? */

   411

		if (widget == 2) ShowGraphLegend();

   412

	}

   413

};

   414

   415

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

   416

/* OPERATING PROFIT */

   417

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

   418

   419

struct OperatingProfitGraphWindow : BaseGraphWindow {

   420

	OperatingProfitGraphWindow(const WindowDesc *desc, WindowNumber window_number) :

   421

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

   422

	{

   423

		this->FindWindowPlacementAndResize(desc);

   424

	}

   425

   426

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

   427

	{

   428

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

   429

	}

   430

};

   431

   432

static const Widget _operating_profit_widgets[] = {

   433

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

   434

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

   435

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

   436

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

   437

{   WIDGETS_END},

   438

};

   439

   440

static const WindowDesc _operating_profit_desc = {

   441

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

   442

	WC_OPERATING_PROFIT, WC_NONE,

   443

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   444

	_operating_profit_widgets,

   445

};

   446

   447

   448

void ShowOperatingProfitGraph()

   449

{

   450

	AllocateWindowDescFront<OperatingProfitGraphWindow>(&_operating_profit_desc, 0);

   451

}

   452

   453

   454

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

   455

/* INCOME GRAPH */

   456

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

   457

   458

struct IncomeGraphWindow : BaseGraphWindow {

   459

	IncomeGraphWindow(const WindowDesc *desc, WindowNumber window_number) :

   460

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

   461

	{

   462

		this->FindWindowPlacementAndResize(desc);

   463

	}

   464

   465

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

   466

	{

   467

		return p->old_economy[j].income;

   468

	}

   469

};

   470

   471

static const Widget _income_graph_widgets[] = {

   472

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

   473

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

   474

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

   475

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

   476

{   WIDGETS_END},

   477

};

   478

   479

static const WindowDesc _income_graph_desc = {

   480

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

   481

	WC_INCOME_GRAPH, WC_NONE,

   482

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   483

	_income_graph_widgets,

   484

};

   485

   486

void ShowIncomeGraph()

   487

{

   488

	AllocateWindowDescFront<IncomeGraphWindow>(&_income_graph_desc, 0);

   489

}

   490

   491

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

   492

/* DELIVERED CARGO */

   493

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

   494

   495

struct DeliveredCargoGraphWindow : BaseGraphWindow {