1

/* $Id$ */

     2

     3

/** @file town_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "town.h"

    12

#include "gfx.h"

    13

#include "viewport.h"

    14

#include "gui.h"

    15

#include "window_gui.h"

    16

#include "textbuf_gui.h"

    17

#include "command.h"

    18

#include "player.h"

    19

#include "network/network.h"

    20

#include "variables.h"

    21

#include "helpers.hpp"

    23

    24

enum TownAuthorityWidget {

    25

	TWA_CLOSEBOX = 0,

    26

	TWA_CAPTION,

    27

	TWA_RATING_INFO,

    28

	TWA_COMMAND_LIST,

    29

	TWA_SCROLLBAR,

    30

	TWA_ACTION_INFO,

    31

	TWA_EXECUTE,

    32

};

    33

    34

static const Widget _town_authority_widgets[] = {

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

{   WIDGETS_END},

    43

};

    44

    45

extern const byte _town_action_costs[8];

    46

    47

enum TownActions {

    48

	TACT_NONE             = 0x00,

    49

    50

	TACT_ADVERTISE_SMALL  = 0x01,

    51

	TACT_ADVERTISE_MEDIUM = 0x02,

    52

	TACT_ADVERTISE_LARGE  = 0x04,

    53

	TACT_ROAD_REBUILD     = 0x08,

    54

	TACT_BUILD_STATUE     = 0x10,

    55

	TACT_FOUND_BUILDINGS  = 0x20,

    56

	TACT_BUY_RIGHTS       = 0x40,

    57

	TACT_BRIBE            = 0x80,

    58

    59

	TACT_ADVERTISE        = TACT_ADVERTISE_SMALL | TACT_ADVERTISE_MEDIUM | TACT_ADVERTISE_LARGE,

    60

	TACT_CONSTRUCTION     = TACT_ROAD_REBUILD | TACT_BUILD_STATUE | TACT_FOUND_BUILDINGS,

    61

	TACT_FUNDS            = TACT_BUY_RIGHTS | TACT_BRIBE,

    62

	TACT_ALL              = TACT_ADVERTISE | TACT_CONSTRUCTION | TACT_FUNDS,

    63

};

    64

    65

DECLARE_ENUM_AS_BIT_SET(TownActions);

    66

    67

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

    68

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

    69

 * @param pid the player that is querying the town

    70

 * @param t the town that is queried

    71

 * @return bitmasked value of enabled actions

    72

 */

    73

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

    74

{

    75

	int num = 0;

    76

	TownActions buttons = TACT_NONE;

    77

    78

	/* Spectators and unwanted have no options */

    79

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

    80

    81

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

    82

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

    83

		Money ref = _price.build_industry >> 8;

    84

    85

		/* Check the action bits for validity and

    86

		 * if they are valid add them */

    87

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

    88

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

    89

    90

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

    91

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

    92

				continue;

    93

    94

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

    95

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

    96

				continue;

    97

    98

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

    99

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

   100

				continue;

   101

   102

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

   103

				buttons |= cur;

   104

				num++;

   105

			}

   106

		}

   107

	}

   108

   109

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

   110

	return buttons;

   111

}

   112

   113

/**

   114

 * Get the position of the Nth set bit.

   115

 *

   116

 * If there is no Nth bit set return -1

   117

 *

   118

 * @param bits The value to search in

   119

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

   120

 * @return The position of the Nth set bit

   121

 */

   122

static int GetNthSetBit(uint32 bits, int n)

   123

{

   124

	if (n >= 0) {

   125

		uint i;

   126

		FOR_EACH_SET_BIT(i, bits) {

   127

			n--;

   128

			if (n < 0) return i;

   129

		}

   130

	}

   131

	return -1;

   132

}

   133

   134

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

   135

{

   136

	switch (e->event) {

   137

	case WE_PAINT: {

   138

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

   139

		int numact;

   140

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

   141

   142

		SetVScrollCount(w, numact + 1);

   143

   144

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

   145

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

   146

   147

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

   148

   149

		{

   150

			int y;

   151

			const Player *p;

   152

			int r;

   153

			StringID str;

   154

   155

			SetDParam(0, w->window_number);

   156

			DrawWindowWidgets(w);

   157

   158

			DrawString(2, 15, STR_2023_TRANSPORT_COMPANY_RATINGS, TC_FROMSTRING);

   159

   160

			/* Draw list of players */

   161

			y = 25;

   162

			FOR_ALL_PLAYERS(p) {

   163

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

   164

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

   165

   166

					SetDParam(0, p->index);

   167

					SetDParam(1, p->index);

   168

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

					(str++,                    true);                    // Outstanding

   178

   179

					SetDParam(2, str);

   180

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

   181

						DrawSprite(SPR_BLOT, PALETTE_TO_RED, 18, y);

   182

					}

   183

   184

					DrawString(28, y, STR_2024, TC_FROMSTRING);

   185

					y += 10;

   186

				}

   187

			}

   188

		}

   189

   190

		/* Draw actions list */

   191

		{

   192

			int y = 107, i;

   193

			int pos = w->vscroll.pos;

   194

   195

			if (--pos < 0) {

   196

				DrawString(2, y, STR_2045_ACTIONS_AVAILABLE, TC_FROMSTRING);

   197

				y += 10;

   198

			}

   199

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

   200

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

   201

   202

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

   203

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

   204

					y += 10;

   205

				}

   206

			}

   207

		}

   208

   209

		{

   210

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

   211

   212

			if (i != -1) {

   213

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

   214

				SetDParam(0, STR_2046_SMALL_ADVERTISING_CAMPAIGN + i);

   215

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

   216

			}

   217

		}

   218

   219

	} break;

   220

   221

	case WE_DOUBLE_CLICK:

   222

	case WE_CLICK:

   223

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

   224

		case TWA_COMMAND_LIST: {

   225

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

   226

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

   227

   228

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

   229

   230

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

   231

			if (y >= 0) {

   232

				WP(w, def_d).data_1 = y;

   233

				SetWindowDirty(w);

   234

			}

   235

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

   236

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

   237

		}

   238

   239

		case TWA_EXECUTE: {

   240

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

   241

			break;

   242

		}

   243

		}

   244

		break;

   245

   246

	case WE_4:

   247

		SetWindowDirty(w);

   248

		break;

   249

	}

   250

}

   251

   252

static const WindowDesc _town_authority_desc = {

   253

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

   254

	WC_TOWN_AUTHORITY, WC_NONE,

   255

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   256

	_town_authority_widgets,

   257

	TownAuthorityWndProc

   258

};

   259

   260

static void ShowTownAuthorityWindow(uint town)

   261

{

   262

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

   263

   264

	if (w != NULL) {

   265

		w->vscroll.cap = 5;

   266

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

   267

	}

   268

}

   269

   270

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

   271

{

   272

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

   273

   274

	switch (e->event) {

   275

	case WE_PAINT:

   276

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

   277

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

   278

   279

		SetDParam(0, t->index);

   280

		DrawWindowWidgets(w);

   281

   282

		SetDParam(0, t->population);

   283

		SetDParam(1, t->num_houses);

   284

		DrawString(2, 107, STR_2006_POPULATION, TC_FROMSTRING);

   285

   286

		SetDParam(0, t->act_pass);

   287

		SetDParam(1, t->max_pass);

   288

		DrawString(2, 117, STR_200D_PASSENGERS_LAST_MONTH_MAX, TC_FROMSTRING);

   289

   290

		SetDParam(0, t->act_mail);

   291

		SetDParam(1, t->max_mail);

   292

		DrawString(2, 127, STR_200E_MAIL_LAST_MONTH_MAX, TC_FROMSTRING);

   293

   294

		DrawWindowViewport(w);

   295

		break;

   296

   297

	case WE_CLICK:

   298

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

   299

			case 6: /* scroll to location */

   300

				ScrollMainWindowToTile(t->xy);

   301

				break;

   302

   303

			case 7: /* town authority */

   304

				ShowTownAuthorityWindow(w->window_number);

   305

				break;

   306

   307

			case 8: /* rename */

   308

				SetDParam(0, w->window_number);

   309

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

   310

				break;

   311

   312

			case 9: /* expand town */

   313

				ExpandTown(t);

   314

				break;

   315

   316

			case 10: /* delete town */

   317

				delete t;

   318

				break;

   319

		}

   320

		break;

   321

   322

	case WE_ON_EDIT_TEXT:

   323

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

   324

			_cmd_text = e->we.edittext.str;

   325

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

   326

				CMD_RENAME_TOWN | CMD_MSG(STR_2008_CAN_T_RENAME_TOWN));

   327

		}

   328

		break;

   329

	}

   330

}

   331

   332

   333

static const Widget _town_view_widgets[] = {

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

{   WIDGETS_END},

   344

};

   345

   346

static const WindowDesc _town_view_desc = {

   347

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

   348

	WC_TOWN_VIEW, WC_NONE,

   349

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   350

	_town_view_widgets,

   351

	TownViewWndProc

   352

};

   353

   354

static const Widget _town_view_scen_widgets[] = {

   355

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

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

{   WIDGETS_END},

   367

};

   368

   369

static const WindowDesc _town_view_scen_desc = {

   370

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

   371

	WC_TOWN_VIEW, WC_NONE,

   372

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_STICKY_BUTTON,

   373

	_town_view_scen_widgets,

   374

	TownViewWndProc

   375

};

   376

   377

void ShowTownViewWindow(TownID town)

   378

{

   379

	Window *w;

   380

   381

	if (_game_mode != GM_EDITOR) {

   382

		w = AllocateWindowDescFront(&_town_view_desc, town);

   383

	} else {

   384

		w = AllocateWindowDescFront(&_town_view_scen_desc, town);

   385

	}

   386

   387

	if (w != NULL) {

   388

		w->flags4 |= WF_DISABLE_VP_SCROLL;

   389

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

   390

	}

   391

}

   392

   393

static const Widget _town_directory_widgets[] = {

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

{   WIDGETS_END},

   404

};

   405

   406

   407

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

   408

static uint _num_town_sort;

   409

   410

static char _bufcache[64];

   411

static const Town* _last_town;

   412

   413

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

   414

{

   415

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

   416

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

   417

	char buf1[64];

   418

	int r;

   419

   420

	SetDParam(0, ta->index);

   421

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

   422

   423

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

   424

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

   425

	 *  times after eachother) */

   426

	if (tb != _last_town) {

   427

		_last_town = tb;

   428

		SetDParam(0, tb->index);

   429

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

   430

	}

   431

   432

	r = strcmp(buf1, _bufcache);

   433

	if (_town_sort_order & 1) r = -r;

   434

	return r;

   435

}

   436

   437

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

   438

{

   439

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

   440

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

   441

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

   442

	if (_town_sort_order & 1) r = -r;

   443

	return r;

   444

}

   445

   446

static void MakeSortedTownList()

   447

{

   448

	const Town* t;

   449

	uint n = 0;

   450

   451

	/* Create array for sorting */

   452

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

   453

   454

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

   455

   456

	_num_town_sort = n;

   457

   458

	_last_town = NULL; // used for "cache"

   459

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

   460

   461

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

   462

}

   463

   464

   465

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

   466

{

   467

	switch (e->event) {

   468

	case WE_PAINT: {

   469

		if (_town_sort_dirty) {

   470

			_town_sort_dirty = false;

   471

			MakeSortedTownList();

   472

		}

   473

   474

		SetVScrollCount(w, _num_town_sort);

   475

   476

		DrawWindowWidgets(w);

   477

		DoDrawString(_town_sort_order & 1 ? DOWNARROW : UPARROW, (_town_sort_order <= 1) ? 88 : 187, 15, TC_BLACK);

   478

   479

		{

   480

			int n = 0;

   481

			uint16 i = w->vscroll.pos;

   482

			int y = 28;

   483

   484

			while (i < _num_town_sort) {

   485

				const Town* t = _town_sort[i];

   486

   487

				assert(t->xy);

   488

   489

				SetDParam(0, t->index);

   490

				SetDParam(1, t->population);

   491

				DrawString(2, y, STR_2057, TC_FROMSTRING);

   492

   493

				y += 10;