1

/* $Id$ */

     2

     3

/** @file gfx.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gfx_func.h"

     8

#include "spritecache.h"

     9

#include "string.h"

    10

#include "table/palettes.h"

    11

#include "table/sprites.h"

    12

#include "variables.h"

    13

#include "table/control_codes.h"

    14

#include "fontcache.h"

    15

#include "genworld.h"

    16

#include "debug.h"

    17

#include "zoom_func.h"

    18

#include "texteff.hpp"

    19

#include "blitter/factory.hpp"

    20

#include "video/video_driver.hpp"

    21

#include "strings_func.h"

    22

#include "core/math_func.hpp"

    23

    24

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

    25

bool _fullscreen;

    26

CursorVars _cursor;

    27

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    28

bool _shift_pressed;  ///< Is Shift pressed?

    29

byte _fast_forward;

    30

bool _left_button_down;

    31

bool _left_button_clicked;

    32

bool _right_button_down;

    33

bool _right_button_clicked;

    34

DrawPixelInfo _screen;

    35

bool _exit_game;

    36

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

    37

byte _game_mode;

    38

byte _pause_game;

    39

int _pal_first_dirty;

    40

int _pal_count_dirty;

    41

    42

Colour _cur_palette[256];

    43

byte _stringwidth_table[FS_END][224];

    44

DrawPixelInfo *_cur_dpi;

    45

byte _colour_gradient[16][8];

    46

bool _use_dos_palette;

    47

    48

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

    49

    50

FontSize _cur_fontsize;

    51

static FontSize _last_fontsize;

    52

static uint8 _cursor_backup[64 * 64 * 4];

    53

    54

/**

    55

 * The rect for repaint.

    56

 *

    57

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

    58

 *

    59

 * @ingroup dirty

    60

 */

    61

static Rect _invalid_rect;

    62

static const byte *_color_remap_ptr;

    63

static byte _string_colorremap[3];

    64

    65

#define DIRTY_BYTES_PER_LINE (MAX_SCREEN_WIDTH / 64)

    66

static byte _dirty_blocks[DIRTY_BYTES_PER_LINE * MAX_SCREEN_HEIGHT / 8];

    67

    68

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

    69

{

    70

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    71

    72

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

    73

    74

	if (_cursor.visible) UndrawMouseCursor();

    75

	UndrawChatMessage();

    76

    77

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

    78

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

    79

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

    80

}

    81

    82

    83

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

    84

{

    85

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    86

	const DrawPixelInfo *dpi = _cur_dpi;

    87

	void *dst;

    88

	const int otop = top;

    89

	const int oleft = left;

    90

    91

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

    92

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

    93

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

    94

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

    95

    96

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

    97

	right = right - dpi->left + 1;

    98

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

    99

	right -= left;

   100

	assert(right > 0);

   101

   102

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

   103

	bottom = bottom - dpi->top + 1;

   104

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

   105

	bottom -= top;

   106

	assert(bottom > 0);

   107

   108

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

   109

   110

	if (!HasBit(color, PALETTE_MODIFIER_GREYOUT)) {

   111

		if (!HasBit(color, USE_COLORTABLE)) {

   112

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

   113

		} else {

   114

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

   115

		}

   116

	} else {

   117

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

   118

		do {

   119

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

   120

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

   121

		} while (--bottom > 0);

   122

	}

   123

}

   124

   125

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

   126

{

   127

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   128

	DrawPixelInfo *dpi = _cur_dpi;

   129

   130

	x -= dpi->left;

   131

	x2 -= dpi->left;

   132

	y -= dpi->top;

   133

	y2 -= dpi->top;

   134

   135

	/* Check clipping */

   136

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

   137

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

   138

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

   139

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

   140

   141

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

   142

}

   143

   144

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

   145

{

   146

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   147

	DrawPixelInfo *dpi = _cur_dpi;

   148

   149

	x -= dpi->left;

   150

	x2 -= dpi->left;

   151

	y -= dpi->top;

   152

	y2 -= dpi->top;

   153

   154

	/* Check clipping */

   155

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

   156

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

   157

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

   158

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

   159

   160

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

   161

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

   162

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

   163

}

   164

   165

/**

   166

 * Draws the projection of a parallelepiped.

   167

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

   168

 *

   169

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

   170

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

   171

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

   172

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

   173

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

   174

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

   175

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

   176

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

   177

 */

   178

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

   179

{

   180

	/*           ....

   181

	 *         ..    ....

   182

	 *       ..          ....

   183

	 *     ..                ^

   184

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

   185

	 *   :    --__       /   :

   186

	 *   :        --__ /     :

   187

	 *   :            *(x,y) :

   188

	 *   :            |      :

   189

	 *   :            |     ..

   190

	 *    ....        |(dx3,dy3)

   191

	 *        ....    | ..

   192

	 *            ....V.

   193

	 */

   194

   195

	static const byte color = 255;

   196

   197

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

   198

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

   199

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

   200

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

}

   208

   209

   210

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

   211

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

   212

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

   213

 * @param maxw maximum width in pixels of the string

   214

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

   215

static int TruncateString(char *str, int maxw)

   216

{

   217

	int w = 0;

   218

	FontSize size = _cur_fontsize;

   219

	int ddd, ddd_w;

   220

   221

	WChar c;

   222

	char *ddd_pos;

   223

   224

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

   225

   226

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

   227

		if (IsPrintable(c)) {

   228

			w += GetCharacterWidth(size, c);

   229

   230

			if (w >= maxw) {

   231

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

   232

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

   233

				ddd_pos[3] = '\0';

   234

				return ddd_w;

   235

			}

   236

		} else {

   237

			if (c == SCC_SETX) str++;

   238

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

   239

			else if (c == SCC_TINYFONT) {

   240

				size = FS_SMALL;

   241

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

   242

			} else if (c == SCC_BIGFONT) {

   243

				size = FS_LARGE;

   244

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

   245

			}

   246

		}

   247

   248

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

   249

		if (w + ddd < maxw) {

   250

			ddd_w = w + ddd;

   251

			ddd_pos = str;

   252

		}

   253

	}

   254

   255

	return w;

   256

}

   257

   258

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

   259

{

   260

	GetString(dest, src, last);

   261

	return TruncateString(dest, maxw);

   262

}

   263

   264

/* returns right coordinate */

   265

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

   266

{

   267

	char buffer[512];

   268

   269

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

   270

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

   271

}

   272

   273

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

   274

{

   275

	char buffer[512];

   276

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

   277

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

   278

}

   279

   280

   281

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

   282

{

   283

	char buffer[512];

   284

	int w;

   285

   286

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

   287

	w = GetStringBoundingBox(buffer).width;

   288

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

   289

   290

	return w;

   291

}

   292

   293

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

   294

{

   295

	char buffer[512];

   296

   297

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

   298

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

   299

}

   300

   301

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

   302

{

   303

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

   304

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

   305

}

   306

   307

   308

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

   309

{

   310

	char buffer[512];

   311

	int w;

   312

   313

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

   314

   315

	w = GetStringBoundingBox(buffer).width;

   316

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

   317

   318

	return w;

   319

}

   320

   321

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

   322

{

   323

	char buffer[512];

   324

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

   325

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

   326

}

   327

   328

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

   329

{

   330

	int w = GetStringBoundingBox(str).width;

   331

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

   332

	return w;

   333

}

   334

   335

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

   336

{

   337

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

   338

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

   339

}

   340

   341

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

   342

{

   343

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

   344

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

   345

}

   346

   347

/**

   348

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

   349

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

   350

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

   351

 * placeholders for the newlines.

   352

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

   353

 * line's maximum width.

   354

 *

   355

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

   356

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

   357

 * starting with index 0 is the real string end.

   358

 *

   359

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

   360

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

   361

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

   362

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

   363

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

   364

 */

   365

uint32 FormatStringLinebreaks(char *str, int maxw)

   366

{

   367

	FontSize size = _cur_fontsize;

   368

	int num = 0;

   369

   370

	assert(maxw > 0);

   371

   372

	for (;;) {

   373

		char *last_space = NULL;

   374

		int w = 0;

   375

   376

		for (;;) {

   377

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

   378

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

   379

			if (IsWhitespace(c)) last_space = str;

   380

   381

			if (IsPrintable(c)) {

   382

				w += GetCharacterWidth(size, c);

   383

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

   384

				 * do. We can do two things:

   385

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

   386

				 *    we will truncate the string and bail out.

   387

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

   388

				if (w > maxw) {

   389

					if (last_space == NULL) {

   390

						*Utf8PrevChar(str) = '\0';

   391

						return num + (size << 16);

   392

					}

   393

					str = last_space;

   394

					break;

   395

				}

   396

			} else {

   397

				switch (c) {

   398

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

   399

					case SCC_SETX:  str++; break;

   400

					case SCC_SETXY: str += 2; break;

   401

					case SCC_TINYFONT: size = FS_SMALL; break;

   402

					case SCC_BIGFONT:  size = FS_LARGE; break;

   403

					case '\n': goto end_of_inner_loop;

   404

				}

   405

			}

   406

		}

   407

end_of_inner_loop:

   408

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

   409

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

   410

		 * whitespace seperators are supported */

   411

		num++;

   412

		char *s = Utf8PrevChar(str);

   413

		*s++ = '\0';

   414

   415

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

   416

		if (str - s >= 1) {

   417

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

   418

		}

   419

	}

   420

}

   421

   422

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

   423

 * @param x Centre the string around this pixel width

   424

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

   425

 * @param str String to draw

   426

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

   427

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

   428

{

   429

	char buffer[512];

   430

	uint32 tmp;

   431

	int num, w, mt;

   432

	const char *src;

   433

	WChar c;

   434

   435

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

   436

   437

	tmp = FormatStringLinebreaks(buffer, maxw);

   438

	num = GB(tmp, 0, 16);

   439

   440

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

   441

   442

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

   443

   444

	src = buffer;

   445

   446

	for (;;) {

   447

		w = GetStringBoundingBox(src).width;

   448

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

   449

		_cur_fontsize = _last_fontsize;

   450

   451

		for (;;) {

   452

			c = Utf8Consume(&src);

   453

			if (c == 0) {

   454

				y += mt;

   455

				if (--num < 0) {

   456

					_cur_fontsize = FS_NORMAL;

   457

					return;

   458

				}

   459

				break;

   460

			} else if (c == SCC_SETX) {

   461

				src++;

   462

			} else if (c == SCC_SETXY) {

   463

				src += 2;

   464

			}

   465

		}

   466

	}

   467

}

   468

   469

   470

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

   471

{

   472

	char buffer[512];

   473

	uint32 tmp;

   474

	int num, mt;

   475

	uint total_height;

   476

	const char *src;

   477

	WChar c;

   478

   479

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

   480

   481

	tmp = FormatStringLinebreaks(buffer, maxw);

   482

	num = GB(tmp, 0, 16);

   483

   484

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

   485

	total_height = (num + 1) * mt;

   486