user32: Avoid TRUE:FALSE conditional expressions.
[wine/multimedia.git] / dlls / gdiplus / font.c
blob9d545e0ac225a71ca979d8677f7503506cb90b9c
1 /*
2 * Copyright (C) 2007 Google (Evan Stade)
3 * Copyright (C) 2012 Dmitry Timoshkov
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 #include <stdarg.h>
22 #include "windef.h"
23 #include "winbase.h"
24 #include "wingdi.h"
25 #include "winnls.h"
26 #include "winreg.h"
27 #include "wine/debug.h"
28 #include "wine/unicode.h"
30 WINE_DEFAULT_DEBUG_CHANNEL (gdiplus);
32 #include "objbase.h"
34 #include "gdiplus.h"
35 #include "gdiplus_private.h"
37 /* PANOSE is 10 bytes in size, need to pack the structure properly */
38 #include "pshpack2.h"
39 typedef struct
41 USHORT version;
42 SHORT xAvgCharWidth;
43 USHORT usWeightClass;
44 USHORT usWidthClass;
45 SHORT fsType;
46 SHORT ySubscriptXSize;
47 SHORT ySubscriptYSize;
48 SHORT ySubscriptXOffset;
49 SHORT ySubscriptYOffset;
50 SHORT ySuperscriptXSize;
51 SHORT ySuperscriptYSize;
52 SHORT ySuperscriptXOffset;
53 SHORT ySuperscriptYOffset;
54 SHORT yStrikeoutSize;
55 SHORT yStrikeoutPosition;
56 SHORT sFamilyClass;
57 PANOSE panose;
58 ULONG ulUnicodeRange1;
59 ULONG ulUnicodeRange2;
60 ULONG ulUnicodeRange3;
61 ULONG ulUnicodeRange4;
62 CHAR achVendID[4];
63 USHORT fsSelection;
64 USHORT usFirstCharIndex;
65 USHORT usLastCharIndex;
66 /* According to the Apple spec, original version didn't have the below fields,
67 * version numbers were taken from the OpenType spec.
69 /* version 0 (TrueType 1.5) */
70 USHORT sTypoAscender;
71 USHORT sTypoDescender;
72 USHORT sTypoLineGap;
73 USHORT usWinAscent;
74 USHORT usWinDescent;
75 /* version 1 (TrueType 1.66) */
76 ULONG ulCodePageRange1;
77 ULONG ulCodePageRange2;
78 /* version 2 (OpenType 1.2) */
79 SHORT sxHeight;
80 SHORT sCapHeight;
81 USHORT usDefaultChar;
82 USHORT usBreakChar;
83 USHORT usMaxContext;
84 } TT_OS2_V2;
86 typedef struct
88 ULONG Version;
89 SHORT Ascender;
90 SHORT Descender;
91 SHORT LineGap;
92 USHORT advanceWidthMax;
93 SHORT minLeftSideBearing;
94 SHORT minRightSideBearing;
95 SHORT xMaxExtent;
96 SHORT caretSlopeRise;
97 SHORT caretSlopeRun;
98 SHORT caretOffset;
99 SHORT reserved[4];
100 SHORT metricDataFormat;
101 USHORT numberOfHMetrics;
102 } TT_HHEA;
103 #include "poppack.h"
105 #ifdef WORDS_BIGENDIAN
106 #define GET_BE_WORD(x) (x)
107 #define GET_BE_DWORD(x) (x)
108 #else
109 #define GET_BE_WORD(x) MAKEWORD(HIBYTE(x), LOBYTE(x))
110 #define GET_BE_DWORD(x) MAKELONG(GET_BE_WORD(HIWORD(x)), GET_BE_WORD(LOWORD(x)));
111 #endif
113 #define MS_MAKE_TAG(ch0, ch1, ch2, ch3) \
114 ((DWORD)(BYTE)(ch0) | ((DWORD)(BYTE)(ch1) << 8) | \
115 ((DWORD)(BYTE)(ch2) << 16) | ((DWORD)(BYTE)(ch3) << 24))
116 #define MS_OS2_TAG MS_MAKE_TAG('O','S','/','2')
117 #define MS_HHEA_TAG MS_MAKE_TAG('h','h','e','a')
119 static GpStatus clone_font_family(const GpFontFamily *, GpFontFamily **);
121 static GpFontCollection installedFontCollection = {0};
123 /*******************************************************************************
124 * GdipCreateFont [GDIPLUS.@]
126 * Create a new font based off of a FontFamily
128 * PARAMS
129 * *fontFamily [I] Family to base the font off of
130 * emSize [I] Size of the font
131 * style [I] Bitwise OR of FontStyle enumeration
132 * unit [I] Unit emSize is measured in
133 * **font [I] the resulting Font object
135 * RETURNS
136 * SUCCESS: Ok
137 * FAILURE: InvalidParameter if fontfamily or font is NULL.
138 * FAILURE: FontFamilyNotFound if an invalid FontFamily is given
140 * NOTES
141 * UnitDisplay is unsupported.
142 * emSize is stored separately from lfHeight, to hold the fraction.
144 GpStatus WINGDIPAPI GdipCreateFont(GDIPCONST GpFontFamily *fontFamily,
145 REAL emSize, INT style, Unit unit, GpFont **font)
147 HFONT hfont;
148 OUTLINETEXTMETRICW otm;
149 LOGFONTW lfw;
150 HDC hdc;
151 GpStatus stat;
152 int ret;
154 if (!fontFamily || !font || emSize < 0.0)
155 return InvalidParameter;
157 TRACE("%p (%s), %f, %d, %d, %p\n", fontFamily,
158 debugstr_w(fontFamily->FamilyName), emSize, style, unit, font);
160 memset(&lfw, 0, sizeof(lfw));
162 stat = GdipGetFamilyName(fontFamily, lfw.lfFaceName, LANG_NEUTRAL);
163 if (stat != Ok) return stat;
165 lfw.lfHeight = -units_to_pixels(emSize, unit, fontFamily->dpi);
166 lfw.lfWeight = style & FontStyleBold ? FW_BOLD : FW_REGULAR;
167 lfw.lfItalic = style & FontStyleItalic;
168 lfw.lfUnderline = style & FontStyleUnderline;
169 lfw.lfStrikeOut = style & FontStyleStrikeout;
171 hfont = CreateFontIndirectW(&lfw);
172 hdc = CreateCompatibleDC(0);
173 SelectObject(hdc, hfont);
174 otm.otmSize = sizeof(otm);
175 ret = GetOutlineTextMetricsW(hdc, otm.otmSize, &otm);
176 DeleteDC(hdc);
177 DeleteObject(hfont);
179 if (!ret) return NotTrueTypeFont;
181 *font = GdipAlloc(sizeof(GpFont));
182 if (!*font) return OutOfMemory;
184 (*font)->unit = unit;
185 (*font)->emSize = emSize;
186 (*font)->otm = otm;
188 stat = clone_font_family(fontFamily, &(*font)->family);
189 if (stat != Ok)
191 GdipFree(*font);
192 return stat;
195 TRACE("<-- %p\n", *font);
197 return Ok;
200 /*******************************************************************************
201 * GdipCreateFontFromLogfontW [GDIPLUS.@]
203 GpStatus WINGDIPAPI GdipCreateFontFromLogfontW(HDC hdc,
204 GDIPCONST LOGFONTW *logfont, GpFont **font)
206 HFONT hfont, oldfont;
207 OUTLINETEXTMETRICW otm;
208 GpStatus stat;
209 int ret;
211 TRACE("(%p, %p, %p)\n", hdc, logfont, font);
213 if (!hdc || !logfont || !font)
214 return InvalidParameter;
216 hfont = CreateFontIndirectW(logfont);
217 oldfont = SelectObject(hdc, hfont);
218 otm.otmSize = sizeof(otm);
219 ret = GetOutlineTextMetricsW(hdc, otm.otmSize, &otm);
220 SelectObject(hdc, oldfont);
221 DeleteObject(hfont);
223 if (!ret) return NotTrueTypeFont;
225 *font = GdipAlloc(sizeof(GpFont));
226 if (!*font) return OutOfMemory;
228 (*font)->unit = UnitWorld;
229 (*font)->emSize = otm.otmTextMetrics.tmAscent;
230 (*font)->otm = otm;
232 stat = GdipCreateFontFamilyFromName(logfont->lfFaceName, NULL, &(*font)->family);
233 if (stat != Ok)
235 GdipFree(*font);
236 return NotTrueTypeFont;
239 TRACE("<-- %p\n", *font);
241 return Ok;
244 /*******************************************************************************
245 * GdipCreateFontFromLogfontA [GDIPLUS.@]
247 GpStatus WINGDIPAPI GdipCreateFontFromLogfontA(HDC hdc,
248 GDIPCONST LOGFONTA *lfa, GpFont **font)
250 LOGFONTW lfw;
252 TRACE("(%p, %p, %p)\n", hdc, lfa, font);
254 if(!lfa || !font)
255 return InvalidParameter;
257 memcpy(&lfw, lfa, FIELD_OFFSET(LOGFONTA,lfFaceName) );
259 if(!MultiByteToWideChar(CP_ACP, 0, lfa->lfFaceName, -1, lfw.lfFaceName, LF_FACESIZE))
260 return GenericError;
262 return GdipCreateFontFromLogfontW(hdc, &lfw, font);
265 /*******************************************************************************
266 * GdipDeleteFont [GDIPLUS.@]
268 GpStatus WINGDIPAPI GdipDeleteFont(GpFont* font)
270 TRACE("(%p)\n", font);
272 if(!font)
273 return InvalidParameter;
275 GdipDeleteFontFamily(font->family);
276 GdipFree(font);
278 return Ok;
281 /*******************************************************************************
282 * GdipCreateFontFromDC [GDIPLUS.@]
284 GpStatus WINGDIPAPI GdipCreateFontFromDC(HDC hdc, GpFont **font)
286 HFONT hfont;
287 LOGFONTW lfw;
289 TRACE("(%p, %p)\n", hdc, font);
291 if(!font)
292 return InvalidParameter;
294 hfont = GetCurrentObject(hdc, OBJ_FONT);
295 if(!hfont)
296 return GenericError;
298 if(!GetObjectW(hfont, sizeof(LOGFONTW), &lfw))
299 return GenericError;
301 return GdipCreateFontFromLogfontW(hdc, &lfw, font);
304 /*******************************************************************************
305 * GdipGetFamily [GDIPLUS.@]
307 * Returns the FontFamily for the specified Font
309 * PARAMS
310 * font [I] Font to request from
311 * family [O] Resulting FontFamily object
313 * RETURNS
314 * SUCCESS: Ok
315 * FAILURE: An element of GpStatus
317 GpStatus WINGDIPAPI GdipGetFamily(GpFont *font, GpFontFamily **family)
319 TRACE("%p %p\n", font, family);
321 if (!(font && family))
322 return InvalidParameter;
324 return GdipCloneFontFamily(font->family, family);
327 static REAL get_font_size(const GpFont *font)
329 return font->emSize;
332 /******************************************************************************
333 * GdipGetFontSize [GDIPLUS.@]
335 * Returns the size of the font in Units
337 * PARAMS
338 * *font [I] The font to retrieve size from
339 * *size [O] Pointer to hold retrieved value
341 * RETURNS
342 * SUCCESS: Ok
343 * FAILURE: InvalidParameter (font or size was NULL)
345 * NOTES
346 * Size returned is actually emSize -- not internal size used for drawing.
348 GpStatus WINGDIPAPI GdipGetFontSize(GpFont *font, REAL *size)
350 TRACE("(%p, %p)\n", font, size);
352 if (!(font && size)) return InvalidParameter;
354 *size = get_font_size(font);
355 TRACE("%s,%d => %f\n", debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, *size);
357 return Ok;
360 static INT get_font_style(const GpFont *font)
362 INT style;
364 if (font->otm.otmTextMetrics.tmWeight > FW_REGULAR)
365 style = FontStyleBold;
366 else
367 style = FontStyleRegular;
368 if (font->otm.otmTextMetrics.tmItalic)
369 style |= FontStyleItalic;
370 if (font->otm.otmTextMetrics.tmUnderlined)
371 style |= FontStyleUnderline;
372 if (font->otm.otmTextMetrics.tmStruckOut)
373 style |= FontStyleStrikeout;
375 return style;
378 /*******************************************************************************
379 * GdipGetFontStyle [GDIPLUS.@]
381 * Gets the font's style, returned in bitwise OR of FontStyle enumeration
383 * PARAMS
384 * font [I] font to request from
385 * style [O] resulting pointer to a FontStyle enumeration
387 * RETURNS
388 * SUCCESS: Ok
389 * FAILURE: InvalidParameter
391 GpStatus WINGDIPAPI GdipGetFontStyle(GpFont *font, INT *style)
393 TRACE("%p %p\n", font, style);
395 if (!(font && style))
396 return InvalidParameter;
398 *style = get_font_style(font);
399 TRACE("%s,%d => %d\n", debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, *style);
401 return Ok;
404 /*******************************************************************************
405 * GdipGetFontUnit [GDIPLUS.@]
407 * PARAMS
408 * font [I] Font to retrieve from
409 * unit [O] Return value
411 * RETURNS
412 * FAILURE: font or unit was NULL
413 * OK: otherwise
415 GpStatus WINGDIPAPI GdipGetFontUnit(GpFont *font, Unit *unit)
417 TRACE("(%p, %p)\n", font, unit);
419 if (!(font && unit)) return InvalidParameter;
421 *unit = font->unit;
422 TRACE("%s,%d => %d\n", debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, *unit);
424 return Ok;
427 /*******************************************************************************
428 * GdipGetLogFontA [GDIPLUS.@]
430 GpStatus WINGDIPAPI GdipGetLogFontA(GpFont *font, GpGraphics *graphics,
431 LOGFONTA *lfa)
433 GpStatus status;
434 LOGFONTW lfw;
436 TRACE("(%p, %p, %p)\n", font, graphics, lfa);
438 status = GdipGetLogFontW(font, graphics, &lfw);
439 if(status != Ok)
440 return status;
442 memcpy(lfa, &lfw, FIELD_OFFSET(LOGFONTA,lfFaceName) );
444 if(!WideCharToMultiByte(CP_ACP, 0, lfw.lfFaceName, -1, lfa->lfFaceName, LF_FACESIZE, NULL, NULL))
445 return GenericError;
447 return Ok;
450 void get_log_fontW(const GpFont *font, GpGraphics *graphics, LOGFONTW *lf)
452 /* FIXME: use graphics */
453 lf->lfHeight = -units_to_pixels(font->emSize, font->unit, font->family->dpi);
454 lf->lfWidth = 0;
455 lf->lfEscapement = 0;
456 lf->lfOrientation = 0;
457 lf->lfWeight = font->otm.otmTextMetrics.tmWeight;
458 lf->lfItalic = font->otm.otmTextMetrics.tmItalic ? 1 : 0;
459 lf->lfUnderline = font->otm.otmTextMetrics.tmUnderlined ? 1 : 0;
460 lf->lfStrikeOut = font->otm.otmTextMetrics.tmStruckOut ? 1 : 0;
461 lf->lfCharSet = font->otm.otmTextMetrics.tmCharSet;
462 lf->lfOutPrecision = OUT_DEFAULT_PRECIS;
463 lf->lfClipPrecision = CLIP_DEFAULT_PRECIS;
464 lf->lfQuality = DEFAULT_QUALITY;
465 lf->lfPitchAndFamily = 0;
466 strcpyW(lf->lfFaceName, font->family->FamilyName);
469 /*******************************************************************************
470 * GdipGetLogFontW [GDIPLUS.@]
472 GpStatus WINGDIPAPI GdipGetLogFontW(GpFont *font, GpGraphics *graphics,
473 LOGFONTW *lfw)
475 TRACE("(%p, %p, %p)\n", font, graphics, lfw);
477 if(!font || !graphics || !lfw)
478 return InvalidParameter;
480 get_log_fontW(font, graphics, lfw);
481 TRACE("=> %s,%d\n", debugstr_w(lfw->lfFaceName), lfw->lfHeight);
483 return Ok;
486 /*******************************************************************************
487 * GdipCloneFont [GDIPLUS.@]
489 GpStatus WINGDIPAPI GdipCloneFont(GpFont *font, GpFont **cloneFont)
491 GpStatus stat;
493 TRACE("(%p, %p)\n", font, cloneFont);
495 if(!font || !cloneFont)
496 return InvalidParameter;
498 *cloneFont = GdipAlloc(sizeof(GpFont));
499 if(!*cloneFont) return OutOfMemory;
501 **cloneFont = *font;
502 stat = GdipCloneFontFamily(font->family, &(*cloneFont)->family);
503 if (stat != Ok) GdipFree(*cloneFont);
505 return stat;
508 /*******************************************************************************
509 * GdipGetFontHeight [GDIPLUS.@]
510 * PARAMS
511 * font [I] Font to retrieve height from
512 * graphics [I] The current graphics context
513 * height [O] Resulting height
514 * RETURNS
515 * SUCCESS: Ok
516 * FAILURE: Another element of GpStatus
518 * NOTES
519 * Forwards to GdipGetFontHeightGivenDPI
521 GpStatus WINGDIPAPI GdipGetFontHeight(GDIPCONST GpFont *font,
522 GDIPCONST GpGraphics *graphics, REAL *height)
524 REAL dpi;
525 GpStatus stat;
526 REAL font_height;
528 TRACE("%p %p %p\n", font, graphics, height);
530 stat = GdipGetFontHeightGivenDPI(font, font->family->dpi, &font_height);
531 if (stat != Ok) return stat;
533 if (!graphics)
535 *height = font_height;
536 TRACE("%s,%d => %f\n",
537 debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, *height);
538 return Ok;
541 stat = GdipGetDpiY((GpGraphics *)graphics, &dpi);
542 if (stat != Ok) return stat;
544 *height = pixels_to_units(font_height, graphics->unit, dpi);
546 TRACE("%s,%d(unit %d) => %f\n",
547 debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, graphics->unit, *height);
548 return Ok;
551 /*******************************************************************************
552 * GdipGetFontHeightGivenDPI [GDIPLUS.@]
553 * PARAMS
554 * font [I] Font to retrieve DPI from
555 * dpi [I] DPI to assume
556 * height [O] Return value
558 * RETURNS
559 * SUCCESS: Ok
560 * FAILURE: InvalidParameter if font or height is NULL
562 * NOTES
563 * According to MSDN, the result is (lineSpacing)*(fontSize / emHeight)*dpi
564 * (for anything other than unit Pixel)
566 GpStatus WINGDIPAPI GdipGetFontHeightGivenDPI(GDIPCONST GpFont *font, REAL dpi, REAL *height)
568 GpStatus stat;
569 INT style;
570 UINT16 line_spacing, em_height;
571 REAL font_size;
573 if (!font || !height) return InvalidParameter;
575 TRACE("%p (%s), %f, %p\n", font,
576 debugstr_w(font->family->FamilyName), dpi, height);
578 font_size = units_to_pixels(get_font_size(font), font->unit, dpi);
579 style = get_font_style(font);
580 stat = GdipGetLineSpacing(font->family, style, &line_spacing);
581 if (stat != Ok) return stat;
582 stat = GdipGetEmHeight(font->family, style, &em_height);
583 if (stat != Ok) return stat;
585 *height = (REAL)line_spacing * font_size / (REAL)em_height;
587 TRACE("%s,%d => %f\n",
588 debugstr_w(font->family->FamilyName), font->otm.otmTextMetrics.tmHeight, *height);
590 return Ok;
593 /***********************************************************************
594 * Borrowed from GDI32:
596 * Elf is really an ENUMLOGFONTEXW, and ntm is a NEWTEXTMETRICEXW.
597 * We have to use other types because of the FONTENUMPROCW definition.
599 static INT CALLBACK is_font_installed_proc(const LOGFONTW *elf,
600 const TEXTMETRICW *ntm, DWORD type, LPARAM lParam)
602 if (type & RASTER_FONTTYPE)
603 return 1;
605 *(LOGFONTW *)lParam = *elf;
607 return 0;
610 struct font_metrics
612 UINT16 em_height, ascent, descent, line_spacing; /* in font units */
613 int dpi;
616 static BOOL get_font_metrics(HDC hdc, struct font_metrics *fm)
618 OUTLINETEXTMETRICW otm;
619 TT_OS2_V2 tt_os2;
620 TT_HHEA tt_hori;
621 LONG size;
622 UINT16 line_gap;
624 otm.otmSize = sizeof(otm);
625 if (!GetOutlineTextMetricsW(hdc, otm.otmSize, &otm)) return FALSE;
627 fm->em_height = otm.otmEMSquare;
628 fm->dpi = GetDeviceCaps(hdc, LOGPIXELSY);
630 memset(&tt_hori, 0, sizeof(tt_hori));
631 if (GetFontData(hdc, MS_HHEA_TAG, 0, &tt_hori, sizeof(tt_hori)) != GDI_ERROR)
633 fm->ascent = GET_BE_WORD(tt_hori.Ascender);
634 fm->descent = -GET_BE_WORD(tt_hori.Descender);
635 TRACE("hhea: ascent %d, descent %d\n", fm->ascent, fm->descent);
636 line_gap = GET_BE_WORD(tt_hori.LineGap);
637 fm->line_spacing = fm->ascent + fm->descent + line_gap;
638 TRACE("line_gap %u, line_spacing %u\n", line_gap, fm->line_spacing);
639 if (fm->ascent + fm->descent != 0) return TRUE;
642 size = GetFontData(hdc, MS_OS2_TAG, 0, NULL, 0);
643 if (size == GDI_ERROR) return FALSE;
645 if (size > sizeof(tt_os2)) size = sizeof(tt_os2);
647 memset(&tt_os2, 0, sizeof(tt_os2));
648 if (GetFontData(hdc, MS_OS2_TAG, 0, &tt_os2, size) != size) return FALSE;
650 fm->ascent = GET_BE_WORD(tt_os2.usWinAscent);
651 fm->descent = GET_BE_WORD(tt_os2.usWinDescent);
652 TRACE("usWinAscent %u, usWinDescent %u\n", fm->ascent, fm->descent);
653 if (fm->ascent + fm->descent == 0)
655 fm->ascent = GET_BE_WORD(tt_os2.sTypoAscender);
656 fm->descent = GET_BE_WORD(tt_os2.sTypoDescender);
657 TRACE("sTypoAscender %u, sTypoDescender %u\n", fm->ascent, fm->descent);
659 line_gap = GET_BE_WORD(tt_os2.sTypoLineGap);
660 fm->line_spacing = fm->ascent + fm->descent + line_gap;
661 TRACE("line_gap %u, line_spacing %u\n", line_gap, fm->line_spacing);
662 return TRUE;
665 static GpStatus find_installed_font(const WCHAR *name, struct font_metrics *fm)
667 LOGFONTW lf;
668 HDC hdc = CreateCompatibleDC(0);
669 GpStatus ret = FontFamilyNotFound;
671 if(!EnumFontFamiliesW(hdc, name, is_font_installed_proc, (LPARAM)&lf))
673 HFONT hfont, old_font;
675 hfont = CreateFontIndirectW(&lf);
676 old_font = SelectObject(hdc, hfont);
677 ret = get_font_metrics(hdc, fm) ? Ok : NotTrueTypeFont;
678 SelectObject(hdc, old_font);
679 DeleteObject(hfont);
682 DeleteDC(hdc);
683 return ret;
686 /*******************************************************************************
687 * GdipCreateFontFamilyFromName [GDIPLUS.@]
689 * Creates a font family object based on a supplied name
691 * PARAMS
692 * name [I] Name of the font
693 * fontCollection [I] What font collection (if any) the font belongs to (may be NULL)
694 * FontFamily [O] Pointer to the resulting FontFamily object
696 * RETURNS
697 * SUCCESS: Ok
698 * FAILURE: FamilyNotFound if the requested FontFamily does not exist on the system
699 * FAILURE: Invalid parameter if FontFamily or name is NULL
701 * NOTES
702 * If fontCollection is NULL then the object is not part of any collection
706 GpStatus WINGDIPAPI GdipCreateFontFamilyFromName(GDIPCONST WCHAR *name,
707 GpFontCollection *fontCollection,
708 GpFontFamily **FontFamily)
710 GpStatus stat;
711 GpFontFamily* ffamily;
712 struct font_metrics fm;
714 TRACE("%s, %p %p\n", debugstr_w(name), fontCollection, FontFamily);
716 if (!(name && FontFamily))
717 return InvalidParameter;
718 if (fontCollection)
719 FIXME("No support for FontCollections yet!\n");
721 stat = find_installed_font(name, &fm);
722 if (stat != Ok) return stat;
724 ffamily = GdipAlloc(sizeof (GpFontFamily));
725 if (!ffamily) return OutOfMemory;
727 lstrcpynW(ffamily->FamilyName, name, LF_FACESIZE);
728 ffamily->em_height = fm.em_height;
729 ffamily->ascent = fm.ascent;
730 ffamily->descent = fm.descent;
731 ffamily->line_spacing = fm.line_spacing;
732 ffamily->dpi = fm.dpi;
734 *FontFamily = ffamily;
736 TRACE("<-- %p\n", ffamily);
738 return Ok;
741 static GpStatus clone_font_family(const GpFontFamily *family, GpFontFamily **clone)
743 *clone = GdipAlloc(sizeof(GpFontFamily));
744 if (!*clone) return OutOfMemory;
746 **clone = *family;
748 return Ok;
751 /*******************************************************************************
752 * GdipCloneFontFamily [GDIPLUS.@]
754 * Creates a deep copy of a Font Family object
756 * PARAMS
757 * FontFamily [I] Font to clone
758 * clonedFontFamily [O] The resulting cloned font
760 * RETURNS
761 * SUCCESS: Ok
763 GpStatus WINGDIPAPI GdipCloneFontFamily(GpFontFamily* FontFamily, GpFontFamily** clonedFontFamily)
765 GpStatus status;
767 if (!(FontFamily && clonedFontFamily)) return InvalidParameter;
769 TRACE("%p (%s), %p\n", FontFamily,
770 debugstr_w(FontFamily->FamilyName), clonedFontFamily);
772 status = clone_font_family(FontFamily, clonedFontFamily);
773 if (status != Ok) return status;
775 TRACE("<-- %p\n", *clonedFontFamily);
777 return Ok;
780 /*******************************************************************************
781 * GdipGetFamilyName [GDIPLUS.@]
783 * Returns the family name into name
785 * PARAMS
786 * *family [I] Family to retrieve from
787 * *name [O] WCHARS of the family name
788 * LANGID [I] charset
790 * RETURNS
791 * SUCCESS: Ok
792 * FAILURE: InvalidParameter if family is NULL
794 * NOTES
795 * If name is a NULL ptr, then both XP and Vista will crash (so we do as well)
797 GpStatus WINGDIPAPI GdipGetFamilyName (GDIPCONST GpFontFamily *family,
798 WCHAR *name, LANGID language)
800 static int lang_fixme;
802 if (family == NULL)
803 return InvalidParameter;
805 TRACE("%p, %p, %d\n", family, name, language);
807 if (language != LANG_NEUTRAL && !lang_fixme++)
808 FIXME("No support for handling of multiple languages!\n");
810 lstrcpynW (name, family->FamilyName, LF_FACESIZE);
812 return Ok;
816 /*****************************************************************************
817 * GdipDeleteFontFamily [GDIPLUS.@]
819 * Removes the specified FontFamily
821 * PARAMS
822 * *FontFamily [I] The family to delete
824 * RETURNS
825 * SUCCESS: Ok
826 * FAILURE: InvalidParameter if FontFamily is NULL.
829 GpStatus WINGDIPAPI GdipDeleteFontFamily(GpFontFamily *FontFamily)
831 if (!FontFamily)
832 return InvalidParameter;
833 TRACE("Deleting %p (%s)\n", FontFamily, debugstr_w(FontFamily->FamilyName));
835 GdipFree (FontFamily);
837 return Ok;
840 GpStatus WINGDIPAPI GdipGetCellAscent(GDIPCONST GpFontFamily *family,
841 INT style, UINT16* CellAscent)
843 if (!(family && CellAscent)) return InvalidParameter;
845 *CellAscent = family->ascent;
846 TRACE("%s => %u\n", debugstr_w(family->FamilyName), *CellAscent);
848 return Ok;
851 GpStatus WINGDIPAPI GdipGetCellDescent(GDIPCONST GpFontFamily *family,
852 INT style, UINT16* CellDescent)
854 TRACE("(%p, %d, %p)\n", family, style, CellDescent);
856 if (!(family && CellDescent)) return InvalidParameter;
858 *CellDescent = family->descent;
859 TRACE("%s => %u\n", debugstr_w(family->FamilyName), *CellDescent);
861 return Ok;
864 /*******************************************************************************
865 * GdipGetEmHeight [GDIPLUS.@]
867 * Gets the height of the specified family in EmHeights
869 * PARAMS
870 * family [I] Family to retrieve from
871 * style [I] (optional) style
872 * EmHeight [O] return value
874 * RETURNS
875 * SUCCESS: Ok
876 * FAILURE: InvalidParameter
878 GpStatus WINGDIPAPI GdipGetEmHeight(GDIPCONST GpFontFamily *family, INT style, UINT16* EmHeight)
880 if (!(family && EmHeight)) return InvalidParameter;
882 TRACE("%p (%s), %d, %p\n", family, debugstr_w(family->FamilyName), style, EmHeight);
884 *EmHeight = family->em_height;
885 TRACE("%s => %u\n", debugstr_w(family->FamilyName), *EmHeight);
887 return Ok;
891 /*******************************************************************************
892 * GdipGetLineSpacing [GDIPLUS.@]
894 * Returns the line spacing in design units
896 * PARAMS
897 * family [I] Family to retrieve from
898 * style [I] (Optional) font style
899 * LineSpacing [O] Return value
901 * RETURNS
902 * SUCCESS: Ok
903 * FAILURE: InvalidParameter (family or LineSpacing was NULL)
905 GpStatus WINGDIPAPI GdipGetLineSpacing(GDIPCONST GpFontFamily *family,
906 INT style, UINT16* LineSpacing)
908 TRACE("%p, %d, %p\n", family, style, LineSpacing);
910 if (!(family && LineSpacing))
911 return InvalidParameter;
913 if (style) FIXME("ignoring style\n");
915 *LineSpacing = family->line_spacing;
916 TRACE("%s => %u\n", debugstr_w(family->FamilyName), *LineSpacing);
918 return Ok;
921 static INT CALLBACK font_has_style_proc(const LOGFONTW *elf,
922 const TEXTMETRICW *ntm, DWORD type, LPARAM lParam)
924 INT fontstyle = FontStyleRegular;
926 if (!ntm) return 1;
928 if (ntm->tmWeight >= FW_BOLD) fontstyle |= FontStyleBold;
929 if (ntm->tmItalic) fontstyle |= FontStyleItalic;
930 if (ntm->tmUnderlined) fontstyle |= FontStyleUnderline;
931 if (ntm->tmStruckOut) fontstyle |= FontStyleStrikeout;
933 return (INT)lParam != fontstyle;
936 GpStatus WINGDIPAPI GdipIsStyleAvailable(GDIPCONST GpFontFamily* family,
937 INT style, BOOL* IsStyleAvailable)
939 HDC hdc;
941 TRACE("%p %d %p\n", family, style, IsStyleAvailable);
943 if (!(family && IsStyleAvailable))
944 return InvalidParameter;
946 *IsStyleAvailable = FALSE;
948 hdc = GetDC(0);
950 if(!EnumFontFamiliesW(hdc, family->FamilyName, font_has_style_proc, (LPARAM)style))
951 *IsStyleAvailable = TRUE;
953 ReleaseDC(0, hdc);
955 return Ok;
958 /*****************************************************************************
959 * GdipGetGenericFontFamilyMonospace [GDIPLUS.@]
961 * Obtains a serif family (Courier New on Windows)
963 * PARAMS
964 * **nativeFamily [I] Where the font will be stored
966 * RETURNS
967 * InvalidParameter if nativeFamily is NULL.
968 * Ok otherwise.
970 GpStatus WINGDIPAPI GdipGetGenericFontFamilyMonospace(GpFontFamily **nativeFamily)
972 static const WCHAR CourierNew[] = {'C','o','u','r','i','e','r',' ','N','e','w','\0'};
973 static const WCHAR LiberationMono[] = {'L','i','b','e','r','a','t','i','o','n',' ','M','o','n','o','\0'};
974 GpStatus stat;
976 if (nativeFamily == NULL) return InvalidParameter;
978 stat = GdipCreateFontFamilyFromName(CourierNew, NULL, nativeFamily);
980 if (stat == FontFamilyNotFound)
981 stat = GdipCreateFontFamilyFromName(LiberationMono, NULL, nativeFamily);
983 if (stat == FontFamilyNotFound)
984 ERR("Missing 'Courier New' font\n");
986 return stat;
989 /*****************************************************************************
990 * GdipGetGenericFontFamilySerif [GDIPLUS.@]
992 * Obtains a serif family (Times New Roman on Windows)
994 * PARAMS
995 * **nativeFamily [I] Where the font will be stored
997 * RETURNS
998 * InvalidParameter if nativeFamily is NULL.
999 * Ok otherwise.
1001 GpStatus WINGDIPAPI GdipGetGenericFontFamilySerif(GpFontFamily **nativeFamily)
1003 static const WCHAR TimesNewRoman[] = {'T','i','m','e','s',' ','N','e','w',' ','R','o','m','a','n','\0'};
1004 static const WCHAR LiberationSerif[] = {'L','i','b','e','r','a','t','i','o','n',' ','S','e','r','i','f','\0'};
1005 GpStatus stat;
1007 TRACE("(%p)\n", nativeFamily);
1009 if (nativeFamily == NULL) return InvalidParameter;
1011 stat = GdipCreateFontFamilyFromName(TimesNewRoman, NULL, nativeFamily);
1013 if (stat == FontFamilyNotFound)
1014 stat = GdipCreateFontFamilyFromName(LiberationSerif, NULL, nativeFamily);
1016 if (stat == FontFamilyNotFound)
1017 ERR("Missing 'Times New Roman' font\n");
1019 return stat;
1022 /*****************************************************************************
1023 * GdipGetGenericFontFamilySansSerif [GDIPLUS.@]
1025 * Obtains a serif family (Microsoft Sans Serif on Windows)
1027 * PARAMS
1028 * **nativeFamily [I] Where the font will be stored
1030 * RETURNS
1031 * InvalidParameter if nativeFamily is NULL.
1032 * Ok otherwise.
1034 GpStatus WINGDIPAPI GdipGetGenericFontFamilySansSerif(GpFontFamily **nativeFamily)
1036 GpStatus stat;
1037 static const WCHAR MicrosoftSansSerif[] = {'M','i','c','r','o','s','o','f','t',' ','S','a','n','s',' ','S','e','r','i','f','\0'};
1038 static const WCHAR Tahoma[] = {'T','a','h','o','m','a','\0'};
1040 TRACE("(%p)\n", nativeFamily);
1042 if (nativeFamily == NULL) return InvalidParameter;
1044 stat = GdipCreateFontFamilyFromName(MicrosoftSansSerif, NULL, nativeFamily);
1046 if (stat == FontFamilyNotFound)
1047 /* FIXME: Microsoft Sans Serif is not installed on Wine. */
1048 stat = GdipCreateFontFamilyFromName(Tahoma, NULL, nativeFamily);
1050 return stat;
1053 /*****************************************************************************
1054 * GdipGetGenericFontFamilySansSerif [GDIPLUS.@]
1056 GpStatus WINGDIPAPI GdipNewPrivateFontCollection(GpFontCollection** fontCollection)
1058 TRACE("%p\n", fontCollection);
1060 if (!fontCollection)
1061 return InvalidParameter;
1063 *fontCollection = GdipAlloc(sizeof(GpFontCollection));
1064 if (!*fontCollection) return OutOfMemory;
1066 (*fontCollection)->FontFamilies = NULL;
1067 (*fontCollection)->count = 0;
1068 (*fontCollection)->allocated = 0;
1070 TRACE("<-- %p\n", *fontCollection);
1072 return Ok;
1075 /*****************************************************************************
1076 * GdipDeletePrivateFontCollection [GDIPLUS.@]
1078 GpStatus WINGDIPAPI GdipDeletePrivateFontCollection(GpFontCollection **fontCollection)
1080 INT i;
1082 TRACE("%p\n", fontCollection);
1084 if (!fontCollection)
1085 return InvalidParameter;
1087 for (i = 0; i < (*fontCollection)->count; i++) GdipFree((*fontCollection)->FontFamilies[i]);
1088 GdipFree(*fontCollection);
1090 return Ok;
1093 /*****************************************************************************
1094 * GdipPrivateAddFontFile [GDIPLUS.@]
1096 GpStatus WINGDIPAPI GdipPrivateAddFontFile(GpFontCollection* fontCollection,
1097 GDIPCONST WCHAR* filename)
1099 FIXME("stub: %p, %s\n", fontCollection, debugstr_w(filename));
1101 if (!(fontCollection && filename))
1102 return InvalidParameter;
1104 return NotImplemented;
1107 /* Copied from msi/font.c */
1109 typedef struct _tagTT_OFFSET_TABLE {
1110 USHORT uMajorVersion;
1111 USHORT uMinorVersion;
1112 USHORT uNumOfTables;
1113 USHORT uSearchRange;
1114 USHORT uEntrySelector;
1115 USHORT uRangeShift;
1116 } TT_OFFSET_TABLE;
1118 typedef struct _tagTT_TABLE_DIRECTORY {
1119 char szTag[4]; /* table name */
1120 ULONG uCheckSum; /* Check sum */
1121 ULONG uOffset; /* Offset from beginning of file */
1122 ULONG uLength; /* length of the table in bytes */
1123 } TT_TABLE_DIRECTORY;
1125 typedef struct _tagTT_NAME_TABLE_HEADER {
1126 USHORT uFSelector; /* format selector. Always 0 */
1127 USHORT uNRCount; /* Name Records count */
1128 USHORT uStorageOffset; /* Offset for strings storage,
1129 * from start of the table */
1130 } TT_NAME_TABLE_HEADER;
1132 #define NAME_ID_FULL_FONT_NAME 4
1133 #define NAME_ID_VERSION 5
1135 typedef struct _tagTT_NAME_RECORD {
1136 USHORT uPlatformID;
1137 USHORT uEncodingID;
1138 USHORT uLanguageID;
1139 USHORT uNameID;
1140 USHORT uStringLength;
1141 USHORT uStringOffset; /* from start of storage area */
1142 } TT_NAME_RECORD;
1144 #define SWAPWORD(x) MAKEWORD(HIBYTE(x), LOBYTE(x))
1145 #define SWAPLONG(x) MAKELONG(SWAPWORD(HIWORD(x)), SWAPWORD(LOWORD(x)))
1148 * Code based off of code located here
1149 * http://www.codeproject.com/gdi/fontnamefromfile.asp
1151 static WCHAR *load_ttf_name_id( const char *mem, DWORD_PTR size, DWORD id, WCHAR *ret, DWORD len )
1153 const TT_TABLE_DIRECTORY *tblDir;
1154 TT_OFFSET_TABLE ttOffsetTable;
1155 TT_NAME_TABLE_HEADER ttNTHeader;
1156 TT_NAME_RECORD ttRecord;
1157 DWORD ofs, pos;
1158 int i;
1160 if (sizeof(TT_OFFSET_TABLE) > size)
1161 return NULL;
1162 ttOffsetTable = *(TT_OFFSET_TABLE*)mem;
1163 ttOffsetTable.uNumOfTables = SWAPWORD(ttOffsetTable.uNumOfTables);
1164 ttOffsetTable.uMajorVersion = SWAPWORD(ttOffsetTable.uMajorVersion);
1165 ttOffsetTable.uMinorVersion = SWAPWORD(ttOffsetTable.uMinorVersion);
1167 if (ttOffsetTable.uMajorVersion != 1 || ttOffsetTable.uMinorVersion != 0)
1168 return NULL;
1170 pos = sizeof(ttOffsetTable);
1171 for (i = 0; i < ttOffsetTable.uNumOfTables; i++)
1173 tblDir = (const TT_TABLE_DIRECTORY*)&mem[pos];
1174 pos += sizeof(*tblDir);
1175 if (memcmp(tblDir->szTag,"name",4)==0)
1177 ofs = SWAPLONG(tblDir->uOffset);
1178 break;
1181 if (i >= ttOffsetTable.uNumOfTables)
1182 return NULL;
1184 pos = ofs + sizeof(ttNTHeader);
1185 if (pos > size)
1186 return NULL;
1187 ttNTHeader = *(TT_NAME_TABLE_HEADER*)&mem[ofs];
1188 ttNTHeader.uNRCount = SWAPWORD(ttNTHeader.uNRCount);
1189 ttNTHeader.uStorageOffset = SWAPWORD(ttNTHeader.uStorageOffset);
1190 for(i=0; i<ttNTHeader.uNRCount; i++)
1192 ttRecord = *(TT_NAME_RECORD*)&mem[pos];
1193 pos += sizeof(ttRecord);
1194 if (pos > size)
1195 return NULL;
1197 ttRecord.uNameID = SWAPWORD(ttRecord.uNameID);
1198 if (ttRecord.uNameID == id)
1200 const char *buf;
1202 ttRecord.uStringLength = SWAPWORD(ttRecord.uStringLength);
1203 ttRecord.uStringOffset = SWAPWORD(ttRecord.uStringOffset);
1204 if (ofs + ttRecord.uStringOffset + ttNTHeader.uStorageOffset + ttRecord.uStringLength > size)
1205 return NULL;
1206 buf = mem + ofs + ttRecord.uStringOffset + ttNTHeader.uStorageOffset;
1207 len = MultiByteToWideChar(CP_ACP, 0, buf, ttRecord.uStringLength, ret, len-1);
1208 ret[len] = 0;
1209 return ret;
1212 return NULL;
1215 static INT CALLBACK add_font_proc(const LOGFONTW *lfw, const TEXTMETRICW *ntm, DWORD type, LPARAM lParam);
1217 /*****************************************************************************
1218 * GdipPrivateAddMemoryFont [GDIPLUS.@]
1220 GpStatus WINGDIPAPI GdipPrivateAddMemoryFont(GpFontCollection* fontCollection,
1221 GDIPCONST void* memory, INT length)
1223 WCHAR buf[32], *name;
1224 DWORD count = 0;
1225 HANDLE font;
1226 TRACE("%p, %p, %d\n", fontCollection, memory, length);
1228 if (!fontCollection || !memory || !length)
1229 return InvalidParameter;
1231 name = load_ttf_name_id(memory, length, NAME_ID_FULL_FONT_NAME, buf, sizeof(buf)/sizeof(*buf));
1232 if (!name)
1233 return OutOfMemory;
1235 font = AddFontMemResourceEx((void*)memory, length, NULL, &count);
1236 TRACE("%s: %p/%u\n", debugstr_w(name), font, count);
1237 if (!font || !count)
1238 return InvalidParameter;
1240 if (count)
1242 HDC hdc;
1243 LOGFONTW lfw;
1245 hdc = GetDC(0);
1247 lfw.lfCharSet = DEFAULT_CHARSET;
1248 lstrcpyW(lfw.lfFaceName, name);
1249 lfw.lfPitchAndFamily = 0;
1251 if (!EnumFontFamiliesExW(hdc, &lfw, add_font_proc, (LPARAM)fontCollection, 0))
1253 ReleaseDC(0, hdc);
1254 return OutOfMemory;
1257 ReleaseDC(0, hdc);
1259 return Ok;
1262 /*****************************************************************************
1263 * GdipGetFontCollectionFamilyCount [GDIPLUS.@]
1265 GpStatus WINGDIPAPI GdipGetFontCollectionFamilyCount(
1266 GpFontCollection* fontCollection, INT* numFound)
1268 TRACE("%p, %p\n", fontCollection, numFound);
1270 if (!(fontCollection && numFound))
1271 return InvalidParameter;
1273 *numFound = fontCollection->count;
1274 return Ok;
1277 /*****************************************************************************
1278 * GdipGetFontCollectionFamilyList [GDIPLUS.@]
1280 GpStatus WINGDIPAPI GdipGetFontCollectionFamilyList(
1281 GpFontCollection* fontCollection, INT numSought,
1282 GpFontFamily* gpfamilies[], INT* numFound)
1284 INT i;
1285 GpStatus stat=Ok;
1287 TRACE("%p, %d, %p, %p\n", fontCollection, numSought, gpfamilies, numFound);
1289 if (!(fontCollection && gpfamilies && numFound))
1290 return InvalidParameter;
1292 memset(gpfamilies, 0, sizeof(*gpfamilies) * numSought);
1294 for (i = 0; i < numSought && i < fontCollection->count && stat == Ok; i++)
1296 stat = GdipCloneFontFamily(fontCollection->FontFamilies[i], &gpfamilies[i]);
1299 if (stat == Ok)
1300 *numFound = i;
1301 else
1303 int numToFree=i;
1304 for (i=0; i<numToFree; i++)
1306 GdipDeleteFontFamily(gpfamilies[i]);
1307 gpfamilies[i] = NULL;
1311 return stat;
1314 void free_installed_fonts(void)
1316 while (installedFontCollection.count)
1317 GdipDeleteFontFamily(installedFontCollection.FontFamilies[--installedFontCollection.count]);
1318 HeapFree(GetProcessHeap(), 0, installedFontCollection.FontFamilies);
1319 installedFontCollection.FontFamilies = NULL;
1320 installedFontCollection.allocated = 0;
1323 static INT CALLBACK add_font_proc(const LOGFONTW *lfw, const TEXTMETRICW *ntm,
1324 DWORD type, LPARAM lParam)
1326 GpFontCollection* fonts = (GpFontCollection*)lParam;
1327 int i;
1329 if (type == RASTER_FONTTYPE)
1330 return 1;
1332 /* skip duplicates */
1333 for (i=0; i<fonts->count; i++)
1334 if (strcmpiW(lfw->lfFaceName, fonts->FontFamilies[i]->FamilyName) == 0)
1335 return 1;
1337 if (fonts->allocated == fonts->count)
1339 INT new_alloc_count = fonts->allocated+50;
1340 GpFontFamily** new_family_list = HeapAlloc(GetProcessHeap(), 0, new_alloc_count*sizeof(void*));
1342 if (!new_family_list)
1343 return 0;
1345 memcpy(new_family_list, fonts->FontFamilies, fonts->count*sizeof(void*));
1346 HeapFree(GetProcessHeap(), 0, fonts->FontFamilies);
1347 fonts->FontFamilies = new_family_list;
1348 fonts->allocated = new_alloc_count;
1351 if (GdipCreateFontFamilyFromName(lfw->lfFaceName, NULL, &fonts->FontFamilies[fonts->count]) == Ok)
1352 fonts->count++;
1353 else
1354 return 0;
1356 return 1;
1359 GpStatus WINGDIPAPI GdipNewInstalledFontCollection(
1360 GpFontCollection** fontCollection)
1362 TRACE("(%p)\n",fontCollection);
1364 if (!fontCollection)
1365 return InvalidParameter;
1367 if (installedFontCollection.count == 0)
1369 HDC hdc;
1370 LOGFONTW lfw;
1372 hdc = GetDC(0);
1374 lfw.lfCharSet = DEFAULT_CHARSET;
1375 lfw.lfFaceName[0] = 0;
1376 lfw.lfPitchAndFamily = 0;
1378 if (!EnumFontFamiliesExW(hdc, &lfw, add_font_proc, (LPARAM)&installedFontCollection, 0))
1380 free_installed_fonts();
1381 ReleaseDC(0, hdc);
1382 return OutOfMemory;
1385 ReleaseDC(0, hdc);
1388 *fontCollection = &installedFontCollection;
1390 return Ok;