1

/* $Id$ */

     2

     3

/** @file town_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "strings.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "town.h"

    13

#include "window.h"

    14

#include "gfx.h"

    15

#include "viewport.h"

    16

#include "gui.h"

    17

#include "command.h"

    18

#include "player.h"

    19

#include "network/network.h"

    20

#include "variables.h"

    21

#include "helpers.hpp"

    22

    23

enum TownAuthorityWidget {

    24

	TWA_CLOSEBOX = 0,

    25

	TWA_CAPTION,

    26

	TWA_RATING_INFO,

    27

	TWA_COMMAND_LIST,

    28

	TWA_SCROLLBAR,

    29

	TWA_ACTION_INFO,

    30

	TWA_EXECUTE,

    31

};

    32

    33

static const Widget _town_authority_widgets[] = {

    34

{   WWT_CLOSEBOX,   RESIZE_NONE,    13,     0,    10,     0,    13, STR_00C5,                 STR_018B_CLOSE_WINDOW},              // TWA_CLOSEBOX

    35

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   316,     0,    13, STR_2022_LOCAL_AUTHORITY, STR_018C_WINDOW_TITLE_DRAG_THIS},    // TWA_CAPTION

    36

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   316,    14,   105, 0x0,                      STR_NULL},                           // TWA_RATING_INFO

    37

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   304,   106,   157, 0x0,                      STR_2043_LIST_OF_THINGS_TO_DO_AT},   // TWA_COMMAND_LIST

    38

{  WWT_SCROLLBAR,   RESIZE_NONE,    13,   305,   316,   106,   157, 0x0,                      STR_0190_SCROLL_BAR_SCROLLS_LIST},   // TWA_SCROLLBAR

    39

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   316,   158,   209, 0x0,                      STR_NULL},                           // TWA_ACTION_INFO

    40

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,   316,   210,   221, STR_2042_DO_IT,           STR_2044_CARRY_OUT_THE_HIGHLIGHTED}, // TWA_EXECUTE

    41

{   WIDGETS_END},

    42

};

    43

    44

extern const byte _town_action_costs[8];

    45

    46

enum TownActions {

    47

	TACT_NONE             = 0x00,

    48

    49

	TACT_ADVERTISE_SMALL  = 0x01,

    50

	TACT_ADVERTISE_MEDIUM = 0x02,

    51

	TACT_ADVERTISE_LARGE  = 0x04,

    52

	TACT_ROAD_REBUILD     = 0x08,

    53

	TACT_BUILD_STATUE     = 0x10,

    54

	TACT_FOUND_BUILDINGS  = 0x20,

    55

	TACT_BUY_RIGHTS       = 0x40,

    56

	TACT_BRIBE            = 0x80,

    57

    58

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    59

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    60

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    61

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    62

};

    63

    64

DECLARE_ENUM_AS_BIT_SET(TownActions);

    65

    66

/** Get a list of available actions to do at a town.

    67

 * @param nump if not NULL add put the number of available actions in it

    68

 * @param pid the player that is querying the town

    69

 * @param t the town that is queried

    70

 * @return bitmasked value of enabled actions

    71

 */

    72

uint GetMaskOfTownActions(int *nump, PlayerID pid, const Town *t)

    73

{

    74

	int num = 0;

    75

	TownActions buttons = TACT_NONE;

    76

    77

	/* Spectators and unwanted have no options */

    78

	if (pid != PLAYER_SPECTATOR && !(_patches.bribe && t->unwanted[pid])) {

    79

    80

		/* Things worth more than this are not shown */

    81

		Money avail = GetPlayer(pid)->player_money + _price.station_value * 200;

    82

		Money ref = _price.build_industry >> 8;

    83

    84

		/* Check the action bits for validity and

    85

		 * if they are valid add them */

    86

		for (uint i = 0; i != lengthof(_town_action_costs); i++) {

    87

			const TownActions cur = (TownActions)(1 << i);

    88

    89

			/* Is the player not able to bribe ? */

    90

			if (cur == TACT_BRIBE && (!_patches.bribe || t->ratings[pid] >= RATING_BRIBE_MAXIMUM))

    91

				continue;

    92

    93

			/* Is the player not able to buy exclusive rights ? */

    94

			if (cur == TACT_BUY_RIGHTS && !_patches.exclusive_rights)

    95

				continue;

    96

    97

			/* Is the player not able to build a statue ? */

    98

			if (cur == TACT_BUILD_STATUE && HasBit(t->statues, pid))

    99

				continue;

   100

   101

			if (avail >= _town_action_costs[i] * ref) {

   102

				buttons |= cur;

   103

				num++;

   104

			}

   105

		}

   106

	}

   107

   108

	if (nump != NULL) *nump = num;

   109

	return buttons;

   110

}

   111

   112

static int GetNthSetBit(uint32 bits, int n)

   113

{

   114

	int i = 0;

   115

   116

	if (n >= 0) {

   117

		do {

   118

			if (bits & 1 && --n < 0) return i;

   119

			i++;

   120

		} while (bits >>= 1);

   121

	}

   122

	return -1;

   123

}

   124

   125

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

   126

{

   127

	switch (e->event) {

   128

	case WE_PAINT: {

   129

		const Town *t = GetTown(w->window_number);

   130

		int numact;

   131

		uint buttons = GetMaskOfTownActions(&numact, _local_player, t);

   132

   133

		SetVScrollCount(w, numact + 1);

   134

   135

		if (WP(w,def_d).data_1 != -1 && !HasBit(buttons, WP(w,def_d).data_1))

   136

			WP(w,def_d).data_1 = -1;

   137

   138

		SetWindowWidgetDisabledState(w, 6, WP(w, def_d).data_1 == -1);

   139

   140

		{

   141

			int y;

   142

			const Player *p;

   143

			int r;

   144

			StringID str;

   145

   146

			SetDParam(0, w->window_number);

   147

			DrawWindowWidgets(w);

   148

   149

			DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   150

   151

			/* Draw list of players */

   152

			y = 25;

   153

			FOR_ALL_PLAYERS(p) {

   154

				if (p->is_active && (HasBit(t->have_ratings, p->index) || t->exclusivity == p->index)) {

   155

					DrawPlayerIcon(p->index, 2, y);

   156

   157

					SetDParam(0, p->index);

   158

					SetDParam(1, p->index);

   159

   160

					r = t->ratings[p->index];

   161

					(str = STR_3035_APPALLING, r <= RATING_APPALLING) || // Apalling

   162

					(str++,                    r <= RATING_VERYPOOR)  || // Very Poor

   163

					(str++,                    r <= RATING_POOR)      || // Poor

   164

					(str++,                    r <= RATING_MEDIOCRE)  || // Mediocore

   165

					(str++,                    r <= RATING_GOOD)      || // Good

   166

					(str++,                    r <= RATING_VERYGOOD)  || // Very Good

   167

					(str++,                    r <= RATING_EXCELLENT) || // Excellent

   168

					(str++,                    true);                    // Outstanding

   169

   170

					SetDParam(2, str);

   171

					if (t->exclusivity == p->index) { // red icon for player with exclusive rights

   172

						DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   173

					}

   174

   175

					DrawString(28, y, STR_2024, TC_FROMSTRING);

   176

					y += 10;

   177

				}

   178

			}

   179

		}

   180

   181

		/* Draw actions list */

   182

		{

   183

			int y = 107, i;

   184

			int pos = w->vscroll.pos;

   185

   186

			if (--pos < 0) {

   187

				DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   188

				y += 10;

   189

			}

   190

			for (i = 0; buttons; i++, buttons >>= 1) {

   191

				if (pos <= -5) break; ///< Draw only the 5 fitting lines

   192

   193

				if ((buttons & 1) && --pos < 0) {

   194

					DrawString(3, y, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i, TC_ORANGE);

   195

					y += 10;

   196

				}

   197

			}

   198

		}

   199

   200

		{

   201

			int i = WP(w,def_d).data_1;

   202

   203

			if (i != -1) {

   204

				SetDParam(1, (_price.build_industry >> 8) * _town_action_costs[i]);

   205

				SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   206

				DrawStringMultiLine(2, 159, STR_204D_INITIATE_A_SMALL_LOCAL + i, 313);

   207

			}

   208

		}

   209

   210

	} break;

   211

   212

	case WE_DOUBLE_CLICK:

   213

	case WE_CLICK:

   214

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

   215

		case TWA_COMMAND_LIST: {

   216

			const Town *t = GetTown(w->window_number);

   217

			int y = (e->we.click.pt.y - 0x6B) / 10;

   218

   220

   221

			y = GetNthSetBit(GetMaskOfTownActions(NULL, _local_player, t), y + w->vscroll.pos - 1);

   222

			if (y >= 0) {

   223

				WP(w,def_d).data_1 = y;

   224

				SetWindowDirty(w);

   225

			}

   226

			/* Fall through to clicking in case we are double-clicked */

   227

			if (e->event != WE_DOUBLE_CLICK || y < 0) break;

   228

		}

   229

   230

		case TWA_EXECUTE: {

   231

			DoCommandP(GetTown(w->window_number)->xy, w->window_number, WP(w,def_d).data_1, NULL, CMD_DO_TOWN_ACTION | CMD_MSG(STR_00B4_CAN_T_DO_THIS));

   232

			break;

   233

		}

   234

		}

   235

		break;

   236

   237

	case WE_4:

   238

		SetWindowDirty(w);

   239

		break;

   240

	}

   241

}

   242

   243

static const WindowDesc _town_authority_desc = {

   244

	WDP_AUTO, WDP_AUTO, 317, 222, 317, 222,

   245

	WC_TOWN_AUTHORITY, WC_NONE,

   246

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   247

	_town_authority_widgets,

   248

	TownAuthorityWndProc

   249

};

   250

   251

static void ShowTownAuthorityWindow(uint town)

   252

{

   253

	Window *w = AllocateWindowDescFront(&_town_authority_desc, town);

   254

   255

	if (w != NULL) {

   256

		w->vscroll.cap = 5;

   257

		WP(w,def_d).data_1 = -1;

   258

	}

   259

}

   260

   261

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

   262

{

   263

	Town *t = GetTown(w->window_number);

   264

   265

	switch (e->event) {

   266

	case WE_PAINT:

   267

		/* disable renaming town in network games if you are not the server */

   268

		SetWindowWidgetDisabledState(w, 8, _networking && !_network_server);

   269

   270

		SetDParam(0, t->index);

   271

		DrawWindowWidgets(w);

   272

   273

		SetDParam(0, t->population);

   274

		SetDParam(1, t->num_houses);

   275

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   276

   277

		SetDParam(0, t->act_pass);

   278

		SetDParam(1, t->max_pass);

   279

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   280

   281

		SetDParam(0, t->act_mail);

   282

		SetDParam(1, t->max_mail);

   283

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   284

   285

		DrawWindowViewport(w);

   286

		break;

   287

   288

	case WE_CLICK:

   289

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

   290

			case 6: /* scroll to location */

   291

				ScrollMainWindowToTile(t->xy);

   292

				break;

   293

   294

			case 7: /* town authority */

   295

				ShowTownAuthorityWindow(w->window_number);

   296

				break;

   297

   298

			case 8: /* rename */

   299

				SetDParam(0, w->window_number);

   300

				ShowQueryString(STR_TOWN, STR_2007_RENAME_TOWN, 31, 130, w, CS_ALPHANUMERAL);

   301

				break;

   302

   303

			case 9: /* expand town */

   304

				ExpandTown(t);

   305

				break;

   306

   307

			case 10: /* delete town */

   308

				delete t;

   309

				break;

   310

		}

   311

		break;

   312

   313

	case WE_ON_EDIT_TEXT:

   314

		if (e->we.edittext.str[0] != '\0') {

   315

			_cmd_text = e->we.edittext.str;

   316

			DoCommandP(0, w->window_number, 0, NULL,

   317

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   318

		}

   319

		break;

   320

	}

   321

}

   322

   323

   324

static const Widget _town_view_widgets[] = {

   325

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

   326

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   247,     0,    13, STR_2005,                 STR_018C_WINDOW_TITLE_DRAG_THIS},

   327

{  WWT_STICKYBOX,   RESIZE_NONE,    13,   248,   259,     0,    13, 0x0,                      STR_STICKY_BUTTON},

   328

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,    14,   105, 0x0,                      STR_NULL},

   329

{      WWT_INSET,   RESIZE_NONE,    13,     2,   257,    16,   103, 0x0,                      STR_NULL},

   330

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,   106,   137, 0x0,                      STR_NULL},

   331

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,    85,   138,   149, STR_00E4_LOCATION,        STR_200B_CENTER_THE_MAIN_VIEW_ON},

   332

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    86,   171,   138,   149, STR_2020_LOCAL_AUTHORITY, STR_2021_SHOW_INFORMATION_ON_LOCAL},

   333

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   172,   259,   138,   149, STR_0130_RENAME,          STR_200C_CHANGE_TOWN_NAME},

   334

{   WIDGETS_END},

   335

};

   336

   337

static const WindowDesc _town_view_desc = {

   338

	WDP_AUTO, WDP_AUTO, 260, 150, 260, 150,

   339

	WC_TOWN_VIEW, WC_NONE,

   340

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   341

	_town_view_widgets,

   342

	TownViewWndProc

   343

};

   344

   345

static const Widget _town_view_scen_widgets[] = {

   346

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

   347

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   172,     0,    13, STR_2005,          STR_018C_WINDOW_TITLE_DRAG_THIS},

   348

{  WWT_STICKYBOX,   RESIZE_NONE,    13,   248,   259,     0,    13, 0x0,               STR_STICKY_BUTTON},

   349

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,    14,   105, 0x0,               STR_NULL},

   350

{      WWT_INSET,   RESIZE_NONE,    13,     2,   257,    16,   103, 0x0,               STR_NULL},

   351

{      WWT_PANEL,   RESIZE_NONE,    13,     0,   259,   106,   137, 0x0,               STR_NULL},

   352

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,    85,   138,   149, STR_00E4_LOCATION, STR_200B_CENTER_THE_MAIN_VIEW_ON},

   353

{      WWT_EMPTY,   RESIZE_NONE,     0,     0,     0,     0,     0, 0x0,               STR_NULL},

   354

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   173,   247,     0,    13, STR_0130_RENAME,   STR_200C_CHANGE_TOWN_NAME},

   355

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    86,   171,   138,   149, STR_023C_EXPAND,   STR_023B_INCREASE_SIZE_OF_TOWN},

   356

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   172,   259,   138,   149, STR_0290_DELETE,   STR_0291_DELETE_THIS_TOWN_COMPLETELY},

   357

{   WIDGETS_END},

   358

};

   359

   360

static const WindowDesc _town_view_scen_desc = {

   361

	WDP_AUTO, WDP_AUTO, 260, 150, 260, 150,

   362

	WC_TOWN_VIEW, WC_NONE,

   363

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   364

	_town_view_scen_widgets,

   365

	TownViewWndProc

   366

};

   367

   368

void ShowTownViewWindow(TownID town)

   369

{

   370

	Window *w;

   371

   372

	if (_game_mode != GM_EDITOR) {

   373

		w = AllocateWindowDescFront(&_town_view_desc, town);

   374

	} else {

   375

		w = AllocateWindowDescFront(&_town_view_scen_desc, town);

   376

	}

   377

   378

	if (w != NULL) {

   379

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   380

		AssignWindowViewport(w, 3, 17, 0xFE, 0x56, GetTown(town)->xy, ZOOM_LVL_TOWN);

   381

	}

   382

}

   383

   384

static const Widget _town_directory_widgets[] = {

   385

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

   386

{    WWT_CAPTION,   RESIZE_NONE,    13,    11,   195,     0,    13, STR_2000_TOWNS,         STR_018C_WINDOW_TITLE_DRAG_THIS},

   387

{  WWT_STICKYBOX,   RESIZE_NONE,    13,   196,   207,     0,    13, 0x0,                    STR_STICKY_BUTTON},

   388

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     0,    98,    14,    25, STR_SORT_BY_NAME,       STR_SORT_ORDER_TIP},

   389

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,    99,   195,    14,    25, STR_SORT_BY_POPULATION, STR_SORT_ORDER_TIP},

   390

{      WWT_PANEL, RESIZE_BOTTOM,    13,     0,   195,    26,   189, 0x0,                    STR_200A_TOWN_NAMES_CLICK_ON_NAME},

   391

{  WWT_SCROLLBAR, RESIZE_BOTTOM,    13,   196,   207,    14,   189, 0x0,                    STR_0190_SCROLL_BAR_SCROLLS_LIST},

   392

{      WWT_PANEL,     RESIZE_TB,    13,     0,   195,   190,   201, 0x0,                    STR_NULL},

   393

{  WWT_RESIZEBOX,     RESIZE_TB,    13,   196,   207,   190,   201, 0x0,                    STR_RESIZE_BUTTON},

   394

{   WIDGETS_END},

   395

};

   396

   397

   398

/* used to get a sorted list of the towns */

   399

static uint _num_town_sort;

   400

   401

static char _bufcache[64];

   402

static const Town* _last_town;

   403

   404

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

   405

{

   406

	const Town* ta = *(const Town**)a;

   407

	const Town* tb = *(const Town**)b;

   408

	char buf1[64];

   409

	int r;

   410

   411

	SetDParam(0, ta->index);

   412

	GetString(buf1, STR_TOWN, lastof(buf1));

   413

   414

	/* If 'b' is the same town as in the last round, use the cached value

   415

	 *  We do this to speed stuff up ('b' is called with the same value a lot of

   416

	 *  times after eachother) */

   417

	if (tb != _last_town) {

   418

		_last_town = tb;

   419

		SetDParam(0, tb->index);

   420

		GetString(_bufcache, STR_TOWN, lastof(_bufcache));

   421

	}

   422

   423

	r = strcmp(buf1, _bufcache);

   424

	if (_town_sort_order & 1) r = -r;

   425

	return r;

   426

}

   427

   428

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

   429

{

   430

	const Town* ta = *(const Town**)a;

   431

	const Town* tb = *(const Town**)b;

   432

	int r = ta->population - tb->population;

   433

	if (_town_sort_order & 1) r = -r;

   434

	return r;

   435

}

   436

   437

static void MakeSortedTownList()

   438

{

   439

	const Town* t;

   440

	uint n = 0;

   441

   442

	/* Create array for sorting */

   443

	_town_sort = ReallocT(_town_sort, GetMaxTownIndex() + 1);

   444

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

   445

   446

	FOR_ALL_TOWNS(t) _town_sort[n++] = t;

   447

   448

	_num_town_sort = n;

   449

   450

	_last_town = NULL; // used for "cache"

   451

	qsort((void*)_town_sort, n, sizeof(_town_sort[0]), _town_sort_order & 2 ? TownPopSorter : TownNameSorter);

   452

   453

	DEBUG(misc, 3, "Resorting towns list");

   454

}

   455

   456

   457

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

   458

{

   459

	switch (e->event) {

   460

	case WE_PAINT: {

   461

		if (_town_sort_dirty) {

   462

			_town_sort_dirty = false;

   463

			MakeSortedTownList();

   464

		}

   465

   466

		SetVScrollCount(w, _num_town_sort);

   467

   468

		DrawWindowWidgets(w);

   469

		DoDrawString(_town_sort_order & 1 ? DOWNARROW : UPARROW, (_town_sort_order <= 1) ? 88 : 187, 15, TC_BLACK);

   470

   471

		{

   472

			int n = 0;

   473

			uint16 i = w->vscroll.pos;

   474

			int y = 28;

   475

   476

			while (i < _num_town_sort) {

   477

				const Town* t = _town_sort[i];

   478

   479

				assert(t->xy);

   480

   481

				SetDParam(0, t->index);

   482

				SetDParam(1, t->population);

   483

				DrawString(2, y, STR_2057, TC_FROMSTRING);

   484

   485

				y += 10;

   486

				i++;

   487

				if (++n == w->vscroll.cap) break; // max number of towns in 1 window

   488

			}

   489

			SetDParam(0, GetWorldPopulation());

   490

			DrawString(3, w->height - 12 + 2, STR_TOWN_POPULATION, TC_FROMSTRING);

   491

		}

   492

	} break;

   493

   494

	case WE_CLICK: