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

    77

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    78

	GetNewsStringNewTrainAvail,    /* DNC_TRAINAVAIL */

    79

	GetNewsStringNewRoadVehAvail,  /* DNC_ROADAVAIL */

    80

	GetNewsStringNewShipAvail,     /* DNC_SHIPAVAIL */

    81

	GetNewsStringNewAircraftAvail, /* DNC_AIRCRAFTAVAIL */

    82

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    83

};

    84

    85

void InitNewsItemStructs(void)

    86

{

    87

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

    88

	_current_news = INVALID_NEWS;

    89

	_oldest_news = 0;

    90

	_latest_news = INVALID_NEWS;

    91

	_forced_news = INVALID_NEWS;

    92

	_total_news = 0;

    93

}

    94

    95

void DrawNewsBorder(const Window *w)

    96

{

    97

	int left = 0;

    98

	int right = w->width - 1;

    99

	int top = 0;

   100

	int bottom = w->height - 1;

   101

   102

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

   103

   104

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

   105

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

   106

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

   107

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

   108

   109

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

   110

}

   111

   112

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

   113

{

   114

	switch (e->event) {

   115

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

   116

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

   117

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

   118

	} break;

   119

   120

	case WE_PAINT: {

   121

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

   122

		ViewPort *vp;

   123

   124

		switch (ni->display_mode) {

   125

			case NM_NORMAL:

   126

			case NM_THIN: {

   127

				DrawNewsBorder(w);

   128

   129

				DrawString(2, 1, STR_00C6, 0);

   130

   131

				SetDParam(0, ni->date);

   132

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   133

   134

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

   135

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

   136

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

   137

						ni->string_id, 426);

   138

				} else {

   139

					byte bk = _display_opt;

   140

					_display_opt &= ~DO_TRANS_BUILDINGS;

   141

					DrawWindowViewport(w);

   142

					_display_opt = bk;

   143

   144

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

   145

					vp = w->viewport;

   146

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

   147

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

   148

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

   149

					);

   150

   151

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

   152

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

   153

				}

   154

				break;

   155

			}

   156

   157

			case NM_CALLBACK: {

   158

				_draw_news_callback[ni->callback](w);

   159

				break;

   160

			}

   161

   162

			default: {

   163

				DrawWindowWidgets(w);

   164

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

   165

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

   166

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

   167

				} else {

   168

					DrawWindowViewport(w);

   169

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

   170

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

   171

				}

   172

				break;

   173

			}

   174

		}

   175

	} break;

   176

   177

	case WE_CLICK: {

   178

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

   179

		case 1: {

   180

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

   181

			DeleteWindow(w);

   182

			ni->duration = 0;

   183

			_forced_news = INVALID_NEWS;

   184

		} break;

   185

		case 0: {

   186

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

   187

			if (ni->flags & NF_VEHICLE) {

   188

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

   189

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

   190

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

   191

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

   192

					ScrollMainWindowToTile(ni->data_b);

   193

			}

   194

		} break;

   195

		}

   196

	} break;

   197

   198

	case WE_KEYPRESS:

   199

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

   200

			// Don't continue.

   201

			e->we.keypress.cont = false;

   202

			DeleteWindow(w);

   203

		}

   204

		break;

   205

   206

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

   207

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

   208

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

   209

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

   210

		}

   211

		break;

   212

   213

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

   214

		int diff;

   215

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

   216

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

   217

   218

		if (w->viewport != NULL)

   219

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

   220

   221

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

   222

		w->top = y;

   223

   224

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

   225

	} break;

   226

	}

   227

}

   228

   229

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

   230

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

   231

static inline NewsID increaseIndex(NewsID i)

   232

{

   233

	assert(i != INVALID_NEWS);

   234

	return (i + 1) % MAX_NEWS;

   235

}

   236

   237

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

   238

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

   239

static inline NewsID decreaseIndex(NewsID i)

   240

{

   241

	assert(i != INVALID_NEWS);

   242

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   243

}

   244

   245

/** Add a new newsitem to be shown.

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

 * stringid has a special meaning.<br/>

   257

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   258

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

   259

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

   260

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

   261

 * @see NewsMode

   262

 * @see NewsFlags

   263

 * @see NewsType

   264

 * @see NewsCallback */

   265

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

   266

{

   267

	NewsID l_news;

   268

   269

	if (_game_mode == GM_MENU) return;

   270

   271

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

   272

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

   273

		MoveToNextItem();

   274

   275

	_forced_news = INVALID_NEWS;

   276

	if (_total_news < MAX_NEWS) _total_news++;

   277

   278

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

   279

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

   280

	 * DeleteVehicleNews */

   281

	l_news = _latest_news;

   282

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

   283

   284

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

   285

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

   286

		assert(_total_news == MAX_NEWS);

   287

		_oldest_news = increaseIndex(_oldest_news);

   288

	}

   289

   290

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

   291

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

   292

   293

	{ /* Add news to _latest_news */

   294

		Window *w;

   295

		NewsItem *ni = &_news_items[_latest_news];

   296

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

   297

   298

		ni->string_id = string;

   299

		ni->display_mode = (byte)flags;

   300

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

   301

   302

		// show this news message in color?

   303

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

   304

   305

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

   306

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

   307

		ni->data_a = data_a;

   308

		ni->data_b = data_b;

   309

		ni->date = _date;

   310

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

   311

   312

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   313

		if (w == NULL) return;

   314

		SetWindowDirty(w);

   315

		w->vscroll.count = _total_news;

   316

	}

   317

}

   318

   319

   320

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

   321

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

   322

   323

static const Widget _news_type13_widgets[] = {

   324

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

   325

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

   326

{   WIDGETS_END},

   327

};

   328

   329

static WindowDesc _news_type13_desc = {

   330

	WDP_CENTER, 476, 430, 170,

   331

	WC_NEWS_WINDOW, 0,

   332

	WDF_DEF_WIDGET,

   333

	_news_type13_widgets,

   334

	NewsWindowProc

   335

};

   336

   337

static const Widget _news_type2_widgets[] = {

   338

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

   339

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

   340

{   WIDGETS_END},

   341

};

   342

   343

static WindowDesc _news_type2_desc = {

   344

	WDP_CENTER, 476, 430, 130,

   345

	WC_NEWS_WINDOW, 0,

   346

	WDF_DEF_WIDGET,

   347

	_news_type2_widgets,

   348

	NewsWindowProc

   349

};

   350

   351

static const Widget _news_type0_widgets[] = {

   352

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

   353

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

   354

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

   355

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

   356

{   WIDGETS_END},

   357

};

   358

   359

static WindowDesc _news_type0_desc = {

   360

	WDP_CENTER, 476, 280, 87,

   361

	WC_NEWS_WINDOW, 0,

   362

	WDF_DEF_WIDGET,

   363

	_news_type0_widgets,

   364

	NewsWindowProc

   365

};

   366

   367

static const SoundFx _news_sounds[] = {

   368

	SND_1D_APPLAUSE,

   369

	SND_1D_APPLAUSE,

   370

	0,

   371

	0,

   372

	0,

   373

	0,

   374

	SND_1E_OOOOH,

   375

	0,

   376

	0,

   377

	0

   378

};

   379

   380

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

   383

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

   384

 */

   385

static inline byte GetNewsDisplayValue(byte item)

   386

{

   387

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

   388

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

   389

}

   390

   391

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

   392

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

   393

 * @param item the item whose value is being set

   394

 * @param val new value

   395

 */

   396

static inline void SetNewsDisplayValue(byte item, byte val)

   397

{

   398

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

   399

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

   400

}

   401

   402

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

   403

static void ShowNewspaper(NewsItem *ni)

   404

{

   405

	Window *w;

   406

	SoundFx sound;

   407

	int top;

   408

	ni->flags &= ~NF_FORCE_BIG;

   409

	ni->duration = 555;

   410

   411

	sound = _news_sounds[ni->type];

   412

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

   413

   414

	top = _screen.height;

   415

	switch (ni->display_mode) {

   416

		case NM_NORMAL:

   417

		case NM_CALLBACK: {

   418

			_news_type13_desc.top = top;

   419

			w = AllocateWindowDesc(&_news_type13_desc);

   420

			if (ni->flags & NF_VIEWPORT)

   421

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

   422

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

   423

			break;

   424

		}

   425

   426

		case NM_THIN: {

   427

			_news_type2_desc.top = top;

   428

			w = AllocateWindowDesc(&_news_type2_desc);

   429

			if (ni->flags & NF_VIEWPORT)

   430

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

   431

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

   432

			break;

   433

		}

   434

   435

		default: {

   436

			_news_type0_desc.top = top;

   437

			w = AllocateWindowDesc(&_news_type0_desc);

   438

			if (ni->flags & NF_VIEWPORT)

   439

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

   440

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

   441

			break;

   442

		}

   443

	}

   444

   445

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

   446

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

   447

   448

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

   449

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   450

}

   451

   452

// show news item in the ticker

   453

static void ShowTicker(const NewsItem *ni)

   454

{

   455

	Window *w;

   456

   457

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   458

   459

	_statusbar_news_item = *ni;

   460

	w = FindWindowById(WC_STATUS_BAR, 0);

   461

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

   462

}

   463

   464

   465

// Are we ready to show another news item?

   466

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

   467

static bool ReadyForNextItem(void)

   468

{

   469

	const Window *w;

   470

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

   471

	NewsItem *ni;

   472

   473

	if (item >= MAX_NEWS) return true;

   474

	ni = &_news_items[item];

   475

   476

	// Ticker message

   477

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

   478

	w = FindWindowById(WC_STATUS_BAR, 0);

   479

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

   480

   481

	// Newspaper message, decrement duration counter

   482

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

   483

   484

	// neither newsticker nor newspaper are running

   485

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

   486

}

   487

   488

static void MoveToNextItem(void)

   489

{

   490

	DeleteWindowById(WC_NEWS_WINDOW, 0);

   491

	_forced_news = INVALID_NEWS;