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

    22

#include "table/sprites.h"

    23

#include "table/strings.h"

    24

    25

/** @file news_gui.cpp

    26

 *

    27

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

    28

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

    29

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

    30

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

    31

 * by the newest (\a _latest_news).

    32

 *

    33

 * \verbatim

    34

 * oldest                   current   lastest

    35

 *  |                          |         |

    36

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

    37

 *               |

    38

 *            forced

    39

 * \endverbatim

    40

 *

    41

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

    42

 *

    43

 * \verbatim

    44

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

    45

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

    46

 * (MAX_NEWS - O) + L news items

    47

 * \endverbatim

    48

 */

    49

    50

#define NB_WIDG_PER_SETTING 4

    51

    52

typedef byte NewsID;

    53

#define INVALID_NEWS 255

    54

    55

NewsItem _statusbar_news_item;

    56

bool _news_ticker_sound;

    57

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

    58

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

    59

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

    60

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

    61

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

    62

    63

struct news_d : vp_d {

    64

	uint16 follow_vehicle;

    66

	int32 scrollpos_x;

    67

	int32 scrollpos_y;

    68

	int32 dest_scrollpos_x;

    69

	int32 dest_scrollpos_y;

    70

	NewsItem *ni;

    71

};

    72

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(news_d));

    73

    74

/** Forced news item.

    75

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

    76

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

    77

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

    78

static NewsID _forced_news = INVALID_NEWS;

    79

    80

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

    81

    82

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

    83

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

    84

static void MoveToNextItem();

    85

    86

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    87

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    88

    89

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    90

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    91

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    92

};

    93

    94

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    95

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    96

	GetNewsStringNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    97

	GetNewsStringBankrupcy,        ///< DNC_BANKRUPCY

    98

};

    99

   100

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

   101

void InitNewsItemStructs()

   102

{

   103

	free(_news_items);

   104

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

   105

	_news_items = CallocT<NewsItem>(_max_news_items);

   106

	_current_news = INVALID_NEWS;

   107

	_oldest_news = 0;

   108

	_latest_news = INVALID_NEWS;

   109

	_forced_news = INVALID_NEWS;

   110

	_total_news = 0;

   111

}

   112

   113

void DrawNewsBorder(const Window *w)

   114

{

   115

	int left = 0;

   116

	int right = w->width - 1;

   117

	int top = 0;

   118

	int bottom = w->height - 1;

   119

   120

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

   121

   122

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

   123

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

   124

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

   125

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

   126

   127

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

   128

}

   129

   130

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

   131

{

   132

	switch (e->event) {

   133

		case WE_CREATE: { // If chatbar is open at creation time, we need to go above it

   134

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

   136

			break;

   137

		}

   138

   139

		case WE_PAINT: {

   140

			const NewsItem *ni = WP(w, news_d).ni;

   141

   142

			switch (ni->display_mode) {

   143

				case NM_NORMAL:

   144

				case NM_THIN: {

   145

					DrawNewsBorder(w);

   146

   147

					DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   148

   149

					SetDParam(0, ni->date);

   150

					DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   151

   152

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

   153

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

   154

						DrawStringMultiCenter(215, ni->display_mode == NM_NORMAL ? 76 : 56,

   155

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

   156

					} else {

   157

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

   158

						TransparencyOptionBits to_backup = _transparency_opt;

   159

						_transparency_opt = 0;

   160

						DrawWindowViewport(w);

   161

						_transparency_opt = to_backup;

   162

   163

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

   164

						ViewPort *vp = w->viewport;

   165

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

   166

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

   167

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

   168

						);

   169

   170

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

   171

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

   172

					}

   173

					break;

   174

				}

   175

   176

				case NM_CALLBACK:

   177

					_draw_news_callback[ni->callback](w, ni);

   178

					break;

   179

   180

				default:

   181

					DrawWindowWidgets(w);

   182

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

   183

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

   184

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

   185

					} else {

   186

						DrawWindowViewport(w);

   187

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

   188

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

   189

					}

   190

					break;

   191

			}

   192

			break;

   193

		}

   194

   195

		case WE_CLICK:

   196

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

   197

				case 1: {

   198

					NewsItem *ni = WP(w, news_d).ni;

   199

					delete w;

   200

					ni->duration = 0;

   201

					_forced_news = INVALID_NEWS;

   202

					break;

   203

				}

   204

   205

				case 0: {

   206

					NewsItem *ni = WP(w, news_d).ni;

   207

					if (ni->flags & NF_VEHICLE) {

   208

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

   209

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

   210

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

   211

						if (_ctrl_pressed) {

   212

							ShowExtraViewPortWindow(ni->data_a);

   213

							if (ni->flags & NF_TILE2) {

   214

								ShowExtraViewPortWindow(ni->data_b);

   215

							}

   216

						} else {

   217

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

   218

								ScrollMainWindowToTile(ni->data_b);

   219

							}

   220

						}

   221

					}

   222

					break;

   223

				}

   224

			}

   225

			break;

   226

   227

		case WE_KEYPRESS:

   228

			if (e->we.keypress.keycode == WKC_SPACE) {

   229

				/* Don't continue. */

   230

				e->we.keypress.cont = false;

   231

				delete w;

   232

			}

   233

			break;

   234

   237

			break;

   238

   239

		case WE_TICK: { // Scroll up newsmessages from the bottom in steps of 4 pixels

   241

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

   242

   243

			if (w->viewport != NULL) {

   244

				w->viewport->top += y - w->top;

   245

			}

   246

   247

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

   248

			w->top = y;

   249

   250

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

   251

			break;

   252

		}

   253

	}

   254

}

   255

   256

/**

   257

 * Return the correct index in the pseudo-fifo

   258

 * queue and deals with overflows when increasing the index

   259

 */

   260

static inline NewsID IncreaseIndex(NewsID i)

   261

{

   262

	assert(i != INVALID_NEWS);

   263

	return (i + 1) % _max_news_items;

   264

}

   265

   266

/**

   267

 * Return the correct index in the pseudo-fifo

   268

 * queue and deals with overflows when decreasing the index

   269

 */

   270

static inline NewsID DecreaseIndex(NewsID i)

   271

{

   272

	assert(i != INVALID_NEWS);

   273

	return (i + _max_news_items - 1) % _max_news_items;

   274

}

   275

   276

/**

   277

 * Add a new newsitem to be shown.

   278

 * @param string String to display, can have special values based on parameter \a display_mode

   279

 * @param display_mode, any of the NewsMode enums (NM_)

   280

 * @param flags any of the NewsFlag enums (NF_)

   281

 * @param type news category, any of the NewsType enums (NT_)

   282

 * @param callback news callback function, any of the NewsCallback enums (DNC_)

   283

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

   284

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

   285

 *

   286

 * @note If the display mode is NM_CALLBACK, special news is shown and parameter

   287

 * \a string has a special meaning.

   288

 *  - For DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL messages: StringID is

   289

 *    the index of the engine that is shown

   290

 *

   291

 *  - For DNC_BANKRUPCY: bytes 0-3 of StringID contains the player that is in trouble,

   292

 *    and 4-7 contains what kind of bankrupcy message is shown.

   293

 *    @see NewsBankrupcy

   294

 *

   295

 * @see NewsMode

   296

 * @see NewsFlag

   297

 * @see NewsType

   298

 * @see NewsCallback

   299

 */

   300

void AddNewsItem(StringID string, NewsMode display_mode, NewsFlag flags, NewsType type, NewsCallback callback, uint data_a, uint data_b)

   301

{

   302

	if (_game_mode == GM_MENU) return;

   303

   304

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

   305

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

   306

		MoveToNextItem();

   307

	}

   308

   309

	if (_total_news < _max_news_items) _total_news++;

   310

   311

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

   312

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

   313

	 * DeleteVehicleNews */

   314

	NewsID l_news = _latest_news;

   315

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

   316

   317

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

   318

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

   319

		assert(_total_news == _max_news_items);

   320

		_oldest_news = IncreaseIndex(_oldest_news);

   321

	}

   322

   323

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

   324

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

   325

   326

	/* Add news to _latest_news */

   327

	NewsItem *ni = &_news_items[_latest_news];

   328

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

   329

   330

	ni->string_id = string;

   331

	ni->display_mode = display_mode;

   332

	ni->flags = flags;

   333

   334

	/* show this news message in color? */

   335

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

   336

   337

	ni->type = type;

   338

	ni->callback = callback;

   339

	ni->data_a = data_a;

   340

	ni->data_b = data_b;

   341

	ni->date = _date;

   342

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

   343

   344

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   345

	if (w == NULL) return;

   346

	w->SetDirty();

   347

	w->vscroll.count = _total_news;

   348

}

   349

   350

   351

/**

   352

 * Per-NewsType data

   353

 */

   354

NewsTypeData _news_type_data[NT_END] = {

   355

	/* name,              age, sound,           display */

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

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

   370

};

   371

   372

   373

static const Widget _news_type13_widgets[] = {

   374

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

   375

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

   376

{   WIDGETS_END},

   377

};

   378

   379

static WindowDesc _news_type13_desc = {

   380

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

   381

	WC_NEWS_WINDOW, WC_NONE,

   382

	WDF_DEF_WIDGET,

   383

	_news_type13_widgets,

   384

	NewsWindowProc

   385

};

   386

   387

static const Widget _news_type2_widgets[] = {

   388

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

   389

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

   390

{   WIDGETS_END},

   391

};

   392

   393

static WindowDesc _news_type2_desc = {

   394

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

   395

	WC_NEWS_WINDOW, WC_NONE,

   396

	WDF_DEF_WIDGET,

   397

	_news_type2_widgets,

   398

	NewsWindowProc

   399

};

   400

   401

static const Widget _news_type0_widgets[] = {

   402

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

   403

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

   404

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

   405

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

   406

{   WIDGETS_END},

   407

};

   408

   409

static WindowDesc _news_type0_desc = {

   410

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

   411

	WC_NEWS_WINDOW, WC_NONE,

   412

	WDF_DEF_WIDGET,

   413

	_news_type0_widgets,

   414

	NewsWindowProc

   415

};

   416

   417

   418

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

   419

static void ShowNewspaper(NewsItem *ni)

   420

{

   421

	ni->flags &= ~NF_FORCE_BIG;

   422

	ni->duration = 555;

   423

   424

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

   425

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

   426

   427

	int top = _screen.height;

   428

	Window *w;

   429

	switch (ni->display_mode) {

   430

		case NM_NORMAL:

   431

		case NM_CALLBACK:

   432

			_news_type13_desc.top = top;

   433

			w = new Window(&_news_type13_desc);

   434

			if (ni->flags & NF_VIEWPORT) {

   435

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

   436

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

   437

			}

   438

			break;

   439

   440

		case NM_THIN:

   441

			_news_type2_desc.top = top;

   442

			w = new Window(&_news_type2_desc);

   443

			if (ni->flags & NF_VIEWPORT) {

   444

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

   445

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

   446

			}

   447

			break;

   448

   449

		default:

   450

			_news_type0_desc.top = top;

   451

			w = new Window(&_news_type0_desc);

   452

			if (ni->flags & NF_VIEWPORT) {

   453

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

   454

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

   455

			}

   456

			break;

   457

	}

   458

   459

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

   460

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

   461

   462

	WP(w, news_d).ni = &_news_items[_forced_news == INVALID_NEWS ? _current_news : _forced_news];

   463

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   464

}

   465

   466

/** Show news item in the ticker */

   467

static void ShowTicker(const NewsItem *ni)

   468

{

   469

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   470

   471

	_statusbar_news_item = *ni;

   472

	Window *w = FindWindowById(WC_STATUS_BAR, 0);

   473

	if (w != NULL) WP(w, def_d).data_1 = 360;

   474

}

   475

   476

   477

/**

   478

 * Are we ready to show another news item?

   479

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

   480

 */

   481

static bool ReadyForNextItem()

   482

{

   483

	NewsID item = (_forced_news == INVALID_NEWS) ? _current_news : _forced_news;

   484