1

/* $Id$ */

     2

     3

/** @file news_gui.cpp GUI functions related to news messages. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "viewport_func.h"

    10

#include "news_func.h"

    11

#include "settings_type.h"

    12

#include "transparency.h"

    13

#include "strings_func.h"

    14

#include "window_func.h"

    15

#include "date_func.h"

    16

#include "vehicle_base.h"

    17

#include "sound_func.h"

    18

#include "string_func.h"

    19

#include "widgets/dropdown_func.h"

    20

#include "map_func.h"

    21

#include "statusbar_gui.h"

    22

#include "player_face.h"

    23

    24

#include "table/sprites.h"

    25

#include "table/strings.h"

    26

    27

/** @file news_gui.cpp

    28

 *

    29

 * News system is realized as a FIFO queue (in an array)

    30

 * The positions in the queue can't be rearranged, we only access

    31

 * the array elements through pointers to the elements. Once the

    32

 * array is full, the oldest entry (\a _oldest_news) is being overwritten

    33

 * by the newest (\a _latest_news).

    34

 *

    35

 * \verbatim

    36

 * oldest                   current   lastest

    37

 *  |                          |         |

    38

 * [O------------F-------------C---------L           ]

    39

 *               |

    40

 *            forced

    41

 * \endverbatim

    42

 *

    43

 * Of course by using an array we can have situations like

    44

 *

    45

 * \verbatim

    46

 * [----L          O-----F---------C-----------------]

    47

 * This is where we have wrapped around the array and have

    48

 * (MAX_NEWS - O) + L news items

    49

 * \endverbatim

    50

 */

    51

    52

#define NB_WIDG_PER_SETTING 4

    53

    54

typedef byte NewsID;

    55

#define INVALID_NEWS 255

    56

    57

NewsItem _statusbar_news_item;

    58

bool _news_ticker_sound;

    59

static NewsItem *_news_items = NULL;        ///< The news FIFO queue

    60

static uint _max_news_items = 0;            ///< size of news FIFO queue

    61

static NewsID _current_news = INVALID_NEWS; ///< points to news item that should be shown next

    62

static NewsID _oldest_news = 0;             ///< points to first item in fifo queue

    63

static NewsID _latest_news = INVALID_NEWS;  ///< points to last item in fifo queue

    64

    65

/** Forced news item.

    66

 * Users can force an item by accessing the history or "last message".

    67

 * If the message being shown was forced by the user, its index is stored in

    68

 * _forced_news. Otherwise, \a _forced_news variable is INVALID_NEWS. */

    69

static NewsID _forced_news = INVALID_NEWS;

    70

    71

static uint _total_news = 0; ///< Number of news items in FIFO queue @see _news_items

    72

static void MoveToNextItem();

    73

    74

    75

typedef void DrawNewsCallbackProc(struct Window *w, const NewsItem *ni);

    76

void DrawNewsNewVehicleAvail(Window *w, const NewsItem *ni);

    77

    78

static void DrawNewsBankrupcy(Window *w, const NewsItem *ni)

    79

{

    80

	Player *p = GetPlayer((PlayerID)(ni->data_b));

    81

	DrawPlayerFace(p->face, p->player_color, 2, 23);

    82

	GfxFillRect(3, 23, 3 + 91, 23 + 118, PALETTE_TO_STRUCT_GREY | (1 << USE_COLORTABLE));

    83

    84

	SetDParam(0, p->index);

    85

    86

	DrawStringMultiCenter(49, 148, STR_7058_PRESIDENT, 94);

    87

    88

	switch (ni->subtype) {

    89

		case NS_COMPANY_TROUBLE:

    90

			DrawStringCentered(w->width >> 1, 1, STR_7056_TRANSPORT_COMPANY_IN_TROUBLE, TC_FROMSTRING);

    91

    92

			SetDParam(0, p->index);

    93

    94

			DrawStringMultiCenter(

    95

				((w->width - 101) >> 1) + 98,

    96

				90,

    97

				STR_7057_WILL_BE_SOLD_OFF_OR_DECLARED,

    98

				w->width - 101);

    99

			break;

   100

   101

		case NS_COMPANY_MERGER:

   102

			DrawStringCentered(w->width >> 1, 1, STR_7059_TRANSPORT_COMPANY_MERGER, TC_FROMSTRING);

   103

			SetDParam(0, ni->params[2]);

   104

			SetDParam(1, p->index);

   105

			SetDParam(2, ni->params[4]);

   106

			DrawStringMultiCenter(

   107

				((w->width - 101) >> 1) + 98,

   108

				90,

   109

				ni->params[4] == 0 ? STR_707F_HAS_BEEN_TAKEN_OVER_BY : STR_705A_HAS_BEEN_SOLD_TO_FOR,

   110

				w->width - 101);

   111

			break;

   112

   113

		case NS_COMPANY_BANKRUPT:

   114

			DrawStringCentered(w->width >> 1, 1, STR_705C_BANKRUPT, TC_FROMSTRING);

   115

			SetDParam(0, p->index);

   116

			DrawStringMultiCenter(

   117

				((w->width - 101) >> 1) + 98,

   118

				90,

   119

				STR_705D_HAS_BEEN_CLOSED_DOWN_BY,

   120

				w->width - 101);

   121

			break;

   122

   123

		case NS_COMPANY_NEW:

   124

			DrawStringCentered(w->width >> 1, 1, STR_705E_NEW_TRANSPORT_COMPANY_LAUNCHED, TC_FROMSTRING);

   125

			SetDParam(0, p->index);

   126

			SetDParam(1, ni->params[3]);

   127

			DrawStringMultiCenter(

   128

				((w->width - 101) >> 1) + 98,

   129

				90,

   130

				STR_705F_STARTS_CONSTRUCTION_NEAR,

   131

				w->width - 101);

   132

			break;

   133

   134

		default:

   135

			NOT_REACHED();

   136

	}

   137

}

   138

   139

   140

/**

   141

 * Data common to all news items of a given subtype (structure)

   142

 */

   143

struct NewsSubtypeData {

   144

	NewsType type;         ///< News category @see NewsType

   145

	NewsMode display_mode; ///< Display mode value @see NewsMode

   146

	NewsFlag flags;        ///< Initial NewsFlags bits @see NewsFlag

   147

	DrawNewsCallbackProc *callback; ///< Call-back function

   148

};

   149

   150

/**

   151

 * Data common to all news items of a given subtype (actual data)

   152

 */

   153

static const struct NewsSubtypeData _news_subtype_data[NS_END] = {

   154

	/* type,             display_mode, flags,                  callback */

   155

	{ NT_ARRIVAL_PLAYER,  NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ARRIVAL_PLAYER

   156

	{ NT_ARRIVAL_OTHER,   NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ARRIVAL_OTHER

   157

	{ NT_ACCIDENT,        NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_ACCIDENT_TILE

   158

	{ NT_ACCIDENT,        NM_THIN,     NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ACCIDENT_VEHICLE

   159

	{ NT_COMPANY_INFO,    NM_CALLBACK, NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_TROUBLE

   160

	{ NT_COMPANY_INFO,    NM_CALLBACK, NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_MERGER

   161

	{ NT_COMPANY_INFO,    NM_CALLBACK, NF_NONE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_BANKRUPT

   162

	{ NT_COMPANY_INFO,    NM_CALLBACK, NF_TILE,                DrawNewsBankrupcy       }, ///< NS_COMPANY_NEW

   163

	{ NT_OPENCLOSE,       NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_OPENCLOSE

   164

	{ NT_ECONOMY,         NM_NORMAL,   NF_NONE,                NULL                    }, ///< NS_ECONOMY

   165

	{ NT_INDUSTRY_PLAYER, NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_PLAYER

   166

	{ NT_INDUSTRY_OTHER,  NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_OTHER

   167

	{ NT_INDUSTRY_NOBODY, NM_THIN,     NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_INDUSTRY_NOBODY

   168

	{ NT_ADVICE,          NM_SMALL,    NF_VIEWPORT|NF_VEHICLE, NULL                    }, ///< NS_ADVICE

   169

	{ NT_NEW_VEHICLES,    NM_CALLBACK, NF_NONE,                DrawNewsNewVehicleAvail }, ///< NS_NEW_VEHICLES

   170

	{ NT_ACCEPTANCE,      NM_SMALL,    NF_VIEWPORT|NF_TILE,    NULL                    }, ///< NS_ACCEPTANCE

   171

	{ NT_SUBSIDIES,       NM_NORMAL,   NF_TILE|NF_TILE2,       NULL                    }, ///< NS_SUBSIDIES

   172

	{ NT_GENERAL,         NM_NORMAL,   NF_TILE,                NULL                    }, ///< NS_GENERAL

   173

};

   174

   175

/** Initialize the news-items data structures */

   176

void InitNewsItemStructs()

   177

{

   178

	free(_news_items);

   179

	_max_news_items = max(ScaleByMapSize(30), 30U);

   180

	_news_items = CallocT<NewsItem>(_max_news_items);

   181

	_current_news = INVALID_NEWS;

   182

	_oldest_news = 0;

   183

	_latest_news = INVALID_NEWS;

   184

	_forced_news = INVALID_NEWS;

   185

	_total_news = 0;

   186

}

   187

   188

struct NewsWindow : Window {

   189

	uint16 chat_height;

   190

	NewsItem *ni;

   191

   192

	NewsWindow(const WindowDesc *desc, NewsItem *ni) : Window(desc), ni(ni)

   193

	{

   194

		const Window *w = FindWindowById(WC_SEND_NETWORK_MSG, 0);

   195

		this->chat_height = (w != NULL) ? w->height : 0;

   196

   197

		this->ni = &_news_items[_forced_news == INVALID_NEWS ? _current_news : _forced_news];

   198

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   199

   200

		this->FindWindowPlacementAndResize(desc);

   201

	}

   202

   203

	void DrawNewsBorder()

   204

	{

   205

		int left = 0;

   206

		int right = this->width - 1;

   207

		int top = 0;

   208

		int bottom = this->height - 1;

   209

   210

		GfxFillRect(left, top, right, bottom, 0xF);

   211

   212

		GfxFillRect(left, top, left, bottom, 0xD7);

   213

		GfxFillRect(right, top, right, bottom, 0xD7);

   214

		GfxFillRect(left, top, right, top, 0xD7);

   215

		GfxFillRect(left, bottom, right, bottom, 0xD7);

   216

   217

		DrawString(left + 2, top + 1, STR_00C6, TC_FROMSTRING);

   218

	}

   219

   220

	virtual void OnPaint()

   221

	{

   222

		const NewsMode display_mode = _news_subtype_data[this->ni->subtype].display_mode;

   223

   224

		switch (display_mode) {

   225

			case NM_NORMAL:

   226

			case NM_THIN: {

   227

				this->DrawNewsBorder();

   228

   229

				DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   230

   231

				SetDParam(0, this->ni->date);

   232

				DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   233

   234

				if (!(this->ni->flags & NF_VIEWPORT)) {

   235

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   236

					DrawStringMultiCenter(215, display_mode == NM_NORMAL ? 76 : 56,

   237

						this->ni->string_id, this->width - 4);

   238

				} else {

   239

					/* Back up transparency options to draw news view */

   240

					TransparencyOptionBits to_backup = _transparency_opt;

   241

					_transparency_opt = 0;

   242

					this->DrawViewport();

   243

					_transparency_opt = to_backup;

   244

   245

					/* Shade the viewport into gray, or color*/

   246

					ViewPort *vp = this->viewport;

   247

					GfxFillRect(vp->left - this->left, vp->top - this->top,

   248

						vp->left - this->left + vp->width - 1, vp->top - this->top + vp->height - 1,

   249

						(this->ni->flags & NF_INCOLOR ? PALETTE_TO_TRANSPARENT : PALETTE_TO_STRUCT_GREY) | (1 << USE_COLORTABLE)

   250

					);

   251

   252

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   253

					DrawStringMultiCenter(this->width / 2, 20, this->ni->string_id, this->width - 4);

   254

				}

   255

				break;

   256

			}

   257

   258

			case NM_CALLBACK:

   259

				this->DrawNewsBorder();

   260

				(_news_subtype_data[this->ni->subtype].callback)(this, ni);

   261

				break;

   262

   263

			default:

   264

				this->DrawWidgets();

   265

				if (!(this->ni->flags & NF_VIEWPORT)) {

   266

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   267

					DrawStringMultiCenter(140, 38, this->ni->string_id, 276);

   268

				} else {

   269

					this->DrawViewport();

   270

					CopyInDParam(0, this->ni->params, lengthof(this->ni->params));

   271

					DrawStringMultiCenter(this->width / 2, this->height - 16, this->ni->string_id, this->width - 4);

   272

				}

   273

				break;

   274

		}

   275

	}

   276

   277

	virtual void OnClick(Point pt, int widget)

   278

	{

   279

		switch (widget) {

   280

			case 1:

   281

				this->ni->duration = 0;

   282

				delete this;

   283

				_forced_news = INVALID_NEWS;

   284

				break;

   285

   286

			case 0:

   287

				if (this->ni->flags & NF_VEHICLE) {

   288

					Vehicle *v = GetVehicle(this->ni->data_a);

   289

					ScrollMainWindowTo(v->x_pos, v->y_pos);

   290

				} else if (this->ni->flags & NF_TILE) {

   291

					if (_ctrl_pressed) {

   292

						ShowExtraViewPortWindow(this->ni->data_a);

   293

						if (this->ni->flags & NF_TILE2) {

   294

							ShowExtraViewPortWindow(this->ni->data_b);

   295

						}

   296

					} else {

   297

						if (!ScrollMainWindowToTile(this->ni->data_a) && this->ni->flags & NF_TILE2) {

   298

							ScrollMainWindowToTile(this->ni->data_b);

   299

						}

   300

					}

   301

				}

   302

				break;

   303

		}

   304

	}

   305

   306

	virtual EventState OnKeyPress(uint16 key, uint16 keycode)

   307

	{

   308

		if (keycode == WKC_SPACE) {

   309

			/* Don't continue. */

   310

			delete this;

   311

			return ES_HANDLED;

   312

		}

   313

		return ES_NOT_HANDLED;

   314

	}

   315

   316

	virtual void OnInvalidateData(int data)

   317

	{

   318

		/* The chatbar has notified us that is was either created or closed */

   319

		this->chat_height = data;

   320

	}

   321

   322

	virtual void OnTick()

   323

	{

   324

		/* Scroll up newsmessages from the bottom in steps of 4 pixels */

   325

		int y = max(this->top - 4, _screen.height - this->height - 12 - this->chat_height);

   326

		if (y == this->top) return;

   327

   328

		if (this->viewport != NULL) this->viewport->top += y - this->top;

   329

   330

		int diff = Delta(this->top, y);

   331

		this->top = y;

   332

   333

		SetDirtyBlocks(this->left, this->top - diff, this->left + this->width, this->top + this->height);

   334

	}

   335

};

   336

   337

/**

   338

 * Return the correct index in the pseudo-fifo

   339

 * queue and deals with overflows when increasing the index

   340

 */

   341

static inline NewsID IncreaseIndex(NewsID i)

   342

{

   343

	assert(i != INVALID_NEWS);

   344

	return (i + 1) % _max_news_items;

   345

}

   346

   347

/**

   348

 * Return the correct index in the pseudo-fifo

   349

 * queue and deals with overflows when decreasing the index

   350

 */

   351

static inline NewsID DecreaseIndex(NewsID i)

   352

{

   353

	assert(i != INVALID_NEWS);

   354

	return (i + _max_news_items - 1) % _max_news_items;

   355

}

   356

   357

/**

   358

 * Add a new newsitem to be shown.

   359

 * @param string String to display

   360

 * @param subtype news category, any of the NewsSubtype enums (NS_)

   361

 * @param data_a news-specific value based on news type

   362

 * @param data_b news-specific value based on news type

   363

 *

   364

 * @see NewsSubype

   365

 */

   366

void AddNewsItem(StringID string, NewsSubtype subtype, uint data_a, uint data_b)

   367

{

   368

	if (_game_mode == GM_MENU) return;

   369

   370

	/* check the rare case that the oldest (to be overwritten) news item is open */

   371

	if (_total_news == _max_news_items && (_oldest_news == _current_news || _oldest_news == _forced_news)) {

   372

		MoveToNextItem();

   373

	}

   374

   375

	if (_total_news < _max_news_items) _total_news++;

   376

   377

	/* Increase _latest_news. If we have no news yet, use _oldest news as an

   378

	 * index. We cannot use 0 as _oldest_news can jump around due to

   379

	 * DeleteVehicleNews */

   380

	NewsID l_news = _latest_news;

   381

	_latest_news = (_latest_news == INVALID_NEWS) ? _oldest_news : IncreaseIndex(_latest_news);

   382

   383

	/* If the fifo-buffer is full, overwrite the oldest entry */

   384

	if (l_news != INVALID_NEWS && _latest_news == _oldest_news) {

   385

		assert(_total_news == _max_news_items);

   386

		_oldest_news = IncreaseIndex(_oldest_news);

   387

	}

   388

   389

	/*DEBUG(misc, 0, "+cur %3d, old %2d, lat %3d, for %3d, tot %2d",

   390

	  _current_news, _oldest_news, _latest_news, _forced_news, _total_news);*/

   391

   392

	/* Add news to _latest_news */

   393

	NewsItem *ni = &_news_items[_latest_news];

   394

	memset(ni, 0, sizeof(*ni));

   395

   396

	ni->string_id = string;

   397

	ni->subtype = subtype;

   398

	ni->flags = _news_subtype_data[subtype].flags;

   399

   400

	/* show this news message in color? */

   401

	if (_cur_year >= _settings.gui.colored_news_year) ni->flags |= NF_INCOLOR;

   402

   403

	ni->data_a = data_a;

   404

	ni->data_b = data_b;

   405

	ni->date = _date;

   406

	CopyOutDParam(ni->params, 0, lengthof(ni->params));

   407

   408

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   409

	if (w == NULL) return;

   410

	w->SetDirty();

   411

	w->vscroll.count = _total_news;

   412

}

   413

   414

   415

/**

   416

 * Per-NewsType data

   417

 */

   418

NewsTypeData _news_type_data[NT_END] = {

   419

	/* name,              age, sound,           display */

   420

	{ "arrival_player",    60, SND_1D_APPLAUSE, ND_FULL },  ///< NT_ARRIVAL_PLAYER

   421

	{ "arrival_other",     60, SND_1D_APPLAUSE, ND_FULL },  ///< NT_ARRIVAL_OTHER

   422

	{ "accident",          90, SND_BEGIN,       ND_FULL },  ///< NT_ACCIDENT

   423

	{ "company_info",      60, SND_BEGIN,       ND_FULL },  ///< NT_COMPANY_INFO

   424

	{ "openclose",         90, SND_BEGIN,       ND_FULL },  ///< NT_OPENCLOSE

   425

	{ "economy",           30, SND_BEGIN,       ND_FULL },  ///< NT_ECONOMY

   426

	{ "production_player", 30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_PLAYER

   427

	{ "production_other",  30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_OTHER

   428

	{ "production_nobody", 30, SND_BEGIN,       ND_FULL },  ///< NT_INDUSTRY_NOBODY

   429

	{ "advice",           150, SND_BEGIN,       ND_FULL },  ///< NT_ADVICE

   430

	{ "new_vehicles",      30, SND_1E_OOOOH,    ND_FULL },  ///< NT_NEW_VEHICLES

   431

	{ "acceptance",        90, SND_BEGIN,       ND_FULL },  ///< NT_ACCEPTANCE

   432

	{ "subsidies",        180, SND_BEGIN,       ND_FULL },  ///< NT_SUBSIDIES

   433

	{ "general",           60, SND_BEGIN,       ND_FULL },  ///< NT_GENERAL

   434

};

   435

   436

   437

static const Widget _news_type13_widgets[] = {

   438

{      WWT_PANEL,   RESIZE_NONE,    15,     0,   429,     0,   169, 0x0, STR_NULL},

   439

{      WWT_PANEL,   RESIZE_NONE,    15,     0,    10,     0,    11, 0x0, STR_NULL},

   440

{   WIDGETS_END},

   441

};

   442

   443

static WindowDesc _news_type13_desc = {

   444

	WDP_CENTER, 476, 430, 170, 430, 170,

   445

	WC_NEWS_WINDOW, WC_NONE,

   446

	WDF_DEF_WIDGET,

   447

	_news_type13_widgets,

   448

};

   449

   450

static const Widget _news_type2_widgets[] = {

   451

{      WWT_PANEL,   RESIZE_NONE,    15,     0,   429,     0,   129, 0x0, STR_NULL},

   452

{      WWT_PANEL,   RESIZE_NONE,    15,     0,    10,     0,    11, 0x0, STR_NULL},

   453

{   WIDGETS_END},

   454

};

   455

   456

static WindowDesc _news_type2_desc = {

   457

	WDP_CENTER, 476, 430, 130, 430, 130,

   458

	WC_NEWS_WINDOW, WC_NONE,

   459

	WDF_DEF_WIDGET,

   460

	_news_type2_widgets,

   461

};

   462

   463

static const Widget _news_type0_widgets[] = {

   464

{      WWT_PANEL,   RESIZE_NONE,     5,     0,   279,    14,    86, 0x0,              STR_NULL},

   465

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

   466

{    WWT_CAPTION,   RESIZE_NONE,     5,    11,   279,     0,    13, STR_012C_MESSAGE, STR_NULL},

   467

{      WWT_INSET,   RESIZE_NONE,     5,     2,   277,    16,    64, 0x0,              STR_NULL},

   468

{   WIDGETS_END},

   469

};

   470

   471

static WindowDesc _news_type0_desc = {

   472

	WDP_CENTER, 476, 280, 87, 280, 87,

   473

	WC_NEWS_WINDOW, WC_NONE,

   474

	WDF_DEF_WIDGET,

   475

	_news_type0_widgets,

   476

};

   477

   478

   479

/** Open up an own newspaper window for the news item */

   480

static void ShowNewspaper(NewsItem *ni)

   481

{

   482

	ni->flags &= ~NF_FORCE_BIG;

   483

	ni->duration = 555;

   484

   485

	SoundFx sound = _news_type_data[_news_subtype_data[ni->subtype].type].sound;

   486

	if (sound != 0) SndPlayFx(sound);

   487