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

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

    34

 *

    35

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

    36

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

    37

 * (MAX_NEWS - O) + L news items

    38

 */

    39

    40

#define MAX_NEWS 30

    41

    42

typedef byte NewsID;

    43

#define INVALID_NEWS 255

    44

    45

static NewsItem _news_items[MAX_NEWS];

    46

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

    47

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

    48

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

    49

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

    50

 * _forced_news. forced_news is INVALID_NEWS otherwise.

    51

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

    52

static NewsID _forced_news = INVALID_NEWS;

    53

    54

static byte _total_news = 0; // total news count

    55

    56

void DrawNewsNewTrainAvail(Window *w);

    57

void DrawNewsNewRoadVehAvail(Window *w);

    58

void DrawNewsNewShipAvail(Window *w);

    59

void DrawNewsNewAircraftAvail(Window *w);

    60

void DrawNewsBankrupcy(Window *w);

    61

static void MoveToNextItem(void);

    62

    63

StringID GetNewsStringNewTrainAvail(const NewsItem *ni);

    64

StringID GetNewsStringNewRoadVehAvail(const NewsItem *ni);

    65

StringID GetNewsStringNewShipAvail(const NewsItem *ni);

    66

StringID GetNewsStringNewAircraftAvail(const NewsItem *ni);

    67

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    68

    69

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    70

	DrawNewsNewTrainAvail,    /* DNC_TRAINAVAIL */

    71

	DrawNewsNewRoadVehAvail,  /* DNC_ROADAVAIL */

    72

	DrawNewsNewShipAvail,     /* DNC_SHIPAVAIL */

    73

	DrawNewsNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    74

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    75

};

    76

    78

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    79

	GetNewsStringNewTrainAvail,    /* DNC_TRAINAVAIL */

    80

	GetNewsStringNewRoadVehAvail,  /* DNC_ROADAVAIL */

    81

	GetNewsStringNewShipAvail,     /* DNC_SHIPAVAIL */

    82

	GetNewsStringNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    83

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    84

};

    85

    86

void InitNewsItemStructs(void)

    87

{

    88

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

    89

	_current_news = INVALID_NEWS;

    90

	_oldest_news = 0;

    91

	_latest_news = INVALID_NEWS;

    92

	_forced_news = INVALID_NEWS;

    93

	_total_news = 0;

    94

}

    95

    96

void DrawNewsBorder(const Window *w)

    97

{

    98

	int left = 0;

    99

	int right = w->width - 1;

   100

	int top = 0;

   101

	int bottom = w->height - 1;

   102

   103

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

   104

   105

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

   106

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

   107

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

   108

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

   109

   110

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

   111

}

   112

   113

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

   114

{

   115

	switch (e->event) {

   116

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

   117

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

   118

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

   119

	} break;

   120

   121

	case WE_PAINT: {

   122

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

   123

		ViewPort *vp;

   124

   125

		switch (ni->display_mode) {

   126

			case NM_NORMAL:

   127

			case NM_THIN: {

   128

				DrawNewsBorder(w);

   129

   130

				DrawString(2, 1, STR_00C6, 0);

   131

   132

				SetDParam(0, ni->date);

   133

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   134

   135

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

   136

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

   137

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

   138

						ni->string_id, 426);

   139

				} else {

   140

					byte bk = _display_opt;

   141

					_display_opt &= ~DO_TRANS_BUILDINGS;

   142

					DrawWindowViewport(w);

   143

					_display_opt = bk;

   144

   145

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

   146

					vp = w->viewport;

   147

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

   148

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

   149

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

   150

					);

   151

   152

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

   153

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

   154

				}

   155

				break;

   156

			}

   157

   158

			case NM_CALLBACK: {

   159

				_draw_news_callback[ni->callback](w);

   160

				break;

   161

			}

   162

   163

			default: {

   164

				DrawWindowWidgets(w);

   165

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

   166

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

   167

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

   168

				} else {

   169

					DrawWindowViewport(w);

   170

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

   171

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

   172

				}

   173

				break;

   174

			}

   175

		}

   176

	} break;

   177

   178

	case WE_CLICK: {

   179

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

   180

		case 1: {

   181

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

   182

			DeleteWindow(w);

   183

			ni->duration = 0;

   184

			_forced_news = INVALID_NEWS;

   185

		} break;

   186

		case 0: {

   187

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

   188

			if (ni->flags & NF_VEHICLE) {

   189

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

   190

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

   191

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

   192

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

   193

					ScrollMainWindowToTile(ni->data_b);

   194

			}

   195

		} break;

   196

		}

   197

	} break;

   198

   199

	case WE_KEYPRESS:

   200

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

   201

			// Don't continue.

   202

			e->we.keypress.cont = false;

   203

			DeleteWindow(w);

   204

		}

   205

		break;

   206

   207

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

   208

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

   209

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

   210

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

   211

		}

   212

		break;

   213

   214

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

   215

		int diff;

   216

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

   217

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

   218

   219

		if (w->viewport != NULL)

   220

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

   221

   223

		w->top = y;

   224

   225

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

   226

	} break;

   227

	}

   228

}

   229

   230

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

   231

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

   232

static inline NewsID increaseIndex(NewsID i)

   233

{

   234

	assert(i != INVALID_NEWS);

   235

	return (i + 1) % MAX_NEWS;

   236

}

   237

   238

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

   239

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

   240

static inline NewsID decreaseIndex(NewsID i)

   241

{

   242

	assert(i != INVALID_NEWS);

   243

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   244

}

   245

   246

/** Add a new newsitem to be shown.

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

 * stringid has a special meaning.<br/>

   258

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   259

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

   260

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

   261

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

   262

 * @see NewsMode

   263

 * @see NewsFlags

   264

 * @see NewsType

   265

 * @see NewsCallback */

   266

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

   267

{

   268

	NewsID l_news;

   269

   270

	if (_game_mode == GM_MENU) return;

   271

   272

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

   273

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

   274

		MoveToNextItem();

   275

   276

	_forced_news = INVALID_NEWS;

   277

	if (_total_news < MAX_NEWS) _total_news++;

   278

   279

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

   280

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

   281

	 * DeleteVehicleNews */

   282

	l_news = _latest_news;

   283

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

   284

   285

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

   286

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

   287

		assert(_total_news == MAX_NEWS);

   288

		_oldest_news = increaseIndex(_oldest_news);

   289

	}

   290

   291

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

   292

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

   293

   294

	{ /* Add news to _latest_news */

   295

		Window *w;

   296

		NewsItem *ni = &_news_items[_latest_news];

   297

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

   298

   299

		ni->string_id = string;

   300

		ni->display_mode = (byte)flags;

   301

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

   302

   303

		// show this news message in color?

   304

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

   305

   306

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

   307

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

   308

		ni->data_a = data_a;

   309

		ni->data_b = data_b;

   310

		ni->date = _date;

   311

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

   312

   313

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   314

		if (w == NULL) return;

   315

		SetWindowDirty(w);

   316

		w->vscroll.count = _total_news;

   317

	}

   318

}

   319

   320

   321

/* Don't show item if it's older than x days, corresponds with NewsType in news.h */

   322

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

   323

   324

static const Widget _news_type13_widgets[] = {

   325

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

   326

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

   327

{   WIDGETS_END},

   328

};

   329

   330

static WindowDesc _news_type13_desc = {

   331

	WDP_CENTER, 476, 430, 170,

   332

	WC_NEWS_WINDOW, 0,

   333

	WDF_DEF_WIDGET,

   334

	_news_type13_widgets,

   335

	NewsWindowProc

   336

};

   337

   338

static const Widget _news_type2_widgets[] = {

   339

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

   340

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

   341

{   WIDGETS_END},

   342

};

   343

   344

static WindowDesc _news_type2_desc = {

   345

	WDP_CENTER, 476, 430, 130,

   346

	WC_NEWS_WINDOW, 0,

   347

	WDF_DEF_WIDGET,

   348

	_news_type2_widgets,

   349

	NewsWindowProc

   350

};

   351

   352

static const Widget _news_type0_widgets[] = {

   353

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

   354

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

   355

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

   356

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

   357

{   WIDGETS_END},

   358

};

   359

   360

static WindowDesc _news_type0_desc = {

   361

	WDP_CENTER, 476, 280, 87,

   362

	WC_NEWS_WINDOW, 0,

   363

	WDF_DEF_WIDGET,

   364

	_news_type0_widgets,

   365

	NewsWindowProc

   366

};

   367

   368

static const SoundFx _news_sounds[] = {

   369

	SND_1D_APPLAUSE,

   370

	SND_1D_APPLAUSE,

   375

	SND_1E_OOOOH,

   379

};

   380

   381

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

   382

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

   383

 * @param item the item whose value is requested

   384

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

   385

 */

   386

static inline byte GetNewsDisplayValue(byte item)

   387

{

   388

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

   389

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

   390

}

   391

   392

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

   393

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

   394

 * @param item the item whose value is being set

   395

 * @param val new value

   396

 */

   397

static inline void SetNewsDisplayValue(byte item, byte val)

   398

{

   399

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

   400

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

   401

}

   402

   403

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

   404

static void ShowNewspaper(NewsItem *ni)

   405

{

   406

	Window *w;

   407

	SoundFx sound;

   408

	int top;

   409

	ni->flags &= ~NF_FORCE_BIG;

   410

	ni->duration = 555;

   411

   412

	sound = _news_sounds[ni->type];

   413

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

   414

   415

	top = _screen.height;

   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

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

   423

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

   424

			break;

   425

		}

   426

   427

		case NM_THIN: {

   428

			_news_type2_desc.top = top;

   429

			w = AllocateWindowDesc(&_news_type2_desc);

   430

			if (ni->flags & NF_VIEWPORT)

   431

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

   432

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

   433

			break;

   434

		}

   435

   436

		default: {

   437

			_news_type0_desc.top = top;

   438

			w = AllocateWindowDesc(&_news_type0_desc);

   439

			if (ni->flags & NF_VIEWPORT)

   440

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

   441

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

   442

			break;

   443

		}

   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

	Window *w;

   457

   458

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   459

   460

	_statusbar_news_item = *ni;

   461

	w = FindWindowById(WC_STATUS_BAR, 0);

   462

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

   463

}

   464

   465

   466

// Are we ready to show another news item?

   467

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

   468

static bool ReadyForNextItem(void)

   469

{

   470

	const Window *w;

   471

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

   472

	NewsItem *ni;

   473

   474

	if (item >= MAX_NEWS) return true;

   475

	ni = &_news_items[item];

   476

   477

	// Ticker message

   478

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

   479

	w = FindWindowById(WC_STATUS_BAR, 0);

   480

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

   481

   482

	// Newspaper message, decrement duration counter

   483

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

   484

   485

	// neither newsticker nor newspaper are running

   486

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

   487

}

   488

   489

static void MoveToNextItem(void)

   490

{

   491

	DeleteWindowById(WC_NEWS_WINDOW, 0);