1

/* $Id$ */

     2

     3

/** @file industry_gui.cpp GUIs related to industries. */

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

    18

#include "cargotype.h"

    19

#include "newgrf.h"

    20

#include "newgrf_callbacks.h"

    21

#include "newgrf_industries.h"

    22

#include "newgrf_text.h"

    23

#include "strings_func.h"

    24

#include "map_func.h"

    25

#include "player_func.h"

    26

#include "settings_type.h"

    27

#include "tilehighlight_func.h"

    28

#include "string_func.h"

    29

#include "sortlist_type.h"

    30

    31

#include "table/strings.h"

    32

#include "table/sprites.h"

    33

    34

bool _ignore_restrictions;

    35

    36

enum CargoSuffixType {

    37

	CST_FUND,

    38

	CST_VIEW,

    39

	CST_DIR,

    40

};

    41

    42

/**

    43

 * Gets the string to display after the cargo name (using callback 37)

    44

 * @param cargo the cargo for which the suffix is requested

    45

 * - 00 - first accepted cargo type

    46

 * - 01 - second accepted cargo type

    47

 * - 02 - third accepted cargo type

    48

 * - 03 - first produced cargo type

    49

 * - 04 - second produced cargo type

    50

 * @param cst the cargo suffix type (for which window is it requested)

    51

 * @param ind the industry (NULL if in fund window)

    52

 * @param ind_type the industry type

    53

 * @param indspec the industry spec

    54

 * @return the string to display

    55

 */

    56

static StringID GetCargoSuffix(uint cargo, CargoSuffixType cst, Industry *ind, IndustryType ind_type, const IndustrySpec *indspec)

    57

{

    58

	if (HasBit(indspec->callback_flags, CBM_IND_CARGO_SUFFIX)) {

    59

		uint16 callback = GetIndustryCallback(CBID_INDUSTRY_CARGO_SUFFIX, 0, (cst << 8) | cargo, ind, ind_type, (cst != CST_FUND) ? ind->xy : INVALID_TILE);

    60

		if (GB(callback, 0, 8) != 0xFF) return GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback);

    61

	}

    62

	return STR_EMPTY;

    63

}

    64

    65

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

    66

enum DynamicPlaceIndustriesWidgets {

    67

	DPIW_CLOSEBOX = 0,

    68

	DPIW_CAPTION,

    69

	DPIW_MATRIX_WIDGET,

    70

	DPIW_SCROLLBAR,

    71

	DPIW_INFOPANEL,

    72

	DPIW_FUND_WIDGET,

    73

	DPIW_RESIZE_WIDGET,

    74

};

    75

    76

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

    77

static const Widget _build_industry_widgets[] = {

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

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

    85

{   WIDGETS_END},

    86

};

    87

    88

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

    89

static const WindowDesc _build_industry_desc = {

    90

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

    91

	WC_BUILD_INDUSTRY, WC_NONE,

    92

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_RESIZABLE,

    93

	_build_industry_widgets,

    94

};

    95

    96

class BuildIndustryWindow : public Window {

    97

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

    98

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

    99

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

   100

	bool timer_enabled;                         ///< timer can be used

   101

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

   102

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

   103

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

   104

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

   105

   106

	void SetupArrays()

   107

	{

   108

		IndustryType ind;

   109

		const IndustrySpec *indsp;

   110

   111

		this->count = 0;

   112

   113

		for (uint i = 0; i < lengthof(this->index); i++) {

   114

			this->index[i]   = INVALID_INDUSTRYTYPE;

   115

			this->text[i]    = STR_NULL;

   116

			this->enabled[i] = false;

   117

		}

   118

   119

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

   120

			this->index[this->count] = INVALID_INDUSTRYTYPE;

   121

			this->count++;

   122

			this->timer_enabled = false;

   123

		}

   124

		/* Fill the arrays with industries.

   125

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

   126

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

   127

		 */

   128

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

   129

			indsp = GetIndustrySpec(ind);

   130

			if (indsp->enabled){

   131

				/* Rule is that editor mode loads all industries.

   132

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

   133

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

   135

					/* Unselect if the industry is no longer in the list */

   136

					if (this->selected_type == ind) this->selected_index = -1;

   137

					continue;

   138

				}

   139

				this->index[this->count] = ind;

   140

				this->enabled[this->count] = (_game_mode == GM_EDITOR) || CheckIfCallBackAllowsAvailability(ind, IACT_USERCREATION);

   141

				/* Keep the selection to the correct line */

   142

				if (this->selected_type == ind) this->selected_index = this->count;

   143

				this->count++;

   144

			}

   145

		}

   146

   147

		/* first indutry type is selected if the current selection is invalid.

   148

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

   149

		if (this->selected_index == -1) {

   150

			this->selected_index = 0;

   151

			this->selected_type = this->index[0];

   152

		}

   153

	}

   154

   155

public:

   156

	BuildIndustryWindow() : Window(&_build_industry_desc)

   157

	{

   158

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

   159

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

   160

		 * height when newindistries are loaded */

   161

		if (!_loaded_newgrf_features.has_newindustries) {

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

		}

   169

   170

		this->timer_enabled = _loaded_newgrf_features.has_newindustries;

   171

   172

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

   173

		this->resize.step_height = 13;

   174

   175

		this->selected_index = -1;

   176

		this->selected_type = INVALID_INDUSTRYTYPE;

   177

   178

		/* Initialize arrays */

   179

		this->SetupArrays();

   180

   181

		this->callback_timer = DAY_TICKS;

   182

   183

		this->FindWindowPlacementAndResize(&_build_industry_desc);

   184

	}

   185

   186

	virtual void OnPaint()

   187

	{

   188

		const IndustrySpec *indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(this->selected_type);

   189

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

   190

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

   191

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

   192

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

   193

   194

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

   195

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

   196

		if (_game_mode == GM_EDITOR) {

   197

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

   199

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

   200

		} else {

   202

		}

   203

		this->SetWidgetDisabledState(DPIW_FUND_WIDGET, !this->enabled[this->selected_index]);

   204

   205

		SetVScrollCount(this, this->count);

   206

   207

		this->DrawWidgets();

   208

   209

		/* and now with the matrix painting */

   210

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

   211

			int offset = i * 13;

   212

			int x = 3;

   213

			int y = 16;

   214

			bool selected = this->selected_index == i + this->vscroll.pos;

   215

   216

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

   217

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

   218

				continue;

   219

			}

   220

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

   221

   222

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

   223

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

   224

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

   225

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

   226

		}

   227

   228

		if (this->selected_type == INVALID_INDUSTRYTYPE) {

   229

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

   230

			return;

   231

		}

   232

   233

		if (_game_mode != GM_EDITOR) {

   234

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

   235

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

   236

			y_str += 11;

   237

		}

   238

   239

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

   240

		StringID str = STR_4827_REQUIRES;

   241

		byte p = 0;

   242

		SetDParam(0, STR_00D0_NOTHING);

   243

		SetDParam(1, STR_EMPTY);

   244

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

   245

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

   246

			if (p > 0) str++;

   247

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

   248

			SetDParam(p++, GetCargoSuffix(j, CST_FUND, NULL, this->selected_type, indsp));

   249

		}

   250

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

   251

		y_str += 11;

   252

   253

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

   254

		str = STR_4827_PRODUCES;

   255

		p = 0;

   256

		SetDParam(0, STR_00D0_NOTHING);

   257

		SetDParam(1, STR_EMPTY);

   258

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

   259

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

   260

			if (p > 0) str++;

   261

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

   262

			SetDParam(p++, GetCargoSuffix(j + 3, CST_FUND, NULL, this->selected_type, indsp));

   263

		}

   264

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

   265

		y_str += 11;

   266

   267

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

   268

		if (this->text[this->selected_index] == STR_NULL) {   // Have i been called already?

   269

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

   270

				uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_FUND_MORE_TEXT, 0, 0, NULL, this->selected_type, INVALID_TILE);

   271

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

   272

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

   273

					this->text[this->selected_index] = newtxt;   // Store it for further usage

   274

				}

   275

			}

   276

		}

   277

   278

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

   279

		 * Otherwhise, will print Nothing */

   280

		str = this->text[this->selected_index];

   281

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

   282

			SetDParam(0, str);

   283

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

   284

		}

   285

	}

   286

   287

	virtual void OnDoubleClick(Point pt, int widget)

   288

	{

   289

		if (widget != DPIW_MATRIX_WIDGET) return;

   290

		this->OnClick(pt, DPIW_FUND_WIDGET);

   291

	}

   292

   293

	virtual void OnClick(Point pt, int widget)

   294

	{

   295

		switch (widget) {

   296

			case DPIW_MATRIX_WIDGET: {

   297

				const IndustrySpec *indsp;

   298

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

   299

   300

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

   301

					this->selected_index = y;

   302

					this->selected_type = this->index[y];

   303

					indsp = (this->selected_type == INVALID_INDUSTRYTYPE) ? NULL : GetIndustrySpec(this->selected_type);

   304

   305

					this->SetDirty();

   306

   308

							this->selected_type == INVALID_INDUSTRYTYPE) {

   309

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

   310

						this->RaiseButtons();

   311

						ResetObjectToPlace();

   312

					}

   313

				}

   314

			} break;

   315

   316

			case DPIW_FUND_WIDGET: {

   317

				if (this->selected_type == INVALID_INDUSTRYTYPE) {

   318

					this->HandleButtonClick(DPIW_FUND_WIDGET);

   319

   320

					if (GetNumTowns() == 0) {

   321

						ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_CAN_T_GENERATE_INDUSTRIES, 0, 0);

   322

					} else {

   323

						extern void GenerateIndustries();

   324

						_generating_world = true;

   325

						GenerateIndustries();

   326

						_generating_world = false;

   327

					}

   329

					DoCommandP(0, this->selected_type, InteractiveRandom(), NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   330

					this->HandleButtonClick(DPIW_FUND_WIDGET);

   331

				} else {

   332

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

   333

				}

   334

			} break;

   335

		}

   336

	}

   337

   338

	virtual void OnResize(Point new_size, Point delta)

   339

	{

   340

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

   341

		this->vscroll.cap  += delta.y / (int)this->resize.step_height;

   342

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

   343

	}

   344

   345

	virtual void OnPlaceObject(Point pt, TileIndex tile)

   346

	{

   347

		bool success = true;

   348

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

   349

		const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);

   350

		uint32 seed = InteractiveRandom();

   351

   352

		if (_game_mode == GM_EDITOR) {

   353

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

   354

			if (GetNumTowns() == 0) {

   355

				SetDParam(0, indsp->name);

   356

				ShowErrorMessage(STR_0286_MUST_BUILD_TOWN_FIRST, STR_0285_CAN_T_BUILD_HERE, pt.x, pt.y);

   357

				return;

   358

			}

   359

   360

			_current_player = OWNER_NONE;

   361

			_generating_world = true;

   362

			_ignore_restrictions = true;

   363

			success = DoCommandP(tile, (InteractiveRandomRange(indsp->num_table) << 16) | this->selected_type, seed, NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   364

			if (!success) {

   365

				SetDParam(0, indsp->name);

   366

				ShowErrorMessage(_error_message, STR_0285_CAN_T_BUILD_HERE, pt.x, pt.y);

   367

			}

   368

   369

			_ignore_restrictions = false;

   370

			_generating_world = false;

   371

		} else {

   372

			success = DoCommandP(tile, (InteractiveRandomRange(indsp->num_table) << 16) | this->selected_type, seed, NULL, CMD_BUILD_INDUSTRY | CMD_MSG(STR_4830_CAN_T_CONSTRUCT_THIS_INDUSTRY));

   373

		}

   374

   375

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

   376

		if (success) ResetObjectToPlace();

   377

	}

   378

   379

	virtual void OnTick()

   380

	{

   381

		if (_pause_game != 0) return;

   382

		if (!this->timer_enabled) return;

   383

		if (--this->callback_timer == 0) {

   384

			/* We have just passed another day.

   385

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

   386

			this->callback_timer = DAY_TICKS;  //restart counter

   387

   388

			const IndustrySpec *indsp = GetIndustrySpec(this->selected_type);

   389

   390

			if (indsp->enabled) {

   391

				bool call_back_result = CheckIfCallBackAllowsAvailability(this->selected_type, IACT_USERCREATION);

   392

   393

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

   394

				if (call_back_result != this->enabled[this->selected_index]) {

   395

					this->enabled[this->selected_index] = call_back_result;

   396

					this->SetDirty();

   397

				}

   398

			}

   399

		}

   400

	}

   401

   402

	virtual void OnTimeout()

   403

	{

   404

		this->RaiseButtons();

   405

	}

   406

   407

	virtual void OnPlaceObjectAbort()

   408

	{

   409

		this->RaiseButtons();

   410

	}

   411

   412

	virtual void OnInvalidateData(int data = 0)

   413

	{

   414

		this->SetupArrays();

   415

		this->SetDirty();

   416

	}

   417

};

   418

   419

void ShowBuildIndustryWindow()

   420

{

   421

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

   422

	if (BringWindowToFrontById(WC_BUILD_INDUSTRY, 0)) return;

   423

	new BuildIndustryWindow();

   424

}

   425

   426

static void UpdateIndustryProduction(Industry *i);

   427

   428

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

   429

{

   430

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

   431

}

   432

   433

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

   434

{

   435

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

   436

}

   437

   438

static inline bool IsProductionAlterable(const Industry *i)

   439

{

   440

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

   441

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

   442

}

   443

   444

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

   445

enum IndustryViewWidgets {

   446

	IVW_CLOSEBOX = 0,

   447

	IVW_CAPTION,

   448

	IVW_STICKY,

   449

	IVW_BACKGROUND,

   450

	IVW_VIEWPORT,

   451

	IVW_INFO,

   452

	IVW_GOTO,

   453

	IVW_SPACER,

   454

	IVW_RESIZE,

   455

};

   456

   457

class IndustryViewWindow : public Window

   458

{

   459

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

   460

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

   461

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

   462

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

   463

   464

public:

   465

	IndustryViewWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

   466

	{

   467

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   468

		this->editbox_line = 0;

   469

		this->clicked_line = 0;

   470

		this->clicked_button = 0;

   471

		InitializeWindowViewport(this, 3, 17, 254, 86, GetIndustry(window_number)->xy + TileDiffXY(1, 1), ZOOM_LVL_INDUSTRY);

   472

		this->FindWindowPlacementAndResize(desc);

   473

	}

   474

   475

	virtual void OnPaint()

   476

	{

   477

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

   478

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

   479

		int y = this->widget[IVW_INFO].top + 1;

   480

		bool first = true;

   481

		bool has_accept = false;

   482

   483

		SetDParam(0, this->window_number);

   484

		this->DrawWidgets();

   485

   486

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

   487

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

   488

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

   489

				has_accept = true;

   490

				if (first) {

   491

					DrawStringTruncated(2, y, STR_INDUSTRY_WINDOW_WAITING_FOR_PROCESSING, TC_FROMSTRING, this->widget[IVW_INFO].right - 2);