1

/* $Id$ */

     2

     3

/** @file industry_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "gui.h"

     9

#include "window_gui.h"

    10

#include "textbuf_gui.h"

    11

#include "command_func.h"

    12

#include "viewport_func.h"

    13

#include "gfx_func.h"

    14

#include "industry.h"

    15

#include "town.h"

    16

#include "variables.h"

    17

#include "cargotype.h"

    18

#include "newgrf.h"

    19

#include "newgrf_callbacks.h"

    20

#include "newgrf_industries.h"

    21

#include "newgrf_text.h"

    22

#include "strings_func.h"

    23

#include "map_func.h"

    24

#include "player_func.h"

    25

#include "settings_type.h"

    26

    27

#include "table/strings.h"

    28

#include "table/sprites.h"

    29

    30

bool _ignore_restrictions;

    31

    32

/** Names of the widgets of the dynamic place industries gui */

    33

enum DynamicPlaceIndustriesWidgets {

    34

	DPIW_CLOSEBOX = 0,

    35

	DPIW_CAPTION,

    36

	DPIW_MATRIX_WIDGET,

    37

	DPIW_SCROLLBAR,

    38

	DPIW_INFOPANEL,

    39

	DPIW_FUND_WIDGET,

    40

	DPIW_RESIZE_WIDGET,

    41

};

    42

    43

/** Attached struct to the window extended data */

    44

struct fnd_d {

    45

	int index;             ///< index of the element in the matrix

    46

	IndustryType select;   ///< industry corresponding to the above index

    47

	uint16 callback_timer; ///< timer counter for callback eventual verification

    48

	bool timer_enabled;    ///< timer can be used

    49

};

    50

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(fnd_d));

    51

    52

/** Helper struct holding the available industries for current situation */

    53

static struct IndustryData {

    54

	uint16 count;                               ///< How many industries are loaded

    55

	IndustryType index[NUM_INDUSTRYTYPES + 1];  ///< Type of industry, in the order it was loaded

    56

	StringID text[NUM_INDUSTRYTYPES + 1];       ///< Text coming from CBM_IND_FUND_MORE_TEXT (if ever)

    57

	bool enabled[NUM_INDUSTRYTYPES + 1];        ///< availability state, coming from CBID_INDUSTRY_AVAILABLE (if ever)

    58

} _fund_gui;

    59

    60

assert_compile(lengthof(_fund_gui.index) == lengthof(_fund_gui.text));

    61

assert_compile(lengthof(_fund_gui.index) == lengthof(_fund_gui.enabled));

    62

    86

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

    87

{

    88

	switch (e->event) {

    89

		case WE_CREATE: {

    90

			IndustryType ind;

    91

			const IndustrySpec *indsp;

    92

    93

			/* Shorten the window to the equivalant of the additionnal purchase

    94

			 * info coming from the callback.  SO it will only be available to tis full

    95

			 * height when newindistries are loaded */

    96

			if (!_loaded_newgrf_features.has_newindustries) {

    97

				w->widget[DPIW_INFOPANEL].bottom -= 44;

    98

				w->widget[DPIW_FUND_WIDGET].bottom -= 44;

    99

				w->widget[DPIW_FUND_WIDGET].top -= 44;

   100

				w->widget[DPIW_RESIZE_WIDGET].bottom -= 44;

   101

				w->widget[DPIW_RESIZE_WIDGET].top -= 44;

   102

				w->resize.height = w->height -= 44;

   103

			}

   104

   105

			WP(w, fnd_d).timer_enabled = _loaded_newgrf_features.has_newindustries;

   106

   107

			/* Initilialize structures */

   108

			_fund_gui.count = 0;

   109

   110

			for (uint i = 0; i < lengthof(_fund_gui.index); i++) {

   111

				_fund_gui.index[i]   = 0xFF;

   112

				_fund_gui.text[i]    = STR_NULL;

   113

				_fund_gui.enabled[i] = false;

   114

			}

   115

   116

			w->vscroll.cap = 8; // rows in grid, same in scroller

   117

			w->resize.step_height = 13;

   118

   119

			if (_game_mode == GM_EDITOR) { // give room for the Many Random "button"

   120

				_fund_gui.index[_fund_gui.count] = INVALID_INDUSTRYTYPE;

   121

				_fund_gui.count++;

   122

				WP(w, fnd_d).timer_enabled = false;

   123

			}

   124

   125

			/* Fill the _fund_gui structure with industries.

   126

			 * The tests performed after the enabled allow to load the industries

   127

			 * In the same way they are inserted by grf (if any)

   128

			 */

   129

			for (ind = 0; ind < NUM_INDUSTRYTYPES; ind++) {

   130

				indsp = GetIndustrySpec(ind);

   131

				if (indsp->enabled){

   132

					/* Rule is that editor mode loads all industries.

   133

					 * In game mode, all non raw industries are loaded too

   134

					 * and raw ones are loaded only when setting allows it */

   135

					if (_game_mode != GM_EDITOR && indsp->IsRawIndustry() && _patches.raw_industry_construction == 0) continue;

   136

					_fund_gui.index[_fund_gui.count] = ind;

   137

					_fund_gui.enabled[_fund_gui.count] = (_game_mode == GM_EDITOR) || CheckIfCallBackAllowsAvailability(ind, IACT_USERCREATION);

   138

					_fund_gui.count++;

   139

				}

   140

			}

   141

   142

			/* first indutry type is selected.

   143

			 * I'll be damned if there are none available ;) */

   144

			WP(w, fnd_d).index = 0;

   145

			WP(w, fnd_d).select = _fund_gui.index[0];

   146

			WP(w, fnd_d).callback_timer = DAY_TICKS;

   147

		} break;

   148

   149

		case WE_PAINT: {

   150

			const IndustrySpec *indsp = (WP(w, fnd_d).select == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(WP(w, fnd_d).select);

   151

			int x_str = w->widget[DPIW_INFOPANEL].left + 3;

   152

			int y_str = w->widget[DPIW_INFOPANEL].top + 3;

   153

			const Widget *wi = &w->widget[DPIW_INFOPANEL];

   154

			int max_width = wi->right - wi->left - 4;

   155

   156

			/* Raw industries might be prospected. Show this fact by changing the string

   157

			 * In Editor, you just build, while ingame, or you fund or you prospect */

   158

			if (_game_mode == GM_EDITOR) {

   159

				/* We've chosen many random industries but no industries have been specified */

   160

				if (indsp == NULL) _fund_gui.enabled[WP(w, fnd_d).index] = _opt.diff.number_industries != 0;

   161

				w->widget[DPIW_FUND_WIDGET].data = STR_BUILD_NEW_INDUSTRY;

   162

			} else {

   163

				w->widget[DPIW_FUND_WIDGET].data = (_patches.raw_industry_construction == 2 && indsp->IsRawIndustry()) ? STR_PROSPECT_NEW_INDUSTRY : STR_FUND_NEW_INDUSTRY;

   164

			}

   165

			w->SetWidgetDisabledState(DPIW_FUND_WIDGET, !_fund_gui.enabled[WP(w, fnd_d).index]);

   166

   167

			SetVScrollCount(w, _fund_gui.count);

   168

   169

			DrawWindowWidgets(w);

   170

   171

			/* and now with the matrix painting */

   172

			for (byte i = 0; i < w->vscroll.cap && ((i + w->vscroll.pos) < _fund_gui.count); i++) {

   173

				int offset = i * 13;

   174

				int x = 3;

   175

				int y = 16;

   176

				bool selected = WP(w, fnd_d).index == i + w->vscroll.pos;

   177

   178

				if (_fund_gui.index[i + w->vscroll.pos] == INVALID_INDUSTRYTYPE) {

   179

					DrawStringTruncated(20, y + offset, STR_MANY_RANDOM_INDUSTRIES, selected ? TC_WHITE : TC_ORANGE, max_width - 25);

   180

					continue;

   181

				}

   182

				const IndustrySpec *indsp = GetIndustrySpec(_fund_gui.index[i + w->vscroll.pos]);

   183

   184

				/* Draw the name of the industry in white is selected, otherwise, in orange */

   185

				DrawStringTruncated(20, y + offset, indsp->name, selected ? TC_WHITE : TC_ORANGE, max_width - 25);

   186

				GfxFillRect(x,     y + 1 + offset,  x + 10, y + 7 + offset, selected ? 15 : 0);

   187

				GfxFillRect(x + 1, y + 2 + offset,  x +  9, y + 6 + offset, indsp->map_colour);

   188

			}

   189

   190

			if (WP(w, fnd_d).select == INVALID_INDUSTRYTYPE) {

   191

				DrawStringMultiLine(x_str, y_str, STR_RANDOM_INDUSTRIES_TIP, max_width, wi->bottom - wi->top - 40);

   192

				break;

   193

			}

   194

   195

			if (_game_mode != GM_EDITOR) {

   196

				SetDParam(0, indsp->GetConstructionCost());

   197

				DrawStringTruncated(x_str, y_str, STR_482F_COST, TC_FROMSTRING, max_width);

   198

				y_str += 11;

   199

			}

   200

   201

			/* Draw the accepted cargos, if any. Otherwhise, will print "Nothing" */

   202

			StringID str = STR_4827_REQUIRES;

   203

			byte p = 0;

   204

			SetDParam(0, STR_00D0_NOTHING);

   206

			for (byte j = 0; j < lengthof(indsp->accepts_cargo); j++) {

   207

				if (indsp->accepts_cargo[j] == CT_INVALID) continue;

   208

				if (p > 0) str++;

   209

				SetDParam(p++, GetCargo(indsp->accepts_cargo[j])->name);

   211

			}

   212

			DrawStringTruncated(x_str, y_str, str, TC_FROMSTRING, max_width);

   213

			y_str += 11;

   214

   215

			/* Draw the produced cargos, if any. Otherwhise, will print "Nothing" */

   216

			str = STR_4827_PRODUCES;

   217

			p = 0;

   218

			SetDParam(0, STR_00D0_NOTHING);

   220

			for (byte j = 0; j < lengthof(indsp->produced_cargo); j++) {

   221

				if (indsp->produced_cargo[j] == CT_INVALID) continue;

   222

				if (p > 0) str++;

   223

				SetDParam(p++, GetCargo(indsp->produced_cargo[j])->name);

   225

			}

   226

			DrawStringTruncated(x_str, y_str, str, TC_FROMSTRING, max_width);

   227

			y_str += 11;

   228

   229

			/* Get the additional purchase info text, if it has not already been */

   230

			if (_fund_gui.text[WP(w, fnd_d).index] == STR_NULL) {   // Have i been called already?

   231

				if (HasBit(indsp->callback_flags, CBM_IND_FUND_MORE_TEXT)) {          // No. Can it be called?

   232

					uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_FUND_MORE_TEXT, 0, 0, NULL, WP(w, fnd_d).select, INVALID_TILE);

   233

					if (callback_res != CALLBACK_FAILED) {  // Did it failed?

   234

						StringID newtxt = GetGRFStringID(indsp->grf_prop.grffile->grfid, 0xD000 + callback_res);  // No. here's the new string

   235

						_fund_gui.text[WP(w, fnd_d).index] = newtxt;   // Store it for further usage

   236

					}

   237

				}

   238

			}

   239

   240

			/* Draw the Additional purchase text, provided by newgrf callback, if any.

   241

			 * Otherwhise, will print Nothing */

   242

			str = _fund_gui.text[WP(w, fnd_d).index];

   243

			if (str != STR_NULL && str != STR_UNDEFINED) {

   244

				SetDParam(0, str);

   245

				DrawStringMultiLine(x_str, y_str, STR_JUST_STRING, max_width, wi->bottom - wi->top - 40);

   246

			}

   247

		} break;

   248

   249

		case WE_DOUBLE_CLICK:

   250

			if (e->we.click.widget != DPIW_MATRIX_WIDGET) break;

   251

			e->we.click.widget = DPIW_FUND_WIDGET;

   252

			/* Fall through */

   253

   254

		case WE_CLICK:

   255

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

   256

				case DPIW_MATRIX_WIDGET: {

   257

					const IndustrySpec *indsp;

   258

					int y = (e->we.click.pt.y - w->widget[DPIW_MATRIX_WIDGET].top) / 13 + w->vscroll.pos ;

   259

   260

					if (y >= 0 && y < _fund_gui.count) { // Is it within the boundaries of available data?

   261

						WP(w, fnd_d).index = y;

   262

						WP(w, fnd_d).select = _fund_gui.index[WP(w, fnd_d).index];

   263

						indsp = (WP(w, fnd_d).select == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(WP(w, fnd_d).select);

   264

   265

						SetWindowDirty(w);

   266

   267

						if ((_game_mode != GM_EDITOR && _patches.raw_industry_construction == 2 && indsp != NULL && indsp->IsRawIndustry()) ||

   268

								WP(w, fnd_d).select == INVALID_INDUSTRYTYPE) {

   269

							/* Reset the button state if going to prospecting or "build many industries" */

   270

							w->RaiseButtons();

   271

							ResetObjectToPlace();

   272

						}

   273

					}

   274

				} break;

   275

   276

				case DPIW_FUND_WIDGET: {

   277

					if (WP(w, fnd_d).select == INVALID_INDUSTRYTYPE) {

   278

						w->HandleButtonClick(DPIW_FUND_WIDGET);

   279

   280

						if (GetNumTowns() == 0) {

   281

							ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_CAN_T_GENERATE_INDUSTRIES, 0, 0);

   282

						} else {

   283

							extern void GenerateIndustries();

   284

							_generating_world = true;

   285

							GenerateIndustries();

   286

							_generating_world = false;

   287

						}

   288

					} else if (_game_mode != GM_EDITOR && _patches.raw_industry_construction == 2 && GetIndustrySpec(WP(w, fnd_d).select)->IsRawIndustry()) {

   289

						DoCommandP(0, WP(w, fnd_d).select, InteractiveRandom(), NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   290

						w->HandleButtonClick(DPIW_FUND_WIDGET);

   291

					} else {

   292

						HandlePlacePushButton(w, DPIW_FUND_WIDGET, SPR_CURSOR_INDUSTRY, VHM_RECT, NULL);

   293

					}

   294

				} break;

   295

			}

   296

			break;

   297

   298

		case WE_RESIZE: {

   299

			/* Adjust the number of items in the matrix depending of the rezise */

   300

			w->vscroll.cap  += e->we.sizing.diff.y / (int)w->resize.step_height;

   301

			w->widget[DPIW_MATRIX_WIDGET].data = (w->vscroll.cap << 8) + 1;

   302

		} break;

   303

   304

		case WE_PLACE_OBJ: {

   305

			bool success = true;

   306

			/* We do not need to protect ourselves against "Random Many Industries" in this mode */

   307

			const IndustrySpec *indsp = GetIndustrySpec(WP(w, fnd_d).select);

   308

			uint32 seed = InteractiveRandom();

   309

   310

			if (_game_mode == GM_EDITOR) {

   311

				/* Show error if no town exists at all */

   312

				if (GetNumTowns() == 0) {

   313

					SetDParam(0, indsp->name);

   314

					ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_0285_CAN_T_BUILD_HERE, e->we.place.pt.x, e->we.place.pt.y);

   315

					return;

   316

				}

   317

   318

				_current_player = OWNER_NONE;

   319

				_generating_world = true;

   320

				_ignore_restrictions = true;

   321

				success = DoCommandP(e->we.place.tile, (InteractiveRandomRange(indsp->num_table) << 16) | WP(w, fnd_d).select, seed, NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   322

				if (!success) {

   323

					SetDParam(0, indsp->name);

   324

					ShowErrorMessage(_error_message, STR_0285_CAN_T_BUILD_HERE, e->we.place.pt.x, e->we.place.pt.y);

   325

				}

   326

   327

				_ignore_restrictions = false;

   328

				_generating_world = false;

   329

			} else {

   330

				success = DoCommandP(e->we.place.tile, (InteractiveRandomRange(indsp->num_table) << 16) | WP(w, fnd_d).select, seed, NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   331

			}

   332

   333

			/* If an industry has been built, just reset the cursor and the system */

   334

			if (success) ResetObjectToPlace();

   335

		} break;

   336

   337

		case WE_TICK:

   338

			if (_pause_game != 0) break;

   339

			if (!WP(w, fnd_d).timer_enabled) break;

   340

			if (--WP(w, fnd_d).callback_timer == 0) {

   341

				/* We have just passed another day.

   342

				 * See if we need to update availability of currently selected industry */

   343

				WP(w, fnd_d).callback_timer = DAY_TICKS;  //restart counter

   344

   345

				const IndustrySpec *indsp = GetIndustrySpec(WP(w, fnd_d).select);

   346

   347

				if (indsp->enabled) {

   348

					bool call_back_result = CheckIfCallBackAllowsAvailability(WP(w, fnd_d).select, IACT_USERCREATION);

   349

   350

					/* Only if result does match the previous state would it require a redraw. */

   351

					if (call_back_result != _fund_gui.enabled[WP(w, fnd_d).index]) {

   352

						_fund_gui.enabled[WP(w, fnd_d).index] = call_back_result;

   353

						SetWindowDirty(w);

   354

					}

   355

				}

   356

			}

   357

			break;

   358

   359

		case WE_TIMEOUT:

   360

		case WE_ABORT_PLACE_OBJ:

   361

			w->RaiseButtons();

   362

			break;

   363

	}

   364

}

   365

   366

/** Widget definition of the dynamic place industries gui */

   367

static const Widget _build_dynamic_industry_widgets[] = {

   368

{   WWT_CLOSEBOX,    RESIZE_NONE,    7,     0,    10,     0,    13, STR_00C5,                       STR_018B_CLOSE_WINDOW},            // DPIW_CLOSEBOX

   369

{    WWT_CAPTION,   RESIZE_RIGHT,    7,    11,   169,     0,    13, STR_0314_FUND_NEW_INDUSTRY,     STR_018C_WINDOW_TITLE_DRAG_THIS},  // DPIW_CAPTION

   370

{     WWT_MATRIX,      RESIZE_RB,    7,     0,   157,    14,   118, 0x801,                          STR_INDUSTRY_SELECTION_HINT},      // DPIW_MATRIX_WIDGET

   371

{  WWT_SCROLLBAR,     RESIZE_LRB,    7,   158,   169,    14,   118, 0x0,                            STR_0190_SCROLL_BAR_SCROLLS_LIST}, // DPIW_SCROLLBAR

   372

{      WWT_PANEL,     RESIZE_RTB,    7,     0,   169,   119,   199, 0x0,                            STR_NULL},                         // DPIW_INFOPANEL

   373

{    WWT_TEXTBTN,     RESIZE_RTB,    7,     0,   157,   200,   211, STR_FUND_NEW_INDUSTRY,          STR_NULL},                         // DPIW_FUND_WIDGET

   374

{  WWT_RESIZEBOX,    RESIZE_LRTB,    7,   158,   169,   200,   211, 0x0,                            STR_RESIZE_BUTTON},                // DPIW_RESIZE_WIDGET

   375

{   WIDGETS_END},

   376

};

   377

   378

/** Window definition of the dynamic place industries gui */

   379

static const WindowDesc _build_industry_dynamic_desc = {

   380

	WDP_AUTO, WDP_AUTO, 170, 212, 170, 212,

   381

	WC_BUILD_INDUSTRY, WC_NONE,

   382

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_RESIZABLE,

   383

	_build_dynamic_industry_widgets,

   384

	BuildDynamicIndustryWndProc,

   385

};

   386

   387

void ShowBuildIndustryWindow()

   388

{

   389

	if (_game_mode != GM_EDITOR && !IsValidPlayer(_current_player)) return;

   390

	AllocateWindowDescFront(&_build_industry_dynamic_desc, 0);

   391

}

   392

   393

static void UpdateIndustryProduction(Industry *i);

   394

   395

static inline bool isProductionMinimum(const Industry *i, int pt)

   396

{

   397

	return i->production_rate[pt] == 0;

   398

}

   399

   400

static inline bool isProductionMaximum(const Industry *i, int pt)

   401

{

   402

	return i->production_rate[pt] >= 255;

   403

}

   404

   405

static inline bool IsProductionAlterable(const Industry *i)

   406

{

   407

	return ((_game_mode == GM_EDITOR || _cheats.setup_prod.value) &&

   408

			(i->accepts_cargo[0] == CT_INVALID || i->accepts_cargo[0] == CT_VALUABLES));

   409

}

   410

   411

/** Names of the widgets of the view industry gui */

   412

enum IndustryViewWidgets {

   413

	IVW_CLOSEBOX = 0,

   414

	IVW_CAPTION,

   415

	IVW_STICKY,

   416

	IVW_BACKGROUND,

   417

	IVW_VIEWPORT,

   418

	IVW_INFO,

   419

	IVW_GOTO,

   420

	IVW_SPACER,

   421

};

   422

   423

/** Information to store about the industry window */

   424

struct indview_d : public vp_d {

   425

	byte editbox_line;        ///< The line clicked to open the edit box

   426

	byte clicked_line;        ///< The line of the button that has been clicked

   427

	byte clicked_button;      ///< The button that has been clicked (to raise)

   428

	byte production_offset_y; ///< The offset of the production texts/buttons

   429

};

   430

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(indview_d));

   431

   432

   433

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

   434

{

   435

	switch (e->event) {

   436

	case WE_PAINT: {

   437

		Industry *i = GetIndustry(w->window_number);

   438

		const IndustrySpec *ind = GetIndustrySpec(i->type);

   440

		bool first = true;

   441

		bool has_accept = false;

   442

   443

		SetDParam(0, w->window_number);

   444

		DrawWindowWidgets(w);

   445

   446

		if (HasBit(ind->callback_flags, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HasBit(ind->callback_flags, CBM_IND_PRODUCTION_256_TICKS)) {

   447

			for (byte j = 0; j < lengthof(i->accepts_cargo); j++) {

   448

				if (i->accepts_cargo[j] == CT_INVALID) continue;

   449

				has_accept = true;

   450

				if (first) {

   451

					DrawString(2, y, STR_INDUSTRY_WINDOW_WAITING_FOR_PROCESSING, TC_FROMSTRING);

   452

					y += 10;

   453

					first = false;

   454

				}

   455

				SetDParam(0, i->accepts_cargo[j]);

   456

				SetDParam(1, i->incoming_cargo_waiting[j]);

   458

				DrawString(4, y, STR_INDUSTRY_WINDOW_WAITING_STOCKPILE_CARGO, TC_FROMSTRING);

   459

				y += 10;

   460

			}

   461

		} else {

   462

			StringID str = STR_4827_REQUIRES;

   463

			byte p = 0;

   464

			for (byte j = 0; j < lengthof(i->accepts_cargo); j++) {

   465

				if (i->accepts_cargo[j] == CT_INVALID) continue;

   466

				has_accept = true;

   467

				if (p > 0) str++;

   468

				SetDParam(p++, GetCargo(i->accepts_cargo[j])->name);

   470

			}

   471

			if (has_accept) {

   472

				DrawString(2, y, str, TC_FROMSTRING);

   473

				y += 10;

   474

			}

   475

		}

   476

   477

		first = true;

   478

		for (byte j = 0; j < lengthof(i->produced_cargo); j++) {

   479

			if (i->produced_cargo[j] == CT_INVALID) continue;

   480

			if (first) {

   481

				if (has_accept) y += 10;

   482

				DrawString(2, y, STR_482A_PRODUCTION_LAST_MONTH, TC_FROMSTRING);

   483

				y += 10;

   484

				WP(w, indview_d).production_offset_y = y;