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

#include "string.h"

    19

    20

/* News system

    21

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

    22

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

    23

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

    24

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

    25

 * by the newest (_latest news).

    26

 *

    27

 * oldest                   current   lastest

    28

 *  |                          |         |

    29

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

    30

 *               |

    31

 *            forced

    32

 */

    33

    34

#define MAX_NEWS 30

    35

    36

#define INVALID_NEWS 255

    37

    38

static NewsItem _news_items[MAX_NEWS];

    39

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

    40

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

    41

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

    42

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

    43

 * _forced_news. forced_news is INVALID_NEWS otherwise.

    44

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

    45

static byte _forced_news = INVALID_NEWS;

    46

    47

static byte _total_news = 0; // total news count

    48

    49

void DrawNewsNewTrainAvail(Window *w);

    50

void DrawNewsNewRoadVehAvail(Window *w);

    51

void DrawNewsNewShipAvail(Window *w);

    52

void DrawNewsNewAircraftAvail(Window *w);

    53

void DrawNewsBankrupcy(Window *w);

    54

static void MoveToNexItem(void);

    55

    56

StringID GetNewsStringNewTrainAvail(const NewsItem *ni);

    57

StringID GetNewsStringNewRoadVehAvail(const NewsItem *ni);

    58

StringID GetNewsStringNewShipAvail(const NewsItem *ni);

    59

StringID GetNewsStringNewAircraftAvail(const NewsItem *ni);

    60

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    61

    62

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    63

	DrawNewsNewTrainAvail,    /* DNC_TRAINAVAIL */

    64

	DrawNewsNewRoadVehAvail,  /* DNC_ROADAVAIL */

    65

	DrawNewsNewShipAvail,     /* DNC_SHIPAVAIL */

    66

	DrawNewsNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    67

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    68

};

    69

    70

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    71

	GetNewsStringNewTrainAvail,    /* DNC_TRAINAVAIL */

    72

	GetNewsStringNewRoadVehAvail,  /* DNC_ROADAVAIL */

    73

	GetNewsStringNewShipAvail,     /* DNC_SHIPAVAIL */

    74

	GetNewsStringNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    75

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    76

};

    77

    78

void InitNewsItemStructs(void)

    79

{

    80

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

    81

	_current_news = INVALID_NEWS;

    82

	_oldest_news = 0;

    83

	_latest_news = INVALID_NEWS;

    84

	_forced_news = INVALID_NEWS;

    85

	_total_news = 0;

    86

}

    87

    88

void DrawNewsBorder(const Window *w)

    89

{

    90

	int left = 0;

    91

	int right = w->width - 1;

    92

	int top = 0;

    93

	int bottom = w->height - 1;

    94

    95

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

    96

    97

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

    98

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

    99

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

   100

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

   101

   102

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

   103

}

   104

   105

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

   106

{

   107

	switch (e->event) {

   108

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

   109

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

   110

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

   111

	} break;

   112

   113

	case WE_PAINT: {

   114

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

   115

		ViewPort *vp;

   116

   117

		switch (ni->display_mode) {

   118

			case NM_NORMAL:

   119

			case NM_THIN: {

   120

				DrawNewsBorder(w);

   121

   122

				DrawString(2, 1, STR_00C6, 0);

   123

   124

				SetDParam(0, ni->date);

   125

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   126

   127

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

   128

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

   129

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

   130

						ni->string_id, 426);

   131

				} else {

   132

					byte bk = _display_opt;

   133

					_display_opt &= ~DO_TRANS_BUILDINGS;

   134

					DrawWindowViewport(w);

   135

					_display_opt = bk;

   136

   137

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

   138

					vp = w->viewport;

   139

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

   140

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

   141

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

   142

					);

   143

   144

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

   145

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

   146

				}

   147

				break;

   148

			}

   149

   150

			case NM_CALLBACK: {

   151

				_draw_news_callback[ni->callback](w);

   152

				break;

   153

			}

   154

   155

			default: {

   156

				DrawWindowWidgets(w);

   157

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

   158

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

   159

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

   160

				} else {

   161

					DrawWindowViewport(w);

   162

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

   163

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

   164

				}

   165

				break;

   166

			}

   167

		}

   168

	} break;

   169

   170

	case WE_CLICK: {

   171

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

   172

		case 1: {

   173

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

   174

			DeleteWindow(w);

   175

			ni->duration = 0;

   176

			_forced_news = INVALID_NEWS;

   177

		} break;

   178

		case 0: {

   179

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

   180

			if (ni->flags & NF_VEHICLE) {

   181

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

   182

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

   183

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

   184

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

   185

					ScrollMainWindowToTile(ni->data_b);

   186

			}

   187

		} break;

   188

		}

   189

	} break;

   190

   191

	case WE_KEYPRESS:

   192

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

   193

			// Don't continue.

   194

			e->we.keypress.cont = false;

   195

			DeleteWindow(w);

   196

		}

   197

		break;

   198

   199

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

   200

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

   201

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

   202

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

   203

		}

   204

		break;

   205

   206

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

   207

		int diff;

   208

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

   209

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

   210

   211

		if (w->viewport != NULL)

   212

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

   213

   214

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

   215

		w->top = y;

   216

   217

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

   218

	} break;

   219

	}

   220

}

   221

   222

// returns the correct index in the array

   223

// (to deal with overflows)

   224

static byte increaseIndex(byte i)

   225

{

   226

	if (i == INVALID_NEWS) return 0;

   227

	i++;

   228

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

   229

	return i;

   230

}

   231

   232

/** Add a new newsitem to be shown.

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

 * stringid has a special meaning.<br/>

   244

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   245

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

   246

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

   247

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

   248

 * @see NewsMode

   249

 * @see NewsFlags

   250

 * @see NewsType

   251

 * @see NewsCallback */

   252

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

   253

{

   254

	NewsItem *ni;

   255

	Window *w;

   256

   257

	if (_game_mode == GM_MENU) return;

   258

   259

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

   260

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

   261

		MoveToNexItem();

   262

   263

	_forced_news = INVALID_NEWS;

   264

	if (_total_news < MAX_NEWS) _total_news++;

   265

   266

	// make sure our pointer isn't overflowing

   267

	_latest_news = increaseIndex(_latest_news);

   268

   269

	// overwrite oldest news entry

   270

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

   271

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

   272

   273

	// add news to _latest_news

   274

	ni = &_news_items[_latest_news];

   275

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

   276

   277

	ni->string_id = string;

   278

	ni->display_mode = (byte)flags;

   279

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

   280

   281

	// show this news message in color?

   282

	if (_cur_year >= _patches.colored_news_year)

   283

		ni->flags |= NF_INCOLOR;

   284

   285

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

   286

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

   287

	ni->data_a = data_a;

   288

	ni->data_b = data_b;

   289

	ni->date = _date;

   290

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

   291

   292

	w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   293

	if (w == NULL) return;

   294

	SetWindowDirty(w);

   295

	w->vscroll.count = _total_news;

   296

}

   297

   298

   299

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

   300

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

   301

   302

static const Widget _news_type13_widgets[] = {

   303

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

   304

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

   305

{   WIDGETS_END},

   306

};

   307

   308

static WindowDesc _news_type13_desc = {

   309

	WDP_CENTER, 476, 430, 170,

   310

	WC_NEWS_WINDOW, 0,

   311

	WDF_DEF_WIDGET,

   312

	_news_type13_widgets,

   313

	NewsWindowProc

   314

};

   315

   316

static const Widget _news_type2_widgets[] = {

   317

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

   318

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

   319

{   WIDGETS_END},

   320

};

   321

   322

static WindowDesc _news_type2_desc = {

   323

	WDP_CENTER, 476, 430, 130,

   324

	WC_NEWS_WINDOW, 0,

   325

	WDF_DEF_WIDGET,

   326

	_news_type2_widgets,

   327

	NewsWindowProc

   328

};

   329

   330

static const Widget _news_type0_widgets[] = {

   331

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

   332

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

   333

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

   334

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

   335

{   WIDGETS_END},

   336

};

   337

   338

static WindowDesc _news_type0_desc = {

   339

	WDP_CENTER, 476, 280, 87,

   340

	WC_NEWS_WINDOW, 0,

   341

	WDF_DEF_WIDGET,

   342

	_news_type0_widgets,

   343

	NewsWindowProc

   344

};

   345

   346

static const SoundFx _news_sounds[] = {

   347

	SND_1D_APPLAUSE,

   348

	SND_1D_APPLAUSE,

   349

	0,

   350

	0,

   351

	0,

   352

	0,

   353

	SND_1E_OOOOH,

   354

	0,

   355

	0,

   356

	0

   357

};

   358

   359

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

   360

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

   361

 * @param item the item whose value is requested

   362

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

   363

 */

   364

static inline byte GetNewsDisplayValue(byte item)

   365

{

   366

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

   367

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

   368

}

   369

   370

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

   371

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

   372

 * @param item the item whose value is being set

   373

 * @param val new value

   374

 */

   375

static inline void SetNewsDisplayValue(byte item, byte val)

   376

{

   377

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

   378

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

   379

}

   380

   381

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

   382

static void ShowNewspaper(NewsItem *ni)

   383

{

   384

	Window *w;

   385

	SoundFx sound;

   386

	int top;

   387

	ni->flags &= ~NF_FORCE_BIG;

   388

	ni->duration = 555;

   389

   390

	sound = _news_sounds[ni->type];

   391

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

   392

   393

	top = _screen.height;

   394

	switch (ni->display_mode) {

   395

		case NM_NORMAL:

   396

		case NM_CALLBACK: {

   397

			_news_type13_desc.top = top;

   398

			w = AllocateWindowDesc(&_news_type13_desc);

   399

			if (ni->flags & NF_VIEWPORT)

   400

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

   401

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

   402

			break;

   403

		}

   404

   405

		case NM_THIN: {

   406

			_news_type2_desc.top = top;

   407

			w = AllocateWindowDesc(&_news_type2_desc);

   408

			if (ni->flags & NF_VIEWPORT)

   409

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

   410

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

   411

			break;

   412

		}

   413

   414

		default: {

   415

			_news_type0_desc.top = top;

   416

			w = AllocateWindowDesc(&_news_type0_desc);

   417

			if (ni->flags & NF_VIEWPORT)

   418

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

   419

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

   420

			break;

   421

		}

   422

	}

   423

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

   424

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   425

}

   426

   427

// show news item in the ticker

   428

static void ShowTicker(const NewsItem *ni)

   429

{

   430

	Window *w;

   431

   432

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   433

   434

	_statusbar_news_item = *ni;

   435

	w = FindWindowById(WC_STATUS_BAR, 0);

   436

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

   437

}

   438

   439

   440

// Are we ready to show another news item?

   441

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

   442

static bool ReadyForNextItem(void)

   443

{

   444

	const Window *w;

   445

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

   446

	NewsItem *ni;

   447

   448

	if (item >= MAX_NEWS) return true;

   449

	ni = &_news_items[item];

   450

   451

	// Ticker message

   452

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

   453

	w = FindWindowById(WC_STATUS_BAR, 0);

   454

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

   455

   456

	// Newspaper message

   457

	// Wait until duration reaches 0

   458

	if (ni->duration != 0) {

   459

		ni->duration--;

   460

		return false;

   461

	}

   462

   463

	// neither newsticker nor newspaper are running

   464

	return true;

   465

}

   466

   467

static void MoveToNexItem(void)

   468

{

   469

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   470

	_forced_news = INVALID_NEWS;

   471

   472

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

   473

	if (_current_news != _latest_news) {

   474

		NewsItem *ni;

   475

   476

		_current_news = increaseIndex(_current_news);

   477

		ni = &_news_items[_current_news];

   478

   479

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

   480

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

   481

   482

		switch (GetNewsDisplayValue(ni->type)) {

   483

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

   484

			Window *w = FindWindowById(WC_STATUS_BAR, 0);

   485

   486

			if (w != NULL) {

   487

				WP(w, def_d).data_2 = 91;

   488

				SetWindowDirty(w);

   489

			}

   490

			break;

   491

		}