1

/* $Id$ */

     2

     3

/** @file town_gui.cpp GUI for towns. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "town.h"

     9

#include "viewport_func.h"

    10

#include "gfx_func.h"

    11

#include "gui.h"

    12

#include "window_gui.h"

    13

#include "textbuf_gui.h"

    14

#include "command_func.h"

    15

#include "player_func.h"

    16

#include "player_base.h"

    17

#include "player_gui.h"

    18

#include "network/network.h"

    19

#include "variables.h"

    20

#include "strings_func.h"

    21

#include "sound_func.h"

    22

#include "economy_func.h"

    23

#include "core/alloc_func.hpp"

    24

#include "settings_type.h"

    25

#include "tilehighlight_func.h"

    26

#include "string_func.h"

    27

    28

#include "table/sprites.h"

    29

#include "table/strings.h"

    30

    31

extern bool GenerateTowns();

    32

static int _scengen_town_size = 1; // depress medium-sized towns per default

    33

    34

enum TownAuthorityWidget {

    35

	TWA_CLOSEBOX = 0,

    36

	TWA_CAPTION,

    37

	TWA_RATING_INFO,

    38

	TWA_COMMAND_LIST,

    39

	TWA_SCROLLBAR,

    40

	TWA_ACTION_INFO,

    41

	TWA_EXECUTE,

    42

};

    43

    44

static const Widget _town_authority_widgets[] = {

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

{   WIDGETS_END},

    53

};

    54

    55

extern const byte _town_action_costs[8];

    56

    57

enum TownActions {

    58

	TACT_NONE             = 0x00,

    59

    60

	TACT_ADVERTISE_SMALL  = 0x01,

    61

	TACT_ADVERTISE_MEDIUM = 0x02,

    62

	TACT_ADVERTISE_LARGE  = 0x04,

    63

	TACT_ROAD_REBUILD     = 0x08,

    64

	TACT_BUILD_STATUE     = 0x10,

    65

	TACT_FOUND_BUILDINGS  = 0x20,

    66

	TACT_BUY_RIGHTS       = 0x40,

    67

	TACT_BRIBE            = 0x80,

    68

    69

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    70

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    71

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    72

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    73

};

    74

    75

DECLARE_ENUM_AS_BIT_SET(TownActions);

    76

    77

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

    78

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

    79

 * @param pid the player that is querying the town

    80

 * @param t the town that is queried

    81

 * @return bitmasked value of enabled actions

    82

 */

    83

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

    84

{

    85

	int num = 0;

    86

	TownActions buttons = TACT_NONE;

    87

    88

	/* Spectators and unwanted have no options */

    89

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

    90

    91

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

    92

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

    93

		Money ref = _price.build_industry >> 8;

    94

    95

		/* Check the action bits for validity and

    96

		 * if they are valid add them */

    97

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

    98

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

    99

   100

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

   101

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

   102

				continue;

   103

   104

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

   105

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

   106

				continue;

   107

   108

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

   109

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

   110

				continue;

   111

   112

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

   113

				buttons |= cur;

   114

				num++;

   115

			}

   116

		}

   117

	}

   118

   119

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

   120

	return buttons;

   121

}

   122

   123

/**

   124

 * Get the position of the Nth set bit.

   125

 *

   126

 * If there is no Nth bit set return -1

   127

 *

   128

 * @param bits The value to search in

   129

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

   130

 * @return The position of the Nth set bit

   131

 */

   132

static int GetNthSetBit(uint32 bits, int n)

   133

{

   134

	if (n >= 0) {

   135

		uint i;

   136

		FOR_EACH_SET_BIT(i, bits) {

   137

			n--;

   138

			if (n < 0) return i;

   139

		}

   140

	}

   141

	return -1;

   142

}

   143

   144

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

   145

{

   146

	switch (e->event) {

   147

		case WE_PAINT: {

   148

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

   149

			int numact;

   150

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

   151

   152

			SetVScrollCount(w, numact + 1);

   153

   154

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

   155

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

   156

   157

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

   158

   159

			{

   160

				int y;

   161

				const Player *p;

   162

				int r;

   163

				StringID str;

   164

   165

				SetDParam(0, w->window_number);

   166

				DrawWindowWidgets(w);

   167

   168

				DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   169

   170

				/* Draw list of players */

   171

				y = 25;

   172

				FOR_ALL_PLAYERS(p) {

   173

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

   174

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

   175

   176

						SetDParam(0, p->index);

   177

						SetDParam(1, p->index);

   178

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

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

   187

						(str++,                    true);                    // Outstanding

   188

   189

						SetDParam(2, str);

   190

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

   191

							DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   192

						}

   193

   194

						DrawString(28, y, STR_2024, TC_FROMSTRING);

   195

						y += 10;

   196

					}

   197

				}

   198

			}

   199

   200

			/* Draw actions list */

   201

			{

   202

				int y = 107, i;

   203

				int pos = w->vscroll.pos;

   204

   205

				if (--pos < 0) {

   206

					DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   207

					y += 10;

   208

				}

   209

   210

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

   211

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

   212

   213

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

   214

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

   215

						y += 10;

   216

					}

   217

				}

   218

			}

   219

   220

			{

   221

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

   222

   223

				if (i != -1) {

   224

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

   225

					SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   226

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

   227

				}

   228

			}

   229

   230

		} break;

   231

   232

		case WE_DOUBLE_CLICK:

   233

		case WE_CLICK:

   234

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

   235

				case TWA_COMMAND_LIST: {

   236

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

   237

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

   238

   239

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

   240

   241

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

   242

					if (y >= 0) {

   243

						WP(w, def_d).data_1 = y;

   244

						w->SetDirty();

   245

					}

   246

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

   247

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

   248

				}

   249

   250

				case TWA_EXECUTE:

   251

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

   252

					break;

   253

			}

   254

			break;

   255

   256

		case WE_100_TICKS:

   257

			w->SetDirty();

   258

			break;

   259

	}

   260

}

   261

   262

static const WindowDesc _town_authority_desc = {

   263

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

   264

	WC_TOWN_AUTHORITY, WC_NONE,

   265

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   266

	_town_authority_widgets,

   267

	TownAuthorityWndProc

   268

};

   269

   270

static void ShowTownAuthorityWindow(uint town)

   271

{

   272

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

   273

   274

	if (w != NULL) {

   275

		w->vscroll.cap = 5;

   276

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

   277

	}

   278

}

   279

   280

   281

enum TownViewWidget {

   282

	TVW_CAPTION = 1,

   283

	TVW_STICKY,

   284

	TVW_CENTERVIEW = 6,

   285

	TVW_SHOWAUTORITY,

   286

	TVW_CHANGENAME,

   287

	TVW_EXPAND,

   288

	TVW_DELETE,

   289

};

   290

   291

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

   292

{

   293

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

   294

   295

	switch (e->event) {

   296

		case WE_CREATE: {

   297

			bool ingame = _game_mode != GM_EDITOR;

   298

			if (t->larger_town) w->widget[TVW_CAPTION].data = STR_CITY;

   299

			w->SetWidgetHiddenState(TVW_DELETE, ingame);  // hide delete button on game mode

   300

			w->SetWidgetHiddenState(TVW_EXPAND, ingame);  // hide expand button on game mode

   301

			w->SetWidgetHiddenState(TVW_SHOWAUTORITY, !ingame); // hide autority button on editor mode

   302

   303

			if (ingame) {

   304

				/* resize caption bar */

   305

				w->widget[TVW_CAPTION].right = w->widget[TVW_STICKY].left -1;

   306

				/* move the rename from top on scenario to bottom in game */

   307

				w->widget[TVW_CHANGENAME].top = w->widget[TVW_EXPAND].top;

   308

				w->widget[TVW_CHANGENAME].bottom = w->widget[TVW_EXPAND].bottom;

   309

				w->widget[TVW_CHANGENAME].right = w->widget[TVW_STICKY].right;

   310

			}

   311

		} break;

   312

   313

		case WE_PAINT:

   314

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

   315

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

   316

   317

			SetDParam(0, t->index);

   318

			DrawWindowWidgets(w);

   319

   320

			SetDParam(0, t->population);

   321

			SetDParam(1, t->num_houses);

   322

			DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   323

   324

			SetDParam(0, t->act_pass);

   325

			SetDParam(1, t->max_pass);

   326

			DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   327

   328

			SetDParam(0, t->act_mail);

   329

			SetDParam(1, t->max_mail);

   330

			DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   331

   332

			DrawWindowViewport(w);

   333

			break;

   334

   335

		case WE_CLICK:

   336

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

   337

				case TVW_CENTERVIEW: /* scroll to location */

   338

					if (_ctrl_pressed) {

   339

						ShowExtraViewPortWindow(t->xy);

   340

					} else {

   341

						ScrollMainWindowToTile(t->xy);

   342

					}

   343

					break;

   344

   345

				case TVW_SHOWAUTORITY: /* town authority */

   346

					ShowTownAuthorityWindow(w->window_number);

   347

					break;

   348

   349

				case TVW_CHANGENAME: /* rename */

   350

					SetDParam(0, w->window_number);

   351

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

   352

					break;

   353

   354

				case TVW_EXPAND: /* expand town - only available on Scenario editor */

   355

					ExpandTown(t);

   356

					break;

   357

   358

				case TVW_DELETE: /* delete town - only available on Scenario editor */

   359

					delete t;

   360

					break;

   361

			} break;

   362

   363

		case WE_ON_EDIT_TEXT:

   364

			if (!StrEmpty(e->we.edittext.str)) {

   365

				_cmd_text = e->we.edittext.str;

   366

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

   367

					CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   368

			}

   369

			break;

   370

	}

   371

}

   372

   373

   374

static const Widget _town_view_widgets[] = {

   375

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

   376

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

   377

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

   378

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

   379

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

   380

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

   381

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

   382

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

   383

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

   384

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

   385

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

   386

{   WIDGETS_END},

   387

};

   388

   389

static const WindowDesc _town_view_desc = {

   390

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

   391

	WC_TOWN_VIEW, WC_NONE,

   392

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   393

	_town_view_widgets,

   394

	TownViewWndProc

   395

};

   396

   397

void ShowTownViewWindow(TownID town)

   398

{

   399

	Window *w;

   400

   401

	w = AllocateWindowDescFront<Window>(&_town_view_desc, town);

   402

   403

	if (w != NULL) {

   404

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   405

		InitializeWindowViewport(w, 3, 17, 254, 86, GetTown(town)->xy, ZOOM_LVL_TOWN);

   406

	}

   407

}

   408

   409

enum TownDirectoryWidget {

   410

	TDW_SORTNAME = 3,

   411

	TDW_SORTPOPULATION,

   412

	TDW_CENTERTOWN,

   413

};

   414

static const Widget _town_directory_widgets[] = {

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

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

   424

{   WIDGETS_END},

   425

};

   426

   427

   428

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

   429

static uint _num_town_sort;

   430

   431

static char _bufcache[64];

   432

static const Town* _last_town;

   433

   434

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

   435

{

   436

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

   437

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

   438

	char buf1[64];

   439

	int r;

   440

   441

	SetDParam(0, ta->index);

   442

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

   443

   444

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

   445

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

   446

	 *  times after eachother) */

   447

	if (tb != _last_town) {

   448

		_last_town = tb;

   449

		SetDParam(0, tb->index);

   450

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

   451

	}

   452

   453

	r = strcmp(buf1, _bufcache);

   454

	if (_town_sort_order & 1) r = -r;

   455

	return r;

   456

}

   457

   458

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

   459

{

   460

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

   461

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

   462

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

   463

	if (_town_sort_order & 1) r = -r;

   464

	return r;

   465

}

   466

   467

static void MakeSortedTownList()

   468

{

   469

	const Town* t;

   470

	uint n = 0;

   471

   472

	/* Create array for sorting */

   473

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

   474

   475

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

   476

   477

	_num_town_sort = n;

   478

   479

	_last_town = NULL; // used for "cache"

   480

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

   481

   482

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

   483

}

   484

   485

   486

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

   487

{

   488

	switch (e->event) {

   489

		case WE_PAINT: {

   490

			if (_town_sort_dirty) {

   491

				_town_sort_dirty = false;