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

typedef byte NewsID;

    37

#define INVALID_NEWS 255

    38

    39

static NewsItem _news_items[MAX_NEWS];

    40

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

    41

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

    42

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

    43

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

    44

 * _forced_news. forced_news is INVALID_NEWS otherwise.

    45

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

    46

static NewsID _forced_news = INVALID_NEWS;

    47

    48

static byte _total_news = 0; // total news count

    49

    50

void DrawNewsNewTrainAvail(Window *w);

    51

void DrawNewsNewRoadVehAvail(Window *w);

    52

void DrawNewsNewShipAvail(Window *w);

    53

void DrawNewsNewAircraftAvail(Window *w);

    54

void DrawNewsBankrupcy(Window *w);

    55

static void MoveToNexItem(void);

    56

    57

StringID GetNewsStringNewTrainAvail(const NewsItem *ni);

    58

StringID GetNewsStringNewRoadVehAvail(const NewsItem *ni);

    59

StringID GetNewsStringNewShipAvail(const NewsItem *ni);

    60

StringID GetNewsStringNewAircraftAvail(const NewsItem *ni);

    61

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    62

    63

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    64

	DrawNewsNewTrainAvail,    /* DNC_TRAINAVAIL */

    65

	DrawNewsNewRoadVehAvail,  /* DNC_ROADAVAIL */

    66

	DrawNewsNewShipAvail,     /* DNC_SHIPAVAIL */

    67

	DrawNewsNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    68

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    69

};

    70

    71

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    72

	GetNewsStringNewTrainAvail,    /* DNC_TRAINAVAIL */

    73

	GetNewsStringNewRoadVehAvail,  /* DNC_ROADAVAIL */

    74

	GetNewsStringNewShipAvail,     /* DNC_SHIPAVAIL */

    75

	GetNewsStringNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    76

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    77

};

    78

    79

void InitNewsItemStructs(void)

    80

{

    81

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

    82

	_current_news = INVALID_NEWS;

    83

	_oldest_news = 0;

    84

	_latest_news = INVALID_NEWS;

    85

	_forced_news = INVALID_NEWS;

    86

	_total_news = 0;

    87

}

    88

    89

void DrawNewsBorder(const Window *w)

    90

{

    91

	int left = 0;

    92

	int right = w->width - 1;

    93

	int top = 0;

    94

	int bottom = w->height - 1;

    95

    96

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

    97

    98

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

    99

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

   100

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

   101

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

   102

   103

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

   104

}

   105

   106

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

   107

{

   108

	switch (e->event) {

   109

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

   110

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

   111

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

   112

	} break;

   113

   114

	case WE_PAINT: {

   115

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

   116

		ViewPort *vp;

   117

   118

		switch (ni->display_mode) {

   119

			case NM_NORMAL:

   120

			case NM_THIN: {

   121

				DrawNewsBorder(w);

   122

   123

				DrawString(2, 1, STR_00C6, 0);

   124

   125

				SetDParam(0, ni->date);

   126

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   127

   128

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

   129

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

   130

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

   131

						ni->string_id, 426);

   132

				} else {

   133

					byte bk = _display_opt;

   134

					_display_opt &= ~DO_TRANS_BUILDINGS;

   135

					DrawWindowViewport(w);

   136

					_display_opt = bk;

   137

   138

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

   139

					vp = w->viewport;

   140

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

   141

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

   142

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

   143

					);

   144

   145

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

   146

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

   147

				}

   148

				break;

   149

			}

   150

   151

			case NM_CALLBACK: {

   152

				_draw_news_callback[ni->callback](w);

   153

				break;

   154

			}

   155

   156

			default: {

   157

				DrawWindowWidgets(w);

   158

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

   159

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

   160

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

   161

				} else {

   162

					DrawWindowViewport(w);

   163

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

   164

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

   165

				}

   166

				break;

   167

			}

   168

		}

   169

	} break;

   170

   171

	case WE_CLICK: {

   172

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

   173

		case 1: {

   174

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

   175

			DeleteWindow(w);

   176

			ni->duration = 0;

   177

			_forced_news = INVALID_NEWS;

   178

		} break;

   179

		case 0: {

   180

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

   181

			if (ni->flags & NF_VEHICLE) {

   182

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

   183

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

   184

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

   185

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

   186

					ScrollMainWindowToTile(ni->data_b);

   187

			}

   188

		} break;

   189

		}

   190

	} break;

   191

   192

	case WE_KEYPRESS:

   193

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

   194

			// Don't continue.

   195

			e->we.keypress.cont = false;

   196

			DeleteWindow(w);

   197

		}

   198

		break;

   199

   200

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

   201

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

   202

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

   203

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

   204

		}

   205

		break;

   206

   207

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

   208

		int diff;

   209

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

   210

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

   211

   212

		if (w->viewport != NULL)

   213

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

   214

   215

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

   216

		w->top = y;

   217

   218

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

   219

	} break;

   220

	}

   221

}

   222

   223

/** Return the correct index in the pseudo-fifo

   224

 * queue and deals with overflows when increasing the index */

   225

static inline NewsID increaseIndex(NewsID i)

   226

{

   227

	if (i == INVALID_NEWS) return 0;

   228

	return (i + 1) % MAX_NEWS;

   229

}

   230

   231

/** Return the correct index in the pseudo-fifo

   232

 * queue and deals with overflows when decreasing the index */

   233

static inline NewsID decreaseIndex(NewsID i)

   234

{

   235

	assert(i != INVALID_NEWS);

   236

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   237

}

   238

   239

/** Add a new newsitem to be shown.

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

 * stringid has a special meaning.<br/>

   251

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   252

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

   253

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

   254

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

   255

 * @see NewsMode

   256

 * @see NewsFlags

   257

 * @see NewsType

   258

 * @see NewsCallback */

   259

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

   260

{

   261

	NewsID l_news;

   262

   263

	if (_game_mode == GM_MENU) return;

   264

   265

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

   266

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

   267

		MoveToNexItem();

   268

   269

	_forced_news = INVALID_NEWS;

   270

	if (_total_news < MAX_NEWS) _total_news++;

   271

   272

	// make sure our pointer isn't overflowing

   273

	l_news = _latest_news;

   274

	_latest_news = increaseIndex(_latest_news);

   275

   276

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

   277

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

   278

		assert(_total_news == MAX_NEWS);

   279

		_oldest_news = increaseIndex(_oldest_news);

   280

	}

   281

   282

	{ /* Add news to _latest_news */

   283

		Window *w;

   284

		NewsItem *ni = &_news_items[_latest_news];

   285

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

   286

   287

		ni->string_id = string;

   288

		ni->display_mode = (byte)flags;

   289

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

   290

   291

		// show this news message in color?

   292

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

   293

   294

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

   295

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

   296

		ni->data_a = data_a;

   297

		ni->data_b = data_b;

   298

		ni->date = _date;

   299

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

   300

   301

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   302

		if (w == NULL) return;

   303

		SetWindowDirty(w);

   304

		w->vscroll.count = _total_news;

   305

	}

   306

}

   307

   308

   309

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

   310

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

   311

   312

static const Widget _news_type13_widgets[] = {

   313

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

   314

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

   315

{   WIDGETS_END},

   316

};

   317

   318

static WindowDesc _news_type13_desc = {

   319

	WDP_CENTER, 476, 430, 170,

   320

	WC_NEWS_WINDOW, 0,

   321

	WDF_DEF_WIDGET,

   322

	_news_type13_widgets,

   323

	NewsWindowProc

   324

};

   325

   326

static const Widget _news_type2_widgets[] = {

   327

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

   328

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

   329

{   WIDGETS_END},

   330

};

   331

   332

static WindowDesc _news_type2_desc = {

   333

	WDP_CENTER, 476, 430, 130,

   334

	WC_NEWS_WINDOW, 0,

   335

	WDF_DEF_WIDGET,

   336

	_news_type2_widgets,

   337

	NewsWindowProc

   338

};

   339

   340

static const Widget _news_type0_widgets[] = {

   341

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

   342

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

   343

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

   344

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

   345

{   WIDGETS_END},

   346

};

   347

   348

static WindowDesc _news_type0_desc = {

   349

	WDP_CENTER, 476, 280, 87,

   350

	WC_NEWS_WINDOW, 0,

   351

	WDF_DEF_WIDGET,

   352

	_news_type0_widgets,

   353

	NewsWindowProc

   354

};

   355

   356

static const SoundFx _news_sounds[] = {

   357

	SND_1D_APPLAUSE,

   358

	SND_1D_APPLAUSE,

   359

	0,

   360

	0,

   361

	0,

   362

	0,

   363

	SND_1E_OOOOH,

   364

	0,

   365

	0,

   366

	0

   367

};

   368

   369

/** Get the value of an item of 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 requested

   372

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

   373

 */

   374

static inline byte GetNewsDisplayValue(byte item)

   375

{

   376

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

   377

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

   378

}

   379

   380

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

   381

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

   382

 * @param item the item whose value is being set

   383

 * @param val new value

   384

 */

   385

static inline void SetNewsDisplayValue(byte item, byte val)

   386

{

   387

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

   388

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

   389

}

   390

   391

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

   392

static void ShowNewspaper(NewsItem *ni)

   393

{

   394

	Window *w;

   395

	SoundFx sound;

   396

	int top;

   397

	ni->flags &= ~NF_FORCE_BIG;

   398

	ni->duration = 555;

   399

   400

	sound = _news_sounds[ni->type];

   401

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

   402

   403

	top = _screen.height;

   404

	switch (ni->display_mode) {

   405

		case NM_NORMAL:

   406

		case NM_CALLBACK: {

   407

			_news_type13_desc.top = top;

   408

			w = AllocateWindowDesc(&_news_type13_desc);

   409

			if (ni->flags & NF_VIEWPORT)

   410

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

   411

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

   412

			break;

   413

		}

   414

   415

		case NM_THIN: {

   416

			_news_type2_desc.top = top;

   417

			w = AllocateWindowDesc(&_news_type2_desc);

   418

			if (ni->flags & NF_VIEWPORT)

   419

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

   420

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

   421

			break;

   422

		}

   423

   424

		default: {

   425

			_news_type0_desc.top = top;

   426

			w = AllocateWindowDesc(&_news_type0_desc);

   427

			if (ni->flags & NF_VIEWPORT)

   428

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

   429

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

   430

			break;

   431

		}

   432

	}

   433

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

   434

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   435

}

   436

   437

// show news item in the ticker

   438

static void ShowTicker(const NewsItem *ni)

   439

{

   440

	Window *w;

   441

   442

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   443

   444

	_statusbar_news_item = *ni;

   445

	w = FindWindowById(WC_STATUS_BAR, 0);

   446

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

   447

}

   448

   449

   450

// Are we ready to show another news item?

   451

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

   452

static bool ReadyForNextItem(void)

   453

{

   454

	const Window *w;

   455

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

   456

	NewsItem *ni;

   457

   458

	if (item >= MAX_NEWS) return true;

   459

	ni = &_news_items[item];

   460

   461

	// Ticker message

   462

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

   463

	w = FindWindowById(WC_STATUS_BAR, 0);

   464

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

   465

   466

	// Newspaper message

   467

	// Wait until duration reaches 0

   468

	if (ni->duration != 0) {

   469

		ni->duration--;

   470

		return false;

   471

	}

   472

   473

	// neither newsticker nor newspaper are running

   474

	return true;

   475

}

   476

   477

static void MoveToNexItem(void)

   478

{

   479

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   480

	_forced_news = INVALID_NEWS;

   481

   482

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

   483

	if (_current_news != _latest_news) {

   484

		NewsItem *ni;

   485

   486

		_current_news = increaseIndex(_current_news);

   487

		ni = &_news_items[_current_news];

   488

   489

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

   490

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

   491