1

/* $Id$ */

     2

     3

/** @file town_gui.cpp */

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

    22

#include "core/alloc_func.hpp"

    23

#include "settings_type.h"

    24

    25

#include "table/sprites.h"

    26

#include "table/strings.h"

    27

    28

enum TownAuthorityWidget {

    29

	TWA_CLOSEBOX = 0,

    30

	TWA_CAPTION,

    31

	TWA_RATING_INFO,

    32

	TWA_COMMAND_LIST,

    33

	TWA_SCROLLBAR,

    34

	TWA_ACTION_INFO,

    35

	TWA_EXECUTE,

    36

};

    37

    38

static const Widget _town_authority_widgets[] = {

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,     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 pid the player 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, PlayerID pid, const Town *t)

    78

{

    79

	int num = 0;

    80

	TownActions buttons = TACT_NONE;

    81

    82

	/* Spectators and unwanted have no options */

    83

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

    84

    85

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

    86

		Money avail = GetPlayer(pid)->player_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 player not able to bribe ? */

    95

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

    96

				continue;

    97

    98

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

    99

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

   100

				continue;

   101

   102

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

   103

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

   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

/**

   118

 * Get the position of the Nth set bit.

   119

 *

   120

 * If there is no Nth bit set return -1

   121

 *

   122

 * @param bits The value to search in

   123

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

   124

 * @return The position of the Nth set bit

   125

 */

   126

static int GetNthSetBit(uint32 bits, int n)

   127

{

   128

	if (n >= 0) {

   129

		uint i;

   130

		FOR_EACH_SET_BIT(i, bits) {

   131

			n--;

   132

			if (n < 0) return i;

   133

		}

   134

	}

   135

	return -1;

   136

}

   137

   138

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

   139

{

   140

	switch (e->event) {

   141

	case WE_PAINT: {

   142

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

   143

		int numact;

   144

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

   145

   146

		SetVScrollCount(w, numact + 1);

   147

   148

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

   149

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

   150

   151

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

   152

   153

		{

   154

			int y;

   155

			const Player *p;

   156

			int r;

   157

			StringID str;

   158

   159

			SetDParam(0, w->window_number);

   160

			DrawWindowWidgets(w);

   161

   162

			DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   163

   164

			/* Draw list of players */

   165

			y = 25;

   166

			FOR_ALL_PLAYERS(p) {

   167

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

   168

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

   169

   170

					SetDParam(0, p->index);

   171

					SetDParam(1, p->index);

   172

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

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

   180

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

   181

					(str++,                    true);                    // Outstanding

   182

   183

					SetDParam(2, str);

   184

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

   185

						DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   186

					}

   187

   188

					DrawString(28, y, STR_2024, TC_FROMSTRING);

   189

					y += 10;

   190

				}

   191

			}

   192

		}

   193

   194

		/* Draw actions list */

   195

		{

   196

			int y = 107, i;

   197

			int pos = w->vscroll.pos;

   198

   199

			if (--pos < 0) {

   200

				DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   201

				y += 10;

   202

			}

   203

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

   204

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

   205

   206

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

   207

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

   208

					y += 10;

   209

				}

   210

			}

   211

		}

   212

   213

		{

   214

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

   215

   216

			if (i != -1) {

   217

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

   218

				SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   219

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

   220

			}

   221

		}

   222

   223

	} break;

   224

   225

	case WE_DOUBLE_CLICK:

   226

	case WE_CLICK:

   227

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

   228

			case TWA_COMMAND_LIST: {

   229

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

   230

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

   231

   232

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

   233

   234

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

   235

				if (y >= 0) {

   236

					WP(w, def_d).data_1 = y;

   237

					SetWindowDirty(w);

   238

				}

   239

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

   240

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

   241

			}

   242

   243

			case TWA_EXECUTE:

   244

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

   245

				break;

   246

		}

   247

		break;

   248

   249

	case WE_4:

   250

		SetWindowDirty(w);

   251

		break;

   252

	}

   253

}

   254

   255

static const WindowDesc _town_authority_desc = {

   256

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

   257

	WC_TOWN_AUTHORITY, WC_NONE,

   258

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   259

	_town_authority_widgets,

   260

	TownAuthorityWndProc

   261

};

   262

   263

static void ShowTownAuthorityWindow(uint town)

   264

{

   265

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

   266

   267

	if (w != NULL) {

   268

		w->vscroll.cap = 5;

   269

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

   270

	}

   271

}

   272

   273

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

   274

{

   275

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

   276

   277

	switch (e->event) {

   278

	case WE_PAINT:

   279

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

   280

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

   281

   282

		SetDParam(0, t->index);

   283

		DrawWindowWidgets(w);

   284

   285

		SetDParam(0, t->population);

   286

		SetDParam(1, t->num_houses);

   287

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   288

   289

		SetDParam(0, t->act_pass);

   290

		SetDParam(1, t->max_pass);

   291

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   292

   293

		SetDParam(0, t->act_mail);

   294

		SetDParam(1, t->max_mail);

   295

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   296

   297

		DrawWindowViewport(w);

   298

		break;

   299

   300

	case WE_CLICK:

   301

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

   302

			case 6: /* scroll to location */

   303

				ScrollMainWindowToTile(t->xy);

   304

				break;

   305

   306

			case 7: /* town authority */

   307

				ShowTownAuthorityWindow(w->window_number);

   308

				break;

   309

   310

			case 8: /* rename */

   311

				SetDParam(0, w->window_number);

   312

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

   313

				break;

   314

   315

			case 9: /* expand town */

   316

				ExpandTown(t);

   317

				break;

   318

   319

			case 10: /* delete town */

   320

				delete t;

   321

				break;

   322

		} break;

   323

   324

	case WE_ON_EDIT_TEXT:

   325

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

   326

			_cmd_text = e->we.edittext.str;

   327

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

   328

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   329

		}

   330

		break;

   331

	}

   332

}

   333

   334

   335

static const Widget _town_view_widgets[] = {

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

{ WWT_PUSHTXTBTN,   RESIZE_NONE,    13,   172,   259,   138,   149, STR_0130_RENAME,          STR_200C_CHANGE_TOWN_NAME},

   345

{   WIDGETS_END},

   346

};

   347

   348

static const WindowDesc _town_view_desc = {

   349

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

   350

	WC_TOWN_VIEW, WC_NONE,

   351

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   352

	_town_view_widgets,

   353

	TownViewWndProc

   354

};

   355

   356

static const Widget _town_view_scen_widgets[] = {

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

{      WWT_EMPTY,   RESIZE_NONE,     0,     0,     0,     0,     0, 0x0,               STR_NULL},

   365

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

   366

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

   367

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

   368

{   WIDGETS_END},

   369

};

   370

   371

static const WindowDesc _town_view_scen_desc = {

   372

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

   373

	WC_TOWN_VIEW, WC_NONE,

   374

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   375

	_town_view_scen_widgets,

   376

	TownViewWndProc

   377

};

   378

   379

void ShowTownViewWindow(TownID town)

   380

{

   381

	Window *w;

   382

   383

	if (_game_mode != GM_EDITOR) {

   384

		w = AllocateWindowDescFront(&_town_view_desc, town);

   385

	} else {

   386

		w = AllocateWindowDescFront(&_town_view_scen_desc, town);

   387

	}

   388

   389

	if (w != NULL) {

   390

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   391

		AssignWindowViewport(w, 3, 17, 0xFE, 0x56, GetTown(town)->xy, ZOOM_LVL_TOWN);

   392

	}

   393

}

   394

   395

enum TownDirectoryWidget {

   396

	TDW_SORTNAME = 3,

   397

	TDW_SORTPOPULATION,

   398

	TDW_CENTERTOWN,

   399

};

   400

static const Widget _town_directory_widgets[] = {

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

{   WIDGETS_END},

   411

};

   412

   413

   414

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

   415

static uint _num_town_sort;

   416

   417

static char _bufcache[64];

   418

static const Town* _last_town;

   419

   420

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

   421

{

   422

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

   423

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

   424

	char buf1[64];

   425

	int r;

   426

   427

	SetDParam(0, ta->index);

   428

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

   429

   430

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

   431

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

   432

	 *  times after eachother) */

   433

	if (tb != _last_town) {

   434

		_last_town = tb;

   435

		SetDParam(0, tb->index);

   436

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

   437

	}

   438

   439

	r = strcmp(buf1, _bufcache);

   440

	if (_town_sort_order & 1) r = -r;

   441

	return r;

   442

}

   443

   444

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

   445

{

   446

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

   447

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

   448

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

   449

	if (_town_sort_order & 1) r = -r;

   450

	return r;

   451

}

   452

   453

static void MakeSortedTownList()

   454

{

   455

	const Town* t;

   456

	uint n = 0;

   457

   458

	/* Create array for sorting */

   459

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

   460

   461

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

   462

   463

	_num_town_sort = n;

   464

   465

	_last_town = NULL; // used for "cache"

   466

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

   467

   468

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

   469

}

   470

   471

   472

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

   473

{

   474

	switch (e->event) {

   475

	case WE_PAINT: {

   476

		if (_town_sort_dirty) {

   477

			_town_sort_dirty = false;

   478

			MakeSortedTownList();

   479

		}

   480

   481

		SetVScrollCount(w, _num_town_sort);

   482

   483

		DrawWindowWidgets(w);

   484

		DrawSortButtonState(w, (_town_sort_order <= 1) ? TDW_SORTNAME : TDW_SORTPOPULATION, _town_sort_order & 1 ? SBS_DOWN : SBS_UP);

   485

   486

		{

   487

			int n = 0;

   488

			uint16 i = w->vscroll.pos;

   489

			int y = 28;

   490

   491

			while (i < _num_town_sort) {

   492

				const Town* t = _town_sort[i];

   493