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 DrawNewsNewVehicleAvail(Window *w);

    57

void DrawNewsBankrupcy(Window *w);

    58

static void MoveToNextItem(void);

    59

    60

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    61

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    62

    63

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    64

	DrawNewsNewVehicleAvail,  /* DNC_VEHICLEAVAIL */

    65

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    66

};

    67

    68

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    69

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    70

	GetNewsStringNewVehicleAvail,  /* DNC_VEHICLEAVAIL */

    71

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    72

};

    73

    74

void InitNewsItemStructs(void)

    75

{

    76

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

    77

	_current_news = INVALID_NEWS;

    78

	_oldest_news = 0;

    79

	_latest_news = INVALID_NEWS;

    80

	_forced_news = INVALID_NEWS;

    81

	_total_news = 0;

    82

}

    83

    84

void DrawNewsBorder(const Window *w)

    85

{

    86

	int left = 0;

    87

	int right = w->width - 1;

    88

	int top = 0;

    89

	int bottom = w->height - 1;

    90

    91

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

    92

    93

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

    94

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

    95

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

    96

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

    97

    98

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

    99

}

   100

   101

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

   102

{

   103

	switch (e->event) {

   104

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

   105

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

   106

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

   107

	} break;

   108

   109

	case WE_PAINT: {

   110

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

   111

		ViewPort *vp;

   112

   113

		switch (ni->display_mode) {

   114

			case NM_NORMAL:

   115

			case NM_THIN: {

   116

				DrawNewsBorder(w);

   117

   118

				DrawString(2, 1, STR_00C6, 0);

   119

   120

				SetDParam(0, ni->date);

   121

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   122

   123

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

   124

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

   125

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

   126

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

   127

				} else {

   128

					byte bk = _display_opt;

   129

					_display_opt &= ~DO_TRANS_BUILDINGS;

   130

					DrawWindowViewport(w);

   131

					_display_opt = bk;

   132

   133

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

   134

					vp = w->viewport;

   135

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

   136

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

   137

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

   138

					);

   139

   140

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

   141

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

   142

				}

   143

				break;

   144

			}

   145

   146

			case NM_CALLBACK: {

   147

				_draw_news_callback[ni->callback](w);

   148

				break;

   149

			}

   150

   151

			default: {

   152

				DrawWindowWidgets(w);

   153

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

   154

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

   155

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

   156

				} else {

   157

					DrawWindowViewport(w);

   158

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

   159

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

   160

				}

   161

				break;

   162

			}

   163

		}

   164

	} break;

   165

   166

	case WE_CLICK: {

   167

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

   168

		case 1: {

   169

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

   170

			DeleteWindow(w);

   171

			ni->duration = 0;

   172

			_forced_news = INVALID_NEWS;

   173

		} break;

   174

		case 0: {

   175

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

   176

			if (ni->flags & NF_VEHICLE) {

   177

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

   178

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

   179

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

   180

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

   181

					ScrollMainWindowToTile(ni->data_b);

   182

			}

   183

		} break;

   184

		}

   185

	} break;

   186

   187

	case WE_KEYPRESS:

   188

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

   189

			// Don't continue.

   190

			e->we.keypress.cont = false;

   191

			DeleteWindow(w);

   192

		}

   193

		break;

   194

   195

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

   196

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

   197

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

   198

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

   199

		}

   200

		break;

   201

   202

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

   203

		int diff;

   204

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

   205

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

   206

   207

		if (w->viewport != NULL)

   208

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

   209

   210

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

   211

		w->top = y;

   212

   213

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

   214

	} break;

   215

	}

   216

}

   217

   218

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

   219

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

   220

static inline NewsID increaseIndex(NewsID i)

   221

{

   222

	assert(i != INVALID_NEWS);

   223

	return (i + 1) % MAX_NEWS;

   224

}

   225

   226

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

   227

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

   228

static inline NewsID decreaseIndex(NewsID i)

   229

{

   230

	assert(i != INVALID_NEWS);

   231

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   232

}

   233

   234

/** Add a new newsitem to be shown.

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

 * stringid has a special meaning.<br/>

   246

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   247

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

   248

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

   249

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

   250

 * @see NewsMode

   251

 * @see NewsFlags

   252

 * @see NewsType

   253

 * @see NewsCallback */

   254

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

   255

{

   256

	NewsID l_news;

   257

   258

	if (_game_mode == GM_MENU) return;

   259

   260

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

   261

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

   262

		MoveToNextItem();

   263

   264

	if (_total_news < MAX_NEWS) _total_news++;

   265

   266

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

   267

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

   268

	 * DeleteVehicleNews */

   269

	l_news = _latest_news;

   270

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

   271

   272

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

   273

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

   274

		assert(_total_news == MAX_NEWS);

   275

		_oldest_news = increaseIndex(_oldest_news);

   276

	}

   277

   278

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

   279

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

   280

   281

	{ /* Add news to _latest_news */

   282

		Window *w;

   283

		NewsItem *ni = &_news_items[_latest_news];

   284

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

   285

   286

		ni->string_id = string;

   287

		ni->display_mode = (byte)flags;

   288

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

   289

   290

		// show this news message in color?

   291

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

   292

   293

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

   294

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

   295

		ni->data_a = data_a;

   296

		ni->data_b = data_b;

   297

		ni->date = _date;

   298

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

   299

   300

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   301

		if (w == NULL) return;

   302

		SetWindowDirty(w);

   303

		w->vscroll.count = _total_news;

   304

	}

   305

}

   306

   307

   308

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

   309

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

   310

   311

static const Widget _news_type13_widgets[] = {

   312

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

   313

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

   314

{   WIDGETS_END},

   315

};

   316

   317

static WindowDesc _news_type13_desc = {

   318

	WDP_CENTER, 476, 430, 170,

   319

	WC_NEWS_WINDOW, WC_NONE,

   320

	WDF_DEF_WIDGET,

   321

	_news_type13_widgets,

   322

	NewsWindowProc

   323

};

   324

   325

static const Widget _news_type2_widgets[] = {

   326

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

   327

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

   328

{   WIDGETS_END},

   329

};

   330

   331

static WindowDesc _news_type2_desc = {

   332

	WDP_CENTER, 476, 430, 130,

   333

	WC_NEWS_WINDOW, WC_NONE,

   334

	WDF_DEF_WIDGET,

   335

	_news_type2_widgets,

   336

	NewsWindowProc

   337

};

   338

   339

static const Widget _news_type0_widgets[] = {

   340

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

   341

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

   342

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

   343

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

   344

{   WIDGETS_END},

   345

};

   346

   347

static WindowDesc _news_type0_desc = {

   348

	WDP_CENTER, 476, 280, 87,

   349

	WC_NEWS_WINDOW, WC_NONE,

   350

	WDF_DEF_WIDGET,

   351

	_news_type0_widgets,

   352

	NewsWindowProc

   353

};

   354

   355

static const SoundFx _news_sounds[] = {

   356

	SND_1D_APPLAUSE,

   357

	SND_1D_APPLAUSE,

   358

	SND_BEGIN,

   359

	SND_BEGIN,

   360

	SND_BEGIN,

   361

	SND_BEGIN,

   362

	SND_1E_OOOOH,

   363

	SND_BEGIN,

   364

	SND_BEGIN,

   365

	SND_BEGIN

   366

};

   367

   368

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

   369

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

   370

 * @param item the item whose value is requested

   371

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

   372

 */

   373

static inline byte GetNewsDisplayValue(byte item)

   374

{

   375

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

   376

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

   377

}

   378

   379

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

   380

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

   381

 * @param item the item whose value is being set

   382

 * @param val new value

   383

 */

   384

static inline void SetNewsDisplayValue(byte item, byte val)

   385

{

   386

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

   387

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

   388

}

   389

   390

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

   391

static void ShowNewspaper(NewsItem *ni)

   392

{

   393

	Window *w;

   394

	SoundFx sound;

   395

	int top;

   396

	ni->flags &= ~NF_FORCE_BIG;

   397

	ni->duration = 555;

   398

   399

	sound = _news_sounds[ni->type];

   400

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

   401

   402

	top = _screen.height;

   403

	switch (ni->display_mode) {

   404

		case NM_NORMAL:

   405

		case NM_CALLBACK: {

   406

			_news_type13_desc.top = top;

   407

			w = AllocateWindowDesc(&_news_type13_desc);

   408

			if (ni->flags & NF_VIEWPORT)

   409

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

   410

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

   411

			break;

   412

		}

   413

   414

		case NM_THIN: {

   415

			_news_type2_desc.top = top;

   416

			w = AllocateWindowDesc(&_news_type2_desc);

   417

			if (ni->flags & NF_VIEWPORT)

   418

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

   419

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

   420

			break;

   421

		}

   422

   423

		default: {

   424

			_news_type0_desc.top = top;

   425

			w = AllocateWindowDesc(&_news_type0_desc);

   426

			if (ni->flags & NF_VIEWPORT)

   427

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

   428

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

   429

			break;

   430

		}

   431

	}

   432

   433

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

   434

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

   435

   436

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

   437

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   438

}

   439

   440

// show news item in the ticker

   441

static void ShowTicker(const NewsItem *ni)

   442

{

   443

	Window *w;

   444

   445

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   446

   447

	_statusbar_news_item = *ni;

   448

	w = FindWindowById(WC_STATUS_BAR, 0);

   449

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

   450

}

   451

   452

   453

// Are we ready to show another news item?

   454

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

   455

static bool ReadyForNextItem(void)

   456

{

   457

	const Window *w;

   458

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

   459

	NewsItem *ni;

   460

   461

	if (item >= MAX_NEWS) return true;

   462

	ni = &_news_items[item];

   463

   464

	// Ticker message

   465

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

   466

	w = FindWindowById(WC_STATUS_BAR, 0);

   467

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

   468

   469

	// Newspaper message, decrement duration counter

   470

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

   471

   472

	// neither newsticker nor newspaper are running

   473

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

   474

}

   475

   476

static void MoveToNextItem(void)

   477

{

   478

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   479

	_forced_news = INVALID_NEWS;

   480

   481

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

   482

	if (_current_news != _latest_news) {

   483

		NewsItem *ni;

   484

   485

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

   486

		ni = &_news_items[_current_news];

   487

   488

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

   489

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