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"

    21

#include "landscape_type.h"

    22

    23

#include "table/palettes.h"

    24

#include "table/sprites.h"

    25

#include "table/control_codes.h"

    26

    27

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

    28

bool _fullscreen;

    29

CursorVars _cursor;

    30

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    31

bool _shift_pressed;  ///< Is Shift pressed?

    32

byte _fast_forward;

    33

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

    34

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

    35

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

    36

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

    37

DrawPixelInfo _screen;

    38

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

    39

bool _exit_game;

    40

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

    41

byte _game_mode;

    42

int8 _pause_game;

    43

int _pal_first_dirty;

    44

int _pal_count_dirty;

    45

    46

Colour _cur_palette[256];

    47

byte _stringwidth_table[FS_END][224];

    48

DrawPixelInfo *_cur_dpi;

    49

byte _colour_gradient[16][8];

    50

bool _use_dos_palette;

    51

    52

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

    53

    54

FontSize _cur_fontsize;

    55

static FontSize _last_fontsize;

    56

static uint8 _cursor_backup[64 * 64 * 4];

    57

    58

/**

    59

 * The rect for repaint.

    60

 *

    61

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

    62

 *

    63

 * @ingroup dirty

    64

 */

    65

static Rect _invalid_rect;

    66

static const byte *_color_remap_ptr;

    67

static byte _string_colorremap[3];

    68

    69

enum {

    70

	DIRTY_BLOCK_HEIGHT   = 8,

    71

	DIRTY_BLOCK_WIDTH    = 64,

    72

};

    73

static uint _dirty_bytes_per_line = 0;

    74

static byte *_dirty_blocks = NULL;

    75

    76

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

    77

{

    78

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    79

    80

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

    81

    82

	if (_cursor.visible) UndrawMouseCursor();

    83

	UndrawChatMessage();

    84

    85

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

    86

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

    87

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

    88

}

    89

    90

    91

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

    92

{

    93

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    94

	const DrawPixelInfo *dpi = _cur_dpi;

    95

	void *dst;

    96

	const int otop = top;

    97

	const int oleft = left;

    98

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

	right = right - dpi->left + 1;

   106

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

   107

	right -= left;

   108

	assert(right > 0);

   109

   110

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

   111

	bottom = bottom - dpi->top + 1;

   112

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

   113

	bottom -= top;

   114

	assert(bottom > 0);

   115

   116

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

   117

   118

	if (!HasBit(color, PALETTE_MODIFIER_GREYOUT)) {

   119

		if (!HasBit(color, USE_COLORTABLE)) {

   120

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

   121

		} else {

   122

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

   123

		}

   124

	} else {

   125

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

   126

		do {

   127

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

   128

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

   129

		} while (--bottom > 0);

   130

	}

   131

}

   132

   133

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

   134

{

   135

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   136

	DrawPixelInfo *dpi = _cur_dpi;

   137

   138

	x -= dpi->left;

   139

	x2 -= dpi->left;

   140

	y -= dpi->top;

   141

	y2 -= dpi->top;

   142

   143

	/* Check clipping */

   144

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

   145

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

   146

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

   147

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

   148

   149

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

   150

}

   151

   152

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

   153

{

   154

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   155

	DrawPixelInfo *dpi = _cur_dpi;

   156

   157

	x -= dpi->left;

   158

	x2 -= dpi->left;

   159

	y -= dpi->top;

   160

	y2 -= dpi->top;

   161

   162

	/* Check clipping */

   163

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

   164

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

   165

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

   166

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

   167

   168

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

   169

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

   170

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

   171

}

   172

   173

/**

   174

 * Draws the projection of a parallelepiped.

   175

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

   176

 *

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

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

   185

 */

   186

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

   187

{

   188

	/*           ....

   189

	 *         ..    ....

   190

	 *       ..          ....

   191

	 *     ..                ^

   192

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

   193

	 *   :    --__       /   :

   194

	 *   :        --__ /     :

   195

	 *   :            *(x,y) :

   196

	 *   :            |      :

   197

	 *   :            |     ..

   198

	 *    ....        |(dx3,dy3)

   199

	 *        ....    | ..

   200

	 *            ....V.

   201

	 */

   202

   203

	static const byte color = 255;

   204

   205

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

   206

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

   207

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

   208

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

}

   216

   217

   218

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

   219

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

   220

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

   221

 * @param maxw maximum width in pixels of the string

   222

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

   223

static int TruncateString(char *str, int maxw)

   224

{

   225

	int w = 0;

   226

	FontSize size = _cur_fontsize;

   227

	int ddd, ddd_w;

   228

   229

	WChar c;

   230

	char *ddd_pos;

   231

   232

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

   233

   234

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

   235

		if (IsPrintable(c)) {

   236

			w += GetCharacterWidth(size, c);

   237

   238

			if (w >= maxw) {

   239

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

   240

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

   241

				ddd_pos[3] = '\0';

   242

				return ddd_w;

   243

			}

   244

		} else {

   245

			if (c == SCC_SETX) str++;

   246

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

   247

			else if (c == SCC_TINYFONT) {

   248

				size = FS_SMALL;

   249

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

   250

			} else if (c == SCC_BIGFONT) {

   251

				size = FS_LARGE;

   252

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

   253

			}

   254

		}

   255

   256

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

   257

		if (w + ddd < maxw) {

   258

			ddd_w = w + ddd;

   259

			ddd_pos = str;

   260

		}

   261

	}

   262

   263

	return w;

   264

}

   265

   266

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

   267

{

   268

	GetString(dest, src, last);

   269

	return TruncateString(dest, maxw);

   270

}

   271

   272

/* returns right coordinate */

   273

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

   274

{

   275

	char buffer[512];

   276

   277

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

   278

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

   279

}

   280

   281

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

   282

{

   283

	char buffer[512];

   284

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

   285

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

   286

}

   287

   288

   289

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

   290

{

   291

	char buffer[512];

   292

	int w;

   293

   294

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

   295

	w = GetStringBoundingBox(buffer).width;

   296

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

   297

   298

	return w;

   299

}

   300

   301

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

   302

{

   303

	char buffer[512];

   304

   305

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

   306

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

   307

}

   308

   309

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

   310

{

   311

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

   312

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

   313

}

   314

   315

   316

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

   317

{

   318

	char buffer[512];

   319

	int w;

   320

   321

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

   322

   323

	w = GetStringBoundingBox(buffer).width;

   324

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

   325

   326

	return w;

   327

}

   328

   329

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

   330

{

   331

	char buffer[512];

   332

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

   333

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

   334

}

   335

   336

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

   337

{

   338

	int w = GetStringBoundingBox(str).width;

   339

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

   340

	return w;

   341

}

   342

   343

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

   344

{

   345

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

   346

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

   347

}

   348

   349

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

   350

{

   351

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

   352

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

   353

}

   354

   355

/**

   356

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

   357

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

   358

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

   359

 * placeholders for the newlines.

   360

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

   361

 * line's maximum width.

   362

 *

   363

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

   364

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

   365

 * starting with index 0 is the real string end.

   366

 *

   367

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

   368

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

   369

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

   370

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

   371

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

   372

 */

   373

uint32 FormatStringLinebreaks(char *str, int maxw)

   374

{

   375

	FontSize size = _cur_fontsize;

   376

	int num = 0;

   377

   378

	assert(maxw > 0);

   379

   380

	for (;;) {

   381

		char *last_space = NULL;

   382

		int w = 0;

   383

   384

		for (;;) {

   385

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

   386

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

   387

			if (IsWhitespace(c)) last_space = str;

   388

   389

			if (IsPrintable(c)) {

   390

				w += GetCharacterWidth(size, c);

   391

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

   392

				 * do. We can do two things:

   393

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

   394

				 *    we will truncate the string and bail out.

   395

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

   396

				if (w > maxw) {

   397

					if (last_space == NULL) {

   398

						*Utf8PrevChar(str) = '\0';

   399

						return num + (size << 16);

   400

					}

   401

					str = last_space;

   402

					break;

   403

				}

   404

			} else {

   405

				switch (c) {

   406

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

   407

					case SCC_SETX:  str++; break;

   408

					case SCC_SETXY: str += 2; break;

   409

					case SCC_TINYFONT: size = FS_SMALL; break;

   410

					case SCC_BIGFONT:  size = FS_LARGE; break;

   411

					case '\n': goto end_of_inner_loop;

   412

				}

   413

			}

   414

		}

   415

end_of_inner_loop:

   416

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

   417

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

   418

		 * whitespace seperators are supported */

   419

		num++;

   420

		char *s = Utf8PrevChar(str);

   421

		*s++ = '\0';

   422

   423

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

   424

		if (str - s >= 1) {

   425

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

   426

		}

   427

	}

   428

}

   429

   430

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

   431

 * @param x Centre the string around this pixel width

   432

 * @param y Centre the string around this pixel height

   433

 * @param str String to draw

   434

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

   435

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

   436

{

   437

	char buffer[512];

   438

	uint32 tmp;

   439

	int num, w, mt;

   440

	const char *src;

   441

	WChar c;

   442

   443

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

   444

   445

	tmp = FormatStringLinebreaks(buffer, maxw);

   446

	num = GB(tmp, 0, 16);

   447

   448

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

   449

   450

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

   451

   452

	src = buffer;

   453

   454

	for (;;) {

   455

		w = GetStringBoundingBox(src).width;

   456

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

   457

		_cur_fontsize = _last_fontsize;

   458

   459

		for (;;) {

   460

			c = Utf8Consume(&src);

   461

			if (c == 0) {

   462

				y += mt;

   463

				if (--num < 0) {

   464

					_cur_fontsize = FS_NORMAL;

   465

					return;

   466

				}

   467

				break;

   468

			} else if (c == SCC_SETX) {

   469

				src++;

   470

			} else if (c == SCC_SETXY) {

   471

				src += 2;

   472

			}

   473

		}

   474

	}

   475

}

   476

   477

   478

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

   479

{

   480

	char buffer[512];

   481

	uint32 tmp;

   482

	int num, mt;

   483

	uint total_height;

   484

	const char *src;

   485

	WChar c;

   486