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

#include "zoom.hpp"

    22

#include "blitter/factory.hpp"

    23

    24

#ifdef _DEBUG

    25

bool _dbg_screen_rect;

    26

#endif

    27

    28

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

    29

bool _fullscreen;

    30

CursorVars _cursor;

    31

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    32

bool _shift_pressed;  ///< Is Shift pressed?

    33

byte _fast_forward;

    34

bool _left_button_down;

    35

bool _left_button_clicked;

    36

bool _right_button_down;

    37

bool _right_button_clicked;

    38

DrawPixelInfo _screen;

    39

bool _exit_game;

    40

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

    41

byte _game_mode;

    42

byte _pause_game;

    43

int _pal_first_dirty;

    44

int _pal_last_dirty;

    45

    46

Colour _cur_palette[256];

    47

byte _stringwidth_table[FS_END][224];

    48

    49

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

    50

    51

FontSize _cur_fontsize;

    52

static FontSize _last_fontsize;

    53

static uint8 _cursor_backup[64 * 64 * 4];

    54

static Rect _invalid_rect;

    55

static const byte *_color_remap_ptr;

    56

static byte _string_colorremap[3];

    57

    58

#define DIRTY_BYTES_PER_LINE (MAX_SCREEN_WIDTH / 64)

    59

static byte _dirty_blocks[DIRTY_BYTES_PER_LINE * MAX_SCREEN_HEIGHT / 8];

    60

    61

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

    62

{

    63

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    64

    65

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

    66

    67

	if (_cursor.visible) UndrawMouseCursor();

    68

	UndrawTextMessage();

    69

    71

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

    72

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

    73

}

    74

    75

    76

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

    77

{

    78

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    79

	const DrawPixelInfo *dpi = _cur_dpi;

    80

	void *dst;

    81

	const int otop = top;

    82

	const int oleft = left;

    83

    84

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

    85

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

    86

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

    87

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

    88

    89

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

    90

	right = right - dpi->left + 1;

    91

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

    92

	right -= left;

    93

	assert(right > 0);

    94

    95

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

    96

	bottom = bottom - dpi->top + 1;

    97

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

    98

	bottom -= top;

    99

	assert(bottom > 0);

   100

   101

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

   102

   103

	if (!HASBIT(color, PALETTE_MODIFIER_GREYOUT)) {

   104

		if (!HASBIT(color, USE_COLORTABLE)) {

   105

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

   106

		} else {

   107

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

   108

		}

   109

	} else {

   110

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

   111

		do {

   112

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

   113

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

   114

		} while (--bottom > 0);

   115

	}

   116

}

   117

   118

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

   119

{

   120

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   121

	DrawPixelInfo *dpi = _cur_dpi;

   122

   123

	x -= dpi->left;

   124

	x2 -= dpi->left;

   125

	y -= dpi->top;

   126

	y2 -= dpi->top;

   127

   128

	/* Check clipping */

   129

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

   130

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

   131

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

   132

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

   133

   134

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

   135

}

   136

   137

   138

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

   139

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

   140

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

   141

 * @param maxw maximum width in pixels of the string

   142

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

   143

static int TruncateString(char *str, int maxw)

   144

{

   145

	int w = 0;

   146

	FontSize size = _cur_fontsize;

   147

	int ddd, ddd_w;

   148

   149

	WChar c;

   150

	char *ddd_pos;

   151

   152

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

   153

   154

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

   155

		if (IsPrintable(c)) {

   156

			w += GetCharacterWidth(size, c);

   157

   158

			if (w >= maxw) {

   159

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

   160

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

   161

				ddd_pos[3] = '\0';

   162

				return ddd_w;

   163

			}

   164

		} else {

   165

			if (c == SCC_SETX) str++;

   166

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

   167

			else if (c == SCC_TINYFONT) {

   168

				size = FS_SMALL;

   169

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

   170

			} else if (c == SCC_BIGFONT) {

   171

				size = FS_LARGE;

   172

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

   173

			}

   174

		}

   175

   176

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

   177

		if (w + ddd < maxw) {

   178

			ddd_w = w + ddd;

   179

			ddd_pos = str;

   180

		}

   181

	}

   182

   183

	return w;

   184

}

   185

   186

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

   187

{

   188

	GetString(dest, src, last);

   189

	return TruncateString(dest, maxw);

   190

}

   191

   192

/* returns right coordinate */

   193

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

   194

{

   195

	char buffer[512];

   196

   197

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

   198

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

   199

}

   200

   201

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

   202

{

   203

	char buffer[512];

   204

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

   205

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

   206

}

   207

   208

   209

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

   210

{

   211

	char buffer[512];

   212

	int w;

   213

   214

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

   215

	w = GetStringBoundingBox(buffer).width;

   216

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

   217

   218

	return w;

   219

}

   220

   221

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

   222

{

   223

	char buffer[512];

   224

   225

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

   226

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

   227

}

   228

   229

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

   230

{

   231

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

   232

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

   233

}

   234

   235

   236

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

   237

{

   238

	char buffer[512];

   239

	int w;

   240

   241

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

   242

   243

	w = GetStringBoundingBox(buffer).width;

   244

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

   245

   246

	return w;

   247

}

   248

   249

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

   250

{

   251

	char buffer[512];

   252

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

   253

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

   254

}

   255

   256

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

   257

{

   258

	int w = GetStringBoundingBox(str).width;

   259

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

   260

	return w;

   261

}

   262

   263

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

   264

{

   265

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

   266

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

   267

}

   268

   269

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

   270

{

   271

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

   272

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

   273

}

   274

   275

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

   276

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

   277

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

   278

 * placeholders for the newlines.

   279

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

   280

 * line's maximum width.

   281

 *

   282

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

   283

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

   284

 * starting with index 0 is the real string end.

   285

 *

   286

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

   287

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

   288

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

   289

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

   290

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

   291

uint32 FormatStringLinebreaks(char *str, int maxw)

   292

{

   293

	FontSize size = _cur_fontsize;

   294

	int num = 0;

   295

   296

	assert(maxw > 0);

   297

   298

	for (;;) {

   299

		char *last_space = NULL;

   300

		int w = 0;

   301

   302

		for (;;) {

   303

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

   304

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

   305

			if (IsWhitespace(c)) last_space = str;

   306

   307

			if (IsPrintable(c)) {

   308

				w += GetCharacterWidth(size, c);

   309

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

   310

				 * do. We can do two things:

   311

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

   312

				 *    we will truncate the string and bail out.

   313

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

   314

				if (w > maxw) {

   315

					if (last_space == NULL) {

   316

						*Utf8PrevChar(str) = '\0';

   317

						return num + (size << 16);

   318

					}

   319

					str = last_space;

   320

					break;

   321

				}

   322

			} else {

   323

				switch (c) {

   324

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

   325

					case SCC_SETX:  str++; break;

   326

					case SCC_SETXY: str += 2; break;

   327

					case SCC_TINYFONT: size = FS_SMALL; break;

   328

					case SCC_BIGFONT:  size = FS_LARGE; break;

   329

					case '\n': goto end_of_inner_loop;

   330

				}

   331

			}

   332

		}

   333

end_of_inner_loop:

   334

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

   335

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

   336

		 * whitespace seperators are supported */

   337

		num++;

   338

		char *s = Utf8PrevChar(str);

   339

		*s++ = '\0';

   340

   341

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

   342

		if (str - s >= 1) {

   343

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

   344

		}

   345

	}

   346

}

   347

   348

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

   349

 * @param x Centre the string around this pixel width

   350

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

   351

 * @param str String to draw

   352

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

   353

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

   354

{

   355

	char buffer[512];

   356

	uint32 tmp;

   357

	int num, w, mt;

   358

	const char *src;

   359

	WChar c;

   360

   361

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

   362

   363

	tmp = FormatStringLinebreaks(buffer, maxw);

   364

	num = GB(tmp, 0, 16);

   365

   366

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

   367

   368

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

   369

   370

	src = buffer;

   371

   372

	for (;;) {

   373

		w = GetStringBoundingBox(src).width;

   374

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

   375

		_cur_fontsize = _last_fontsize;

   376

   377

		for (;;) {

   378

			c = Utf8Consume(&src);

   379

			if (c == 0) {

   380

				y += mt;

   381

				if (--num < 0) {

   382

					_cur_fontsize = FS_NORMAL;

   383

					return;

   384

				}

   385

				break;

   386

			} else if (c == SCC_SETX) {

   387

				src++;

   388

			} else if (c == SCC_SETXY) {

   389

				src += 2;

   390

			}

   391

		}

   392

	}

   393

}

   394

   395

   396

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

   397

{

   398

	char buffer[512];

   399

	uint32 tmp;

   400

	int num, mt;

   401

	uint total_height;

   402

	const char *src;

   403

	WChar c;

   404

   405

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

   406

   407

	tmp = FormatStringLinebreaks(buffer, maxw);

   408

	num = GB(tmp, 0, 16);

   409

   410

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

   411

	total_height = (num + 1) * mt;

   412

   413

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

   414

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

   415

		if (maxh < mt) return 0;

   416

   417

		num = maxh / mt - 1;

   418

		total_height = (num + 1) * mt;

   419

	}

   420

   421

	src = buffer;

   422

   423

	for (;;) {

   424

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

   425

		_cur_fontsize = _last_fontsize;

   426

   427

		for (;;) {

   428

			c = Utf8Consume(&src);

   429

			if (c == 0) {

   430

				y += mt;

   431

				if (--num < 0) {

   432

					_cur_fontsize = FS_NORMAL;

   433

					return total_height;

   434

				}

   435

				break;

   436

			} else if (c == SCC_SETX) {

   437

				src++;

   438

			} else if (c == SCC_SETXY) {

   439

				src += 2;

   440

			}

   441

		}

   442

	}

   443

}

   444

   445

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

   446

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

   447

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

   448

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

   449

 * but not every possible combination

   450

 * @param str string to calculate pixel-width

   451

 * @return string width and height in pixels */

   452

BoundingRect GetStringBoundingBox(const char *str)

   453

{

   454

	FontSize size = _cur_fontsize;

   455

	BoundingRect br;

   456

	int max_width;

   457

	WChar c;

   458

   459

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

   460

	for (;;) {

   461

		c = Utf8Consume(&str);

   462

		if (c == 0) break;

   463

		if (IsPrintable(c)) {

   464

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

   465

		} else {

   466

			switch (c) {

   467

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

   468

				case SCC_SETXY:

   469

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

   470

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

   471

					break;

   472

				case SCC_TINYFONT: size = FS_SMALL; break;

   473

				case SCC_BIGFONT:  size = FS_LARGE; break;

   474

				case '\n':

   475

					br.height += GetCharacterHeight(size);

   476

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

   477

					br.width = 0;

   478

					break;

   479

			}

   480

		}

   481

	}

   482

	br.height += GetCharacterHeight(size);

   483

   484

	br.width  = max(br.width, max_width);

   485

	return br;

   486