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 "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "town.h"

    12

#include "gfx.h"

    13

#include "viewport.h"

    14

#include "gui.h"

    15

#include "window_gui.h"

    16

#include "textbuf_gui.h"

    18

#include "player.h"

    19

#include "network/network.h"

    20

#include "variables.h"

    21

#include "helpers.hpp"

    22

#include "strings_func.h"

    24

    25

enum TownAuthorityWidget {

    26

	TWA_CLOSEBOX = 0,

    27

	TWA_CAPTION,

    28

	TWA_RATING_INFO,

    29

	TWA_COMMAND_LIST,

    30

	TWA_SCROLLBAR,

    31

	TWA_ACTION_INFO,

    32

	TWA_EXECUTE,

    33

};

    34

    35

static const Widget _town_authority_widgets[] = {

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

{   WIDGETS_END},

    44

};

    45

    46

extern const byte _town_action_costs[8];

    47

    48

enum TownActions {

    49

	TACT_NONE             = 0x00,

    50

    51

	TACT_ADVERTISE_SMALL  = 0x01,

    52

	TACT_ADVERTISE_MEDIUM = 0x02,

    53

	TACT_ADVERTISE_LARGE  = 0x04,

    54

	TACT_ROAD_REBUILD     = 0x08,

    55

	TACT_BUILD_STATUE     = 0x10,

    56

	TACT_FOUND_BUILDINGS  = 0x20,

    57

	TACT_BUY_RIGHTS       = 0x40,

    58

	TACT_BRIBE            = 0x80,

    59

    60

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    61

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    62

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    63

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    64

};

    65

    66

DECLARE_ENUM_AS_BIT_SET(TownActions);

    67

    68

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

    69

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

    70

 * @param pid the player that is querying the town

    71

 * @param t the town that is queried

    72

 * @return bitmasked value of enabled actions

    73

 */

    74

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

    75

{

    76

	int num = 0;

    77

	TownActions buttons = TACT_NONE;

    78

    79

	/* Spectators and unwanted have no options */

    80

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

    81

    82

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

    83

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

    84

		Money ref = _price.build_industry >> 8;

    85

    86

		/* Check the action bits for validity and

    87

		 * if they are valid add them */

    88

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

    89

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

    90

    91

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

    92

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

    93

				continue;

    94

    95

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

    96

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

    97

				continue;

    98

    99

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

   100

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

   101

				continue;

   102

   103

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

   104

				buttons |= cur;

   105

				num++;

   106

			}

   107

		}

   108

	}

   109

   110

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

   111

	return buttons;

   112

}

   113

   114

/**

   115

 * Get the position of the Nth set bit.

   116

 *

   117

 * If there is no Nth bit set return -1

   118

 *

   119

 * @param bits The value to search in

   120

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

   121

 * @return The position of the Nth set bit

   122

 */

   123

static int GetNthSetBit(uint32 bits, int n)

   124

{

   125

	if (n >= 0) {

   126

		uint i;

   127

		FOR_EACH_SET_BIT(i, bits) {

   128

			n--;

   129

			if (n < 0) return i;

   130

		}

   131

	}

   132

	return -1;

   133

}

   134

   135

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

   136

{

   137

	switch (e->event) {

   138

	case WE_PAINT: {

   139

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

   140

		int numact;

   141

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

   142

   143

		SetVScrollCount(w, numact + 1);

   144

   145

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

   146

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

   147

   148

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

   149

   150

		{

   151

			int y;

   152

			const Player *p;

   153

			int r;

   154

			StringID str;

   155

   156

			SetDParam(0, w->window_number);

   157

			DrawWindowWidgets(w);

   158

   159

			DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   160

   161

			/* Draw list of players */

   162

			y = 25;

   163

			FOR_ALL_PLAYERS(p) {

   164

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

   165

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

   166

   167

					SetDParam(0, p->index);

   168

					SetDParam(1, p->index);

   169

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

					(str++,                    true);                    // Outstanding

   179

   180

					SetDParam(2, str);

   181

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

   182

						DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   183

					}

   184

   185

					DrawString(28, y, STR_2024, TC_FROMSTRING);

   186

					y += 10;

   187

				}

   188

			}

   189

		}

   190

   191

		/* Draw actions list */

   192

		{

   193

			int y = 107, i;

   194

			int pos = w->vscroll.pos;

   195

   196

			if (--pos < 0) {

   197

				DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   198

				y += 10;

   199

			}

   200

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

   201

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

   202

   203

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

   204

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

   205

					y += 10;

   206

				}

   207

			}

   208

		}

   209

   210

		{

   211

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

   212

   213

			if (i != -1) {

   214

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

   215

				SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   216

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

   217

			}

   218

		}

   219

   220

	} break;

   221

   222

	case WE_DOUBLE_CLICK:

   223

	case WE_CLICK:

   224

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

   225

		case TWA_COMMAND_LIST: {

   226

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

   227

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

   228

   229

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

   230

   231

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

   232

			if (y >= 0) {

   233

				WP(w, def_d).data_1 = y;

   234

				SetWindowDirty(w);

   235

			}

   236

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

   237

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

   238

		}

   239

   240

		case TWA_EXECUTE: {

   241

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

   242

			break;

   243

		}

   244

		}

   245

		break;

   246

   247

	case WE_4:

   248

		SetWindowDirty(w);

   249

		break;

   250

	}

   251

}

   252

   253

static const WindowDesc _town_authority_desc = {

   254

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

   255

	WC_TOWN_AUTHORITY, WC_NONE,

   256

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   257

	_town_authority_widgets,

   258

	TownAuthorityWndProc

   259

};

   260

   261

static void ShowTownAuthorityWindow(uint town)

   262

{

   263

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

   264

   265

	if (w != NULL) {

   266

		w->vscroll.cap = 5;

   267

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

   268

	}

   269

}

   270

   271

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

   272

{

   273

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

   274

   275

	switch (e->event) {

   276

	case WE_PAINT:

   277

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

   278

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

   279

   280

		SetDParam(0, t->index);

   281

		DrawWindowWidgets(w);

   282

   283

		SetDParam(0, t->population);

   284

		SetDParam(1, t->num_houses);

   285

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   286

   287

		SetDParam(0, t->act_pass);

   288

		SetDParam(1, t->max_pass);

   289

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   290

   291

		SetDParam(0, t->act_mail);

   292

		SetDParam(1, t->max_mail);

   293

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   294

   295

		DrawWindowViewport(w);

   296

		break;

   297

   298

	case WE_CLICK:

   299

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

   300

			case 6: /* scroll to location */

   301

				ScrollMainWindowToTile(t->xy);

   302

				break;

   303

   304

			case 7: /* town authority */

   305

				ShowTownAuthorityWindow(w->window_number);

   306

				break;

   307

   308

			case 8: /* rename */

   309

				SetDParam(0, w->window_number);

   310

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

   311

				break;

   312

   313

			case 9: /* expand town */

   314

				ExpandTown(t);

   315

				break;

   316

   317

			case 10: /* delete town */

   318

				delete t;

   319

				break;

   320

		}

   321

		break;

   322

   323

	case WE_ON_EDIT_TEXT:

   324

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

   325

			_cmd_text = e->we.edittext.str;

   326

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

   327

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   328

		}

   329

		break;

   330

	}

   331

}

   332

   333

   334

static const Widget _town_view_widgets[] = {

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

{   WIDGETS_END},

   345

};

   346

   347

static const WindowDesc _town_view_desc = {

   348

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

   349

	WC_TOWN_VIEW, WC_NONE,

   350

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   351

	_town_view_widgets,

   352

	TownViewWndProc

   353

};

   354

   355

static const Widget _town_view_scen_widgets[] = {

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

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

   367

{   WIDGETS_END},

   368

};

   369

   370

static const WindowDesc _town_view_scen_desc = {

   371

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

   372

	WC_TOWN_VIEW, WC_NONE,

   373

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   374

	_town_view_scen_widgets,

   375

	TownViewWndProc

   376

};

   377

   378

void ShowTownViewWindow(TownID town)

   379

{

   380

	Window *w;

   381

   382

	if (_game_mode != GM_EDITOR) {

   383

		w = AllocateWindowDescFront(&_town_view_desc, town);

   384

	} else {

   385

		w = AllocateWindowDescFront(&_town_view_scen_desc, town);

   386

	}

   387

   388

	if (w != NULL) {

   389

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   390

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

   391

	}

   392

}

   393

   394

static const Widget _town_directory_widgets[] = {

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

{   WIDGETS_END},

   405

};

   406

   407

   408

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

   409

static uint _num_town_sort;

   410

   411

static char _bufcache[64];

   412

static const Town* _last_town;

   413

   414

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

   415

{

   416

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

   417

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

   418

	char buf1[64];

   419

	int r;

   420

   421

	SetDParam(0, ta->index);

   422

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

   423

   424

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

   425

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

   426

	 *  times after eachother) */

   427

	if (tb != _last_town) {

   428

		_last_town = tb;

   429

		SetDParam(0, tb->index);

   430

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

   431

	}

   432

   433

	r = strcmp(buf1, _bufcache);

   434

	if (_town_sort_order & 1) r = -r;

   435

	return r;

   436

}

   437

   438

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

   439

{

   440

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

   441

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

   442

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

   443

	if (_town_sort_order & 1) r = -r;

   444

	return r;

   445

}

   446

   447

static void MakeSortedTownList()

   448

{

   449

	const Town* t;

   450

	uint n = 0;

   451

   452

	/* Create array for sorting */

   453

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

   454

   455

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

   456

   457

	_num_town_sort = n;

   458

   459

	_last_town = NULL; // used for "cache"

   460

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

   461

   462

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

   463

}

   464

   465

   466

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

   467

{

   468

	switch (e->event) {

   469

	case WE_PAINT: {

   470

		if (_town_sort_dirty) {

   471

			_town_sort_dirty = false;

   472

			MakeSortedTownList();

   473

		}

   474

   475

		SetVScrollCount(w, _num_town_sort);

   476

   477

		DrawWindowWidgets(w);

   478

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

   479

   480

		{

   481

			int n = 0;

   482

			uint16 i = w->vscroll.pos;

   483

			int y = 28;

   484

   485

			while (i < _num_town_sort) {

   486

				const Town* t = _town_sort[i];

   487

   488

				assert(t->xy);

   489

   490

				SetDParam(0, t->index);

   491

				SetDParam(1, t->population);

   492

				DrawString(2, y, STR_2057, TC_FROMSTRING);

   493