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"

    21

    22

/** @file news_gui.cpp

    23

 *

    24

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

    25

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

    26

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

    27

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

    28

 * by the newest (\a _latest_news).

    29

 *

    30

 * \verbatim

    31

 * oldest                   current   lastest

    32

 *  |                          |         |

    33

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

    34

 *               |

    35

 *            forced

    36

 * \endverbatim

    37

 *

    38

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

    39

 *

    40

 * \verbatim

    41

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

    42

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

    43

 * (MAX_NEWS - O) + L news items

    44

 * \endverbatim

    45

 */

    46

    47

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

    48

#define MAX_NEWS 30

    49

#define NB_WIDG_PER_SETTING 4

    50

    51

typedef byte NewsID;

    52

#define INVALID_NEWS 255

    53

    54

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

    55

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

    56

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

    57

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

    58

    59

/** Forced news item.

    60

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

    61

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

    62

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

    63

static NewsID _forced_news = INVALID_NEWS;

    64

    65

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

    66

    67

void DrawNewsNewVehicleAvail(Window *w);

    68

void DrawNewsBankrupcy(Window *w);

    69

static void MoveToNextItem();

    70

    71

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    72

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    73

    74

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    75

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    76

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    77

};

    78

    79

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    80

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    81

	GetNewsStringNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    82

	GetNewsStringBankrupcy,        ///< DNC_BANKRUPCY

    83

};

    84

    85

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

    86

void InitNewsItemStructs()

    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, TC_FROMSTRING);

   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, TC_FROMSTRING);

   131

   132

				SetDParam(0, ni->date);

   133

				DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   134

   135

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

   136

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

   137

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

   138

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

   139

				} else {

   140

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

   143

					DrawWindowViewport(w);

   145

   146

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

   147

					vp = w->viewport;

   148

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

   149

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

   150

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

   151

					);

   152

   153

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

   154

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

   155

				}

   156

				break;

   157

			}

   158

   159

			case NM_CALLBACK: {

   160

				_draw_news_callback[ni->callback](w);

   161

				break;

   162

			}

   163

   164

			default: {

   165

				DrawWindowWidgets(w);

   166

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

   167

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

   168

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

   169

				} else {

   170

					DrawWindowViewport(w);

   171

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

   172

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

   173

				}

   174

				break;

   175

			}

   176

		}

   177

	} break;

   178

   179

	case WE_CLICK: {

   180

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

   181

		case 1: {

   182

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

   183

			DeleteWindow(w);

   184

			ni->duration = 0;

   185

			_forced_news = INVALID_NEWS;

   186

		} break;

   187

		case 0: {

   188

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

   189

			if (ni->flags & NF_VEHICLE) {

   190

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

   191

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

   192

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

   193

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

   194

					ScrollMainWindowToTile(ni->data_b);

   195

			}

   196

		} break;

   197

		}

   198

	} break;

   199

   200

	case WE_KEYPRESS:

   201

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

   202

			/* Don't continue. */

   203

			e->we.keypress.cont = false;

   204

			DeleteWindow(w);

   205

		}

   206

		break;

   207

   208

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

   209

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

   210

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

   211

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

   212

		}

   213

		break;

   214

   215

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

   216

		int diff;

   217

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

   218

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

   219

   220

		if (w->viewport != NULL)

   221

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

   222

   223

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

   224

		w->top = y;

   225

   226

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

   227

	} break;

   228

	}

   229

}

   230

   231

/**

   232

 * Return the correct index in the pseudo-fifo

   233

 * queue and deals with overflows when increasing the index

   234

 */

   235

static inline NewsID increaseIndex(NewsID i)

   236

{

   237

	assert(i != INVALID_NEWS);

   238

	return (i + 1) % MAX_NEWS;

   239

}

   240

   241

/**

   242

 * Return the correct index in the pseudo-fifo

   243

 * queue and deals with overflows when decreasing the index

   244

 */

   245

static inline NewsID decreaseIndex(NewsID i)

   246

{

   247

	assert(i != INVALID_NEWS);

   248

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   249

}

   250

   251

/**

   252

 * Add a new newsitem to be shown.

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

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

   261

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

   262

 *

   263

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

   264

 * \a string has a special meaning.

   265

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

   266

 *    the index of the engine that is shown

   267

 *

   268

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

   269

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

   270

 *    @see NewsBankrupcy

   271

 *

   272

 * @see NewsMode

   273

 * @see NewsFlags

   274

 * @see NewsType

   275

 * @see NewsCallback

   276

 */

   277

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

   278

{

   279

	NewsID l_news;

   280

   281

	if (_game_mode == GM_MENU) return;

   282

   283

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

   284

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

   285

		MoveToNextItem();

   286

   287

	if (_total_news < MAX_NEWS) _total_news++;

   288

   289

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

   290

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

   291

	 * DeleteVehicleNews */

   292

	l_news = _latest_news;

   293

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

   294

   295

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

   296

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

   297

		assert(_total_news == MAX_NEWS);

   298

		_oldest_news = increaseIndex(_oldest_news);

   299

	}

   300

   301

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

   302

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

   303

   304

	/* Add news to _latest_news */

   305

	{

   306

		Window *w;

   307

		NewsItem *ni = &_news_items[_latest_news];

   308

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

   309

   310

		ni->string_id = string;

   311

		ni->display_mode = (byte)flags;

   312

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

   313

   314

		/* show this news message in color? */

   315

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

   316

   317

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

   318

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

   319

		ni->data_a = data_a;

   320

		ni->data_b = data_b;

   321

		ni->date = _date;

   322

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

   323

   324

		w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   325

		if (w == NULL) return;

   326

		SetWindowDirty(w);

   327

		w->vscroll.count = _total_news;

   328

	}

   329

}

   330

   331

   332

/**

   333

 * Maximum age of news items.

   334

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

   335

 * @see NewsType

   336

 */

   337

static const byte _news_items_age[NT_END] = {

   338

	60,  ///< NT_ARRIVAL_PLAYER

   339

	60,  ///< NT_ARRIVAL_OTHER

   340

	90,  ///< NT_ACCIDENT

   341

	60,  ///< NT_COMPANY_INFO

   342

	90,  ///< NT_OPENCLOSE

   343

	30,  ///< NT_ECONOMY

   344

	150, ///< NT_ADVICE

   345

	30,  ///< NT_NEW_VEHICLES

   346

	90,  ///< NT_ACCEPTANCE

   347

	180, ///< NT_SUBSIDIES

   348

	60   ///< NT_GENERAL

   349

};

   350

   351

   352

static const Widget _news_type13_widgets[] = {

   353

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

   354

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

   355

{   WIDGETS_END},

   356

};

   357

   358

static WindowDesc _news_type13_desc = {

   359

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

   360

	WC_NEWS_WINDOW, WC_NONE,

   361

	WDF_DEF_WIDGET,

   362

	_news_type13_widgets,

   363

	NewsWindowProc

   364

};

   365

   366

static const Widget _news_type2_widgets[] = {

   367

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

   368

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

   369

{   WIDGETS_END},

   370

};

   371

   372

static WindowDesc _news_type2_desc = {

   373

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

   374

	WC_NEWS_WINDOW, WC_NONE,

   375

	WDF_DEF_WIDGET,

   376

	_news_type2_widgets,

   377

	NewsWindowProc

   378

};

   379

   380

static const Widget _news_type0_widgets[] = {

   381

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

   382

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

   383

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

   384

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

   385

{   WIDGETS_END},

   386

};

   387

   388

static WindowDesc _news_type0_desc = {

   389

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

   390

	WC_NEWS_WINDOW, WC_NONE,

   391

	WDF_DEF_WIDGET,

   392

	_news_type0_widgets,

   393

	NewsWindowProc

   394

};

   395

   396

static const SoundFx _news_sounds[NT_END] = {

   397

	SND_1D_APPLAUSE,

   398

	SND_1D_APPLAUSE,

   399

	SND_BEGIN,

   400

	SND_BEGIN,

   401

	SND_BEGIN,

   402

	SND_BEGIN,

   403

	SND_BEGIN,

   404

	SND_1E_OOOOH,

   405

	SND_BEGIN,

   406

	SND_BEGIN,

   407

	SND_BEGIN,

   408

};

   409

   410

const char *_news_display_name[NT_END] = {

   411

	"arrival_player",

   412

	"arrival_other",

   413

	"accident",

   414

	"company_info",

   415

	"openclose",

   416

	"economy",

   417

	"advice",

   418

	"new_vehicles",

   419

	"acceptance",

   420

	"subsidies",

   421

	"general",

   422

};

   423

   424

/**

   425

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

   426

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

   427

 * @param item the item whose value is requested

   428

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

   429

 */

   430

static inline byte GetNewsDisplayValue(byte item)

   431

{

   432

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

   433

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

   434

}

   435

   436

/**

   437

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

   438

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

   439

 * @param item the item whose value is being set

   440

 * @param val new value

   441

 */

   442

static inline void SetNewsDisplayValue(byte item, byte val)

   443

{

   444

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

   445

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

   446

}

   447

   448

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

   449

static void ShowNewspaper(NewsItem *ni)

   450

{

   451

	Window *w;

   452

	SoundFx sound;

   453

	int top;

   454

	ni->flags &= ~NF_FORCE_BIG;

   455

	ni->duration = 555;

   456

   457

	sound = _news_sounds[ni->type];

   458

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

   459

   460

	top = _screen.height;

   461

	switch (ni->display_mode) {

   462

		case NM_NORMAL:

   463

		case NM_CALLBACK: {

   464

			_news_type13_desc.top = top;

   465

			w = AllocateWindowDesc(&_news_type13_desc);

   466

			if (ni->flags & NF_VIEWPORT)

   467

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

   468

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

   469

			break;

   470

		}

   471

   472

		case NM_THIN: {

   473

			_news_type2_desc.top = top;

   474

			w = AllocateWindowDesc(&_news_type2_desc);

   475

			if (ni->flags & NF_VIEWPORT)

   476

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

   477

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

   478

			break;

   479

		}

   480

   481

		default: {

   482

			_news_type0_desc.top = top;

   483

			w = AllocateWindowDesc(&_news_type0_desc);

   484

			if (ni->flags & NF_VIEWPORT)

   485

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

   486

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

   487

			break;

   488

		}