1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "strings.h"

     8

#include "table/strings.h"

     9

#include "window.h"

    10

#include "gui.h"

    11

#include "station.h"

    12

#include "gfx.h"

    13

#include "player.h"

    14

#include "economy.h"

    15

#include "town.h"

    16

#include "command.h"

    17

#include "variables.h"

    18

#include "vehicle_gui.h"

    19

#include "date.h"

    20

#include "vehicle.h"

    21

#include "table/sprites.h"

    22

#include "helpers.hpp"

    23

#include "cargotype.h"

    24

    25

enum StationListWidgets {

    26

	STATIONLIST_WIDGET_CLOSEBOX = 0,

    27

	STATIONLIST_WIDGET_LIST = 3,

    28

	STATIONLIST_WIDGET_TRAIN =6,

    29

	STATIONLIST_WIDGET_TRUCK,

    30

	STATIONLIST_WIDGET_BUS,

    31

	STATIONLIST_WIDGET_AIRPLANE,

    32

	STATIONLIST_WIDGET_SHIP,

    33

	STATIONLIST_WIDGET_CARGOSTART = 12,

    34

	STATIONLIST_WIDGET_NOCARGOWAITING = 24,

    35

	STATIONLIST_WIDGET_FACILALL = 26,

    36

	STATIONLIST_WIDGET_CARGOALL,

    37

	STATIONLIST_WIDGET_SORTBY,

    38

	STATIONLIST_WIDGET_SORTCRITERIA,

    39

	STATIONLIST_WIDGET_SORTDROPBTN,

    40

};

    41

    42

typedef int CDECL StationSortListingTypeFunction(const void*, const void*);

    43

    44

static StationSortListingTypeFunction StationNameSorter;

    45

static StationSortListingTypeFunction StationTypeSorter;

    46

static StationSortListingTypeFunction StationWaitingSorter;

    47

static StationSortListingTypeFunction StationRatingMaxSorter;

    48

    49

/** Draw small boxes of cargo amount and ratings data at the given

    50

 * coordinates. If amount exceeds 576 units, it is shown 'full', same

    51

 * goes for the rating: at above 90% orso (224) it is also 'full'

    52

 * Each cargo-bar is 16 pixels wide and 6 pixels high

    53

 * Each rating 14 pixels wide and 1 pixel high and is 1 pixel below the cargo-bar

    54

 * @param x,y X/Y coordinate to draw the box at

    55

 * @param type Cargo type

    56

 * @param amount Cargo amount

    57

 * @param rating ratings data for that particular cargo */

    58

static void StationsWndShowStationRating(int x, int y, CargoID type, uint amount, byte rating)

    59

{

    60

	const CargoSpec *cs = GetCargo(type);

    61

	if (!cs->IsValid()) return;

    62

    63

	int colour = cs->rating_colour;

    64

	uint w = (minu(amount, 576) + 5) / 36;

    65

    66

	/* Draw total cargo (limited) on station (fits into 16 pixels) */

    67

	if (w != 0) GfxFillRect(x, y, x + w - 1, y + 6, colour);

    68

    69

	/* Draw a one pixel-wide bar of additional cargo meter, useful

    70

	 * for stations with only a small amount (<=30) */

    71

	if (w == 0) {

    72

		uint rest = amount / 5;

    73

		if (rest != 0) {

    74

			w += x;

    75

			GfxFillRect(w, y + 6 - rest, w, y + 6, colour);

    76

		}

    77

	}

    78

    79

	DrawString(x + 1, y, cs->abbrev, 0x10);

    80

    81

	/* Draw green/red ratings bar (fits into 14 pixels) */

    82

	y += 8;

    83

	GfxFillRect(x + 1, y, x + 14, y, 0xB8);

    84

	rating = minu(rating,  224) / 16;

    85

	if (rating != 0) GfxFillRect(x + 1, y, x + rating, y, 0xD0);

    86

}

    87

    88

const StringID _station_sort_listing[] = {

    89

	STR_SORT_BY_DROPDOWN_NAME,

    90

	STR_SORT_BY_FACILITY,

    91

	STR_SORT_BY_WAITING,

    92

	STR_SORT_BY_RATING_MAX,

    93

	INVALID_STRING_ID

    94

};

    95

    96

static char _bufcache[64];

    97

static const Station* _last_station;

    98

static int _internal_sort_order;

    99

   100

static int CDECL StationNameSorter(const void *a, const void *b)

   101

{

   102

	const Station* st1 = *(const Station**)a;

   103

	const Station* st2 = *(const Station**)b;

   104

	char buf1[64];

   105

	int r;

   106

   107

	SetDParam(0, st1->index);

   108

	GetString(buf1, STR_STATION, lastof(buf1));

   109

   110

	if (st2 != _last_station) {

   111

		_last_station = st2;

   112

		SetDParam(0, st2->index);

   113

		GetString(_bufcache, STR_STATION, lastof(_bufcache));

   114

	}

   115

   116

	r = strcmp(buf1, _bufcache); // sort by name

   117

	return (_internal_sort_order & 1) ? -r : r;

   118

}

   119

   120

static int CDECL StationTypeSorter(const void *a, const void *b)

   121

{

   122

	const Station* st1 = *(const Station**)a;

   123

	const Station* st2 = *(const Station**)b;

   124

	return (_internal_sort_order & 1) ? st2->facilities - st1->facilities : st1->facilities - st2->facilities;

   125

}

   126

   127

static int CDECL StationWaitingSorter(const void *a, const void *b)

   128

{

   129

	const Station* st1 = *(const Station**)a;

   130

	const Station* st2 = *(const Station**)b;

   131

	int sum1 = 0, sum2 = 0;

   132

   133

	for (CargoID j = 0; j < NUM_CARGO; j++) {

   134

		if (st1->goods[j].waiting_acceptance & 0xfff) sum1 += GetTransportedGoodsIncome(st1->goods[j].waiting_acceptance & 0xfff, 20, 50, j);

   135

		if (st2->goods[j].waiting_acceptance & 0xfff) sum2 += GetTransportedGoodsIncome(st2->goods[j].waiting_acceptance & 0xfff, 20, 50, j);

   136

	}

   137

   138

	return (_internal_sort_order & 1) ? sum2 - sum1 : sum1 - sum2;

   139

}

   140

   141

static int CDECL StationRatingMaxSorter(const void *a, const void *b)

   142

{

   143

	const Station* st1 = *(const Station**)a;

   144

	const Station* st2 = *(const Station**)b;

   145

	byte maxr1 = 0;

   146

	byte maxr2 = 0;

   147

   148

	for (CargoID j = 0; j < NUM_CARGO; j++) {

   149

		if (st1->goods[j].waiting_acceptance & 0xfff) maxr1 = max(maxr1, st1->goods[j].rating);

   150

		if (st2->goods[j].waiting_acceptance & 0xfff) maxr2 = max(maxr2, st2->goods[j].rating);

   151

	}

   152

   153

	return (_internal_sort_order & 1) ? maxr2 - maxr1 : maxr1 - maxr2;

   154

}

   155

   156

typedef enum StationListFlags {

   157

	SL_ORDER   = 0x01,

   158

	SL_RESORT  = 0x02,

   159

	SL_REBUILD = 0x04,

   160

} StationListFlags;

   161

   162

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   163

   164

typedef struct plstations_d {

   165

	const Station** sort_list;

   166

	uint16 list_length;

   167

	byte sort_type;

   168

	StationListFlags flags;

   169

	uint16 resort_timer;  //was byte refresh_counter;

   170

} plstations_d;

   171

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   172

   174

{

   175

	Window* const *wz;

   176

   177

	FOR_ALL_WINDOWS(wz) {

   178

		Window *w = *wz;

   179

		if (w->window_class == WC_STATION_LIST) {

   180

			WP(w, plstations_d).flags |= SL_REBUILD;

   181

			SetWindowDirty(w);

   182

		}

   183

	}

   184

}

   185

   187

{

   188

	Window* const *wz;

   189

   190

	FOR_ALL_WINDOWS(wz) {

   191

		Window *w = *wz;

   192

		if (w->window_class == WC_STATION_LIST) {

   193

			WP(w, plstations_d).flags |= SL_RESORT;

   194

			SetWindowDirty(w);

   195

		}

   196

	}

   197

}

   198

   199

static void BuildStationsList(plstations_d* sl, PlayerID owner, byte facilities, uint16 cargo_filter)

   200

{

   201

	uint n = 0;

   202

	const Station *st;

   203

   204

	if (!(sl->flags & SL_REBUILD)) return;

   205

   206

	/* Create array for sorting */

   207

	const Station** station_sort = MallocT<const Station*>(GetMaxStationIndex() + 1);

   208

	if (station_sort == NULL) error("Could not allocate memory for the station-sorting-list");

   209

   210

	DEBUG(misc, 3, "Building station list for player %d", owner);

   211

   212

	FOR_ALL_STATIONS(st) {

   213

		if (st->owner == owner) {

   214

			if (facilities & st->facilities) { //only stations with selected facilities

   215

				int num_waiting_cargo = 0;

   216

				for (CargoID j = 0; j < NUM_CARGO; j++) {

   217

					if (st->goods[j].waiting_acceptance & 0xFFF) {

   218

						num_waiting_cargo++; //count number of waiting cargo

   219

						if (HASBIT(cargo_filter, j)) {

   220

							station_sort[n++] = st;

   221

							break;

   222

						}

   223

					}

   224

				}

   225

				//stations without waiting cargo

   226

				if (num_waiting_cargo == 0 && HASBIT(cargo_filter, NUM_CARGO)) {

   227

					station_sort[n++] = st;

   228

				}

   229

			}

   230

		}

   231

	}

   232

   233

	free((void*)sl->sort_list);

   234

	sl->sort_list = MallocT<const Station*>(n);

   235

	if (n != 0 && sl->sort_list == NULL) error("Could not allocate memory for the station-sorting-list");

   236

	sl->list_length = n;

   237

   238

	for (uint i = 0; i < n; ++i) sl->sort_list[i] = station_sort[i];

   239

   240

	sl->flags &= ~SL_REBUILD;

   241

	sl->flags |= SL_RESORT;

   242

	free((void*)station_sort);

   243

}

   244

   245

static void SortStationsList(plstations_d *sl)

   246

{

   247

	static StationSortListingTypeFunction* const _station_sorter[] = {

   248

		&StationNameSorter,

   249

		&StationTypeSorter,

   250

		&StationWaitingSorter,

   251

		&StationRatingMaxSorter

   252

	};

   253

   254

	if (!(sl->flags & SL_RESORT)) return;

   255

   256

	_internal_sort_order = sl->flags & SL_ORDER;

   257

	_last_station = NULL; // used for "cache" in namesorting

   258

	qsort((void*)sl->sort_list, sl->list_length, sizeof(sl->sort_list[0]), _station_sorter[sl->sort_type]);

   259

   260

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   261

	sl->flags &= ~SL_RESORT;

   262

}

   263

   264

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

   265

{

   266

	static const uint16 CARGO_ALL_SELECTED = 0x1FFF;

   267

   268

	const PlayerID owner = (PlayerID)w->window_number;

   269

	static byte facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;

   270

	static uint16 cargo_filter = CARGO_ALL_SELECTED;

   271

	static Listing station_sort = {0, 0};

   272

   273

	plstations_d *sl = &WP(w, plstations_d);

   274

   275

	switch (e->event) {

   276

		case WE_CREATE: /* set up resort timer */

   277

			for (uint i = 0; i < 5; i++) {

   278

				if (HASBIT(facilities, i)) LowerWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   279

			}

   280

			for (CargoID i = 0; i < NUM_CARGO; i++) {

   281

				if (HASBIT(cargo_filter, i)) LowerWindowWidget(w, i + STATIONLIST_WIDGET_CARGOSTART);

   282

			}

   283

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   284

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_CARGOALL, cargo_filter == CARGO_ALL_SELECTED);

   285

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_NOCARGOWAITING, HASBIT(cargo_filter, STATIONLIST_WIDGET_NOCARGOWAITING - NUM_CARGO));

   286

   287

			sl->sort_list = NULL;

   288

			sl->flags = SL_REBUILD;

   289

			sl->sort_type = station_sort.criteria;

   290

			if (station_sort.order) sl->flags |= SL_ORDER;

   291

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   292

			break;

   293

   294

		case WE_PAINT: {

   295

			BuildStationsList(sl, owner, facilities, cargo_filter);

   296

			SortStationsList(sl);

   297

   298

			SetVScrollCount(w, sl->list_length);

   299

   300

			/* draw widgets, with player's name in the caption */

   301

			const Player* p = GetPlayer(owner);

   302

			SetDParam(0, p->name_1);

   303

			SetDParam(1, p->name_2);

   304

			SetDParam(2, w->vscroll.count);

   305

			DrawWindowWidgets(w);

   306

   307

			/* draw sorting criteria string */

   308

			DrawString(85, 26, _station_sort_listing[sl->sort_type], 0x10);

   309

			/* draw arrow pointing up/down for ascending/descending sorting */

   310

			DoDrawString(sl->flags & SL_ORDER ? DOWNARROW : UPARROW, 69, 26, 0x10);

   311

   312

			int cg_ofst;

   313

			int x = 89;

   314

			int y = 14;

   315

			int xb = 2; // offset from left of widget

   316

   317

			for (CargoID i = 0; i < NUM_CARGO; i++) {

   318

				const CargoSpec *cs = GetCargo(i);

   319

				if (cs->IsValid()) {

   320

					cg_ofst = IsWindowWidgetLowered(w, i + STATIONLIST_WIDGET_CARGOSTART) ? 2 : 1;

   321

					GfxFillRect(x + cg_ofst, y + cg_ofst, x + cg_ofst + 10 , y + cg_ofst + 7, cs->rating_colour);

   322

					DrawStringCentered(x + 6 + cg_ofst, y + cg_ofst, cs->abbrev, 0x10);

   323

				}

   324

				x += 14;

   325

			}

   326

   327

			x += 6;

   328

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_NOCARGOWAITING) ? 2 : 1;

   329

			DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_NONE, 16);

   330

			x += 14;

   331

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_CARGOALL) ? 2 : 1;

   332

			DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, 16);

   333

   334

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_FACILALL) ? 2 : 1;

   335

			DrawString(71 + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, 16);

   336

   337

			if (w->vscroll.count == 0) { // player has no stations

   338

				DrawString(xb, 40, STR_304A_NONE, 0);

   339

				return;

   340

			}

   341

   342

			int max = min(w->vscroll.pos + w->vscroll.cap, sl->list_length);

   343

			y = 40; // start of the list-widget

   344

   345

			for (int i = w->vscroll.pos; i < max; ++i) { // do until max number of stations of owner

   346

				const Station *st = sl->sort_list[i];

   347

				int x;

   348

   349

				assert(st->xy != 0);

   350

				assert(st->owner == owner);

   351

   352

				SetDParam(0, st->index);

   353

				SetDParam(1, st->facilities);

   354

				x = DrawString(xb, y, STR_3049_0, 0) + 5;

   355

   356

				// show cargo waiting and station ratings

   357

				for (CargoID j = 0; j != NUM_CARGO; j++) {

   358

					uint amount = GB(st->goods[j].waiting_acceptance, 0, 12);

   359

					if (amount != 0) {

   360

						StationsWndShowStationRating(x, y, j, amount, st->goods[j].rating);

   361

						x += 20;

   362

					}

   363

				}

   364

				y += 10;

   365

			}

   366

			break;

   367

		}

   368

   369

		case WE_CLICK:

   370

			switch (e->we.click.widget) {

   371

				case STATIONLIST_WIDGET_LIST: {

   372

					uint32 id_v = (e->we.click.pt.y - 41) / 10;

   373

   374

					if (id_v >= w->vscroll.cap) return; // click out of bounds

   375

   376

					id_v += w->vscroll.pos;

   377

   378

					if (id_v >= sl->list_length) return; // click out of list bound

   379

   380

					const Station *st = sl->sort_list[id_v];

   381

					assert(st->owner == owner);

   382

					ScrollMainWindowToTile(st->xy);

   383

					break;

   384

				}

   385

   386

				case STATIONLIST_WIDGET_TRAIN:

   387

				case STATIONLIST_WIDGET_TRUCK:

   388

				case STATIONLIST_WIDGET_BUS:

   389

				case STATIONLIST_WIDGET_AIRPLANE:

   390

				case STATIONLIST_WIDGET_SHIP:

   391

					if (_ctrl_pressed) {

   392

						TOGGLEBIT(facilities, e->we.click.widget - STATIONLIST_WIDGET_TRAIN);

   393

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

   394

					} else {

   395

						for (uint i = 0; facilities != 0; i++, facilities >>= 1) {

   396

							if (HASBIT(facilities, 0)) RaiseWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   397

						}

   398

						SETBIT(facilities, e->we.click.widget - STATIONLIST_WIDGET_TRAIN);

   399

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

   400

					}

   401

					SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   402

					sl->flags |= SL_REBUILD;

   403

					SetWindowDirty(w);

   404

					break;

   405

   406

				case STATIONLIST_WIDGET_FACILALL:

   407

					for (uint i = 0; i < 5; i++) {

   408

						LowerWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   409

					}

   410

					LowerWindowWidget(w, STATIONLIST_WIDGET_FACILALL);

   411

   412

					facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;

   413

					sl->flags |= SL_REBUILD;

   414

					SetWindowDirty(w);

   415

					break;

   416

   417

				case STATIONLIST_WIDGET_CARGOALL:

   418

					for (CargoID i = 0; i < NUM_CARGO; i++) {

   419

						LowerWindowWidget(w, i + STATIONLIST_WIDGET_CARGOSTART);

   420

					}

   421

					LowerWindowWidget(w, STATIONLIST_WIDGET_NOCARGOWAITING);

   422

					LowerWindowWidget(w, STATIONLIST_WIDGET_CARGOALL);

   423

   424

					cargo_filter = CARGO_ALL_SELECTED;

   425

					sl->flags |= SL_REBUILD;

   426

					SetWindowDirty(w);

   427

					break;

   428

   429

				case STATIONLIST_WIDGET_SORTBY: /*flip sorting method asc/desc*/

   430

					sl->flags ^= SL_ORDER; //DESC-flag

   431

					station_sort.order = GB(sl->flags, 0, 1);

   432

					sl->flags |= SL_RESORT;

   433

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   434

					LowerWindowWidget(w, STATIONLIST_WIDGET_SORTBY);

   435

					SetWindowDirty(w);

   436

					break;

   437

   438

				case STATIONLIST_WIDGET_SORTCRITERIA:

   439

				case STATIONLIST_WIDGET_SORTDROPBTN: /* select sorting criteria dropdown menu */

   440

					ShowDropDownMenu(w, _station_sort_listing, sl->sort_type, STATIONLIST_WIDGET_SORTDROPBTN, 0, 0);

   441

					break;

   442

   443

				default:

   444

					if (e->we.click.widget >= STATIONLIST_WIDGET_CARGOSTART && e->we.click.widget <= STATIONLIST_WIDGET_NOCARGOWAITING) { //change cargo_filter

   445

						if (_ctrl_pressed) {

   446

							TOGGLEBIT(cargo_filter, e->we.click.widget - STATIONLIST_WIDGET_CARGOSTART);

   447

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

   448

						} else {

   449

							for (uint i = 0; cargo_filter != 0; i++, cargo_filter >>= 1) {

   450

								if (HASBIT(cargo_filter, 0)) RaiseWindowWidget(w, i + STATIONLIST_WIDGET_CARGOSTART);

   451

							}

   452

							SETBIT(cargo_filter, e->we.click.widget - STATIONLIST_WIDGET_CARGOSTART);

   453

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

   454

						}

   455

						sl->flags |= SL_REBUILD;

   456

						SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_CARGOALL, cargo_filter == CARGO_ALL_SELECTED);

   457

						SetWindowDirty(w);

   458

					}

   459

					break;

   460

			}

   461

			break;

   462

   463

		case WE_DROPDOWN_SELECT: /* we have selected a dropdown item in the list */

   464

			if (sl->sort_type != e->we.dropdown.index) {

   465

				// value has changed -> resort

   466

				sl->sort_type = e->we.dropdown.index;

   467

				station_sort.criteria = sl->sort_type;

   468

				sl->flags |= SL_RESORT;

   469

			}

   470

			SetWindowDirty(w);

   471

			break;

   472

   473

		case WE_TICK:

   474

			if (--sl->resort_timer == 0) {

   475

				DEBUG(misc, 3, "Periodic rebuild station list player %d", owner);

   476

				sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   477

				sl->flags |= SL_REBUILD;

   478

				SetWindowDirty(w);

   479

			}

   480

			break;

   481

   482

		case WE_TIMEOUT:

   483

			RaiseWindowWidget(w, STATIONLIST_WIDGET_SORTBY);

   484

			SetWindowDirty(w);

   485

			break;

   486

   487

		case WE_RESIZE: