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

#include "spriteloader/spriteloader.hpp"

    19

    20

#ifdef WITH_FREETYPE

    21

    22

#include <ft2build.h>

    23

#include FT_FREETYPE_H

    24

#include FT_GLYPH_H

    25

    26

#ifdef WITH_FONTCONFIG

    27

#include <fontconfig/fontconfig.h>

    28

#endif

    29

    30

static FT_Library _library = NULL;

    31

static FT_Face _face_small = NULL;

    32

static FT_Face _face_medium = NULL;

    33

static FT_Face _face_large = NULL;

    34

    35

FreeTypeSettings _freetype;

    36

    37

enum {

    38

	FACE_COLOUR = 1,

    39

	SHADOW_COLOUR = 2,

    40

};

    41

    42

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

    43

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

    44

#ifdef WIN32

    45

#include <windows.h>

    46

#include <tchar.h>

    47

#include <shlobj.h> // SHGetFolderPath

    48

#include "win32.h"

    49

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

 * font for all font sizes */

    58

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

    59

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

    60

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

    61

{

    62

	FT_Error err = FT_Err_Cannot_Open_Resource;

    63

	HKEY hKey;

    64

	LONG ret;

    65

	TCHAR vbuffer[MAX_PATH], dbuffer[256];

    66

	TCHAR *font_namep;

    67

	char *font_path;

    68

	uint index;

    69

    70

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

    71

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

    72

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

    73

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

    74

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

    75

    76

	if (ret != ERROR_SUCCESS) {

    77

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

    78

		return err;

    79

	}

    80

    81

	/* For Unicode we need some conversion between widechar and

    82

	 * normal char to match the data returned by RegEnumValue,

    83

	 * otherwise just use parameter */

    84

#if defined(UNICODE)

    85

	font_namep = MallocT<TCHAR>(MAX_PATH);

    86

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

    87

#else

    88

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

    89

#endif

    90

    91

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

    92

		TCHAR *s;

    93

		DWORD vbuflen = lengthof(vbuffer);

    94

		DWORD dbuflen = lengthof(dbuffer);

    95

    96

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

    97

		if (ret != ERROR_SUCCESS) goto registry_no_font_found;

    98

    99

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

   100

		 * - ADMUI3.fon

   101

		 * - Book Antiqua Bold (TrueType)

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

   111

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

   112

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

   113

		} else {

   114

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

   115

		}

   116

	}

   117

   118

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

   119

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

   120

		goto folder_error;

   121

	}

   122

   123

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

   124

	 * contain multiple fonts inside this single file. GetFontData however

   125

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

   126

	 * proper font.

   127

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

   128

#if defined(UNICODE)

   129

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

   130

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

   131

	 * font_name search */

   132

	font_path = (char*)font_namep;

   133

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

   134

#else

   135

	font_path = vbuffer;

   136

#endif

   137

   138

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

   139

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

   140

	index = 0;

   141

	do {

   142

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

   143

		if (err != FT_Err_Ok) break;

   144

   145

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

   146

		err = FT_Err_Cannot_Open_Resource;

   147

   148

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

   149

   150

   151

folder_error:

   152

registry_no_font_found:

   153

#if defined(UNICODE)

   154

	free(font_namep);

   155

#endif

   156

	RegCloseKey(hKey);

   157

	return err;

   158

}

   159

#else

   160

# ifdef WITH_FONTCONFIG

   161

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

   162

{

   163

	FT_Error err = FT_Err_Cannot_Open_Resource;

   164

   165

	if (!FcInit()) {

   166

		ShowInfoF("Unable to load font configuration");

   167

	} else {

   168

		FcPattern *match;

   169

		FcPattern *pat;

   170

		FcFontSet *fs;

   171

		FcResult  result;

   172

		char *font_style;

   173

		char *font_family;

   174

   175

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

   176

		font_family = strdup(font_name);

   177

		font_style = strchr(font_family, ',');

   178

		if (font_style != NULL) {

   179

			font_style[0] = '\0';

   180

			font_style++;

   181

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

   182

		}

   183

   184

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

   185

		pat = FcNameParse((FcChar8*)font_family);

   186

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

   187

		FcConfigSubstitute(0, pat, FcMatchPattern);

   188

		FcDefaultSubstitute(pat);

   189

		fs = FcFontSetCreate();

   190

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

   191

   192

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

   193

			int i;

   194

			FcChar8 *family;

   195

			FcChar8 *style;

   196

			FcChar8 *file;

   197

			FcFontSetAdd(fs, match);

   198

   199

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

   200

				/* Try the new filename */

   201

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

   202

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

   203

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

   204

   205

					/* The correct style? */

   206

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

   207

   208

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

   209

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

   210

					* same as the supplied name */

   211

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

   212

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

   213

					}

   214

				}

   215

			}

   216

		}

   217

   218

		free(font_family);

   219

		FcPatternDestroy(pat);

   220

		FcFontSetDestroy(fs);

   221

		FcFini();

   222

	}

   223

   224

	return err;

   225

}

   226

# else

   227

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

   228

# endif /* WITH_FONTCONFIG */

   229

   230

#endif

   231

   232

/**

   233

 * Loads the freetype font.

   234

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

   235

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

   236

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

   237

 */

   238

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

   239

{

   240

	FT_Error error;

   241

   242

	if (StrEmpty(font_name)) return;

   243

   244

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

   245

   246

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

   247

   248

	if (error == FT_Err_Ok) {

   249

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

   250

   251

		/* Attempt to select the unicode character map */

   252

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   253

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

   254

   255

		if (error == FT_Err_Invalid_CharMap_Handle) {

   256

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

   257

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

   258

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

   259

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

   260

			int i;

   261

   262

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

   263

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

   264

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

   265

					found = charmap;

   266

				}

   267

			}

   268

   269

			if (found != NULL) {

   270

				error = FT_Set_Charmap(*face, found);

   271

				if (error == FT_Err_Ok) return;

   272

			}

   273

		}

   274

	}

   275

   276

	FT_Done_Face(*face);

   277

	*face = NULL;

   278

   279

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

   280

}

   281

   282

   283

void InitFreeType()

   284

{

   285

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

   286

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

   287

		return;

   288

	}

   289

   290

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

   291

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

   292

		return;

   293

	}

   294

   295

	DEBUG(freetype, 2, "Initialized");

   296

   297

	/* Load each font */

   298

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

   299

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

   300

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

   301

   302

	/* Set each font size */

   303

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

   304

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

   305

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

   306

}

   307

   308

   309

static FT_Face GetFontFace(FontSize size)

   310

{

   311

	switch (size) {

   312

		default: NOT_REACHED();

   313

		case FS_NORMAL: return _face_medium;

   314

		case FS_SMALL:  return _face_small;

   315

		case FS_LARGE:  return _face_large;

   316

	}

   317

}

   318

   319

   320

struct GlyphEntry {

   321

	Sprite *sprite;

   322

	byte width;

   323

};

   324

   325

   326

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

   327

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

   328

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

   329

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

   330

 *

   331

 * The cache is accessed in the following way:

   332

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

   333

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

   334

 *

   335

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

   336

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

   337

 */

   338

static GlyphEntry **_glyph_ptr[FS_END];

   339

   340

   341

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   342

{

   343

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

   344

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

   345

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

   346

}

   347

   348

   349

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

   350

{

   351

	if (_glyph_ptr[size] == NULL) {

   352

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

   353

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

   354

	}

   355

   356

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

   357

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

   358

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

   359

	}

   360

   361

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

   362

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

   363

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

   364

}

   365

   366

void *AllocateFont(size_t size)

   367

{

   368

	return malloc(size);

   369

}

   370

   371

   387

const Sprite *GetGlyph(FontSize size, WChar key)

   388

{

   389

	FT_Face face = GetFontFace(size);

   390

	FT_GlyphSlot slot;

   391

	GlyphEntry new_glyph;

   392

	GlyphEntry *glyph;

   393

	SpriteLoader::Sprite sprite;

   394

	int width;

   395

	int height;

   396

	int x;

   397

	int y;

   398

	int y_adj;

   399

   400

	assert(IsPrintable(key));

   401

   402

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

   403

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

   404

		SpriteID sprite = GetUnicodeGlyph(size, key);

   405

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

   406

		return GetSprite(sprite);

   407

	}

   408

   409

	/* Check for the glyph in our cache */

   410

	glyph = GetGlyphPtr(size, key);

   411

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

   412

   413

	slot = face->glyph;

   414

   417

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   419

   420

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

   421

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

   422

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

   423

   424

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

   425

	sprite.data = CallocT<SpriteLoader::CommonPixel>(width * height);

   426

	sprite.width = width;

   427

	sprite.height = height;

   428

	sprite.x_offs = slot->bitmap_left;

   429

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

   430

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

   431

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

   432

   433

	/* Draw shadow for medium size */

   434

	if (size == FS_NORMAL) {

   435

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

   436

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

   438

					sprite.data[1 + x + (1 + y) * sprite.width].m = SHADOW_COLOUR;

   440

				}

   441

			}

   442

		}

   443

	}

   444

   445

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

   446

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

   448

				sprite.data[x + y * sprite.width].m = FACE_COLOUR;

   450

			}

   451

		}

   452

	}

   453

   454

	new_glyph.sprite = BlitterFactoryBase::GetCurrentBlitter()->Encode(&sprite, AllocateFont);

   455

	free(sprite.data);

   456

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

   457

   458

	SetGlyphPtr(size, key, &new_glyph);

   459

   460

	return new_glyph.sprite;

   461

}

   462

   463

   464

uint GetGlyphWidth(FontSize size, WChar key)

   465

{

   466

	FT_Face face = GetFontFace(size);

   467

	GlyphEntry *glyph;

   468

   469

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

   470

		SpriteID sprite = GetUnicodeGlyph(size, key);

   471

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

   472

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

   473

	}

   474

   475

	glyph = GetGlyphPtr(size, key);

   476

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

   477

		GetGlyph(size, key);

   478

		glyph = GetGlyphPtr(size, key);

   479

	}

   480

   481

	return glyph->width;

   482

}

   483

   484

   485

#endif /* WITH_FREETYPE */

   486

   487

/* Sprite based glyph mapping */

   488

   489

#include "table/unicode.h"

   490

   491

static SpriteID **_unicode_glyph_map[FS_END];

   492

   493

   494

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

   495

static SpriteID GetFontBase(FontSize size)

   496

{

   497

	switch (size) {

   498

		default: NOT_REACHED();

   499

		case FS_NORMAL: return SPR_ASCII_SPACE;

   500

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   501

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   502

	}

   503

}

   504

   505