1

/* $Id$ */

     2

     3

     4

#include "stdafx.h"

     5

#include "openttd.h"

     6

#include "gui.h"

     7

#include "window_gui.h"

     8

#include "viewport_func.h"

     9

#include "news_func.h"

    10

#include "settings_type.h"

    11

#include "transparency.h"

    12

#include "strings_func.h"

    13

#include "window_func.h"

    14

#include "date_func.h"

    15

#include "vehicle_base.h"

    16

#include "sound_func.h"

    17

#include "string_func.h"

    18

#include "widgets/dropdown_func.h"

    19

    20

#include "table/sprites.h"

    21

#include "table/strings.h"

    22

    23

/** @file news_gui.cpp

    24

 *

    25

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

    26

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

    27

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

    28

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

    29

 * by the newest (\a _latest_news).

    30

 *

    31

 * \verbatim

    32

 * oldest                   current   lastest

    33

 *  |                          |         |

    34

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

    35

 *               |

    36

 *            forced

    37

 * \endverbatim

    38

 *

    39

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

    40

 *

    41

 * \verbatim

    42

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

    43

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

    44

 * (MAX_NEWS - O) + L news items

    45

 * \endverbatim

    46

 */

    47

    48

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

    49

#define MAX_NEWS 30

    50

#define NB_WIDG_PER_SETTING 4

    51

    52

typedef byte NewsID;

    53

#define INVALID_NEWS 255

    54

    55

NewsItem _statusbar_news_item;

    56

uint32 _news_display_opt;

    57

bool _news_ticker_sound;

    58

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

    59

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

    60

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

    61

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

    62

    63

struct news_d {

    64

	uint16 follow_vehicle;

    65

	int32 scrollpos_x;

    66

	int32 scrollpos_y;

    67

	int32 dest_scrollpos_x;

    68

	int32 dest_scrollpos_y;

    69

	NewsItem *ni;

    70

};

    71

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(news_d));

    72

    73

/** Forced news item.

    74

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

    75

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

    76

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

    77

static NewsID _forced_news = INVALID_NEWS;

    78

    79

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

    80

    81

void DrawNewsNewVehicleAvail(Window *w, const NewsItem *ni);

    82

void DrawNewsBankrupcy(Window *w, const NewsItem *ni);

    83

static void MoveToNextItem();

    84

    85

StringID GetNewsStringNewVehicleAvail(const NewsItem *ni);

    86

StringID GetNewsStringBankrupcy(const NewsItem *ni);

    87

    88

static DrawNewsCallbackProc * const _draw_news_callback[] = {

    89

	DrawNewsNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    90

	DrawNewsBankrupcy,        ///< DNC_BANKRUPCY

    91

};

    92

    93

extern GetNewsStringCallbackProc * const _get_news_string_callback[];

    94

GetNewsStringCallbackProc * const _get_news_string_callback[] = {

    95

	GetNewsStringNewVehicleAvail,  ///< DNC_VEHICLEAVAIL

    96

	GetNewsStringBankrupcy,        ///< DNC_BANKRUPCY

    97

};

    98

    99

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

   100

void InitNewsItemStructs()

   101

{

   102

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

   103

	_current_news = INVALID_NEWS;

   104

	_oldest_news = 0;

   105

	_latest_news = INVALID_NEWS;

   106

	_forced_news = INVALID_NEWS;

   107

	_total_news = 0;

   108

}

   109

   110

void DrawNewsBorder(const Window *w)

   111

{

   112

	int left = 0;

   113

	int right = w->width - 1;

   114

	int top = 0;

   115

	int bottom = w->height - 1;

   116

   117

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

   118

   119

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

   120

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

   121

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

   122

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

   123

   124

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

   125

}

   126

   127

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

   128

{

   129

	switch (e->event) {

   130

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

   131

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

   132

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

   133

		} break;

   134

   135

		case WE_PAINT: {

   136

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

   137

   138

			switch (ni->display_mode) {

   139

				case NM_NORMAL:

   140

				case NM_THIN: {

   141

					DrawNewsBorder(w);

   142

   143

					DrawString(2, 1, STR_00C6, TC_FROMSTRING);

   144

   145

					SetDParam(0, ni->date);

   146

					DrawStringRightAligned(428, 1, STR_01FF, TC_FROMSTRING);

   147

   148

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

   149

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

   150

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

   151

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

   152

					} else {

   153

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

   154

						TransparencyOptionBits to_backup = _transparency_opt;

   155

						_transparency_opt = 0;

   156

						DrawWindowViewport(w);

   157

						_transparency_opt = to_backup;

   158

   159

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

   160

						ViewPort *vp = w->viewport;

   161

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

   162

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

   163

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

   164

						);

   165

   166

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

   167

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

   168

					}

   169

					break;

   170

				}

   171

   172

				case NM_CALLBACK:

   173

					_draw_news_callback[ni->callback](w, ni);

   174

					break;

   175

   176

				default:

   177

					DrawWindowWidgets(w);

   178

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

   179

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

   180

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

   181

					} else {

   182

						DrawWindowViewport(w);

   183

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

   184

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

   185

					}

   186

					break;

   187

			}

   188

		} break;

   189

   190

		case WE_CLICK: {

   191

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

   192

			case 1: {

   193

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

   194

				DeleteWindow(w);

   195

				ni->duration = 0;

   196

				_forced_news = INVALID_NEWS;

   197

			} break;

   198

			case 0: {

   199

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

   200

				if (ni->flags & NF_VEHICLE) {

   201

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

   202

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

   203

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

   204

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

   205

						ScrollMainWindowToTile(ni->data_b);

   206

				}

   207

			} break;

   208

			}

   209

		} break;

   210

   211

		case WE_KEYPRESS:

   212

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

   213

				/* Don't continue. */

   214

				e->we.keypress.cont = false;

   215

				DeleteWindow(w);

   216

			}

   217

			break;

   218

   219

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

   220

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

   221

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

   222

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

   223

			}

   224

			break;

   225

   226

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

   227

			int diff;

   228

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

   229

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

   230

   231

			if (w->viewport != NULL)

   232

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

   233

   234

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

   235

			w->top = y;

   236

   237

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

   238

		} break;

   239

	}

   240

}

   241

   242

/**

   243

 * Return the correct index in the pseudo-fifo

   244

 * queue and deals with overflows when increasing the index

   245

 */

   246

static inline NewsID IncreaseIndex(NewsID i)

   247

{

   248

	assert(i != INVALID_NEWS);

   249

	return (i + 1) % MAX_NEWS;

   250

}

   251

   252

/**

   253

 * Return the correct index in the pseudo-fifo

   254

 * queue and deals with overflows when decreasing the index

   255

 */

   256

static inline NewsID DecreaseIndex(NewsID i)

   257

{

   258

	assert(i != INVALID_NEWS);

   259

	return (i + MAX_NEWS - 1) % MAX_NEWS;

   260

}

   261

   262

/**

   263

 * Add a new newsitem to be shown.

   264

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

   265

 * @param display_mode, any of the NewsMode enums (NM_)

   266

 * @param flags any of the NewsFlag enums (NF_)

   267

 * @param type news category, any of the NewsType enums (NT_)

   268

 * @param callback news callback function, any of the NewsCallback enums (DNC_)

   269

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

   270

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

   271

 *

   272

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

   273

 * \a string has a special meaning.

   274

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

   275

 *    the index of the engine that is shown

   276

 *

   277

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

   278

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

   279

 *    @see NewsBankrupcy

   280

 *

   281

 * @see NewsMode

   282

 * @see NewsFlag

   283

 * @see NewsType

   284

 * @see NewsCallback

   285

 */

   286

void AddNewsItem(StringID string, NewsMode display_mode, NewsFlag flags, NewsType type, NewsCallback callback, uint data_a, uint data_b)

   287

{

   288

	if (_game_mode == GM_MENU) return;

   289

   290

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

   291

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

   292

		MoveToNextItem();

   293

	}

   294

   295

	if (_total_news < MAX_NEWS) _total_news++;

   296

   297

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

   298

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

   299

	 * DeleteVehicleNews */

   300

	NewsID l_news = _latest_news;

   301

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

   302

   303

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

   304

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

   305

		assert(_total_news == MAX_NEWS);

   306

		_oldest_news = IncreaseIndex(_oldest_news);

   307

	}

   308

   309

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

   310

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

   311

   312

	/* Add news to _latest_news */

   313

	NewsItem *ni = &_news_items[_latest_news];

   314

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

   315

   316

	ni->string_id = string;

   317

	ni->display_mode = display_mode;

   318

	ni->flags = flags;

   319

   320

	/* show this news message in color? */

   321

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

   322

   323

	ni->type = type;

   324

	ni->callback = callback;

   325

	ni->data_a = data_a;

   326

	ni->data_b = data_b;

   327

	ni->date = _date;

   328

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

   329

   330

	Window *w = FindWindowById(WC_MESSAGE_HISTORY, 0);

   331

	if (w == NULL) return;

   332

	SetWindowDirty(w);

   333

	w->vscroll.count = _total_news;

   334

}

   335

   336

   337

/**

   338

 * Maximum age of news items.

   339

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

   340

 * @see NewsType

   341

 */

   342

static const byte _news_items_age[NT_END] = {

   343

	60,  ///< NT_ARRIVAL_PLAYER

   344

	60,  ///< NT_ARRIVAL_OTHER

   345

	90,  ///< NT_ACCIDENT

   346

	60,  ///< NT_COMPANY_INFO

   347

	90,  ///< NT_OPENCLOSE

   348

	30,  ///< NT_ECONOMY

   349

	30,  ///< NT_INDUSTRY_PLAYER

   350

	30,  ///< NT_INDUSTRY_OTHER

   351

	30,  ///< NT_INDUSTRY_NOBODY

   352

	150, ///< NT_ADVICE

   353

	30,  ///< NT_NEW_VEHICLES

   354

	90,  ///< NT_ACCEPTANCE

   355

	180, ///< NT_SUBSIDIES

   356

	60   ///< NT_GENERAL

   357

};

   358

   359

   360

static const Widget _news_type13_widgets[] = {

   361

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

   362

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

   363

{   WIDGETS_END},

   364

};

   365

   366

static WindowDesc _news_type13_desc = {

   367

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

   368

	WC_NEWS_WINDOW, WC_NONE,

   369

	WDF_DEF_WIDGET,

   370

	_news_type13_widgets,

   371

	NewsWindowProc

   372

};

   373

   374

static const Widget _news_type2_widgets[] = {

   375

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

   376

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

   377

{   WIDGETS_END},

   378

};

   379

   380

static WindowDesc _news_type2_desc = {

   381

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

   382

	WC_NEWS_WINDOW, WC_NONE,

   383

	WDF_DEF_WIDGET,

   384

	_news_type2_widgets,

   385

	NewsWindowProc

   386

};

   387

   388

static const Widget _news_type0_widgets[] = {

   389

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

   390

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

   391

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

   392

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

   393

{   WIDGETS_END},

   394

};

   395

   396

static WindowDesc _news_type0_desc = {

   397

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

   398

	WC_NEWS_WINDOW, WC_NONE,

   399

	WDF_DEF_WIDGET,

   400

	_news_type0_widgets,

   401

	NewsWindowProc

   402

};

   403

   404

static const SoundFx _news_sounds[NT_END] = {

   405

	SND_1D_APPLAUSE,	///< NT_ARRIVAL_PLAYER

   406

	SND_1D_APPLAUSE,	///< NT_ARRIVAL_OTHER

   407

	SND_BEGIN,		///< NT_ACCIDENT

   408

	SND_BEGIN,		///< NT_COMPANY_INFO

   409

	SND_BEGIN,		///< NT_OPENCLOSE

   410

	SND_BEGIN,		///< NT_ECONOMY

   411

	SND_BEGIN,		///< NT_INDUSTRY_PLAYER

   412

	SND_BEGIN,		///< NT_INDUSTRY_OTHER

   413

	SND_BEGIN,		///< NT_INDUSTRY_NOBODY

   414

	SND_BEGIN,		///< NT_ADVICE

   415

	SND_1E_OOOOH,		///< NT_NEW_VEHICLES

   416

	SND_BEGIN,		///< NT_ACCEPTANCE

   417

	SND_BEGIN,		///< NT_SUBSIDIES

   418

	SND_BEGIN,		///< NT_GENERAL

   419

};

   420

   421

const char *_news_display_name[NT_END] = {

   422

	"arrival_player",

   423

	"arrival_other",

   424

	"accident",

   425

	"company_info",

   426

	"openclose",

   427

	"economy",

   428

	"production_player",

   429

	"production_other",

   430

	"production_nobody",

   431

	"advice",

   432

	"new_vehicles",

   433

	"acceptance",

   434

	"subsidies",

   435

	"general",

   436

};

   437

   438

/**

   439

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

   440

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

   441

 * @param item the item whose value is requested

   442

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

   443

 */

   444

static inline byte GetNewsDisplayValue(byte item)

   445

{

   446

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

   447

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

   448

}

   449

   450

/**

   451

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

   452

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

   453

 * @param item the item whose value is being set

   454

 * @param val new value

   455

 */

   456

static inline void SetNewsDisplayValue(byte item, byte val)

   457

{

   458

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

   459

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

   460

}

   461

   462

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

   463

static void ShowNewspaper(NewsItem *ni)

   464

{

   465

	ni->flags &= ~NF_FORCE_BIG;

   466

	ni->duration = 555;

   467

   468

	SoundFx sound = _news_sounds[ni->type];

   469

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

   470

   471

	int top = _screen.height;

   472

	Window *w;

   473

	switch (ni->display_mode) {

   474

		case NM_NORMAL:

   475

		case NM_CALLBACK:

   476

			_news_type13_desc.top = top;

   477

			w = AllocateWindowDesc(&_news_type13_desc);

   478

			if (ni->flags & NF_VIEWPORT) {

   479

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

   480

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

   481

			}

   482

			break;

   483

   484

		case NM_THIN:

   485

			_news_type2_desc.top = top;

   486

			w = AllocateWindowDesc(&_news_type2_desc);

   487

			if (ni->flags & NF_VIEWPORT) {

   488

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