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

    23

#include "table/sprites.h"

    24

#include "table/strings.h"

    25

    26

/** @file news_gui.cpp

    27

 *

    28

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

    29

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

    30

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

    31

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

    32

 * by the newest (\a _latest_news).

    33

 *

    34

 * \verbatim

    35

 * oldest                   current   lastest

    36

 *  |                          |         |

    37

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

    38

 *               |

    39

 *            forced

    40

 * \endverbatim

    41

 *

    42

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

    43

 *

    44

 * \verbatim

    45

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

    46

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

    47

 * (MAX_NEWS - O) + L news items

    48

 * \endverbatim

    49

 */

    50

    51

#define NB_WIDG_PER_SETTING 4

    52

    53

typedef byte NewsID;

    54

#define INVALID_NEWS 255

    55

    56

NewsItem _statusbar_news_item;

    57

bool _news_ticker_sound;

    58

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

    59

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

    60

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

    61

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

    62

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

    63

    64

/** Forced news item.

    65

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

    66

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

    67

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

    68

static NewsID _forced_news = INVALID_NEWS;

    69

    70

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

    71

static void MoveToNextItem();

    72

    73

    74

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

    75

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

    76

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

    77

    78

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    79

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    80

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    81

};

    82

    83

/**

    84

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

    85

 */

    86

struct NewsSubtypeData {

    87

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

    88

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

    89

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

    90

	NewsCallback callback; ///< Call-back function

    91

};

    92

    93

/**

    94

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

    95

 */

    96

static const struct NewsSubtypeData _news_subtype_data[NS_END] = {

    97

	/* type,             display_mode, flags,                  callback */

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

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

   115

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

   116

};

   117

   118

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

   119

void InitNewsItemStructs()

   120

{

   121

	free(_news_items);

   122

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

   123

	_news_items = CallocT<NewsItem>(_max_news_items);

   124

	_current_news = INVALID_NEWS;

   125

	_oldest_news = 0;

   126

	_latest_news = INVALID_NEWS;

   127

	_forced_news = INVALID_NEWS;

   128

	_total_news = 0;

   129

}

   130

   131

struct NewsWindow : Window {

   132

	uint16 chat_height;

   133

	NewsItem *ni;

   134

   135

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

   136

	{

   137

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

   138

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

   139

   140

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

   141

		this->flags4 |= WF_DISABLE_VP_SCROLL;

   142

   143

		this->FindWindowPlacementAndResize(desc);

   144

	}

   145

   146

	void DrawNewsBorder()

   147

	{

   148

		int left = 0;

   149

		int right = this->width - 1;

   150

		int top = 0;

   151

		int bottom = this->height - 1;

   152

   153

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

   154

   155

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

   156

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

   157

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

   158

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

   159

   160

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

   161

	}

   162

   163

	virtual void OnPaint()

   164

	{

   165

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

   166

   167

		switch (display_mode) {

   168

			case NM_NORMAL:

   169

			case NM_THIN: {

   170

				this->DrawNewsBorder();

   171

   172

				DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   173

   174

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

   175

				DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   176

   177

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

   178

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

   179

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

   180

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

   181

				} else {

   182

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

   183

					TransparencyOptionBits to_backup = _transparency_opt;

   184

					_transparency_opt = 0;

   186

					_transparency_opt = to_backup;

   187

   188

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

   189

					ViewPort *vp = this->viewport;

   190

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

   191

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

   192

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

   193

					);

   194

   195

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

   196

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

   197

				}

   198

				break;

   199

			}

   200

   201

			case NM_CALLBACK:

   202

				this->DrawNewsBorder();

   203

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

   204

				break;

   205

   206

			default:

   208

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

   209

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

   210

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

   211

				} else {

   213

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

   214

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

   215

				}

   216

				break;

   217

		}

   218

	}

   219

   220

	virtual void OnClick(Point pt, int widget)

   221

	{

   222

		switch (widget) {

   223

			case 1:

   224

				this->ni->duration = 0;

   225

				delete this;

   226

				_forced_news = INVALID_NEWS;

   227

				break;

   228

   229

			case 0:

   230

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

   231

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

   232

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

   233

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

   234

					if (_ctrl_pressed) {

   235

						ShowExtraViewPortWindow(this->ni->data_a);

   236

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

   237

							ShowExtraViewPortWindow(this->ni->data_b);

   238

						}

   239

					} else {

   240

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

   241

							ScrollMainWindowToTile(this->ni->data_b);

   242

						}

   243

					}

   244

				}

   245

				break;

   246

		}

   247

	}

   248

   249

	virtual bool OnKeyPress(uint16 key, uint16 keycode)

   250

	{

   251

		if (keycode == WKC_SPACE) {

   252

			/* Don't continue. */

   253

			delete this;

   254

			return false;

   255

		}

   256

		return true;

   257

	}

   258

   259

	virtual void OnInvalidateData(int data)

   260

	{

   261

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

   262

		this->chat_height = data;

   263

	}

   264

   265

	virtual void OnTick()

   266

	{

   267

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

   268

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

   269

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

   270

   271

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

   272

   273

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

   274

		this->top = y;

   275

   276

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

   277

	}

   278

};

   279

   280

/**

   281

 * Return the correct index in the pseudo-fifo

   282

 * queue and deals with overflows when increasing the index

   283

 */

   284

static inline NewsID IncreaseIndex(NewsID i)

   285

{

   286

	assert(i != INVALID_NEWS);

   287

	return (i + 1) % _max_news_items;

   288

}

   289

   290

/**

   291

 * Return the correct index in the pseudo-fifo

   292

 * queue and deals with overflows when decreasing the index

   293

 */

   294

static inline NewsID DecreaseIndex(NewsID i)

   295

{

   296

	assert(i != INVALID_NEWS);

   297

	return (i + _max_news_items - 1) % _max_news_items;

   298

}

   299

   300

/**

   301

 * Add a new newsitem to be shown.

   302

 * @param string String to display

   303

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

   304

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

   305

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

   306

 *

   307

 * @see NewsSubype

   308

 */

   309

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

   310

{

   311

	if (_game_mode == GM_MENU) return;

   312

   313

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

   314

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

   315

		MoveToNextItem();

   316

	}

   317

   318

	if (_total_news < _max_news_items) _total_news++;

   319

   320

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

   321

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

   322

	 * DeleteVehicleNews */

   323

	NewsID l_news = _latest_news;

   324

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

   325

   326

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

   327

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

   328

		assert(_total_news == _max_news_items);

   329

		_oldest_news = IncreaseIndex(_oldest_news);

   330

	}

   331

   332

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

   333

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

   334

   335

	/* Add news to _latest_news */

   336

	NewsItem *ni = &_news_items[_latest_news];

   337

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

   338

   339

	ni->string_id = string;

   340

	ni->subtype = subtype;

   341

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

   342

   343

	/* show this news message in color? */

   344

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

   345

   346

	ni->data_a = data_a;

   347

	ni->data_b = data_b;

   348

	ni->date = _date;

   349

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

   350

   351

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   352

	if (w == NULL) return;

   353

	w->SetDirty();

   354

	w->vscroll.count = _total_news;

   355

}

   356

   357

   358

/**

   359

 * Per-NewsType data

   360

 */

   361

NewsTypeData _news_type_data[NT_END] = {

   362

	/* name,              age, sound,           display */

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

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

   371

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

   372

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

   373

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

   374

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

   375

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

   376

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

   377

};

   378

   379

   380

static const Widget _news_type13_widgets[] = {

   381

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

   382

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

   383

{   WIDGETS_END},

   384

};

   385

   386

static WindowDesc _news_type13_desc = {

   387

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

   388

	WC_NEWS_WINDOW, WC_NONE,

   389

	WDF_DEF_WIDGET,

   390

	_news_type13_widgets,

   391

	NULL

   392

};

   393

   394

static const Widget _news_type2_widgets[] = {

   395

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

   396

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

   397

{   WIDGETS_END},

   398

};

   399

   400

static WindowDesc _news_type2_desc = {

   401

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

   402

	WC_NEWS_WINDOW, WC_NONE,

   403

	WDF_DEF_WIDGET,

   404

	_news_type2_widgets,

   405

	NULL

   406

};

   407

   408

static const Widget _news_type0_widgets[] = {

   409

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

   410

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

   411

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

   412

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

   413

{   WIDGETS_END},

   414

};

   415

   416

static WindowDesc _news_type0_desc = {

   417

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

   418

	WC_NEWS_WINDOW, WC_NONE,

   419

	WDF_DEF_WIDGET,

   420

	_news_type0_widgets,

   421

	NULL

   422

};

   423

   424

   425

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

   426

static void ShowNewspaper(NewsItem *ni)

   427

{

   428

	ni->flags &= ~NF_FORCE_BIG;

   429

	ni->duration = 555;

   430

   431

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

   432

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

   433

   434

	int top = _screen.height;

   435

	Window *w;

   436

	switch (_news_subtype_data[ni->subtype].display_mode) {

   437

		case NM_NORMAL:

   438

		case NM_CALLBACK:

   439

			_news_type13_desc.top = top;

   440

			w = new NewsWindow(&_news_type13_desc, ni);

   441

			if (ni->flags & NF_VIEWPORT) {

   442

				InitializeWindowViewport(w, 2, 58, 426, 110,

   443

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   444

			}

   445

			break;

   446

   447

		case NM_THIN:

   448

			_news_type2_desc.top = top;

   449

			w = new NewsWindow(&_news_type2_desc, ni);

   450

			if (ni->flags & NF_VIEWPORT) {

   451

				InitializeWindowViewport(w, 2, 58, 426, 70,

   452

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   453

			}

   454

			break;

   455

   456

		default:

   457

			_news_type0_desc.top = top;

   458

			w = new NewsWindow(&_news_type0_desc, ni);

   459

			if (ni->flags & NF_VIEWPORT) {

   460

				InitializeWindowViewport(w, 3, 17, 274, 47,

   461

					ni->data_a | (ni->flags & NF_VEHICLE ? 0x80000000 : 0), ZOOM_LVL_NEWS);

   462

			}

   463

			break;

   464

	}

   465

   466

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

   467

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

   468

}

   469

   470

/** Show news item in the ticker */

   471

static void ShowTicker(const NewsItem *ni)

   472

{

   473

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   474

   475

	_statusbar_news_item = *ni;

   476

	InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);

   477

}

   478

   479

   480

/**

   481

 * Are we ready to show another news item?

   482

 * Only if nothing is in the newsticker and no newspaper is displayed

   483

 */

   484

static bool ReadyForNextItem()

   485

{