gdiplus: Stub GdipPrivateAddFontFile.
[wine.git] / dlls / gdiplus / font.c
blob1f7b187aa8e220b88db0473ca177bd478ff3140e
1 /*
2 * Copyright (C) 2007 Google (Evan Stade)
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 #include <stdarg.h>
21 #include "windef.h"
22 #include "winbase.h"
23 #include "wingdi.h"
24 #include "winnls.h"
25 #include "winreg.h"
26 #include "wine/debug.h"
27 #include "wine/unicode.h"
29 WINE_DEFAULT_DEBUG_CHANNEL (gdiplus);
31 #include "objbase.h"
33 #include "gdiplus.h"
34 #include "gdiplus_private.h"
36 static const REAL mm_per_inch = 25.4;
37 static const REAL inch_per_point = 1.0/72.0;
39 static inline REAL get_dpi (void)
41 REAL dpi;
42 GpGraphics *graphics;
43 HDC hdc = GetDC(0);
44 GdipCreateFromHDC (hdc, &graphics);
45 GdipGetDpiX(graphics, &dpi);
46 GdipDeleteGraphics(graphics);
47 ReleaseDC (0, hdc);
49 return dpi;
52 static inline REAL point_to_pixel (REAL point)
54 return point * get_dpi() * inch_per_point;
57 static inline REAL inch_to_pixel (REAL inch)
59 return inch * get_dpi();
62 static inline REAL document_to_pixel (REAL doc)
64 return doc * (get_dpi() / 300.0); /* Per MSDN */
67 static inline REAL mm_to_pixel (REAL mm)
69 return mm * (get_dpi() / mm_per_inch);
72 /*******************************************************************************
73 * GdipCreateFont [GDIPLUS.@]
75 * Create a new font based off of a FontFamily
77 * PARAMS
78 * *fontFamily [I] Family to base the font off of
79 * emSize [I] Size of the font
80 * style [I] Bitwise OR of FontStyle enumeration
81 * unit [I] Unit emSize is measured in
82 * **font [I] the resulting Font object
84 * RETURNS
85 * SUCCESS: Ok
86 * FAILURE: InvalidParameter if fontfamily or font is NULL.
87 * FAILURE: FontFamilyNotFound if an invalid FontFamily is given
89 * NOTES
90 * UnitDisplay is unsupported.
91 * emSize is stored separately from lfHeight, to hold the fraction.
93 GpStatus WINGDIPAPI GdipCreateFont(GDIPCONST GpFontFamily *fontFamily,
94 REAL emSize, INT style, Unit unit, GpFont **font)
96 WCHAR facename[LF_FACESIZE];
97 LOGFONTW* lfw;
98 const NEWTEXTMETRICW* tmw;
99 GpStatus stat;
101 if (!fontFamily || !font)
102 return InvalidParameter;
104 TRACE("%p (%s), %f, %d, %d, %p\n", fontFamily,
105 debugstr_w(fontFamily->FamilyName), emSize, style, unit, font);
107 stat = GdipGetFamilyName (fontFamily, facename, 0);
108 if (stat != Ok) return stat;
109 *font = GdipAlloc(sizeof(GpFont));
111 tmw = &fontFamily->tmw;
112 lfw = &((*font)->lfw);
113 ZeroMemory(&(*lfw), sizeof(*lfw));
115 lfw->lfWeight = tmw->tmWeight;
116 lfw->lfItalic = tmw->tmItalic;
117 lfw->lfUnderline = tmw->tmUnderlined;
118 lfw->lfStrikeOut = tmw->tmStruckOut;
119 lfw->lfCharSet = tmw->tmCharSet;
120 lfw->lfPitchAndFamily = tmw->tmPitchAndFamily;
121 lstrcpynW(lfw->lfFaceName, facename, LF_FACESIZE);
123 switch (unit)
125 case UnitWorld:
126 /* FIXME: Figure out when World != Pixel */
127 lfw->lfHeight = emSize; break;
128 case UnitDisplay:
129 FIXME("Unknown behavior for UnitDisplay! Please report!\n");
130 /* FIXME: Figure out how this works...
131 * MSDN says that if "DISPLAY" is a monitor, then pixel should be
132 * used. That's not what I got. Tests on Windows revealed no output,
133 * and the tests in tests/font crash windows */
134 lfw->lfHeight = 0; break;
135 case UnitPixel:
136 lfw->lfHeight = emSize; break;
137 case UnitPoint:
138 lfw->lfHeight = point_to_pixel(emSize); break;
139 case UnitInch:
140 lfw->lfHeight = inch_to_pixel(emSize); break;
141 case UnitDocument:
142 lfw->lfHeight = document_to_pixel(emSize); break;
143 case UnitMillimeter:
144 lfw->lfHeight = mm_to_pixel(emSize); break;
147 lfw->lfHeight *= -1;
149 lfw->lfWeight = style & FontStyleBold ? 700 : 400;
150 lfw->lfItalic = style & FontStyleItalic;
151 lfw->lfUnderline = style & FontStyleUnderline;
152 lfw->lfStrikeOut = style & FontStyleStrikeout;
154 (*font)->unit = unit;
155 (*font)->emSize = emSize;
157 return Ok;
160 GpStatus WINGDIPAPI GdipCreateFontFromLogfontW(HDC hdc,
161 GDIPCONST LOGFONTW *logfont, GpFont **font)
163 HFONT hfont, oldfont;
164 TEXTMETRICW textmet;
166 if(!logfont || !font)
167 return InvalidParameter;
169 *font = GdipAlloc(sizeof(GpFont));
170 if(!*font) return OutOfMemory;
172 memcpy((*font)->lfw.lfFaceName, logfont->lfFaceName, LF_FACESIZE *
173 sizeof(WCHAR));
174 (*font)->lfw.lfHeight = logfont->lfHeight;
175 (*font)->lfw.lfItalic = logfont->lfItalic;
176 (*font)->lfw.lfUnderline = logfont->lfUnderline;
177 (*font)->lfw.lfStrikeOut = logfont->lfStrikeOut;
179 (*font)->emSize = logfont->lfHeight;
180 (*font)->unit = UnitPixel;
182 hfont = CreateFontIndirectW(&(*font)->lfw);
183 oldfont = SelectObject(hdc, hfont);
184 GetTextMetricsW(hdc, &textmet);
186 (*font)->lfw.lfHeight = -textmet.tmHeight;
187 (*font)->lfw.lfWeight = textmet.tmWeight;
189 SelectObject(hdc, oldfont);
190 DeleteObject(hfont);
192 return Ok;
195 GpStatus WINGDIPAPI GdipCreateFontFromLogfontA(HDC hdc,
196 GDIPCONST LOGFONTA *lfa, GpFont **font)
198 LOGFONTW lfw;
200 if(!lfa || !font)
201 return InvalidParameter;
203 memcpy(&lfw, lfa, FIELD_OFFSET(LOGFONTA,lfFaceName) );
205 if(!MultiByteToWideChar(CP_ACP, 0, lfa->lfFaceName, -1, lfw.lfFaceName, LF_FACESIZE))
206 return GenericError;
208 GdipCreateFontFromLogfontW(hdc, &lfw, font);
210 return Ok;
213 GpStatus WINGDIPAPI GdipDeleteFont(GpFont* font)
215 if(!font)
216 return InvalidParameter;
218 GdipFree(font);
220 return Ok;
223 GpStatus WINGDIPAPI GdipCreateFontFromDC(HDC hdc, GpFont **font)
225 HFONT hfont;
226 LOGFONTW lfw;
228 if(!font)
229 return InvalidParameter;
231 hfont = (HFONT)GetCurrentObject(hdc, OBJ_FONT);
232 if(!hfont)
233 return GenericError;
235 if(!GetObjectW(hfont, sizeof(LOGFONTW), &lfw))
236 return GenericError;
238 return GdipCreateFontFromLogfontW(hdc, &lfw, font);
241 /******************************************************************************
242 * GdipGetFontSize [GDIPLUS.@]
244 * Returns the size of the font in Units
246 * PARAMS
247 * *font [I] The font to retrieve size from
248 * *size [O] Pointer to hold retrieved value
250 * RETURNS
251 * SUCCESS: Ok
252 * FAILURE: InvalidParamter (font or size was NULL)
254 * NOTES
255 * Size returned is actually emSize -- not internal size used for drawing.
257 GpStatus WINGDIPAPI GdipGetFontSize(GpFont *font, REAL *size)
259 if (!(font && size)) return InvalidParameter;
261 *size = font->emSize;
263 return Ok;
266 /*******************************************************************************
267 * GdipGetFontUnit [GDIPLUS.@]
269 * PARAMS
270 * font [I] Font to retrieve from
271 * unit [O] Return value
273 * RETURNS
274 * FAILURE: font or unit was NULL
275 * OK: otherwise
277 GpStatus WINGDIPAPI GdipGetFontUnit(GpFont *font, Unit *unit)
279 if (!(font && unit)) return InvalidParameter;
281 *unit = font->unit;
283 return Ok;
286 /* FIXME: use graphics */
287 GpStatus WINGDIPAPI GdipGetLogFontW(GpFont *font, GpGraphics *graphics,
288 LOGFONTW *lfw)
290 if(!font || !graphics || !lfw)
291 return InvalidParameter;
293 *lfw = font->lfw;
295 return Ok;
298 GpStatus WINGDIPAPI GdipCloneFont(GpFont *font, GpFont **cloneFont)
300 if(!font || !cloneFont)
301 return InvalidParameter;
303 *cloneFont = GdipAlloc(sizeof(GpFont));
304 if(!*cloneFont) return OutOfMemory;
306 **cloneFont = *font;
308 return Ok;
311 /*******************************************************************************
312 * GdipGetFontHeightGivenDPI [GDIPLUS.@]
313 * PARAMS
314 * font [I] Font to retrieve DPI from
315 * dpi [I] DPI to assume
316 * height [O] Return value
318 * RETURNS
319 * SUCCESS: Ok
320 * FAILURE: InvalidParameter if font or height is NULL
322 * NOTES
323 * According to MSDN, the result is (lineSpacing)*(fontSize / emHeight)*dpi
324 * (for anything other than unit Pixel)
326 GpStatus WINGDIPAPI GdipGetFontHeightGivenDPI(GDIPCONST GpFont *font, REAL dpi, REAL *height)
328 if (!(font && height)) return InvalidParameter;
330 FIXME("%p (%s), %f, %p\n", font,
331 debugstr_w(font->lfw.lfFaceName), dpi, height);
333 return NotImplemented;
336 /***********************************************************************
337 * Borrowed from GDI32:
339 * Elf is really an ENUMLOGFONTEXW, and ntm is a NEWTEXTMETRICEXW.
340 * We have to use other types because of the FONTENUMPROCW definition.
342 static INT CALLBACK is_font_installed_proc(const LOGFONTW *elf,
343 const TEXTMETRICW *ntm, DWORD type, LPARAM lParam)
345 if (!ntm)
347 return 1;
350 *(NEWTEXTMETRICW*)lParam = *(const NEWTEXTMETRICW*)ntm;
352 return 0;
355 static BOOL find_installed_font(const WCHAR *name, NEWTEXTMETRICW *ntm)
357 HDC hdc = GetDC(0);
358 BOOL ret = FALSE;
360 if(!EnumFontFamiliesW(hdc, name, is_font_installed_proc, (LPARAM)ntm))
361 ret = TRUE;
363 ReleaseDC(0, hdc);
364 return ret;
367 /*******************************************************************************
368 * GdipCreateFontFamilyFromName [GDIPLUS.@]
370 * Creates a font family object based on a supplied name
372 * PARAMS
373 * name [I] Name of the font
374 * fontCollection [I] What font collection (if any) the font belongs to (may be NULL)
375 * FontFamily [O] Pointer to the resulting FontFamily object
377 * RETURNS
378 * SUCCESS: Ok
379 * FAILURE: FamilyNotFound if the requested FontFamily does not exist on the system
380 * FAILURE: Invalid parameter if FontFamily or name is NULL
382 * NOTES
383 * If fontCollection is NULL then the object is not part of any collection
387 GpStatus WINGDIPAPI GdipCreateFontFamilyFromName(GDIPCONST WCHAR *name,
388 GpFontCollection *fontCollection,
389 GpFontFamily **FontFamily)
391 GpFontFamily* ffamily;
392 NEWTEXTMETRICW ntm;
394 TRACE("%s, %p %p\n", debugstr_w(name), fontCollection, FontFamily);
396 if (!(name && FontFamily))
397 return InvalidParameter;
398 if (fontCollection)
399 FIXME("No support for FontCollections yet!\n");
401 if (!find_installed_font(name, &ntm))
402 return FontFamilyNotFound;
404 ffamily = GdipAlloc(sizeof (GpFontFamily));
405 if (!ffamily) return OutOfMemory;
407 ffamily->tmw = ntm;
408 lstrcpynW(ffamily->FamilyName, name, LF_FACESIZE);
410 *FontFamily = ffamily;
412 return Ok;
415 /*******************************************************************************
416 * GdipCloneFontFamily [GDIPLUS.@]
418 * Creates a deep copy of a Font Family object
420 * PARAMS
421 * FontFamily [I] Font to clone
422 * clonedFontFamily [O] The resulting cloned font
424 * RETURNS
425 * SUCCESS: Ok
427 GpStatus WINGDIPAPI GdipCloneFontFamily(GpFontFamily* FontFamily, GpFontFamily** clonedFontFamily)
429 if (!(FontFamily && clonedFontFamily)) return InvalidParameter;
431 TRACE("stub: %p (%s), %p\n", FontFamily,
432 debugstr_w(FontFamily->FamilyName), clonedFontFamily);
434 *clonedFontFamily = GdipAlloc(sizeof(GpFontFamily));
435 if (!*clonedFontFamily) return OutOfMemory;
437 (*clonedFontFamily)->tmw = FontFamily->tmw;
438 lstrcpyW((*clonedFontFamily)->FamilyName, FontFamily->FamilyName);
440 return Ok;
443 /*******************************************************************************
444 * GdipGetFamilyName [GDIPLUS.@]
446 * Returns the family name into name
448 * PARAMS
449 * *family [I] Family to retrieve from
450 * *name [O] WCHARS of the family name
451 * LANGID [I] charset
453 * RETURNS
454 * SUCCESS: Ok
455 * FAILURE: InvalidParameter if family is NULL
457 * NOTES
458 * If name is a NULL ptr, then both XP and Vista will crash (so we do as well)
460 GpStatus WINGDIPAPI GdipGetFamilyName (GDIPCONST GpFontFamily *family,
461 WCHAR *name, LANGID language)
463 if (family == NULL)
464 return InvalidParameter;
466 TRACE("%p, %p, %d\n", family, name, language);
468 if (language != LANG_NEUTRAL)
469 FIXME("No support for handling of multiple languages!\n");
471 lstrcpynW (name, family->FamilyName, LF_FACESIZE);
473 return Ok;
477 /*****************************************************************************
478 * GdipDeleteFontFamily [GDIPLUS.@]
480 * Removes the specified FontFamily
482 * PARAMS
483 * *FontFamily [I] The family to delete
485 * RETURNS
486 * SUCCESS: Ok
487 * FAILURE: InvalidParameter if FontFamily is NULL.
490 GpStatus WINGDIPAPI GdipDeleteFontFamily(GpFontFamily *FontFamily)
492 if (!FontFamily)
493 return InvalidParameter;
494 TRACE("Deleting %p (%s)\n", FontFamily, debugstr_w(FontFamily->FamilyName));
496 GdipFree (FontFamily);
498 return Ok;
501 GpStatus WINGDIPAPI GdipGetCellAscent(GDIPCONST GpFontFamily *family,
502 INT style, UINT16* CellAscent)
504 if (!(family && CellAscent)) return InvalidParameter;
506 *CellAscent = family->tmw.tmAscent;
508 return Ok;
511 GpStatus WINGDIPAPI GdipGetCellDescent(GDIPCONST GpFontFamily *family,
512 INT style, UINT16* CellDescent)
514 if (!(family && CellDescent)) return InvalidParameter;
516 *CellDescent = family->tmw.tmDescent;
518 return Ok;
521 /*******************************************************************************
522 * GdipGetEmHeight [GDIPLUS.@]
524 * Gets the height of the specified family in EmHeights
526 * PARAMS
527 * family [I] Family to retrieve from
528 * style [I] (optional) style
529 * EmHeight [O] return value
531 * RETURNS
532 * SUCCESS: Ok
533 * FAILURE: InvalidParameter
535 GpStatus WINGDIPAPI GdipGetEmHeight(GDIPCONST GpFontFamily *family, INT style, UINT16* EmHeight)
537 if (!(family && EmHeight)) return InvalidParameter;
539 TRACE("%p (%s), %d, %p, stub!\n", family,
540 debugstr_w(family->FamilyName), style, EmHeight);
542 *EmHeight = family->tmw.ntmSizeEM;
544 return Ok;
548 /*******************************************************************************
549 * GdipGetLineSpacing [GDIPLUS.@]
551 * Returns the line spacing in design units
553 * PARAMS
554 * family [I] Family to retrieve from
555 * style [I] (Optional) font style
556 * LineSpacing [O] Return value
558 * RETURNS
559 * SUCCESS: Ok
560 * FAILURE: InvalidParameter (family or LineSpacing was NULL)
562 GpStatus WINGDIPAPI GdipGetLineSpacing(GDIPCONST GpFontFamily *family,
563 INT style, UINT16* LineSpacing)
565 if (!(family && LineSpacing)) return InvalidParameter;
567 FIXME("stub!\n");
569 return NotImplemented;
572 /*****************************************************************************
573 * GdipGetGenericFontFamilyMonospace [GDIPLUS.@]
575 * Obtains a serif family (Courier New on Windows)
577 * PARAMS
578 * **nativeFamily [I] Where the font will be stored
580 * RETURNS
581 * InvalidParameter if nativeFamily is NULL.
582 * Ok otherwise.
584 GpStatus WINGDIPAPI GdipGetGenericFontFamilyMonospace(GpFontFamily **nativeFamily)
586 static const WCHAR CourierNew[] = {'C','o','u','r','i','e','r',' ','N','e','w','\0'};
588 if (nativeFamily == NULL) return InvalidParameter;
590 return GdipCreateFontFamilyFromName(CourierNew, NULL, nativeFamily);
593 /*****************************************************************************
594 * GdipGetGenericFontFamilySerif [GDIPLUS.@]
596 * Obtains a serif family (Times New Roman on Windows)
598 * PARAMS
599 * **nativeFamily [I] Where the font will be stored
601 * RETURNS
602 * InvalidParameter if nativeFamily is NULL.
603 * Ok otherwise.
605 GpStatus WINGDIPAPI GdipGetGenericFontFamilySerif(GpFontFamily **nativeFamily)
607 static const WCHAR TimesNewRoman[] = {'T','i','m','e','s',' ','N','e','w',' ','R','o','m','a','n','\0'};
609 if (nativeFamily == NULL) return InvalidParameter;
611 return GdipCreateFontFamilyFromName(TimesNewRoman, NULL, nativeFamily);
614 /*****************************************************************************
615 * GdipGetGenericFontFamilySansSerif [GDIPLUS.@]
617 * Obtains a serif family (Microsoft Sans Serif on Windows)
619 * PARAMS
620 * **nativeFamily [I] Where the font will be stored
622 * RETURNS
623 * InvalidParameter if nativeFamily is NULL.
624 * Ok otherwise.
626 GpStatus WINGDIPAPI GdipGetGenericFontFamilySansSerif(GpFontFamily **nativeFamily)
628 /* FIXME: On Windows this is called Microsoft Sans Serif, this shouldn't
629 * affect anything */
630 static const WCHAR MSSansSerif[] = {'M','S',' ','S','a','n','s',' ','S','e','r','i','f','\0'};
632 if (nativeFamily == NULL) return InvalidParameter;
634 return GdipCreateFontFamilyFromName(MSSansSerif, NULL, nativeFamily);
637 GpStatus WINGDIPAPI GdipNewPrivateFontCollection(GpFontCollection** fontCollection)
639 FIXME("stub %p\n", fontCollection);
641 if (!fontCollection)
642 return InvalidParameter;
644 return NotImplemented;
647 GpStatus WINGDIPAPI GdipDeletePrivateFontCollection(GpFontCollection **fontCollection)
649 FIXME("stub %p\n", fontCollection);
651 if (!fontCollection)
652 return InvalidParameter;
654 return NotImplemented;
657 GpStatus WINGDIPAPI GdipPrivateAddFontFile(GpFontCollection* fontCollection,
658 GDIPCONST WCHAR* filename)
660 FIXME("stub: %p, %s\n", fontCollection, debugstr_w(filename));
662 if (!(fontCollection && filename))
663 return InvalidParameter;
665 return NotImplemented;