1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "strings.h"

     7

#include "table/sprites.h"

     8

#include "table/strings.h"

     9

#include "window.h"

    10

#include "gui.h"

    11

#include "viewport.h"

    12

#include "gfx.h"

    13

#include "news.h"

    14

#include "vehicle.h"

    15

#include "sound.h"

    16

#include "variables.h"

    17

#include "date.h"

    18

    19

/* News system

    20

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

    21

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

    22

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

    23

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

    24

 * by the newest (_latest news).

    25

 *

    26

 * oldest                   current   lastest

    27

 *  |                          |         |

    28

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

    29

 *               |

    30

 *            forced

    31

 */

    32

    33

#define MAX_NEWS 30

    34

    35

#define INVALID_NEWS 255

    36

    37

static NewsItem _news_items[MAX_NEWS];

    38

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

    39

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

    40

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

    41

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

    42

 * _forced_news. forced_news is INVALID_NEWS otherwise.

    43

 * (Users can force messages through history or "last message") */

    44

static byte _forced_news = INVALID_NEWS;

    45

    46

static byte _total_news = 0; // total news count

    47

    48

void DrawNewsNewTrainAvail(Window *w);

    49

void DrawNewsNewRoadVehAvail(Window *w);

    50

void DrawNewsNewShipAvail(Window *w);

    51

void DrawNewsNewAircraftAvail(Window *w);

    52

void DrawNewsBankrupcy(Window *w);

    53

static void MoveToNexItem(void);

    54

    55

StringID GetNewsStringNewTrainAvail(const NewsItem *ni);

    56

StringID GetNewsStringNewRoadVehAvail(const NewsItem *ni);

    57

StringID GetNewsStringNewShipAvail(const NewsItem *ni);

    58

StringID GetNewsStringNewAircraftAvail(const NewsItem *ni);

    59

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    60

    61

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    62

	DrawNewsNewTrainAvail,    /* DNC_TRAINAVAIL */

    63

	DrawNewsNewRoadVehAvail,  /* DNC_ROADAVAIL */

    64

	DrawNewsNewShipAvail,     /* DNC_SHIPAVAIL */

    65

	DrawNewsNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    66

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    67

};

    68

    69

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    70

	GetNewsStringNewTrainAvail,    /* DNC_TRAINAVAIL */

    71

	GetNewsStringNewRoadVehAvail,  /* DNC_ROADAVAIL */

    72

	GetNewsStringNewShipAvail,     /* DNC_SHIPAVAIL */

    73

	GetNewsStringNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    74

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    75

};

    76

    77

void InitNewsItemStructs(void)

    78

{

    79

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

    80

	_current_news = INVALID_NEWS;

    81

	_oldest_news = 0;

    82

	_latest_news = INVALID_NEWS;

    83

	_forced_news = INVALID_NEWS;

    84

	_total_news = 0;

    85

}

    86

    87

void DrawNewsBorder(const Window *w)

    88

{

    89

	int left = 0;

    90

	int right = w->width - 1;

    91

	int top = 0;

    92

	int bottom = w->height - 1;

    93

    94

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

    95

    96

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

    97

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

    98

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

    99

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

   100

   101

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

   102

}

   103

   104

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

   105

{

   106

	switch (e->event) {

   107

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

   108

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

   109

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

   110

	} break;

   111

   112

	case WE_PAINT: {

   113

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

   114

		ViewPort *vp;

   115

   116

		switch (ni->display_mode) {

   117

			case NM_NORMAL:

   118

			case NM_THIN: {

   119

				DrawNewsBorder(w);

   120

   121

				DrawString(2, 1, STR_00C6, 0);

   122

   123

				SetDParam(0, ni->date);

   124

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   125

   126

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

   127

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

   128

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

   129

						ni->string_id, 426);

   130

				} else {

   131

					byte bk = _display_opt;

   132

					_display_opt &= ~DO_TRANS_BUILDINGS;

   133

					DrawWindowViewport(w);

   134

					_display_opt = bk;

   135

   136

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

   137

					vp = w->viewport;

   138

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

   139

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

   140

						(ni->flags & NF_INCOLOR ? 0x322 : 0x323) | USE_COLORTABLE

   141

					);

   142

   143

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

   144

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

   145

				}

   146

				break;

   147

			}

   148

   149

			case NM_CALLBACK: {

   150

				_draw_news_callback[ni->callback](w);

   151

				break;

   152

			}

   153

   154

			default: {

   155

				DrawWindowWidgets(w);

   156

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

   157

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

   158

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

   159

				} else {

   160

					DrawWindowViewport(w);

   161

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

   162

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

   163

				}

   164

				break;

   165

			}

   166

		}

   167

	} break;

   168

   169

	case WE_CLICK: {

   170

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

   171

		case 1: {

   172

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

   173

			DeleteWindow(w);

   174

			ni->duration = 0;

   175

			_forced_news = INVALID_NEWS;

   176

		} break;

   177

		case 0: {

   178

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

   179

			if (ni->flags & NF_VEHICLE) {

   180

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

   181

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

   182

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

   183

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

   184

					ScrollMainWindowToTile(ni->data_b);

   185

			}

   186

		} break;

   187

		}

   188

	} break;

   189

   190

	case WE_KEYPRESS:

   191

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

   192

			// Don't continue.

   193

			e->we.keypress.cont = false;

   194

			DeleteWindow(w);

   195

		}

   196

		break;

   197

   198

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

   199

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

   200

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

   201

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

   202

		}

   203

		break;

   204

   205

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

   206

		int diff;

   207

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

   208

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

   209

   210

		if (w->viewport != NULL)

   211

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

   212

   213

		diff = abs(w->top - y);

   214

		w->top = y;

   215

   216

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

   217

	} break;

   218

	}

   219

}

   220

   221

// returns the correct index in the array

   222

// (to deal with overflows)

   223

static byte increaseIndex(byte i)

   224

{

   225

	if (i == INVALID_NEWS) return 0;

   226

	i++;

   227

	if (i >= MAX_NEWS) i = i % MAX_NEWS;

   228

	return i;

   229

}

   230

   231

/** Add a new newsitem to be shown.

   232

 * @param string String to display, can have special values based on parameter 'flags'

   233

 * @param flags various control bits that will show various news-types. See macro NEWS_FLAGS()

   234

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

   235

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

   236

 * @note flags exists of 4 byte-sized extra parameters.<br/>

   237

 * 1.  0 -  7 display_mode, any of the NewsMode enums (NM_)<br/>

   238

 * 2.  8 - 15 news flags, any of the NewsFlags enums (NF_) NF_INCOLOR are set automatically if needed<br/>

   239

 * 3. 16 - 23 news category, any of the NewsType enums (NT_)<br/>

   240

 * 4. 24 - 31 news callback function, any of the NewsCallback enums (DNC_)<br/>

   241

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

   242

 * stringid has a special meaning.<br/>

   243

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   244

 * the index of the engine that is shown<br/>

   245

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

   246

 * and 4-7 contains what kind of bankrupcy message is shown, NewsBankrupcy enum (NB_)<br/>

   247

 * @see NewsMode

   248

 * @see NewsFlags

   249

 * @see NewsType

   250

 * @see NewsCallback */

   251

void AddNewsItem(StringID string, uint32 flags, uint data_a, uint data_b)

   252

{

   253

	NewsItem *ni;

   254

	Window *w;

   255

   256

	if (_game_mode == GM_MENU) return;

   257

   258

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

   259

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

   260

		MoveToNexItem();

   261

   262

	_forced_news = INVALID_NEWS;

   263

	if (_total_news < MAX_NEWS) _total_news++;

   264

   265

	// make sure our pointer isn't overflowing

   266

	_latest_news = increaseIndex(_latest_news);

   267

   268

	// overwrite oldest news entry

   269

	if (_oldest_news == _latest_news && _news_items[_oldest_news].string_id != 0)

   270

		_oldest_news = increaseIndex(_oldest_news); // but make sure we're not overflowing here

   271

   272

	// add news to _latest_news

   273

	ni = &_news_items[_latest_news];

   274

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

   275

   276

	ni->string_id = string;

   277

	ni->display_mode = (byte)flags;

   278

	ni->flags = (byte)(flags >> 8);

   279

   280

	// show this news message in color?

   281

	if (_cur_year >= _patches.colored_news_year)

   282

		ni->flags |= NF_INCOLOR;

   283

   284

	ni->type = (byte)(flags >> 16);

   285

	ni->callback = (byte)(flags >> 24);

   286

	ni->data_a = data_a;

   287

	ni->data_b = data_b;

   288

	ni->date = _date;

   289

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

   290

   291

	w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   292

	if (w == NULL) return;

   293

	SetWindowDirty(w);

   294

	w->vscroll.count = _total_news;

   295

}

   296

   297

   298

// don't show item if it's older than x days

   299

static const byte _news_items_age[] = {60, 60, 90, 60, 90, 30, 150, 30, 90, 180};

   300

   301

static const Widget _news_type13_widgets[] = {

   302

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

   303

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

   304

{   WIDGETS_END},

   305

};

   306

   307

static WindowDesc _news_type13_desc = {

   308

	WDP_CENTER, 476, 430, 170,

   309

	WC_NEWS_WINDOW, 0,

   310

	WDF_DEF_WIDGET,

   311

	_news_type13_widgets,

   312

	NewsWindowProc

   313

};

   314

   315

static const Widget _news_type2_widgets[] = {

   316

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

   317

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

   318

{   WIDGETS_END},

   319

};

   320

   321

static WindowDesc _news_type2_desc = {

   322

	WDP_CENTER, 476, 430, 130,

   323

	WC_NEWS_WINDOW, 0,

   324

	WDF_DEF_WIDGET,

   325

	_news_type2_widgets,

   326

	NewsWindowProc

   327

};

   328

   329

static const Widget _news_type0_widgets[] = {

   330

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

   331

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

   332

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

   333

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

   334

{   WIDGETS_END},

   335

};

   336

   337

static WindowDesc _news_type0_desc = {

   338

	WDP_CENTER, 476, 280, 87,

   339

	WC_NEWS_WINDOW, 0,

   340

	WDF_DEF_WIDGET,

   341

	_news_type0_widgets,

   342

	NewsWindowProc

   343

};

   344

   345

static const SoundFx _news_sounds[] = {

   346

	SND_1D_APPLAUSE,

   347

	SND_1D_APPLAUSE,

   348

	0,

   349

	0,

   350

	0,

   351

	0,

   352

	SND_1E_OOOOH,

   353

	0,

   354

	0,

   355

	0

   356

};

   357

   358

/** Get the value of an item of the news-display settings. This is

   359

 * a little tricky since on/off/summary must use 2 bits to store the value

   360

 * @param item the item whose value is requested

   361

 * @return return the found value which is between 0-2

   362

 */

   363

static inline byte GetNewsDisplayValue(byte item)

   364

{

   365

	assert(item < 10 && GB(_news_display_opt, item * 2, 2) <= 2);

   366

	return GB(_news_display_opt, item * 2, 2);

   367

}

   368

   369

/** Set the value of an item in the news-display settings. This is

   370

 * a little tricky since on/off/summary must use 2 bits to store the value

   371

 * @param item the item whose value is being set

   372

 * @param val new value

   373

 */

   374

static inline void SetNewsDisplayValue(byte item, byte val)

   375

{

   376

	assert(item < 10 && val <= 2);

   377

	SB(_news_display_opt, item * 2, 2, val);

   378

}

   379

   380

// open up an own newspaper window for the news item

   381

static void ShowNewspaper(NewsItem *ni)

   382

{

   383

	Window *w;

   384

	SoundFx sound;

   385

	int top;

   386

	ni->flags &= ~NF_FORCE_BIG;

   387

	ni->duration = 555;

   388

   389

	sound = _news_sounds[ni->type];

   390

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

   391

   392

	top = _screen.height;

   393

	switch (ni->display_mode) {

   394

		case NM_NORMAL:

   395

		case NM_CALLBACK: {

   396

			_news_type13_desc.top = top;

   397

			w = AllocateWindowDesc(&_news_type13_desc);

   398

			if (ni->flags & NF_VIEWPORT)

   399

				AssignWindowViewport(w, 2, 58, 0x1AA, 0x6E,

   400

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

   401

			break;

   402

		}

   403

   404

		case NM_THIN: {

   405

			_news_type2_desc.top = top;

   406

			w = AllocateWindowDesc(&_news_type2_desc);

   407

			if (ni->flags & NF_VIEWPORT)

   408

				AssignWindowViewport(w, 2, 58, 0x1AA, 0x46,

   409

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

   410

			break;

   411

		}

   412

   413

		default: {

   414

			_news_type0_desc.top = top;

   415

			w = AllocateWindowDesc(&_news_type0_desc);

   416

			if (ni->flags & NF_VIEWPORT)

   417

				AssignWindowViewport(w, 3, 17, 0x112, 0x2F,

   418

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

   419

			break;

   420

		}

   421

	}

   422

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

   423

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   424

}

   425

   426

// show news item in the ticker

   427

static void ShowTicker(const NewsItem *ni)

   428

{

   429

	Window *w;

   430

   431

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   432

   433

	_statusbar_news_item = *ni;

   434

	w = FindWindowById(WC_STATUS_BAR, 0);

   435

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

   436

}

   437

   438

   439

// Are we ready to show another news item?

   440

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

   441

static bool ReadyForNextItem(void)

   442

{

   443

	const Window *w;

   444

	byte item = _forced_news == INVALID_NEWS ? _current_news : _forced_news;

   445

	NewsItem *ni;

   446

   447

	if (item >= MAX_NEWS) return true;

   448

	ni = &_news_items[item];

   449

   450

	// Ticker message

   451

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

   452

	w = FindWindowById(WC_STATUS_BAR, 0);

   453

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

   454

   455

	// Newspaper message

   456

	// Wait until duration reaches 0

   457

	if (ni->duration != 0) {

   458

		ni->duration--;

   459

		return false;

   460

	}

   461

   462

	// neither newsticker nor newspaper are running

   463

	return true;

   464

}

   465

   466

static void MoveToNexItem(void)

   467

{

   468

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   469

	_forced_news = INVALID_NEWS;

   470

   471

	// if we're not at the last item, than move on

   472

	if (_current_news != _latest_news) {

   473

		NewsItem *ni;

   474

   475

		_current_news = increaseIndex(_current_news);

   476

		ni = &_news_items[_current_news];

   477

   478

		// check the date, don't show too old items

   479

		if (_date - _news_items_age[ni->type] > ni->date) return;

   480

   481

		switch (GetNewsDisplayValue(ni->type)) {

   482

		case 0: { /* Off - show nothing only a small reminder in the status bar */

   483

			Window *w = FindWindowById(WC_STATUS_BAR, 0);

   484

   485

			if (w != NULL) {

   486

				WP(w, def_d).data_2 = 91;

   487

				SetWindowDirty(w);

   488

			}

   489

			break;

   490

		}

   491