1

/* $Id$ */

     2

     3

/** @file gfx.cpp Handling of drawing text and other gfx related stuff. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gfx_func.h"

     8

#include "spritecache.h"

     9

#include "variables.h"

    10

#include "fontcache.h"

    11

#include "genworld.h"

    12

#include "debug.h"

    13

#include "zoom_func.h"

    14

#include "texteff.hpp"

    15

#include "blitter/factory.hpp"

    16

#include "video/video_driver.hpp"

    17

#include "strings_func.h"

    18

#include "core/math_func.hpp"

    19

#include "settings_type.h"

    20

#include "core/alloc_func.hpp"

    21

#include "core/sort_func.hpp"

    22

#include "landscape_type.h"

    23

#include "network/network_func.h"

    24

    25

#include "table/palettes.h"

    26

#include "table/sprites.h"

    27

#include "table/control_codes.h"

    28

    29

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

    30

bool _fullscreen;

    31

CursorVars _cursor;

    32

bool _ctrl_pressed;   ///< Is Ctrl pressed?

    33

bool _shift_pressed;  ///< Is Shift pressed?

    34

byte _fast_forward;

    35

bool _left_button_down;     ///< Is left mouse button pressed?

    36

bool _left_button_clicked;  ///< Is left mouse button clicked?

    37

bool _right_button_down;    ///< Is right mouse button pressed?

    38

bool _right_button_clicked; ///< Is right mouse button clicked?

    39

DrawPixelInfo _screen;

    40

bool _screen_disable_anim = false;   ///< Disable palette animation (important for 32bpp-anim blitter during giant screenshot)

    41

bool _exit_game;

    42

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

    43

byte _game_mode;

    44

int8 _pause_game;

    45

int _pal_first_dirty;

    46

int _pal_count_dirty;

    47

    48

Colour _cur_palette[256];

    49

byte _stringwidth_table[FS_END][224]; ///< Cache containing width of often used characters. @see GetCharacterWidth()

    50

DrawPixelInfo *_cur_dpi;

    51

byte _colour_gradient[COLOUR_END][8];

    52

bool _use_dos_palette;

    53

    54

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

    55

    56

FontSize _cur_fontsize;

    57

static FontSize _last_fontsize;

    58

static uint8 _cursor_backup[64 * 64 * 4];

    59

    60

/**

    61

 * The rect for repaint.

    62

 *

    63

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

    64

 *

    65

 * @ingroup dirty

    66

 */

    67

static Rect _invalid_rect;

    68

static const byte *_color_remap_ptr;

    69

static byte _string_colorremap[3];

    70

    71

enum {

    72

	DIRTY_BLOCK_HEIGHT   = 8,

    73

	DIRTY_BLOCK_WIDTH    = 64,

    74

};

    75

static uint _dirty_bytes_per_line = 0;

    76

static byte *_dirty_blocks = NULL;

    77

    78

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

    79

{

    80

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

    81

    82

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

    83

    84

	if (_cursor.visible) UndrawMouseCursor();

    85

    86

#ifdef ENABLE_NETWORK

    87

	NetworkUndrawChatMessage();

    88

#endif /* ENABLE_NETWORK */

    89

    90

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

    91

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

    92

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

    93

}

    94

    95

    96

/**

    97

 * Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.

    98

 *

    99

 * @pre dpi->zoom == ZOOM_LVL_NORMAL, right >= left, bottom >= top

   100

 * @param left Minimum X (inclusive)

   101

 * @param top Minimum Y (inclusive)

   102

 * @param right Maximum X (inclusive)

   103

 * @param bottom Maximum Y (inclusive)

   104

 * @param color A 8 bit palette index (FILLRECT_OPAQUE and FILLRECT_CHECKER) or a recolor spritenumber (FILLRECT_RECOLOR)

   105

 * @param mode

   106

 *         FILLRECT_OPAQUE:   Fill the rectangle with the specified color

   107

 *         FILLRECT_CHECKER:  Like FILLRECT_OPAQUE, but only draw every second pixel (used to grey out things)

   108

 *         FILLRECT_RECOLOR:  Apply a recolor sprite to every pixel in the rectangle currently on screen

   109

 */

   110

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

   111

{

   112

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   113

	const DrawPixelInfo *dpi = _cur_dpi;

   114

	void *dst;

   115

	const int otop = top;

   116

	const int oleft = left;

   117

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

	right = right - dpi->left + 1;

   125

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

   126

	right -= left;

   127

	assert(right > 0);

   128

   129

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

   130

	bottom = bottom - dpi->top + 1;

   131

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

   132

	bottom -= top;

   133

	assert(bottom > 0);

   134

   135

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

   136

   137

	switch (mode) {

   138

		default: // FILLRECT_OPAQUE

   139

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

   140

			break;

   141

   142

		case FILLRECT_RECOLOR:

   143

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

   144

			break;

   145

   146

		case FILLRECT_CHECKER: {

   147

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

   148

			do {

   149

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

   150

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

   151

			} while (--bottom > 0);

   152

			break;

   153

		}

   154

	}

   155

}

   156

   157

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

   158

{

   159

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   160

	DrawPixelInfo *dpi = _cur_dpi;

   161

   162

	x -= dpi->left;

   163

	x2 -= dpi->left;

   164

	y -= dpi->top;

   165

	y2 -= dpi->top;

   166

   167

	/* Check clipping */

   168

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

   169

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

   170

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

   171

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

   172

   173

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

   174

}

   175

   176

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

   177

{

   178

	Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();

   179

	DrawPixelInfo *dpi = _cur_dpi;

   180

   181

	x -= dpi->left;

   182

	x2 -= dpi->left;

   183

	y -= dpi->top;

   184

	y2 -= dpi->top;

   185

   186

	/* Check clipping */

   187

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

   188

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

   189

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

   190

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

   191

   192

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

   193

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

   194

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

   195

}

   196

   197

/**

   198

 * Draws the projection of a parallelepiped.

   199

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

   200

 *

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

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

   208

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

   209

 */

   210

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

   211

{

   212

	/*           ....

   213

	 *         ..    ....

   214

	 *       ..          ....

   215

	 *     ..                ^

   216

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

   217

	 *   :    --__       /   :

   218

	 *   :        --__ /     :

   219

	 *   :            *(x,y) :

   220

	 *   :            |      :

   221

	 *   :            |     ..

   222

	 *    ....        |(dx3,dy3)

   223

	 *        ....    | ..

   224

	 *            ....V.

   225

	 */

   226

   227

	static const byte color = 255;

   228

   229

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

   230

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

   231

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

   232

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

}

   240

   241

   242

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

   243

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

   244

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

   245

 * @param maxw maximum width in pixels of the string

   246

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

   247

static int TruncateString(char *str, int maxw)

   248

{

   249

	int w = 0;

   250

	FontSize size = _cur_fontsize;

   251

	int ddd, ddd_w;

   252

   253

	WChar c;

   254

	char *ddd_pos;

   255

   256

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

   257

   258

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

   259

		if (IsPrintable(c)) {

   260

			w += GetCharacterWidth(size, c);

   261

   262

			if (w >= maxw) {

   263

				/* string got too big... insert dotdotdot, but make sure we do not

   264

				 * print anything beyond the string termination character. */

   265

				for (int i = 0; *ddd_pos != '\0' && i < 3; i++, ddd_pos++) *ddd_pos = '.';

   266

				*ddd_pos = '\0';

   267

				return ddd_w;

   268

			}

   269

		} else {

   270

			if (c == SCC_SETX) {

   271

				w = *str;

   272

				str++;

   273

			} else if (c == SCC_SETXY) {

   274

				w = *str;

   275

				str += 2;

   276

			} else if (c == SCC_TINYFONT) {

   277

				size = FS_SMALL;

   278

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

   279

			} else if (c == SCC_BIGFONT) {

   280

				size = FS_LARGE;

   281

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

   282

			}

   283

		}

   284

   285

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

   286

		if (w + ddd < maxw) {

   287

			ddd_w = w + ddd;

   288

			ddd_pos = str;

   289

		}

   290

	}

   291

   292

	return w;

   293

}

   294

   295

/**

   296

 * Write string to output buffer, truncating it to specified maximal width in pixels if it is too long.

   297

 *

   298

 * @param src   String to truncate

   299

 * @param dest  Start of character output buffer where truncated string is stored

   300

 * @param maxw  Maximal allowed length of the string in pixels

   301

 * @param last  Address of last character in output buffer

   302

 *

   303

 * @return Actual width of the (possibly) truncated string in pixels

   304

 */

   305

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

   306

{

   307

	GetString(dest, src, last);

   308

	return TruncateString(dest, maxw);

   309

}

   310

   311

/**

   312

 * Draw string starting at position (x,y).

   313

 *

   314

 * @param x      X position to start drawing

   315

 * @param y      Y position to start drawing

   316

 * @param str    String to draw

   317

 * @param color  Color used for drawing the string, see DoDrawString() for details

   318

 *

   319

 * @return Horizontal coordinate after drawing the string

   320

 */

   321

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

   322

{

   323

	char buffer[DRAW_STRING_BUFFER];

   324

   325

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

   326

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

   327

}

   328

   329

/**

   330

 * Draw string, possibly truncated to make it fit in its allocated space

   331

 *

   332

 * @param x      X position to start drawing

   333

 * @param y      Y position to start drawing

   334

 * @param str    String to draw

   335

 * @param color  Color used for drawing the string, see DoDrawString() for details

   336

 * @param maxw   Maximal width of the string

   337

 *

   338

 * @return Horizontal coordinate after drawing the (possibly truncated) string

   339

 */

   340

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

   341

{

   342

	char buffer[DRAW_STRING_BUFFER];

   343

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

   344

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

   345

}

   346

   347

/**

   348

 * Draw string right-aligned.

   349

 *

   350

 * @param x      Right-most x position of the string

   351

 * @param y      Y position of the string

   352

 * @param str    String to draw

   353

 * @param color  Color used for drawing the string, see DoDrawString() for details

   354

 *

   355

 * @return Width of drawn string in pixels

   356

 */

   357

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

   358

{

   359

	char buffer[DRAW_STRING_BUFFER];

   360

	int w;

   361

   362

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

   363

	w = GetStringBoundingBox(buffer).width;

   364

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

   365

   366

	return w;

   367

}

   368

   369

/**

   370

 * Draw string right-aligned, possibly truncated to make it fit in its allocated space

   371

 *

   372

 * @param x      Right-most x position to start drawing

   373

 * @param y      Y position to start drawing

   374

 * @param str    String to draw

   375

 * @param color  Color used for drawing the string, see DoDrawString() for details

   376

 * @param maxw   Maximal width of the string

   377

 */

   378

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

   379

{

   380

	char buffer[DRAW_STRING_BUFFER];

   381

   382

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

   383

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

   384

}

   385

   386

/**

   387

 * Draw string right-aligned with a line underneath it.

   388

 *

   389

 * @param x      Right-most x position of the string

   390

 * @param y      Y position of the string

   391

 * @param str    String to draw

   392

 * @param color  Color used for drawing the string, see DoDrawString() for details

   393

 */

   394

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

   395

{

   396

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

   397

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

   398

}

   399

   400

/**

   401

 * Draw string centered.

   402

 *

   403

 * @param x      X position of center of the string

   404

 * @param y      Y position of center of the string

   405

 * @param str    String to draw

   406

 * @param color  Color used for drawing the string, see DoDrawString() for details

   407

 *

   408

 * @return Width of the drawn string in pixels

   409

 */

   410

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

   411

{

   412

	char buffer[DRAW_STRING_BUFFER];

   413

	int w;

   414

   415

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

   416

   417

	w = GetStringBoundingBox(buffer).width;

   418

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

   419

   420

	return w;

   421

}

   422

   423

/**

   424

 * Draw string centered, possibly truncated to fit in the assigned space.

   425

 *

   426

 * @param xl     Left-most x position

   427

 * @param xr     Right-most x position

   428

 * @param y      Y position of the string

   429

 * @param str    String to draw

   430

 * @param color  Color used for drawing the string, see DoDrawString() for details

   431

 *

   432

 * @return Right-most coordinate of the (possibly truncated) drawn string

   433

 */

   434

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

   435

{

   436

	char buffer[DRAW_STRING_BUFFER];

   437

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

   438

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

   439

}

   440

   441

/**

   442

 * Draw string centered.

   443

 *

   444

 * @param x      X position of center of the string

   445

 * @param y      Y position of center of the string

   446

 * @param str    String to draw

   447

 * @param color  Color used for drawing the string, see DoDrawString() for details

   448

 *

   449

 * @return Width of the drawn string in pixels

   450

 */

   451

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

   452

{

   453

	int w = GetStringBoundingBox(str).width;

   454

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

   455

	return w;

   456

}

   457

   458

/**

   459

 * Draw string centered, with additional line underneath it

   460

 *

   461

 * @param x      X position of center of the string

   462

 * @param y      Y position of center of the string

   463

 * @param str    String to draw

   464

 * @param color  Color used for drawing the string, see DoDrawString() for details

   465

 */

   466

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

   467

{

   468

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

   469

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

   470

}

   471

   472

/**

   473

 * Draw string centered possibly truncated, with additional line underneath it

   474

 *

   475

 * @param xl     Left x position of the string

   476

 * @param xr     Right x position of the string

   477

 * @param y      Y position of center of the string

   478

 * @param str    String to draw

   479

 * @param color  Color used for drawing the string, see DoDrawString() for details

   480

 */

   481

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

   482

{

   483

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

   484

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

   485

}

   486

   487

/**

   488

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