1

/* $Id$ */

     2

     3

     4

#include "stdafx.h"

     5

#include "openttd.h"

     6

#include "gui.h"

     7

#include "window_gui.h"

     8

#include "viewport_func.h"

     9

#include "news_func.h"

    10

#include "settings_type.h"

    11

#include "transparency.h"

    12

#include "strings_func.h"

    13

#include "window_func.h"

    14

#include "date_func.h"

    15

#include "vehicle_base.h"

    16

#include "sound_func.h"

    17

#include "string_func.h"

    18

#include "widgets/dropdown_func.h"

    19

    20

#include "table/sprites.h"

    21

#include "table/strings.h"

    22

    23

/** @file news_gui.cpp

    24

 *

    25

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

    26

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

    27

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

    28

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

    29

 * by the newest (\a _latest_news).

    30

 *

    31

 * \verbatim

    32

 * oldest                   current   lastest

    33

 *  |                          |         |

    34

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

    35

 *               |

    36

 *            forced

    37

 * \endverbatim

    38

 *

    39

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

    40

 *

    41

 * \verbatim

    42

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

    43

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

    44

 * (MAX_NEWS - O) + L news items

    45

 * \endverbatim

    46

 */

    47

    48

/** Number of news items in the FIFO queue */

    49

#define MAX_NEWS 30

    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[MAX_NEWS];      ///< The news FIFO queue

    58

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

    59

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

    60

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

    61

    62

struct news_d : vp_d {

    63

	uint16 follow_vehicle;

    64

	int32 scrollpos_x;

    65

	int32 scrollpos_y;

    66

	int32 dest_scrollpos_x;

    67

	int32 dest_scrollpos_y;

    68

	NewsItem *ni;

    69

};

    70

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(news_d));

    71

    72

/** Forced news item.

    73

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

    74

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

    75

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

    76

static NewsID _forced_news = INVALID_NEWS;

    77

    78

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

    79

    80

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

    81

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

    82

static void MoveToNextItem();

    83

    84

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    85

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    86

    87

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    88

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    89

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    90

};

    91

    92

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    93

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    94

	GetNewsStringNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    95

	GetNewsStringBankrupcy,        ///< DNC_BANKRUPCY

    96

};

    97

    98

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

    99

void InitNewsItemStructs()

   100

{

   101

	memset(_news_items, 0, sizeof(_news_items));

   102

	_current_news = INVALID_NEWS;

   103

	_oldest_news = 0;

   104

	_latest_news = INVALID_NEWS;

   105

	_forced_news = INVALID_NEWS;

   106

	_total_news = 0;

   107

}

   108

   109

void DrawNewsBorder(const Window *w)

   110

{

   111

	int left = 0;

   112

	int right = w->width - 1;

   113

	int top = 0;

   114

	int bottom = w->height - 1;

   115

   116

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

   117

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

}

   125

   126

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

   127

{

   128

	switch (e->event) {

   129

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

   130

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

   131

			w->message.msg = (w1 != NULL) ? w1->height : 0;

   132

		} break;

   133

   134

		case WE_PAINT: {

   135

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

   136

   137

			switch (ni->display_mode) {

   138

				case NM_NORMAL:

   139

				case NM_THIN: {

   140

					DrawNewsBorder(w);

   141

   142

					DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   143

   144

					SetDParam(0, ni->date);

   145

					DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   146

   147

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

   148

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

   149

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

   150

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

   151

					} else {

   152

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

   153

						TransparencyOptionBits to_backup = _transparency_opt;

   154

						_transparency_opt = 0;

   155

						DrawWindowViewport(w);

   156

						_transparency_opt = to_backup;

   157

   158

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

   159

						ViewPort *vp = w->viewport;

   160

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

   161

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

   162

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

   163

						);

   164

   165

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

   166

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

   167

					}

   168

					break;

   169

				}

   170

   171

				case NM_CALLBACK:

   172

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

   173

					break;

   174

   175

				default:

   176

					DrawWindowWidgets(w);

   177

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

   178

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

   179

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

   180

					} else {

   181

						DrawWindowViewport(w);

   182

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

   183

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

   184

					}

   185

					break;

   186

			}

   187

		} break;

   188

   189

		case WE_CLICK: {

   190

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

   191

			case 1: {

   192

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

   193

				DeleteWindow(w);

   194

				ni->duration = 0;

   195

				_forced_news = INVALID_NEWS;

   196

			} break;

   197

			case 0: {

   198

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

   199

				if (ni->flags & NF_VEHICLE) {

   200

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

   201

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

   202

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

   203

					if (!ScrollMainWindowToTile(ni->data_a) && ni->data_b != 0)

   204

						ScrollMainWindowToTile(ni->data_b);

   205

				}

   206

			} break;

   207

			}

   208

		} break;

   209

   210

		case WE_KEYPRESS:

   211

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

   212

				/* Don't continue. */

   213

				e->we.keypress.cont = false;

   214

				DeleteWindow(w);

   215

			}

   216

			break;

   217

   218

		case WE_MESSAGE: // The chatbar has notified us that is was either created or closed

   219

			switch (e->we.message.msg) {

   220

				case WE_CREATE: w->message.msg = e->we.message.wparam; break;

   221

				case WE_DESTROY: w->message.msg = 0; break;

   222

			}

   223

			break;

   224

   225

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

   226

			int diff;

   227

			int y = max(w->top - 4, _screen.height - w->height - 12 - w->message.msg);

   228

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

   229

   230

			if (w->viewport != NULL)

   231

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

   232

   233

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

   234

			w->top = y;

   235

   236

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

   237

		} break;

   238

	}

   239

}

   240

   241

/**

   242

 * Return the correct index in the pseudo-fifo

   243

 * queue and deals with overflows when increasing the index

   244

 */

   245

static inline NewsID IncreaseIndex(NewsID i)

   246

{

   247

	assert(i != INVALID_NEWS);

   248

	return (i + 1) % MAX_NEWS;

   249

}

   250

   251

/**

   252

 * Return the correct index in the pseudo-fifo

   253

 * queue and deals with overflows when decreasing the index

   254

 */

   255

static inline NewsID DecreaseIndex(NewsID i)

   256

{

   257

	assert(i != INVALID_NEWS);

   258

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   259

}

   260

   261

/**

   262

 * Add a new newsitem to be shown.

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

 *

   271

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

   272

 * \a string has a special meaning.

   273

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

   274

 *    the index of the engine that is shown

   275

 *

   276

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

   277

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

   278

 *    @see NewsBankrupcy

   279

 *

   280

 * @see NewsMode

   281

 * @see NewsFlag

   282

 * @see NewsType

   283

 * @see NewsCallback

   284

 */

   285

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

   286

{

   287

	if (_game_mode == GM_MENU) return;

   288

   289

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

   290

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

   291

		MoveToNextItem();

   292

	}

   293

   294

	if (_total_news < MAX_NEWS) _total_news++;

   295

   296

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

   297

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

   298

	 * DeleteVehicleNews */

   299

	NewsID l_news = _latest_news;

   300

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

   301

   302

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

   303

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

   304

		assert(_total_news == MAX_NEWS);

   305

		_oldest_news = IncreaseIndex(_oldest_news);

   306

	}

   307

   308

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

   309

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

   310

   311

	/* Add news to _latest_news */

   312

	NewsItem *ni = &_news_items[_latest_news];

   313

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

   314

   315

	ni->string_id = string;

   316

	ni->display_mode = display_mode;

   317

	ni->flags = flags;

   318

   319

	/* show this news message in color? */

   320

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

   321

   322

	ni->type = type;

   323

	ni->callback = callback;

   324

	ni->data_a = data_a;

   325

	ni->data_b = data_b;

   326

	ni->date = _date;

   327

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

   328

   329

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   330

	if (w == NULL) return;

   331

	SetWindowDirty(w);

   332

	w->vscroll.count = _total_news;

   333

}

   334

   335

   336

/**

   337

 * Per-NewsType data

   338

 */

   339

NewsTypeData _news_type_data[NT_END] = {

   340

	/* name,              age, sound,           display */

   341

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

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

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

   355

};

   356

   357

   358

static const Widget _news_type13_widgets[] = {

   359

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

   360

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

   361

{   WIDGETS_END},

   362

};

   363

   364

static WindowDesc _news_type13_desc = {

   365

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

   366

	WC_NEWS_WINDOW, WC_NONE,

   367

	WDF_DEF_WIDGET,

   368

	_news_type13_widgets,

   369

	NewsWindowProc

   370

};

   371

   372

static const Widget _news_type2_widgets[] = {

   373

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

   374

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

   375

{   WIDGETS_END},

   376

};

   377

   378

static WindowDesc _news_type2_desc = {

   379

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

   380

	WC_NEWS_WINDOW, WC_NONE,

   381

	WDF_DEF_WIDGET,

   382

	_news_type2_widgets,

   383

	NewsWindowProc

   384

};

   385

   386

static const Widget _news_type0_widgets[] = {

   387

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

   388

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

   389

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

   390

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

   391

{   WIDGETS_END},

   392

};

   393

   394

static WindowDesc _news_type0_desc = {

   395

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

   396

	WC_NEWS_WINDOW, WC_NONE,

   397

	WDF_DEF_WIDGET,

   398

	_news_type0_widgets,

   399

	NewsWindowProc

   400

};

   401

   402

   403

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

   404

static void ShowNewspaper(NewsItem *ni)

   405

{

   406

	ni->flags &= ~NF_FORCE_BIG;

   407

	ni->duration = 555;

   408

   409

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

   410

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

   411

   412

	int top = _screen.height;

   413

	Window *w;

   414

	switch (ni->display_mode) {

   415

		case NM_NORMAL:

   416

		case NM_CALLBACK:

   417

			_news_type13_desc.top = top;

   418

			w = AllocateWindowDesc(&_news_type13_desc);

   419

			if (ni->flags & NF_VIEWPORT) {

   420

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

   421

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

   422

			}

   423

			break;

   424

   425

		case NM_THIN:

   426

			_news_type2_desc.top = top;

   427

			w = AllocateWindowDesc(&_news_type2_desc);

   428

			if (ni->flags & NF_VIEWPORT) {

   429

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

   430

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

   431

			}

   432

			break;

   433

   434

		default:

   435

			_news_type0_desc.top = top;

   436

			w = AllocateWindowDesc(&_news_type0_desc);

   437

			if (ni->flags & NF_VIEWPORT) {

   438

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

   439

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

   440

			}

   441

			break;

   442

	}

   443

   444

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

   445

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

   446

   447

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

   448

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   449

}

   450

   451

/** Show news item in the ticker */

   452

static void ShowTicker(const NewsItem *ni)

   453

{

   454

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   455

   456

	_statusbar_news_item = *ni;

   457

	Window *w = FindWindowById(WC_STATUS_BAR, 0);

   458

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

   459

}

   460

   461

   462

/**

   463

 * Are we ready to show another news item?

   464

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

   465

 */

   466

static bool ReadyForNextItem()

   467

{

   468

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

   469

   470

	if (item >= MAX_NEWS) return true;

   471

	NewsItem *ni = &_news_items[item];

   472

   473

	/* Ticker message

   474

	 * Check if the status bar message is still being displayed? */

   475

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

   476

	if (w != NULL && WP(w, const def_d).data_1 > -1280) return false;

   477

   478

	/* Newspaper message, decrement duration counter */

   479

	if (ni->duration != 0) ni->duration--;

   480

   481

	/* neither newsticker nor newspaper are running */

   482

	return (ni->duration == 0 || FindWindowById(WC_NEWS_WINDOW, 0) == NULL);

   483

}

   484

   485

/** Move to the next news item */

   486

static void MoveToNextItem()

   487