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) goto registry_no_font_found;

    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.

   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

registry_no_font_found:

   127

	RegCloseKey(hKey);

   128

	return err;

   129

}

   130

#else

   131

# ifdef WITH_FONTCONFIG

   132

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

   133

{

   134

	FT_Error err = FT_Err_Cannot_Open_Resource;

   135

   136

	if (!FcInit()) {

   137

		ShowInfoF("Unable to load font configuration");

   138

	} else {

   139

		FcPattern *match;

   140

		FcPattern *pat;

   141

		FcFontSet *fs;

   142

		FcResult  result;

   143

		char *font_style;

   144

		char *font_family;

   145

   146

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

   147

		font_family = strdup(font_name);

   148

		font_style = strchr(font_family, ',');

   149

		if (font_style != NULL) {

   150

			font_style[0] = '\0';

   151

			font_style++;

   152

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

   153

		}

   154

   155

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

   156

		pat = FcNameParse((FcChar8*)font_family);

   157

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

   158

		FcConfigSubstitute(0, pat, FcMatchPattern);

   159

		FcDefaultSubstitute(pat);

   160

		fs = FcFontSetCreate();

   161

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

   162

   163

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

   164

			int i;

   165

			FcChar8 *family;

   166

			FcChar8 *style;

   167

			FcChar8 *file;

   168

			FcFontSetAdd(fs, match);

   169

   170

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

   171

				/* Try the new filename */

   172

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

   173

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

   174

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

   175

   176

					/* The correct style? */

   177

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

   178

   179

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

   180

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

   181

					* same as the supplied name */

   182

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

   183

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

   184

					}

   185

				}

   186

			}

   187

		}

   188

   189

		free(font_family);

   190

		FcPatternDestroy(pat);

   191

		FcFontSetDestroy(fs);

   192

		FcFini();

   193

	}

   194

   195

	return err;

   196

}

   197

# else

   198

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

   199

# endif /* WITH_FONTCONFIG */

   200

   201

#endif

   202

   203

/**

   204

 * Loads the freetype font.

   205

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

   206

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

   207

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

   208

 */

   209

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

   210

{

   211

	FT_Error error;

   212

   213

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

   214

   215

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

   216

   217

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

   218

   219

	if (error == FT_Err_Ok) {

   220

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

   221

   222

		/* Attempt to select the unicode character map */

   223

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   224

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

   225

   226

		if (error == FT_Err_Invalid_CharMap_Handle) {

   227

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

   228

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

   229

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

   230

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

   231

			int i;

   232

   233

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

   234

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

   235

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

   236

					found = charmap;

   237

				}

   238

			}

   239

   240

			if (found != NULL) {

   241

				error = FT_Set_Charmap(*face, found);

   242

				if (error == FT_Err_Ok) return;

   243

			}

   244

		}

   245

	}

   246

   247

	FT_Done_Face(*face);

   248

	*face = NULL;

   249

   250

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

   251

}

   252

   253

   254

void InitFreeType(void)

   255

{

   256

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

   257

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

   258

		return;

   259

	}

   260

   261

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

   262

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

   263

		return;

   264

	}

   265

   266

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

   267

   268

	/* Load each font */

   269

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

   270

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

   271

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

   272

   273

	/* Set each font size */

   274

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

   275

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

   276

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

   277

}

   278

   279

   280

static FT_Face GetFontFace(FontSize size)

   281

{

   282

	switch (size) {

   283

		default: NOT_REACHED();

   284

		case FS_NORMAL: return _face_medium;

   285

		case FS_SMALL:  return _face_small;

   286

		case FS_LARGE:  return _face_large;

   287

	}

   288

}

   289

   290

   291

typedef struct GlyphEntry {

   292

	Sprite *sprite;

   293

	byte width;

   294

} GlyphEntry;

   295

   296

   297

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

   298

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

   299

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

   300

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

   301

 *

   302

 * The cache is accessed in the following way:

   303

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

   304

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

   305

 *

   306

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

   307

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

   308

 */

   309

static GlyphEntry **_glyph_ptr[FS_END];

   310

   311

   312

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   313

{

   314

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

   315

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

   316

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

   317

}

   318

   319

   320

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

   321

{

   322

	if (_glyph_ptr[size] == NULL) {

   323

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

   324

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

   325

	}

   326

   327

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

   328

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

   329

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

   330

	}

   331

   332

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

   333

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

   334

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

   335

}

   336

   337

   338

const Sprite *GetGlyph(FontSize size, WChar key)

   339

{

   340

	FT_Face face = GetFontFace(size);

   341

	FT_GlyphSlot slot;

   342

	GlyphEntry new_glyph;

   343

	GlyphEntry *glyph;

   344

	Sprite *sprite;

   345

	int width;

   346

	int height;

   347

	int x;

   348

	int y;

   349

	int y_adj;

   350

   351

	assert(IsPrintable(key));

   352

   353

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

   354

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

   355

		SpriteID sprite = GetUnicodeGlyph(size, key);

   356

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

   357

		return GetSprite(sprite);

   358

	}

   359

   360

	/* Check for the glyph in our cache */

   361

	glyph = GetGlyphPtr(size, key);

   362

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

   363

   364

	slot = face->glyph;

   365

   366

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   367

	FT_Render_Glyph(face->glyph, FT_RENDER_MODE_MONO);

   368

   369

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

   370

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

   371

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

   372

   373

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

   374

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

   375

	sprite->info   = 1;

   376

	sprite->width  = width;

   377

	sprite->height = height;

   378

	sprite->x_offs = slot->bitmap_left;

   379

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

   380

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

   381

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

   382

   383

	/* Draw shadow for medium size */

   384

	if (size == FS_NORMAL) {

   385

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

   386

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

   387

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

   388

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

   389

				}

   390

			}

   391

		}

   392

	}

   393

   394

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

   395

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

   396

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

   397

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

   398

			}

   399

		}

   400

	}

   401

   402

	new_glyph.sprite = sprite;

   403

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

   404

   405

	SetGlyphPtr(size, key, &new_glyph);

   406

   407

	return sprite;

   408

}

   409

   410

   411

uint GetGlyphWidth(FontSize size, WChar key)

   412

{

   413

	FT_Face face = GetFontFace(size);

   414

	GlyphEntry *glyph;

   415

   416

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

   417

		SpriteID sprite = GetUnicodeGlyph(size, key);

   418

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

   419

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

   420

	}

   421

   422

	glyph = GetGlyphPtr(size, key);

   423

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

   424

		GetGlyph(size, key);

   425

		glyph = GetGlyphPtr(size, key);

   426

	}

   427

   428

	return glyph->width;

   429

}

   430

   431

   432

#endif /* WITH_FREETYPE */

   433

   434

/* Sprite based glyph mapping */

   435

   436

#include "table/unicode.h"

   437

   438

static SpriteID **_unicode_glyph_map[FS_END];

   439

   440

   441

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

   442

static SpriteID GetFontBase(FontSize size)

   443

{

   444

	switch (size) {

   445

		default: NOT_REACHED();

   446

		case FS_NORMAL: return SPR_ASCII_SPACE;

   447

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   448

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   449

	}

   450

}

   451

   452

   453

SpriteID GetUnicodeGlyph(FontSize size, uint32 key)

   454

{

   455

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

   456

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

   457

}

   458

   459

   460

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

   461

{

   462

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

   463

	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]));

   464

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

   465

}

   466

   467

   468

void InitializeUnicodeGlyphMap(void)

   469

{

   470

	FontSize size;

   471

	SpriteID base;

   472

	SpriteID sprite;

   473

	uint i;

   474

   475

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

   476

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

   477

		if (_unicode_glyph_map[size] != NULL) {

   478

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

   479

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

   480

			}

   481

			free(_unicode_glyph_map[size]);

   482

			_unicode_glyph_map[size] = NULL;

   483

		}

   484

   485

		base = GetFontBase(size);

   486

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

   487

			sprite = base + i - ASCII_LETTERSTART;

   488

			if (!SpriteExists(sprite)) continue;

   489

			SetUnicodeGlyph(size, i, sprite);

   490

			SetUnicodeGlyph(size, i + SCC_SPRITE_START, sprite);

   491

		}

   492

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

   493

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

   494

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

   495

		}

   496

	}

   497

}

   498