1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "macros.h"

     7

#include "debug.h"

     8

#include "table/sprites.h"

     9

#include "table/control_codes.h"

    10

#include "spritecache.h"

    11

#include "gfx.h"

    12

#include "string.h"

    13

#include "fontcache.h"

    14

    15

#ifdef WITH_FREETYPE

    16

    17

#include <ft2build.h>

    18

#include FT_FREETYPE_H

    19

#include FT_GLYPH_H

    20

    21

#ifdef WITH_FONTCONFIG

    22

#include <fontconfig/fontconfig.h>

    23

#endif

    24

    25

static FT_Library _library = NULL;

    26

static FT_Face _face_small = NULL;

    27

static FT_Face _face_medium = NULL;

    28

static FT_Face _face_large = NULL;

    29

    30

FreeTypeSettings _freetype;

    31

    32

enum {

    33

	FACE_COLOUR = 1,

    34

	SHADOW_COLOUR = 2,

    35

};

    36

    37

#ifdef WIN32

    38

#include <windows.h>

    39

#include <tchar.h>

    40

#include <shlobj.h> // SHGetFolderPath

    41

#include "win32.h"

    42

    43

#define FONT_DIR_NT "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts"

    44

#define FONT_DIR_9X "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Fonts"

    45

static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)

    46

{

    47

	FT_Error err = FT_Err_Cannot_Open_Resource;

    48

	HKEY hKey;

    49

	LONG ret;

    50

	TCHAR vbuffer[MAX_PATH], dbuffer[256];

    51

	char *font_path;

    52

	uint index;

    53

    54

	/* On windows NT (2000, NT3.5, XP, etc.) the fonts are stored in the

    55

	 * "Windows NT" key, on Windows 9x in the Windows key. To save us having

    56

	 * to retrieve the windows version, we'll just query both */

    57

	ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_NT), 0, KEY_READ, &hKey);

    58

	if (ret != ERROR_SUCCESS) ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_9X), 0, KEY_READ, &hKey);

    59

    60

	if (ret != ERROR_SUCCESS) {

    61

		DEBUG(freetype, 0) ("Cannot open registry key HKLM\\SOFTWARE\\Microsoft\\Windows (NT)\\CurrentVersion\\Fonts");

    62

		return err;

    63

	}

    64

    65

	for (index = 0;; index++) {

    66

		char *s;

    67

		DWORD vbuflen = lengthof(vbuffer);

    68

		DWORD dbuflen = lengthof(dbuffer);

    69

    70

		ret = RegEnumValue(hKey, index, vbuffer, &vbuflen, NULL, NULL, dbuffer, &dbuflen);

    71

		if (ret != ERROR_SUCCESS) break;

    72

    73

		/* The font names in the registry are of the following 3 forms:

    74

		 * - ADMUI3.fon

    75

		 * - Book Antiqua Bold (TrueType)

    76

		 * - Batang & BatangChe & Gungsuh & GungsuhChe (TrueType)

    77

		 * We will strip the font-type '()' if any and work with the font name

    78

		 * itself, which must match exactly; if...

    79

		 * TTC files, font files which contain more than one font are seperated

    80

		 * byt '&'. Our best bet will be to do substr match for the fontname

    81

		 * and then let FreeType figure out which index to load */

    82

		s = _tcschr(vbuffer, '(');

    83

		if (s != NULL) s[-1] = '\0';

    84

    85

		if (_tcschr(vbuffer, '&') == NULL) {

    86

			if (_tcsicmp(vbuffer, font_name) == 0) break;

    87

		} else {

    88

			if (_tcsstr(vbuffer, font_name) != NULL) break;

    89

		}

    90

	}

    91

    92

	if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_FONTS, NULL, SHGFP_TYPE_CURRENT, vbuffer))) {

    93

		DEBUG(freetype, 0) ("SHGetFolderPath cannot return fonts directory");

    94

		goto folder_error;

    95

	}

    96

    97

	/* Some fonts are contained in .ttc files, TrueType Collection fonts. These

    98

	 * contain multiple fonts inside this single file. GetFontData however

    99

	 * returns the whole file, so we need to check each font inside to get the

   100

	 * proper font. If not found, we will use the last font in the ttc.

   101

	 * Also note that FreeType does not support UNICODE filesnames! */

   102

#if defined(UNICODE)

   103

	font_path = malloc(MAX_PATH);

   104

	font_path = convert_from_fs(vbuffer, font_path, MAX_PATH);

   105

#else

   106

	font_path = vbuffer;

   107

#endif

   108

   109

	ttd_strlcat(font_path, "\\", MAX_PATH);

   110

	ttd_strlcat(font_path, WIDE_TO_MB(dbuffer), MAX_PATH);

   111

	index = 0;

   112

	do {

   113

		err = FT_New_Face(_library, font_path, index, face);

   114

		if (err != FT_Err_Ok) break;

   115

   116

		if (strncasecmp(font_name, (*face)->family_name, strlen((*face)->family_name)) == 0) break;

   117

		err = FT_Err_Cannot_Open_Resource;

   118

   119

	} while ((FT_Long)++index != (*face)->num_faces);

   120

   121

#if defined(UNICODE)

   122

	free(font_path);

   123

#endif

   124

   125

folder_error:

   126

	RegCloseKey(hKey);

   127

	return err;

   128

}

   129

#else

   130

# ifdef WITH_FONTCONFIG

   131

static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)

   132

{

   133

	FT_Error err = FT_Err_Cannot_Open_Resource;

   134

   135

	if (!FcInit()) {

   136

		ShowInfoF("Unable to load font configuration");

   137

	} else {

   138

		FcPattern *match;

   139

		FcPattern *pat;

   140

		FcFontSet *fs;

   141

		FcResult  result;

   142

		char *font_style;

   143

		char *font_family;

   144

   145

		/* Split & strip the font's style */

   146

		font_family = strdup(font_name);

   147

		font_style = strchr(font_family, ',');

   148

		if (font_style != NULL) {

   149

			font_style[0] = '\0';

   150

			font_style++;

   151

			while (*font_style == ' ' || *font_style == '\t') font_style++;

   152

		}

   153

   154

		/* Resolve the name and populate the information structure */

   155

		pat = FcNameParse((FcChar8*)font_family);

   156

		if (font_style != NULL) FcPatternAddString(pat, FC_STYLE, (FcChar8*)font_style);

   157

		FcConfigSubstitute(0, pat, FcMatchPattern);

   158

		FcDefaultSubstitute(pat);

   159

		fs = FcFontSetCreate();

   160

		match = FcFontMatch(0, pat, &result);

   161

   162

		if (fs != NULL && match != NULL) {

   163

			int i;

   164

			FcChar8 *family;

   165

			FcChar8 *style;

   166

			FcChar8 *file;

   167

			FcFontSetAdd(fs, match);

   168

   169

			for (i = 0; err != FT_Err_Ok && i < fs->nfont; i++) {

   170

				/* Try the new filename */

   171

				if (FcPatternGetString(fs->fonts[i], FC_FILE,   0, &file)   == FcResultMatch &&

   172

						FcPatternGetString(fs->fonts[i], FC_FAMILY, 0, &family) == FcResultMatch &&

   173

						FcPatternGetString(fs->fonts[i], FC_STYLE,  0, &style)  == FcResultMatch) {

   174

   175

					/* The correct style? */

   176

					if (font_style != NULL && strcasecmp(font_style, (char*)style) != 0) continue;

   177

   178

					/* Font config takes the best shot, which, if the family name is spelled

   179

					* wrongly a 'random' font, so check whether the family name is the

   180

					* same as the supplied name */

   181

					if (strcasecmp(font_family, (char*)family) == 0) {

   182

						err = FT_New_Face(_library, (char *)file, 0, face);

   183

					}

   184

				}

   185

			}

   186

		}

   187

   188

		free(font_family);

   189

		FcPatternDestroy(pat);

   190

		FcFontSetDestroy(fs);

   191

		FcFini();

   192

	}

   193

   194

	return err;

   195

}

   196

# else

   197

FT_Error GetFontByFaceName(const char *font_name, FT_Face *face) {return FT_Err_Cannot_Open_Resource;}

   198

# endif /* WITH_FONTCONFIG */

   199

   200

#endif

   201

   202

/**

   203

 * Loads the freetype font.

   204

 * First type to load the fontname as if it were a path. If that fails,

   205

 * try to resolve the filename of the font using fontconfig, where the

   206

 * format is 'font family name' or 'font family name, font style'.

   207

 */

   208

static void LoadFreeTypeFont(const char *font_name, FT_Face *face, const char *type)

   209

{

   210

	FT_Error error;

   211

   212

	if (strlen(font_name) == 0) return;

   213

   214

	error = FT_New_Face(_library, font_name, 0, face);

   215

   216

	if (error != FT_Err_Ok) error = GetFontByFaceName(font_name, face);

   217

   218

	if (error == FT_Err_Ok) {

   219

		DEBUG(freetype, 2) ("Requested font '%s', found '%s %s'", font_name, (*face)->family_name, (*face)->style_name);

   220

   221

		/* Attempt to select the unicode character map */

   222

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   223

		if (error == FT_Err_Ok) return; // Success

   224

   225

		if (error == FT_Err_Invalid_CharMap_Handle) {

   226

			/* Try to pick a different character map instead. We default to

   227

			 * the first map, but platform_id 0 encoding_id 0 should also

   228

			 * be unicode (strange system...) */

   229

			FT_CharMap found = (*face)->charmaps[0];

   230

			int i;

   231

   232

			for (i = 0; i < (*face)->num_charmaps; i++) {

   233

				FT_CharMap charmap = (*face)->charmaps[i];

   234

				if (charmap->platform_id == 0 && charmap->encoding_id == 0) {

   235

					found = charmap;

   236

				}

   237

			}

   238

   239

			if (found != NULL) {

   240

				error = FT_Set_Charmap(*face, found);

   241

				if (error == FT_Err_Ok) return;

   242

			}

   243

		}

   244

   245

		FT_Done_Face(*face);

   246

		*face = NULL;

   247

	}

   248

   249

	ShowInfoF("Unable to use '%s' for %s font, FreeType reported error 0x%X, using sprite font instead", font_name, type, error);

   250

}

   251

   252

   253

void InitFreeType(void)

   254

{

   255

	if (strlen(_freetype.small_font) == 0 && strlen(_freetype.medium_font) == 0 && strlen(_freetype.large_font) == 0) {

   256

		DEBUG(freetype, 1) ("[FreeType] No font faces specified, using sprite fonts instead");

   257

		return;

   258

	}

   259

   260

	if (FT_Init_FreeType(&_library) != FT_Err_Ok) {

   261

		ShowInfoF("Unable to initialize FreeType, using sprite fonts instead");

   262

		return;

   263

	}

   264

   265

	DEBUG(freetype, 2) ("[FreeType] Initialized");

   266

   267

	/* Load each font */

   268

	LoadFreeTypeFont(_freetype.small_font,  &_face_small,  "small");

   269

	LoadFreeTypeFont(_freetype.medium_font, &_face_medium, "medium");

   270

	LoadFreeTypeFont(_freetype.large_font,  &_face_large,  "large");

   271

   272

	/* Set each font size */

   273

	if (_face_small  != NULL) FT_Set_Pixel_Sizes(_face_small,  0, _freetype.small_size);

   274

	if (_face_medium != NULL) FT_Set_Pixel_Sizes(_face_medium, 0, _freetype.medium_size);

   275

	if (_face_large  != NULL) FT_Set_Pixel_Sizes(_face_large,  0, _freetype.large_size);

   276

}

   277

   278

   279

static FT_Face GetFontFace(FontSize size)

   280

{

   281

	switch (size) {

   282

		default: NOT_REACHED();

   283

		case FS_NORMAL: return _face_medium;

   284

		case FS_SMALL:  return _face_small;

   285

		case FS_LARGE:  return _face_large;

   286

	}

   287

}

   288

   289

   290

typedef struct GlyphEntry {

   291

	Sprite *sprite;

   292

	byte width;

   293

} GlyphEntry;

   294

   295

   296

/* The glyph cache. This is structured to reduce memory consumption.

   297

 * 1) There is a 'segment' table for each font size.

   298

 * 2) Each segment table is a discrete block of characters.

   299

 * 3) Each block contains 256 (aligned) characters sequential characters.

   300

 *

   301

 * The cache is accessed in the following way:

   302

 * For character 0x0041  ('A'): _glyph_ptr[FS_NORMAL][0x00][0x41]

   303

 * For character 0x20AC (Euro): _glyph_ptr[FS_NORMAL][0x20][0xAC]

   304

 *

   305

 * Currently only 256 segments are allocated, "limiting" us to 65536 characters.

   306

 * This can be simply changed in the two functions Get & SetGlyphPtr.

   307

 */

   308

static GlyphEntry **_glyph_ptr[FS_END];

   309

   310

   311

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   312

{

   313

	if (_glyph_ptr[size] == NULL) return NULL;

   314

	if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) return NULL;

   315

	return &_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)];

   316

}

   317

   318

   319

static void SetGlyphPtr(FontSize size, WChar key, const GlyphEntry *glyph)

   320

{

   321

	if (_glyph_ptr[size] == NULL) {

   322

		DEBUG(freetype, 3) ("[FreeType] Allocating root glyph cache for size %u", size);

   323

		_glyph_ptr[size] = calloc(256, sizeof(**_glyph_ptr));

   324

	}

   325

   326

	if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) {

   327

		DEBUG(freetype, 3) ("[FreeType] Allocating glyph cache for range 0x%02X00, size %u", GB(key, 8, 8), size);

   328

		_glyph_ptr[size][GB(key, 8, 8)] = calloc(256, sizeof(***_glyph_ptr));

   329

	}

   330

   331

	DEBUG(freetype, 4) ("[FreeType] Set glyph for unicode character 0x%04X, size %u", key, size);

   332

	_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].sprite = glyph->sprite;

   333

	_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].width  = glyph->width;

   334

}

   335

   336

   337

const Sprite *GetGlyph(FontSize size, WChar key)

   338

{

   339

	FT_Face face = GetFontFace(size);

   340

	FT_GlyphSlot slot;

   341

	GlyphEntry new_glyph;

   342

	GlyphEntry *glyph;

   343

	Sprite *sprite;

   344

	int width;

   345

	int height;

   346

	int x;

   347

	int y;

   348

	int y_adj;

   349

   350

	assert(IsPrintable(key));

   351

   352

	/* Bail out if no face loaded, or for our special characters */

   353

	if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {

   354

		SpriteID sprite = GetUnicodeGlyph(size, key);

   355

		if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');

   356

		return GetSprite(sprite);

   357

	}

   358

   359

	/* Check for the glyph in our cache */

   360

	glyph = GetGlyphPtr(size, key);

   361

	if (glyph != NULL && glyph->sprite != NULL) return glyph->sprite;

   362

   363

	slot = face->glyph;

   364

   365

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   366

	FT_Render_Glyph(face->glyph, FT_RENDER_MODE_MONO);

   367

   368

	/* Add 1 pixel for the shadow on the medium font. Our sprite must be at least 1x1 pixel */

   369

	width  = max(1, slot->bitmap.width + (size == FS_NORMAL));

   370

	height = max(1, slot->bitmap.rows  + (size == FS_NORMAL));

   371

   372

	/* FreeType has rendered the glyph, now we allocate a sprite and copy the image into it */

   373

	sprite = calloc(width * height + 8, 1);

   374

	sprite->info   = 1;

   375

	sprite->width  = width;

   376

	sprite->height = height;

   377

	sprite->x_offs = slot->bitmap_left;

   378

	// XXX 2 should be determined somehow... it's right for the normal face

   379

	y_adj = (size == FS_NORMAL) ? 2 : 0;

   380

	sprite->y_offs = GetCharacterHeight(size) - slot->bitmap_top - y_adj;

   381

   382

	/* Draw shadow for medium size */

   383

	if (size == FS_NORMAL) {

   384

		for (y = 0; y < slot->bitmap.rows; y++) {

   385

			for (x = 0; x < slot->bitmap.width; x++) {

   386

				if (HASBIT(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   387

					sprite->data[1 + x + (1 + y) * sprite->width] = SHADOW_COLOUR;

   388

				}

   389

			}

   390

		}

   391

	}

   392

   393

	for (y = 0; y < slot->bitmap.rows; y++) {

   394

		for (x = 0; x < slot->bitmap.width; x++) {

   395

			if (HASBIT(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   396

				sprite->data[x + y * sprite->width] = FACE_COLOUR;

   397

			}

   398

		}

   399

	}

   400

   401

	new_glyph.sprite = sprite;

   402

	new_glyph.width  = (slot->advance.x >> 6) + (size != FS_NORMAL);

   403

   404

	SetGlyphPtr(size, key, &new_glyph);

   405

   406

	return sprite;

   407

}

   408

   409

   410

uint GetGlyphWidth(FontSize size, WChar key)

   411

{

   412

	FT_Face face = GetFontFace(size);

   413

	GlyphEntry *glyph;

   414

   415

	if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {

   416

		SpriteID sprite = GetUnicodeGlyph(size, key);

   417

		if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');

   418

		return SpriteExists(sprite) ? GetSprite(sprite)->width + (size != FS_NORMAL) : 0;

   419

	}

   420

   421

	glyph = GetGlyphPtr(size, key);

   422

	if (glyph == NULL || glyph->sprite == NULL) {

   423

		GetGlyph(size, key);

   424

		glyph = GetGlyphPtr(size, key);

   425

	}

   426

   427

	return glyph->width;

   428

}

   429

   430

   431

#endif /* WITH_FREETYPE */

   432

   433

/* Sprite based glyph mapping */

   434

   435

#include "table/unicode.h"

   436

   437

static SpriteID **_unicode_glyph_map[FS_END];

   438

   439

   440

/** Get the SpriteID of the first glyph for the given font size */

   441

static SpriteID GetFontBase(FontSize size)

   442

{

   443

	switch (size) {

   444

		default: NOT_REACHED();

   445

		case FS_NORMAL: return SPR_ASCII_SPACE;

   446

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   447

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   448

	}

   449

}

   450

   451

   452

SpriteID GetUnicodeGlyph(FontSize size, uint32 key)

   453

{

   454

	if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) return 0;

   455

	return _unicode_glyph_map[size][GB(key, 8, 8)][GB(key, 0, 8)];

   456

}

   457

   458

   459

void SetUnicodeGlyph(FontSize size, uint32 key, SpriteID sprite)

   460

{

   461

	if (_unicode_glyph_map[size] == NULL) _unicode_glyph_map[size] = calloc(256, sizeof(*_unicode_glyph_map[size]));

   462

	if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) _unicode_glyph_map[size][GB(key, 8, 8)] = calloc(256, sizeof(**_unicode_glyph_map[size]));

   463

	_unicode_glyph_map[size][GB(key, 8, 8)][GB(key, 0, 8)] = sprite;

   464

}

   465

   466

   467

void InitializeUnicodeGlyphMap(void)

   468

{

   469

	FontSize size;

   470

	SpriteID base;

   471

	SpriteID sprite;

   472

	uint i;

   473

   474

	for (size = FS_NORMAL; size != FS_END; size++) {

   475

		/* Clear out existing glyph map if it exists */

   476

		if (_unicode_glyph_map[size] != NULL) {

   477

			for (i = 0; i < 256; i++) {

   478

				if (_unicode_glyph_map[size][i] != NULL) free(_unicode_glyph_map[size][i]);

   479

			}

   480

			free(_unicode_glyph_map[size]);

   481

			_unicode_glyph_map[size] = NULL;

   482

		}

   483

   484

		base = GetFontBase(size);

   485

		for (i = ASCII_LETTERSTART; i < 256; i++) {

   486

			sprite = base + i - ASCII_LETTERSTART;

   487

			if (!SpriteExists(sprite)) continue;

   488

			SetUnicodeGlyph(size, i, sprite);

   489

			SetUnicodeGlyph(size, i + SCC_SPRITE_START, sprite);

   490

		}

   491

		for (i = 0; i < lengthof(_default_unicode_map); i++) {

   492

			sprite = base + _default_unicode_map[i].key - ASCII_LETTERSTART;

   493

			SetUnicodeGlyph(size, _default_unicode_map[i].code, sprite);

   494

		}

   495

	}

   496

}

   497