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/list.h"
  24 #include "wine/unicode.h"
  25
  26 static const DWRITE_MATRIX identity =
  27 {
  28     1.0f, 0.0f,
  29     0.0f, 1.0f,
  30     0.0f, 0.0f
  31 };
  32
  33 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc(size_t size)
  34 {
  35     return HeapAlloc(GetProcessHeap(), 0, size);
  36 }
  37
  38 static inline void* __WINE_ALLOC_SIZE(1) heap_alloc_zero(size_t size)
  39 {
  40     return HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, size);
  41 }
  42
  43 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc(void *mem, size_t size)
  44 {
  45     return HeapReAlloc(GetProcessHeap(), 0, mem, size);
  46 }
  47
  48 static inline void* __WINE_ALLOC_SIZE(2) heap_realloc_zero(void *mem, size_t size)
  49 {
  50     return HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, mem, size);
  51 }
  52
  53 static inline BOOL heap_free(void *mem)
  54 {
  55     return HeapFree(GetProcessHeap(), 0, mem);
  56 }
  57
  58 static inline LPWSTR heap_strdupW(const WCHAR *str)
  59 {
  60     LPWSTR ret = NULL;
  61
  62     if(str) {
  63         DWORD size;
  64
  65         size = (strlenW(str)+1)*sizeof(WCHAR);
  66         ret = heap_alloc(size);
  67         if(ret)
  68             memcpy(ret, str, size);
  69     }
  70
  71     return ret;
  72 }
  73
  74 static inline LPWSTR heap_strdupnW(const WCHAR *str, UINT32 len)
  75 {
  76     WCHAR *ret = NULL;
  77
  78     if (len)
  79     {
  80         ret = heap_alloc((len+1)*sizeof(WCHAR));
  81         if(ret)
  82         {
  83             memcpy(ret, str, len*sizeof(WCHAR));
  84             ret[len] = 0;
  85         }
  86     }
  87
  88     return ret;
  89 }
  90
  91 static inline const char *debugstr_range(const DWRITE_TEXT_RANGE *range)
  92 {
  93     return wine_dbg_sprintf("%u:%u", range->startPosition, range->length);
  94 }
  95
  96 static inline const char *debugstr_matrix(const DWRITE_MATRIX *m)
  97 {
  98     if (!m) return "(null)";
  99     return wine_dbg_sprintf("{%.2f,%.2f,%.2f,%.2f,%.2f,%.2f}", m->m11, m->m12, m->m21, m->m22,
 100         m->dx, m->dy);
 101 }
 102
 103 const char *debugstr_sa_script(UINT16) DECLSPEC_HIDDEN;
 104
 105 static inline unsigned short get_table_entry(const unsigned short *table, WCHAR ch)
 106 {
 107     return table[table[table[ch >> 8] + ((ch >> 4) & 0x0f)] + (ch & 0xf)];
 108 }
 109
 110 static inline FLOAT get_scaled_advance_width(INT32 advance, FLOAT emSize, const DWRITE_FONT_METRICS *metrics)
 111 {
 112     return (FLOAT)advance * emSize / (FLOAT)metrics->designUnitsPerEm;
 113 }
 114
 115 static inline BOOL is_simulation_valid(DWRITE_FONT_SIMULATIONS simulations)
 116 {
 117     return (simulations & ~(DWRITE_FONT_SIMULATIONS_NONE | DWRITE_FONT_SIMULATIONS_BOLD |
 118         DWRITE_FONT_SIMULATIONS_OBLIQUE)) == 0;
 119 }
 120
 121 struct textlayout_desc
 122 {
 123     IDWriteFactory5 *factory;
 124     const WCHAR *string;
 125     UINT32 length;
 126     IDWriteTextFormat *format;
 127     FLOAT max_width;
 128     FLOAT max_height;
 129     BOOL is_gdi_compatible;
 130     /* fields below are only meaningful for gdi-compatible layout */
 131     FLOAT ppdip;
 132     const DWRITE_MATRIX *transform;
 133     BOOL use_gdi_natural;
 134 };
 135
 136 struct glyphrunanalysis_desc
 137 {
 138     const DWRITE_GLYPH_RUN *run;
 139     const DWRITE_MATRIX *transform;
 140     DWRITE_RENDERING_MODE1 rendering_mode;
 141     DWRITE_MEASURING_MODE measuring_mode;
 142     DWRITE_GRID_FIT_MODE gridfit_mode;
 143     DWRITE_TEXT_ANTIALIAS_MODE aa_mode;
 144     FLOAT origin_x;
 145     FLOAT origin_y;
 146     FLOAT ppdip;
 147 };
 148
 149 struct fontface_desc
 150 {
 151     IDWriteFactory5 *factory;
 152     DWRITE_FONT_FACE_TYPE face_type;
 153     IDWriteFontFile * const *files;
 154     UINT32 files_number;
 155     UINT32 index;
 156     DWRITE_FONT_SIMULATIONS simulations;
 157     struct dwrite_font_data *font_data; /* could be NULL when face is created directly with IDWriteFactory::CreateFontFace() */
 158 };
 159
 160 struct fontfacecached
 161 {
 162     struct list entry;
 163     IDWriteFontFace4 *fontface;
 164 };
 165
 166 extern HRESULT create_numbersubstitution(DWRITE_NUMBER_SUBSTITUTION_METHOD,const WCHAR *locale,BOOL,IDWriteNumberSubstitution**) DECLSPEC_HIDDEN;
 167 extern HRESULT create_textformat(const WCHAR*,IDWriteFontCollection*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 168                                  FLOAT,const WCHAR*,IDWriteTextFormat**) DECLSPEC_HIDDEN;
 169 extern HRESULT create_textlayout(const struct textlayout_desc*,IDWriteTextLayout**) DECLSPEC_HIDDEN;
 170 extern HRESULT create_trimmingsign(IDWriteFactory5*,IDWriteTextFormat*,IDWriteInlineObject**) DECLSPEC_HIDDEN;
 171 extern HRESULT create_typography(IDWriteTypography**) DECLSPEC_HIDDEN;
 172 extern HRESULT create_localizedstrings(IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 173 extern HRESULT add_localizedstring(IDWriteLocalizedStrings*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
 174 extern HRESULT clone_localizedstring(IDWriteLocalizedStrings *iface, IDWriteLocalizedStrings **strings) DECLSPEC_HIDDEN;
 175 extern void    set_en_localizedstring(IDWriteLocalizedStrings*,const WCHAR*) DECLSPEC_HIDDEN;
 176 extern HRESULT get_system_fontcollection(IDWriteFactory5*,IDWriteFontCollection1**) DECLSPEC_HIDDEN;
 177 extern HRESULT get_eudc_fontcollection(IDWriteFactory5*,IDWriteFontCollection1**) DECLSPEC_HIDDEN;
 178 extern IDWriteTextAnalyzer *get_text_analyzer(void) DECLSPEC_HIDDEN;
 179 extern HRESULT create_font_file(IDWriteFontFileLoader *loader, const void *reference_key, UINT32 key_size, IDWriteFontFile **font_file) DECLSPEC_HIDDEN;
 180 extern void    init_local_fontfile_loader(void) DECLSPEC_HIDDEN;
 181 extern IDWriteFontFileLoader *get_local_fontfile_loader(void) DECLSPEC_HIDDEN;
 182 extern HRESULT create_fontface(const struct fontface_desc*,struct list*,IDWriteFontFace4**) DECLSPEC_HIDDEN;
 183 extern HRESULT create_font_collection(IDWriteFactory5*,IDWriteFontFileEnumerator*,BOOL,IDWriteFontCollection1**) DECLSPEC_HIDDEN;
 184 extern HRESULT create_glyphrunanalysis(const struct glyphrunanalysis_desc*,IDWriteGlyphRunAnalysis**) DECLSPEC_HIDDEN;
 185 extern BOOL    is_system_collection(IDWriteFontCollection*) DECLSPEC_HIDDEN;
 186 extern HRESULT get_local_refkey(const WCHAR*,const FILETIME*,void**,UINT32*) DECLSPEC_HIDDEN;
 187 extern HRESULT get_filestream_from_file(IDWriteFontFile*,IDWriteFontFileStream**) DECLSPEC_HIDDEN;
 188 extern BOOL    is_face_type_supported(DWRITE_FONT_FACE_TYPE) DECLSPEC_HIDDEN;
 189 extern HRESULT get_family_names_from_stream(IDWriteFontFileStream*,UINT32,DWRITE_FONT_FACE_TYPE,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 190 extern HRESULT create_colorglyphenum(FLOAT,FLOAT,const DWRITE_GLYPH_RUN*,const DWRITE_GLYPH_RUN_DESCRIPTION*,DWRITE_MEASURING_MODE,
 191     const DWRITE_MATRIX*,UINT32,IDWriteColorGlyphRunEnumerator**) DECLSPEC_HIDDEN;
 192 extern BOOL lb_is_newline_char(WCHAR) DECLSPEC_HIDDEN;
 193 extern HRESULT create_system_fontfallback(IDWriteFactory5*,IDWriteFontFallback**) DECLSPEC_HIDDEN;
 194 extern void    release_system_fontfallback(IDWriteFontFallback*) DECLSPEC_HIDDEN;
 195 extern HRESULT create_fontfallback_builder(IDWriteFactory5*,IDWriteFontFallbackBuilder**) DECLSPEC_HIDDEN;
 196 extern HRESULT create_matching_font(IDWriteFontCollection*,const WCHAR*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 197     IDWriteFont**) DECLSPEC_HIDDEN;
 198 extern HRESULT create_fontfacereference(IDWriteFactory5*,IDWriteFontFile*,UINT32,DWRITE_FONT_SIMULATIONS,
 199     IDWriteFontFaceReference**) DECLSPEC_HIDDEN;
 200 extern HRESULT factory_get_cached_fontface(IDWriteFactory5*,IDWriteFontFile*const*,UINT32,DWRITE_FONT_SIMULATIONS,
 201         struct list**,REFIID,void**) DECLSPEC_HIDDEN;
 202 extern void factory_detach_fontcollection(IDWriteFactory5*,IDWriteFontCollection1*) DECLSPEC_HIDDEN;
 203 extern void factory_detach_gdiinterop(IDWriteFactory5*,IDWriteGdiInterop1*) DECLSPEC_HIDDEN;
 204 extern struct fontfacecached *factory_cache_fontface(IDWriteFactory5*,struct list*,IDWriteFontFace4*) DECLSPEC_HIDDEN;
 205 extern void    get_logfont_from_font(IDWriteFont*,LOGFONTW*) DECLSPEC_HIDDEN;
 206 extern void    get_logfont_from_fontface(IDWriteFontFace*,LOGFONTW*) DECLSPEC_HIDDEN;
 207 extern HRESULT get_fontsig_from_font(IDWriteFont*,FONTSIGNATURE*) DECLSPEC_HIDDEN;
 208 extern HRESULT get_fontsig_from_fontface(IDWriteFontFace*,FONTSIGNATURE*) DECLSPEC_HIDDEN;
 209 extern HRESULT create_gdiinterop(IDWriteFactory5*,IDWriteGdiInterop1**) DECLSPEC_HIDDEN;
 210 extern void fontface_detach_from_cache(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 211 extern void factory_lock(IDWriteFactory5*) DECLSPEC_HIDDEN;
 212 extern void factory_unlock(IDWriteFactory5*) DECLSPEC_HIDDEN;
 213 extern HRESULT create_inmemory_fileloader(IDWriteFontFileLoader**) DECLSPEC_HIDDEN;
 214
 215 /* Opentype font table functions */
 216 struct dwrite_font_props {
 217     DWRITE_FONT_STYLE style;
 218     DWRITE_FONT_STRETCH stretch;
 219     DWRITE_FONT_WEIGHT weight;
 220     DWRITE_PANOSE panose;
 221     FONTSIGNATURE fontsig;
 222     LOGFONTW lf;
 223 };
 224
 225 struct file_stream_desc {
 226     IDWriteFontFileStream *stream;
 227     DWRITE_FONT_FACE_TYPE face_type;
 228     UINT32 face_index;
 229 };
 230
 231 extern HRESULT opentype_analyze_font(IDWriteFontFileStream*,UINT32*,DWRITE_FONT_FILE_TYPE*,DWRITE_FONT_FACE_TYPE*,BOOL*) DECLSPEC_HIDDEN;
 232 extern HRESULT opentype_get_font_table(struct file_stream_desc*,UINT32,const void**,void**,UINT32*,BOOL*) DECLSPEC_HIDDEN;
 233 extern HRESULT opentype_cmap_get_unicode_ranges(void*,UINT32,DWRITE_UNICODE_RANGE*,UINT32*) DECLSPEC_HIDDEN;
 234 extern void opentype_get_font_properties(struct file_stream_desc*,struct dwrite_font_props*) DECLSPEC_HIDDEN;
 235 extern void opentype_get_font_metrics(struct file_stream_desc*,DWRITE_FONT_METRICS1*,DWRITE_CARET_METRICS*) DECLSPEC_HIDDEN;
 236 extern HRESULT opentype_get_font_info_strings(const void*,DWRITE_INFORMATIONAL_STRING_ID,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 237 extern HRESULT opentype_get_font_familyname(struct file_stream_desc*,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 238 extern HRESULT opentype_get_font_facename(struct file_stream_desc*,WCHAR*,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 239 extern HRESULT opentype_get_typographic_features(IDWriteFontFace*,UINT32,UINT32,UINT32,UINT32*,DWRITE_FONT_FEATURE_TAG*) DECLSPEC_HIDDEN;
 240 extern BOOL opentype_get_vdmx_size(const void*,INT,UINT16*,UINT16*) DECLSPEC_HIDDEN;
 241 extern UINT32 opentype_get_cpal_palettecount(const void*) DECLSPEC_HIDDEN;
 242 extern UINT32 opentype_get_cpal_paletteentrycount(const void*) DECLSPEC_HIDDEN;
 243 extern HRESULT opentype_get_cpal_entries(const void*,UINT32,UINT32,UINT32,DWRITE_COLOR_F*) DECLSPEC_HIDDEN;
 244 extern BOOL opentype_has_vertical_variants(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 245 extern UINT32 opentype_get_glyph_image_formats(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 246
 247 struct dwrite_colorglyph {
 248     USHORT layer; /* [0, num_layers) index indicating current layer */
 249     /* base glyph record data, set once on initialization */
 250     USHORT first_layer;
 251     USHORT num_layers;
 252     /* current layer record data, updated every time glyph is switched to next layer */
 253     UINT16 glyph;
 254     UINT16 palette_index;
 255 };
 256
 257 extern HRESULT opentype_get_colr_glyph(const void*,UINT16,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 258 extern void opentype_colr_next_glyph(const void*,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 259
 260 enum gasp_flags {
 261     GASP_GRIDFIT             = 0x0001,
 262     GASP_DOGRAY              = 0x0002,
 263     GASP_SYMMETRIC_GRIDFIT   = 0x0004,
 264     GASP_SYMMETRIC_SMOOTHING = 0x0008,
 265 };
 266
 267 extern WORD opentype_get_gasp_flags(const WORD*,UINT32,INT) DECLSPEC_HIDDEN;
 268
 269 /* BiDi helpers */
 270 extern HRESULT bidi_computelevels(const WCHAR*,UINT32,UINT8,UINT8*,UINT8*) DECLSPEC_HIDDEN;
 271 extern WCHAR bidi_get_mirrored_char(WCHAR) DECLSPEC_HIDDEN;
 272
 273 /* FreeType integration */
 274 struct dwrite_glyphbitmap {
 275     IDWriteFontFace4 *fontface;
 276     DWORD simulations;
 277     FLOAT emsize;
 278     BOOL nohint;
 279     BOOL aliased;
 280     UINT16 index;
 281     INT pitch;
 282     RECT bbox;
 283     BYTE *buf;
 284     DWRITE_MATRIX *m;
 285 };
 286
 287 extern BOOL init_freetype(void) DECLSPEC_HIDDEN;
 288 extern void release_freetype(void) DECLSPEC_HIDDEN;
 289 extern HRESULT freetype_get_design_glyph_metrics(IDWriteFontFace4*,UINT16,UINT16,DWRITE_GLYPH_METRICS*) DECLSPEC_HIDDEN;
 290 extern void freetype_notify_cacheremove(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 291 extern BOOL freetype_is_monospaced(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 292 extern HRESULT freetype_get_glyphrun_outline(IDWriteFontFace4*,FLOAT,UINT16 const*,FLOAT const*, DWRITE_GLYPH_OFFSET const*,
 293     UINT32,BOOL,IDWriteGeometrySink*) DECLSPEC_HIDDEN;
 294 extern UINT16 freetype_get_glyphcount(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 295 extern void freetype_get_glyphs(IDWriteFontFace4*,INT,UINT32 const*,UINT32,UINT16*) DECLSPEC_HIDDEN;
 296 extern BOOL freetype_has_kerning_pairs(IDWriteFontFace4*) DECLSPEC_HIDDEN;
 297 extern INT32 freetype_get_kerning_pair_adjustment(IDWriteFontFace4*,UINT16,UINT16) DECLSPEC_HIDDEN;
 298 extern void freetype_get_glyph_bbox(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 299 extern BOOL freetype_get_glyph_bitmap(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 300 extern INT freetype_get_charmap_index(IDWriteFontFace4*,BOOL*) DECLSPEC_HIDDEN;
 301 extern INT32 freetype_get_glyph_advance(IDWriteFontFace4*,FLOAT,UINT16,DWRITE_MEASURING_MODE,BOOL*) DECLSPEC_HIDDEN;
 302 extern void freetype_get_design_glyph_bbox(IDWriteFontFace4*,UINT16,UINT16,RECT*) DECLSPEC_HIDDEN;
 303
 304 /* Glyph shaping */
 305 enum SCRIPT_JUSTIFY
 306 {
 307     SCRIPT_JUSTIFY_NONE,
 308     SCRIPT_JUSTIFY_ARABIC_BLANK,
 309     SCRIPT_JUSTIFY_CHARACTER,
 310     SCRIPT_JUSTIFY_RESERVED1,
 311     SCRIPT_JUSTIFY_BLANK,
 312     SCRIPT_JUSTIFY_RESERVED2,
 313     SCRIPT_JUSTIFY_RESERVED3,
 314     SCRIPT_JUSTIFY_ARABIC_NORMAL,
 315     SCRIPT_JUSTIFY_ARABIC_KASHIDA,
 316     SCRIPT_JUSTIFY_ARABIC_ALEF,
 317     SCRIPT_JUSTIFY_ARABIC_HA,
 318     SCRIPT_JUSTIFY_ARABIC_RA,
 319     SCRIPT_JUSTIFY_ARABIC_BA,
 320     SCRIPT_JUSTIFY_ARABIC_BARA,
 321     SCRIPT_JUSTIFY_ARABIC_SEEN,
 322     SCRIPT_JUSTIFY_ARABIC_SEEN_M
 323 };
 324
 325 struct scriptshaping_cache;
 326
 327 struct scriptshaping_context
 328 {
 329     struct scriptshaping_cache *cache;
 330     UINT32 language_tag;
 331
 332     const WCHAR *text;
 333     UINT32 length;
 334     BOOL is_rtl;
 335
 336     UINT32 max_glyph_count;
 337 };
 338
 339 extern HRESULT create_scriptshaping_cache(IDWriteFontFace*,struct scriptshaping_cache**) DECLSPEC_HIDDEN;
 340 extern void release_scriptshaping_cache(struct scriptshaping_cache*) DECLSPEC_HIDDEN;
 341
 342 struct scriptshaping_ops
 343 {
 344     HRESULT (*contextual_shaping)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices, UINT32* actual_glyph_count);
 345     HRESULT (*set_text_glyphs_props)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices,
 346                                      UINT32 glyphcount, DWRITE_SHAPING_TEXT_PROPERTIES *text_props, DWRITE_SHAPING_GLYPH_PROPERTIES *glyph_props);
 347 };
 348
 349 extern const struct scriptshaping_ops default_shaping_ops DECLSPEC_HIDDEN;
 350 extern const struct scriptshaping_ops latn_shaping_ops DECLSPEC_HIDDEN;