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, const SubSprite *sub = NULL);

    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

   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

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

   143

{

   144

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   145

	DrawPixelInfo *dpi = _cur_dpi;

   146

   147

	x -= dpi->left;

   148

	x2 -= dpi->left;

   149

	y -= dpi->top;

   150

	y2 -= dpi->top;

   151

   152

	/* Check clipping */

   153

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

   154

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

   155

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

   156

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

   157

   158

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

   159

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

   160

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

   161

}

   162

   163

/**

   164

 * Draws the projection of a parallelepiped.

   165

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

   166

 *

   167

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

   168

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

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

 */

   176

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

   177

{

   178

	/*           ....

   179

	 *         ..    ....

   180

	 *       ..          ....

   181

	 *     ..                ^

   182

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

   183

	 *   :    --__       /   :

   184

	 *   :        --__ /     :

   185

	 *   :            *(x,y) :

   186

	 *   :            |      :

   187

	 *   :            |     ..

   188

	 *    ....        |(dx3,dy3)

   189

	 *        ....    | ..

   190

	 *            ....V.

   191

	 */

   192

   193

	static const byte color = 255;

   194

   195

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

   196

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

   197

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

   198

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

}

   206

   207

   208

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

   209

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

   210

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

   211

 * @param maxw maximum width in pixels of the string

   212

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

   213

static int TruncateString(char *str, int maxw)

   214

{

   215

	int w = 0;

   216

	FontSize size = _cur_fontsize;

   217

	int ddd, ddd_w;

   218

   219

	WChar c;

   220

	char *ddd_pos;

   221

   222

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

   223

   224

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

   225

		if (IsPrintable(c)) {

   226

			w += GetCharacterWidth(size, c);

   227

   228

			if (w >= maxw) {

   229

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

   230

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

   231

				ddd_pos[3] = '\0';

   232

				return ddd_w;

   233

			}

   234

		} else {

   235

			if (c == SCC_SETX) str++;

   236

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

   237

			else if (c == SCC_TINYFONT) {

   238

				size = FS_SMALL;

   239

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

   240

			} else if (c == SCC_BIGFONT) {

   241

				size = FS_LARGE;

   242

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

   243

			}

   244

		}

   245

   246

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

   247

		if (w + ddd < maxw) {

   248

			ddd_w = w + ddd;

   249

			ddd_pos = str;

   250

		}

   251

	}

   252

   253

	return w;

   254

}

   255

   256

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

   257

{

   258

	GetString(dest, src, last);

   259

	return TruncateString(dest, maxw);

   260

}

   261

   262

/* returns right coordinate */

   263

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

   264

{

   265

	char buffer[512];

   266

   267

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

   268

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

   269

}

   270

   271

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

   272

{

   273

	char buffer[512];

   274

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

   275

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

   276

}

   277

   278

   279

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

   280

{

   281

	char buffer[512];

   282

	int w;

   283

   284

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

   285

	w = GetStringBoundingBox(buffer).width;

   286

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

   287

   288

	return w;

   289

}

   290

   291

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

   292

{

   293

	char buffer[512];

   294

   295

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

   296

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

   297

}

   298

   299

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

   300

{

   301

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

   302

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

   303

}

   304

   305

   306

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

   307

{

   308

	char buffer[512];

   309

	int w;

   310

   311

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

   312

   313

	w = GetStringBoundingBox(buffer).width;

   314

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

   315

   316

	return w;

   317

}

   318

   319

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

   320

{

   321

	char buffer[512];

   322

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

   323

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

   324

}

   325

   326

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

   327

{

   328

	int w = GetStringBoundingBox(str).width;

   329

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

   330

	return w;

   331

}

   332

   333

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

   334

{

   335

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

   336

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

   337

}

   338

   339

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

   340

{

   341

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

   342

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

   343

}

   344

   345

/**

   346

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

   347

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

   348

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

   349

 * placeholders for the newlines.

   350

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

   351

 * line's maximum width.

   352

 *

   353

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

   354

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

   355

 * starting with index 0 is the real string end.

   356

 *

   357

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

   358

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

   359

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

   360

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

   361

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

   362

 */

   363

uint32 FormatStringLinebreaks(char *str, int maxw)

   364

{

   365

	FontSize size = _cur_fontsize;

   366

	int num = 0;

   367

   368

	assert(maxw > 0);

   369

   370

	for (;;) {

   371

		char *last_space = NULL;

   372

		int w = 0;

   373

   374

		for (;;) {

   375

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

   376

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

   377

			if (IsWhitespace(c)) last_space = str;

   378

   379

			if (IsPrintable(c)) {

   380

				w += GetCharacterWidth(size, c);

   381

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

   382

				 * do. We can do two things:

   383

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

   384

				 *    we will truncate the string and bail out.

   385

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

   386

				if (w > maxw) {

   387

					if (last_space == NULL) {

   388

						*Utf8PrevChar(str) = '\0';

   389

						return num + (size << 16);

   390

					}

   391

					str = last_space;

   392

					break;

   393

				}

   394

			} else {

   395

				switch (c) {

   396

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

   397

					case SCC_SETX:  str++; break;

   398

					case SCC_SETXY: str += 2; break;

   399

					case SCC_TINYFONT: size = FS_SMALL; break;

   400

					case SCC_BIGFONT:  size = FS_LARGE; break;

   401

					case '\n': goto end_of_inner_loop;

   402

				}

   403

			}

   404

		}

   405

end_of_inner_loop:

   406

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

   407

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

   408

		 * whitespace seperators are supported */

   409

		num++;

   410

		char *s = Utf8PrevChar(str);

   411

		*s++ = '\0';

   412

   413

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

   414

		if (str - s >= 1) {

   415

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

   416

		}

   417

	}

   418

}

   419

   420

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

   421

 * @param x Centre the string around this pixel width

   422

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

   423

 * @param str String to draw

   424

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

   425

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

   426

{

   427

	char buffer[512];

   428

	uint32 tmp;

   429

	int num, w, mt;

   430

	const char *src;

   431

	WChar c;

   432

   433

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

   434

   435

	tmp = FormatStringLinebreaks(buffer, maxw);

   436

	num = GB(tmp, 0, 16);

   437

   438

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

   439

   440

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

   441

   442

	src = buffer;

   443

   444

	for (;;) {

   445

		w = GetStringBoundingBox(src).width;

   446

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

   447

		_cur_fontsize = _last_fontsize;

   448

   449

		for (;;) {

   450

			c = Utf8Consume(&src);

   451

			if (c == 0) {

   452

				y += mt;

   453

				if (--num < 0) {

   454

					_cur_fontsize = FS_NORMAL;

   455

					return;

   456

				}

   457

				break;

   458

			} else if (c == SCC_SETX) {

   459

				src++;

   460

			} else if (c == SCC_SETXY) {

   461

				src += 2;

   462

			}

   463

		}

   464

	}

   465

}

   466

   467

   468

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

   469

{

   470

	char buffer[512];

   471

	uint32 tmp;

   472

	int num, mt;

   473

	uint total_height;

   474

	const char *src;

   475

	WChar c;

   476

   477

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

   478

   479

	tmp = FormatStringLinebreaks(buffer, maxw);

   480

	num = GB(tmp, 0, 16);

   481

   482

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

   483

	total_height = (num + 1) * mt;

   484

   485

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

   486

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

   487