/* * fontconfig/src/fcmatch.c * * Copyright © 2000 Keith Packard * * Permission to use, copy, modify, distribute, and sell this software and its * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ #include "fcint.h" #include #include #include #include static double FcCompareNumber (FcValue *value1, FcValue *value2) { double v1, v2, v; switch ((int) value1->type) { case FcTypeInteger: v1 = (double) value1->u.i; break; case FcTypeDouble: v1 = value1->u.d; break; default: return -1.0; } switch ((int) value2->type) { case FcTypeInteger: v2 = (double) value2->u.i; break; case FcTypeDouble: v2 = value2->u.d; break; default: return -1.0; } v = v2 - v1; if (v < 0) v = -v; return v; } static double FcCompareString (FcValue *v1, FcValue *v2) { return (double) FcStrCmpIgnoreCase (FcValueString(v1), FcValueString(v2)) != 0; } static double FcCompareFamily (FcValue *v1, FcValue *v2) { /* rely on the guarantee in FcPatternObjectAddWithBinding that * families are always FcTypeString. */ const FcChar8* v1_string = FcValueString(v1); const FcChar8* v2_string = FcValueString(v2); if (FcToLower(*v1_string) != FcToLower(*v2_string) && *v1_string != ' ' && *v2_string != ' ') return 1.0; return (double) FcStrCmpIgnoreBlanksAndCase (v1_string, v2_string) != 0; } static double FcCompareLang (FcValue *v1, FcValue *v2) { FcLangResult result; FcValue value1 = FcValueCanonicalize(v1), value2 = FcValueCanonicalize(v2); switch ((int) value1.type) { case FcTypeLangSet: switch ((int) value2.type) { case FcTypeLangSet: result = FcLangSetCompare (value1.u.l, value2.u.l); break; case FcTypeString: result = FcLangSetHasLang (value1.u.l, value2.u.s); break; default: return -1.0; } break; case FcTypeString: switch ((int) value2.type) { case FcTypeLangSet: result = FcLangSetHasLang (value2.u.l, value1.u.s); break; case FcTypeString: result = FcLangCompare (value1.u.s, value2.u.s); break; default: return -1.0; } break; default: return -1.0; } switch (result) { case FcLangEqual: return 0; case FcLangDifferentCountry: return 1; case FcLangDifferentLang: default: return 2; } } static double FcCompareBool (FcValue *v1, FcValue *v2) { if (v2->type != FcTypeBool || v1->type != FcTypeBool) return -1.0; return (double) v2->u.b != v1->u.b; } static double FcCompareCharSet (FcValue *v1, FcValue *v2) { return (double) FcCharSetSubtractCount (FcValueCharSet(v1), FcValueCharSet(v2)); } static double FcCompareSize (FcValue *value1, FcValue *value2) { double v1, v2, v; switch ((int) value1->type) { case FcTypeInteger: v1 = value1->u.i; break; case FcTypeDouble: v1 = value1->u.d; break; default: return -1; } switch ((int) value2->type) { case FcTypeInteger: v2 = value2->u.i; break; case FcTypeDouble: v2 = value2->u.d; break; default: return -1; } if (v2 == 0) return 0; v = v2 - v1; if (v < 0) v = -v; return v; } static double FcCompareFilename (FcValue *v1, FcValue *v2) { const FcChar8 *s1 = FcValueString (v1), *s2 = FcValueString (v2); if (FcStrCmp (s1, s2) == 0) return 0.0; else if (FcStrCmpIgnoreCase (s1, s2) == 0) return 1.0; else if (FcStrRegexCmp (s2, s1)) return 2.0; else if (FcStrRegexCmpIgnoreCase (s2, s1)) return 3.0; else return 4.0; } typedef struct _FcMatcher { FcObject object; double (*compare) (FcValue *value1, FcValue *value2); int strong, weak; } FcMatcher; /* * Order is significant, it defines the precedence of * each value, earlier values are more significant than * later values */ static const FcMatcher _FcMatchers [] = { { FC_FILE_OBJECT, FcCompareFilename, 0, 0 }, #define MATCH_FILE 0 { FC_FOUNDRY_OBJECT, FcCompareString, 1, 1 }, #define MATCH_FOUNDRY 1 { FC_CHARSET_OBJECT, FcCompareCharSet, 2, 2 }, #define MATCH_CHARSET 2 { FC_FAMILY_OBJECT, FcCompareFamily, 3, 5 }, #define MATCH_FAMILY 3 { FC_LANG_OBJECT, FcCompareLang, 4, 4 }, #define MATCH_LANG 4 #define MATCH_LANG_INDEX 4 { FC_SPACING_OBJECT, FcCompareNumber, 6, 6 }, #define MATCH_SPACING 5 { FC_PIXEL_SIZE_OBJECT, FcCompareSize, 7, 7 }, #define MATCH_PIXEL_SIZE 6 { FC_STYLE_OBJECT, FcCompareString, 8, 8 }, #define MATCH_STYLE 7 { FC_SLANT_OBJECT, FcCompareNumber, 9, 9 }, #define MATCH_SLANT 8 { FC_WEIGHT_OBJECT, FcCompareNumber, 10, 10 }, #define MATCH_WEIGHT 9 { FC_WIDTH_OBJECT, FcCompareNumber, 11, 11 }, #define MATCH_WIDTH 10 { FC_DECORATIVE_OBJECT, FcCompareBool, 12, 12 }, #define MATCH_DECORATIVE 11 { FC_ANTIALIAS_OBJECT, FcCompareBool, 13, 13 }, #define MATCH_ANTIALIAS 12 { FC_RASTERIZER_OBJECT, FcCompareString, 14, 14 }, #define MATCH_RASTERIZER 13 { FC_OUTLINE_OBJECT, FcCompareBool, 15, 15 }, #define MATCH_OUTLINE 14 { FC_FONTVERSION_OBJECT, FcCompareNumber, 16, 16 }, #define MATCH_FONTVERSION 15 }; #define NUM_MATCH_VALUES 17 static const FcMatcher* FcObjectToMatcher (FcObject object, FcBool include_lang) { int i; i = -1; switch (object) { case FC_FILE_OBJECT: i = MATCH_FILE; break; case FC_FOUNDRY_OBJECT: i = MATCH_FOUNDRY; break; case FC_FONTVERSION_OBJECT: i = MATCH_FONTVERSION; break; case FC_FAMILY_OBJECT: i = MATCH_FAMILY; break; case FC_CHARSET_OBJECT: i = MATCH_CHARSET; break; case FC_ANTIALIAS_OBJECT: i = MATCH_ANTIALIAS; break; case FC_LANG_OBJECT: i = MATCH_LANG; break; case FC_SPACING_OBJECT: i = MATCH_SPACING; break; case FC_STYLE_OBJECT: i = MATCH_STYLE; break; case FC_SLANT_OBJECT: i = MATCH_SLANT; break; case FC_PIXEL_SIZE_OBJECT: i = MATCH_PIXEL_SIZE; break; case FC_WIDTH_OBJECT: i = MATCH_WIDTH; break; case FC_WEIGHT_OBJECT: i = MATCH_WEIGHT; break; case FC_RASTERIZER_OBJECT: i = MATCH_RASTERIZER; break; case FC_OUTLINE_OBJECT: i = MATCH_OUTLINE; break; case FC_DECORATIVE_OBJECT: i = MATCH_DECORATIVE; break; default: if (include_lang) { switch (object) { case FC_FAMILYLANG_OBJECT: case FC_STYLELANG_OBJECT: case FC_FULLNAMELANG_OBJECT: i = MATCH_LANG; break; } } } if (i < 0) return NULL; return _FcMatchers+i; } static FcBool FcCompareValueList (FcObject object, const FcMatcher *match, FcValueListPtr v1orig, /* pattern */ FcValueListPtr v2orig, /* target */ FcValue *bestValue, double *value, int *n, FcResult *result) { FcValueListPtr v1, v2; double v, best, bestStrong, bestWeak; int j, k, pos = 0; if (!match) { if (bestValue) *bestValue = FcValueCanonicalize(&v2orig->value); if (n) *n = 0; return FcTrue; } best = 1e99; bestStrong = 1e99; bestWeak = 1e99; j = 1; for (v1 = v1orig; v1; v1 = FcValueListNext(v1)) { for (v2 = v2orig, k = 0; v2; v2 = FcValueListNext(v2), k++) { v = (match->compare) (&v1->value, &v2->value); if (v < 0) { *result = FcResultTypeMismatch; return FcFalse; } v = v * 1000 + j; if (v < best) { if (bestValue) *bestValue = FcValueCanonicalize(&v2->value); best = v; pos = k; } if (v1->binding == FcValueBindingStrong) { if (v < bestStrong) bestStrong = v; } else { if (v < bestWeak) bestWeak = v; } } j++; } if (FcDebug () & FC_DBG_MATCHV) { printf (" %s: %g ", FcObjectName (object), best); FcValueListPrint (v1orig); printf (", "); FcValueListPrint (v2orig); printf ("\n"); } if (value) { int weak = match->weak; int strong = match->strong; if (weak == strong) value[strong] += best; else { value[weak] += bestWeak; value[strong] += bestStrong; } } if (n) *n = pos; return FcTrue; } /* * Return a value indicating the distance between the two lists of * values */ static FcBool FcCompare (FcPattern *pat, FcPattern *fnt, double *value, FcResult *result) { int i, i1, i2; for (i = 0; i < NUM_MATCH_VALUES; i++) value[i] = 0.0; i1 = 0; i2 = 0; while (i1 < pat->num && i2 < fnt->num) { FcPatternElt *elt_i1 = &FcPatternElts(pat)[i1]; FcPatternElt *elt_i2 = &FcPatternElts(fnt)[i2]; i = FcObjectCompare(elt_i1->object, elt_i2->object); if (i > 0) i2++; else if (i < 0) i1++; else { const FcMatcher *match = FcObjectToMatcher (elt_i1->object, FcFalse); if (!FcCompareValueList (elt_i1->object, match, FcPatternEltValues(elt_i1), FcPatternEltValues(elt_i2), NULL, value, NULL, result)) return FcFalse; i1++; i2++; } } return FcTrue; } FcPattern * FcFontRenderPrepare (FcConfig *config, FcPattern *pat, FcPattern *font) { FcPattern *new; int i; FcPatternElt *fe, *pe, *fel, *pel; FcValue v; FcResult result; assert (pat != NULL); assert (font != NULL); new = FcPatternCreate (); if (!new) return NULL; for (i = 0; i < font->num; i++) { fe = &FcPatternElts(font)[i]; if (fe->object == FC_FAMILYLANG_OBJECT || fe->object == FC_STYLELANG_OBJECT || fe->object == FC_FULLNAMELANG_OBJECT) { /* ignore those objects. we need to deal with them * another way */ continue; } if (fe->object == FC_FAMILY_OBJECT || fe->object == FC_STYLE_OBJECT || fe->object == FC_FULLNAME_OBJECT) { FC_ASSERT_STATIC ((FC_FAMILY_OBJECT + 1) == FC_FAMILYLANG_OBJECT); FC_ASSERT_STATIC ((FC_STYLE_OBJECT + 1) == FC_STYLELANG_OBJECT); FC_ASSERT_STATIC ((FC_FULLNAME_OBJECT + 1) == FC_FULLNAMELANG_OBJECT); fel = FcPatternObjectFindElt (font, fe->object + 1); pel = FcPatternObjectFindElt (pat, fe->object + 1); } else { fel = NULL; pel = NULL; } pe = FcPatternObjectFindElt (pat, fe->object); if (pe) { const FcMatcher *match = FcObjectToMatcher (pe->object, FcFalse); if (!FcCompareValueList (pe->object, match, FcPatternEltValues(pe), FcPatternEltValues(fe), &v, NULL, NULL, &result)) { FcPatternDestroy (new); return NULL; } if (fel && pel) { int n = 1, j; FcValueListPtr l1, l2, ln = NULL, ll = NULL; match = FcObjectToMatcher (pel->object, FcTrue); if (!FcCompareValueList (pel->object, match, FcPatternEltValues (pel), FcPatternEltValues (fel), NULL, NULL, &n, &result)) { FcPatternDestroy (new); return NULL; } for (j = 0, l1 = FcPatternEltValues (fe), l2 = FcPatternEltValues (fel); l1 != NULL || l2 != NULL; j++, l1 = l1 ? FcValueListNext (l1) : NULL, l2 = l2 ? FcValueListNext (l2) : NULL) { if (j == n) { if (l1) ln = FcValueListPrepend (ln, FcValueCanonicalize (&l1->value), FcValueBindingStrong); if (l2) ll = FcValueListPrepend (ll, FcValueCanonicalize (&l2->value), FcValueBindingStrong); } else { if (l1) ln = FcValueListAppend (ln, FcValueCanonicalize (&l1->value), FcValueBindingStrong); if (l2) ll = FcValueListAppend (ll, FcValueCanonicalize (&l2->value), FcValueBindingStrong); } } FcPatternObjectListAdd (new, fe->object, ln, FcFalse); FcPatternObjectListAdd (new, fel->object, ll, FcFalse); continue; } else if (fel) { FcValueListPtr l1, l2; copy_lang: l1 = FcValueListDuplicate (FcPatternEltValues (fe)); l2 = FcValueListDuplicate (FcPatternEltValues (fel)); FcPatternObjectListAdd (new, fe->object, l1, FcFalse); FcPatternObjectListAdd (new, fel->object, l2, FcFalse); continue; } } else { if (fel) goto copy_lang; v = FcValueCanonicalize(&FcPatternEltValues (fe)->value); } FcPatternObjectAdd (new, fe->object, v, FcFalse); } for (i = 0; i < pat->num; i++) { pe = &FcPatternElts(pat)[i]; fe = FcPatternObjectFindElt (font, pe->object); if (!fe) { v = FcValueCanonicalize(&FcPatternEltValues(pe)->value); FcPatternObjectAdd (new, pe->object, v, FcTrue); } } FcConfigSubstituteWithPat (config, new, pat, FcMatchFont); return new; } static FcPattern * FcFontSetMatchInternal (FcConfig *config, FcFontSet **sets, int nsets, FcPattern *p, FcResult *result) { double score[NUM_MATCH_VALUES], bestscore[NUM_MATCH_VALUES]; int f; FcFontSet *s; FcPattern *best; int i; int set; for (i = 0; i < NUM_MATCH_VALUES; i++) bestscore[i] = 0; best = 0; if (FcDebug () & FC_DBG_MATCH) { printf ("Match "); FcPatternPrint (p); } for (set = 0; set < nsets; set++) { s = sets[set]; if (!s) continue; for (f = 0; f < s->nfont; f++) { if (FcDebug () & FC_DBG_MATCHV) { printf ("Font %d ", f); FcPatternPrint (s->fonts[f]); } if (!FcCompare (p, s->fonts[f], score, result)) return 0; if (FcDebug () & FC_DBG_MATCHV) { printf ("Score"); for (i = 0; i < NUM_MATCH_VALUES; i++) { printf (" %g", score[i]); } printf ("\n"); } for (i = 0; i < NUM_MATCH_VALUES; i++) { if (best && bestscore[i] < score[i]) break; if (!best || score[i] < bestscore[i]) { for (i = 0; i < NUM_MATCH_VALUES; i++) bestscore[i] = score[i]; best = s->fonts[f]; break; } } } } if (FcDebug () & FC_DBG_MATCH) { printf ("Best score"); for (i = 0; i < NUM_MATCH_VALUES; i++) printf (" %g", bestscore[i]); printf ("\n"); FcPatternPrint (best); } /* assuming that 'result' is initialized with FcResultNoMatch * outside this function */ if (best) *result = FcResultMatch; return best; } FcPattern * FcFontSetMatch (FcConfig *config, FcFontSet **sets, int nsets, FcPattern *p, FcResult *result) { FcPattern *best; assert (sets != NULL); assert (p != NULL); assert (result != NULL); *result = FcResultNoMatch; if (!config) { config = FcConfigGetCurrent (); if (!config) return 0; } best = FcFontSetMatchInternal (config, sets, nsets, p, result); if (best) return FcFontRenderPrepare (config, p, best); else return NULL; } FcPattern * FcFontMatch (FcConfig *config, FcPattern *p, FcResult *result) { FcFontSet *sets[2]; int nsets; FcPattern *best; assert (p != NULL); assert (result != NULL); *result = FcResultNoMatch; if (!config) { config = FcConfigGetCurrent (); if (!config) return 0; } nsets = 0; if (config->fonts[FcSetSystem]) sets[nsets++] = config->fonts[FcSetSystem]; if (config->fonts[FcSetApplication]) sets[nsets++] = config->fonts[FcSetApplication]; best = FcFontSetMatchInternal (config, sets, nsets, p, result); if (best) return FcFontRenderPrepare (config, p, best); else return NULL; } typedef struct _FcSortNode { FcPattern *pattern; double score[NUM_MATCH_VALUES]; } FcSortNode; static int FcSortCompare (const void *aa, const void *ab) { FcSortNode *a = *(FcSortNode **) aa; FcSortNode *b = *(FcSortNode **) ab; double *as = &a->score[0]; double *bs = &b->score[0]; double ad = 0, bd = 0; int i; i = NUM_MATCH_VALUES; while (i-- && (ad = *as++) == (bd = *bs++)) ; return ad < bd ? -1 : ad > bd ? 1 : 0; } static FcBool FcSortWalk (FcSortNode **n, int nnode, FcFontSet *fs, FcCharSet **csp, FcBool trim) { FcBool ret = FcFalse; FcCharSet *cs; cs = 0; if (trim || csp) { cs = FcCharSetCreate (); if (cs == NULL) goto bail; } while (nnode--) { FcSortNode *node = *n++; FcBool adds_chars = FcFalse; /* * Only fetch node charset if we'd need it */ if (cs) { FcCharSet *ncs; if (FcPatternGetCharSet (node->pattern, FC_CHARSET, 0, &ncs) != FcResultMatch) continue; if (!FcCharSetMerge (cs, ncs, &adds_chars)) goto bail; } /* * If this font isn't a subset of the previous fonts, * add it to the list */ if (!trim || adds_chars) { FcPatternReference (node->pattern); if (FcDebug () & FC_DBG_MATCHV) { printf ("Add "); FcPatternPrint (node->pattern); } if (!FcFontSetAdd (fs, node->pattern)) { FcPatternDestroy (node->pattern); goto bail; } } } if (csp) { *csp = cs; cs = 0; } ret = FcTrue; bail: if (cs) FcCharSetDestroy (cs); return ret; } void FcFontSetSortDestroy (FcFontSet *fs) { FcFontSetDestroy (fs); } FcFontSet * FcFontSetSort (FcConfig *config, FcFontSet **sets, int nsets, FcPattern *p, FcBool trim, FcCharSet **csp, FcResult *result) { FcFontSet *ret; FcFontSet *s; FcSortNode *nodes; FcSortNode **nodeps, **nodep; int nnodes; FcSortNode *new; int set; int f; int i; int nPatternLang; FcBool *patternLangSat; FcValue patternLang; assert (sets != NULL); assert (p != NULL); assert (result != NULL); /* There are some implementation that relying on the result of * "result" to check if the return value of FcFontSetSort * is valid or not. * So we should initialize it to the conservative way since * this function doesn't return NULL anymore. */ if (result) *result = FcResultNoMatch; if (FcDebug () & FC_DBG_MATCH) { printf ("Sort "); FcPatternPrint (p); } nnodes = 0; for (set = 0; set < nsets; set++) { s = sets[set]; if (!s) continue; nnodes += s->nfont; } if (!nnodes) return FcFontSetCreate (); for (nPatternLang = 0; FcPatternGet (p, FC_LANG, nPatternLang, &patternLang) == FcResultMatch; nPatternLang++) ; /* freed below */ nodes = malloc (nnodes * sizeof (FcSortNode) + nnodes * sizeof (FcSortNode *) + nPatternLang * sizeof (FcBool)); if (!nodes) goto bail0; nodeps = (FcSortNode **) (nodes + nnodes); patternLangSat = (FcBool *) (nodeps + nnodes); new = nodes; nodep = nodeps; for (set = 0; set < nsets; set++) { s = sets[set]; if (!s) continue; for (f = 0; f < s->nfont; f++) { if (FcDebug () & FC_DBG_MATCHV) { printf ("Font %d ", f); FcPatternPrint (s->fonts[f]); } new->pattern = s->fonts[f]; if (!FcCompare (p, new->pattern, new->score, result)) goto bail1; if (FcDebug () & FC_DBG_MATCHV) { printf ("Score"); for (i = 0; i < NUM_MATCH_VALUES; i++) { printf (" %g", new->score[i]); } printf ("\n"); } *nodep = new; new++; nodep++; } } nnodes = new - nodes; qsort (nodeps, nnodes, sizeof (FcSortNode *), FcSortCompare); for (i = 0; i < nPatternLang; i++) patternLangSat[i] = FcFalse; for (f = 0; f < nnodes; f++) { FcBool satisfies = FcFalse; /* * If this node matches any language, go check * which ones and satisfy those entries */ if (nodeps[f]->score[MATCH_LANG_INDEX] < 2000) { for (i = 0; i < nPatternLang; i++) { FcValue nodeLang; if (!patternLangSat[i] && FcPatternGet (p, FC_LANG, i, &patternLang) == FcResultMatch && FcPatternGet (nodeps[f]->pattern, FC_LANG, 0, &nodeLang) == FcResultMatch) { double compare = FcCompareLang (&patternLang, &nodeLang); if (compare >= 0 && compare < 2) { if (FcDebug () & FC_DBG_MATCHV) { FcChar8 *family; FcChar8 *style; if (FcPatternGetString (nodeps[f]->pattern, FC_FAMILY, 0, &family) == FcResultMatch && FcPatternGetString (nodeps[f]->pattern, FC_STYLE, 0, &style) == FcResultMatch) printf ("Font %s:%s matches language %d\n", family, style, i); } patternLangSat[i] = FcTrue; satisfies = FcTrue; break; } } } } if (!satisfies) nodeps[f]->score[MATCH_LANG_INDEX] = 10000.0; } /* * Re-sort once the language issues have been settled */ qsort (nodeps, nnodes, sizeof (FcSortNode *), FcSortCompare); ret = FcFontSetCreate (); if (!ret) goto bail1; if (!FcSortWalk (nodeps, nnodes, ret, csp, trim)) goto bail2; free (nodes); if (FcDebug() & FC_DBG_MATCH) { printf ("First font "); FcPatternPrint (ret->fonts[0]); } if (ret->nfont > 0) *result = FcResultMatch; return ret; bail2: FcFontSetDestroy (ret); bail1: free (nodes); bail0: return 0; } FcFontSet * FcFontSort (FcConfig *config, FcPattern *p, FcBool trim, FcCharSet **csp, FcResult *result) { FcFontSet *sets[2]; int nsets; assert (p != NULL); assert (result != NULL); *result = FcResultNoMatch; if (!config) { config = FcConfigGetCurrent (); if (!config) return 0; } nsets = 0; if (config->fonts[FcSetSystem]) sets[nsets++] = config->fonts[FcSetSystem]; if (config->fonts[FcSetApplication]) sets[nsets++] = config->fonts[FcSetApplication]; return FcFontSetSort (config, sets, nsets, p, trim, csp, result); } #define __fcmatch__ #include "fcaliastail.h" #undef __fcmatch__