void QuartzWindow::init_font_info() {
CFStringRef desired = CFStringCreateWithCString(
kCFAllocatorDefault, default_fixed_font_name(), kCFStringEncodingMacRoman);
ATSFontIterator fi;
OSStatus e = ATSFontIteratorCreate( kATSFontContextLocal, NULL, NULL,
kATSOptionFlagsDefaultScope, &fi);
if (e) fatal1("could not create ATSFontIterator %d", e);
ATSFontRef font;
for (;;) {
ATSFontIteratorNext( fi, &font);
if (!font)
fatal("could not find font");
CFStringRef name;
ATSFontGetName( font, kATSOptionFlagsDefault, &name);
if ( kCFCompareEqualTo == CFStringCompare( desired, name, kCFCompareCaseInsensitive | kCFCompareAnchored))
break;
}
_default_font = font;
e = ATSFontGetHorizontalMetrics(font, kATSOptionFlagsDefault, &_metrics);
if (e) fatal1("could not get metrics %d", e);
e = ATSFontIteratorRelease(&fi);
if (e) fatal1("could not release ATSFontIterator %d", e);
CFRelease(desired);
}
bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, MissingGlyphSearcher *callback)
{
bool result = false;
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
if (MacOSVersionIsAtLeast(10, 5, 0)) {
/* Determine fallback font using CoreText. This uses the language isocode
* to find a suitable font. CoreText is available from 10.5 onwards. */
char lang[16];
if (strcmp(language_isocode, "zh_TW") == 0) {
/* Traditional Chinese */
strecpy(lang, "zh-Hant", lastof(lang));
} else if (strcmp(language_isocode, "zh_CN") == 0) {
/* Simplified Chinese */
strecpy(lang, "zh-Hans", lastof(lang));
} else {
/* Just copy the first part of the isocode. */
strecpy(lang, language_isocode, lastof(lang));
char *sep = strchr(lang, '_');
if (sep != NULL) *sep = '\0';
}
/* Create a font descriptor matching the wanted language and latin (english) glyphs. */
CFStringRef lang_codes[2];
lang_codes[0] = CFStringCreateWithCString(kCFAllocatorDefault, lang, kCFStringEncodingUTF8);
lang_codes[1] = CFSTR("en");
CFArrayRef lang_arr = CFArrayCreate(kCFAllocatorDefault, (const void **)lang_codes, lengthof(lang_codes), &kCFTypeArrayCallBacks);
CFDictionaryRef lang_attribs = CFDictionaryCreate(kCFAllocatorDefault, (const void**)&kCTFontLanguagesAttribute, (const void **)&lang_arr, 1, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
CTFontDescriptorRef lang_desc = CTFontDescriptorCreateWithAttributes(lang_attribs);
CFRelease(lang_arr);
CFRelease(lang_attribs);
CFRelease(lang_codes[0]);
/* Get array of all font descriptors for the wanted language. */
CFSetRef mandatory_attribs = CFSetCreate(kCFAllocatorDefault, (const void **)&kCTFontLanguagesAttribute, 1, &kCFTypeSetCallBacks);
CFArrayRef descs = CTFontDescriptorCreateMatchingFontDescriptors(lang_desc, mandatory_attribs);
CFRelease(mandatory_attribs);
CFRelease(lang_desc);
for (CFIndex i = 0; descs != NULL && i < CFArrayGetCount(descs); i++) {
CTFontDescriptorRef font = (CTFontDescriptorRef)CFArrayGetValueAtIndex(descs, i);
/* Get font traits. */
CFDictionaryRef traits = (CFDictionaryRef)CTFontDescriptorCopyAttribute(font, kCTFontTraitsAttribute);
CTFontSymbolicTraits symbolic_traits;
CFNumberGetValue((CFNumberRef)CFDictionaryGetValue(traits, kCTFontSymbolicTrait), kCFNumberIntType, &symbolic_traits);
CFRelease(traits);
/* Skip symbol fonts and vertical fonts. */
if ((symbolic_traits & kCTFontClassMaskTrait) == (CTFontStylisticClass)kCTFontSymbolicClass || (symbolic_traits & kCTFontVerticalTrait)) continue;
/* Skip bold fonts (especially Arial Bold, which looks worse than regular Arial). */
if (symbolic_traits & kCTFontBoldTrait) continue;
/* Select monospaced fonts if asked for. */
if (((symbolic_traits & kCTFontMonoSpaceTrait) == kCTFontMonoSpaceTrait) != callback->Monospace()) continue;
/* Get font name. */
char name[128];
CFStringRef font_name = (CFStringRef)CTFontDescriptorCopyAttribute(font, kCTFontDisplayNameAttribute);
CFStringGetCString(font_name, name, lengthof(name), kCFStringEncodingUTF8);
CFRelease(font_name);
/* There are some special fonts starting with an '.' and the last
* resort font that aren't usable. Skip them. */
if (name[0] == '.' || strncmp(name, "LastResort", 10) == 0) continue;
/* Save result. */
callback->SetFontNames(settings, name);
if (!callback->FindMissingGlyphs(NULL)) {
DEBUG(freetype, 2, "CT-Font for %s: %s", language_isocode, name);
result = true;
break;
}
}
if (descs != NULL) CFRelease(descs);
} else
#endif
{
/* Create a font iterator and iterate over all fonts that
* are available to the application. */
ATSFontIterator itr;
ATSFontRef font;
ATSFontIteratorCreate(kATSFontContextLocal, NULL, NULL, kATSOptionFlagsDefaultScope, &itr);
while (!result && ATSFontIteratorNext(itr, &font) == noErr) {
/* Get font name. */
char name[128];
CFStringRef font_name;
ATSFontGetName(font, kATSOptionFlagsDefault, &font_name);
CFStringGetCString(font_name, name, lengthof(name), kCFStringEncodingUTF8);
bool monospace = IsMonospaceFont(font_name);
CFRelease(font_name);
/* Select monospaced fonts if asked for. */
if (monospace != callback->Monospace()) continue;
/* We only want the base font and not bold or italic variants. */
if (strstr(name, "Italic") != NULL || strstr(name, "Bold")) continue;
/* Skip some inappropriate or ugly looking fonts that have better alternatives. */
if (name[0] == '.' || strncmp(name, "Apple Symbols", 13) == 0 || strncmp(name, "LastResort", 10) == 0) continue;
/* Save result. */
callback->SetFontNames(settings, name);
if (!callback->FindMissingGlyphs(NULL)) {
DEBUG(freetype, 2, "ATS-Font for %s: %s", language_isocode, name);
result = true;
break;
}
}
ATSFontIteratorRelease(&itr);
}
if (!result) {
/* For some OS versions, the font 'Arial Unicode MS' does not report all languages it
* supports. If we didn't find any other font, just try it, maybe we get lucky. */
callback->SetFontNames(settings, "Arial Unicode MS");
result = !callback->FindMissingGlyphs(NULL);
}
callback->FindMissingGlyphs(NULL);
return result;
}
bool SetFallbackFont(FreeTypeSettings *settings, const char *language_isocode, int winlangid, MissingGlyphSearcher *callback)
{
const char *str;
bool result = false;
callback->FindMissingGlyphs(&str);
#if (MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5)
if (MacOSVersionIsAtLeast(10, 5, 0)) {
/* Determine fallback font using CoreText. This uses the language isocode
* to find a suitable font. CoreText is available from 10.5 onwards. */
char lang[16];
if (strcmp(language_isocode, "zh_TW") == 0) {
/* Traditional Chinese */
strecpy(lang, "zh-Hant", lastof(lang));
} else if (strcmp(language_isocode, "zh_CN") == 0) {
/* Simplified Chinese */
strecpy(lang, "zh-Hans", lastof(lang));
} else if (strncmp(language_isocode, "ur", 2) == 0) {
/* The urdu alphabet is variant of persian. As OS X has no default
* font that advertises an urdu language code, search for persian
* support instead. */
strecpy(lang, "fa", lastof(lang));
} else {
/* Just copy the first part of the isocode. */
strecpy(lang, language_isocode, lastof(lang));
char *sep = strchr(lang, '_');
if (sep != NULL) *sep = '\0';
}
CFStringRef lang_code;
lang_code = CFStringCreateWithCString(kCFAllocatorDefault, lang, kCFStringEncodingUTF8);
/* Create a font iterator and iterate over all fonts that
* are available to the application. */
ATSFontIterator itr;
ATSFontRef font;
ATSFontIteratorCreate(kATSFontContextLocal, NULL, NULL, kATSOptionFlagsUnRestrictedScope, &itr);
while (!result && ATSFontIteratorNext(itr, &font) == noErr) {
/* Get CoreText font handle. */
CTFontRef font_ref = CTFontCreateWithPlatformFont(font, 0.0, NULL, NULL);
CFArrayRef langs = CTFontCopySupportedLanguages(font_ref);
if (langs != NULL) {
/* Font has a list of supported languages. */
for (CFIndex i = 0; i < CFArrayGetCount(langs); i++) {
CFStringRef lang = (CFStringRef)CFArrayGetValueAtIndex(langs, i);
if (CFStringCompare(lang, lang_code, kCFCompareAnchored) == kCFCompareEqualTo) {
/* Lang code is supported by font, get full font name. */
CFStringRef font_name = CTFontCopyFullName(font_ref);
char name[128];
CFStringGetCString(font_name, name, lengthof(name), kCFStringEncodingUTF8);
CFRelease(font_name);
/* Skip some inappropriate or ugly looking fonts that have better alternatives. */
if (strncmp(name, "Courier", 7) == 0 || strncmp(name, "Apple Symbols", 13) == 0 ||
strncmp(name, ".Aqua", 5) == 0 || strncmp(name, "LastResort", 10) == 0 ||
strncmp(name, "GB18030 Bitmap", 14) == 0) continue;
/* Save result. */
callback->SetFontNames(settings, name);
DEBUG(freetype, 2, "CT-Font for %s: %s", language_isocode, name);
result = true;
break;
}
}
CFRelease(langs);
}
CFRelease(font_ref);
}
ATSFontIteratorRelease(&itr);
CFRelease(lang_code);
} else
#endif
{
#if (MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_5) && !__LP64__
/* Determine fallback font using ATSUI. This uses a string sample with
* missing characters. This is not failure-proof, but a better way like
* using the isocode as in the CoreText code path is not available.
* ATSUI was deprecated with 10.6 and is only partially available in
* 64-bit mode. */
/* Remove all control characters in the range from SCC_CONTROL_START to
* SCC_CONTROL_END as well as all ASCII < 0x20 from the string as it will
* mess with the automatic font detection */
char buff[256]; // This length is enough to find a suitable replacement font
strecpy(buff, str, lastof(buff));
str_validate(buff, lastof(buff), SVS_ALLOW_NEWLINE);
/* Extract a UniChar representation of the sample string. */
CFStringRef cf_str = CFStringCreateWithCString(kCFAllocatorDefault, buff, kCFStringEncodingUTF8);
if (cf_str == NULL) {
/* Something went wrong. Corrupt/invalid sample string? */
return false;
}
CFIndex str_len = CFStringGetLength(cf_str);
UniChar string[str_len];
CFStringGetCharacters(cf_str, CFRangeMake(0, str_len), string);
/* Create a default text style with the default font. */
ATSUStyle style;
ATSUCreateStyle(&style);
/* Create a text layout object from the sample string using the text style. */
UniCharCount run_len = kATSUToTextEnd;
ATSUTextLayout text_layout;
ATSUCreateTextLayoutWithTextPtr(string, kATSUFromTextBeginning, kATSUToTextEnd, str_len, 1, &run_len, &style, &text_layout);
/* Try to match a font for the sample text. ATSUMatchFontsToText stops after
* it finds the first continuous character run not renderable with the currently
* selected font starting at offset. The matching needs to be repeated until
* the end of the string is reached to make sure the fallback font matches for
* all characters in the string and not only the first run. */
UniCharArrayOffset offset = kATSUFromTextBeginning;
OSStatus os_err;
do {
ATSUFontID font;
UniCharCount run_len;
os_err = ATSUMatchFontsToText(text_layout, offset, kATSUToTextEnd, &font, &offset, &run_len);
if (os_err == kATSUFontsMatched) {
/* Found a better fallback font. Update the text layout
* object with the new font. */
ATSUAttributeTag tag = kATSUFontTag;
ByteCount size = sizeof(font);
ATSUAttributeValuePtr val = &font;
ATSUSetAttributes(style, 1, &tag, &size, &val);
offset += run_len;
}
/* Exit if the end of the string is reached or some other error occurred. */
} while (os_err == kATSUFontsMatched && offset < (UniCharArrayOffset)str_len);
if (os_err == noErr || os_err == kATSUFontsMatched) {
/* ATSUMatchFontsToText exited normally. Extract font
* out of the text layout object. */
ATSUFontID font;
ByteCount act_len;
ATSUGetAttribute(style, kATSUFontTag, sizeof(font), &font, &act_len);
/* Get unique font name. The result is not a c-string, we have
* to leave space for a \0 and terminate it ourselves. */
char name[128];
ATSUFindFontName(font, kFontUniqueName, kFontNoPlatformCode, kFontNoScriptCode, kFontNoLanguageCode, 127, name, &act_len, NULL);
name[act_len > 127 ? 127 : act_len] = '\0';
/* Save Result. */
callback->SetFontNames(settings, name);
DEBUG(freetype, 2, "ATSUI-Font for %s: %s", language_isocode, name);
result = true;
}
ATSUDisposeTextLayout(text_layout);
ATSUDisposeStyle(style);
CFRelease(cf_str);
#endif
}
if (result && strncmp(settings->medium.font, "Geeza Pro", 9) == 0) {
/* The font 'Geeza Pro' is often found for arabic characters, but
* it has the 'tiny' problem of not having any latin characters.
* 'Arial Unicode MS' on the other hand has arabic and latin glyphs,
* but seems to 'forget' to inform the OS about this fact. Manually
* substitute the latter for the former if it is loadable. */
bool ft_init = _library != NULL;
FT_Face face;
/* Init FreeType if needed. */
if ((ft_init || FT_Init_FreeType(&_library) == FT_Err_Ok) && GetFontByFaceName("Arial Unicode MS", &face) == FT_Err_Ok) {
FT_Done_Face(face);
callback->SetFontNames(settings, "Arial Unicode MS");
DEBUG(freetype, 1, "Replacing font 'Geeza Pro' with 'Arial Unicode MS'");
}
if (!ft_init) {
/* Uninit FreeType if we did the init. */
FT_Done_FreeType(_library);
_library = NULL;
}
}
callback->FindMissingGlyphs(NULL);
return result;
}
/*
PsychInitFontList()
Build a list of records describing installed fonts.
*/
void PsychInitFontList(void)
{
ATSFontRef tempATSFontRef;
CTFontRef tempCTFontRef;
//for font structures
PsychFontStructPtrType fontListHead, fontRecord, previousFontRecord;
//for ATI font iteration
ATSFontIterator fontIterator;
OSStatus halt;
//for font field names
CFStringRef cfFontName;
int i, j;
psych_bool resultOK;
//for font file
OSStatus osStatus;
FSSpec fontFileSpec;
FSRef fontFileRef;
//for the font metrics
ATSFontMetrics horizontalMetrics;
ATSFontMetrics verticalMetrics;
//for info from Font Manager
FMFontStyle fmStyle;
OSStatus fmStatus;
Str255 fmFontFamilyNamePString;
//whatever
Str255 fontFamilyQuickDrawNamePString;
TextEncoding textEncoding;
OSStatus scriptInfoOK;
ScriptCode scriptCode;
LangCode languageCode;
OSStatus localOK;
LocaleRef locale;
psych_bool trouble = FALSE;
psych_bool reportTrouble = TRUE;
fontListHead=PsychFontListHeadKeeper(FALSE, NULL); //get the font list head.
if(fontListHead) PsychErrorExitMsg(PsychError_internal, "Attempt to set new font list head when one is already set.");
fontRecord = NULL;
fontIterator = NULL;
halt = ATSFontIteratorCreate(PSYCH_ATS_ITERATOR_CONTEXT, NULL, NULL, PSYCH_ATS_ITERATOR_SCOPE, &fontIterator);
i = 0;
while (halt==noErr) {
// Give repair hints early. Experience shows we might crash during enumeration of a
// corrupt OSX font database, so make sure we get out the helpful message as early as possible. Doing
// this (just) at the end of enumeration might be too late - we might never get there...
// However, allow user to suppress the hint, as this happens quite regularly on 32-Bit OSX:
if (reportTrouble && trouble && PsychPrefStateGet_Verbosity() > 2) {
reportTrouble = FALSE; // Only show this hint once, not for every invalid font.
printf("\nPTB-HINT: =============================================================================================================================\n");
printf("PTB-HINT: At least one font on this system has issues and can not be accessed by Psychtoolbox. If you want to know which font(s) make\n");
printf("PTB-HINT: trouble, do a 'clear all' and rerun your script with Screen()'s verbosity level set to at least 4 for more diagnostic output.\n");
printf("PTB-HINT: The following tips may help you to resolve font issues:\n");
printf("PTB-HINT: Go to the Application folder and open the 'Font Book' application. It allows you to check and repair your font database.\n");
printf("PTB-HINT: Run its 'Validate' function on all installed fonts. Another thing you could try is downloading and running the free\n");
printf("PTB-HINT: FontNuke application (Google will find it for you) to regenerate corrupt OSX font caches. Good luck!\n");
printf("PTB-HINT: You can suppress this hint by choosing a verbosity level for Screen() of 2 or lower.\n");
printf("PTB-HINT: =============================================================================================================================\n\n");
}
halt=ATSFontIteratorNext(fontIterator, &tempATSFontRef);
if(halt==noErr){
//create a new font font structure. Set the next field to NULL as soon as we allocate the font so that if
//we break with an error then we can find the end when we walk down the linked list.
fontRecord=(PsychFontStructPtrType) calloc(1, sizeof(PsychFontStructType));
fontRecord->next=NULL;
//Get FM and ATS font and font family references from the ATS font reference, which we get from iteration.
fontRecord->fontATSRef=tempATSFontRef;
fontRecord->fontFMRef=FMGetFontFromATSFontRef(fontRecord->fontATSRef);
// Create CTFont from given ATSFontRef. Available since OSX 10.5
tempCTFontRef = CTFontCreateWithPlatformFont(fontRecord->fontATSRef, 0.0, NULL, NULL);
if (tempCTFontRef) {
// Get font family name from CTFont:
CFStringRef cfFamilyName = CTFontCopyFamilyName(tempCTFontRef);
// Retrieve symbolic traits of font -- the closest equivalent of the fmStyle from the
// good'ol fontManager:
CTFontSymbolicTraits ctTraits = CTFontGetSymbolicTraits(tempCTFontRef);
// Remap new trait constants to old constants for later Screen('TextStyle') matching.
fmStyle = 0;
if (ctTraits & kCTFontBoldTrait) fmStyle |= 1;
if (ctTraits & kCTFontItalicTrait) fmStyle |= 2;
if (ctTraits & kCTFontCondensedTrait) fmStyle |= 32;
if (ctTraits & kCTFontExpandedTrait) fmStyle |= 64;
// CTFont no longer needed:
CFRelease(tempCTFontRef);
// Convert to C-String and assign:
resultOK = cfFamilyName && CFStringGetCString(cfFamilyName, (char*) fontRecord->fontFMFamilyName, 255, kCFStringEncodingASCII);
if(!resultOK){
if (cfFamilyName) CFRelease(cfFamilyName);
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to retrieve font family name for font... Defective font?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
// Get ATSRef for font family:
fontRecord->fontFamilyATSRef = ATSFontFamilyFindFromName(cfFamilyName, kATSOptionFlagsDefault);
CFRelease(cfFamilyName);
}
else {
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to retrieve CTFontRef for font... Defective font?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
//get the font name and set the the corresponding field of the struct
if (ATSFontGetName(fontRecord->fontATSRef, kATSOptionFlagsDefault, &cfFontName)!=noErr) {
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to query font name in ATSFontGetName! OS-X font handling screwed up?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
resultOK = cfFontName && CFStringGetCString(cfFontName, (char*) fontRecord->fontFMName, 255, kCFStringEncodingASCII);
if(!resultOK){
if (cfFontName) CFRelease(cfFontName);
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to convert fontFMName CF string to char string. Defective font?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
CFRelease(cfFontName);
//get the font postscript name and set the corresponding field of the struct
if (ATSFontGetPostScriptName(fontRecord->fontATSRef, kATSOptionFlagsDefault, &cfFontName)!=noErr) {
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: The following font makes trouble: %s. Please REMOVE the offending font file from your font folders and restart Matlab. Skipped entry for now...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
resultOK = cfFontName && CFStringGetCString(cfFontName, (char*) fontRecord->fontPostScriptName, 255, kCFStringEncodingASCII); //kCFStringEncodingASCII matches MATLAB for 0-127
if(!resultOK){
if (cfFontName) CFRelease(cfFontName);
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to convert fontPostScriptName CF string to char string for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
CFRelease(cfFontName);
// Get the QuickDraw name of the font:
fontRecord->fontFamilyQuickDrawName[0] = 0;
fontFamilyQuickDrawNamePString[0] = 0;
ATSFontFamilyGetQuickDrawName(fontRecord->fontFamilyATSRef, fontFamilyQuickDrawNamePString);
for (j = 0; j < fontFamilyQuickDrawNamePString[0]; j++) fontRecord->fontFamilyQuickDrawName[j] = fontFamilyQuickDrawNamePString[j+1];
fontRecord->fontFamilyQuickDrawName[j] = 0;
osStatus = ATSFontGetFileReference(fontRecord->fontATSRef, &fontFileRef);
if(osStatus != noErr) {
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to get the font file specifier for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
osStatus= FSRefMakePath(&fontFileRef, (UInt8*) fontRecord->fontFile, (UInt32)(kPsychMaxFontFileNameChars - 1));
if(osStatus!=noErr){
if (PsychPrefStateGet_Verbosity() > 3) printf("PTB-WARNING: In font initialization: Failed to get the font file path for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
//get the font metrics of this font.
//Explicit copy between fields to make it clear what is going one, will likely have to mix & match between native and Psych structures for different
//platforms.
ATSFontGetHorizontalMetrics(fontRecord->fontATSRef, kATSOptionFlagsDefault, &horizontalMetrics);
ATSFontGetVerticalMetrics(fontRecord->fontATSRef, kATSOptionFlagsDefault, &verticalMetrics);
//horizontal
fontRecord->horizontalMetrics.ascent= horizontalMetrics.ascent;
fontRecord->horizontalMetrics.descent= horizontalMetrics.descent;
fontRecord->horizontalMetrics.leading= horizontalMetrics.leading;
fontRecord->horizontalMetrics.avgAdvanceWidth= horizontalMetrics.avgAdvanceWidth;
fontRecord->horizontalMetrics.minLeftSideBearing= horizontalMetrics.minLeftSideBearing;
fontRecord->horizontalMetrics.minRightSideBearing= horizontalMetrics.minRightSideBearing;
fontRecord->horizontalMetrics.stemWidth= horizontalMetrics.stemWidth;
fontRecord->horizontalMetrics.stemHeight= horizontalMetrics.stemHeight;
fontRecord->horizontalMetrics.capHeight= horizontalMetrics.capHeight;
fontRecord->horizontalMetrics.xHeight= horizontalMetrics.xHeight;
fontRecord->horizontalMetrics.italicAngle= horizontalMetrics.italicAngle;
fontRecord->horizontalMetrics.underlinePosition= horizontalMetrics.underlinePosition;
fontRecord->horizontalMetrics.underlineThickness= horizontalMetrics.underlineThickness;
fontRecord->horizontalMetrics.underlineThickness= horizontalMetrics.underlineThickness;
//vertical
fontRecord->verticalMetrics.ascent= verticalMetrics.ascent;
fontRecord->verticalMetrics.descent= verticalMetrics.descent;
fontRecord->verticalMetrics.leading= verticalMetrics.leading;
fontRecord->verticalMetrics.avgAdvanceWidth= verticalMetrics.avgAdvanceWidth;
fontRecord->verticalMetrics.minLeftSideBearing= verticalMetrics.minLeftSideBearing;
fontRecord->verticalMetrics.minRightSideBearing= verticalMetrics.minRightSideBearing;
fontRecord->verticalMetrics.stemWidth= verticalMetrics.stemWidth;
fontRecord->verticalMetrics.stemHeight= verticalMetrics.stemHeight;
fontRecord->verticalMetrics.capHeight= verticalMetrics.capHeight;
fontRecord->verticalMetrics.xHeight= verticalMetrics.xHeight;
fontRecord->verticalMetrics.italicAngle= verticalMetrics.italicAngle;
fontRecord->verticalMetrics.underlinePosition= verticalMetrics.underlinePosition;
fontRecord->verticalMetrics.underlineThickness= verticalMetrics.underlineThickness;
fontRecord->verticalMetrics.underlineThickness= verticalMetrics.underlineThickness;
fontRecord->fontFMStyle=fmStyle;
fontRecord->fontFMNumStyles=PsychFindNumFMFontStylesFromStyle(fmStyle);
fontRecord->fontFMNumStyles= fontRecord->fontFMNumStyles ? fontRecord->fontFMNumStyles : 1; //because the name is "normal" even if there are no styles.
// Get the locale info which is a property of the font family:
// No error checking is done here, because many (most?) fonts miss the information,
// so we would error-out all the time and this is non-critical for us:
textEncoding=ATSFontFamilyGetEncoding(fontRecord->fontFamilyATSRef);
scriptInfoOK=RevertTextEncodingToScriptInfo(textEncoding, &scriptCode, &languageCode, NULL);
localOK=LocaleRefFromLangOrRegionCode(languageCode, kTextRegionDontCare, &locale);
localOK |= LocaleRefGetPartString(locale, kLocaleLanguageMask, 255, (char*) fontRecord->locale.language); fontRecord->locale.language[255]='\0';
localOK |= LocaleRefGetPartString(locale, kLocaleLanguageVariantMask, 255, (char*) fontRecord->locale.languageVariant); fontRecord->locale.languageVariant[255]='\0';
localOK |= LocaleRefGetPartString(locale, kLocaleRegionMask, 255, (char*) fontRecord->locale.region); fontRecord->locale.region[255]='\0';
localOK |= LocaleRefGetPartString(locale, kLocaleRegionVariantMask, 255, (char*) fontRecord->locale.regionVariant); fontRecord->locale.regionVariant[255]='\0';
localOK |= LocaleRefGetPartString(locale, kLocaleAllPartsMask, 255, (char*) fontRecord->locale.fullName); fontRecord->locale.fullName[255]='\0';
// Init for fontRecord (nearly) finished.
// Set this fontRecord as head of font-list, or enqueue it in existing list:
if(i==0) {
PsychFontListHeadKeeper(TRUE, fontRecord);
}
else {
previousFontRecord->next=fontRecord;
}
// Set the font number field of the struct
fontRecord->fontNumber=i+1;
// Increment the font index and update the next font pointer
++i;
previousFontRecord=fontRecord;
}else if(halt == kATSIterationScopeModified){
//exit because the font database changed during this loop.
PsychFreeFontList();
if (fontIterator) ATSFontIteratorRelease(&fontIterator);
PsychErrorExitMsg(PsychError_system, "The system font database was modified during font list setup. Please 'clear all' and restart your script.");
}
// Next parse iteration in system font database...
}
if (fontIterator) ATSFontIteratorRelease(&fontIterator);
if (halt != kATSIterationCompleted) {
PsychFreeFontList();
trouble = TRUE;
if (PsychPrefStateGet_Verbosity() > 0) printf("PTB-ERROR: Font iteration during enumeration terminated prematurely. OS-X Font database corrupted?!?");
}
// Did we get a hand on at least one font?
if (i==0) {
PsychFreeFontList();
trouble = TRUE;
if (PsychPrefStateGet_Verbosity() > 0) {
printf("PTB-ERROR: In font initialization: Could not even retrieve one valid font from the system! The OS-X font database must be corrupt.\n");
printf("PTB-ERROR: Will try to continue but will likely abort if your code tries to call any of the font handling or text drawing functions.\n");
}
}
// If there was some trouble and it wasn't reported yet, then report it now at the end if either
// verbosity level is at least 3 (our default level), or if the error was especially serious and
// lead to a premature abortion of font iteration or complete failure to find even a single valid
// font. In the latter cases, we must report the trouble, regardless of verbosity level. In the
// former case, probably only a few fonts had trouble, so we allow the user to suppress such messages
// by lowering the verbosity to warning level or lower:
if (reportTrouble && trouble && ((PsychPrefStateGet_Verbosity() > 2) || (halt != kATSIterationCompleted) || (i == 0))) {
printf("PTB-HINT: =============================================================================================================================\n");
printf("PTB-HINT: At least one font on this system has issues and can not be accessed by Psychtoolbox. If you want to know which font(s) make\n");
printf("PTB-HINT: trouble, do a 'clear all' and rerun your script with Screen()'s verbosity level set to at least 4 for more diagnostic output.\n");
printf("PTB-HINT: The following tips may help you to resolve font issues:\n");
printf("PTB-HINT: Go to the Application folder and open the 'Font Book' application. It allows you to check and repair your font database.\n");
printf("PTB-HINT: Run its 'Validate' function on all installed fonts. Another thing you could try is downloading and running the free\n");
printf("PTB-HINT: FontNuke application (Google will find it for you) to regenerate corrupt OSX font caches. Good luck!\n");
printf("PTB-HINT: In case of non-fatal errors, you can suppress this hint by choosing a verbosity level for Screen() of 2 or lower.\n");
printf("PTB-HINT: =============================================================================================================================\n");
}
// Font database ready for use.
return;
}
/*
PsychInitFontList()
Build a list of records describing installed fonts.
*/
void PsychInitFontList(void)
{
ATSFontRef tempATSFontRef;
//for font structures
PsychFontStructPtrType fontListHead, fontRecord, previousFontRecord;
//for ATI font iteration
ATSFontIterator fontIterator;
OSStatus halt;
//for font field names
CFStringRef cfFontName;
int i;
psych_bool resultOK;
//for font file
//OSErr osError;
OSStatus osStatus;
FSSpec fontFileSpec;
FSRef fontFileRef;
//for the font metrics
ATSFontMetrics horizontalMetrics;
ATSFontMetrics verticalMetrics;
//for info from Font Manager
FMFontStyle fmStyle;
OSStatus fmStatus;
Str255 fmFontFamilyNamePString;
//whatever
Str255 fontFamilyQuickDrawNamePString;
TextEncoding textEncoding;
OSStatus scriptInfoOK;
ScriptCode scriptCode;
LangCode languageCode;
OSStatus localOK;
LocaleRef locale;
psych_bool trouble = FALSE;
fontListHead=PsychFontListHeadKeeper(FALSE, NULL); //get the font list head.
if(fontListHead) PsychErrorExitMsg(PsychError_internal, "Attempt to set new font list head when one is already set.");
fontRecord=NULL;
halt= ATSFontIteratorCreate(PSYCH_ATS_ITERATOR_CONTEXT, NULL, NULL, PSYCH_ATS_ITERATOR_SCOPE, &fontIterator);
i=0;
while(halt==noErr){
halt=ATSFontIteratorNext(fontIterator, &tempATSFontRef);
if(halt==noErr){
//create a new font font structure. Set the next field to NULL as soon as we allocate the font so that if
//we break with an error then we can find the end when we walk down the linked list.
fontRecord=(PsychFontStructPtrType)malloc(sizeof(PsychFontStructType));
fontRecord->next=NULL;
//Get FM and ATS font and font family references from the ATS font reference, which we get from iteration.
fontRecord->fontATSRef=tempATSFontRef;
fontRecord->fontFMRef=FMGetFontFromATSFontRef(fontRecord->fontATSRef);
fmStatus=FMGetFontFamilyInstanceFromFont(fontRecord->fontFMRef, &(fontRecord->fontFamilyFMRef), &fmStyle);
fontRecord->fontFamilyATSRef=FMGetATSFontFamilyRefFromFontFamily(fontRecord->fontFamilyFMRef);
//get the font name and set the the corresponding field of the struct
if (ATSFontGetName(fontRecord->fontATSRef, kATSOptionFlagsDefault, &cfFontName)!=noErr) {
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: Failed to query font name in ATSFontGetName! OS-X font handling screwed up?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
resultOK=CFStringGetCString(cfFontName, (char*) fontRecord->fontFMName, 255, kCFStringEncodingASCII);
if(!resultOK){
CFRelease(cfFontName);
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: Failed to convert fontFMName CF string to char string. Defective font?!? Skipped this entry...\n");
trouble = TRUE;
continue;
}
CFRelease(cfFontName);
//get the font postscript name and set the corresponding field of the struct
if (ATSFontGetPostScriptName(fontRecord->fontATSRef, kATSOptionFlagsDefault, &cfFontName)!=noErr) {
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: The following font makes trouble: %s. Please REMOVE the offending font file from your font folders and restart Matlab. Skipped entry for now...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
resultOK=CFStringGetCString(cfFontName, (char*) fontRecord->fontPostScriptName, 255, kCFStringEncodingASCII); //kCFStringEncodingASCII matches MATLAB for 0-127
if(!resultOK){
CFRelease(cfFontName);
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: Failed to convert fontPostScriptName CF string to char string for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
CFRelease(cfFontName);
//get the QuickDraw name of the font
ATSFontFamilyGetQuickDrawName(fontRecord->fontFamilyATSRef, fontFamilyQuickDrawNamePString);
CopyPascalStringToC(fontFamilyQuickDrawNamePString, (char*) fontRecord->fontFamilyQuickDrawName);
//get the font file used for this font
osStatus= ATSFontGetFileSpecification(fontRecord->fontATSRef, &fontFileSpec);
if(osStatus != noErr) {
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: Failed to get the font file specifier for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
FSpMakeFSRef(&fontFileSpec, &fontFileRef);
osStatus= FSRefMakePath(&fontFileRef, (UInt8*) fontRecord->fontFile, (UInt32)(kPsychMaxFontFileNameChars - 1));
if(osStatus!=noErr){
if (PsychPrefStateGet_Verbosity() > 1) printf("PTB-WARNING: In font initialization: Failed to get the font file path for font %s. Defective font?!? Skipped this entry...\n", fontRecord->fontFMName);
trouble = TRUE;
continue;
}
//get the font metrics of this font.
//Explicit copy between fields to make it clear what is going one, will likely have to mix & match between native and Psych structures for different
//platforms.
ATSFontGetHorizontalMetrics(fontRecord->fontATSRef, kATSOptionFlagsDefault, &horizontalMetrics);
ATSFontGetVerticalMetrics(fontRecord->fontATSRef, kATSOptionFlagsDefault, &verticalMetrics);
//horizontal
fontRecord->horizontalMetrics.ascent= horizontalMetrics.ascent;
fontRecord->horizontalMetrics.descent= horizontalMetrics.descent;
fontRecord->horizontalMetrics.leading= horizontalMetrics.leading;
fontRecord->horizontalMetrics.avgAdvanceWidth= horizontalMetrics.avgAdvanceWidth;
fontRecord->horizontalMetrics.minLeftSideBearing= horizontalMetrics.minLeftSideBearing;
fontRecord->horizontalMetrics.minRightSideBearing= horizontalMetrics.minRightSideBearing;
fontRecord->horizontalMetrics.stemWidth= horizontalMetrics.stemWidth;
fontRecord->horizontalMetrics.stemHeight= horizontalMetrics.stemHeight;
fontRecord->horizontalMetrics.capHeight= horizontalMetrics.capHeight;
fontRecord->horizontalMetrics.xHeight= horizontalMetrics.xHeight;
fontRecord->horizontalMetrics.italicAngle= horizontalMetrics.italicAngle;
fontRecord->horizontalMetrics.underlinePosition= horizontalMetrics.underlinePosition;
fontRecord->horizontalMetrics.underlineThickness= horizontalMetrics.underlineThickness;
fontRecord->horizontalMetrics.underlineThickness= horizontalMetrics.underlineThickness;
//vertical
fontRecord->verticalMetrics.ascent= verticalMetrics.ascent;
fontRecord->verticalMetrics.descent= verticalMetrics.descent;
fontRecord->verticalMetrics.leading= verticalMetrics.leading;
fontRecord->verticalMetrics.avgAdvanceWidth= verticalMetrics.avgAdvanceWidth;
fontRecord->verticalMetrics.minLeftSideBearing= verticalMetrics.minLeftSideBearing;
fontRecord->verticalMetrics.minRightSideBearing= verticalMetrics.minRightSideBearing;
fontRecord->verticalMetrics.stemWidth= verticalMetrics.stemWidth;
fontRecord->verticalMetrics.stemHeight= verticalMetrics.stemHeight;
fontRecord->verticalMetrics.capHeight= verticalMetrics.capHeight;
fontRecord->verticalMetrics.xHeight= verticalMetrics.xHeight;
fontRecord->verticalMetrics.italicAngle= verticalMetrics.italicAngle;
fontRecord->verticalMetrics.underlinePosition= verticalMetrics.underlinePosition;
fontRecord->verticalMetrics.underlineThickness= verticalMetrics.underlineThickness;
fontRecord->verticalMetrics.underlineThickness= verticalMetrics.underlineThickness;
//use Font Manager to get the FM font family name font style
fmStatus=FMGetFontFamilyName(fontRecord->fontFamilyFMRef, fmFontFamilyNamePString);
CopyPascalStringToC(fmFontFamilyNamePString, (char*) fontRecord->fontFMFamilyName);
fontRecord->fontFMStyle=fmStyle;
fontRecord->fontFMNumStyles=PsychFindNumFMFontStylesFromStyle(fmStyle);
fontRecord->fontFMNumStyles= fontRecord->fontFMNumStyles ? fontRecord->fontFMNumStyles : 1; //because the name is "normal" even if there are no styles.
//get the locale info which is a property of the font family
textEncoding=ATSFontFamilyGetEncoding(fontRecord->fontFamilyATSRef);
scriptInfoOK=RevertTextEncodingToScriptInfo(textEncoding, &scriptCode, &languageCode, NULL);
localOK=LocaleRefFromLangOrRegionCode(languageCode, kTextRegionDontCare, &locale);
localOK=LocaleRefGetPartString(locale, kLocaleLanguageMask, 255, (char*) fontRecord->locale.language); fontRecord->locale.language[255]='\0';
localOK=LocaleRefGetPartString(locale, kLocaleLanguageVariantMask, 255, (char*) fontRecord->locale.languageVariant); fontRecord->locale.languageVariant[255]='\0';
localOK=LocaleRefGetPartString(locale, kLocaleRegionMask, 255, (char*) fontRecord->locale.region); fontRecord->locale.region[255]='\0';
localOK=LocaleRefGetPartString(locale, kLocaleRegionVariantMask, 255, (char*) fontRecord->locale.regionVariant); fontRecord->locale.regionVariant[255]='\0';
localOK=LocaleRefGetPartString(locale, kLocaleAllPartsMask, 255, (char*) fontRecord->locale.fullName); fontRecord->locale.fullName[255]='\0';
// Init for fontRecord (nearly) finished.
// Set this fontRecord as head of font-list, or enqueue it in existing list:
if(i==0) {
PsychFontListHeadKeeper(TRUE, fontRecord);
}
else {
previousFontRecord->next=fontRecord;
}
// Set the font number field of the struct
fontRecord->fontNumber=i+1;
// Increment the font index and update the next font pointer
++i;
previousFontRecord=fontRecord;
}else if(halt == kATSIterationScopeModified){
//exit because the font database changed during this loop.
PsychFreeFontList();
PsychErrorExitMsg(PsychError_internal, "The system font database was modified during font list setup. Please 'clear all' and restart your script.");
}
// Next parse iteration in system font database...
}
if(halt != kATSIterationCompleted){
PsychFreeFontList();
PsychErrorExitMsg(PsychError_internal, "Font iteration terminated prematurely. OS-X Font database corrupted?!?");
}
// Did we get a hand on at least one font?
if (i==0) {
if (PsychPrefStateGet_Verbosity() > 0) {
printf("PTB-ERROR: In font initialization: Could not even retrieve one valid font from the system! The OS-X font database must be corrupt.\n");
printf("PTB-ERROR: Will try to continue but will likely crash if your code tries to call any of the font handling or text drawing functions.\n");
trouble = TRUE;
}
}
if (trouble && PsychPrefStateGet_Verbosity() > 0) {
printf("PTB-HINT: Go to the Application folder and open the 'Font Book' application. It allows you to check and repair your font database.\n");
}
ATSFontIteratorRelease(&fontIterator);
// Font database ready for use.
return;
}
ATSFontIterator ATSFontIteratorCreate_wrap( ATSFontContext iContext, ATSOptionFlags iOptions, void* FH ) {
ATSFontIterator it;
OSStatus e = ATSFontIteratorCreate( iContext, NULL, NULL, iOptions, &it);
return e != noErr ? (ATSFontIterator)reportOSError(e, "ATSFontIteratorCreate", FH) : it;
}
