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"

    21

    22

#ifdef _DEBUG

    23

bool _dbg_screen_rect;

    24

#endif

    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;

    33

bool _left_button_clicked;

    34

bool _right_button_down;

    35

bool _right_button_clicked;

    36

DrawPixelInfo _screen;

    37

bool _exit_game;

    38

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

    39

byte _game_mode;

    40

byte _pause_game;

    41

int _pal_first_dirty;

    42

int _pal_last_dirty;

    43

    44

Colour _cur_palette[256];

    45

byte _stringwidth_table[FS_END][224];

    46

    47

enum BlitterMode {

    48

	BM_NORMAL,

    49

	BM_COLOUR_REMAP,

    50

	BM_TRANSPARENT,

    51

};

    52

    53

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

    54

    55

FontSize _cur_fontsize;

    56

static FontSize _last_fontsize;

    57

static Pixel _cursor_backup[64 * 64];

    58

static Rect _invalid_rect;

    59

static const byte *_color_remap_ptr;

    60

static byte _string_colorremap[3];

    61

    62

#define DIRTY_BYTES_PER_LINE (MAX_SCREEN_WIDTH / 64)

    63

static byte _dirty_blocks[DIRTY_BYTES_PER_LINE * MAX_SCREEN_HEIGHT / 8];

    64

    65

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

    66

{

    67

	byte *dstp = (byte*)dst;

    68

	byte *srcp = (byte*)src;

    69

    70

	assert(h >= 0);

    71

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

    72

		memcpy(dstp, srcp, w);

    73

		dstp += dstpitch;

    74

		srcp += srcpitch;

    75

	}

    76

}

    77

    78

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

    79

{

    80

	const Pixel *src;

    81

	Pixel *dst;

    82

	int p;

    83

	int ht;

    84

    85

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

    86

    87

	if (_cursor.visible) UndrawMouseCursor();

    88

	UndrawTextMessage();

    89

    90

	p = _screen.pitch;

    91

    92

	if (yo > 0) {

    93

		/*Calculate pointers */

    94

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

    95

		src = dst - yo * p;

    96

    97

		/* Decrease height and increase top */

    98

		top += yo;

    99

		height -= yo;

   100

		assert(height > 0);

   101

   102

		/* Adjust left & width */

   103

		if (xo >= 0) {

   104

			dst += xo;

   105

			left += xo;

   106

			width -= xo;

   107

		} else {

   108

			src -= xo;

   109

			width += xo;

   110

		}

   111

   112

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

   113

			memcpy(dst, src, width);

   114

			src -= p;

   115

			dst -= p;

   116

		}

   117

	} else {

   118

		/* Calculate pointers */

   119

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

   120

		src = dst - yo * p;

   121

   122

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

   123

		height += yo;

   124

		assert(height > 0);

   125

   126

		/* Adjust left & width */

   127

		if (xo >= 0) {

   128

			dst += xo;

   129

			left += xo;

   130

			width -= xo;

   131

		} else {

   132

			src -= xo;

   133

			width += xo;

   134

		}

   135

   136

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

   137

		 * because source and destination may overlap */

   138

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

   139

			memmove(dst, src, width);

   140

			src += p;

   141

			dst += p;

   142

		}

   143

	}

   144

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

   145

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

   146

}

   147

   148

   149

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

   150

{

   151

	const DrawPixelInfo* dpi = _cur_dpi;

   152

	Pixel *dst;

   153

	const int otop = top;

   154

	const int oleft = left;

   155

   156

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

   157

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

   158

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

   159

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

   160

   161

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

   162

	right = right - dpi->left + 1;

   163

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

   164

	right -= left;

   165

	assert(right > 0);

   166

   167

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

   168

	bottom = bottom - dpi->top + 1;

   169

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

   170

	bottom -= top;

   171

	assert(bottom > 0);

   172

   173

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

   174

   175

	if (!HASBIT(color, PALETTE_MODIFIER_GREYOUT)) {

   176

		if (!HASBIT(color, USE_COLORTABLE)) {

   177

			do {

   178

				memset(dst, color, right);

   179

				dst += dpi->pitch;

   180

			} while (--bottom);

   181

		} else {

   182

			/* use colortable mode */

   183

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

   184

   185

			do {

   186

				int i;

   187

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

   188

				dst += dpi->pitch;

   189

			} while (--bottom);

   190

		}

   191

	} else {

   192

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

   193

		do {

   194

			int i;

   195

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

   196

			dst += dpi->pitch;

   197

		} while (--bottom > 0);

   198

	}

   199

}

   200

   201

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

   202

{

   203

	const DrawPixelInfo* dpi = _cur_dpi;

   204

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

   205

		return;

   206

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

   207

}

   208

   209

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

   210

{

   211

	int dy;

   212

	int dx;

   213

	int stepx;

   214

	int stepy;

   215

	int frac;

   216

   217

	/* Check clipping first */

   218

	{

   219

		DrawPixelInfo *dpi = _cur_dpi;

   220

		int t;

   221

   222

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

   223

   224

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

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

	}

   232

   233

	dy = (y2 - y) * 2;

   234

	if (dy < 0) {

   235

		dy = -dy;

   236

		stepy = -1;

   237

	} else {

   238

		stepy = 1;

   239

	}

   240

   241

	dx = (x2 - x) * 2;

   242

	if (dx < 0) {

   243

		dx = -dx;

   244

		stepx = -1;

   245

	} else {

   246

		stepx = 1;

   247

	}

   248

   249

	GfxSetPixel(x, y, color);

   250

	if (dx > dy) {

   251

		frac = dy - (dx >> 1);

   252

		while (x != x2) {

   253

			if (frac >= 0) {

   254

				y += stepy;

   255

				frac -= dx;

   256

			}

   257

			x += stepx;

   258

			frac += dy;

   259

			GfxSetPixel(x, y, color);

   260

		}

   261

	} else {

   262

		frac = dx - (dy >> 1);

   263

		while (y != y2) {

   264

			if (frac >= 0) {

   265

				x += stepx;

   266

				frac -= dy;

   267

			}

   268

			y += stepy;

   269

			frac += dx;

   270

			GfxSetPixel(x, y, color);

   271

		}

   272

	}

   273

}

   274

   275

   276

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

   277

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

   278

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

   279

 * @param maxw maximum width in pixels of the string

   280

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

   281

static int TruncateString(char *str, int maxw)

   282

{

   283

	int w = 0;

   284

	FontSize size = _cur_fontsize;

   285

	int ddd, ddd_w;

   286

   287

	WChar c;

   288

	char *ddd_pos;

   289

   290

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

   291

   292

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

   293

		if (IsPrintable(c)) {

   294

			w += GetCharacterWidth(size, c);

   295

   296

			if (w >= maxw) {

   297

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

   298

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

   299

				ddd_pos[3] = '\0';

   300

				return ddd_w;

   301

			}

   302

		} else {

   303

			if (c == SCC_SETX) str++;

   304

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

   305

			else if (c == SCC_TINYFONT) {

   306

				size = FS_SMALL;

   307

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

   308

			} else if (c == SCC_BIGFONT) {

   309

				size = FS_LARGE;

   310

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

   311

			}

   312

		}

   313

   314

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

   315

		if (w + ddd < maxw) {

   316

			ddd_w = w + ddd;

   317

			ddd_pos = str;

   318

		}

   319

	}

   320

   321

	return w;

   322

}

   323

   324

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

   325

{

   326

	GetString(dest, src, last);

   327

	return TruncateString(dest, maxw);

   328

}

   329

   330

/* returns right coordinate */

   331

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

   332

{

   333

	char buffer[512];

   334

   335

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

   336

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

   337

}

   338

   339

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

   340

{

   341

	char buffer[512];

   342

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

   343

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

   344

}

   345

   346

   347

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

   348

{

   349

	char buffer[512];

   350

	int w;

   351

   352

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

   353

	w = GetStringBoundingBox(buffer).width;

   354

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

   355

   356

	return w;

   357

}

   358

   359

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

   360

{

   361

	char buffer[512];

   362

   363

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

   364

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

   365

}

   366

   367

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

   368

{

   369

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

   370

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

   371

}

   372

   373

   374

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

   375

{

   376

	char buffer[512];

   377

	int w;

   378

   379

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

   380

   381

	w = GetStringBoundingBox(buffer).width;

   382

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

   383

   384

	return w;

   385

}

   386

   387

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

   388

{

   389

	char buffer[512];

   390

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

   391

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

   392

}

   393

   394

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

   395

{

   396

	int w = GetStringBoundingBox(str).width;

   397

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

   398

	return w;

   399

}

   400

   401

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

   402

{

   403

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

   404

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

   405

}

   406

   407

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

   408

{

   409

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

   410

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

   411

}

   412

   413

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

   414

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

   415

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

   416

 * placeholders for the newlines.<br/>

   417

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

   418

 * line's maximum width.

   419

 *

   420

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

   421

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

   422

 * starting with index 0 is the real string end.

   423

 *

   424

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

   425

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

   426

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

   427

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

   428

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

   429

uint32 FormatStringLinebreaks(char *str, int maxw)

   430

{

   431

	FontSize size = _cur_fontsize;

   432

	int num = 0;

   433

   434

	assert(maxw > 0);

   435

   436

	for (;;) {

   437

		char *last_space = NULL;

   438

		int w = 0;

   439

   440

		for (;;) {

   441

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

   442

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

   443

			if (IsWhitespace(c)) last_space = str;

   444

   445

			if (IsPrintable(c)) {

   446

				w += GetCharacterWidth(size, c);

   447

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

   448

				 * do. We can do two things:

   449

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

   450

				 *    we will truncate the string and bail out.

   451

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

   452

				if (w > maxw) {

   453

					if (last_space == NULL) {

   454

						*Utf8PrevChar(str) = '\0';

   455

						return num + (size << 16);

   456

					}

   457

					str = last_space;

   458

					break;

   459

				}

   460

			} else {

   461

				switch (c) {

   462

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

   463

					case SCC_SETX:  str++; break;

   464

					case SCC_SETXY: str +=2; break;

   465

					case SCC_TINYFONT: size = FS_SMALL; break;

   466

					case SCC_BIGFONT:  size = FS_LARGE; break;

   467

					case '\n': goto end_of_inner_loop;

   468

				}

   469

			}

   470

		}

   471

end_of_inner_loop:

   472

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

   473

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

   474

		 * whitespace seperators are supported */

   475

		num++;

   476

		char *s = Utf8PrevChar(str);

   477

		*s++ = '\0';

   478

   479

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

   480

		if (str - s >= 1) {

   481

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

   482

		}

   483

	}

   484

}

   485

   486

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

   487

 * @param x Centre the string around this pixel width

   488

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

   489

 * @param str String to draw

   490

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

   491

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

   492

{