1

/* $Id$ */

     2

     3

/** @file news_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "strings.h"

     9

#include "table/sprites.h"

    10

#include "table/strings.h"

    11

#include "window.h"

    12

#include "gui.h"

    13

#include "viewport.h"

    14

#include "gfx.h"

    15

#include "news.h"

    16

#include "vehicle.h"

    17

#include "sound.h"

    18

#include "variables.h"

    19

#include "date.h"

    20

#include "string.h"

    21

    22

/* News system

    23

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

    24

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

    25

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

    26

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

    27

 * by the newest (_latest news).

    28

 *

    29

 * oldest                   current   lastest

    30

 *  |                          |         |

    31

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

    32

 *               |

    33

 *            forced

    34

 *

    35

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

    36

 *

    37

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

    38

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

    39

 * (MAX_NEWS - O) + L news items

    40

 */

    41

    42

#define MAX_NEWS 30

    43

#define NB_WIDG_PER_SETTING 4

    44

    45

typedef byte NewsID;

    46

#define INVALID_NEWS 255

    47

    48

static NewsItem _news_items[MAX_NEWS];

    49

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

    50

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

    51

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

    52

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

    53

 * _forced_news. forced_news is INVALID_NEWS otherwise.

    54

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

    55

static NewsID _forced_news = INVALID_NEWS;

    56

    57

static byte _total_news = 0; // total news count

    58

    59

void DrawNewsNewVehicleAvail(Window *w);

    60

void DrawNewsBankrupcy(Window *w);

    61

static void MoveToNextItem();

    62

    63

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    64

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    65

    66

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    67

	DrawNewsNewVehicleAvail,  /* DNC_VEHICLEAVAIL */

    68

	DrawNewsBankrupcy,        /* DNC_BANKRUPCY */

    69

};

    70

    71

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    72

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    73

	GetNewsStringNewVehicleAvail,  /* DNC_VEHICLEAVAIL */

    74

	GetNewsStringBankrupcy,        /* DNC_BANKRUPCY */

    75

};

    76

    77

void InitNewsItemStructs()

    78

{

    79

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

    80

	_current_news = INVALID_NEWS;

    81

	_oldest_news = 0;

    82

	_latest_news = INVALID_NEWS;

    83

	_forced_news = INVALID_NEWS;

    84

	_total_news = 0;

    85

}

    86

    87

void DrawNewsBorder(const Window *w)

    88

{

    89

	int left = 0;

    90

	int right = w->width - 1;

    91

	int top = 0;

    92

	int bottom = w->height - 1;

    93

    94

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

    95

    96

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

    97

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

    98

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

    99

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

   100

   101

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

   102

}

   103

   104

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

   105

{

   106

	switch (e->event) {

   107

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

   108

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

   109

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

   110

	} break;

   111

   112

	case WE_PAINT: {

   113

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

   114

		ViewPort *vp;

   115

   116

		switch (ni->display_mode) {

   117

			case NM_NORMAL:

   118

			case NM_THIN: {

   119

				DrawNewsBorder(w);

   120

   121

				DrawString(2, 1, STR_00C6, 0);

   122

   123

				SetDParam(0, ni->date);

   124

				DrawStringRightAligned(428, 1, STR_01FF, 0);

   125

   126

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

   127

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

   128

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

   129

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

   130

				} else {

   131

					byte bk = _display_opt;

   132

					_display_opt &= ~DO_TRANS_BUILDINGS;

   133

					DrawWindowViewport(w);

   134

					_display_opt = bk;

   135

   136

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

   137

					vp = w->viewport;

   138

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

   139

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

   140

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

   141

					);

   142

   143

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

   144

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

   145

				}

   146

				break;

   147

			}

   148

   149

			case NM_CALLBACK: {

   150

				_draw_news_callback[ni->callback](w);

   151

				break;

   152

			}

   153

   154

			default: {

   155

				DrawWindowWidgets(w);

   156

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

   157

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

   158

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

   159

				} else {

   160

					DrawWindowViewport(w);

   161

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

   162

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

   163

				}

   164

				break;

   165

			}

   166

		}

   167

	} break;

   168

   169

	case WE_CLICK: {

   170

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

   171

		case 1: {

   172

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

   173

			DeleteWindow(w);

   174

			ni->duration = 0;

   175

			_forced_news = INVALID_NEWS;

   176

		} break;

   177

		case 0: {

   178

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

   179

			if (ni->flags & NF_VEHICLE) {

   180

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

   181

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

   182

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

   183

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

   184

					ScrollMainWindowToTile(ni->data_b);

   185

			}

   186

		} break;

   187

		}

   188

	} break;

   189

   190

	case WE_KEYPRESS:

   191

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

   192

			// Don't continue.

   193

			e->we.keypress.cont = false;

   194

			DeleteWindow(w);

   195

		}

   196

		break;

   197

   198

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

   199

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

   200

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

   201

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

   202

		}

   203

		break;

   204

   205

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

   206

		int diff;

   207

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

   208

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

   209

   210

		if (w->viewport != NULL)

   211

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

   212

   213

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

   214

		w->top = y;

   215

   216

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

   217

	} break;

   218

	}

   219

}

   220

   221

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

   222

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

   223

static inline NewsID increaseIndex(NewsID i)

   224

{

   225

	assert(i != INVALID_NEWS);

   226

	return (i + 1) % MAX_NEWS;

   227

}

   228

   229

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

   230

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

   231

static inline NewsID decreaseIndex(NewsID i)

   232

{

   233

	assert(i != INVALID_NEWS);

   234

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   235

}

   236

   237

/** Add a new newsitem to be shown.

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

 * stringid has a special meaning.<br/>

   249

 * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is

   250

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

   251

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

   252

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

   253

 * @see NewsMode

   254

 * @see NewsFlags

   255

 * @see NewsType

   256

 * @see NewsCallback */

   257

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

   258

{

   259

	NewsID l_news;

   260

   261

	if (_game_mode == GM_MENU) return;

   262

   263

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

   264

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

   265

		MoveToNextItem();

   266

   267

	if (_total_news < MAX_NEWS) _total_news++;

   268

   269

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

   270

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

   271

	 * DeleteVehicleNews */

   272

	l_news = _latest_news;

   273

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

   274

   275

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

   276

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

   277

		assert(_total_news == MAX_NEWS);

   278

		_oldest_news = increaseIndex(_oldest_news);

   279

	}

   280

   281

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

   282

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

   283

   284

	{ /* Add news to _latest_news */

   285

		Window *w;

   286

		NewsItem *ni = &_news_items[_latest_news];

   287

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

   288

   289

		ni->string_id = string;

   290

		ni->display_mode = (byte)flags;

   291

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

   292

   293

		// show this news message in color?

   294

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

   295

   296

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

   297

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

   298

		ni->data_a = data_a;

   299

		ni->data_b = data_b;

   300

		ni->date = _date;

   301

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

   302

   303

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   304

		if (w == NULL) return;

   305

		SetWindowDirty(w);

   306

		w->vscroll.count = _total_news;

   307

	}

   308

}

   309

   310

   311

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

   312

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

   313

   314

static const Widget _news_type13_widgets[] = {

   315

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

   316

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

   317

{   WIDGETS_END},

   318

};

   319

   320

static WindowDesc _news_type13_desc = {

   321

	WDP_CENTER, 476, 430, 170,

   322

	WC_NEWS_WINDOW, WC_NONE,

   323

	WDF_DEF_WIDGET,

   324

	_news_type13_widgets,

   325

	NewsWindowProc

   326

};

   327

   328

static const Widget _news_type2_widgets[] = {

   329

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

   330

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

   331

{   WIDGETS_END},

   332

};

   333

   334

static WindowDesc _news_type2_desc = {

   335

	WDP_CENTER, 476, 430, 130,

   336

	WC_NEWS_WINDOW, WC_NONE,

   337

	WDF_DEF_WIDGET,

   338

	_news_type2_widgets,

   339

	NewsWindowProc

   340

};

   341

   342

static const Widget _news_type0_widgets[] = {

   343

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

   344

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

   345

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

   346

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

   347

{   WIDGETS_END},

   348

};

   349

   350

static WindowDesc _news_type0_desc = {

   351

	WDP_CENTER, 476, 280, 87,

   352

	WC_NEWS_WINDOW, WC_NONE,

   353

	WDF_DEF_WIDGET,

   354

	_news_type0_widgets,

   355

	NewsWindowProc

   356

};

   357

   358

static const SoundFx _news_sounds[NT_END] = {

   359

	SND_1D_APPLAUSE,

   360

	SND_1D_APPLAUSE,

   361

	SND_BEGIN,

   362

	SND_BEGIN,

   363

	SND_BEGIN,

   364

	SND_BEGIN,

   365

	SND_BEGIN,

   366

	SND_1E_OOOOH,

   367

	SND_BEGIN,

   368

	SND_BEGIN,

   369

	SND_BEGIN,

   370

};

   371

   372

const char *_news_display_name[NT_END] = {

   373

	"arrival_player",

   374

	"arrival_other",

   375

	"accident",

   376

	"company_info",

   377

	"openclose",

   378

	"economy",

   379

	"advice",

   380

	"new_vehicles",

   381

	"acceptance",

   382

	"subsidies",

   383

	"general",

   384

};

   385

   386

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

   387

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

   388

 * @param item the item whose value is requested

   389

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

   390

 */

   391

static inline byte GetNewsDisplayValue(byte item)

   392

{

   393

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

   394

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

   395

}

   396

   397

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

   398

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

   399

 * @param item the item whose value is being set

   400

 * @param val new value

   401

 */

   402

static inline void SetNewsDisplayValue(byte item, byte val)

   403

{

   404

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

   405

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

   406

}

   407

   408

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

   409

static void ShowNewspaper(NewsItem *ni)

   410

{

   411

	Window *w;

   412

	SoundFx sound;

   413

	int top;

   414

	ni->flags &= ~NF_FORCE_BIG;

   415

	ni->duration = 555;

   416

   417

	sound = _news_sounds[ni->type];

   418

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

   419

   420

	top = _screen.height;

   421

	switch (ni->display_mode) {

   422

		case NM_NORMAL:

   423

		case NM_CALLBACK: {

   424

			_news_type13_desc.top = top;

   425

			w = AllocateWindowDesc(&_news_type13_desc);

   426

			if (ni->flags & NF_VIEWPORT)

   427

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

   428

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

   429

			break;

   430

		}

   431

   432

		case NM_THIN: {

   433

			_news_type2_desc.top = top;

   434

			w = AllocateWindowDesc(&_news_type2_desc);

   435

			if (ni->flags & NF_VIEWPORT)

   436

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

   437

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

   438

			break;

   439

		}

   440

   441

		default: {

   442

			_news_type0_desc.top = top;

   443

			w = AllocateWindowDesc(&_news_type0_desc);

   444

			if (ni->flags & NF_VIEWPORT)

   445

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

   446

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

   447

			break;

   448

		}

   449

	}

   450

   451

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

   452

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

   453

   454

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

   455

	w->flags4 |= WF_DISABLE_VP_SCROLL;

   456

}

   457

   458

// show news item in the ticker

   459

static void ShowTicker(const NewsItem *ni)

   460

{

   461

	Window *w;

   462

   463

	if (_news_ticker_sound) SndPlayFx(SND_16_MORSE);

   464

   465

	_statusbar_news_item = *ni;

   466

	w = FindWindowById(WC_STATUS_BAR, 0);

   467

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

   468

}

   469

   470

   471

// Are we ready to show another news item?

   472

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

   473

static bool ReadyForNextItem()

   474

{

   475

	const Window *w;

   476

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

   477

	NewsItem *ni;

   478

   479

	if (item >= MAX_NEWS) return true;

   480

	ni = &_news_items[item];

   481

   482

	// Ticker message

   483

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

   484

	w = FindWindowById(WC_STATUS_BAR, 0);

   485

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

   486

   487

	// Newspaper message, decrement duration counter

   488

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

   489