1

/* $Id$ */

     2

     3

     4

#include "stdafx.h"

     5

#include "openttd.h"

     6

#include "functions.h"

     7

#include "strings.h"

     8

#include "table/sprites.h"

     9

#include "table/strings.h"

    10

#include "window.h"

    11

#include "gui.h"

    12

#include "viewport.h"

    13

#include "gfx.h"

    14

#include "news.h"

    15

#include "vehicle.h"

    16

#include "sound.h"

    17

#include "variables.h"

    18

#include "date.h"

    19

#include "string.h"

    20

    21

/** @file news_gui.cpp

    22

 *

    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 (\a _oldest_news) is being overwritten

    27

 * by the newest (\a _latest_news).

    28

 *

    29

 * \verbatim

    30

 * oldest                   current   lastest

    31

 *  |                          |         |

    32

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

    33

 *               |

    34

 *            forced

    35

 * \endverbatim

    36

 *

    37

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

    38

 *

    39

 * \verbatim

    40

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

    41

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

    42

 * (MAX_NEWS - O) + L news items

    43

 * \endverbatim

    44

 */

    45

    46

/** Number of news items in the FIFO queue */

    47

#define MAX_NEWS 30

    48

#define NB_WIDG_PER_SETTING 4

    49

    50

typedef byte NewsID;

    51

#define INVALID_NEWS 255

    52

    53

static NewsItem _news_items[MAX_NEWS];      ///< The news FIFO queue

    54

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

    55

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

    56

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

    57

    58

/** Forced news item.

    59

 * Users can force an item by accessing the history or "last message".

    60

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

    61

 * _forced_news. Otherwise, \a _forced_news variable is INVALID_NEWS. */

    62

static NewsID _forced_news = INVALID_NEWS;

    63

    64

static byte _total_news = 0; ///< Number of news items in FIFO queue @see _news_items

    65

    66

void DrawNewsNewVehicleAvail(Window *w);

    67

void DrawNewsBankrupcy(Window *w);

    68

static void MoveToNextItem();

    69

    70

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    71

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    72

    73

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    74

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    75

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    76

};

    77

    78

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    79

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    80

	GetNewsStringNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    81

	GetNewsStringBankrupcy,        ///< DNC_BANKRUPCY

    82

};

    83

    84

/** Initialize the news-items data structures */

    85

void InitNewsItemStructs()

    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

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

   136

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

   137

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

   138

				} else {

   139

					/* Back up transparency options to draw news view */

   140

					byte to_backup = _transparent_opt;

   141

					_transparent_opt = 0;

   142

					DrawWindowViewport(w);

   143

					_transparent_opt = to_backup;

   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 ? PALETTE_TO_TRANSPARENT : PALETTE_TO_STRUCT_GREY) | (1 << USE_COLORTABLE)

   150

					);

   151

   152

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

   153

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

   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

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

   167

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

   168

				} else {

   169

					DrawWindowViewport(w);

   170

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

   171

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

   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

   222

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

   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

/**

   231

 * Return the correct index in the pseudo-fifo

   232

 * queue and deals with overflows when increasing the index

   233

 */

   234

static inline NewsID increaseIndex(NewsID i)

   235

{

   236

	assert(i != INVALID_NEWS);

   237

	return (i + 1) % MAX_NEWS;

   238

}

   239

   240

/**

   241

 * Return the correct index in the pseudo-fifo

   242

 * queue and deals with overflows when decreasing the index

   243

 */

   244

static inline NewsID decreaseIndex(NewsID i)

   245

{

   246

	assert(i != INVALID_NEWS);

   247

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   248

}

   249

   250

/**

   251

 * Add a new newsitem to be shown.

   252

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

   253

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

   254

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

   255

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

   256

 * @note flags exists of 4 byte-sized extra parameters.

   257

 *  -# Bits  0 -  7 display_mode, any of the NewsMode enums (NM_)

   258

 *  -# Bits  8 - 15 news flags, any of the NewsFlags enums (NF_)

   259

 *  -# Bits 16 - 23 news category, any of the NewsType enums (NT_)

   260

 *  -# Bits 24 - 31 news callback function, any of the NewsCallback enums (DNC_)

   261

 *

   262

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

   263

 * \a string has a special meaning.

   264

 *  - For DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL messages: StringID is

   265

 *    the index of the engine that is shown

   266

 *

   267

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

   268

 *    and 4-7 contains what kind of bankrupcy message is shown.

   269

 *    @see NewsBankrupcy

   270

 *

   271

 * @see NewsMode

   272

 * @see NewsFlags

   273

 * @see NewsType

   274

 * @see NewsCallback

   275

 */

   276

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

   277

{

   278

	NewsID l_news;

   279

   280

	if (_game_mode == GM_MENU) return;

   281

   282

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

   283

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

   284

		MoveToNextItem();

   285

   286

	if (_total_news < MAX_NEWS) _total_news++;

   287

   288

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

   289

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

   290

	 * DeleteVehicleNews */

   291

	l_news = _latest_news;

   292

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

   293

   294

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

   295

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

   296

		assert(_total_news == MAX_NEWS);

   297

		_oldest_news = increaseIndex(_oldest_news);

   298

	}

   299

   300

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

   301

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

   302

   303

	/* Add news to _latest_news */

   304

	{

   305

		Window *w;

   306

		NewsItem *ni = &_news_items[_latest_news];

   307

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

   308

   309

		ni->string_id = string;

   310

		ni->display_mode = (byte)flags;

   311

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

   312

   313

		/* show this news message in color? */

   314

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

   315

   316

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

   317

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

   318

		ni->data_a = data_a;

   319

		ni->data_b = data_b;

   320

		ni->date = _date;

   321

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

   322

   323

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   324

		if (w == NULL) return;

   325

		SetWindowDirty(w);

   326

		w->vscroll.count = _total_news;

   327

	}

   328

}

   329

   330

   331

/**

   332

 * Maximum age of news items.

   333

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

   334

 * @see NewsType

   335

 */

   336

static const byte _news_items_age[NT_END] = {

   337

	60,  ///< NT_ARRIVAL_PLAYER

   338

	60,  ///< NT_ARRIVAL_OTHER

   339

	90,  ///< NT_ACCIDENT

   340

	60,  ///< NT_COMPANY_INFO

   341

	90,  ///< NT_OPENCLOSE

   342

	30,  ///< NT_ECONOMY

   343

	150, ///< NT_ADVICE

   344

	30,  ///< NT_NEW_VEHICLES

   345

	90,  ///< NT_ACCEPTANCE

   346

	180, ///< NT_SUBSIDIES

   347

	60   ///< NT_GENERAL

   348

};

   349

   350

   351

static const Widget _news_type13_widgets[] = {

   352

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

   353

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

   354

{   WIDGETS_END},

   355

};

   356

   357

static WindowDesc _news_type13_desc = {

   358

	WDP_CENTER, 476, 430, 170, 430, 170,

   359

	WC_NEWS_WINDOW, WC_NONE,

   360

	WDF_DEF_WIDGET,

   361

	_news_type13_widgets,

   362

	NewsWindowProc

   363

};

   364

   365

static const Widget _news_type2_widgets[] = {

   366

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

   367

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

   368

{   WIDGETS_END},

   369

};

   370

   371

static WindowDesc _news_type2_desc = {

   372

	WDP_CENTER, 476, 430, 130, 430, 130,

   373

	WC_NEWS_WINDOW, WC_NONE,

   374

	WDF_DEF_WIDGET,

   375

	_news_type2_widgets,

   376

	NewsWindowProc

   377

};

   378

   379

static const Widget _news_type0_widgets[] = {

   380

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

   381

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

   382

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

   383

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

   384

{   WIDGETS_END},

   385

};

   386

   387

static WindowDesc _news_type0_desc = {

   388

	WDP_CENTER, 476, 280, 87, 280, 87,

   389

	WC_NEWS_WINDOW, WC_NONE,

   390

	WDF_DEF_WIDGET,

   391

	_news_type0_widgets,

   392

	NewsWindowProc

   393

};

   394

   395

static const SoundFx _news_sounds[NT_END] = {

   396

	SND_1D_APPLAUSE,

   397

	SND_1D_APPLAUSE,

   398

	SND_BEGIN,

   399

	SND_BEGIN,

   400

	SND_BEGIN,

   401

	SND_BEGIN,

   402

	SND_BEGIN,

   403

	SND_1E_OOOOH,

   404

	SND_BEGIN,

   405

	SND_BEGIN,

   406

	SND_BEGIN,

   407

};

   408

   409

const char *_news_display_name[NT_END] = {

   410

	"arrival_player",

   411

	"arrival_other",

   412

	"accident",

   413

	"company_info",

   414

	"openclose",

   415

	"economy",

   416

	"advice",

   417

	"new_vehicles",

   418

	"acceptance",

   419

	"subsidies",

   420

	"general",

   421

};

   422

   423

/**

   424

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

   425

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

   426

 * @param item the item whose value is requested

   427

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

   428

 */

   429

static inline byte GetNewsDisplayValue(byte item)

   430

{

   431

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

   432

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

   433

}

   434

   435

/**

   436

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

   437

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

   438

 * @param item the item whose value is being set

   439

 * @param val new value

   440

 */

   441

static inline void SetNewsDisplayValue(byte item, byte val)

   442

{

   443

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

   444

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

   445

}

   446

   447

/** Open up an own newspaper window for the news item */

   448

static void ShowNewspaper(NewsItem *ni)

   449

{

   450

	Window *w;

   451

	SoundFx sound;

   452

	int top;

   453

	ni->flags &= ~NF_FORCE_BIG;

   454

	ni->duration = 555;

   455

   456

	sound = _news_sounds[ni->type];

   457

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

   458

   459

	top = _screen.height;

   460

	switch (ni->display_mode) {

   461

		case NM_NORMAL:

   462

		case NM_CALLBACK: {

   463

			_news_type13_desc.top = top;

   464

			w = AllocateWindowDesc(&_news_type13_desc);

   465

			if (ni->flags & NF_VIEWPORT)

   466

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

   467

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

   468

			break;

   469

		}

   470

   471

		case NM_THIN: {

   472

			_news_type2_desc.top = top;

   473

			w = AllocateWindowDesc(&_news_type2_desc);

   474

			if (ni->flags & NF_VIEWPORT)

   475

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

   476

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

   477

			break;

   478

		}

   479

   480

		default: {

   481

			_news_type0_desc.top = top;

   482

			w = AllocateWindowDesc(&_news_type0_desc);

   483

			if (ni->flags & NF_VIEWPORT)

   484

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

   485

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

   486

			break;

   487

		}

   488

	}