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 "company_func.h"

    16

#include "company_base.h"

    17

#include "company_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

#include "sortlist_type.h"

    28

    29

#include "table/sprites.h"

    30

#include "table/strings.h"

    31

    32

typedef GUIList<const Town*> GUITownList;

    33

    34

extern bool GenerateTowns();

    35

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

    36

    37

static const Widget _town_authority_widgets[] = {

    38

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

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

{   WIDGETS_END},

    46

};

    47

    48

extern const byte _town_action_costs[8];

    49

    50

enum TownActions {

    51

	TACT_NONE             = 0x00,

    52

    53

	TACT_ADVERTISE_SMALL  = 0x01,

    54

	TACT_ADVERTISE_MEDIUM = 0x02,

    55

	TACT_ADVERTISE_LARGE  = 0x04,

    56

	TACT_ROAD_REBUILD     = 0x08,

    57

	TACT_BUILD_STATUE     = 0x10,

    58

	TACT_FOUND_BUILDINGS  = 0x20,

    59

	TACT_BUY_RIGHTS       = 0x40,

    60

	TACT_BRIBE            = 0x80,

    61

    62

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    63

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    64

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    65

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    66

};

    67

    68

DECLARE_ENUM_AS_BIT_SET(TownActions);

    69

    70

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

    71

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

    72

 * @param cid the company that is querying the town

    73

 * @param t the town that is queried

    74

 * @return bitmasked value of enabled actions

    75

 */

    76

uint GetMaskOfTownActions(int *nump, CompanyID cid, const Town *t)

    77

{

    78

	int num = 0;

    79

	TownActions buttons = TACT_NONE;

    80

    81

	/* Spectators and unwanted have no options */

    82

	if (cid != COMPANY_SPECTATOR && !(_settings_game.economy.bribe && t->unwanted[cid])) {

    83

    84

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

    85

		Money avail = GetCompany(cid)->money + _price.station_value * 200;

    86

		Money ref = _price.build_industry >> 8;

    87

    88

		/* Check the action bits for validity and

    89

		 * if they are valid add them */

    90

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

    91

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

    92

    93

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

    94

			if (cur == TACT_BRIBE && (!_settings_game.economy.bribe || t->ratings[cid] >= RATING_BRIBE_MAXIMUM))

    95

				continue;

    96

    97

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

    98

			if (cur == TACT_BUY_RIGHTS && !_settings_game.economy.exclusive_rights)

    99

				continue;

   100

   101

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

   102

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

   103

				continue;

   104

   105

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

   106

				buttons |= cur;

   107

				num++;

   108

			}

   109

		}

   110

	}

   111

   112

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

   113

	return buttons;

   114

}

   115

   116

struct TownAuthorityWindow : Window {

   117

private:

   118

	Town *town;

   119

	int sel_index;

   120

   121

	enum TownAuthorityWidget {

   122

		TWA_CLOSEBOX = 0,

   123

		TWA_CAPTION,

   124

		TWA_RATING_INFO,

   125

		TWA_COMMAND_LIST,

   126

		TWA_SCROLLBAR,

   127

		TWA_ACTION_INFO,

   128

		TWA_EXECUTE,

   129

	};

   130

   131

	/**

   132

	 * Get the position of the Nth set bit.

   133

	 *

   134

	 * If there is no Nth bit set return -1

   135

	 *

   136

	 * @param bits The value to search in

   137

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

   138

	 * @return The position of the Nth set bit

   139

	 */

   140

	static int GetNthSetBit(uint32 bits, int n)

   141

	{

   142

		if (n >= 0) {

   143

			uint i;

   144

			FOR_EACH_SET_BIT(i, bits) {

   145

				n--;

   146

				if (n < 0) return i;

   147

			}

   148

		}

   149

		return -1;

   150

	}

   151

   152

public:

   153

	TownAuthorityWindow(const WindowDesc *desc, WindowNumber window_number) :

   154

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

   155

	{

   156

		this->town = GetTown(this->window_number);

   157

		this->vscroll.cap = 5;

   158

   159

		this->FindWindowPlacementAndResize(desc);

   160

	}

   161

   162

	virtual void OnPaint()

   163

	{

   164

		int numact;

   165

		uint buttons = GetMaskOfTownActions(&numact, _local_company, this->town);

   166

   167

		SetVScrollCount(this, numact + 1);

   168

   169

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

   170

			this->sel_index = -1;

   171

		}

   172

   173

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

   174

   175

		SetDParam(0, this->window_number);

   176

		this->DrawWidgets();

   177

   178

		DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   179

   180

		/* Draw list of companies */

   181

		int y = 25;

   182

   183

		const Company *c;

   184

		FOR_ALL_COMPANIES(c) {

   185

			if ((HasBit(this->town->have_ratings, c->index) || this->town->exclusivity == c->index)) {

   186

				DrawCompanyIcon(c->index, 2, y);

   187

   188

				SetDParam(0, c->index);

   189

				SetDParam(1, c->index);

   190

   191

				int r = this->town->ratings[c->index];

   192

				StringID str;

   193

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

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

				(str++,                    true);                    // Outstanding

   201

   202

				SetDParam(2, str);

   203

				if (this->town->exclusivity == c->index) { // red icon for company with exclusive rights

   204

					DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   205

				}

   206

   207

				DrawString(28, y, STR_2024, TC_FROMSTRING);

   208

				y += 10;

   209

			}

   210

		}

   211

		y = 107;

   212

		int pos = this->vscroll.pos;

   213

   214

		if (--pos < 0) {

   215

			DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   216

			y += 10;

   217

		}

   218

   219

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

   220

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

   221

   222

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

   223

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

   224

				y += 10;

   225

			}

   226

		}

   227

   228

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

   229

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

   230

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

   231

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

   232

		}

   233

	}

   234

   235

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

   236

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

   237

   238

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

   239

	{

   240

		switch (widget) {

   241

			case TWA_COMMAND_LIST: {

   242

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

   243

   244

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

   245

   246

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

   247

				if (y >= 0) {

   248

					this->sel_index = y;

   249

					this->SetDirty();

   250

				}

   251

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

   252

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

   253

			}

   254

   255

			case TWA_EXECUTE:

   256

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

   257

				break;

   258

		}

   259

	}

   260

   261

	virtual void OnHundredthTick()

   262

	{

   263

		this->SetDirty();

   264

	}

   265

};

   266

   267

static const WindowDesc _town_authority_desc = {

   268

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

   269

	WC_TOWN_AUTHORITY, WC_NONE,

   270

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   271

	_town_authority_widgets,

   272

};

   273

   274

static void ShowTownAuthorityWindow(uint town)

   275

{

   276

	AllocateWindowDescFront<TownAuthorityWindow>(&_town_authority_desc, town);

   277

}

   278

   279

struct TownViewWindow : Window {

   280

private:

   281

	Town *town;

   282

   283

	enum TownViewWidget {

   284

		TVW_CAPTION = 1,

   285

		TVW_STICKY,

   286

		TVW_VIEWPORTPANEL,

   287

		TVW_INFOPANEL = 5,

   288

		TVW_CENTERVIEW,

   289

		TVW_SHOWAUTORITY,

   290

		TVW_CHANGENAME,

   291

		TVW_EXPAND,

   292

		TVW_DELETE,

   293

	};

   294

   295

public:

   296

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

   297

	{

   298

		this->town = GetTown(this->window_number);

   299

		bool ingame = _game_mode != GM_EDITOR;

   300

   301

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   302

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

   303

   304

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

   305

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

   306

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

   307

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

   308

   309

		if (ingame) {

   310

			/* resize caption bar */

   311

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

   312

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

   313

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

   314

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

   315

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

   316

		}

   317

   318

		/* Space required for showing noise level information */

   319

		if (_settings_game.economy.station_noise_level) {

   320

			ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   321

		}

   322

   323

		this->FindWindowPlacementAndResize(desc);

   324

	}

   325

   326

	virtual void OnPaint()

   327

	{

   328

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

   329

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

   330

   331

		SetDParam(0, this->town->index);

   332

		this->DrawWidgets();

   333

   334

		SetDParam(0, this->town->population);

   335

		SetDParam(1, this->town->num_houses);

   336

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   337

   338

		SetDParam(0, this->town->act_pass);

   339

		SetDParam(1, this->town->max_pass);

   340

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   341

   342

		SetDParam(0, this->town->act_mail);

   343

		SetDParam(1, this->town->max_mail);

   344

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   345

   346

		this->DrawViewport();

   347

   348

		/* only show the town noise, if the noise option is activated. */

   349

		if (_settings_game.economy.station_noise_level) {

   350

			SetDParam(0, this->town->noise_reached);

   351

			SetDParam(1, this->town->MaxTownNoise());

   352

			DrawString(2, 137, STR_NOISE_IN_TOWN, 0);

   353

		}

   354

	}

   355

   356

	virtual void OnClick(Point pt, int widget)

   357

	{

   358

		switch (widget) {

   359

			case TVW_CENTERVIEW: /* scroll to location */

   360

				if (_ctrl_pressed) {

   361

					ShowExtraViewPortWindow(this->town->xy);

   362

				} else {

   363

					ScrollMainWindowToTile(this->town->xy);

   364

				}

   365

				break;

   366

   367

			case TVW_SHOWAUTORITY: /* town authority */

   368

				ShowTownAuthorityWindow(this->window_number);

   369

				break;

   370

   371

			case TVW_CHANGENAME: /* rename */

   372

				SetDParam(0, this->window_number);

   373

				ShowQueryString(STR_TOWN, STR_2007_RENAME_TOWN, MAX_LENGTH_TOWN_NAME_BYTES, MAX_LENGTH_TOWN_NAME_PIXELS, this, CS_ALPHANUMERAL, QSF_ENABLE_DEFAULT);

   374

				break;

   375

   376

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

   377

				ExpandTown(this->town);

   378

				break;

   379

   380

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

   381

				delete this->town;

   382

				break;

   383

		}

   384

	}

   385

   386

	virtual void OnInvalidateData(int data = 0)

   387

	{

   388

		/* Called when setting station noise have changed, in order to resize the window */

   389

		this->SetDirty(); // refresh display for current size. This will allow to avoid glitches when downgrading

   390

   391

		if (_settings_game.economy.station_noise_level) { // adjust depending

   392

			if (this->height == 150) { // window is smaller, needs to be bigger

   393

				ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   394

			}

   395

		} else {

   396

			if (this->height != 150) { // window is bigger, needs to be smaller

   397

				ResizeWindowForWidget(this, TVW_INFOPANEL, 0, -10);

   398

			}

   399

		}

   400

	}

   401

   402

	virtual void OnQueryTextFinished(char *str)

   403

	{

   404

		if (str == NULL) return;

   405

   406

		_cmd_text = str;

   407

		DoCommandP(0, this->window_number, 0, NULL, CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   408

	}

   409

};

   410

   411

   412

static const Widget _town_view_widgets[] = {

   413

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

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

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

   424

{   WIDGETS_END},

   425

};

   426

   427

static const WindowDesc _town_view_desc = {

   428

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

   429

	WC_TOWN_VIEW, WC_NONE,

   430

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   431

	_town_view_widgets,

   432

};

   433

   434

void ShowTownViewWindow(TownID town)

   435

{

   436

	AllocateWindowDescFront<TownViewWindow>(&_town_view_desc, town);

   437

}

   438

   439

static const Widget _town_directory_widgets[] = {

   440

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

   441

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

   442

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

   443

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

   444

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

   445

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

   446

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

   447

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

   448

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

   449

{   WIDGETS_END},

   450

};

   451

   452

   453

struct TownDirectoryWindow : public Window {

   454

private:

   455

	enum TownDirectoryWidget {

   456

		TDW_SORTNAME = 3,

   457

		TDW_SORTPOPULATION,

   458

		TDW_CENTERTOWN,

   459

	};

   460

   461

	/* Runtime saved values */

   462

	static Listing last_sorting;

   463

	static const Town *last_town;

   464

   465

	/* Constants for sorting towns */

   466

	static GUITownList::SortFunction * const sorter_funcs[];

   467

   468

	GUITownList towns;

   469

   470

	void BuildTownList()

   471

	{

   472

		if (!this->towns.NeedRebuild()) return;

   473

   474

		this->towns.Clear();

   475

   476

		const Town *t;

   477

		FOR_ALL_TOWNS(t) {

   478

			*this->towns.Append() = t;

   479

		}

   480

   481

		this->towns.Compact();

   482

		this->towns.RebuildDone();

   483

	}

   484

   485

	void SortTownList()

   486

	{

   487

		last_town = NULL;

   488

		this->towns.Sort();