1

/* $Id$ */

     2

     3

/** @file gfx.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "spritecache.h"

    10

#include "strings.h"

    11

#include "string.h"

    12

#include "gfx.h"

    13

#include "table/palettes.h"

    14

#include "table/sprites.h"

    15

#include "hal.h"

    16

#include "variables.h"

    17

#include "table/control_codes.h"

    18

#include "fontcache.h"

    19

#include "genworld.h"

    20

#include "debug.h"

    22

    23

#ifdef _DEBUG

    24

bool _dbg_screen_rect;

    25

#endif

    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;

    34

bool _left_button_clicked;

    35

bool _right_button_down;

    36

bool _right_button_clicked;

    37

DrawPixelInfo _screen;

    38

bool _exit_game;

    39

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

    40

byte _game_mode;

    41

byte _pause_game;

    42

int _pal_first_dirty;

    43

int _pal_last_dirty;

    44

    45

Colour _cur_palette[256];

    46

byte _stringwidth_table[FS_END][224];

    47

    48

enum BlitterMode {

    49

	BM_NORMAL,

    50

	BM_COLOUR_REMAP,

    51

	BM_TRANSPARENT,

    52

};

    53

    54

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

    55

    56

FontSize _cur_fontsize;

    57

static FontSize _last_fontsize;

    58

static Pixel _cursor_backup[64 * 64];

    59

static Rect _invalid_rect;

    60

static const byte *_color_remap_ptr;

    61

static byte _string_colorremap[3];

    62

    63

#define DIRTY_BYTES_PER_LINE (MAX_SCREEN_WIDTH / 64)

    64

static byte _dirty_blocks[DIRTY_BYTES_PER_LINE * MAX_SCREEN_HEIGHT / 8];

    65

    66

void memcpy_pitch(void *dst, void *src, int w, int h, int srcpitch, int dstpitch)

    67

{

    68

	Pixel *dstp = (Pixel *)dst;

    69

	Pixel *srcp = (Pixel *)src;

    70

    71

	assert(h >= 0);

    72

	for (; h != 0; --h) {

    73

		memcpy(dstp, srcp, w * sizeof(Pixel));

    74

		dstp += dstpitch;

    75

		srcp += srcpitch;

    76

	}

    77

}

    78

    79

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

    80

{

    81

	const Pixel *src;

    82

	Pixel *dst;

    83

	int p;

    84

	int ht;

    85

    86

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

    87

    88

	if (_cursor.visible) UndrawMouseCursor();

    89

	UndrawTextMessage();

    90

    91

	p = _screen.pitch;

    92

    93

	if (yo > 0) {

    94

		/*Calculate pointers */

    95

		dst = _screen.dst_ptr + (top + height - 1) * p + left;

    96

		src = dst - yo * p;

    97

    98

		/* Decrease height and increase top */

    99

		top += yo;

   100

		height -= yo;

   101

		assert(height > 0);

   102

   103

		/* Adjust left & width */

   104

		if (xo >= 0) {

   105

			dst += xo;

   106

			left += xo;

   107

			width -= xo;

   108

		} else {

   109

			src -= xo;

   110

			width += xo;

   111

		}

   112

   113

		for (ht = height; ht > 0; --ht) {

   114

			memcpy(dst, src, width * sizeof(Pixel));

   115

			src -= p;

   116

			dst -= p;

   117

		}

   118

	} else {

   119

		/* Calculate pointers */

   120

		dst = _screen.dst_ptr + top * p + left;

   121

		src = dst - yo * p;

   122

   123

		/* Decrese height. (yo is <=0). */

   124

		height += yo;

   125

		assert(height > 0);

   126

   127

		/* Adjust left & width */

   128

		if (xo >= 0) {

   129

			dst += xo;

   130

			left += xo;

   131

			width -= xo;

   132

		} else {

   133

			src -= xo;

   134

			width += xo;

   135

		}

   136

   137

		/* the y-displacement may be 0 therefore we have to use memmove,

   138

		 * because source and destination may overlap */

   139

		for (ht = height; ht > 0; --ht) {

   140

			memmove(dst, src, width * sizeof(Pixel));

   141

			src += p;

   142

			dst += p;

   143

		}

   144

	}

   145

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

   146

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

   147

}

   148

   149

   150

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

   151

{

   152

	const DrawPixelInfo* dpi = _cur_dpi;

   153

	Pixel *dst;

   154

	const int otop = top;

   155

	const int oleft = left;

   156

   158

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

   159

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

   160

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

   161

   162

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

   163

	right = right - dpi->left + 1;

   164

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

   165

	right -= left;

   166

	assert(right > 0);

   167

   168

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

   169

	bottom = bottom - dpi->top + 1;

   170

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

   171

	bottom -= top;

   172

	assert(bottom > 0);

   173

   174

	dst = dpi->dst_ptr + top * dpi->pitch + left;

   175

   176

	if (!HASBIT(color, PALETTE_MODIFIER_GREYOUT)) {

   177

		if (!HASBIT(color, USE_COLORTABLE)) {

   178

			do {

   179

				memset(dst, color, right * sizeof(Pixel));

   180

				dst += dpi->pitch;

   181

			} while (--bottom);

   182

		} else {

   183

			/* use colortable mode */

   184

			const byte* ctab = GetNonSprite(GB(color, 0, PALETTE_WIDTH)) + 1;

   185

   186

			do {

   187

				int i;

   188

				for (i = 0; i != right; i++) dst[i] = ctab[dst[i]];

   189

				dst += dpi->pitch;

   190

			} while (--bottom);

   191

		}

   192

	} else {

   193

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

   194

		do {

   195

			int i;

   196

			for (i = (bo ^= 1); i < right; i += 2) dst[i] = (byte)color;

   197

			dst += dpi->pitch;

   198

		} while (--bottom > 0);

   199

	}

   200

}

   201

   202

static void GfxSetPixel(int x, int y, int color)

   203

{

   204

	const DrawPixelInfo* dpi = _cur_dpi;

   205

	if ((x -= dpi->left) < 0 || x >= dpi->width || (y -= dpi->top)<0 || y >= dpi->height)

   206

		return;

   207

	dpi->dst_ptr[y * dpi->pitch + x] = color;

   208

}

   209

   210

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

   211

{

   212

	int dy;

   213

	int dx;

   214

	int stepx;

   215

	int stepy;

   216

	int frac;

   217

   218

	/* Check clipping first */

   219

	{

   220

		DrawPixelInfo *dpi = _cur_dpi;

   221

		int t;

   222

   223

		if (x < dpi->left && x2 < dpi->left) return;

   224

   225

		if (y < dpi->top && y2 < dpi->top) return;

   226

   227

		t = dpi->left + dpi->width;

   228

		if (x > t && x2 > t) return;

   229

   230

		t = dpi->top + dpi->height;

   231

		if (y > t && y2 > t) return;

   232

	}

   233

   234

	dy = (y2 - y) * 2;

   235

	if (dy < 0) {

   236

		dy = -dy;

   237

		stepy = -1;

   238

	} else {

   239

		stepy = 1;

   240

	}

   241

   242

	dx = (x2 - x) * 2;

   243

	if (dx < 0) {

   244

		dx = -dx;

   245

		stepx = -1;

   246

	} else {

   247

		stepx = 1;

   248

	}

   249

   250

	GfxSetPixel(x, y, color);

   251

	if (dx > dy) {

   252

		frac = dy - (dx >> 1);

   253

		while (x != x2) {

   254

			if (frac >= 0) {

   255

				y += stepy;

   256

				frac -= dx;

   257

			}

   258

			x += stepx;

   259

			frac += dy;

   260

			GfxSetPixel(x, y, color);

   261

		}

   262

	} else {

   263

		frac = dx - (dy >> 1);

   264

		while (y != y2) {

   265

			if (frac >= 0) {

   266

				x += stepx;

   267

				frac -= dy;

   268

			}

   269

			y += stepy;

   270

			frac += dx;

   271

			GfxSetPixel(x, y, color);

   272

		}

   273

	}

   274

}

   275

   276

   277

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

   278

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

   279

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

   280

 * @param maxw maximum width in pixels of the string

   281

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

   282

static int TruncateString(char *str, int maxw)

   283

{

   284

	int w = 0;

   285

	FontSize size = _cur_fontsize;

   286

	int ddd, ddd_w;

   287

   288

	WChar c;

   289

	char *ddd_pos;

   290

   291

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

   292

   293

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

   294

		if (IsPrintable(c)) {

   295

			w += GetCharacterWidth(size, c);

   296

   297

			if (w >= maxw) {

   298

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

   299

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

   300

				ddd_pos[3] = '\0';

   301

				return ddd_w;

   302

			}

   303

		} else {

   304

			if (c == SCC_SETX) str++;

   305

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

   306

			else if (c == SCC_TINYFONT) {

   307

				size = FS_SMALL;

   308

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

   309

			} else if (c == SCC_BIGFONT) {

   310

				size = FS_LARGE;

   311

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

   312

			}

   313

		}

   314

   315

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

   316

		if (w + ddd < maxw) {

   317

			ddd_w = w + ddd;

   318

			ddd_pos = str;

   319

		}

   320

	}

   321

   322

	return w;

   323

}

   324

   325

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

   326

{

   327

	GetString(dest, src, last);

   328

	return TruncateString(dest, maxw);

   329

}

   330

   331

/* returns right coordinate */

   332

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

   333

{

   334

	char buffer[512];

   335

   336

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

   337

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

   338

}

   339

   340

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

   341

{

   342

	char buffer[512];

   343

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

   344

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

   345

}

   346

   347

   348

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

   349

{

   350

	char buffer[512];

   351

	int w;

   352

   353

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

   354

	w = GetStringBoundingBox(buffer).width;

   355

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

   356

   357

	return w;

   358

}

   359

   360

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

   361

{

   362

	char buffer[512];

   363

   364

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

   365

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

   366

}

   367

   368

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

   369

{

   370

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

   371

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

   372

}

   373

   374

   375

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

   376

{

   377

	char buffer[512];

   378

	int w;

   379

   380

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

   381

   382

	w = GetStringBoundingBox(buffer).width;

   383

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

   384

   385

	return w;

   386

}

   387

   388

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

   389

{

   390

	char buffer[512];

   391

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

   392

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

   393

}

   394

   395

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

   396

{

   397

	int w = GetStringBoundingBox(str).width;

   398

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

   399

	return w;

   400

}

   401

   402

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

   403

{

   404

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

   405

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

   406

}

   407

   408

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

   409

{

   410

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

   411

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

   412

}

   413

   414

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

   415

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

   416

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

   417

 * placeholders for the newlines.

   418

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

   419

 * line's maximum width.

   420

 *

   421

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

   422

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

   423

 * starting with index 0 is the real string end.

   424

 *

   425

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

   426

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

   427

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

   428

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

   429

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

   430

uint32 FormatStringLinebreaks(char *str, int maxw)

   431

{

   432

	FontSize size = _cur_fontsize;

   433

	int num = 0;

   434

   435

	assert(maxw > 0);

   436

   437

	for (;;) {

   438

		char *last_space = NULL;

   439

		int w = 0;

   440

   441

		for (;;) {

   442

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

   443

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

   444

			if (IsWhitespace(c)) last_space = str;

   445

   446

			if (IsPrintable(c)) {

   447

				w += GetCharacterWidth(size, c);

   448

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

   449

				 * do. We can do two things:

   450

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

   451

				 *    we will truncate the string and bail out.

   452

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

   453

				if (w > maxw) {

   454

					if (last_space == NULL) {

   455

						*Utf8PrevChar(str) = '\0';

   456

						return num + (size << 16);

   457

					}

   458

					str = last_space;

   459

					break;

   460

				}

   461

			} else {

   462

				switch (c) {

   463

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

   464

					case SCC_SETX:  str++; break;

   465

					case SCC_SETXY: str += 2; break;

   466

					case SCC_TINYFONT: size = FS_SMALL; break;

   467

					case SCC_BIGFONT:  size = FS_LARGE; break;

   468

					case '\n': goto end_of_inner_loop;

   469

				}

   470

			}

   471

		}

   472

end_of_inner_loop:

   473

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

   474

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

   475

		 * whitespace seperators are supported */

   476

		num++;

   477

		char *s = Utf8PrevChar(str);

   478

		*s++ = '\0';

   479

   480

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

   481

		if (str - s >= 1) {

   482

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

   483

		}

   484

	}

   485

}

   486

   487

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

   488

 * @param x Centre the string around this pixel width

   489

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

   490

 * @param str String to draw

   491

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