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

    21

#include "table/palettes.h"

    22

#include "table/sprites.h"

    23

#include "table/control_codes.h"

    24

    25

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

    26

bool _fullscreen;

    27

CursorVars _cursor;

    28

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    29

bool _shift_pressed;  ///< Is Shift pressed?

    30

byte _fast_forward;

    31

bool _left_button_down;

    32

bool _left_button_clicked;

    33

bool _right_button_down;

    34

bool _right_button_clicked;

    35

DrawPixelInfo _screen;

    36

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

    37

bool _exit_game;

    38

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

    39

byte _game_mode;

    40

int8 _pause_game;

    41

int _pal_first_dirty;

    42

int _pal_count_dirty;

    43

    44

Colour _cur_palette[256];

    45

byte _stringwidth_table[FS_END][224];

    46

DrawPixelInfo *_cur_dpi;

    47

byte _colour_gradient[16][8];

    48

bool _use_dos_palette;

    49

    50

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

    51

    52

FontSize _cur_fontsize;

    53

static FontSize _last_fontsize;

    54

static uint8 _cursor_backup[64 * 64 * 4];

    55

    56

/**

    57

 * The rect for repaint.

    58

 *

    59

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

    60

 *

    61

 * @ingroup dirty

    62

 */

    63

static Rect _invalid_rect;

    64

static const byte *_color_remap_ptr;

    65

static byte _string_colorremap[3];

    66

    67

#define DIRTY_BYTES_PER_LINE (MAX_SCREEN_WIDTH / 64)

    68

static byte _dirty_blocks[DIRTY_BYTES_PER_LINE * MAX_SCREEN_HEIGHT / 8];

    69

    70

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

    71

{

    72

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    73

    74

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

    75

    76

	if (_cursor.visible) UndrawMouseCursor();

    77

	UndrawChatMessage();

    78

    79

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

    80

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

    81

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

    82

}

    83

    84

    85

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

    86

{

    87

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    88

	const DrawPixelInfo *dpi = _cur_dpi;

    89

	void *dst;

    90

	const int otop = top;

    91

	const int oleft = left;

    92

    93

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

    94

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

    95

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

    96

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

    97

    98

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

    99

	right = right - dpi->left + 1;

   100

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

   101

	right -= left;

   102

	assert(right > 0);

   103

   104

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

   105

	bottom = bottom - dpi->top + 1;

   106

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

   107

	bottom -= top;

   108

	assert(bottom > 0);

   109

   110

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

   111

   112

	if (!HasBit(color, PALETTE_MODIFIER_GREYOUT)) {

   113

		if (!HasBit(color, USE_COLORTABLE)) {

   114

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

   115

		} else {

   116

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

   117

		}

   118

	} else {

   119

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

   120

		do {

   121

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

   122

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

   123

		} while (--bottom > 0);

   124

	}

   125

}

   126

   127

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

   128

{

   129

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   130

	DrawPixelInfo *dpi = _cur_dpi;

   131

   132

	x -= dpi->left;

   133

	x2 -= dpi->left;

   134

	y -= dpi->top;

   135

	y2 -= dpi->top;

   136

   137

	/* Check clipping */

   138

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

   139

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

   140

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

   141

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

   142

   143

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

   144

}

   145

   146

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

   147

{

   148

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   149

	DrawPixelInfo *dpi = _cur_dpi;

   150

   151

	x -= dpi->left;

   152

	x2 -= dpi->left;

   153

	y -= dpi->top;

   154

	y2 -= dpi->top;

   155

   156

	/* Check clipping */

   157

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

   158

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

   159

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

   160

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

   161

   162

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

   163

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

   164

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

   165

}

   166

   167

/**

   168

 * Draws the projection of a parallelepiped.

   169

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

   170

 *

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

 */

   180

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

   181

{

   182

	/*           ....

   183

	 *         ..    ....

   184

	 *       ..          ....

   185

	 *     ..                ^

   186

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

   187

	 *   :    --__       /   :

   188

	 *   :        --__ /     :

   189

	 *   :            *(x,y) :

   190

	 *   :            |      :

   191

	 *   :            |     ..

   192

	 *    ....        |(dx3,dy3)

   193

	 *        ....    | ..

   194

	 *            ....V.

   195

	 */

   196

   197

	static const byte color = 255;

   198

   199

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

   200

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

   201

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

   202

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

}

   210

   211

   212

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

   213

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

   214

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

   215

 * @param maxw maximum width in pixels of the string

   216

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

   217

static int TruncateString(char *str, int maxw)

   218

{

   219

	int w = 0;

   220

	FontSize size = _cur_fontsize;

   221

	int ddd, ddd_w;

   222

   223

	WChar c;

   224

	char *ddd_pos;

   225

   226

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

   227

   228

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

   229

		if (IsPrintable(c)) {

   230

			w += GetCharacterWidth(size, c);

   231

   232

			if (w >= maxw) {

   233

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

   234

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

   235

				ddd_pos[3] = '\0';

   236

				return ddd_w;

   237

			}

   238

		} else {

   239

			if (c == SCC_SETX) str++;

   240

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

   241

			else if (c == SCC_TINYFONT) {

   242

				size = FS_SMALL;

   243

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

   244

			} else if (c == SCC_BIGFONT) {

   245

				size = FS_LARGE;

   246

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

   247

			}

   248

		}

   249

   250

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

   251

		if (w + ddd < maxw) {

   252

			ddd_w = w + ddd;

   253

			ddd_pos = str;

   254

		}

   255

	}

   256

   257

	return w;

   258

}

   259

   260

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

   261

{

   262

	GetString(dest, src, last);

   263

	return TruncateString(dest, maxw);

   264

}

   265

   266

/* returns right coordinate */

   267

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

   268

{

   269

	char buffer[512];

   270

   271

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

   272

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

   273

}

   274

   275

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

   276

{

   277

	char buffer[512];

   278

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

   279

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

   280

}

   281

   282

   283

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

   284

{

   285

	char buffer[512];

   286

	int w;

   287

   288

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

   289

	w = GetStringBoundingBox(buffer).width;

   290

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

   291

   292

	return w;

   293

}

   294

   295

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

   296

{

   297

	char buffer[512];

   298

   299

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

   300

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

   301

}

   302

   303

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

   304

{

   305

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

   306

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

   307

}

   308

   309

   310

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

   311

{

   312

	char buffer[512];

   313

	int w;

   314

   315

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

   316

   317

	w = GetStringBoundingBox(buffer).width;

   318

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

   319

   320

	return w;

   321

}

   322

   323

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

   324

{

   325

	char buffer[512];

   326

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

   327

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

   328

}

   329

   330

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

   331

{

   332

	int w = GetStringBoundingBox(str).width;

   333

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

   334

	return w;

   335

}

   336

   337

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

   338

{

   339

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

   340

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

   341

}

   342

   343

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

   344

{

   345

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

   346

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

   347

}

   348

   349

/**

   350

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

   351

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

   352

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

   353

 * placeholders for the newlines.

   354

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

   355

 * line's maximum width.

   356

 *

   357

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

   358

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

   359

 * starting with index 0 is the real string end.

   360

 *

   361

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

   362

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

   363

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

   364

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

   365

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

   366

 */

   367

uint32 FormatStringLinebreaks(char *str, int maxw)

   368

{

   369

	FontSize size = _cur_fontsize;

   370

	int num = 0;

   371

   372

	assert(maxw > 0);

   373

   374

	for (;;) {

   375

		char *last_space = NULL;

   376

		int w = 0;

   377

   378

		for (;;) {

   379

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

   380

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

   381

			if (IsWhitespace(c)) last_space = str;

   382

   383

			if (IsPrintable(c)) {

   384

				w += GetCharacterWidth(size, c);

   385

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

   386

				 * do. We can do two things:

   387

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

   388

				 *    we will truncate the string and bail out.

   389

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

   390

				if (w > maxw) {

   391

					if (last_space == NULL) {

   392

						*Utf8PrevChar(str) = '\0';

   393

						return num + (size << 16);

   394

					}

   395

					str = last_space;

   396

					break;

   397

				}

   398

			} else {

   399

				switch (c) {

   400

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

   401

					case SCC_SETX:  str++; break;

   402

					case SCC_SETXY: str += 2; break;

   403

					case SCC_TINYFONT: size = FS_SMALL; break;

   404

					case SCC_BIGFONT:  size = FS_LARGE; break;

   405

					case '\n': goto end_of_inner_loop;

   406

				}

   407

			}

   408

		}

   409

end_of_inner_loop:

   410

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

   411

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

   412

		 * whitespace seperators are supported */

   413

		num++;

   414

		char *s = Utf8PrevChar(str);

   415

		*s++ = '\0';

   416

   417

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

   418

		if (str - s >= 1) {

   419

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

   420

		}

   421

	}

   422

}

   423

   424

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

   425

 * @param x Centre the string around this pixel width

   426

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

   427

 * @param str String to draw

   428

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

   429

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

   430

{

   431

	char buffer[512];

   432

	uint32 tmp;

   433

	int num, w, mt;

   434

	const char *src;

   435

	WChar c;

   436

   437

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

   438

   439

	tmp = FormatStringLinebreaks(buffer, maxw);

   440

	num = GB(tmp, 0, 16);

   441

   442

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

   443

   444

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

   445

   446

	src = buffer;

   447

   448

	for (;;) {

   449

		w = GetStringBoundingBox(src).width;

   450

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

   451

		_cur_fontsize = _last_fontsize;

   452

   453

		for (;;) {

   454

			c = Utf8Consume(&src);

   455

			if (c == 0) {

   456

				y += mt;

   457

				if (--num < 0) {

   458

					_cur_fontsize = FS_NORMAL;

   459

					return;

   460

				}

   461

				break;

   462

			} else if (c == SCC_SETX) {

   463

				src++;

   464

			} else if (c == SCC_SETXY) {

   465

				src += 2;

   466

			}

   467

		}

   468

	}

   469

}

   470

   471

   472

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

   473

{

   474

	char buffer[512];

   475

	uint32 tmp;

   476

	int num, mt;

   477

	uint total_height;

   478

	const char *src;

   479

	WChar c;

   480

   481

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

   482

   483

	tmp = FormatStringLinebreaks(buffer, maxw);

   484

	num = GB(tmp, 0, 16);

   485

   486

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