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

#include "road_cmd.h"

    29

    30

#include "table/sprites.h"

    31

#include "table/strings.h"

    32

    33

typedef GUIList<const Town*> GUITownList;

    34

    35

extern bool GenerateTowns();

    36

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

    37

    38

static const Widget _town_authority_widgets[] = {

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

{   WIDGETS_END},

    47

};

    48

    49

extern const byte _town_action_costs[8];

    50

    51

enum TownActions {

    52

	TACT_NONE             = 0x00,

    53

    54

	TACT_ADVERTISE_SMALL  = 0x01,

    55

	TACT_ADVERTISE_MEDIUM = 0x02,

    56

	TACT_ADVERTISE_LARGE  = 0x04,

    57

	TACT_ROAD_REBUILD     = 0x08,

    58

	TACT_BUILD_STATUE     = 0x10,

    59

	TACT_FOUND_BUILDINGS  = 0x20,

    60

	TACT_BUY_RIGHTS       = 0x40,

    61

	TACT_BRIBE            = 0x80,

    62

    63

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    64

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    65

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    66

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    67

};

    68

    69

DECLARE_ENUM_AS_BIT_SET(TownActions);

    70

    71

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

    72

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

    73

 * @param cid the company that is querying the town

    74

 * @param t the town that is queried

    75

 * @return bitmasked value of enabled actions

    76

 */

    77

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

    78

{

    79

	int num = 0;

    80

	TownActions buttons = TACT_NONE;

    81

    82

	/* Spectators and unwanted have no options */

    83

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

    84

    85

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

    86

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

    87

		Money ref = _price.build_industry >> 8;

    88

    89

		/* Check the action bits for validity and

    90

		 * if they are valid add them */

    91

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

    92

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

    93

    94

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

    95

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

    96

				continue;

    97

    98

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

    99

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

   100

				continue;

   101

   102

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

   103

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

   104

				continue;

   105

   106

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

   107

				buttons |= cur;

   108

				num++;

   109

			}

   110

		}

   111

	}

   112

   113

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

   114

	return buttons;

   115

}

   116

   117

struct TownAuthorityWindow : Window {

   118

private:

   119

	Town *town;

   120

	int sel_index;

   121

   122

	enum TownAuthorityWidget {

   123

		TWA_CLOSEBOX = 0,

   124

		TWA_CAPTION,

   125

		TWA_RATING_INFO,

   126

		TWA_COMMAND_LIST,

   127

		TWA_SCROLLBAR,

   128

		TWA_ACTION_INFO,

   129

		TWA_EXECUTE,

   130

	};

   131

   132

	/**

   133

	 * Get the position of the Nth set bit.

   134

	 *

   135

	 * If there is no Nth bit set return -1

   136

	 *

   137

	 * @param bits The value to search in

   138

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

   139

	 * @return The position of the Nth set bit

   140

	 */

   141

	static int GetNthSetBit(uint32 bits, int n)

   142

	{

   143

		if (n >= 0) {

   144

			uint i;

   145

			FOR_EACH_SET_BIT(i, bits) {

   146

				n--;

   147

				if (n < 0) return i;

   148

			}

   149

		}

   150

		return -1;

   151

	}

   152

   153

public:

   154

	TownAuthorityWindow(const WindowDesc *desc, WindowNumber window_number) :

   155

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

   156

	{

   157

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

   158

		this->vscroll.cap = 5;

   159

   160

		this->FindWindowPlacementAndResize(desc);

   161

	}

   162

   163

	virtual void OnPaint()

   164

	{

   165

		int numact;

   166

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

   167

   168

		SetVScrollCount(this, numact + 1);

   169

   170

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

   171

			this->sel_index = -1;

   172

		}

   173

   174

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

   175

   176

		SetDParam(0, this->window_number);

   177

		this->DrawWidgets();

   178

   179

		DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   180

   181

		/* Draw list of companies */

   182

		int y = 25;

   183

   184

		const Company *c;

   185

		FOR_ALL_COMPANIES(c) {

   186

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

   187

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

   188

   189

				SetDParam(0, c->index);

   190

				SetDParam(1, c->index);

   191

   192

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

   193

				StringID str;

   194

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

   195

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

   196

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

   197

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

   198

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

   199

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

   200

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

   201

				(str++,                    true);                    // Outstanding

   202

   203

				SetDParam(2, str);

   204

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

   205

					DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   206

				}

   207

   208

				DrawString(28, y, STR_2024, TC_FROMSTRING);

   209

				y += 10;

   210

			}

   211

		}

   212

		y = 107;

   213

		int pos = this->vscroll.pos;

   214

   215

		if (--pos < 0) {

   216

			DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   217

			y += 10;

   218

		}

   219

   220

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

   221

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

   222

   223

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

   224

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

   225

				y += 10;

   226

			}

   227

		}

   228

   229

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

   230

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

   231

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

   232

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

   233

		}

   234

	}

   235

   236

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

   237

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

   238

   239

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

   240

	{

   241

		switch (widget) {

   242

			case TWA_COMMAND_LIST: {

   243

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

   244

   245

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

   246

   247

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

   248

				if (y >= 0) {

   249

					this->sel_index = y;

   250

					this->SetDirty();

   251

				}

   252

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

   253

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

   254

			}

   255

   256

			case TWA_EXECUTE:

   257

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

   258

				break;

   259

		}

   260

	}

   261

   262

	virtual void OnHundredthTick()

   263

	{

   264

		this->SetDirty();

   265

	}

   266

};

   267

   268

static const WindowDesc _town_authority_desc = {

   269

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

   270

	WC_TOWN_AUTHORITY, WC_NONE,

   271

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   272

	_town_authority_widgets,

   273

};

   274

   275

static void ShowTownAuthorityWindow(uint town)

   276

{

   277

	AllocateWindowDescFront<TownAuthorityWindow>(&_town_authority_desc, town);

   278

}

   279

   280

struct TownViewWindow : Window {

   281

private:

   282

	Town *town;

   283

   284

	enum TownViewWidget {

   285

		TVW_CAPTION = 1,

   286

		TVW_STICKY,

   287

		TVW_VIEWPORTPANEL,

   288

		TVW_INFOPANEL = 5,

   289

		TVW_CENTERVIEW,

   290

		TVW_SHOWAUTORITY,

   291

		TVW_CHANGENAME,

   292

		TVW_EXPAND,

   293

		TVW_DELETE,

   294

	};

   295

   296

public:

   297

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

   298

	{

   299

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

   300

		bool ingame = _game_mode != GM_EDITOR;

   301

   302

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   303

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

   304

   305

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

   306

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

   307

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

   308

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

   309

   310

		if (ingame) {

   311

			/* resize caption bar */

   312

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

   313

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

   314

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

   315

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

   316

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

   317

		}

   318

   319

		/* Space required for showing noise level information */

   320

		if (_settings_game.economy.station_noise_level) {

   321

			ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   322

		}

   323

   324

		this->FindWindowPlacementAndResize(desc);

   325

	}

   326

   327

	virtual void OnPaint()

   328

	{

   329

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

   330

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

   331

   332

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

   333

		this->DrawWidgets();

   334

   335

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

   336

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

   337

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   338

   339

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

   340

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

   341

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   342

   343

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

   344

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

   345

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   346

   347

		this->DrawViewport();

   348

   349

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

   350

		if (_settings_game.economy.station_noise_level) {

   351

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

   352

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

   353

			DrawString(2, 137, STR_NOISE_IN_TOWN, 0);

   354

		}

   355

	}

   356

   357

	virtual void OnClick(Point pt, int widget)

   358

	{

   359

		switch (widget) {

   360

			case TVW_CENTERVIEW: /* scroll to location */

   361

				if (_ctrl_pressed) {

   362

					ShowExtraViewPortWindow(this->town->xy);

   363

				} else {

   364

					ScrollMainWindowToTile(this->town->xy);

   365

				}

   366

				break;

   367

   368

			case TVW_SHOWAUTORITY: /* town authority */

   369

				ShowTownAuthorityWindow(this->window_number);

   370

				break;

   371

   372

			case TVW_CHANGENAME: /* rename */

   373

				SetDParam(0, this->window_number);

   374

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

   375

				break;

   376

   377

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

   378

				ExpandTown(this->town);

   379

				break;

   380

   381

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

   382

				delete this->town;

   383

				break;

   384

		}

   385

	}

   386

   387

	virtual void OnInvalidateData(int data = 0)

   388

	{

   389

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

   390

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

   391

   392

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

   393

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

   394

				ResizeWindowForWidget(this, TVW_INFOPANEL, 0, 10);

   395

			}

   396

		} else {

   397

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

   398

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

   399

			}

   400

		}

   401

	}

   402

   403

	virtual void OnQueryTextFinished(char *str)

   404

	{

   405

		if (str == NULL) return;

   406

   407

		_cmd_text = str;

   408

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

   409

	}

   410

};

   411

   412

   413

static const Widget _town_view_widgets[] = {

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

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

   424

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

   425

{   WIDGETS_END},

   426

};

   427

   428

static const WindowDesc _town_view_desc = {

   429

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

   430

	WC_TOWN_VIEW, WC_NONE,

   431

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   432

	_town_view_widgets,

   433

};

   434

   435

void ShowTownViewWindow(TownID town)

   436

{

   437

	AllocateWindowDescFront<TownViewWindow>(&_town_view_desc, town);

   438

}

   439

   440

static const Widget _town_directory_widgets[] = {

   441

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

   442

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

   443

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

   444

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

   445

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

   446

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

   447

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

   448

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

   449

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

   450

{   WIDGETS_END},

   451

};

   452

   453

   454

struct TownDirectoryWindow : public Window {

   455

private:

   456

	enum TownDirectoryWidget {

   457

		TDW_SORTNAME = 3,

   458

		TDW_SORTPOPULATION,

   459

		TDW_CENTERTOWN,

   460

	};

   461

   462

	/* Runtime saved values */

   463

	static Listing last_sorting;

   464

	static const Town *last_town;

   465

   466

	/* Constants for sorting towns */

   467

	static GUITownList::SortFunction * const sorter_funcs[];

   468

   469

	GUITownList towns;

   470

   471

	void BuildTownList()

   472

	{

   473

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

   474

   475

		this->towns.Clear();

   476

   477

		const Town *t;

   478

		FOR_ALL_TOWNS(t) {

   479

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

   480

		}

   481

   482

		this->towns.Compact();

   483

		this->towns.RebuildDone();

   484

	}

   485

   486

	void SortTownList()

   487

	{

   488

		last_town = NULL;