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

#include "map_func.h"

    20

    21

#include "table/sprites.h"

    22

#include "table/strings.h"

    23

    24

/** @file news_gui.cpp

    25

 *

    26

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

    27

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

    28

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

    29

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

    30

 * by the newest (\a _latest_news).

    31

 *

    32

 * \verbatim

    33

 * oldest                   current   lastest

    34

 *  |                          |         |

    35

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

    36

 *               |

    37

 *            forced

    38

 * \endverbatim

    39

 *

    40

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

    41

 *

    42

 * \verbatim

    43

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

    44

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

    45

 * (MAX_NEWS - O) + L news items

    46

 * \endverbatim

    47

 */

    48

    49

#define NB_WIDG_PER_SETTING 4

    50

    51

typedef byte NewsID;

    52

#define INVALID_NEWS 255

    53

    54

NewsItem _statusbar_news_item;

    55

bool _news_ticker_sound;

    56

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

    57

static uint _max_news_items = 0;            ///< size of 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 uint _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

	free(_news_items);

   102

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

   103

	_news_items = CallocT<NewsItem>(_max_news_items);

   104

	_current_news = INVALID_NEWS;

   105

	_oldest_news = 0;

   106

	_latest_news = INVALID_NEWS;

   107

	_forced_news = INVALID_NEWS;

   108

	_total_news = 0;

   109

}

   110

   111

void DrawNewsBorder(const Window *w)

   112

{

   113

	int left = 0;

   114

	int right = w->width - 1;

   115

	int top = 0;

   116

	int bottom = w->height - 1;

   117

   118

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

   119

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

}

   127

   128

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

   129

{

   130

	switch (e->event) {

   131

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

   132

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

   133

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

   134

		} break;

   135

   136

		case WE_PAINT: {

   137

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

   138

   139

			switch (ni->display_mode) {

   140

				case NM_NORMAL:

   141

				case NM_THIN: {

   142

					DrawNewsBorder(w);

   143

   144

					DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   145

   146

					SetDParam(0, ni->date);

   147

					DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   148

   149

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

   150

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

   151

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

   152

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

   153

					} else {

   154

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

   155

						TransparencyOptionBits to_backup = _transparency_opt;

   156

						_transparency_opt = 0;

   157

						DrawWindowViewport(w);

   158

						_transparency_opt = to_backup;

   159

   160

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

   161

						ViewPort *vp = w->viewport;

   162

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

   163

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

   164

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

   165

						);

   166

   167

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

   168

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

   169

					}

   170

					break;

   171

				}

   172

   173

				case NM_CALLBACK:

   174

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

   175

					break;

   176

   177

				default:

   178

					DrawWindowWidgets(w);

   179

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

   180

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

   181

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

   182

					} else {

   183

						DrawWindowViewport(w);

   184

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

   185

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

   186

					}

   187

					break;

   188

			}

   189

		} break;

   190

   191

		case WE_CLICK: {

   192

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

   193

			case 1: {

   194

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

   195

				DeleteWindow(w);

   196

				ni->duration = 0;

   197

				_forced_news = INVALID_NEWS;

   198

			} break;

   199

			case 0: {

   200

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

   201

				if (ni->flags & NF_VEHICLE) {

   202

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

   203

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

   204

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

   205

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

   206

						ScrollMainWindowToTile(ni->data_b);

   207

				}

   208

			} break;

   209

			}

   210

		} break;

   211

   212

		case WE_KEYPRESS:

   213

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

   214

				/* Don't continue. */

   215

				e->we.keypress.cont = false;

   216

				DeleteWindow(w);

   217

			}

   218

			break;

   219

   220

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

   221

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

   222

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

   223

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

   224

			}

   225

			break;

   226

   227

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

   228

			int diff;

   229

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

   230

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

   231

   232

			if (w->viewport != NULL)

   233

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

   234

   235

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

   236

			w->top = y;

   237

   238

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

   239

		} break;

   240

	}

   241

}

   242

   243

/**

   244

 * Return the correct index in the pseudo-fifo

   245

 * queue and deals with overflows when increasing the index

   246

 */

   247

static inline NewsID IncreaseIndex(NewsID i)

   248

{

   249

	assert(i != INVALID_NEWS);

   250

	return (i + 1) % _max_news_items;

   251

}

   252

   253

/**

   254

 * Return the correct index in the pseudo-fifo

   255

 * queue and deals with overflows when decreasing the index

   256

 */

   257

static inline NewsID DecreaseIndex(NewsID i)

   258

{

   259

	assert(i != INVALID_NEWS);

   260

	return (i + _max_news_items - 1) % _max_news_items;

   261

}

   262

   263

/**

   264

 * Add a new newsitem to be shown.

   265

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

   266

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

   267

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

   268

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

   269

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

   270

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

   271

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

   272

 *

   273

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

   274

 * \a string has a special meaning.

   275

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

   276

 *    the index of the engine that is shown

   277

 *

   278

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

   279

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

   280

 *    @see NewsBankrupcy

   281

 *

   282

 * @see NewsMode

   283

 * @see NewsFlag

   284

 * @see NewsType

   285

 * @see NewsCallback

   286

 */

   287

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

   288

{

   289

	if (_game_mode == GM_MENU) return;

   290

   291

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

   292

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

   293

		MoveToNextItem();

   294

	}

   295

   296

	if (_total_news < _max_news_items) _total_news++;

   297

   298

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

   299

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

   300

	 * DeleteVehicleNews */

   301

	NewsID l_news = _latest_news;

   302

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

   303

   304

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

   305

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

   306

		assert(_total_news == _max_news_items);

   307

		_oldest_news = IncreaseIndex(_oldest_news);

   308

	}

   309

   310

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

   311

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

   312

   313

	/* Add news to _latest_news */

   314

	NewsItem *ni = &_news_items[_latest_news];

   315

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

   316

   317

	ni->string_id = string;

   318

	ni->display_mode = display_mode;

   319

	ni->flags = flags;

   320

   321

	/* show this news message in color? */

   322

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

   323

   324

	ni->type = type;

   325

	ni->callback = callback;

   326

	ni->data_a = data_a;

   327

	ni->data_b = data_b;

   328

	ni->date = _date;

   329

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

   330

   331

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   332

	if (w == NULL) return;

   333

	SetWindowDirty(w);

   334

	w->vscroll.count = _total_news;

   335

}

   336

   337

   338

/**

   339

 * Per-NewsType data

   340

 */

   341

NewsTypeData _news_type_data[NT_END] = {

   342

	/* name,              age, sound,           display */

   343

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

   344

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

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

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

   355

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

   356

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

   357

};

   358

   359

   360

static const Widget _news_type13_widgets[] = {

   361

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

   362

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

   363

{   WIDGETS_END},

   364

};

   365

   366

static WindowDesc _news_type13_desc = {

   367

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

   368

	WC_NEWS_WINDOW, WC_NONE,

   369

	WDF_DEF_WIDGET,

   370

	_news_type13_widgets,

   371

	NewsWindowProc

   372

};

   373

   374

static const Widget _news_type2_widgets[] = {

   375

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

   376

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

   377

{   WIDGETS_END},

   378

};

   379

   380

static WindowDesc _news_type2_desc = {

   381

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

   382

	WC_NEWS_WINDOW, WC_NONE,

   383

	WDF_DEF_WIDGET,

   384

	_news_type2_widgets,

   385

	NewsWindowProc

   386

};

   387

   388

static const Widget _news_type0_widgets[] = {

   389

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

   390

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

   391

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

   392

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

   393

{   WIDGETS_END},

   394

};

   395

   396

static WindowDesc _news_type0_desc = {

   397

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

   398

	WC_NEWS_WINDOW, WC_NONE,

   399

	WDF_DEF_WIDGET,

   400

	_news_type0_widgets,

   401

	NewsWindowProc

   402

};

   403

   404

   405

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

   406

static void ShowNewspaper(NewsItem *ni)

   407

{

   408

	ni->flags &= ~NF_FORCE_BIG;

   409

	ni->duration = 555;

   410

   411

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

   412

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

   413

   414

	int top = _screen.height;

   415

	Window *w;

   416

	switch (ni->display_mode) {

   417

		case NM_NORMAL:

   418

		case NM_CALLBACK:

   419

			_news_type13_desc.top = top;

   420

			w = AllocateWindowDesc(&_news_type13_desc);

   421

			if (ni->flags & NF_VIEWPORT) {

   422

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

   423

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

   424

			}

   425

			break;

   426

   427

		case NM_THIN:

   428

			_news_type2_desc.top = top;

   429

			w = AllocateWindowDesc(&_news_type2_desc);

   430

			if (ni->flags & NF_VIEWPORT) {

   431

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

   432

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

   433

			}

   434

			break;

   435

   436

		default:

   437

			_news_type0_desc.top = top;

   438

			w = AllocateWindowDesc(&_news_type0_desc);

   439

			if (ni->flags & NF_VIEWPORT) {

   440

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

   441

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

   442

			}

   443

			break;

   444

	}

   445

   446

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

   447

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

   448

   449

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

   450

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   451

}

   452

   453

/** Show news item in the ticker */

   454

static void ShowTicker(const NewsItem *ni)

   455

{

   456

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   457

   458

	_statusbar_news_item = *ni;

   459

	Window *w = FindWindowById(WC_STATUS_BAR, 0);

   460

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

   461

}

   462

   463

   464

/**

   465

 * Are we ready to show another news item?

   466

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

   467

 */

   468

static bool ReadyForNextItem()

   469

{

   470

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

   471

   472

	if (item >= _max_news_items) return true;

   473

	NewsItem *ni = &_news_items[item];

   474

   475

	/* Ticker message

   476

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

   477

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

   478

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

   479

   480

	/* Newspaper message, decrement duration counter */

   481

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

   482

   483

	/* neither newsticker nor newspaper are running */

   484

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

   485

}

   486