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

/**

   113

 * Get the position of the Nth set bit.

   114

 *

   115

 * If there is no Nth bit set return -1

   116

 *

   117

 * @param bits The value to search in

   118

 * @param n The Nth set bit from which we want to know the position

   119

 * @return The position of the Nth set bit

   120

 */

   121

static int GetNthSetBit(uint32 bits, int n)

   122

{

   123

	if (n >= 0) {

   124

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

   125

			if (bits & 1) n--;

   126

			if (n < 0) return i;

   127

		}

   128

	}

   129

	return -1;

   130

}

   131

   132

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

   133

{

   134

	switch (e->event) {

   135

	case WE_PAINT: {

   136

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

   137

		int numact;

   138

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

   139

   140

		SetVScrollCount(w, numact + 1);

   141

   142

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

   143

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

   144

   145

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

   146

   147

		{

   148

			int y;

   149

			const Player *p;

   150

			int r;

   151

			StringID str;

   152

   153

			SetDParam(0, w->window_number);

   154

			DrawWindowWidgets(w);

   155

   156

			DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   157

   158

			/* Draw list of players */

   159

			y = 25;

   160

			FOR_ALL_PLAYERS(p) {

   161

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

   162

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

   163

   164

					SetDParam(0, p->index);

   165

					SetDParam(1, p->index);

   166

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

					(str++,                    true);                    // Outstanding

   176

   177

					SetDParam(2, str);

   178

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

   179

						DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   180

					}

   181

   182

					DrawString(28, y, STR_2024, TC_FROMSTRING);

   183

					y += 10;

   184

				}

   185

			}

   186

		}

   187

   188

		/* Draw actions list */

   189

		{

   190

			int y = 107, i;

   191

			int pos = w->vscroll.pos;

   192

   193

			if (--pos < 0) {

   194

				DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   195

				y += 10;

   196

			}

   197

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

   198

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

   199

   200

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

   201

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

   202

					y += 10;

   203

				}

   204

			}

   205

		}

   206

   207

		{

   208

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

   209

   210

			if (i != -1) {

   211

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

   212

				SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   213

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

   214

			}

   215

		}

   216

   217

	} break;

   218

   219

	case WE_DOUBLE_CLICK:

   220

	case WE_CLICK:

   221

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

   222

		case TWA_COMMAND_LIST: {

   223

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

   224

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

   225

   226

			if (!IsInsideMM(y, 0, 5)) return;

   227

   228

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

   229

			if (y >= 0) {

   230

				WP(w,def_d).data_1 = y;

   231

				SetWindowDirty(w);

   232

			}

   233

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

   234

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

   235

		}

   236

   237

		case TWA_EXECUTE: {

   238

			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));

   239

			break;

   240

		}

   241

		}

   242

		break;

   243

   244

	case WE_4:

   245

		SetWindowDirty(w);

   246

		break;

   247

	}

   248

}

   249

   250

static const WindowDesc _town_authority_desc = {

   251

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

   252

	WC_TOWN_AUTHORITY, WC_NONE,

   253

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   254

	_town_authority_widgets,

   255

	TownAuthorityWndProc

   256

};

   257

   258

static void ShowTownAuthorityWindow(uint town)

   259

{

   260

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

   261

   262

	if (w != NULL) {

   263

		w->vscroll.cap = 5;

   264

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

   265

	}

   266

}

   267

   268

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

   269

{

   270

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

   271

   272

	switch (e->event) {

   273

	case WE_PAINT:

   274

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

   275

		w->SetWidgetDisabledState(8, _networking && !_network_server);

   276

   277

		SetDParam(0, t->index);

   278

		DrawWindowWidgets(w);

   279

   280

		SetDParam(0, t->population);

   281

		SetDParam(1, t->num_houses);

   282

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   283

   284

		SetDParam(0, t->act_pass);

   285

		SetDParam(1, t->max_pass);

   286

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   287

   288

		SetDParam(0, t->act_mail);

   289

		SetDParam(1, t->max_mail);

   290

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   291

   292

		DrawWindowViewport(w);

   293

		break;

   294

   295

	case WE_CLICK:

   296

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

   297

			case 6: /* scroll to location */

   298

				ScrollMainWindowToTile(t->xy);

   299

				break;

   300

   301

			case 7: /* town authority */

   302

				ShowTownAuthorityWindow(w->window_number);

   303

				break;

   304

   305

			case 8: /* rename */

   306

				SetDParam(0, w->window_number);

   307

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

   308

				break;

   309

   310

			case 9: /* expand town */

   311

				ExpandTown(t);

   312

				break;

   313

   314

			case 10: /* delete town */

   315

				delete t;

   316

				break;

   317

		}

   318

		break;

   319

   320

	case WE_ON_EDIT_TEXT:

   321

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

   322

			_cmd_text = e->we.edittext.str;

   323

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

   324

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   325

		}

   326

		break;

   327

	}

   328

}

   329

   330

   331

static const Widget _town_view_widgets[] = {

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

{   WIDGETS_END},

   342

};

   343

   344

static const WindowDesc _town_view_desc = {

   345

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

   346

	WC_TOWN_VIEW, WC_NONE,

   347

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   348

	_town_view_widgets,

   349

	TownViewWndProc

   350

};

   351

   352

static const Widget _town_view_scen_widgets[] = {

   353

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

   354

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

   355

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

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

{   WIDGETS_END},

   365

};

   366

   367

static const WindowDesc _town_view_scen_desc = {

   368

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

   369

	WC_TOWN_VIEW, WC_NONE,

   370

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   371

	_town_view_scen_widgets,

   372

	TownViewWndProc

   373

};

   374

   375

void ShowTownViewWindow(TownID town)

   376

{

   377

	Window *w;

   378

   379

	if (_game_mode != GM_EDITOR) {

   380

		w = AllocateWindowDescFront(&_town_view_desc, town);

   381

	} else {

   382

		w = AllocateWindowDescFront(&_town_view_scen_desc, town);

   383

	}

   384

   385

	if (w != NULL) {

   386

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   387

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

   388

	}

   389

}

   390

   391

static const Widget _town_directory_widgets[] = {

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

{   WIDGETS_END},

   402

};

   403

   404

   405

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

   406

static uint _num_town_sort;

   407

   408

static char _bufcache[64];

   409

static const Town* _last_town;

   410

   411

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

   412

{

   413

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

   414

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

   415

	char buf1[64];

   416

	int r;

   417

   418

	SetDParam(0, ta->index);

   419

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

   420

   421

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

   422

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

   423

	 *  times after eachother) */

   424

	if (tb != _last_town) {

   425

		_last_town = tb;

   426

		SetDParam(0, tb->index);

   427

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

   428

	}

   429

   430

	r = strcmp(buf1, _bufcache);

   431

	if (_town_sort_order & 1) r = -r;

   432

	return r;

   433

}

   434

   435

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

   436

{

   437

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

   438

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

   439

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

   440

	if (_town_sort_order & 1) r = -r;

   441

	return r;

   442

}

   443

   444

static void MakeSortedTownList()

   445

{

   446

	const Town* t;

   447

	uint n = 0;

   448

   449

	/* Create array for sorting */

   450

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

   451

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

   452

   453

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

   454

   455

	_num_town_sort = n;

   456

   457

	_last_town = NULL; // used for "cache"

   458

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

   459

   460

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

   461

}

   462

   463

   464

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

   465

{

   466

	switch (e->event) {

   467

	case WE_PAINT: {

   468

		if (_town_sort_dirty) {

   469

			_town_sort_dirty = false;

   470

			MakeSortedTownList();

   471

		}

   472

   473

		SetVScrollCount(w, _num_town_sort);

   474

   475

		DrawWindowWidgets(w);

   476

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

   477

   478

		{

   479

			int n = 0;

   480

			uint16 i = w->vscroll.pos;

   481

			int y = 28;

   482

   483

			while (i < _num_town_sort) {

   484

				const Town* t = _town_sort[i];

   485

   486

				assert(t->xy);

   487

   488

				SetDParam(0, t->index);

   489

				SetDParam(1, t->population);

   490

				DrawString(2, y, STR_2057, TC_FROMSTRING);

   491

   492

				y += 10;

   493

				i++;

   494