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

    27

#include "table/sprites.h"

    28

#include "table/strings.h"

    29

    30

extern bool GenerateTowns();

    31

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

    32

    33

enum TownAuthorityWidget {

    34

	TWA_CLOSEBOX = 0,

    35

	TWA_CAPTION,

    36

	TWA_RATING_INFO,

    37

	TWA_COMMAND_LIST,

    38

	TWA_SCROLLBAR,

    39

	TWA_ACTION_INFO,

    40

	TWA_EXECUTE,

    41

};

    42

    43

static const Widget _town_authority_widgets[] = {

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

{   WIDGETS_END},

    52

};

    53

    54

extern const byte _town_action_costs[8];

    55

    56

enum TownActions {

    57

	TACT_NONE             = 0x00,

    58

    59

	TACT_ADVERTISE_SMALL  = 0x01,

    60

	TACT_ADVERTISE_MEDIUM = 0x02,

    61

	TACT_ADVERTISE_LARGE  = 0x04,

    62

	TACT_ROAD_REBUILD     = 0x08,

    63

	TACT_BUILD_STATUE     = 0x10,

    64

	TACT_FOUND_BUILDINGS  = 0x20,

    65

	TACT_BUY_RIGHTS       = 0x40,

    66

	TACT_BRIBE            = 0x80,

    67

    68

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    69

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    70

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    71

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    72

};

    73

    74

DECLARE_ENUM_AS_BIT_SET(TownActions);

    75

    76

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

    77

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

    78

 * @param pid the player that is querying the town

    79

 * @param t the town that is queried

    80

 * @return bitmasked value of enabled actions

    81

 */

    82

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

    83

{

    84

	int num = 0;

    85

	TownActions buttons = TACT_NONE;

    86

    87

	/* Spectators and unwanted have no options */

    88

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

    89

    90

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

    91

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

    92

		Money ref = _price.build_industry >> 8;

    93

    94

		/* Check the action bits for validity and

    95

		 * if they are valid add them */

    96

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

    97

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

    98

    99

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

   100

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

   101

				continue;

   102

   103

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

   104

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

   105

				continue;

   106

   107

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

   108

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

   109

				continue;

   110

   111

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

   112

				buttons |= cur;

   113

				num++;

   114

			}

   115

		}

   116

	}

   117

   118

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

   119

	return buttons;

   120

}

   121

   122

/**

   123

 * Get the position of the Nth set bit.

   124

 *

   125

 * If there is no Nth bit set return -1

   126

 *

   127

 * @param bits The value to search in

   128

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

   129

 * @return The position of the Nth set bit

   130

 */

   131

static int GetNthSetBit(uint32 bits, int n)

   132

{

   133

	if (n >= 0) {

   134

		uint i;

   135

		FOR_EACH_SET_BIT(i, bits) {

   136

			n--;

   137

			if (n < 0) return i;

   138

		}

   139

	}

   140

	return -1;

   141

}

   142

   143

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

   144

{

   145

	switch (e->event) {

   146

		case WE_PAINT: {

   147

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

   148

			int numact;

   149

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

   150

   151

			SetVScrollCount(w, numact + 1);

   152

   153

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

   154

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

   155

   156

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

   157

   158

			{

   159

				int y;

   160

				const Player *p;

   161

				int r;

   162

				StringID str;

   163

   164

				SetDParam(0, w->window_number);

   165

				DrawWindowWidgets(w);

   166

   167

				DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   168

   169

				/* Draw list of players */

   170

				y = 25;

   171

				FOR_ALL_PLAYERS(p) {

   172

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

   173

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

   174

   175

						SetDParam(0, p->index);

   176

						SetDParam(1, p->index);

   177

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

						(str++,                    true);                    // Outstanding

   187

   188

						SetDParam(2, str);

   189

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

   190

							DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   191

						}

   192

   193

						DrawString(28, y, STR_2024, TC_FROMSTRING);

   194

						y += 10;

   195

					}

   196

				}

   197

			}

   198

   199

			/* Draw actions list */

   200

			{

   201

				int y = 107, i;

   202

				int pos = w->vscroll.pos;

   203

   204

				if (--pos < 0) {

   205

					DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   206

					y += 10;

   207

				}

   208

   209

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

   210

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

   211

   212

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

   213

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

   214

						y += 10;

   215

					}

   216

				}

   217

			}

   218

   219

			{

   220

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

   221

   222

				if (i != -1) {

   223

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

   224

					SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   225

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

   226

				}

   227

			}

   228

   229

		} break;

   230

   231

		case WE_DOUBLE_CLICK:

   232

		case WE_CLICK:

   233

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

   234

				case TWA_COMMAND_LIST: {

   235

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

   236

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

   237

   238

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

   239

   240

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

   241

					if (y >= 0) {

   242

						WP(w, def_d).data_1 = y;

   243

						w->SetDirty();

   244

					}

   245

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

   246

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

   247

				}

   248

   249

				case TWA_EXECUTE:

   250

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

   251

					break;

   252

			}

   253

			break;

   254

   255

		case WE_4:

   256

			w->SetDirty();

   257

			break;

   258

	}

   259

}

   260

   261

static const WindowDesc _town_authority_desc = {

   262

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

   263

	WC_TOWN_AUTHORITY, WC_NONE,

   264

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   265

	_town_authority_widgets,

   266

	TownAuthorityWndProc

   267

};

   268

   269

static void ShowTownAuthorityWindow(uint town)

   270

{

   271

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

   272

   273

	if (w != NULL) {

   274

		w->vscroll.cap = 5;

   275

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

   276

	}

   277

}

   278

   279

   280

enum TownViewWidget {

   281

	TVW_CAPTION = 1,

   282

	TVW_STICKY,

   283

	TVW_CENTERVIEW = 6,

   284

	TVW_SHOWAUTORITY,

   285

	TVW_CHANGENAME,

   286

	TVW_EXPAND,

   287

	TVW_DELETE,

   288

};

   289

   290

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

   291

{

   292

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

   293

   294

	switch (e->event) {

   295

		case WE_CREATE: {

   296

			bool ingame = _game_mode != GM_EDITOR;

   297

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

   298

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

   299

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

   300

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

   301

   302

			if (ingame) {

   303

				/* resize caption bar */

   304

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

   305

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

   306

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

   307

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

   308

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

   309

			}

   310

		} break;

   311

   312

		case WE_PAINT:

   313

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

   314

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

   315

   316

			SetDParam(0, t->index);

   317

			DrawWindowWidgets(w);

   318

   319

			SetDParam(0, t->population);

   320

			SetDParam(1, t->num_houses);

   321

			DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   322

   323

			SetDParam(0, t->act_pass);

   324

			SetDParam(1, t->max_pass);

   325

			DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   326

   327

			SetDParam(0, t->act_mail);

   328

			SetDParam(1, t->max_mail);

   329

			DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   330

   331

			DrawWindowViewport(w);

   332

			break;

   333

   334

		case WE_CLICK:

   335

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

   336

				case TVW_CENTERVIEW: /* scroll to location */

   337

					if (_ctrl_pressed) {

   338

						ShowExtraViewPortWindow(t->xy);

   339

					} else {

   340

						ScrollMainWindowToTile(t->xy);

   341

					}

   342

					break;

   343

   344

				case TVW_SHOWAUTORITY: /* town authority */

   345

					ShowTownAuthorityWindow(w->window_number);

   346

					break;

   347

   348

				case TVW_CHANGENAME: /* rename */

   349

					SetDParam(0, w->window_number);

   350

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

   351

					break;

   352

   353

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

   354

					ExpandTown(t);

   355

					break;

   356

   357

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

   358

					delete t;

   359

					break;

   360

			} break;

   361

   362

		case WE_ON_EDIT_TEXT:

   363

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

   364

				_cmd_text = e->we.edittext.str;

   365

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

   366

					CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   367

			}

   368

			break;

   369

	}

   370

}

   371

   372

   373

static const Widget _town_view_widgets[] = {

   374

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

   375

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

   376

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

   377

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

   378

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

   379

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

   380

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

   381

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

   382

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

   383

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

   384

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

   385

{   WIDGETS_END},

   386

};

   387

   388

static const WindowDesc _town_view_desc = {

   389

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

   390

	WC_TOWN_VIEW, WC_NONE,

   391

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   392

	_town_view_widgets,

   393

	TownViewWndProc

   394

};

   395

   396

void ShowTownViewWindow(TownID town)

   397

{

   398

	Window *w;

   399

   400

	w = AllocateWindowDescFront(&_town_view_desc, town);

   401

   402

	if (w != NULL) {

   403

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   404

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

   405

	}

   406

}

   407

   408

enum TownDirectoryWidget {

   409

	TDW_SORTNAME = 3,

   410

	TDW_SORTPOPULATION,

   411

	TDW_CENTERTOWN,

   412

};

   413

static const Widget _town_directory_widgets[] = {

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

{   WIDGETS_END},

   424

};

   425

   426

   427

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

   428

static uint _num_town_sort;

   429

   430

static char _bufcache[64];

   431

static const Town* _last_town;

   432

   433

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

   434

{

   435

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

   436

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

   437

	char buf1[64];

   438

	int r;

   439

   440

	SetDParam(0, ta->index);

   441

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

   442

   443

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

   444

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

   445

	 *  times after eachother) */

   446

	if (tb != _last_town) {

   447

		_last_town = tb;

   448

		SetDParam(0, tb->index);

   449

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

   450

	}

   451

   452

	r = strcmp(buf1, _bufcache);

   453

	if (_town_sort_order & 1) r = -r;

   454

	return r;

   455

}

   456

   457

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

   458

{

   459

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

   460

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

   461

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

   462

	if (_town_sort_order & 1) r = -r;

   463

	return r;

   464

}

   465

   466

static void MakeSortedTownList()

   467

{

   468

	const Town* t;

   469

	uint n = 0;

   470

   471

	/* Create array for sorting */

   472

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

   473

   474

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

   475

   476

	_num_town_sort = n;

   477

   478

	_last_town = NULL; // used for "cache"

   479

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

   480

   481

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

   482

}

   483

   484

   485

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

   486

{

   487

	switch (e->event) {

   488

		case WE_PAINT: {

   489

			if (_town_sort_dirty) {

   490

				_town_sort_dirty = false;

   491

				MakeSortedTownList();

   492