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

struct TownAuthorityWindow : Window {

   145

	int sel_index;

   146

   147

	TownAuthorityWindow(const WindowDesc *desc, WindowNumber window_number) :

   148

			Window(desc, window_number), sel_index(-1)

   149

	{

   150

		this->vscroll.cap = 5;

   151

   152

		this->FindWindowPlacementAndResize(desc);

   153

	}

   154

   155

	virtual void OnPaint()

   156

	{

   157

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

   158

		int numact;

   159

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

   160

   161

		SetVScrollCount(this, numact + 1);

   162

   163

		if (this->sel_index != -1 && !HasBit(buttons, this->sel_index)) {

   164

			this->sel_index = -1;

   165

		}

   166

   167

		this->SetWidgetDisabledState(6, this->sel_index == -1);

   168

   169

		SetDParam(0, this->window_number);

   170

		this->DrawWidgets();

   171

   172

		DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   173

   174

		/* Draw list of players */

   175

		int y = 25;

   176

   177

		const Player *p;

   178

		FOR_ALL_PLAYERS(p) {

   179

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

   180

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

   181

   182

				SetDParam(0, p->index);

   183

				SetDParam(1, p->index);

   184

   185

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

   186

				StringID str;

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

				(str++,                    true);                    // Outstanding

   195

   196

				SetDParam(2, str);

   197

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

   198

					DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   199

				}

   200

   201

				DrawString(28, y, STR_2024, TC_FROMSTRING);

   202

				y += 10;

   203

			}

   204

		}

   205

		y = 107;

   206

		int pos = this->vscroll.pos;

   207

   208

		if (--pos < 0) {

   209

			DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   210

			y += 10;

   211

		}

   212

   213

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

   214

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

   215

   216

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

   217

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

   218

				y += 10;

   219

			}

   220

		}

   221

   222

		if (this->sel_index != -1) {

   223

			SetDParam(1, (_price.build_industry >> 8) * _town_action_costs[this->sel_index]);

   224

			SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + this->sel_index);

   225

			DrawStringMultiLine(2, 159, STR_204D_INITIATE_A_SMALL_LOCAL + this->sel_index, 313);

   226

		}

   227

	}

   228

   229

	virtual void OnDoubleClick(Point pt, int widget) { HandleClick(pt, widget, true); }

   230

	virtual void OnClick(Point pt, int widget) { HandleClick(pt, widget, false); }

   231

   232

	void HandleClick(Point pt, int widget, bool double_click)

   233

	{

   234

		switch (widget) {

   235

			case TWA_COMMAND_LIST: {

   236

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

   237

				int y = (pt.y - 0x6B) / 10;

   238

   239

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

   240

   241

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

   242

				if (y >= 0) {

   243

					this->sel_index = y;

   244

					this->SetDirty();

   245

				}

   246

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

   247

				if (!double_click || y < 0) break;

   248

			}

   249

   250

			case TWA_EXECUTE:

   251

				DoCommandP(GetTown(this->window_number)->xy, this->window_number, this->sel_index, NULL, CMD_DO_TOWN_ACTION | CMD_MSG(STR_00B4_CAN_T_DO_THIS));

   252

				break;

   253

		}

   254

	}

   255

   256

	virtual void OnHundredthTick()

   257

	{

   258

		this->SetDirty();

   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

};

   268

   269

static void ShowTownAuthorityWindow(uint town)

   270

{

   271

	AllocateWindowDescFront<TownAuthorityWindow>(&_town_authority_desc, town);

   272

}

   273

   274

   275

enum TownViewWidget {

   276

	TVW_CAPTION = 1,

   277

	TVW_STICKY,

   278

	TVW_CENTERVIEW = 6,

   279

	TVW_SHOWAUTORITY,

   280

	TVW_CHANGENAME,

   281

	TVW_EXPAND,

   282

	TVW_DELETE,

   283

};

   284

   285

struct TownViewWindow : Window {

   286

	TownViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

   287

	{

   288

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

   289

   290

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   291

		InitializeWindowViewport(this, 3, 17, 254, 86, t->xy, ZOOM_LVL_TOWN);

   292

   293

		bool ingame = _game_mode != GM_EDITOR;

   294

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

   295

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

   296

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

   297

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

   298

   299

		if (ingame) {

   300

			/* resize caption bar */

   301

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

   302

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

   303

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

   304

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

   305

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

   306

		}

   307

   308

		this->FindWindowPlacementAndResize(desc);

   309

	}

   310

   311

	virtual void OnPaint()

   312

	{

   313

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

   314

   315

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

   316

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

   317

   318

		SetDParam(0, t->index);

   319

		this->DrawWidgets();

   320

   321

		SetDParam(0, t->population);

   322

		SetDParam(1, t->num_houses);

   323

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   324

   325

		SetDParam(0, t->act_pass);

   326

		SetDParam(1, t->max_pass);

   327

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   328

   329

		SetDParam(0, t->act_mail);

   330

		SetDParam(1, t->max_mail);

   331

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   332

   333

		this->DrawViewport();

   334

	}

   335

   336

	virtual void OnClick(Point pt, int widget)

   337

	{

   338

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

   339

   340

		switch (widget) {

   341

			case TVW_CENTERVIEW: /* scroll to location */

   342

				if (_ctrl_pressed) {

   343

					ShowExtraViewPortWindow(t->xy);

   344

				} else {

   345

					ScrollMainWindowToTile(t->xy);

   346

				}

   347

				break;

   348

   349

			case TVW_SHOWAUTORITY: /* town authority */

   350

				ShowTownAuthorityWindow(this->window_number);

   351

				break;

   352

   353

			case TVW_CHANGENAME: /* rename */

   354

				SetDParam(0, this->window_number);

   355

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

   356

				break;

   357

   358

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

   359

				ExpandTown(t);

   360

				break;

   361

   362

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

   363

				delete t;

   364

				break;

   365

		}

   366

	}

   367

   368

	virtual void OnQueryTextFinished(char *str)

   369

	{

   370

		if (!StrEmpty(str)) {

   371

			_cmd_text = str;

   372

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

   373

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   374

		}

   375

	}

   376

};

   377

   378

   379

static const Widget _town_view_widgets[] = {

   380

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

   381

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

   382

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

   383

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

   384

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

   385

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

   386

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

   387

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

   388

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

   389

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

   390

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

   391

{   WIDGETS_END},

   392

};

   393

   394

static const WindowDesc _town_view_desc = {

   395

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

   396

	WC_TOWN_VIEW, WC_NONE,

   397

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   398

	_town_view_widgets,

   399

};

   400

   401

void ShowTownViewWindow(TownID town)

   402

{

   403

	AllocateWindowDescFront<TownViewWindow>(&_town_view_desc, town);

   404

}

   405

   406

static const Widget _town_directory_widgets[] = {

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

{   WIDGETS_END},

   417

};

   418

   419

   420

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

   421

static uint _num_town_sort;

   422

   423

static char _bufcache[64];

   424

static const Town* _last_town;

   425

   426

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

   427

{

   428

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

   429

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

   430

	char buf1[64];

   431

	int r;

   432

   433

	SetDParam(0, ta->index);

   434

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

   435

   436

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

   437

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

   438

	 *  times after eachother) */

   439

	if (tb != _last_town) {

   440

		_last_town = tb;

   441

		SetDParam(0, tb->index);

   442

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

   443

	}

   444

   445

	r = strcmp(buf1, _bufcache);

   446

	if (_town_sort_order & 1) r = -r;

   447

	return r;

   448

}

   449

   450

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

   451

{

   452

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

   453

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

   454

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

   455

	if (_town_sort_order & 1) r = -r;

   456

	return r;

   457

}

   458

   459

static void MakeSortedTownList()

   460

{

   461

	const Town* t;

   462

	uint n = 0;

   463

   464

	/* Create array for sorting */

   465

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

   466

   467

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

   468

   469

	_num_town_sort = n;

   470

   471

	_last_town = NULL; // used for "cache"

   472

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

   473

   474

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

   475

}

   476

   477

   478

struct TownDirectoryWindow : public Window {

   479

	enum TownDirectoryWidget {

   480

		TDW_SORTNAME = 3,

   481

		TDW_SORTPOPULATION,

   482

		TDW_CENTERTOWN,

   483

	};

   484

   485

	TownDirectoryWindow(const WindowDesc *desc) : Window(desc, 0)

   486

	{

   487

		this->vscroll.cap = 16;

   488

		this->resize.step_height = 10;

   489

		this->resize.height = this->height - 10 * 6; // minimum of 10 items in the list, each item 10 high

   490

   491

		this->FindWindowPlacementAndResize(desc);

   492

	}