dlls/dwrite/dwrite_private.h

   1 /*
   2  * Copyright 2012 Nikolay Sivov for CodeWeavers
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 #include "dwrite_3.h"
  20 #include "d2d1.h"
  21
  22 #include "wine/debug.h"
  23 #include "wine/unicode.h"
  24
  25 static const DWRITE_MATRIX identity =
  26 {
  27     1.0f, 0.0f,
  28     0.0f, 1.0f,
  29     0.0f, 0.0f
  30 };
  31
  32 static inline void *heap_alloc(size_t len)
  33 {
  34     return HeapAlloc(GetProcessHeap(), 0, len);
  35 }
  36
  37 static inline void *heap_alloc_zero(size_t len)
  38 {
  39     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, len);
  40 }
  41
  42 static inline void *heap_realloc(void *mem, size_t len)
  43 {
  44     return HeapReAlloc(GetProcessHeap(), 0, mem, len);
  45 }
  46
  47 static inline void *heap_realloc_zero(void *mem, size_t len)
  48 {
  49     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, len);
  50 }
  51
  52 static inline BOOL heap_free(void *mem)
  53 {
  54     return HeapFree(GetProcessHeap(), 0, mem);
  55 }
  56
  57 static inline LPWSTR heap_strdupW(const WCHAR *str)
  58 {
  59     LPWSTR ret = NULL;
  60
  61     if(str) {
  62         DWORD size;
  63
  64         size = (strlenW(str)+1)*sizeof(WCHAR);
  65         ret = heap_alloc(size);
  66         if(ret)
  67             memcpy(ret, str, size);
  68     }
  69
  70     return ret;
  71 }
  72
  73 static inline LPWSTR heap_strdupnW(const WCHAR *str, UINT32 len)
  74 {
  75     WCHAR *ret = NULL;
  76
  77     if (len)
  78     {
  79         ret = heap_alloc((len+1)*sizeof(WCHAR));
  80         if(ret)
  81         {
  82             memcpy(ret, str, len*sizeof(WCHAR));
  83             ret[len] = 0;
  84         }
  85     }
  86
  87     return ret;
  88 }
  89
  90 static inline const char *debugstr_range(const DWRITE_TEXT_RANGE *range)
  91 {
  92     return wine_dbg_sprintf("%u:%u", range->startPosition, range->length);
  93 }
  94
  95 static inline const char *debugstr_matrix(const DWRITE_MATRIX *m)
  96 {
  97     if (!m) return "(null)";
  98     return wine_dbg_sprintf("{%.2f,%.2f,%.2f,%.2f,%.2f,%.2f}", m->m11, m->m12, m->m21, m->m22,
  99         m->dx, m->dy);
 100 }
 101
 102 const char *debugstr_sa_script(UINT16) DECLSPEC_HIDDEN;
 103
 104 static inline unsigned short get_table_entry(const unsigned short *table, WCHAR ch)
 105 {
 106     return table[table[table[ch >> 8] + ((ch >> 4) & 0x0f)] + (ch & 0xf)];
 107 }
 108
 109 static inline FLOAT get_scaled_advance_width(INT32 advance, FLOAT emSize, const DWRITE_FONT_METRICS *metrics)
 110 {
 111     return (FLOAT)advance * emSize / (FLOAT)metrics->designUnitsPerEm;
 112 }
 113
 114 extern HRESULT convert_fontface_to_logfont(IDWriteFontFace*, LOGFONTW*) DECLSPEC_HIDDEN;
 115 extern HRESULT create_numbersubstitution(DWRITE_NUMBER_SUBSTITUTION_METHOD,const WCHAR *locale,BOOL,IDWriteNumberSubstitution**) DECLSPEC_HIDDEN;
 116 extern HRESULT create_textformat(const WCHAR*,IDWriteFontCollection*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 117                                  FLOAT,const WCHAR*,IDWriteTextFormat**) DECLSPEC_HIDDEN;
 118 extern HRESULT create_textlayout(IDWriteFactory2*,const WCHAR*,UINT32,IDWriteTextFormat*,FLOAT,FLOAT,IDWriteTextLayout**) DECLSPEC_HIDDEN;
 119 extern HRESULT create_gdicompat_textlayout(IDWriteFactory2*,const WCHAR*,UINT32,IDWriteTextFormat*,FLOAT,FLOAT,FLOAT,
 120     const DWRITE_MATRIX*,BOOL,IDWriteTextLayout**) DECLSPEC_HIDDEN;
 121 extern HRESULT create_trimmingsign(IDWriteFactory2*,IDWriteTextFormat*,IDWriteInlineObject**) DECLSPEC_HIDDEN;
 122 extern HRESULT create_typography(IDWriteTypography**) DECLSPEC_HIDDEN;
 123 extern HRESULT create_gdiinterop(IDWriteFactory2*,IDWriteGdiInterop**) DECLSPEC_HIDDEN;
 124 extern void    release_gdiinterop(IDWriteGdiInterop*) DECLSPEC_HIDDEN;
 125 extern HRESULT create_localizedstrings(IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 126 extern HRESULT add_localizedstring(IDWriteLocalizedStrings*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
 127 extern HRESULT clone_localizedstring(IDWriteLocalizedStrings *iface, IDWriteLocalizedStrings **strings) DECLSPEC_HIDDEN;
 128 extern void    set_en_localizedstring(IDWriteLocalizedStrings*,const WCHAR*) DECLSPEC_HIDDEN;
 129 extern HRESULT get_system_fontcollection(IDWriteFactory2*,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 130 extern HRESULT get_eudc_fontcollection(IDWriteFactory2*,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 131 extern HRESULT get_textanalyzer(IDWriteTextAnalyzer**) DECLSPEC_HIDDEN;
 132 extern HRESULT create_font_file(IDWriteFontFileLoader *loader, const void *reference_key, UINT32 key_size, IDWriteFontFile **font_file) DECLSPEC_HIDDEN;
 133 extern HRESULT create_localfontfileloader(IDWriteLocalFontFileLoader** iface) DECLSPEC_HIDDEN;
 134 extern HRESULT create_fontface(DWRITE_FONT_FACE_TYPE,UINT32,IDWriteFontFile* const*,UINT32,DWRITE_FONT_SIMULATIONS,IDWriteFontFace2**) DECLSPEC_HIDDEN;
 135 extern HRESULT create_font_collection(IDWriteFactory2*,IDWriteFontFileEnumerator*,BOOL,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 136 extern HRESULT create_glyphrunanalysis(DWRITE_RENDERING_MODE,DWRITE_MEASURING_MODE,DWRITE_GLYPH_RUN const*,FLOAT,const DWRITE_MATRIX*,
 137     DWRITE_GRID_FIT_MODE,DWRITE_TEXT_ANTIALIAS_MODE,FLOAT,FLOAT,IDWriteGlyphRunAnalysis**) DECLSPEC_HIDDEN;
 138 extern BOOL    is_system_collection(IDWriteFontCollection*) DECLSPEC_HIDDEN;
 139 extern HRESULT get_local_refkey(const WCHAR*,const FILETIME*,void**,UINT32*) DECLSPEC_HIDDEN;
 140 extern HRESULT get_filestream_from_file(IDWriteFontFile*,IDWriteFontFileStream**) DECLSPEC_HIDDEN;
 141 extern BOOL    is_face_type_supported(DWRITE_FONT_FACE_TYPE) DECLSPEC_HIDDEN;
 142 extern HRESULT get_family_names_from_stream(IDWriteFontFileStream*,UINT32,DWRITE_FONT_FACE_TYPE,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 143 extern HRESULT create_colorglyphenum(FLOAT,FLOAT,const DWRITE_GLYPH_RUN*,const DWRITE_GLYPH_RUN_DESCRIPTION*,DWRITE_MEASURING_MODE,
 144     const DWRITE_MATRIX*,UINT32,IDWriteColorGlyphRunEnumerator**) DECLSPEC_HIDDEN;
 145 extern BOOL lb_is_newline_char(WCHAR) DECLSPEC_HIDDEN;
 146 extern HRESULT create_system_fontfallback(IDWriteFactory2*,IDWriteFontFallback**) DECLSPEC_HIDDEN;
 147 extern void    release_system_fontfallback(IDWriteFontFallback*) DECLSPEC_HIDDEN;
 148 extern HRESULT create_matching_font(IDWriteFontCollection*,const WCHAR*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 149     IDWriteFont**) DECLSPEC_HIDDEN;
 150
 151 /* Opentype font table functions */
 152 struct dwrite_font_props {
 153     DWRITE_FONT_STYLE style;
 154     DWRITE_FONT_STRETCH stretch;
 155     DWRITE_FONT_WEIGHT weight;
 156     DWRITE_PANOSE panose;
 157 };
 158
 159 extern HRESULT opentype_analyze_font(IDWriteFontFileStream*,UINT32*,DWRITE_FONT_FILE_TYPE*,DWRITE_FONT_FACE_TYPE*,BOOL*) DECLSPEC_HIDDEN;
 160 extern HRESULT opentype_get_font_table(IDWriteFontFileStream*,DWRITE_FONT_FACE_TYPE,UINT32,UINT32,const void**,void**,UINT32*,BOOL*) DECLSPEC_HIDDEN;
 161 extern HRESULT opentype_cmap_get_unicode_ranges(void*,UINT32,DWRITE_UNICODE_RANGE*,UINT32*) DECLSPEC_HIDDEN;
 162 extern void opentype_get_font_properties(IDWriteFontFileStream*,DWRITE_FONT_FACE_TYPE,UINT32,struct dwrite_font_props*) DECLSPEC_HIDDEN;
 163 extern void opentype_get_font_metrics(IDWriteFontFileStream*,DWRITE_FONT_FACE_TYPE,UINT32,DWRITE_FONT_METRICS1*,DWRITE_CARET_METRICS*) DECLSPEC_HIDDEN;
 164 extern HRESULT opentype_get_font_info_strings(const void*,DWRITE_INFORMATIONAL_STRING_ID,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 165 extern HRESULT opentype_get_font_familyname(IDWriteFontFileStream*,DWRITE_FONT_FACE_TYPE,UINT32,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 166 extern HRESULT opentype_get_font_facename(IDWriteFontFileStream*,DWRITE_FONT_FACE_TYPE,UINT32,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 167 extern HRESULT opentype_get_typographic_features(IDWriteFontFace*,UINT32,UINT32,UINT32,UINT32*,DWRITE_FONT_FEATURE_TAG*) DECLSPEC_HIDDEN;
 168 extern BOOL opentype_get_vdmx_size(const void*,INT,UINT16*,UINT16*) DECLSPEC_HIDDEN;
 169 extern UINT32 opentype_get_cpal_palettecount(const void*) DECLSPEC_HIDDEN;
 170 extern UINT32 opentype_get_cpal_paletteentrycount(const void*) DECLSPEC_HIDDEN;
 171 extern HRESULT opentype_get_cpal_entries(const void*,UINT32,UINT32,UINT32,DWRITE_COLOR_F*) DECLSPEC_HIDDEN;
 172
 173 struct dwrite_colorglyph {
 174     USHORT layer; /* [0, num_layers) index indicating current layer */
 175     /* base glyph record data, set once on initialization */
 176     USHORT first_layer;
 177     USHORT num_layers;
 178     /* current layer record data, updated every time glyph is switched to next layer */
 179     UINT16 glyph;
 180     UINT16 palette_index;
 181 };
 182
 183 extern HRESULT opentype_get_colr_glyph(const void*,UINT16,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 184 extern void opentype_colr_next_glyph(const void*,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 185
 186 enum gasp_flags {
 187     GASP_GRIDFIT             = 0x0001,
 188     GASP_DOGRAY              = 0x0002,
 189     GASP_SYMMETRIC_GRIDFIT   = 0x0004,
 190     GASP_SYMMETRIC_SMOOTHING = 0x0008,
 191 };
 192
 193 extern WORD opentype_get_gasp_flags(const WORD*,UINT32,INT) DECLSPEC_HIDDEN;
 194
 195 /* BiDi helpers */
 196 extern HRESULT bidi_computelevels(const WCHAR*,UINT32,UINT8,UINT8*,UINT8*) DECLSPEC_HIDDEN;
 197 extern WCHAR bidi_get_mirrored_char(WCHAR) DECLSPEC_HIDDEN;
 198
 199 /* FreeType integration */
 200 struct dwrite_glyphbitmap {
 201     IDWriteFontFace2 *fontface;
 202     FLOAT emsize;
 203     BOOL nohint;
 204     UINT16 index;
 205     INT pitch;
 206     RECT bbox;
 207     BYTE *buf;
 208     DWRITE_TEXTURE_TYPE type;
 209     DWRITE_MATRIX *m;
 210 };
 211
 212 extern BOOL init_freetype(void) DECLSPEC_HIDDEN;
 213 extern void release_freetype(void) DECLSPEC_HIDDEN;
 214 extern HRESULT freetype_get_design_glyph_metrics(IDWriteFontFace2*,UINT16,UINT16,DWRITE_GLYPH_METRICS*) DECLSPEC_HIDDEN;
 215 extern void freetype_notify_cacheremove(IDWriteFontFace2*) DECLSPEC_HIDDEN;
 216 extern BOOL freetype_is_monospaced(IDWriteFontFace2*) DECLSPEC_HIDDEN;
 217 extern HRESULT freetype_get_glyphrun_outline(IDWriteFontFace2*,FLOAT,UINT16 const*,FLOAT const*, DWRITE_GLYPH_OFFSET const*,
 218     UINT32,BOOL,IDWriteGeometrySink*) DECLSPEC_HIDDEN;
 219 extern UINT16 freetype_get_glyphcount(IDWriteFontFace2*) DECLSPEC_HIDDEN;
 220 extern void freetype_get_glyphs(IDWriteFontFace2*,INT,UINT32 const*,UINT32,UINT16*) DECLSPEC_HIDDEN;
 221 extern BOOL freetype_has_kerning_pairs(IDWriteFontFace2*) DECLSPEC_HIDDEN;
 222 extern INT32 freetype_get_kerning_pair_adjustment(IDWriteFontFace2*,UINT16,UINT16) DECLSPEC_HIDDEN;
 223 extern void freetype_get_glyph_bbox(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 224 extern BOOL freetype_get_glyph_bitmap(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 225 extern INT freetype_get_charmap_index(IDWriteFontFace2*,BOOL*) DECLSPEC_HIDDEN;
 226 extern INT32 freetype_get_glyph_advance(IDWriteFontFace2*,FLOAT,UINT16,DWRITE_MEASURING_MODE) DECLSPEC_HIDDEN;
 227
 228 /* Glyph shaping */
 229 enum SCRIPT_JUSTIFY
 230 {
 231     SCRIPT_JUSTIFY_NONE,
 232     SCRIPT_JUSTIFY_ARABIC_BLANK,
 233     SCRIPT_JUSTIFY_CHARACTER,
 234     SCRIPT_JUSTIFY_RESERVED1,
 235     SCRIPT_JUSTIFY_BLANK,
 236     SCRIPT_JUSTIFY_RESERVED2,
 237     SCRIPT_JUSTIFY_RESERVED3,
 238     SCRIPT_JUSTIFY_ARABIC_NORMAL,
 239     SCRIPT_JUSTIFY_ARABIC_KASHIDA,
 240     SCRIPT_JUSTIFY_ARABIC_ALEF,
 241     SCRIPT_JUSTIFY_ARABIC_HA,
 242     SCRIPT_JUSTIFY_ARABIC_RA,
 243     SCRIPT_JUSTIFY_ARABIC_BA,
 244     SCRIPT_JUSTIFY_ARABIC_BARA,
 245     SCRIPT_JUSTIFY_ARABIC_SEEN,
 246     SCRIPT_JUSTIFY_ARABIC_SEEN_M
 247 };
 248
 249 struct scriptshaping_cache;
 250
 251 struct scriptshaping_context
 252 {
 253     struct scriptshaping_cache *cache;
 254     UINT32 language_tag;
 255
 256     const WCHAR *text;
 257     UINT32 length;
 258     BOOL is_rtl;
 259
 260     UINT32 max_glyph_count;
 261 };
 262
 263 extern HRESULT create_scriptshaping_cache(IDWriteFontFace*,struct scriptshaping_cache**) DECLSPEC_HIDDEN;
 264 extern void release_scriptshaping_cache(struct scriptshaping_cache*) DECLSPEC_HIDDEN;
 265
 266 struct scriptshaping_ops
 267 {
 268     HRESULT (*contextual_shaping)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices, UINT32* actual_glyph_count);
 269     HRESULT (*set_text_glyphs_props)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices,
 270                                      UINT32 glyphcount, DWRITE_SHAPING_TEXT_PROPERTIES *text_props, DWRITE_SHAPING_GLYPH_PROPERTIES *glyph_props);
 271 };
 272
 273 extern const struct scriptshaping_ops default_shaping_ops DECLSPEC_HIDDEN;
 274 extern const struct scriptshaping_ops latn_shaping_ops DECLSPEC_HIDDEN;