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

   173

void RebuildStationLists(void)

   174

{

   175

	BaseWindow *w = NULL;

   176

   177

	FOR_ALL_WINDOWS(w) {

   178

		if (w->window_class == WC_STATION_LIST) {

   179

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

   180

			w->SetDirty();

   181

		}

   182

	}

   183

}

   184

   185

void ResortStationLists(void)

   186

{

   187

	BaseWindow *w = NULL;

   188

   189

	FOR_ALL_WINDOWS(w) {

   190

		if (w->window_class == WC_STATION_LIST) {

   191

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

   192

			w->SetDirty();

   193

		}

   194

	}

   195

}

   196

   197

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

   198

{

   199

	uint n = 0;

   200

	const Station *st;

   201

   202

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

   203

   204

	/* Create array for sorting */

   205

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

   206

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

   207

   208

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

   209

   210

	FOR_ALL_STATIONS(st) {

   211

		if (st->owner == owner) {

   212

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

   213

				int num_waiting_cargo = 0;

   214

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

   215

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

   216

						num_waiting_cargo++; //count number of waiting cargo

   217

						if (HASBIT(cargo_filter, j)) {

   218

							station_sort[n++] = st;

   219

							break;

   220

						}

   221

					}

   222

				}

   223

				//stations without waiting cargo

   224

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

   225

					station_sort[n++] = st;

   226

				}

   227

			}

   228

		}

   229

	}

   230

   231

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

   232

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

   233

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

   234

	sl->list_length = n;

   235

   236

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

   237

   238

	sl->flags &= ~SL_REBUILD;

   239

	sl->flags |= SL_RESORT;

   240

	free((void*)station_sort);

   241

}

   242

   243

static void SortStationsList(plstations_d *sl)

   244

{

   245

	static StationSortListingTypeFunction* const _station_sorter[] = {

   246

		&StationNameSorter,

   247

		&StationTypeSorter,

   248

		&StationWaitingSorter,

   249

		&StationRatingMaxSorter

   250

	};

   251

   252

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

   253

   254

	_internal_sort_order = sl->flags & SL_ORDER;

   255

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

   256

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

   257

   258

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   259

	sl->flags &= ~SL_RESORT;

   260

}

   261

   262

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

   263

{

   264

	static const uint16 CARGO_ALL_SELECTED = 0x1FFF;

   265

   266

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

   267

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

   268

	static uint16 cargo_filter = CARGO_ALL_SELECTED;

   269

	static Listing station_sort = {0, 0};

   270

   271

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

   272

   273

	switch (e->event) {

   274

		case WE_CREATE: /* set up resort timer */

   275

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

   276

				if (HASBIT(facilities, i)) w->LowerWidget(i + STATIONLIST_WIDGET_TRAIN);

   277

			}

   278

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

   279

				if (HASBIT(cargo_filter, i)) w->LowerWidget(i + STATIONLIST_WIDGET_CARGOSTART);

   280

			}

   281

			w->SetWidgetLoweredState(STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   282

			w->SetWidgetLoweredState(STATIONLIST_WIDGET_CARGOALL, cargo_filter == CARGO_ALL_SELECTED);

   283

			w->SetWidgetLoweredState(STATIONLIST_WIDGET_NOCARGOWAITING, HASBIT(cargo_filter, STATIONLIST_WIDGET_NOCARGOWAITING - NUM_CARGO));

   284

   285

			sl->sort_list = NULL;

   286

			sl->flags = SL_REBUILD;

   287

			sl->sort_type = station_sort.criteria;

   288

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

   289

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   290

			break;

   291

   292

		case WE_PAINT: {

   293

			BuildStationsList(sl, owner, facilities, cargo_filter);

   294

			SortStationsList(sl);

   295

   296

			SetVScrollCount(w, sl->list_length);

   297

   298

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

   299

			const Player* p = GetPlayer(owner);

   300

			SetDParam(0, p->name_1);

   301

			SetDParam(1, p->name_2);

   302

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

   303

			w->DrawWidgets();

   304

   305

			/* draw sorting criteria string */

   306

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

   307

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

   308

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

   309

   310

			int cg_ofst;

   311

			int x = 89;

   312

			int y = 14;

   313

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

   314

   315

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

   316

				const CargoSpec *cs = GetCargo(i);

   317

				if (cs->IsValid()) {

   318

					cg_ofst = w->IsWidgetLowered(i + STATIONLIST_WIDGET_CARGOSTART) ? 2 : 1;

   319

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

   320

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

   321

				}

   322

				x += 14;

   323

			}

   324

   325

			x += 6;

   326

			cg_ofst = w->IsWidgetLowered(STATIONLIST_WIDGET_NOCARGOWAITING) ? 2 : 1;

   327

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

   328

			x += 14;

   329

			cg_ofst = w->IsWidgetLowered(STATIONLIST_WIDGET_CARGOALL) ? 2 : 1;

   330

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

   331

   332

			cg_ofst = w->IsWidgetLowered(STATIONLIST_WIDGET_FACILALL) ? 2 : 1;

   333

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

   334

   335

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

   336

				DrawString(xb, 40, STR_304A_NONE, 0);

   337

				return;

   338

			}

   339

   340

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

   341

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

   342

   343

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

   344

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

   345

				int x;

   346

   347

				assert(st->xy != 0);

   348

				assert(st->owner == owner);

   349

   350

				SetDParam(0, st->index);

   351

				SetDParam(1, st->facilities);

   352

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

   353

   354

				// show cargo waiting and station ratings

   355

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

   356

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

   357

					if (amount != 0) {

   358

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

   359

						x += 20;

   360

					}

   361

				}

   362

				y += 10;

   363

			}

   364

			break;

   365

		}

   366

   367

		case WE_CLICK:

   368

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

   369

				case STATIONLIST_WIDGET_LIST: {

   370

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

   371

   372

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

   373

   374

					id_v += w->vscroll.pos;

   375

   376

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

   377

   378

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

   379

					assert(st->owner == owner);

   380

					ScrollMainWindowToTile(st->xy);

   381

					break;

   382

				}

   383

   384

				case STATIONLIST_WIDGET_TRAIN:

   385

				case STATIONLIST_WIDGET_TRUCK:

   386

				case STATIONLIST_WIDGET_BUS:

   387

				case STATIONLIST_WIDGET_AIRPLANE:

   388

				case STATIONLIST_WIDGET_SHIP:

   389

					if (_ctrl_pressed) {

   390

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

   391

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

   392

					} else {

   393

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

   394

							if (HASBIT(facilities, 0)) w->RaiseWidget(i + STATIONLIST_WIDGET_TRAIN);

   395

						}

   396

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

   397

						w->LowerWidget(e->we.click.widget);

   398

					}

   399

					w->SetWidgetLoweredState(STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   400

					sl->flags |= SL_REBUILD;

   401

					w->SetDirty();

   402

					break;

   403

   404

				case STATIONLIST_WIDGET_FACILALL:

   405

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

   406

						w->LowerWidget(i + STATIONLIST_WIDGET_TRAIN);

   407

					}

   408

					w->LowerWidget(STATIONLIST_WIDGET_FACILALL);

   409

   410

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

   411

					sl->flags |= SL_REBUILD;

   412

					w->SetDirty();

   413

					break;

   414

   415

				case STATIONLIST_WIDGET_CARGOALL:

   416

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

   417

						w->LowerWidget(i + STATIONLIST_WIDGET_CARGOSTART);

   418

					}

   419

					w->LowerWidget(STATIONLIST_WIDGET_NOCARGOWAITING);

   420

					w->LowerWidget(STATIONLIST_WIDGET_CARGOALL);

   421

   422

					cargo_filter = CARGO_ALL_SELECTED;

   423

					sl->flags |= SL_REBUILD;

   424

					w->SetDirty();

   425

					break;

   426

   427

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

   428

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

   429

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

   430

					sl->flags |= SL_RESORT;

   431

					w->flash_timeout = 5;

   432

					w->LowerWidget(STATIONLIST_WIDGET_SORTBY);

   433

					w->SetDirty();

   434

					break;

   435

   436

				case STATIONLIST_WIDGET_SORTCRITERIA:

   437

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

   438

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

   439

					break;

   440

   441

				default:

   442

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

   443

						if (_ctrl_pressed) {

   444

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

   445

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

   446

						} else {

   447

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

   448

								if (HASBIT(cargo_filter, 0)) w->RaiseWidget(i + STATIONLIST_WIDGET_CARGOSTART);

   449

							}

   450

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

   451

							w->LowerWidget(e->we.click.widget);

   452

						}

   453

						sl->flags |= SL_REBUILD;

   454

						w->SetWidgetLoweredState(STATIONLIST_WIDGET_CARGOALL, cargo_filter == CARGO_ALL_SELECTED);

   455

						w->SetDirty();

   456

					}

   457

					break;

   458

			}

   459

			break;

   460

   461

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

   462

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

   463

				// value has changed -> resort

   464

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

   465

				station_sort.criteria = sl->sort_type;

   466

				sl->flags |= SL_RESORT;

   467

			}

   468

			w->SetDirty();

   469

			break;

   470

   471

		case WE_TICK:

   472

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

   473

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

   474

				sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   475

				sl->flags |= SL_REBUILD;

   476

				w->SetDirty();

   477

			}

   478

			break;

   479

   480

		case WE_TIMEOUT:

   481

			w->RaiseWidget(STATIONLIST_WIDGET_SORTBY);

   482

			w->SetDirty();

   483

			break;

   484

   485

		case WE_RESIZE:

   486

			w->vscroll.cap += e->we.sizing.diff.y / 10;

   487