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"

    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

    63

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

    64

{

    65

	switch (e->event) {

    66

		case WE_CREATE: {

    67

			IndustryType ind;

    68

			const IndustrySpec *indsp;

    69

    70

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

    71

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

    72

			 * height when newindistries are loaded */

    73

			if (!_loaded_newgrf_features.has_newindustries) {

    74

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

    75

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

    76

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

    77

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

    78

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

    79

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

    80

			}

    81

    82

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

    83

    84

			/* Initilialize structures */

    85

			_fund_gui.count = 0;

    86

    93

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

    94

			w->resize.step_height = 13;

    95

    96

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

    97

				_fund_gui.index[_fund_gui.count] = INVALID_INDUSTRYTYPE;

    98

				_fund_gui.count++;

    99

				WP(w, fnd_d).timer_enabled = false;

   100

			}

   101

   102

			/* Fill the _fund_gui structure with industries.

   103

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

   104

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

   105

			 */

   106

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

   107

				indsp = GetIndustrySpec(ind);

   108

				if (indsp->enabled){

   109

					/* Rule is that editor mode loads all industries.

   110

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

   111

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

   112

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

   113

					_fund_gui.index[_fund_gui.count] = ind;

   114

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

   115

					_fund_gui.count++;

   116

				}

   117

			}

   118

   119

			/* first indutry type is selected.

   120

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

   121

			WP(w, fnd_d).index = 0;

   122

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

   123

			WP(w, fnd_d).callback_timer = DAY_TICKS;

   124

		} break;

   125

   126

		case WE_PAINT: {

   127

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

   128

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

   129

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

   130

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

   131

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

   132

   133

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

   134

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

   135

			if (_game_mode == GM_EDITOR) {

   136

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

   137

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

   138

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

   139

			} else {

   140

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

   141

			}

   142

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

   143

   144

			SetVScrollCount(w, _fund_gui.count);

   145

   146

			DrawWindowWidgets(w);

   147

   148

			/* and now with the matrix painting */

   149

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

   150

				int offset = i * 13;

   151

				int x = 3;

   152

				int y = 16;

   153

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

   154

   155

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

   156

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

   157

					continue;

   158

				}

   159

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

   160

   161

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

   162

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

   163

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

   164

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

   165

			}

   166

   167

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

   168

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

   169

				break;

   170

			}

   171

   172

			if (_game_mode != GM_EDITOR) {

   173

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

   174

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

   175

				y_str += 11;

   176

			}

   177

   178

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

   179

			StringID str = STR_4827_REQUIRES;

   180

			byte p = 0;

   181

			SetDParam(0, STR_00D0_NOTHING);

   182

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

   183

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

   184

				if (p > 0) str++;

   185

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

   186

			}

   187

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

   188

			y_str += 11;

   189

   190

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

   191

			str = STR_4827_PRODUCES;

   192

			p = 0;

   193

			SetDParam(0, STR_00D0_NOTHING);

   194

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

   195

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

   196

				if (p > 0) str++;

   197

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

   198

			}

   199

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

   200

			y_str += 11;

   201

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

					}

   210

				}

   211

			}

   212

   213

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

   214

			 * Otherwhise, will print Nothing */

   215

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

   216

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

   217

				SetDParam(0, str);

   218

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

   219

			}

   220

		} break;

   221

   222

		case WE_DOUBLE_CLICK:

   223

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

   224

			e->we.click.widget = DPIW_FUND_WIDGET;

   225

			/* Fall through */

   226

   227

		case WE_CLICK:

   228

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

   229

				case DPIW_MATRIX_WIDGET: {

   230

					const IndustrySpec *indsp;

   231

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

   232

   233

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

   234

						WP(w, fnd_d).index = y;

   235

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

   236

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

   237

   238

						SetWindowDirty(w);

   239

   240

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

   241

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

   242

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

   243

							w->RaiseButtons();

   244

							ResetObjectToPlace();

   245

						}

   246

					}

   247

				} break;

   248

   249

				case DPIW_FUND_WIDGET: {

   250

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

   251

						w->HandleButtonClick(DPIW_FUND_WIDGET);

   252

   253

						if (GetNumTowns() == 0) {

   254

							ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_CAN_T_GENERATE_INDUSTRIES, 0, 0);

   255

						} else {

   256

							extern void GenerateIndustries();

   257

							_generating_world = true;

   258

							GenerateIndustries();

   259

							_generating_world = false;

   260

						}

   261

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

   263

						w->HandleButtonClick(DPIW_FUND_WIDGET);

   264

					} else {

   265

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

   266

					}

   267

				} break;

   268

			}

   269

			break;

   270

   271

		case WE_RESIZE: {

   272

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

   273

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

   274

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

   275

		} break;

   276

   277

		case WE_PLACE_OBJ: {

   278

			bool success = true;

   279

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

   280

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

   282

   283

			if (_game_mode == GM_EDITOR) {

   284

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

   285

				if (GetNumTowns() == 0) {

   286

					SetDParam(0, indsp->name);

   287

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

   288

					return;

   289

				}

   290

   291

				_current_player = OWNER_NONE;

   292

				_generating_world = true;

   293

				_ignore_restrictions = true;

   295

				if (!success) {

   296

					SetDParam(0, indsp->name);

   297

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

   298

				}

   299

   300

				_ignore_restrictions = false;

   301

				_generating_world = false;

   302

			} else {

   304

			}

   305

   306

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

   307

			if (success) ResetObjectToPlace();

   308

		} break;

   309

   310

		case WE_TICK:

   311

			if (_pause_game != 0) break;

   312

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

   313

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

   314

				/* We have just passed another day.

   315

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

   316

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

   317

   318

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

   319

   320

				if (indsp->enabled) {

   321

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

   322

   323

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

   324

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

   325

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

   326

						SetWindowDirty(w);

   327

					}

   328

				}

   329

			}

   330

			break;

   331

   332

		case WE_TIMEOUT:

   333

		case WE_ABORT_PLACE_OBJ:

   334

			w->RaiseButtons();

   335

			break;

   336

	}

   337

}

   338

   339

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

   340

static const Widget _build_dynamic_industry_widgets[] = {

   341

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

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

{   WIDGETS_END},

   349

};

   350

   351

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

   352

static const WindowDesc _build_industry_dynamic_desc = {

   353

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

   354

	WC_BUILD_INDUSTRY, WC_NONE,

   355

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_RESIZABLE,

   356

	_build_dynamic_industry_widgets,

   357

	BuildDynamicIndustryWndProc,

   358

};

   359

   360

void ShowBuildIndustryWindow()

   361

{

   362

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

   363

	AllocateWindowDescFront(&_build_industry_dynamic_desc, 0);

   364

}

   365

   366

static void UpdateIndustryProduction(Industry *i);

   367

   368

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

   369

{

   370

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

   371

}

   372

   373

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

   374

{

   375

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

   376

}

   377

   378

static inline bool IsProductionAlterable(const Industry *i)

   379

{

   380

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

   381

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

   382

}

   383

   384

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

   385

enum IndustryViewWidgets {

   386

	IVW_CLOSEBOX = 0,

   387

	IVW_CAPTION,

   388

	IVW_STICKY,

   389

	IVW_BACKGROUND,

   390

	IVW_VIEWPORT,

   391

	IVW_INFO,

   392

	IVW_GOTO,

   393

	IVW_SPACER,

   395

};

   396

   397

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

   398

struct indview_d : public vp_d {

   399

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

   400

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

   401

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

   402

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

   403

};

   404

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(indview_d));

   405

   406

   407

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

   408

{

   409

	switch (e->event) {

   410

	case WE_CREATE: {

   411

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

   412

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

   413

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

   414

		int lines = -3;

   415

		bool first = true;

   416

		bool has_accept = false;

   417

   418

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

   419

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

   420

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

   421

				has_accept = true;

   422

				if (first) {

   423

					lines++;

   424

					first = false;

   425

				}

   426

				lines++;

   427

			}

   428

		} else {

   429

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

   430

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

   431

				has_accept = true;

   432

				lines++;

   433

				break;

   434

			}

   435

		}

   436

   437

		first = true;

   438

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

   439

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

   440

			if (first) {

   441

				if (has_accept) lines++;

   442

				lines++;

   443

				first = false;

   444

			}

   445

			lines++;

   446

		}

   447

   459

   466

		}

   469

	} break;

   470

   471

	case WE_PAINT: {

   472

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

   473

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

   474

		int y = 111;

   475

		bool first = true;

   476

		bool has_accept = false;

   477

   478

		SetDParam(0, w->window_number);

   479

		DrawWindowWidgets(w);

   480

   481

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

   482

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

   483

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

   484

				has_accept = true;

   485

				if (first) {