1

/* $Id$ */

     2

     3

/** @file gfx.cpp */

     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

    22

#include "table/palettes.h"

    23

#include "table/sprites.h"

    24

#include "table/control_codes.h"

    25

    26

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

    27

bool _fullscreen;

    28

CursorVars _cursor;

    29

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    30

bool _shift_pressed;  ///< Is Shift pressed?

    31

byte _fast_forward;

    32

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

    33

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

    34

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

    35

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

    36

DrawPixelInfo _screen;

    37

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

    38

bool _exit_game;

    39

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

    40

byte _game_mode;

    41

int8 _pause_game;

    42

int _pal_first_dirty;

    43

int _pal_count_dirty;

    44

    45

Colour _cur_palette[256];

    46

byte _stringwidth_table[FS_END][224];

    47

DrawPixelInfo *_cur_dpi;

    48

byte _colour_gradient[16][8];

    49

bool _use_dos_palette;

    50

    51

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

    52

    53

FontSize _cur_fontsize;

    54

static FontSize _last_fontsize;

    55

static uint8 _cursor_backup[64 * 64 * 4];

    56

    57

/**

    58

 * The rect for repaint.

    59

 *

    60

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

    61

 *

    62

 * @ingroup dirty

    63

 */

    64

static Rect _invalid_rect;

    65

static const byte *_color_remap_ptr;

    66

static byte _string_colorremap[3];

    67

    68

enum {

    69

	DIRTY_BLOCK_HEIGHT   = 8,

    70

	DIRTY_BLOCK_WIDTH    = 64,

    71

};

    72

static uint _dirty_bytes_per_line = 0;

    73

static byte *_dirty_blocks = NULL;

    74

    75

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

    76

{

    77

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    78

    79

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

    80

    81

	if (_cursor.visible) UndrawMouseCursor();

    82

	UndrawChatMessage();

    83

    84

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

    85

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

    86

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

    87

}

    88

    89

    90

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

    91

{

    92

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    93

	const DrawPixelInfo *dpi = _cur_dpi;

    94

	void *dst;

    95

	const int otop = top;

    96

	const int oleft = left;

    97

    98

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

    99

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

   100

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

   101

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

   102

   103

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

   104

	right = right - dpi->left + 1;

   105

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

   106

	right -= left;

   107

	assert(right > 0);

   108

   109

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

   110

	bottom = bottom - dpi->top + 1;

   111

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

   112

	bottom -= top;

   113

	assert(bottom > 0);

   114

   115

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

   116

   117

	if (!HasBit(color, PALETTE_MODIFIER_GREYOUT)) {

   118

		if (!HasBit(color, USE_COLORTABLE)) {

   119

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

   120

		} else {

   121

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

   122

		}

   123

	} else {

   124

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

   125

		do {

   126

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

   127

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

   128

		} while (--bottom > 0);

   129

	}

   130

}

   131

   132

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

   133

{

   134

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   135

	DrawPixelInfo *dpi = _cur_dpi;

   136

   137

	x -= dpi->left;

   138

	x2 -= dpi->left;

   139

	y -= dpi->top;

   140

	y2 -= dpi->top;

   141

   142

	/* Check clipping */

   143

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

   144

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

   145

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

   146

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

   147

   148

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

   149

}

   150

   151

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

   152

{

   153

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   154

	DrawPixelInfo *dpi = _cur_dpi;

   155

   156

	x -= dpi->left;

   157

	x2 -= dpi->left;

   158

	y -= dpi->top;

   159

	y2 -= dpi->top;

   160

   161

	/* Check clipping */

   162

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

   163

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

   164

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

   165

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

   166

   167

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

   168

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

   169

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

   170

}

   171

   172

/**

   173

 * Draws the projection of a parallelepiped.

   174

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

   175

 *

   176

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

   177

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

   178

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

   179

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

   180

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

   181

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

   182

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

   183

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

   184

 */

   185

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

   186

{

   187

	/*           ....

   188

	 *         ..    ....

   189

	 *       ..          ....

   190

	 *     ..                ^

   191

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

   192

	 *   :    --__       /   :

   193

	 *   :        --__ /     :

   194

	 *   :            *(x,y) :

   195

	 *   :            |      :

   196

	 *   :            |     ..

   197

	 *    ....        |(dx3,dy3)

   198

	 *        ....    | ..

   199

	 *            ....V.

   200

	 */

   201

   202

	static const byte color = 255;

   203

   204

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

   205

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

   206

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

   207

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

}

   215

   216

   217

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

   218

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

   219

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

   220

 * @param maxw maximum width in pixels of the string

   221

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

   222

static int TruncateString(char *str, int maxw)

   223

{

   224

	int w = 0;

   225

	FontSize size = _cur_fontsize;

   226

	int ddd, ddd_w;

   227

   228

	WChar c;

   229

	char *ddd_pos;

   230

   231

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

   232

   233

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

   234

		if (IsPrintable(c)) {

   235

			w += GetCharacterWidth(size, c);

   236

   237

			if (w >= maxw) {

   238

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

   239

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

   240

				ddd_pos[3] = '\0';

   241

				return ddd_w;

   242

			}

   243

		} else {

   244

			if (c == SCC_SETX) str++;

   245

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

   246

			else if (c == SCC_TINYFONT) {

   247

				size = FS_SMALL;

   248

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

   249

			} else if (c == SCC_BIGFONT) {

   250

				size = FS_LARGE;

   251

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

   252

			}

   253

		}

   254

   255

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

   256

		if (w + ddd < maxw) {

   257

			ddd_w = w + ddd;

   258

			ddd_pos = str;

   259

		}

   260

	}

   261

   262

	return w;

   263

}

   264

   265

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

   266

{

   267

	GetString(dest, src, last);

   268

	return TruncateString(dest, maxw);

   269

}

   270

   271

/* returns right coordinate */

   272

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

   273

{

   274

	char buffer[512];

   275

   276

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

   277

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

   278

}

   279

   280

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

   281

{

   282

	char buffer[512];

   283

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

   284

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

   285

}

   286

   287

   288

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

   289

{

   290

	char buffer[512];

   291

	int w;

   292

   293

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

   294

	w = GetStringBoundingBox(buffer).width;

   295

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

   296

   297

	return w;

   298

}

   299

   300

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

   301

{

   302

	char buffer[512];

   303

   304

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

   305

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

   306

}

   307

   308

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

   309

{

   310

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

   311

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

   312

}

   313

   314

   315

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

   316

{

   317

	char buffer[512];

   318

	int w;

   319

   320

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

   321

   322

	w = GetStringBoundingBox(buffer).width;

   323

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

   324

   325

	return w;

   326

}

   327

   328

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

   329

{

   330

	char buffer[512];

   331

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

   332

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

   333

}

   334

   335

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

   336

{

   337

	int w = GetStringBoundingBox(str).width;

   338

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

   339

	return w;

   340

}

   341

   342

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

   343

{

   344

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

   345

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

   346

}

   347

   348

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

   349

{

   350

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

   351

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

   352

}

   353

   354

/**

   355

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

   356

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

   357

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

   358

 * placeholders for the newlines.

   359

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

   360

 * line's maximum width.

   361

 *

   362

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

   363

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

   364

 * starting with index 0 is the real string end.

   365

 *

   366

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

   367

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

   368

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

   369

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

   370

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

   371

 */

   372

uint32 FormatStringLinebreaks(char *str, int maxw)

   373

{

   374

	FontSize size = _cur_fontsize;

   375

	int num = 0;

   376

   377

	assert(maxw > 0);

   378

   379

	for (;;) {

   380

		char *last_space = NULL;

   381

		int w = 0;

   382

   383

		for (;;) {

   384

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

   385

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

   386

			if (IsWhitespace(c)) last_space = str;

   387

   388

			if (IsPrintable(c)) {

   389

				w += GetCharacterWidth(size, c);

   390

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

   391

				 * do. We can do two things:

   392

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

   393

				 *    we will truncate the string and bail out.

   394

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

   395

				if (w > maxw) {

   396

					if (last_space == NULL) {

   397

						*Utf8PrevChar(str) = '\0';

   398

						return num + (size << 16);

   399

					}

   400

					str = last_space;

   401

					break;

   402

				}

   403

			} else {

   404

				switch (c) {

   405

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

   406

					case SCC_SETX:  str++; break;

   407

					case SCC_SETXY: str += 2; break;

   408

					case SCC_TINYFONT: size = FS_SMALL; break;

   409

					case SCC_BIGFONT:  size = FS_LARGE; break;

   410

					case '\n': goto end_of_inner_loop;

   411

				}

   412

			}

   413

		}

   414

end_of_inner_loop:

   415

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

   416

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

   417

		 * whitespace seperators are supported */

   418

		num++;

   419

		char *s = Utf8PrevChar(str);

   420

		*s++ = '\0';

   421

   422

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

   423

		if (str - s >= 1) {

   424

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

   425

		}

   426

	}

   427

}

   428

   429

/** Draw a given string with the centre around the given x coordinates

   430

 * @param x Centre the string around this pixel width

   431

 * @param y Draw the string at this pixel height (first line's bottom)

   432

 * @param str String to draw

   433

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

   434

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

   435

{

   436

	char buffer[512];

   437

	uint32 tmp;

   438

	int num, w, mt;

   439

	const char *src;

   440

	WChar c;

   441

   442

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

   443

   444

	tmp = FormatStringLinebreaks(buffer, maxw);

   445

	num = GB(tmp, 0, 16);

   446

   447

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

   448

   449

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

   450

   451

	src = buffer;

   452

   453

	for (;;) {

   454

		w = GetStringBoundingBox(src).width;

   455

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

   456

		_cur_fontsize = _last_fontsize;

   457

   458

		for (;;) {

   459

			c = Utf8Consume(&src);

   460

			if (c == 0) {

   461

				y += mt;

   462

				if (--num < 0) {

   463

					_cur_fontsize = FS_NORMAL;

   464

					return;

   465

				}

   466

				break;

   467

			} else if (c == SCC_SETX) {

   468

				src++;

   469

			} else if (c == SCC_SETXY) {

   470

				src += 2;

   471

			}

   472

		}

   473

	}

   474

}

   475

   476

   477

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

   478

{

   479

	char buffer[512];

   480

	uint32 tmp;

   481

	int num, mt;

   482

	uint total_height;

   483

	const char *src;

   484

	WChar c;

   485

   486

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