fontcache.cpp

Go to the documentation of this file.
00001 /* $Id: fontcache.cpp 22886 2011-09-03 18:56:34Z frosch $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #include "stdafx.h"
00013 #include "fontcache.h"
00014 #include "blitter/factory.hpp"
00015 #include "core/math_func.hpp"
00016 
00017 #include "table/sprites.h"
00018 #include "table/control_codes.h"
00019 
00020 static const int ASCII_LETTERSTART = 32; 
00021 
00023 int _font_height[FS_END];
00024 
00025 #ifdef WITH_FREETYPE
00026 #include <ft2build.h>
00027 #include FT_FREETYPE_H
00028 #include FT_GLYPH_H
00029 
00030 #ifdef WITH_FONTCONFIG
00031 #include <fontconfig/fontconfig.h>
00032 #endif
00033 
00034 static FT_Library _library = NULL;
00035 static FT_Face _face_small = NULL;
00036 static FT_Face _face_medium = NULL;
00037 static FT_Face _face_large = NULL;
00038 static int _ascender[FS_END];
00039 
00040 FreeTypeSettings _freetype;
00041 
00042 static const byte FACE_COLOUR   = 1;
00043 static const byte SHADOW_COLOUR = 2;
00044 
00050 /* ========================================================================================
00051  * Windows support
00052  * ======================================================================================== */
00053 
00054 #ifdef WIN32
00055 #include <windows.h>
00056 #include <shlobj.h> /* SHGetFolderPath */
00057 #include "os/windows/win32.h"
00058 
00069 char *GetShortPath(const char *long_path)
00070 {
00071   static char short_path[MAX_PATH];
00072 #ifdef UNICODE
00073   /* The non-unicode GetShortPath doesn't support UTF-8...,
00074    * so convert the path to wide chars, then get the short
00075    * path and convert it back again. */
00076   wchar_t long_path_w[MAX_PATH];
00077   MultiByteToWideChar(CP_UTF8, 0, long_path, -1, long_path_w, MAX_PATH);
00078 
00079   wchar_t short_path_w[MAX_PATH];
00080   GetShortPathNameW(long_path_w, short_path_w, MAX_PATH);
00081 
00082   WideCharToMultiByte(CP_ACP, 0, short_path_w, -1, short_path, MAX_PATH, NULL, NULL);
00083 #else
00084   /* Technically not needed, but do it for consistency. */
00085   GetShortPathNameA(long_path, short_path, MAX_PATH);
00086 #endif
00087   return short_path;
00088 }
00089 
00090 /* Get the font file to be loaded into Freetype by looping the registry
00091  * location where windows lists all installed fonts. Not very nice, will
00092  * surely break if the registry path changes, but it works. Much better
00093  * solution would be to use CreateFont, and extract the font data from it
00094  * by GetFontData. The problem with this is that the font file needs to be
00095  * kept in memory then until the font is no longer needed. This could mean
00096  * an additional memory usage of 30MB (just for fonts!) when using an eastern
00097  * font for all font sizes */
00098 #define FONT_DIR_NT "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts"
00099 #define FONT_DIR_9X "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Fonts"
00100 static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)
00101 {
00102   FT_Error err = FT_Err_Cannot_Open_Resource;
00103   HKEY hKey;
00104   LONG ret;
00105   TCHAR vbuffer[MAX_PATH], dbuffer[256];
00106   TCHAR *font_namep;
00107   char *font_path;
00108   uint index;
00109 
00110   /* On windows NT (2000, NT3.5, XP, etc.) the fonts are stored in the
00111    * "Windows NT" key, on Windows 9x in the Windows key. To save us having
00112    * to retrieve the windows version, we'll just query both */
00113   ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_NT), 0, KEY_READ, &hKey);
00114   if (ret != ERROR_SUCCESS) ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_9X), 0, KEY_READ, &hKey);
00115 
00116   if (ret != ERROR_SUCCESS) {
00117     DEBUG(freetype, 0, "Cannot open registry key HKLM\\SOFTWARE\\Microsoft\\Windows (NT)\\CurrentVersion\\Fonts");
00118     return err;
00119   }
00120 
00121   /* For Unicode we need some conversion between widechar and
00122    * normal char to match the data returned by RegEnumValue,
00123    * otherwise just use parameter */
00124 #if defined(UNICODE)
00125   font_namep = MallocT<TCHAR>(MAX_PATH);
00126   MB_TO_WIDE_BUFFER(font_name, font_namep, MAX_PATH * sizeof(TCHAR));
00127 #else
00128   font_namep = const_cast<char *>(font_name); // only cast because in unicode pointer is not const
00129 #endif
00130 
00131   for (index = 0;; index++) {
00132     TCHAR *s;
00133     DWORD vbuflen = lengthof(vbuffer);
00134     DWORD dbuflen = lengthof(dbuffer);
00135 
00136     ret = RegEnumValue(hKey, index, vbuffer, &vbuflen, NULL, NULL, (byte*)dbuffer, &dbuflen);
00137     if (ret != ERROR_SUCCESS) goto registry_no_font_found;
00138 
00139     /* The font names in the registry are of the following 3 forms:
00140      * - ADMUI3.fon
00141      * - Book Antiqua Bold (TrueType)
00142      * - Batang & BatangChe & Gungsuh & GungsuhChe (TrueType)
00143      * We will strip the font-type '()' if any and work with the font name
00144      * itself, which must match exactly; if...
00145      * TTC files, font files which contain more than one font are seperated
00146      * byt '&'. Our best bet will be to do substr match for the fontname
00147      * and then let FreeType figure out which index to load */
00148     s = _tcschr(vbuffer, _T('('));
00149     if (s != NULL) s[-1] = '\0';
00150 
00151     if (_tcschr(vbuffer, _T('&')) == NULL) {
00152       if (_tcsicmp(vbuffer, font_namep) == 0) break;
00153     } else {
00154       if (_tcsstr(vbuffer, font_namep) != NULL) break;
00155     }
00156   }
00157 
00158   if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_FONTS, NULL, SHGFP_TYPE_CURRENT, vbuffer))) {
00159     DEBUG(freetype, 0, "SHGetFolderPath cannot return fonts directory");
00160     goto folder_error;
00161   }
00162 
00163   /* Some fonts are contained in .ttc files, TrueType Collection fonts. These
00164    * contain multiple fonts inside this single file. GetFontData however
00165    * returns the whole file, so we need to check each font inside to get the
00166    * proper font.
00167    * Also note that FreeType does not support UNICODE filesnames! */
00168 #if defined(UNICODE)
00169   /* We need a cast here back from wide because FreeType doesn't support
00170    * widechar filenames. Just use the buffer we allocated before for the
00171    * font_name search */
00172   font_path = (char*)font_namep;
00173   WIDE_TO_MB_BUFFER(vbuffer, font_path, MAX_PATH * sizeof(TCHAR));
00174 #else
00175   font_path = vbuffer;
00176 #endif
00177 
00178   ttd_strlcat(font_path, "\\", MAX_PATH * sizeof(TCHAR));
00179   ttd_strlcat(font_path, WIDE_TO_MB(dbuffer), MAX_PATH * sizeof(TCHAR));
00180 
00181   /* Convert the path into something that FreeType understands */
00182   font_path = GetShortPath(font_path);
00183 
00184   index = 0;
00185   do {
00186     err = FT_New_Face(_library, font_path, index, face);
00187     if (err != FT_Err_Ok) break;
00188 
00189     if (strncasecmp(font_name, (*face)->family_name, strlen((*face)->family_name)) == 0) break;
00190     /* Try english name if font name failed */
00191     if (strncasecmp(font_name + strlen(font_name) + 1, (*face)->family_name, strlen((*face)->family_name)) == 0) break;
00192     err = FT_Err_Cannot_Open_Resource;
00193 
00194   } while ((FT_Long)++index != (*face)->num_faces);
00195 
00196 
00197 folder_error:
00198 registry_no_font_found:
00199 #if defined(UNICODE)
00200   free(font_namep);
00201 #endif
00202   RegCloseKey(hKey);
00203   return err;
00204 }
00205 
00219 static const char *GetEnglishFontName(const ENUMLOGFONTEX *logfont)
00220 {
00221   static char font_name[MAX_PATH];
00222   const char *ret_font_name = NULL;
00223   uint pos = 0;
00224   HDC dc;
00225   HGDIOBJ oldfont;
00226   byte *buf;
00227   DWORD dw;
00228   uint16 format, count, stringOffset, platformId, encodingId, languageId, nameId, length, offset;
00229 
00230   HFONT font = CreateFontIndirect(&logfont->elfLogFont);
00231   if (font == NULL) goto err1;
00232 
00233   dc = GetDC(NULL);
00234   oldfont = SelectObject(dc, font);
00235   dw = GetFontData(dc, 'eman', 0, NULL, 0);
00236   if (dw == GDI_ERROR) goto err2;
00237 
00238   buf = MallocT<byte>(dw);
00239   dw = GetFontData(dc, 'eman', 0, buf, dw);
00240   if (dw == GDI_ERROR) goto err3;
00241 
00242   format = buf[pos++] << 8;
00243   format += buf[pos++];
00244   assert(format == 0);
00245   count = buf[pos++] << 8;
00246   count += buf[pos++];
00247   stringOffset = buf[pos++] << 8;
00248   stringOffset += buf[pos++];
00249   for (uint i = 0; i < count; i++) {
00250     platformId = buf[pos++] << 8;
00251     platformId += buf[pos++];
00252     encodingId = buf[pos++] << 8;
00253     encodingId += buf[pos++];
00254     languageId = buf[pos++] << 8;
00255     languageId += buf[pos++];
00256     nameId = buf[pos++] << 8;
00257     nameId += buf[pos++];
00258     if (nameId != 1) {
00259       pos += 4; // skip length and offset
00260       continue;
00261     }
00262     length = buf[pos++] << 8;
00263     length += buf[pos++];
00264     offset = buf[pos++] << 8;
00265     offset += buf[pos++];
00266 
00267     /* Don't buffer overflow */
00268     length = min(length, MAX_PATH - 1);
00269     for (uint j = 0; j < length; j++) font_name[j] = buf[stringOffset + offset + j];
00270     font_name[length] = '\0';
00271 
00272     if ((platformId == 1 && languageId == 0) ||      // Macintosh English
00273         (platformId == 3 && languageId == 0x0409)) { // Microsoft English (US)
00274       ret_font_name = font_name;
00275       break;
00276     }
00277   }
00278 
00279 err3:
00280   free(buf);
00281 err2:
00282   SelectObject(dc, oldfont);
00283   ReleaseDC(NULL, dc);
00284   DeleteObject(font);
00285 err1:
00286   return ret_font_name == NULL ? WIDE_TO_MB((const TCHAR*)logfont->elfFullName) : ret_font_name;
00287 }
00288 
00289 struct EFCParam {
00290   FreeTypeSettings *settings;
00291   LOCALESIGNATURE  locale;
00292   SetFallbackFontCallback *callback;
00293 };
00294 
00295 static int CALLBACK EnumFontCallback(const ENUMLOGFONTEX *logfont, const NEWTEXTMETRICEX *metric, DWORD type, LPARAM lParam)
00296 {
00297   EFCParam *info = (EFCParam *)lParam;
00298 
00299   /* Only use TrueType fonts */
00300   if (!(type & TRUETYPE_FONTTYPE)) return 1;
00301   /* Don't use SYMBOL fonts */
00302   if (logfont->elfLogFont.lfCharSet == SYMBOL_CHARSET) return 1;
00303 
00304   /* The font has to have at least one of the supported locales to be usable. */
00305   if ((metric->ntmFontSig.fsCsb[0] & info->locale.lsCsbSupported[0]) == 0 && (metric->ntmFontSig.fsCsb[1] & info->locale.lsCsbSupported[1]) == 0) {
00306     /* On win9x metric->ntmFontSig seems to contain garbage. */
00307     FONTSIGNATURE fs;
00308     memset(&fs, 0, sizeof(fs));
00309     HFONT font = CreateFontIndirect(&logfont->elfLogFont);
00310     if (font != NULL) {
00311       HDC dc = GetDC(NULL);
00312       HGDIOBJ oldfont = SelectObject(dc, font);
00313       GetTextCharsetInfo(dc, &fs, 0);
00314       SelectObject(dc, oldfont);
00315       ReleaseDC(NULL, dc);
00316       DeleteObject(font);
00317     }
00318     if ((fs.fsCsb[0] & info->locale.lsCsbSupported[0]) == 0 && (fs.fsCsb[1] & info->locale.lsCsbSupported[1]) == 0) return 1;
00319   }
00320 
00321   char font_name[MAX_PATH];
00322 #if defined(UNICODE)
00323   WIDE_TO_MB_BUFFER((const TCHAR*)logfont->elfFullName, font_name, lengthof(font_name));
00324 #else
00325   strecpy(font_name, (const TCHAR*)logfont->elfFullName, lastof(font_name));
00326 #endif
00327 
00328   /* Add english name after font name */
00329   const char *english_name = GetEnglishFontName(logfont);
00330   strecpy(font_name + strlen(font_name) + 1, english_name, lastof(font_name));
00331 
00332   /* Check whether we can actually load the font. */
00333   bool ft_init = _library != NULL;
00334   bool found = false;
00335   FT_Face face;
00336   /* Init FreeType if needed. */
00337   if ((ft_init || FT_Init_FreeType(&_library) == FT_Err_Ok) && GetFontByFaceName(font_name, &face) == FT_Err_Ok) {
00338     FT_Done_Face(face);
00339     found = true;
00340   }
00341   if (!ft_init) {
00342     /* Uninit FreeType if we did the init. */
00343     FT_Done_FreeType(_library);
00344     _library = NULL;
00345   }
00346 
00347   if (!found) return 1;
00348 
00349   strecpy(info->settings->small_font,  font_name, lastof(info->settings->small_font));
00350   strecpy(info->settings->medium_font, font_name, lastof(info->settings->medium_font));
00351   strecpy(info->settings->large_font,  font_name, lastof(info->settings->large_font));
00352   if (info->callback(NULL)) return 1;
00353   DEBUG(freetype, 1, "Fallback font: %s (%s)", font_name, english_name);
00354   return 0; // stop enumerating
00355 }
00356 
00357 bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, SetFallbackFontCallback *callback)
00358 {
00359   DEBUG(freetype, 1, "Trying fallback fonts");
00360   EFCParam langInfo;
00361   if (GetLocaleInfo(MAKELCID(winlangid, SORT_DEFAULT), LOCALE_FONTSIGNATURE, (LPTSTR)&langInfo.locale, sizeof(langInfo.locale) / sizeof(TCHAR)) == 0) {
00362     /* Invalid langid or some other mysterious error, can't determine fallback font. */
00363     DEBUG(freetype, 1, "Can't get locale info for fallback font (langid=0x%x)", winlangid);
00364     return false;
00365   }
00366   langInfo.settings = settings;
00367   langInfo.callback = callback;
00368 
00369   LOGFONT font;
00370   /* Enumerate all fonts. */
00371   font.lfCharSet = DEFAULT_CHARSET;
00372   font.lfFaceName[0] = '\0';
00373   font.lfPitchAndFamily = 0;
00374 
00375   HDC dc = GetDC(NULL);
00376   int ret = EnumFontFamiliesEx(dc, &font, (FONTENUMPROC)&EnumFontCallback, (LPARAM)&langInfo, 0);
00377   ReleaseDC(NULL, dc);
00378   return ret == 0;
00379 }
00380 
00381 #elif defined(__APPLE__) /* end ifdef Win32 */
00382 /* ========================================================================================
00383  * OSX support
00384  * ======================================================================================== */
00385 
00386 #include "os/macosx/macos.h"
00387 #include <ApplicationServices/ApplicationServices.h>
00388 
00389 FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)
00390 {
00391   FT_Error err = FT_Err_Cannot_Open_Resource;
00392 
00393   /* Get font reference from name. */
00394   CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault, font_name, kCFStringEncodingUTF8);
00395   ATSFontRef font = ATSFontFindFromName(name, kATSOptionFlagsDefault);
00396   CFRelease(name);
00397   if (font == kInvalidFont) return err;
00398 
00399   /* Get a file system reference for the font. */
00400   FSRef ref;
00401   OSStatus os_err = -1;
00402 #if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
00403   if (MacOSVersionIsAtLeast(10, 5, 0)) {
00404     os_err = ATSFontGetFileReference(font, &ref);
00405   } else
00406 #endif
00407   {
00408 #if (MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_5) && !__LP64__
00409     /* This type was introduced with the 10.5 SDK. */
00410 #if (MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5)
00411   #define ATSFSSpec FSSpec
00412 #endif
00413     FSSpec spec;
00414     os_err = ATSFontGetFileSpecification(font, (ATSFSSpec *)&spec);
00415     if (os_err == noErr) os_err = FSpMakeFSRef(&spec, &ref);
00416 #endif
00417   }
00418 
00419   if (os_err == noErr) {
00420     /* Get unix path for file. */
00421     UInt8 file_path[PATH_MAX];
00422     if (FSRefMakePath(&ref, file_path, sizeof(file_path)) == noErr) {
00423       DEBUG(freetype, 3, "Font path for %s: %s", font_name, file_path);
00424       err = FT_New_Face(_library, (const char *)file_path, 0, face);
00425     }
00426   }
00427 
00428   return err;
00429 }
00430 
00431 bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, SetFallbackFontCallback *callback)
00432 {
00433   const char *str;
00434   bool result = false;
00435 
00436   callback(&str);
00437 
00438 #if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
00439   if (MacOSVersionIsAtLeast(10, 5, 0)) {
00440     /* Determine fallback font using CoreText. This uses the language isocode
00441      * to find a suitable font. CoreText is available from 10.5 onwards. */
00442     char lang[16];
00443     if (strcmp(language_isocode, "zh_TW") == 0) {
00444       /* Traditional Chinese */
00445       strecpy(lang, "zh-Hant", lastof(lang));
00446     } else if (strcmp(language_isocode, "zh_CN") == 0) {
00447       /* Simplified Chinese */
00448       strecpy(lang, "zh-Hans", lastof(lang));
00449     } else if (strncmp(language_isocode, "ur", 2) == 0) {
00450       /* The urdu alphabet is variant of persian. As OS X has no default
00451        * font that advertises an urdu language code, search for persian
00452        * support instead. */
00453       strecpy(lang, "fa", lastof(lang));
00454     } else {
00455       /* Just copy the first part of the isocode. */
00456       strecpy(lang, language_isocode, lastof(lang));
00457       char *sep = strchr(lang, '_');
00458       if (sep != NULL) *sep = '\0';
00459     }
00460 
00461     CFStringRef lang_code;
00462     lang_code = CFStringCreateWithCString(kCFAllocatorDefault, lang, kCFStringEncodingUTF8);
00463 
00464     /* Create a font iterator and iterate over all fonts that
00465      * are available to the application. */
00466     ATSFontIterator itr;
00467     ATSFontRef font;
00468     ATSFontIteratorCreate(kATSFontContextLocal, NULL, NULL, kATSOptionFlagsUnRestrictedScope, &itr);
00469     while (!result && ATSFontIteratorNext(itr, &font) == noErr) {
00470       /* Get CoreText font handle. */
00471       CTFontRef font_ref = CTFontCreateWithPlatformFont(font, 0.0, NULL, NULL);
00472       CFArrayRef langs = CTFontCopySupportedLanguages(font_ref);
00473       if (langs != NULL) {
00474         /* Font has a list of supported languages. */
00475         for (CFIndex i = 0; i < CFArrayGetCount(langs); i++) {
00476           CFStringRef lang = (CFStringRef)CFArrayGetValueAtIndex(langs, i);
00477           if (CFStringCompare(lang, lang_code, kCFCompareAnchored) == kCFCompareEqualTo) {
00478             /* Lang code is supported by font, get full font name. */
00479             CFStringRef font_name = CTFontCopyFullName(font_ref);
00480             char name[128];
00481             CFStringGetCString(font_name, name, lengthof(name), kCFStringEncodingUTF8);
00482             CFRelease(font_name);
00483             /* Skip some inappropriate or ugly looking fonts that have better alternatives. */
00484             if (strncmp(name, "Courier", 7) == 0 || strncmp(name, "Apple Symbols", 13) == 0 ||
00485                 strncmp(name, ".Aqua", 5) == 0 || strncmp(name, "LastResort", 10) == 0 ||
00486                 strncmp(name, "GB18030 Bitmap", 14) == 0) continue;
00487 
00488             /* Save result. */
00489             strecpy(settings->small_font,  name, lastof(settings->small_font));
00490             strecpy(settings->medium_font, name, lastof(settings->medium_font));
00491             strecpy(settings->large_font,  name, lastof(settings->large_font));
00492             DEBUG(freetype, 2, "CT-Font for %s: %s", language_isocode, name);
00493             result = true;
00494             break;
00495           }
00496         }
00497         CFRelease(langs);
00498       }
00499       CFRelease(font_ref);
00500     }
00501     ATSFontIteratorRelease(&itr);
00502     CFRelease(lang_code);
00503   } else
00504 #endif
00505   {
00506 #if (MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_5) && !__LP64__
00507     /* Determine fallback font using ATSUI. This uses a string sample with
00508      * missing characters. This is not failure-proof, but a better way like
00509      * using the isocode as in the CoreText code path is not available.
00510      * ATSUI was deprecated with 10.6 and is only partially available in
00511      * 64-bit mode. */
00512 
00513     /* Remove all control characters in the range from SCC_CONTROL_START to
00514      * SCC_CONTROL_END as well as all ASCII < 0x20 from the string as it will
00515      * mess with the automatic font detection */
00516     char buff[256]; // This length is enough to find a suitable replacement font
00517     strecpy(buff, str, lastof(buff));
00518     str_validate(buff, lastof(buff), true, false);
00519 
00520     /* Extract a UniChar represenation of the sample string. */
00521     CFStringRef cf_str = CFStringCreateWithCString(kCFAllocatorDefault, buff, kCFStringEncodingUTF8);
00522     if (cf_str == NULL) {
00523       /* Something went wrong. Corrupt/invalid sample string? */
00524       return false;
00525     }
00526     CFIndex str_len = CFStringGetLength(cf_str);
00527     UniChar string[str_len];
00528     CFStringGetCharacters(cf_str, CFRangeMake(0, str_len), string);
00529 
00530     /* Create a default text style with the default font. */
00531     ATSUStyle style;
00532     ATSUCreateStyle(&style);
00533 
00534     /* Create a text layout object from the sample string using the text style. */
00535     UniCharCount run_len = kATSUToTextEnd;
00536     ATSUTextLayout text_layout;
00537     ATSUCreateTextLayoutWithTextPtr(string, kATSUFromTextBeginning, kATSUToTextEnd, str_len, 1, &run_len, &style, &text_layout);
00538 
00539     /* Try to match a font for the sample text. ATSUMatchFontsToText stops after
00540      * it finds the first continous character run not renderable with the currently
00541      * selected font starting at offset. The matching needs to be repeated until
00542      * the end of the string is reached to make sure the fallback font matches for
00543      * all characters in the string and not only the first run. */
00544     UniCharArrayOffset offset = kATSUFromTextBeginning;
00545     OSStatus os_err;
00546     do {
00547       ATSUFontID font;
00548       UniCharCount run_len;
00549       os_err = ATSUMatchFontsToText(text_layout, offset, kATSUToTextEnd, &font, &offset, &run_len);
00550       if (os_err == kATSUFontsMatched) {
00551         /* Found a better fallback font. Update the text layout
00552          * object with the new font. */
00553         ATSUAttributeTag tag = kATSUFontTag;
00554         ByteCount size = sizeof(font);
00555         ATSUAttributeValuePtr val = &font;
00556         ATSUSetAttributes(style, 1, &tag, &size, &val);
00557         offset += run_len;
00558       }
00559       /* Exit if the end of the string is reached or some other error occurred. */
00560     } while (os_err == kATSUFontsMatched && offset < (UniCharArrayOffset)str_len);
00561 
00562     if (os_err == noErr || os_err == kATSUFontsMatched) {
00563       /* ATSUMatchFontsToText exited normally. Extract font
00564        * out of the text layout object. */
00565       ATSUFontID font;
00566       ByteCount act_len;
00567       ATSUGetAttribute(style, kATSUFontTag, sizeof(font), &font, &act_len);
00568 
00569       /* Get unique font name. The result is not a c-string, we have
00570        * to leave space for a \0 and terminate it ourselves. */
00571       char name[128];
00572       ATSUFindFontName(font, kFontUniqueName, kFontNoPlatformCode, kFontNoScriptCode, kFontNoLanguageCode, 127, name, &act_len, NULL);
00573       name[act_len > 127 ? 127 : act_len] = '\0';
00574 
00575       /* Save Result. */
00576       strecpy(settings->small_font,  name, lastof(settings->small_font));
00577       strecpy(settings->medium_font, name, lastof(settings->medium_font));
00578       strecpy(settings->large_font,  name, lastof(settings->large_font));
00579       DEBUG(freetype, 2, "ATSUI-Font for %s: %s", language_isocode, name);
00580       result = true;
00581     }
00582 
00583     ATSUDisposeTextLayout(text_layout);
00584     ATSUDisposeStyle(style);
00585     CFRelease(cf_str);
00586 #endif
00587   }
00588 
00589   if (result && strncmp(settings->medium_font, "Geeza Pro", 9) == 0) {
00590     /* The font 'Geeza Pro' is often found for arabic characters, but
00591      * it has the 'tiny' problem of not having any latin characters.
00592      * 'Arial Unicode MS' on the other hand has arabic and latin glyphs,
00593      * but seems to 'forget' to inform the OS about this fact. Manually
00594      * substitute the latter for the former if it is loadable. */
00595     bool ft_init = _library != NULL;
00596     FT_Face face;
00597     /* Init FreeType if needed. */
00598     if ((ft_init || FT_Init_FreeType(&_library) == FT_Err_Ok) && GetFontByFaceName("Arial Unicode MS", &face) == FT_Err_Ok) {
00599       FT_Done_Face(face);
00600       strecpy(settings->small_font,  "Arial Unicode MS", lastof(settings->small_font));
00601       strecpy(settings->medium_font, "Arial Unicode MS", lastof(settings->medium_font));
00602       strecpy(settings->large_font,  "Arial Unicode MS", lastof(settings->large_font));
00603       DEBUG(freetype, 1, "Replacing font 'Geeza Pro' with 'Arial Unicode MS'");
00604     }
00605     if (!ft_init) {
00606       /* Uninit FreeType if we did the init. */
00607       FT_Done_FreeType(_library);
00608       _library = NULL;
00609     }
00610    }
00611 
00612   callback(NULL);
00613   return result;
00614 }
00615 
00616 #elif defined(WITH_FONTCONFIG) /* end ifdef __APPLE__ */
00617 /* ========================================================================================
00618  * FontConfig (unix) support
00619  * ======================================================================================== */
00620 static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)
00621 {
00622   FT_Error err = FT_Err_Cannot_Open_Resource;
00623 
00624   if (!FcInit()) {
00625     ShowInfoF("Unable to load font configuration");
00626   } else {
00627     FcPattern *match;
00628     FcPattern *pat;
00629     FcFontSet *fs;
00630     FcResult  result;
00631     char *font_style;
00632     char *font_family;
00633 
00634     /* Split & strip the font's style */
00635     font_family = strdup(font_name);
00636     font_style = strchr(font_family, ',');
00637     if (font_style != NULL) {
00638       font_style[0] = '\0';
00639       font_style++;
00640       while (*font_style == ' ' || *font_style == '\t') font_style++;
00641     }
00642 
00643     /* Resolve the name and populate the information structure */
00644     pat = FcNameParse((FcChar8*)font_family);
00645     if (font_style != NULL) FcPatternAddString(pat, FC_STYLE, (FcChar8*)font_style);
00646     FcConfigSubstitute(0, pat, FcMatchPattern);
00647     FcDefaultSubstitute(pat);
00648     fs = FcFontSetCreate();
00649     match = FcFontMatch(0, pat, &result);
00650 
00651     if (fs != NULL && match != NULL) {
00652       int i;
00653       FcChar8 *family;
00654       FcChar8 *style;
00655       FcChar8 *file;
00656       FcFontSetAdd(fs, match);
00657 
00658       for (i = 0; err != FT_Err_Ok && i < fs->nfont; i++) {
00659         /* Try the new filename */
00660         if (FcPatternGetString(fs->fonts[i], FC_FILE,   0, &file)   == FcResultMatch &&
00661             FcPatternGetString(fs->fonts[i], FC_FAMILY, 0, &family) == FcResultMatch &&
00662             FcPatternGetString(fs->fonts[i], FC_STYLE,  0, &style)  == FcResultMatch) {
00663 
00664           /* The correct style? */
00665           if (font_style != NULL && strcasecmp(font_style, (char*)style) != 0) continue;
00666 
00667           /* Font config takes the best shot, which, if the family name is spelled
00668            * wrongly a 'random' font, so check whether the family name is the
00669            * same as the supplied name */
00670           if (strcasecmp(font_family, (char*)family) == 0) {
00671             err = FT_New_Face(_library, (char *)file, 0, face);
00672           }
00673         }
00674       }
00675     }
00676 
00677     free(font_family);
00678     FcPatternDestroy(pat);
00679     FcFontSetDestroy(fs);
00680     FcFini();
00681   }
00682 
00683   return err;
00684 }
00685 
00686 bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, SetFallbackFontCallback *callback)
00687 {
00688   if (!FcInit()) return false;
00689 
00690   bool ret = false;
00691 
00692   /* Fontconfig doesn't handle full language isocodes, only the part
00693    * before the _ of e.g. en_GB is used, so "remove" everything after
00694    * the _. */
00695   char lang[16];
00696   seprintf(lang, lastof(lang), ":lang=%s", language_isocode);
00697   char *split = strchr(lang, '_');
00698   if (split != NULL) *split = '\0';
00699 
00700   /* First create a pattern to match the wanted language. */
00701   FcPattern *pat = FcNameParse((FcChar8*)lang);
00702   /* We only want to know the filename. */
00703   FcObjectSet *os = FcObjectSetBuild(FC_FILE, NULL);
00704   /* Get the list of filenames matching the wanted language. */
00705   FcFontSet *fs = FcFontList(NULL, pat, os);
00706 
00707   /* We don't need these anymore. */
00708   FcObjectSetDestroy(os);
00709   FcPatternDestroy(pat);
00710 
00711   if (fs != NULL) {
00712     for (int i = 0; i < fs->nfont; i++) {
00713       FcPattern *font = fs->fonts[i];
00714 
00715       FcChar8 *file = NULL;
00716       FcResult res = FcPatternGetString(font, FC_FILE, 0, &file);
00717       if (res != FcResultMatch || file == NULL) {
00718         continue;
00719       }
00720 
00721       strecpy(settings->small_font,  (const char*)file, lastof(settings->small_font));
00722       strecpy(settings->medium_font, (const char*)file, lastof(settings->medium_font));
00723       strecpy(settings->large_font,  (const char*)file, lastof(settings->large_font));
00724 
00725       bool missing = callback(NULL);
00726       DEBUG(freetype, 1, "Font \"%s\" misses%s glyphs", file, missing ? "" : " no");
00727 
00728       if (!missing) {
00729         ret = true;
00730         break;
00731       }
00732     }
00733 
00734     /* Clean up the list of filenames. */
00735     FcFontSetDestroy(fs);
00736   }
00737 
00738   FcFini();
00739   return ret;
00740 }
00741 
00742 #else /* without WITH_FONTCONFIG */
00743 FT_Error GetFontByFaceName(const char *font_name, FT_Face *face) {return FT_Err_Cannot_Open_Resource;}
00744 bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, SetFallbackFontCallback *callback) { return false; }
00745 #endif /* WITH_FONTCONFIG */
00746 
00747 static void SetFontGeometry(FT_Face face, FontSize size, int pixels)
00748 {
00749   FT_Set_Pixel_Sizes(face, 0, pixels);
00750 
00751   if (FT_IS_SCALABLE(face)) {
00752     int asc = face->ascender * pixels / face->units_per_EM;
00753     int dec = face->descender * pixels / face->units_per_EM;
00754 
00755     _ascender[size] = asc;
00756     _font_height[size] = asc - dec;
00757   } else {
00758     _ascender[size] = pixels;
00759     _font_height[size] = pixels;
00760   }
00761 }
00762 
00769 static void LoadFreeTypeFont(const char *font_name, FT_Face *face, const char *type)
00770 {
00771   FT_Error error;
00772 
00773   if (StrEmpty(font_name)) return;
00774 
00775   error = FT_New_Face(_library, font_name, 0, face);
00776 
00777   if (error != FT_Err_Ok) error = GetFontByFaceName(font_name, face);
00778 
00779   if (error == FT_Err_Ok) {
00780     DEBUG(freetype, 2, "Requested '%s', using '%s %s'", font_name, (*face)->family_name, (*face)->style_name);
00781 
00782     /* Attempt to select the unicode character map */
00783     error = FT_Select_Charmap(*face, ft_encoding_unicode);
00784     if (error == FT_Err_Ok) return; // Success
00785 
00786     if (error == FT_Err_Invalid_CharMap_Handle) {
00787       /* Try to pick a different character map instead. We default to
00788        * the first map, but platform_id 0 encoding_id 0 should also
00789        * be unicode (strange system...) */
00790       FT_CharMap found = (*face)->charmaps[0];
00791       int i;
00792 
00793       for (i = 0; i < (*face)->num_charmaps; i++) {
00794         FT_CharMap charmap = (*face)->charmaps[i];
00795         if (charmap->platform_id == 0 && charmap->encoding_id == 0) {
00796           found = charmap;
00797         }
00798       }
00799 
00800       if (found != NULL) {
00801         error = FT_Set_Charmap(*face, found);
00802         if (error == FT_Err_Ok) return;
00803       }
00804     }
00805   }
00806 
00807   FT_Done_Face(*face);
00808   *face = NULL;
00809 
00810   ShowInfoF("Unable to use '%s' for %s font, FreeType reported error 0x%X, using sprite font instead", font_name, type, error);
00811 }
00812 
00813 
00814 void InitFreeType()
00815 {
00816   ResetFontSizes();
00817 
00818   if (StrEmpty(_freetype.small_font) && StrEmpty(_freetype.medium_font) && StrEmpty(_freetype.large_font)) {
00819     DEBUG(freetype, 1, "No font faces specified, using sprite fonts instead");
00820     return;
00821   }
00822 
00823   if (FT_Init_FreeType(&_library) != FT_Err_Ok) {
00824     ShowInfoF("Unable to initialize FreeType, using sprite fonts instead");
00825     return;
00826   }
00827 
00828   DEBUG(freetype, 2, "Initialized");
00829 
00830   /* Load each font */
00831   LoadFreeTypeFont(_freetype.small_font,  &_face_small,  "small");
00832   LoadFreeTypeFont(_freetype.medium_font, &_face_medium, "medium");
00833   LoadFreeTypeFont(_freetype.large_font,  &_face_large,  "large");
00834 
00835   /* Set each font size */
00836   if (_face_small != NULL) {
00837     SetFontGeometry(_face_small, FS_SMALL, _freetype.small_size);
00838   }
00839   if (_face_medium != NULL) {
00840     SetFontGeometry(_face_medium, FS_NORMAL, _freetype.medium_size);
00841   }
00842   if (_face_large != NULL) {
00843     SetFontGeometry(_face_large, FS_LARGE, _freetype.large_size);
00844   }
00845 }
00846 
00847 static void ResetGlyphCache();
00848 
00853 static void UnloadFace(FT_Face *face)
00854 {
00855   if (*face == NULL) return;
00856 
00857   FT_Done_Face(*face);
00858   *face = NULL;
00859 }
00860 
00864 void UninitFreeType()
00865 {
00866   ResetFontSizes();
00867   ResetGlyphCache();
00868 
00869   UnloadFace(&_face_small);
00870   UnloadFace(&_face_medium);
00871   UnloadFace(&_face_large);
00872 
00873   FT_Done_FreeType(_library);
00874   _library = NULL;
00875 }
00876 
00877 
00878 static FT_Face GetFontFace(FontSize size)
00879 {
00880   switch (size) {
00881     default: NOT_REACHED();
00882     case FS_NORMAL: return _face_medium;
00883     case FS_SMALL:  return _face_small;
00884     case FS_LARGE:  return _face_large;
00885   }
00886 }
00887 
00888 
00889 struct GlyphEntry {
00890   Sprite *sprite;
00891   byte width;
00892   bool duplicate;
00893 };
00894 
00895 
00896 /* The glyph cache. This is structured to reduce memory consumption.
00897  * 1) There is a 'segment' table for each font size.
00898  * 2) Each segment table is a discrete block of characters.
00899  * 3) Each block contains 256 (aligned) characters sequential characters.
00900  *
00901  * The cache is accessed in the following way:
00902  * For character 0x0041  ('A'): _glyph_ptr[FS_NORMAL][0x00][0x41]
00903  * For character 0x20AC (Euro): _glyph_ptr[FS_NORMAL][0x20][0xAC]
00904  *
00905  * Currently only 256 segments are allocated, "limiting" us to 65536 characters.
00906  * This can be simply changed in the two functions Get & SetGlyphPtr.
00907  */
00908 static GlyphEntry **_glyph_ptr[FS_END];
00909 
00911 static void ResetGlyphCache()
00912 {
00913   for (FontSize i = FS_BEGIN; i < FS_END; i++) {
00914     if (_glyph_ptr[i] == NULL) continue;
00915 
00916     for (int j = 0; j < 256; j++) {
00917       if (_glyph_ptr[i][j] == NULL) continue;
00918 
00919       for (int k = 0; k < 256; k++) {
00920         if (_glyph_ptr[i][j][k].duplicate) continue;
00921         free(_glyph_ptr[i][j][k].sprite);
00922       }
00923 
00924       free(_glyph_ptr[i][j]);
00925     }
00926 
00927     free(_glyph_ptr[i]);
00928     _glyph_ptr[i] = NULL;
00929   }
00930 }
00931 
00932 static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)
00933 {
00934   if (_glyph_ptr[size] == NULL) return NULL;
00935   if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) return NULL;
00936   return &_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)];
00937 }
00938 
00939 
00940 static void SetGlyphPtr(FontSize size, WChar key, const GlyphEntry *glyph, bool duplicate = false)
00941 {
00942   if (_glyph_ptr[size] == NULL) {
00943     DEBUG(freetype, 3, "Allocating root glyph cache for size %u", size);
00944     _glyph_ptr[size] = CallocT<GlyphEntry*>(256);
00945   }
00946 
00947   if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) {
00948     DEBUG(freetype, 3, "Allocating glyph cache for range 0x%02X00, size %u", GB(key, 8, 8), size);
00949     _glyph_ptr[size][GB(key, 8, 8)] = CallocT<GlyphEntry>(256);
00950   }
00951 
00952   DEBUG(freetype, 4, "Set glyph for unicode character 0x%04X, size %u", key, size);
00953   _glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].sprite    = glyph->sprite;
00954   _glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].width     = glyph->width;
00955   _glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].duplicate = duplicate;
00956 }
00957 
00958 static void *AllocateFont(size_t size)
00959 {
00960   return MallocT<byte>(size);
00961 }
00962 
00963 
00964 /* Check if a glyph should be rendered with antialiasing */
00965 static bool GetFontAAState(FontSize size)
00966 {
00967   /* AA is only supported for 32 bpp */
00968   if (BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth() != 32) return false;
00969 
00970   switch (size) {
00971     default: NOT_REACHED();
00972     case FS_NORMAL: return _freetype.medium_aa;
00973     case FS_SMALL:  return _freetype.small_aa;
00974     case FS_LARGE:  return _freetype.large_aa;
00975   }
00976 }
00977 
00978 
00979 const Sprite *GetGlyph(FontSize size, WChar key)
00980 {
00981   FT_Face face = GetFontFace(size);
00982   FT_GlyphSlot slot;
00983   GlyphEntry new_glyph;
00984   GlyphEntry *glyph;
00985   SpriteLoader::Sprite sprite;
00986   int width;
00987   int height;
00988   int x;
00989   int y;
00990 
00991   assert(IsPrintable(key));
00992 
00993   /* Bail out if no face loaded, or for our special characters */
00994   if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {
00995     SpriteID sprite = GetUnicodeGlyph(size, key);
00996     if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');
00997     return GetSprite(sprite, ST_FONT);
00998   }
00999 
01000   /* Check for the glyph in our cache */
01001   glyph = GetGlyphPtr(size, key);
01002   if (glyph != NULL && glyph->sprite != NULL) return glyph->sprite;
01003 
01004   slot = face->glyph;
01005 
01006   bool aa = GetFontAAState(size);
01007 
01008   FT_UInt glyph_index = FT_Get_Char_Index(face, key);
01009   if (glyph_index == 0) {
01010     if (key == '?') {
01011       /* The font misses the '?' character. Use sprite font. */
01012       SpriteID sprite = GetUnicodeGlyph(size, key);
01013       Sprite *spr = (Sprite*)GetRawSprite(sprite, ST_FONT, AllocateFont);
01014       assert(spr != NULL);
01015       new_glyph.sprite = spr;
01016       new_glyph.width  = spr->width + (size != FS_NORMAL);
01017       SetGlyphPtr(size, key, &new_glyph, false);
01018       return new_glyph.sprite;
01019     } else {
01020       /* Use '?' for missing characters. */
01021       GetGlyph(size, '?');
01022       glyph = GetGlyphPtr(size, '?');
01023       SetGlyphPtr(size, key, glyph, true);
01024       return glyph->sprite;
01025     }
01026   }
01027   FT_Load_Glyph(face, glyph_index, FT_LOAD_DEFAULT);
01028   FT_Render_Glyph(face->glyph, aa ? FT_RENDER_MODE_NORMAL : FT_RENDER_MODE_MONO);
01029 
01030   /* Despite requesting a normal glyph, FreeType may have returned a bitmap */
01031   aa = (slot->bitmap.pixel_mode == FT_PIXEL_MODE_GRAY);
01032 
01033   /* Add 1 pixel for the shadow on the medium font. Our sprite must be at least 1x1 pixel */
01034   width  = max(1, slot->bitmap.width + (size == FS_NORMAL));
01035   height = max(1, slot->bitmap.rows  + (size == FS_NORMAL));
01036 
01037   /* Limit glyph size to prevent overflows later on. */
01038   if (width > 256 || height > 256) usererror("Font glyph is too large");
01039 
01040   /* FreeType has rendered the glyph, now we allocate a sprite and copy the image into it */
01041   sprite.AllocateData(width * height);
01042   sprite.width = width;
01043   sprite.height = height;
01044   sprite.x_offs = slot->bitmap_left;
01045   sprite.y_offs = _ascender[size] - slot->bitmap_top;
01046 
01047   /* Draw shadow for medium size */
01048   if (size == FS_NORMAL) {
01049     for (y = 0; y < slot->bitmap.rows; y++) {
01050       for (x = 0; x < slot->bitmap.width; x++) {
01051         if (aa ? (slot->bitmap.buffer[x + y * slot->bitmap.pitch] > 0) : HasBit(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {
01052           sprite.data[1 + x + (1 + y) * sprite.width].m = SHADOW_COLOUR;
01053           sprite.data[1 + x + (1 + y) * sprite.width].a = aa ? slot->bitmap.buffer[x + y * slot->bitmap.pitch] : 0xFF;
01054         }
01055       }
01056     }
01057   }
01058 
01059   for (y = 0; y < slot->bitmap.rows; y++) {
01060     for (x = 0; x < slot->bitmap.width; x++) {
01061       if (aa ? (slot->bitmap.buffer[x + y * slot->bitmap.pitch] > 0) : HasBit(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {
01062         sprite.data[x + y * sprite.width].m = FACE_COLOUR;
01063         sprite.data[x + y * sprite.width].a = aa ? slot->bitmap.buffer[x + y * slot->bitmap.pitch] : 0xFF;
01064       }
01065     }
01066   }
01067 
01068   new_glyph.sprite = BlitterFactoryBase::GetCurrentBlitter()->Encode(&sprite, AllocateFont);
01069   new_glyph.width  = slot->advance.x >> 6;
01070 
01071   SetGlyphPtr(size, key, &new_glyph);
01072 
01073   return new_glyph.sprite;
01074 }
01075 
01076 
01077 uint GetGlyphWidth(FontSize size, WChar key)
01078 {
01079   FT_Face face = GetFontFace(size);
01080   GlyphEntry *glyph;
01081 
01082   if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {
01083     SpriteID sprite = GetUnicodeGlyph(size, key);
01084     if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');
01085     return SpriteExists(sprite) ? GetSprite(sprite, ST_FONT)->width + (size != FS_NORMAL) : 0;
01086   }
01087 
01088   glyph = GetGlyphPtr(size, key);
01089   if (glyph == NULL || glyph->sprite == NULL) {
01090     GetGlyph(size, key);
01091     glyph = GetGlyphPtr(size, key);
01092   }
01093 
01094   return glyph->width;
01095 }
01096 
01097 
01098 #endif /* WITH_FREETYPE */
01099 
01101 void ResetFontSizes()
01102 {
01103   _font_height[FS_SMALL]  =  6;
01104   _font_height[FS_NORMAL] = 10;
01105   _font_height[FS_LARGE]  = 18;
01106 }
01107 
01108 /* Sprite based glyph mapping */
01109 
01110 #include "table/unicode.h"
01111 
01112 static SpriteID **_unicode_glyph_map[FS_END];
01113 
01114 
01116 static SpriteID GetFontBase(FontSize size)
01117 {
01118   switch (size) {
01119     default: NOT_REACHED();
01120     case FS_NORMAL: return SPR_ASCII_SPACE;
01121     case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;
01122     case FS_LARGE:  return SPR_ASCII_SPACE_BIG;
01123   }
01124 }
01125 
01126 
01127 SpriteID GetUnicodeGlyph(FontSize size, uint32 key)
01128 {
01129   if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) return 0;
01130   return _unicode_glyph_map[size][GB(key, 8, 8)][GB(key, 0, 8)];
01131 }
01132 
01133 
01134 void SetUnicodeGlyph(FontSize size, uint32 key, SpriteID sprite)
01135 {
01136   if (_unicode_glyph_map[size] == NULL) _unicode_glyph_map[size] = CallocT<SpriteID*>(256);
01137   if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) _unicode_glyph_map[size][GB(key, 8, 8)] = CallocT<SpriteID>(256);
01138   _unicode_glyph_map[size][GB(key, 8, 8)][GB(key, 0, 8)] = sprite;
01139 }
01140 
01141 
01142 void InitializeUnicodeGlyphMap()
01143 {
01144   for (FontSize size = FS_BEGIN; size != FS_END; size++) {
01145     /* Clear out existing glyph map if it exists */
01146     if (_unicode_glyph_map[size] != NULL) {
01147       for (uint i = 0; i < 256; i++) {
01148         free(_unicode_glyph_map[size][i]);
01149       }
01150       free(_unicode_glyph_map[size]);
01151       _unicode_glyph_map[size] = NULL;
01152     }
01153 
01154     SpriteID base = GetFontBase(size);
01155 
01156     for (uint i = ASCII_LETTERSTART; i < 256; i++) {
01157       SpriteID sprite = base + i - ASCII_LETTERSTART;
01158       if (!SpriteExists(sprite)) continue;
01159       SetUnicodeGlyph(size, i, sprite);
01160       SetUnicodeGlyph(size, i + SCC_SPRITE_START, sprite);
01161     }
01162 
01163     for (uint i = 0; i < lengthof(_default_unicode_map); i++) {
01164       byte key = _default_unicode_map[i].key;
01165       if (key == CLRA || key == CLRL) {
01166         /* Clear the glyph. This happens if the glyph at this code point
01167          * is non-standard and should be accessed by an SCC_xxx enum
01168          * entry only. */
01169         if (key == CLRA || size == FS_LARGE) {
01170           SetUnicodeGlyph(size, _default_unicode_map[i].code, 0);
01171         }
01172       } else {
01173         SpriteID sprite = base + key - ASCII_LETTERSTART;
01174         SetUnicodeGlyph(size, _default_unicode_map[i].code, sprite);
01175       }
01176     }
01177   }
01178 }