1

/* $Id$ */

     2

     3

/** @file industry_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "strings.h"

    10

#include "table/strings.h"

    11

#include "table/sprites.h"

    12

#include "map.h"

    13

#include "gui.h"

    14

#include "window.h"

    15

#include "gfx.h"

    16

#include "command.h"

    17

#include "viewport.h"

    18

#include "industry.h"

    19

#include "town.h"

    20

#include "variables.h"

    21

#include "helpers.hpp"

    22

#include "cargotype.h"

    23

#include "newgrf.h"

    24

#include "newgrf_callbacks.h"

    25

#include "newgrf_industries.h"

    26

#include "newgrf_text.h"

    27

#include "date.h"

    28

    29

extern Industry *CreateNewIndustry(TileIndex tile, IndustryType type);

    30

    31

/**

    32

 * Search callback function for TryBuildIndustry

    33

 * @param tile to test

    34

 * @param data that is passed by the caller.  In this case, the type of industry been tested

    35

 * @return the success (or not) of the operation

    36

 */

    37

static bool SearchTileForIndustry(TileIndex tile, uint32 data)

    38

{

    39

	return CreateNewIndustry(tile, data) != NULL;

    40

}

    41

    42

/**

    43

 * Perform a 9*9 tiles circular search around a tile

    44

 * in order to find a suitable zone to create the desired industry

    45

 * @param tile to start search for

    46

 * @param type of the desired industry

    47

 * @return the success (or not) of the operation

    48

 */

    49

static bool TryBuildIndustry(TileIndex tile, int type)

    50

{

    51

	return CircularTileSearch(tile, 9, SearchTileForIndustry, type);

    52

}

    53

bool _ignore_restrictions;

    54

    55

enum {

    56

	DYNA_INDU_MATRIX_WIDGET = 2,

    57

	DYNA_INDU_INFOPANEL = 4,

    58

	DYNA_INDU_FUND_WIDGET,

    59

	DYNA_INDU_RESIZE_WIDGET,

    60

};

    61

    62

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

    63

struct fnd_d {

    64

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

    65

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

    66

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

    67

	bool timer_enabled;    ///< timer can be used

    68

};

    69

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(fnd_d));

    70

    71

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

    72

static struct IndustryData {

    73

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

    74

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

    75

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

    76

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

    77

} _fund_gui;

    78

    79

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

    80

{

    81

	switch (e->event) {

    82

		case WE_CREATE: {

    83

			IndustryType ind;

    84

			const IndustrySpec *indsp;

    85

    86

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

    87

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

    88

			 * height when newindistries are loaded */

    89

			if (!_loaded_newgrf_features.has_newindustries) {

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

			}

    97

    98

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

    99

   100

			/* Initilialize structures */

   101

			memset(&_fund_gui.index, 0xFF, NUM_INDUSTRYTYPES);

   102

			memset(&_fund_gui.text, STR_NULL, NUM_INDUSTRYTYPES);

   103

			memset(&_fund_gui.enabled, false, NUM_INDUSTRYTYPES);

   104

			_fund_gui.count = 0;

   105

   106

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

   107

			w->resize.step_height = 13;

   108

   109

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

   110

				_fund_gui.index[_fund_gui.count] = INVALID_INDUSTRYTYPE;

   111

				_fund_gui.count++;

   112

				WP(w, fnd_d).timer_enabled = false;

   113

			}

   114

   115

			/* Fill the _fund_gui structure with industries.

   116

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

   117

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

   118

			 */

   119

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

   120

				indsp = GetIndustrySpec(ind);

   121

				if (indsp->enabled){

   122

					/* Rule is that editor mode loads all industries.

   123

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

   124

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

   125

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

   126

					_fund_gui.index[_fund_gui.count] = ind;

   127

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

   128

					_fund_gui.count++;

   129

				}

   130

			}

   131

   132

			/* first indutry type is selected.

   133

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

   134

			WP(w, fnd_d).index = 0;

   135

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

   136

			WP(w, fnd_d).callback_timer = DAY_TICKS;

   137

		} break;

   138

   139

		case WE_PAINT: {

   140

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

   141

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

   142

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

   143

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

   144

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

   145

   146

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

   147

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

   148

			if (_game_mode == GM_EDITOR) {

   149

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

   150

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

   151

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

   152

			} else {

   153

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

   154

			}

   155

			SetWindowWidgetDisabledState(w, DYNA_INDU_FUND_WIDGET, !_fund_gui.enabled[WP(w, fnd_d).index]);

   156

   157

			SetVScrollCount(w, _fund_gui.count);

   158

   159

			DrawWindowWidgets(w);

   160

   161

			/* and now with the matrix painting */

   162

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

   163

				int offset = i * 13;

   164

				int x = 3;

   165

				int y = 16;

   166

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

   167

   168

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

   169

					DrawString(21, y + offset, STR_MANY_RANDOM_INDUSTRIES, selected ? 12 : 6);

   170

					continue;

   171

				}

   172

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

   173

   174

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

   175

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

   176

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

   177

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

   178

			}

   179

   180

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

   181

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

   182

				break;

   183

			}

   184

   185

			if (_game_mode != GM_EDITOR) {

   186

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

   187

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

   188

				y_str += 11;

   189

			}

   190

   191

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

   199

			}

   200

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

   202

   203

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

   204

			str = STR_4827_PRODUCES;

   211

			}

   212

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

   214

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

					}

   223

				}

   224

			}

   225

   226

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

   227

			 * Otherwhise, will print Nothing */

   228

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

   229

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

   230

				SetDParam(0, str);

   231

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

   232

			}

   233

		} break;

   234

   235

		case WE_CLICK:

   236

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

   237

				case DYNA_INDU_MATRIX_WIDGET: {

   238

					const IndustrySpec *indsp;

   239

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

   240

   241

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

   242

						WP(w, fnd_d).index = y;

   243

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

   244

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

   245

   246

						SetWindowDirty(w);

   247

   248

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

   249

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

   250

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

   251

							RaiseWindowButtons(w);

   252

							ResetObjectToPlace();

   253

						}

   254

					}

   255

				} break;

   256

   257

				case DYNA_INDU_FUND_WIDGET: {

   258

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

   259

						HandleButtonClick(w, DYNA_INDU_FUND_WIDGET);

   260

   261

						if (GetNumTowns() == 0) {

   262

							ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_CAN_T_GENERATE_INDUSTRIES, 0, 0);

   263

						} else {

   264

							extern void GenerateIndustries();

   265

							_generating_world = true;

   266

							GenerateIndustries();

   267

							_generating_world = false;

   268

						}

   269

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

   270

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

   271

						HandleButtonClick(w, DYNA_INDU_FUND_WIDGET);

   272

					} else {

   273

						HandlePlacePushButton(w, DYNA_INDU_FUND_WIDGET, SPR_CURSOR_INDUSTRY, 1, NULL);

   274

					}

   275

				} break;

   276

			}

   277

			break;

   278

   279

		case WE_RESIZE: {

   280

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

   281

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

   282

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

   283

		} break;

   284

   285

		case WE_PLACE_OBJ: {

   286

			bool success = true;

   287

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

   288

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

   289

   290

			if (_game_mode == GM_EDITOR) {

   291

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

   292

				if (GetNumTowns() == 0) {

   293

					SetDParam(0, indsp->name);

   294

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

   295

					return;

   296

				}

   297

   298

				_current_player = OWNER_NONE;

   299

				_generating_world = true;

   300

				_ignore_restrictions = true;

   301

				success = TryBuildIndustry(e->we.place.tile, WP(w, fnd_d).select);

   302

				if (!success) {

   303

					SetDParam(0, indsp->name);

   304

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

   305

				}

   306

   307

				_ignore_restrictions = false;

   308

				_generating_world = false;

   309

			} else {

   310

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

   311

			}

   312

   313

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

   314

			if (success) ResetObjectToPlace();

   315

		} break;

   316

   317

		case WE_TICK:

   318

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

   319

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

   320

				/* We have just passed another day.

   321

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

   322

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

   323

   324

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

   325

   326

				if (indsp->enabled) {

   327

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

   328

   329

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

   330

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

   331

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

   332

						SetWindowDirty(w);

   333

					}

   334

				}

   335

			}

   336

			break;

   337

   338

		case WE_TIMEOUT:

   339

		case WE_ABORT_PLACE_OBJ:

   340

			RaiseWindowButtons(w);

   341

			break;

   342

	}

   343

}

   344

   345

static const Widget _build_dynamic_industry_widgets[] = {

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

{   WIDGETS_END},

   354

};

   355

   356

static const WindowDesc _build_industry_dynamic_desc = {

   357

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

   358

	WC_BUILD_INDUSTRY, WC_NONE,

   359

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_RESIZABLE,

   360

	_build_dynamic_industry_widgets,

   361

	BuildDynamicIndustryWndProc,

   362

};

   363

   364

void ShowBuildIndustryWindow()

   365

{

   366

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

   367

	AllocateWindowDescFront(&_build_industry_dynamic_desc, 0);

   368

}

   369

   370

static void UpdateIndustryProduction(Industry *i);

   371

   372

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

   373

{

   374

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

   375

}

   376

   377

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

   378

{

   379

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

   380

}

   381

   382

static inline bool IsProductionAlterable(const Industry *i)

   383

{

   384

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

   385

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

   386

}

   387

   388

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

   389

struct indview_d : public vp_d {

   390

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

   391

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

   392

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

   393

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

   394

};

   395

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(indview_d));

   396

   397

   398

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

   399

{

   400

	switch (e->event) {

   401

	case WE_CREATE: {

   402

		/* Count the number of lines that we need to resize the GUI with */

   403

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

   404

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

   405

		int lines = -3;

   408

   409

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

   417

				lines++;

   418

			}

   426

		}

   427

   433

				lines++;

   435

			}

   436

			lines++;

   437

		}

   438

   439

		if (HASBIT(ind->callback_flags, CBM_IND_WINDOW_MORE_TEXT)) lines += 2;

   440

   442

			if (j != 5) w->widget[j].top += lines * 10;

   443

			w->widget[j].bottom += lines * 10;

   444

		}

   445

		w->height += lines * 10;

   446

	} break;

   447

   448

	case WE_PAINT: {

   449

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

   450

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

   451

		int y = 111;

   454

   455

		SetDParam(0, w->window_number);

   456

		DrawWindowWidgets(w);

   457

   458

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

   463

					DrawString(2, y, STR_INDUSTRY_WINDOW_WAITING_FOR_PROCESSING, 0);

   464

					y += 10;

   466

				}

   467

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

   468

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

   469

				DrawString(4, y, STR_INDUSTRY_WINDOW_WAITING_STOCKPILE_CARGO, 0);

   470

				y += 10;

   471

			}

   480

			}

   485

		}