1

/* $Id$ */

     2

     3

/** @file gfx.cpp Handling of drawing text and other gfx related stuff. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gfx_func.h"

     8

#include "spritecache.h"

     9

#include "variables.h"

    10

#include "fontcache.h"

    11

#include "genworld.h"

    12

#include "debug.h"

    13

#include "zoom_func.h"

    14

#include "texteff.hpp"

    15

#include "blitter/factory.hpp"

    16

#include "video/video_driver.hpp"

    17

#include "strings_func.h"

    18

#include "core/math_func.hpp"

    19

#include "settings_type.h"

    20

#include "core/alloc_func.hpp"

    22

#include "landscape_type.h"

    23

    24

#include "table/palettes.h"

    25

#include "table/sprites.h"

    26

#include "table/control_codes.h"

    27

    28

byte _dirkeys;        ///< 1 = left, 2 = up, 4 = right, 8 = down

    29

bool _fullscreen;

    30

CursorVars _cursor;

    31

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    32

bool _shift_pressed;  ///< Is Shift pressed?

    33

byte _fast_forward;

    34

bool _left_button_down;     ///< Is left mouse button pressed?

    35

bool _left_button_clicked;  ///< Is left mouse button clicked?

    36

bool _right_button_down;    ///< Is right mouse button pressed?

    37

bool _right_button_clicked; ///< Is right mouse button clicked?

    38

DrawPixelInfo _screen;

    39

bool _screen_disable_anim = false;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)

    40

bool _exit_game;

    41

bool _networking;         ///< are we in networking mode?

    42

byte _game_mode;

    43

int8 _pause_game;

    44

int _pal_first_dirty;

    45

int _pal_count_dirty;

    46

    47

Colour _cur_palette[256];

    48

byte _stringwidth_table[FS_END][224];

    49

DrawPixelInfo *_cur_dpi;

    50

byte _colour_gradient[16][8];

    51

bool _use_dos_palette;

    52

    53

static void GfxMainBlitter(const Sprite *sprite, int x, int y, BlitterMode mode, const SubSprite *sub = NULL);

    54

    55

FontSize _cur_fontsize;

    56

static FontSize _last_fontsize;

    57

static uint8 _cursor_backup[64 * 64 * 4];

    58

    59

/**

    60

 * The rect for repaint.

    61

 *

    62

 * This rectangle defines the area which should be repaint by the video driver.

    63

 *

    64

 * @ingroup dirty

    65

 */

    66

static Rect _invalid_rect;

    67

static const byte *_color_remap_ptr;

    68

static byte _string_colorremap[3];

    69

    70

enum {

    71

	DIRTY_BLOCK_HEIGHT   = 8,

    72

	DIRTY_BLOCK_WIDTH    = 64,

    73

};

    74

static uint _dirty_bytes_per_line = 0;

    75

static byte *_dirty_blocks = NULL;

    76

    77

void GfxScroll(int left, int top, int width, int height, int xo, int yo)

    78

{

    79

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    80

    81

	if (xo == 0 && yo == 0) return;

    82

    83

	if (_cursor.visible) UndrawMouseCursor();

    84

	UndrawChatMessage();

    85

    86

	blitter->ScrollBuffer(_screen.dst_ptr, left, top, width, height, xo, yo);

    87

	/* This part of the screen is now dirty. */

    88

	_video_driver->MakeDirty(left, top, width, height);

    89

}

    90

    91

    92

void GfxFillRect(int left, int top, int right, int bottom, int color)

    93

{

    94

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    95

	const DrawPixelInfo *dpi = _cur_dpi;

    96

	void *dst;

    97

	const int otop = top;

    98

	const int oleft = left;

    99

   100

	if (dpi->zoom != ZOOM_LVL_NORMAL) return;

   101

	if (left > right || top > bottom) return;

   102

	if (right < dpi->left || left >= dpi->left + dpi->width) return;

   103

	if (bottom < dpi->top || top >= dpi->top + dpi->height) return;

   104

   105

	if ( (left -= dpi->left) < 0) left = 0;

   106

	right = right - dpi->left + 1;

   107

	if (right > dpi->width) right = dpi->width;

   108

	right -= left;

   109

	assert(right > 0);

   110

   111

	if ( (top -= dpi->top) < 0) top = 0;

   112

	bottom = bottom - dpi->top + 1;

   113

	if (bottom > dpi->height) bottom = dpi->height;

   114

	bottom -= top;

   115

	assert(bottom > 0);

   116

   117

	dst = blitter->MoveTo(dpi->dst_ptr, left, top);

   118

   119

	if (!HasBit(color, PALETTE_MODIFIER_GREYOUT)) {

   120

		if (!HasBit(color, USE_COLORTABLE)) {

   121

			blitter->DrawRect(dst, right, bottom, (uint8)color);

   122

		} else {

   123

			blitter->DrawColorMappingRect(dst, right, bottom, GB(color, 0, PALETTE_WIDTH));

   124

		}

   125

	} else {

   126

		byte bo = (oleft - left + dpi->left + otop - top + dpi->top) & 1;

   127

		do {

   128

			for (int i = (bo ^= 1); i < right; i += 2) blitter->SetPixel(dst, i, 0, (uint8)color);

   129

			dst = blitter->MoveTo(dst, 0, 1);

   130

		} while (--bottom > 0);

   131

	}

   132

}

   133

   134

void GfxDrawLine(int x, int y, int x2, int y2, int color)

   135

{

   136

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   137

	DrawPixelInfo *dpi = _cur_dpi;

   138

   139

	x -= dpi->left;

   140

	x2 -= dpi->left;

   141

	y -= dpi->top;

   142

	y2 -= dpi->top;

   143

   144

	/* Check clipping */

   145

	if (x < 0 && x2 < 0) return;

   146

	if (y < 0 && y2 < 0) return;

   147

	if (x > dpi->width  && x2 > dpi->width)  return;

   148

	if (y > dpi->height && y2 > dpi->height) return;

   149

   150

	blitter->DrawLine(dpi->dst_ptr, x, y, x2, y2, dpi->width, dpi->height, color);

   151

}

   152

   153

void GfxDrawLineUnscaled(int x, int y, int x2, int y2, int color)

   154

{

   155

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   156

	DrawPixelInfo *dpi = _cur_dpi;

   157

   158

	x -= dpi->left;

   159

	x2 -= dpi->left;

   160

	y -= dpi->top;

   161

	y2 -= dpi->top;

   162

   163

	/* Check clipping */

   164

	if (x < 0 && x2 < 0) return;

   165

	if (y < 0 && y2 < 0) return;

   166

	if (x > dpi->width  && x2 > dpi->width)  return;

   167

	if (y > dpi->height && y2 > dpi->height) return;

   168

   169

	blitter->DrawLine(dpi->dst_ptr, UnScaleByZoom(x, dpi->zoom), UnScaleByZoom(y, dpi->zoom),

   170

			UnScaleByZoom(x2, dpi->zoom), UnScaleByZoom(y2, dpi->zoom),

   171

			UnScaleByZoom(dpi->width, dpi->zoom), UnScaleByZoom(dpi->height, dpi->zoom), color);

   172

}

   173

   174

/**

   175

 * Draws the projection of a parallelepiped.

   176

 * This can be used to draw boxes in world coordinates.

   177

 *

   178

 * @param x   Screen X-coordinate of top front corner.

   179

 * @param y   Screen Y-coordinate of top front corner.

   180

 * @param dx1 Screen X-length of first edge.

   181

 * @param dy1 Screen Y-length of first edge.

   182

 * @param dx2 Screen X-length of second edge.

   183

 * @param dy2 Screen Y-length of second edge.

   184

 * @param dx3 Screen X-length of third edge.

   185

 * @param dy3 Screen Y-length of third edge.

   186

 */

   187

void DrawBox(int x, int y, int dx1, int dy1, int dx2, int dy2, int dx3, int dy3)

   188

{

   189

	/*           ....

   190

	 *         ..    ....

   191

	 *       ..          ....

   192

	 *     ..                ^

   193

	 *   <--__(dx1,dy1)    /(dx2,dy2)

   194

	 *   :    --__       /   :

   195

	 *   :        --__ /     :

   196

	 *   :            *(x,y) :

   197

	 *   :            |      :

   198

	 *   :            |     ..

   199

	 *    ....        |(dx3,dy3)

   200

	 *        ....    | ..

   201

	 *            ....V.

   202

	 */

   203

   204

	static const byte color = 255;

   205

   206

	GfxDrawLineUnscaled(x, y, x + dx1, y + dy1, color);

   207

	GfxDrawLineUnscaled(x, y, x + dx2, y + dy2, color);

   208

	GfxDrawLineUnscaled(x, y, x + dx3, y + dy3, color);

   209

   210

	GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx2, y + dy1 + dy2, color);

   211

	GfxDrawLineUnscaled(x + dx1, y + dy1, x + dx1 + dx3, y + dy1 + dy3, color);

   212

	GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx1, y + dy2 + dy1, color);

   213

	GfxDrawLineUnscaled(x + dx2, y + dy2, x + dx2 + dx3, y + dy2 + dy3, color);

   214

	GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx1, y + dy3 + dy1, color);

   215

	GfxDrawLineUnscaled(x + dx3, y + dy3, x + dx3 + dx2, y + dy3 + dy2, color);

   216

}

   217

   218

   219

/** Truncate a given string to a maximum width if neccessary.

   220

 * If the string is truncated, add three dots ('...') to show this.

   221

 * @param *str string that is checked and possibly truncated

   222

 * @param maxw maximum width in pixels of the string

   223

 * @return new width of (truncated) string */

   224

static int TruncateString(char *str, int maxw)

   225

{

   226

	int w = 0;

   227

	FontSize size = _cur_fontsize;

   228

	int ddd, ddd_w;

   229

   230

	WChar c;

   231

	char *ddd_pos;

   232

   233

	ddd_w = ddd = GetCharacterWidth(size, '.') * 3;

   234

   235

	for (ddd_pos = str; (c = Utf8Consume((const char **)&str)) != '\0'; ) {

   236

		if (IsPrintable(c)) {

   237

			w += GetCharacterWidth(size, c);

   238

   239

			if (w >= maxw) {

   240

				/* string got too big... insert dotdotdot */

   241

				ddd_pos[0] = ddd_pos[1] = ddd_pos[2] = '.';

   242

				ddd_pos[3] = '\0';

   243

				return ddd_w;

   244

			}

   245

		} else {

   246

			if (c == SCC_SETX) str++;

   247

			else if (c == SCC_SETXY) str += 2;

   248

			else if (c == SCC_TINYFONT) {

   249

				size = FS_SMALL;

   250

				ddd = GetCharacterWidth(size, '.') * 3;

   251

			} else if (c == SCC_BIGFONT) {

   252

				size = FS_LARGE;

   253

				ddd = GetCharacterWidth(size, '.') * 3;

   254

			}

   255

		}

   256

   257

		/* Remember the last position where three dots fit. */

   258

		if (w + ddd < maxw) {

   259

			ddd_w = w + ddd;

   260

			ddd_pos = str;

   261

		}

   262

	}

   263

   264

	return w;

   265

}

   266

   267

static inline int TruncateStringID(StringID src, char *dest, int maxw, const char* last)

   268

{

   269

	GetString(dest, src, last);

   270

	return TruncateString(dest, maxw);

   271

}

   272

   273

/* returns right coordinate */

   274

int DrawString(int x, int y, StringID str, uint16 color)

   275

{

   276

	char buffer[512];

   277

   278

	GetString(buffer, str, lastof(buffer));

   279

	return DoDrawString(buffer, x, y, color);

   280

}

   281

   282

int DrawStringTruncated(int x, int y, StringID str, uint16 color, uint maxw)

   283

{

   284

	char buffer[512];

   285

	TruncateStringID(str, buffer, maxw, lastof(buffer));

   286

	return DoDrawString(buffer, x, y, color);

   287

}

   288

   289

   290

int DrawStringRightAligned(int x, int y, StringID str, uint16 color)

   291

{

   292

	char buffer[512];

   293

	int w;

   294

   295

	GetString(buffer, str, lastof(buffer));

   296

	w = GetStringBoundingBox(buffer).width;

   297

	DoDrawString(buffer, x - w, y, color);

   298

   299

	return w;

   300

}

   301

   302

void DrawStringRightAlignedTruncated(int x, int y, StringID str, uint16 color, uint maxw)

   303

{

   304

	char buffer[512];

   305

   306

	TruncateStringID(str, buffer, maxw, lastof(buffer));

   307

	DoDrawString(buffer, x - GetStringBoundingBox(buffer).width, y, color);

   308

}

   309

   310

void DrawStringRightAlignedUnderline(int x, int y, StringID str, uint16 color)

   311

{

   312

	int w = DrawStringRightAligned(x, y, str, color);

   313

	GfxFillRect(x - w, y + 10, x, y + 10, _string_colorremap[1]);

   314

}

   315

   316

   317

int DrawStringCentered(int x, int y, StringID str, uint16 color)

   318

{

   319

	char buffer[512];

   320

	int w;

   321

   322

	GetString(buffer, str, lastof(buffer));

   323

   324

	w = GetStringBoundingBox(buffer).width;

   325

	DoDrawString(buffer, x - w / 2, y, color);

   326

   327

	return w;

   328

}

   329

   330

int DrawStringCenteredTruncated(int xl, int xr, int y, StringID str, uint16 color)

   331

{

   332

	char buffer[512];

   333

	int w = TruncateStringID(str, buffer, xr - xl, lastof(buffer));

   334

	return DoDrawString(buffer, (xl + xr - w) / 2, y, color);

   335

}

   336

   337

int DoDrawStringCentered(int x, int y, const char *str, uint16 color)

   338

{

   339

	int w = GetStringBoundingBox(str).width;

   340

	DoDrawString(str, x - w / 2, y, color);

   341

	return w;

   342

}

   343

   344

void DrawStringCenterUnderline(int x, int y, StringID str, uint16 color)

   345

{

   346

	int w = DrawStringCentered(x, y, str, color);

   347

	GfxFillRect(x - (w >> 1), y + 10, x - (w >> 1) + w, y + 10, _string_colorremap[1]);

   348

}

   349

   350

void DrawStringCenterUnderlineTruncated(int xl, int xr, int y, StringID str, uint16 color)

   351

{

   352

	int w = DrawStringCenteredTruncated(xl, xr, y, str, color);

   353

	GfxFillRect((xl + xr - w) / 2, y + 10, (xl + xr + w) / 2, y + 10, _string_colorremap[1]);

   354

}

   355

   356

/**

   357

 * 'Correct' a string to a maximum length. Longer strings will be cut into

   358

 * additional lines at whitespace characters if possible. The string parameter

   359

 * is modified with terminating characters mid-string which are the

   360

 * placeholders for the newlines.

   361

 * The string WILL be truncated if there was no whitespace for the current

   362

 * line's maximum width.

   363

 *

   364

 * @note To know if the terminating '\0' is the string end or just a

   365

 * newline, the returned 'num' value should be consulted. The num'th '\0',

   366

 * starting with index 0 is the real string end.

   367

 *

   368

 * @param str string to check and correct for length restrictions

   369

 * @param maxw the maximum width the string can have on one line

   370

 * @return return a 32bit wide number consisting of 2 packed values:

   371

 *  0 - 15 the number of lines ADDED to the string

   372

 * 16 - 31 the fontsize in which the length calculation was done at

   373

 */

   374

uint32 FormatStringLinebreaks(char *str, int maxw)

   375

{

   376

	FontSize size = _cur_fontsize;

   377

	int num = 0;

   378

   379

	assert(maxw > 0);

   380

   381

	for (;;) {

   382

		char *last_space = NULL;

   383

		int w = 0;

   384

   385

		for (;;) {

   386

			WChar c = Utf8Consume((const char **)&str);

   387

			/* whitespace is where we will insert the line-break */

   388

			if (IsWhitespace(c)) last_space = str;

   389

   390

			if (IsPrintable(c)) {

   391

				w += GetCharacterWidth(size, c);

   392

				/* string is longer than maximum width so we need to decide what to

   393

				 * do. We can do two things:

   394

				 * 1. If no whitespace was found at all up until now (on this line) then

   395

				 *    we will truncate the string and bail out.

   396

				 * 2. In all other cases force a linebreak at the last seen whitespace */

   397

				if (w > maxw) {

   398

					if (last_space == NULL) {

   399

						*Utf8PrevChar(str) = '\0';

   400

						return num + (size << 16);

   401

					}

   402

					str = last_space;

   403

					break;

   404

				}

   405

			} else {

   406

				switch (c) {

   407

					case '\0': return num + (size << 16); break;

   408

					case SCC_SETX:  str++; break;

   409

					case SCC_SETXY: str += 2; break;

   410

					case SCC_TINYFONT: size = FS_SMALL; break;

   411

					case SCC_BIGFONT:  size = FS_LARGE; break;

   412

					case '\n': goto end_of_inner_loop;

   413

				}

   414

			}

   415

		}

   416

end_of_inner_loop:

   417

		/* String didn't fit on line (or a '\n' was encountered), so 'dummy' terminate

   418

		 * and increase linecount. We use Utf8PrevChar() as also non 1 char long

   419

		 * whitespace seperators are supported */

   420

		num++;

   421

		char *s = Utf8PrevChar(str);

   422

		*s++ = '\0';

   423

   424

		/* In which case (see above) we will shift remainder to left and close the gap */

   425

		if (str - s >= 1) {

   426

			for (; str[-1] != '\0';) *s++ = *str++;

   427

		}

   428

	}

   429

}

   430

   431

/** Draw a given string with the centre around the given (x,y) coordinates

   432

 * @param x Centre the string around this pixel width

   433

 * @param y Centre the string around this pixel height

   434

 * @param str String to draw

   435

 * @param maxw Maximum width the string can have before it is wrapped */

   436

void DrawStringMultiCenter(int x, int y, StringID str, int maxw)

   437

{

   438

	char buffer[512];

   439

	uint32 tmp;

   440

	int num, w, mt;

   441

	const char *src;

   442

	WChar c;

   443

   444

	GetString(buffer, str, lastof(buffer));

   445

   446

	tmp = FormatStringLinebreaks(buffer, maxw);

   447

	num = GB(tmp, 0, 16);

   448

   449

	mt = GetCharacterHeight((FontSize)GB(tmp, 16, 16));

   450

   451

	y -= (mt >> 1) * num;

   452

   453

	src = buffer;

   454

   455

	for (;;) {

   456

		w = GetStringBoundingBox(src).width;

   457

		DoDrawString(src, x - (w >> 1), y, 0xFE);

   458

		_cur_fontsize = _last_fontsize;

   459

   460

		for (;;) {

   461

			c = Utf8Consume(&src);

   462

			if (c == 0) {

   463

				y += mt;

   464

				if (--num < 0) {

   465

					_cur_fontsize = FS_NORMAL;

   466

					return;

   467

				}

   468

				break;

   469

			} else if (c == SCC_SETX) {

   470

				src++;

   471

			} else if (c == SCC_SETXY) {

   472

				src += 2;

   473

			}

   474

		}

   475

	}

   476

}

   477

   478

   479

uint DrawStringMultiLine(int x, int y, StringID str, int maxw, int maxh)

   480

{

   481

	char buffer[512];

   482

	uint32 tmp;

   483

	int num, mt;

   484

	uint total_height;

   485

	const char *src;

   486

	WChar c;

   487