1

/* $Id$ */

     2

     3

/** @file fontcache.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "macros.h"

     9

#include "debug.h"

    10

#include "table/sprites.h"

    11

#include "table/control_codes.h"

    12

#include "spritecache.h"

    13

#include "gfx.h"

    14

#include "string.h"

    15

#include "fontcache.h"

    16

#include "helpers.hpp"

    17

    18

#ifdef WITH_FREETYPE

    19

    20

#include <ft2build.h>

    21

#include FT_FREETYPE_H

    22

#include FT_GLYPH_H

    23

    24

#ifdef WITH_FONTCONFIG

    25

#include <fontconfig/fontconfig.h>

    26

#endif

    27

    28

static FT_Library _library = NULL;

    29

static FT_Face _face_small = NULL;

    30

static FT_Face _face_medium = NULL;

    31

static FT_Face _face_large = NULL;

    32

    33

FreeTypeSettings _freetype;

    34

    35

enum {

    36

	FACE_COLOUR = 1,

    37

	SHADOW_COLOUR = 2,

    38

};

    39

    40

/** Get the font loaded into a Freetype face by using a font-name.

    41

 * If no appropiate font is found, the function returns an error */

    42

#ifdef WIN32

    43

#include <windows.h>

    44

#include <tchar.h>

    45

#include <shlobj.h> // SHGetFolderPath

    46

#include "win32.h"

    47

    48

/* Get the font file to be loaded into Freetype by looping the registry

    49

 * location where windows lists all installed fonts. Not very nice, will

    50

 * surely break if the registry path changes, but it works. Much better

    51

 * solution would be to use CreateFont, and extract the font data from it

    52

 * by GetFontData. The problem with this is that the font file needs to be

    53

 * kept in memory then until the font is no longer needed. This could mean

    54

 * an additional memory usage of 30MB (just for fonts!) when using an eastern

    55

 * font for all font sizes */

    56

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

    57

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

    58

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

    59

{

    60

	FT_Error err = FT_Err_Cannot_Open_Resource;

    61

	HKEY hKey;

    62

	LONG ret;

    63

	TCHAR vbuffer[MAX_PATH], dbuffer[256];

    64

	TCHAR *font_namep;

    65

	char *font_path;

    66

	uint index;

    67

    68

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

    69

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

    70

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

    71

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

    72

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

    73

    74

	if (ret != ERROR_SUCCESS) {

    75

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

    76

		return err;

    77

	}

    78

    79

	/* For Unicode we need some conversion between widechar and

    80

	 * normal char to match the data returned by RegEnumValue,

    81

	 * otherwise just use parameter */

    82

#if defined(UNICODE)

    83

	font_namep = MallocT<TCHAR>(MAX_PATH);

    84

	MB_TO_WIDE_BUFFER(font_name, font_namep, MAX_PATH * sizeof(TCHAR));

    85

#else

    86

	font_namep = (char*)font_name; // only cast because in unicode pointer is not const

    87

#endif

    88

    89

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

    90

		TCHAR *s;

    91

		DWORD vbuflen = lengthof(vbuffer);

    92

		DWORD dbuflen = lengthof(dbuffer);

    93

    94

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

    95

		if (ret != ERROR_SUCCESS) goto registry_no_font_found;

    96

    97

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

    98

		 * - ADMUI3.fon

    99

		 * - Book Antiqua Bold (TrueType)

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

		s = _tcschr(vbuffer, _T('('));

   107

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

   108

   109

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

   110

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

   111

		} else {

   112

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

   113

		}

   114

	}

   115

   116

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

   117

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

   118

		goto folder_error;

   119

	}

   120

   121

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

   122

	 * contain multiple fonts inside this single file. GetFontData however

   123

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

   124

	 * proper font.

   125

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

   126

#if defined(UNICODE)

   127

	/* We need a cast here back from wide because FreeType doesn't support

   128

	 * widechar filenames. Just use the buffer we allocated before for the

   129

	 * font_name search */

   130

	font_path = (char*)font_namep;

   131

	WIDE_TO_MB_BUFFER(vbuffer, font_path, MAX_PATH * sizeof(TCHAR));

   132

#else

   133

	font_path = vbuffer;

   134

#endif

   135

   136

	ttd_strlcat(font_path, "\\", MAX_PATH * sizeof(TCHAR));

   137

	ttd_strlcat(font_path, WIDE_TO_MB(dbuffer), MAX_PATH * sizeof(TCHAR));

   138

	index = 0;

   139

	do {

   140

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

   141

		if (err != FT_Err_Ok) break;

   142

   143

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

   144

		err = FT_Err_Cannot_Open_Resource;

   145

   146

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

   147

   148

   149

folder_error:

   150

#if defined(UNICODE)

   151

	free(font_path);

   152

#endif

   153

registry_no_font_found:

   154

	RegCloseKey(hKey);

   155

	return err;

   156

}

   157

#else

   158

# ifdef WITH_FONTCONFIG

   159

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

   160

{

   161

	FT_Error err = FT_Err_Cannot_Open_Resource;

   162

   163

	if (!FcInit()) {

   164

		ShowInfoF("Unable to load font configuration");

   165

	} else {

   166

		FcPattern *match;

   167

		FcPattern *pat;

   168

		FcFontSet *fs;

   169

		FcResult  result;

   170

		char *font_style;

   171

		char *font_family;

   172

   173

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

   174

		font_family = strdup(font_name);

   175

		font_style = strchr(font_family, ',');

   176

		if (font_style != NULL) {

   177

			font_style[0] = '\0';

   178

			font_style++;

   179

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

   180

		}

   181

   182

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

   183

		pat = FcNameParse((FcChar8*)font_family);

   184

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

   185

		FcConfigSubstitute(0, pat, FcMatchPattern);

   186

		FcDefaultSubstitute(pat);

   187

		fs = FcFontSetCreate();

   188

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

   189

   190

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

   191

			int i;

   192

			FcChar8 *family;

   193

			FcChar8 *style;

   194

			FcChar8 *file;

   195

			FcFontSetAdd(fs, match);

   196

   197

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

   198

				/* Try the new filename */

   199

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

   200

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

   201

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

   202

   203

					/* The correct style? */

   204

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

   205

   206

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

   207

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

   208

					* same as the supplied name */

   209

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

   210

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

   211

					}

   212

				}

   213

			}

   214

		}

   215

   216

		free(font_family);

   217

		FcPatternDestroy(pat);

   218

		FcFontSetDestroy(fs);

   219

		FcFini();

   220

	}

   221

   222

	return err;

   223

}

   224

# else

   225

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

   226

# endif /* WITH_FONTCONFIG */

   227

   228

#endif

   229

   230

/**

   231

 * Loads the freetype font.

   232

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

   233

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

   234

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

   235

 */

   236

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

   237

{

   238

	FT_Error error;

   239

   240

	if (StrEmpty(font_name)) return;

   241

   242

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

   243

   244

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

   245

   246

	if (error == FT_Err_Ok) {

   247

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

   248

   249

		/* Attempt to select the unicode character map */

   250

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   251

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

   252

   253

		if (error == FT_Err_Invalid_CharMap_Handle) {

   254

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

   255

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

   256

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

   257

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

   258

			int i;

   259

   260

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

   261

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

   262

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

   263

					found = charmap;

   264

				}

   265

			}

   266

   267

			if (found != NULL) {

   268

				error = FT_Set_Charmap(*face, found);

   269

				if (error == FT_Err_Ok) return;

   270

			}

   271

		}

   272

	}

   273

   274

	FT_Done_Face(*face);

   275

	*face = NULL;

   276

   277

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

   278

}

   279

   280

   281

void InitFreeType()

   282

{

   283

	if (StrEmpty(_freetype.small_font) && StrEmpty(_freetype.medium_font) && StrEmpty(_freetype.large_font)) {

   284

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

   285

		return;

   286

	}

   287

   288

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

   289

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

   290

		return;

   291

	}

   292

   293

	DEBUG(freetype, 2, "Initialized");

   294

   295

	/* Load each font */

   296

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

   297

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

   298

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

   299

   300

	/* Set each font size */

   301

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

   302

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

   303

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

   304

}

   305

   306

   307

static FT_Face GetFontFace(FontSize size)

   308

{

   309

	switch (size) {

   310

		default: NOT_REACHED();

   311

		case FS_NORMAL: return _face_medium;

   312

		case FS_SMALL:  return _face_small;

   313

		case FS_LARGE:  return _face_large;

   314

	}

   315

}

   316

   317

   318

struct GlyphEntry {

   319

	Sprite *sprite;

   320

	byte width;

   321

};

   322

   323

   324

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

   325

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

   326

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

   327

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

   328

 *

   329

 * The cache is accessed in the following way:

   330

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

   331

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

   332

 *

   333

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

   334

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

   335

 */

   336

static GlyphEntry **_glyph_ptr[FS_END];

   337

   338

   339

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   340

{

   341

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

   342

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

   343

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

   344

}

   345

   346

   347

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

   348

{

   349

	if (_glyph_ptr[size] == NULL) {

   350

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

   351

		_glyph_ptr[size] = CallocT<GlyphEntry*>(256);

   352

	}

   353

   354

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

   355

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

   356

		_glyph_ptr[size][GB(key, 8, 8)] = CallocT<GlyphEntry>(256);

   357

	}

   358

   359

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

   360

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

   361

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

   362

}

   363

   364

   365

const Sprite *GetGlyph(FontSize size, WChar key)

   366

{

   367

	FT_Face face = GetFontFace(size);

   368

	FT_GlyphSlot slot;

   369

	GlyphEntry new_glyph;

   370

	GlyphEntry *glyph;

   371

	Sprite *sprite;

   372

	int width;

   373

	int height;

   374

	int x;

   375

	int y;

   376

	int y_adj;

   377

   378

	assert(IsPrintable(key));

   379

   380

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

   381

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

   382

		SpriteID sprite = GetUnicodeGlyph(size, key);

   383

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

   384

		return GetSprite(sprite);

   385

	}

   386

   387

	/* Check for the glyph in our cache */

   388

	glyph = GetGlyphPtr(size, key);

   389

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

   390

   391

	slot = face->glyph;

   392

   393

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   394

	FT_Render_Glyph(face->glyph, FT_RENDER_MODE_MONO);

   395

   396

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

   397

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

   398

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

   399

   400

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

   401

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

   402

	sprite->info   = 1;

   403

	sprite->width  = width;

   404

	sprite->height = height;

   405

	sprite->x_offs = slot->bitmap_left;

   406

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

   407

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

   408

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

   409

   410

	/* Draw shadow for medium size */

   411

	if (size == FS_NORMAL) {

   412

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

   413

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

   414

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

   415

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

   416

				}

   417

			}

   418

		}

   419

	}

   420

   421

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

   422

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

   423

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

   424

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

   425

			}

   426

		}

   427

	}

   428

   429

	new_glyph.sprite = sprite;

   430

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

   431

   432

	SetGlyphPtr(size, key, &new_glyph);

   433

   434

	return sprite;

   435

}

   436

   437

   438

uint GetGlyphWidth(FontSize size, WChar key)

   439

{

   440

	FT_Face face = GetFontFace(size);

   441

	GlyphEntry *glyph;

   442

   443

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

   444

		SpriteID sprite = GetUnicodeGlyph(size, key);

   445

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

   446

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

   447

	}

   448

   449

	glyph = GetGlyphPtr(size, key);

   450

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

   451

		GetGlyph(size, key);

   452

		glyph = GetGlyphPtr(size, key);

   453

	}

   454

   455

	return glyph->width;

   456

}

   457

   458

   459

#endif /* WITH_FREETYPE */

   460

   461

/* Sprite based glyph mapping */

   462

   463

#include "table/unicode.h"

   464

   465

static SpriteID **_unicode_glyph_map[FS_END];

   466

   467

   468

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

   469

static SpriteID GetFontBase(FontSize size)

   470

{

   471

	switch (size) {

   472

		default: NOT_REACHED();

   473

		case FS_NORMAL: return SPR_ASCII_SPACE;

   474

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   475

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   476

	}

   477

}

   478

   479

   480

SpriteID GetUnicodeGlyph(FontSize size, uint32 key)

   481

{

   482

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

   483

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

   484

}

   485

   486

   487

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

   488

{

   489

	if (_unicode_glyph_map[size] == NULL) _unicode_glyph_map[size] = CallocT<SpriteID*>(256);

   490

	if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) _unicode_glyph_map[size][GB(key, 8, 8)] = CallocT<SpriteID>(256);

   491

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

   492

}

   493

   494

   495

void InitializeUnicodeGlyphMap()

   496

{

   497

	FontSize size;

   498

	SpriteID base;

   499

	SpriteID sprite;

   500

	uint i;

   501

   502

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

   503

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

   504

		if (_unicode_glyph_map[size] != NULL) {

   505

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

   506

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

   507

			}

   508

			free(_unicode_glyph_map[size]);