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 "variables.h"

    16

#include "table/control_codes.h"

    17

#include "fontcache.h"

    18

#include "genworld.h"

    19

#include "debug.h"

    20

#include "zoom.hpp"

    21

#include "texteff.hpp"

    22

#include "blitter/factory.hpp"

    23

#include "video/video_driver.hpp"

    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 _exit_game;

    37

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

    38

byte _game_mode;

    39

byte _pause_game;

    40

int _pal_first_dirty;

    41

int _pal_count_dirty;

    42

    43

Colour _cur_palette[256];

    44

byte _stringwidth_table[FS_END][224];

    45

    46

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

    47

    48

FontSize _cur_fontsize;

    49

static FontSize _last_fontsize;

    50

static uint8 _cursor_backup[64 * 64 * 4];

    51

    52

/**

    53

 * The rect for repaint.

    54

 *

    55

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

    56

 *

    57

 * @ingroup dirty

    58

 */

    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 GfxScroll(int left, int top, int width, int height, int xo, int yo)

    67

{

    68

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    69

    70

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

    71

    72

	if (_cursor.visible) UndrawMouseCursor();

    73

	UndrawChatMessage();

    74

    75

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

    76

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

    77

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

    78

}

    79

    80

    81

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

    82

{

    83

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    84

	const DrawPixelInfo *dpi = _cur_dpi;

    85

	void *dst;

    86

	const int otop = top;

    87

	const int oleft = left;

    88

    89

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

    90

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

    91

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

    92

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

    93

    94

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

    95

	right = right - dpi->left + 1;

    96

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

    97

	right -= left;

    98

	assert(right > 0);

    99

   100

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

   101

	bottom = bottom - dpi->top + 1;

   102

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

   103

	bottom -= top;

   104

	assert(bottom > 0);

   105

   106

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

   107

   108

	if (!HASBIT(color, PALETTE_MODIFIER_GREYOUT)) {

   109

		if (!HASBIT(color, USE_COLORTABLE)) {

   110

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

   111

		} else {

   112

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

   113

		}

   114

	} else {

   115

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

   116

		do {

   117

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

   118

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

   119

		} while (--bottom > 0);

   120

	}

   121

}

   122

   123

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

   124

{

   125

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   126

	DrawPixelInfo *dpi = _cur_dpi;

   127

   128

	x -= dpi->left;

   129

	x2 -= dpi->left;

   130

	y -= dpi->top;

   131

	y2 -= dpi->top;

   132

   133

	/* Check clipping */

   134

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

   135

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

   136

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

   137

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

   138

   139

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

   140

}

   141

   142

   143

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

   144

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

   145

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

   146

 * @param maxw maximum width in pixels of the string

   147

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

   148

static int TruncateString(char *str, int maxw)

   149

{

   150

	int w = 0;

   151

	FontSize size = _cur_fontsize;

   152

	int ddd, ddd_w;

   153

   154

	WChar c;

   155

	char *ddd_pos;

   156

   157

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

   158

   159

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

   160

		if (IsPrintable(c)) {

   161

			w += GetCharacterWidth(size, c);

   162

   163

			if (w >= maxw) {

   164

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

   165

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

   166

				ddd_pos[3] = '\0';

   167

				return ddd_w;

   168

			}

   169

		} else {

   170

			if (c == SCC_SETX) str++;

   171

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

   172

			else if (c == SCC_TINYFONT) {

   173

				size = FS_SMALL;

   174

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

   175

			} else if (c == SCC_BIGFONT) {

   176

				size = FS_LARGE;

   177

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

   178

			}

   179

		}

   180

   181

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

   182

		if (w + ddd < maxw) {

   183

			ddd_w = w + ddd;

   184

			ddd_pos = str;

   185

		}

   186

	}

   187

   188

	return w;

   189

}

   190

   191

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

   192

{

   193

	GetString(dest, src, last);

   194

	return TruncateString(dest, maxw);

   195

}

   196

   197

/* returns right coordinate */

   198

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

   199

{

   200

	char buffer[512];

   201

   202

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

   203

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

   204

}

   205

   206

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

   207

{

   208

	char buffer[512];

   209

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

   210

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

   211

}

   212

   213

   214

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

   215

{

   216

	char buffer[512];

   217

	int w;

   218

   219

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

   220

	w = GetStringBoundingBox(buffer).width;

   221

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

   222

   223

	return w;

   224

}

   225

   226

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

   227

{

   228

	char buffer[512];

   229

   230

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

   231

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

   232

}

   233

   234

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

   235

{

   236

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

   237

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

   238

}

   239

   240

   241

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

   242

{

   243

	char buffer[512];

   244

	int w;

   245

   246

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

   247

   248

	w = GetStringBoundingBox(buffer).width;

   249

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

   250

   251

	return w;

   252

}

   253

   254

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

   255

{

   256

	char buffer[512];

   257

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

   258

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

   259

}

   260

   261

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

   262

{

   263

	int w = GetStringBoundingBox(str).width;

   264

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

   265

	return w;

   266

}

   267

   268

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

   269

{

   270

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

   271

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

   272

}

   273

   274

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

   275

{

   276

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

   277

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

   278

}

   279

   280

/**

   281

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

   282

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

   283

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

   284

 * placeholders for the newlines.

   285

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

   286

 * line's maximum width.

   287

 *

   288

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

   289

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

   290

 * starting with index 0 is the real string end.

   291

 *

   292

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

   293

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

   294

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

   295

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

   296

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

   297

 */

   298

uint32 FormatStringLinebreaks(char *str, int maxw)

   299

{

   300

	FontSize size = _cur_fontsize;

   301

	int num = 0;

   302

   303

	assert(maxw > 0);

   304

   305

	for (;;) {

   306

		char *last_space = NULL;

   307

		int w = 0;

   308

   309

		for (;;) {

   310

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

   311

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

   312

			if (IsWhitespace(c)) last_space = str;

   313

   314

			if (IsPrintable(c)) {

   315

				w += GetCharacterWidth(size, c);

   316

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

   317

				 * do. We can do two things:

   318

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

   319

				 *    we will truncate the string and bail out.

   320

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

   321

				if (w > maxw) {

   322

					if (last_space == NULL) {

   323

						*Utf8PrevChar(str) = '\0';

   324

						return num + (size << 16);

   325

					}

   326

					str = last_space;

   327

					break;

   328

				}

   329

			} else {

   330

				switch (c) {

   331

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

   332

					case SCC_SETX:  str++; break;

   333

					case SCC_SETXY: str += 2; break;

   334

					case SCC_TINYFONT: size = FS_SMALL; break;

   335

					case SCC_BIGFONT:  size = FS_LARGE; break;

   336

					case '\n': goto end_of_inner_loop;

   337

				}

   338

			}

   339

		}

   340

end_of_inner_loop:

   341

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

   342

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

   343

		 * whitespace seperators are supported */

   344

		num++;

   345

		char *s = Utf8PrevChar(str);

   346

		*s++ = '\0';

   347

   348

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

   349

		if (str - s >= 1) {

   350

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

   351

		}

   352

	}

   353

}

   354

   355

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

   356

 * @param x Centre the string around this pixel width

   357

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

   358

 * @param str String to draw

   359

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

   360

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

   361

{

   362

	char buffer[512];

   363

	uint32 tmp;

   364

	int num, w, mt;

   365

	const char *src;

   366

	WChar c;

   367

   368

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

   369

   370

	tmp = FormatStringLinebreaks(buffer, maxw);

   371

	num = GB(tmp, 0, 16);

   372

   373

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

   374

   375

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

   376

   377

	src = buffer;

   378

   379

	for (;;) {

   380

		w = GetStringBoundingBox(src).width;

   381

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

   382

		_cur_fontsize = _last_fontsize;

   383

   384

		for (;;) {

   385

			c = Utf8Consume(&src);

   386

			if (c == 0) {

   387

				y += mt;

   388

				if (--num < 0) {

   389

					_cur_fontsize = FS_NORMAL;

   390

					return;

   391

				}

   392

				break;

   393

			} else if (c == SCC_SETX) {

   394

				src++;

   395

			} else if (c == SCC_SETXY) {

   396

				src += 2;

   397

			}

   398

		}

   399

	}

   400

}

   401

   402

   403

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

   404

{

   405

	char buffer[512];

   406

	uint32 tmp;

   407

	int num, mt;

   408

	uint total_height;

   409

	const char *src;

   410

	WChar c;

   411

   412

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

   413

   414

	tmp = FormatStringLinebreaks(buffer, maxw);

   415

	num = GB(tmp, 0, 16);

   416

   417

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

   418

	total_height = (num + 1) * mt;

   419

   420

	if (maxh != -1 && (int)total_height > maxh) {

   421

		/* Check there's room enough for at least one line. */

   422

		if (maxh < mt) return 0;

   423

   424

		num = maxh / mt - 1;

   425

		total_height = (num + 1) * mt;

   426

	}

   427

   428

	src = buffer;

   429

   430

	for (;;) {

   431

		DoDrawString(src, x, y, 0xFE);

   432

		_cur_fontsize = _last_fontsize;

   433

   434

		for (;;) {

   435

			c = Utf8Consume(&src);

   436

			if (c == 0) {

   437

				y += mt;

   438

				if (--num < 0) {

   439

					_cur_fontsize = FS_NORMAL;

   440

					return total_height;

   441

				}

   442

				break;

   443

			} else if (c == SCC_SETX) {

   444

				src++;

   445

			} else if (c == SCC_SETXY) {

   446

				src += 2;

   447

			}

   448

		}

   449

	}

   450

}

   451

   452

/** Return the string dimension in pixels. The height and width are returned

   453

 * in a single BoundingRect value. TINYFONT, BIGFONT modifiers are only

   454

 * supported as the first character of the string. The returned dimensions

   455

 * are therefore a rough estimation correct for all the current strings

   456

 * but not every possible combination

   457

 * @param str string to calculate pixel-width

   458

 * @return string width and height in pixels */

   459

BoundingRect GetStringBoundingBox(const char *str)

   460

{

   461

	FontSize size = _cur_fontsize;

   462

	BoundingRect br;

   463

	int max_width;

   464

	WChar c;

   465

   466

	br.width = br.height = max_width = 0;

   467

	for (;;) {

   468

		c = Utf8Consume(&str);

   469

		if (c == 0) break;

   470

		if (IsPrintable(c)) {

   471

			br.width += GetCharacterWidth(size, c);

   472

		} else {

   473

			switch (c) {

   474

				case SCC_SETX: br.width += (byte)*str++; break;

   475

				case SCC_SETXY:

   476

					br.width += (byte)*str++;

   477

					br.height += (byte)*str++;

   478

					break;

   479

				case SCC_TINYFONT: size = FS_SMALL; break;

   480

				case SCC_BIGFONT:  size = FS_LARGE; break;

   481

				case '\n':

   482

					br.height += GetCharacterHeight(size);

   483

					if (br.width > max_width) max_width = br.width;

   484

					br.width = 0;

   485

					break;