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

static DrawNewsCallbackProc * const _draw_news_callback[] = {

   141

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

   142

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

   143

};

   144

   145

/**

   146

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

   147

 */

   148

struct NewsSubtypeData {

   149

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

   150

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

   151

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

   152

	NewsCallback callback; ///< Call-back function

   153

};

   154

   155

/**

   156

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

   157

 */

   158

static const struct NewsSubtypeData _news_subtype_data[NS_END] = {

   159

	/* type,             display_mode, flags,                  callback */

   160

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

   161

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

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

};

   179

   180

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

   181

void InitNewsItemStructs()

   182

{

   183

	free(_news_items);

   184

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

   185

	_news_items = CallocT<NewsItem>(_max_news_items);

   186

	_current_news = INVALID_NEWS;

   187

	_oldest_news = 0;

   188

	_latest_news = INVALID_NEWS;

   189

	_forced_news = INVALID_NEWS;

   190

	_total_news = 0;

   191

}

   192

   193

struct NewsWindow : Window {

   194

	uint16 chat_height;

   195

	NewsItem *ni;

   196

   197

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

   198

	{

   199

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

   200

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

   201

   202

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

   203

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   204

   205

		this->FindWindowPlacementAndResize(desc);

   206

	}

   207

   208

	void DrawNewsBorder()

   209

	{

   210

		int left = 0;

   211

		int right = this->width - 1;

   212

		int top = 0;

   213

		int bottom = this->height - 1;

   214

   215

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

   216

   217

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

   218

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

   219

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

   220

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

   221

   222

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

   223

	}

   224

   225

	virtual void OnPaint()

   226

	{

   227

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

   228

   229

		switch (display_mode) {

   230

			case NM_NORMAL:

   231

			case NM_THIN: {

   232

				this->DrawNewsBorder();

   233

   234

				DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   235

   236

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

   237

				DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   238

   239

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

   240

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

   241

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

   242

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

   243

				} else {

   244

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

   245

					TransparencyOptionBits to_backup = _transparency_opt;

   246

					_transparency_opt = 0;

   247

					this->DrawViewport();

   248

					_transparency_opt = to_backup;

   249

   250

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

   251

					ViewPort *vp = this->viewport;

   252

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

   253

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

   254

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

   255

					);

   256

   257

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

   258

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

   259

				}

   260

				break;

   261

			}

   262

   263

			case NM_CALLBACK:

   264

				this->DrawNewsBorder();

   265

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

   266

				break;

   267

   268

			default:

   269

				this->DrawWidgets();

   270

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

   271

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

   272

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

   273

				} else {

   274

					this->DrawViewport();

   275

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

   276

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

   277

				}

   278

				break;

   279

		}

   280

	}

   281

   282

	virtual void OnClick(Point pt, int widget)

   283

	{

   284

		switch (widget) {

   285

			case 1:

   286

				this->ni->duration = 0;

   287

				delete this;

   288

				_forced_news = INVALID_NEWS;

   289

				break;

   290

   291

			case 0:

   292

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

   293

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

   294

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

   295

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

   296

					if (_ctrl_pressed) {

   297

						ShowExtraViewPortWindow(this->ni->data_a);

   298

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

   299

							ShowExtraViewPortWindow(this->ni->data_b);

   300

						}

   301

					} else {

   302

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

   303

							ScrollMainWindowToTile(this->ni->data_b);

   304

						}

   305

					}

   306

				}

   307

				break;

   308

		}

   309

	}

   310

   312

	{

   313

		if (keycode == WKC_SPACE) {

   314

			/* Don't continue. */

   315

			delete this;

   317

		}

   319

	}

   320

   321

	virtual void OnInvalidateData(int data)

   322

	{

   323

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

   324

		this->chat_height = data;

   325

	}

   326

   327

	virtual void OnTick()

   328

	{

   329

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

   330

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

   331

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

   332

   333

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

   334

   335

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

   336

		this->top = y;

   337

   338

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

   339

	}

   340

};

   341

   342

/**

   343

 * Return the correct index in the pseudo-fifo

   344

 * queue and deals with overflows when increasing the index

   345

 */

   346

static inline NewsID IncreaseIndex(NewsID i)

   347

{

   348

	assert(i != INVALID_NEWS);

   349

	return (i + 1) % _max_news_items;

   350

}

   351

   352

/**

   353

 * Return the correct index in the pseudo-fifo

   354

 * queue and deals with overflows when decreasing the index

   355

 */

   356

static inline NewsID DecreaseIndex(NewsID i)

   357

{

   358

	assert(i != INVALID_NEWS);

   359

	return (i + _max_news_items - 1) % _max_news_items;

   360

}

   361

   362

/**

   363

 * Add a new newsitem to be shown.

   364

 * @param string String to display

   365

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

   366

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

   367

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

   368

 *

   369

 * @see NewsSubype

   370

 */

   371

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

   372

{

   373

	if (_game_mode == GM_MENU) return;

   374

   375

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

   376

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

   377

		MoveToNextItem();

   378

	}

   379

   380

	if (_total_news < _max_news_items) _total_news++;

   381

   382

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

   383

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

   384

	 * DeleteVehicleNews */

   385

	NewsID l_news = _latest_news;

   386

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

   387

   388

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

   389

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

   390

		assert(_total_news == _max_news_items);

   391

		_oldest_news = IncreaseIndex(_oldest_news);

   392

	}

   393

   394

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

   395

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

   396

   397

	/* Add news to _latest_news */

   398

	NewsItem *ni = &_news_items[_latest_news];

   399

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

   400

   401

	ni->string_id = string;

   402

	ni->subtype = subtype;

   403

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

   404

   405

	/* show this news message in color? */

   406

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

   407

   408

	ni->data_a = data_a;

   409

	ni->data_b = data_b;

   410

	ni->date = _date;

   411

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

   412

   413

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   414

	if (w == NULL) return;

   415

	w->SetDirty();

   416

	w->vscroll.count = _total_news;

   417

}

   418

   419

   420

/**

   421

 * Per-NewsType data

   422

 */

   423

NewsTypeData _news_type_data[NT_END] = {

   424

	/* name,              age, sound,           display */

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

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

   437

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

   438

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

   439

};

   440

   441

   442

static const Widget _news_type13_widgets[] = {

   443

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

   444

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

   445

{   WIDGETS_END},

   446

};

   447

   448

static WindowDesc _news_type13_desc = {

   449

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

   450

	WC_NEWS_WINDOW, WC_NONE,

   451

	WDF_DEF_WIDGET,

   452

	_news_type13_widgets,

   453

	NULL

   454

};

   455

   456

static const Widget _news_type2_widgets[] = {

   457

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

   458

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

   459

{   WIDGETS_END},

   460

};

   461

   462

static WindowDesc _news_type2_desc = {

   463

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

   464

	WC_NEWS_WINDOW, WC_NONE,

   465

	WDF_DEF_WIDGET,

   466

	_news_type2_widgets,

   467

	NULL

   468

};

   469

   470

static const Widget _news_type0_widgets[] = {

   471

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

   472

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

   473

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

   474

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

   475

{   WIDGETS_END},

   476

};

   477

   478

static WindowDesc _news_type0_desc = {

   479

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

   480

	WC_NEWS_WINDOW, WC_NONE,

   481

	WDF_DEF_WIDGET,

   482

	_news_type0_widgets,

   483

	NULL

   484

};

   485

   486

   487

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

   488

static void ShowNewspaper(NewsItem *ni)