1

/* $Id$ */

     2

     3

/** @file texteff.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "strings.h"

    10

#include "gfx.h"

    11

#include "landscape.h"

    12

#include "viewport.h"

    13

#include "saveload.h"

    14

#include "console.h"

    15

#include "string.h"

    16

#include "variables.h"

    17

#include "table/sprites.h"

    18

#include "blitter/factory.hpp"

    19

#include <stdarg.h> /* va_list */

    20

#include "date.h"

    21

#include "texteff.hpp"

    22

#include "video/video_driver.hpp"

    23

#include "transparency.h"

    24

    25

enum {

    26

	MAX_TEXTMESSAGE_LENGTH = 200,

    27

	INIT_NUM_TEXT_MESSAGES =  20,

    28

	MAX_CHAT_MESSAGES      =  10,

    29

};

    30

    31

struct TextEffect {

    32

	StringID string_id;

    33

	int32 x;

    34

	int32 y;

    35

	int32 right;

    36

	int32 bottom;

    37

	uint16 duration;

    38

	uint64 params_1;

    39

	uint64 params_2;

    40

	TextEffectMode mode;

    41

};

    42

    43

    44

struct ChatMessage {

    45

	char message[MAX_TEXTMESSAGE_LENGTH];

    46

	uint16 color;

    47

	Date end_date;

    48

};

    49

    50

/* used for text effects */

    51

static TextEffect *_text_effect_list = NULL;

    52

static uint16 _num_text_effects = INIT_NUM_TEXT_MESSAGES;

    53

    54

/* used for chat window */

    55

static ChatMessage _chatmsg_list[MAX_CHAT_MESSAGES];

    56

static bool _chatmessage_dirty = false;

    57

static bool _chatmessage_visible = false;

    58

    59

/* The chatbox grows from the bottom so the coordinates are pixels from

    60

 * the left and pixels from the bottom. The height is the maximum height */

    61

static const Oblong _chatmsg_box = {10, 30, 500, 150};

    62

static uint8 _chatmessage_backup[150 * 500 * 6]; // (height * width)

    63

    64

static inline uint GetChatMessageCount()

    65

{

    66

	uint i;

    67

    68

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

    69

		if (_chatmsg_list[i].message[0] == '\0') break;

    70

	}

    71

    72

	return i;

    73

}

    74

    75

/* Add a text message to the 'chat window' to be shown

    76

 * @param color The colour this message is to be shown in

    77

 * @param duration The duration of the chat message in game-days

    78

 * @param message message itself in printf() style */

    79

void CDECL AddChatMessage(uint16 color, uint8 duration, const char *message, ...)

    80

{

    81

	char buf[MAX_TEXTMESSAGE_LENGTH];

    82

	const char *bufp;

    83

	va_list va;

    84

	uint msg_count;

    85

	uint16 lines;

    86

    87

	va_start(va, message);

    88

	vsnprintf(buf, lengthof(buf), message, va);

    89

	va_end(va);

    90

    91

    92

	Utf8TrimString(buf, MAX_TEXTMESSAGE_LENGTH);

    93

    94

	/* Force linebreaks for strings that are too long */

    95

	lines = GB(FormatStringLinebreaks(buf, _chatmsg_box.width - 8), 0, 16) + 1;

    96

	if (lines >= MAX_CHAT_MESSAGES) return;

    97

    98

	msg_count = GetChatMessageCount();

    99

	/* We want to add more chat messages than there is free space for, remove 'old' */

   100

	if (lines > MAX_CHAT_MESSAGES - msg_count) {

   101

		int i = lines - (MAX_CHAT_MESSAGES - msg_count);

   102

		memmove(&_chatmsg_list[0], &_chatmsg_list[i], sizeof(_chatmsg_list[0]) * (msg_count - i));

   103

		msg_count = MAX_CHAT_MESSAGES - lines;

   104

	}

   105

   106

	for (bufp = buf; lines != 0; lines--) {

   107

		ChatMessage *cmsg = &_chatmsg_list[msg_count++];

   108

		ttd_strlcpy(cmsg->message, bufp, sizeof(cmsg->message));

   109

   110

		/* The default colour for a message is player colour. Replace this with

   111

		 * white for any additional lines */

   112

		cmsg->color = (bufp == buf && color & IS_PALETTE_COLOR) ? color : (0x1D - 15) | IS_PALETTE_COLOR;

   113

		cmsg->end_date = _date + duration;

   114

   115

		bufp += strlen(bufp) + 1; // jump to 'next line' in the formatted string

   116

	}

   117

   118

	_chatmessage_dirty = true;

   119

}

   120

   121

void InitChatMessage()

   122

{

   123

	uint i;

   124

   125

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

   126

		_chatmsg_list[i].message[0] = '\0';

   127

	}

   128

}

   129

   130

/** Hide the chatbox */

   131

void UndrawChatMessage()

   132

{

   133

	if (_chatmessage_visible) {

   134

		Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   135

		/* Sometimes we also need to hide the cursor

   136

		 *   This is because both textmessage and the cursor take a shot of the

   137

		 *   screen before drawing.

   138

		 *   Now the textmessage takes his shot and paints his data before the cursor

   139

		 *   does, so in the shot of the cursor is the screen-data of the textmessage

   140

		 *   included when the cursor hangs somewhere over the textmessage. To

   141

		 *   avoid wrong repaints, we undraw the cursor in that case, and everything

   142

		 *   looks nicely ;)

   143

		 * (and now hope this story above makes sense to you ;))

   144

		 */

   145

   146

		if (_cursor.visible) {

   147

			if (_cursor.draw_pos.x + _cursor.draw_size.x >= _chatmsg_box.x &&

   148

				_cursor.draw_pos.x <= _chatmsg_box.x + _chatmsg_box.width &&

   149

				_cursor.draw_pos.y + _cursor.draw_size.y >= _screen.height - _chatmsg_box.y - _chatmsg_box.height &&

   150

				_cursor.draw_pos.y <= _screen.height - _chatmsg_box.y) {

   151

				UndrawMouseCursor();

   152

			}

   153

		}

   154

   155

		int x      = _chatmsg_box.x;

   156

		int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;

   157

		int width  = _chatmsg_box.width;

   158

		int height = _chatmsg_box.height;

   159

		if (y < 0) {

   160

			height = max(height + y, min(_chatmsg_box.height, _screen.height));

   161

			y = 0;

   162

		}

   163

		if (x + width >= _screen.width) {

   164

			width = _screen.width - x;

   165

		}

   166

		if (width <= 0 || height <= 0) return;

   167

   168

		_chatmessage_visible = false;

   169

		/* Put our 'shot' back to the screen */

   170

		blitter->CopyFromBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup, width, height);

   171

		/* And make sure it is updated next time */

   172

		_video_driver->MakeDirty(x, y, width, height);

   173

   174

		_chatmessage_dirty = true;

   175

	}

   176

}

   177

   178

/** Check if a message is expired every day */

   179

void ChatMessageDailyLoop()

   180

{

   181

	uint i;

   182

   183

	for (i = 0; i < MAX_CHAT_MESSAGES; i++) {

   184

		ChatMessage *cmsg = &_chatmsg_list[i];

   185

		if (cmsg->message[0] == '\0') continue;

   186

   187

		/* Message has expired, remove from the list */

   188

		if (cmsg->end_date < _date) {

   189

			/* Move the remaining messages over the current message */

   190

			if (i != MAX_CHAT_MESSAGES - 1) memmove(cmsg, cmsg + 1, sizeof(*cmsg) * (MAX_CHAT_MESSAGES - i - 1));

   191

   192

			/* Mark the last item as empty */

   193

			_chatmsg_list[MAX_CHAT_MESSAGES - 1].message[0] = '\0';

   194

			_chatmessage_dirty = true;

   195

   196

			/* Go one item back, because we moved the array 1 to the left */

   197

			i--;

   198

		}

   199

	}

   200

}

   201

   202

/** Draw the chat message-box */

   203

void DrawChatMessage()

   204

{

   205

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   206

	if (!_chatmessage_dirty) return;

   207

   208

	/* First undraw if needed */

   209

	UndrawChatMessage();

   210

   211

	if (_iconsole_mode == ICONSOLE_FULL) return;

   212

   213

	/* Check if we have anything to draw at all */

   214

	uint count = GetChatMessageCount();

   215

	if (count == 0) return;

   216

   217

	int x      = _chatmsg_box.x;

   218

	int y      = _screen.height - _chatmsg_box.y - _chatmsg_box.height;

   219

	int width  = _chatmsg_box.width;

   220

	int height = _chatmsg_box.height;

   221

	if (y < 0) {

   222

		height = max(height + y, min(_chatmsg_box.height, _screen.height));

   223

		y = 0;

   224

	}

   225

	if (x + width >= _screen.width) {

   226

		width = _screen.width - x;

   227

	}

   228

	if (width <= 0 || height <= 0) return;

   229

   230

	assert(blitter->BufferSize(width, height) < (int)sizeof(_chatmessage_backup));

   231

   232

	/* Make a copy of the screen as it is before painting (for undraw) */

   233

	blitter->CopyToBuffer(blitter->MoveTo(_screen.dst_ptr, x, y), _chatmessage_backup, width, height);

   234

   235

	_cur_dpi = &_screen; // switch to _screen painting

   236

   237

	/* Paint a half-transparent box behind the chat messages */

   238

	GfxFillRect(

   239

			_chatmsg_box.x,

   240

			_screen.height - _chatmsg_box.y - count * 13 - 2,

   241

			_chatmsg_box.x + _chatmsg_box.width - 1,

   242

			_screen.height - _chatmsg_box.y - 2,

   243

			PALETTE_TO_TRANSPARENT | (1 << USE_COLORTABLE) // black, but with some alpha for background

   244

		);

   245

   246

	/* Paint the chat messages starting with the lowest at the bottom */

   247

	for (uint y = 13; count-- != 0; y += 13) {

   248

		DoDrawString(_chatmsg_list[count].message, _chatmsg_box.x + 3, _screen.height - _chatmsg_box.y - y + 1, _chatmsg_list[count].color);

   249

	}

   250

   251

	/* Make sure the data is updated next flush */

   252

	_video_driver->MakeDirty(x, y, width, height);

   253

   254

	_chatmessage_visible = true;

   255

	_chatmessage_dirty = false;

   256

}

   257

   258

/* Text Effects */

   259

/**

   260

 * Mark the area of the text effect as dirty.

   261

 *

   262

 * This function marks the area of a text effect as dirty for repaint.

   263

 *

   264

 * @param te The TextEffect to mark the area dirty

   265

 * @ingroup dirty

   266

 */

   267

static void MarkTextEffectAreaDirty(TextEffect *te)

   268

{

   269

	/* Width and height of the text effect are doubled, so they are correct in both zoom out levels 1x and 2x. */

   270

	MarkAllViewportsDirty(

   271

		te->x,

   272

		te->y - 1,

   273

		(te->right - te->x)*2 + te->x + 1,

   274

		(te->bottom - (te->y - 1)) * 2 + (te->y - 1) + 1

   275

	);

   276

}

   277

   278

TextEffectID AddTextEffect(StringID msg, int x, int y, uint16 duration, TextEffectMode mode)

   279

{

   280

	TextEffect *te;

   281

	int w;

   282

	char buffer[100];

   283

	TextEffectID i;

   284

   285

	if (_game_mode == GM_MENU) return INVALID_TE_ID;

   286

   287

	/* Look for a free spot in the text effect array */

   288

	for (i = 0; i < _num_text_effects; i++) {

   289

		if (_text_effect_list[i].string_id == INVALID_STRING_ID) break;

   290

	}

   291

   292

	/* If there is none found, we grow the array */

   293

	if (i == _num_text_effects) {

   294

		_num_text_effects += 25;

   295

		_text_effect_list = ReallocT<TextEffect>(_text_effect_list, _num_text_effects);

   296

		for (; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

   297

		i = _num_text_effects - 1;

   298

	}

   299

   300

	te = &_text_effect_list[i];

   301

   302

	/* Start defining this object */

   303

	te->string_id = msg;

   304

	te->duration = duration;

   305

	te->y = y - 5;

   306

	te->bottom = y + 5;

   307

	te->params_1 = GetDParam(0);

   308

	te->params_2 = GetDParam(4);

   309

	te->mode = mode;

   310

   311

	GetString(buffer, msg, lastof(buffer));

   312

	w = GetStringBoundingBox(buffer).width;

   313

   314

	te->x = x - (w >> 1);

   315

	te->right = x + (w >> 1) - 1;

   316

	MarkTextEffectAreaDirty(te);

   317

   318

	return i;

   319

}

   320

   321

void UpdateTextEffect(TextEffectID te_id, StringID msg)

   322

{

   323

	assert(te_id < _num_text_effects);

   324

	TextEffect *te;

   325

   326

	/* Update details */

   327

	te = &_text_effect_list[te_id];

   328

	te->string_id = msg;

   329

	te->params_1 = GetDParam(0);

   330

	te->params_2 = GetDParam(4);

   331

   332

	/* Update width of text effect */

   333

	char buffer[100];

   334

	GetString(buffer, msg, lastof(buffer));

   335

	int w = GetStringBoundingBox(buffer).width;

   336

   337

	/* Only allow to make it broader, so it completely covers the old text. That avoids remnants of the old text. */

   338

	int right_new = te->x + w;

   339

	if (te->right < right_new) te->right = right_new;

   340

   341

	MarkTextEffectAreaDirty(te);

   342

}

   343

   344

void RemoveTextEffect(TextEffectID te_id)

   345

{

   346

	assert(te_id < _num_text_effects);

   347

	TextEffect *te;

   348

   349

	te = &_text_effect_list[te_id];

   350

	MarkTextEffectAreaDirty(te);

   351

	te->string_id = INVALID_STRING_ID;

   352

}

   353

   354

static void MoveTextEffect(TextEffect *te)

   355

{

   356

	/* Never expire for duration of 0xFFFF */

   357

	if (te->duration == 0xFFFF) return;

   358

	if (te->duration < 8) {

   359

		te->string_id = INVALID_STRING_ID;

   360

	} else {

   361

		te->duration -= 8;

   362

		te->y--;

   363

		te->bottom--;

   364

	}

   365

	MarkTextEffectAreaDirty(te);

   366

}

   367

   368

void MoveAllTextEffects()

   369

{

   370

	for (TextEffectID i = 0; i < _num_text_effects; i++) {

   371

		TextEffect *te = &_text_effect_list[i];

   372

		if (te->string_id != INVALID_STRING_ID && te->mode == TE_RISING) MoveTextEffect(te);

   373

	}

   374

}

   375

   376

void InitTextEffects()

   377

{

   378

	if (_text_effect_list == NULL) _text_effect_list = MallocT<TextEffect>(_num_text_effects);

   379

   380

	for (TextEffectID i = 0; i < _num_text_effects; i++) _text_effect_list[i].string_id = INVALID_STRING_ID;

   381

}

   382

   383

void DrawTextEffects(DrawPixelInfo *dpi)

   384

{

   385

	switch (dpi->zoom) {

   386

		case ZOOM_LVL_NORMAL:

   387

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   388

				TextEffect *te = &_text_effect_list[i];

   389

				if (te->string_id != INVALID_STRING_ID &&

   390

						dpi->left <= te->right &&

   391

						dpi->top  <= te->bottom &&

   392

						dpi->left + dpi->width  > te->x &&

   393

						dpi->top  + dpi->height > te->y) {

   394

					if (te->mode == TE_RISING || (_patches.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   395

						AddStringToDraw(te->x, te->y, te->string_id, te->params_1, te->params_2);

   396

					}

   397

				}

   398

			}

   399

			break;

   400

   401

		case ZOOM_LVL_OUT_2X:

   402

			for (TextEffectID i = 0; i < _num_text_effects; i++) {

   403

				TextEffect *te = &_text_effect_list[i];

   404

				if (te->string_id != INVALID_STRING_ID &&

   405

						dpi->left <= te->right  * 2 - te->x &&

   406

						dpi->top  <= te->bottom * 2 - te->y &&

   407

						dpi->left + dpi->width  > te->x &&

   408

						dpi->top  + dpi->height > te->y) {

   409

					if (te->mode == TE_RISING || (_patches.loading_indicators && !IsTransparencySet(TO_LOADING))) {

   410

						AddStringToDraw(te->x, te->y, (StringID)(te->string_id - 1), te->params_1, te->params_2);

   411

					}

   412

				}

   413

			}

   414

			break;

   415

   416

		case ZOOM_LVL_OUT_4X:

   417

		case ZOOM_LVL_OUT_8X:

   418

			break;

   419

   420

		default: NOT_REACHED();

   421

	}

   422

}

   423

   424

/** The table/list with animated tiles. */

   425

TileIndex *_animated_tile_list = NULL;

   426

/** The number of animated tiles in the current state. */

   427

uint _animated_tile_count = 0;

   428

/** The number of slots for animated tiles allocated currently. */

   429

static uint _animated_tile_allocated = 0;

   430

   431

/**

   432

 * Removes the given tile from the animated tile table.

   433

 * @param tile the tile to remove

   434

 */

   435

void DeleteAnimatedTile(TileIndex tile)

   436

{

   437

	for (TileIndex *ti = _animated_tile_list; ti < _animated_tile_list + _animated_tile_count; ti++) {

   438

		if (tile == *ti) {

   439

			/* Remove the hole

   440

			 * The order of the remaining elements must stay the same, otherwise the animation loop

   441

			 * may miss a tile; that's why we must use memmove instead of just moving the last element.

   442

			 */

   443

			memmove(ti, ti + 1, (_animated_tile_list + _animated_tile_count - (ti + 1)) * sizeof(*ti));

   444

			_animated_tile_count--;

   445

			MarkTileDirtyByTile(tile);

   446

			return;

   447

		}

   448

	}

   449

}

   450

   451

/**

   452

 * Add the given tile to the animated tile table (if it does not exist

   453

 * on that table yet). Also increases the size of the table if necessary.

   454

 * @param tile the tile to make animated

   455

 */

   456

void AddAnimatedTile(TileIndex tile)

   457

{

   458

	MarkTileDirtyByTile(tile);

   459

   460

	for (const TileIndex *ti = _animated_tile_list; ti < _animated_tile_list + _animated_tile_count; ti++) {

   461

		if (tile == *ti) return;

   462

	}

   463

   464

	/* Table not large enough, so make it larger */

   465

	if (_animated_tile_count == _animated_tile_allocated) {

   466

		_animated_tile_allocated *= 2;

   467

		_animated_tile_list = ReallocT<TileIndex>(_animated_tile_list, _animated_tile_allocated);

   468

	}

   469

   470

	_animated_tile_list[_animated_tile_count] = tile;

   471

	_animated_tile_count++;

   472

}

   473

   474

/**

   475

 * Animate all tiles in the animated tile list, i.e.\ call AnimateTile on them.

   476

 */

   477

void AnimateAnimatedTiles()

   478

{

   479

	const TileIndex *ti = _animated_tile_list;

   480

	while (ti < _animated_tile_list + _animated_tile_count) {

   481

		const TileIndex curr = *ti;

   482

		AnimateTile(curr);

   483

		/* During the AnimateTile call, DeleteAnimatedTile could have been called,

   484

		 * deleting an element we've already processed and pushing the rest one

   485

		 * slot to the left. We can detect this by checking whether the index