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 static inline BOOL is_simulation_valid(DWRITE_FONT_SIMULATIONS simulations)
 115 {
 116     return (simulations & ~(DWRITE_FONT_SIMULATIONS_NONE | DWRITE_FONT_SIMULATIONS_BOLD |
 117         DWRITE_FONT_SIMULATIONS_OBLIQUE)) == 0;
 118 }
 119
 120 struct gdiinterop
 121 {
 122     IDWriteGdiInterop1 IDWriteGdiInterop1_iface;
 123     IDWriteFactory3 *factory;
 124 };
 125
 126 struct textlayout_desc
 127 {
 128     IDWriteFactory3 *factory;
 129     const WCHAR *string;
 130     UINT32 length;
 131     IDWriteTextFormat *format;
 132     FLOAT max_width;
 133     FLOAT max_height;
 134     BOOL is_gdi_compatible;
 135     /* fields below are only meaningful for gdi-compatible layout */
 136     FLOAT ppdip;
 137     const DWRITE_MATRIX *transform;
 138     BOOL use_gdi_natural;
 139 };
 140
 141 struct glyphrunanalysis_desc
 142 {
 143     const DWRITE_GLYPH_RUN *run;
 144     const DWRITE_MATRIX *transform;
 145     DWRITE_RENDERING_MODE rendering_mode;
 146     DWRITE_MEASURING_MODE measuring_mode;
 147     DWRITE_GRID_FIT_MODE gridfit_mode;
 148     DWRITE_TEXT_ANTIALIAS_MODE aa_mode;
 149     FLOAT origin_x;
 150     FLOAT origin_y;
 151     FLOAT ppdip;
 152 };
 153
 154 extern HRESULT convert_fontface_to_logfont(IDWriteFontFace*, LOGFONTW*) DECLSPEC_HIDDEN;
 155 extern HRESULT create_numbersubstitution(DWRITE_NUMBER_SUBSTITUTION_METHOD,const WCHAR *locale,BOOL,IDWriteNumberSubstitution**) DECLSPEC_HIDDEN;
 156 extern HRESULT create_textformat(const WCHAR*,IDWriteFontCollection*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 157                                  FLOAT,const WCHAR*,IDWriteTextFormat**) DECLSPEC_HIDDEN;
 158 extern HRESULT create_textlayout(const struct textlayout_desc*,IDWriteTextLayout**) DECLSPEC_HIDDEN;
 159 extern HRESULT create_trimmingsign(IDWriteFactory3*,IDWriteTextFormat*,IDWriteInlineObject**) DECLSPEC_HIDDEN;
 160 extern HRESULT create_typography(IDWriteTypography**) DECLSPEC_HIDDEN;
 161 extern void    gdiinterop_init(struct gdiinterop*,IDWriteFactory3*) DECLSPEC_HIDDEN;
 162 extern HRESULT create_localizedstrings(IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 163 extern HRESULT add_localizedstring(IDWriteLocalizedStrings*,const WCHAR*,const WCHAR*) DECLSPEC_HIDDEN;
 164 extern HRESULT clone_localizedstring(IDWriteLocalizedStrings *iface, IDWriteLocalizedStrings **strings) DECLSPEC_HIDDEN;
 165 extern void    set_en_localizedstring(IDWriteLocalizedStrings*,const WCHAR*) DECLSPEC_HIDDEN;
 166 extern HRESULT get_system_fontcollection(IDWriteFactory3*,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 167 extern HRESULT get_eudc_fontcollection(IDWriteFactory3*,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 168 extern HRESULT get_textanalyzer(IDWriteTextAnalyzer**) DECLSPEC_HIDDEN;
 169 extern HRESULT create_font_file(IDWriteFontFileLoader *loader, const void *reference_key, UINT32 key_size, IDWriteFontFile **font_file) DECLSPEC_HIDDEN;
 170 extern HRESULT create_localfontfileloader(IDWriteLocalFontFileLoader** iface) DECLSPEC_HIDDEN;
 171 extern HRESULT create_fontface(DWRITE_FONT_FACE_TYPE,UINT32,IDWriteFontFile* const*,UINT32,DWRITE_FONT_SIMULATIONS,IDWriteFontFace3**) DECLSPEC_HIDDEN;
 172 extern HRESULT create_font_collection(IDWriteFactory3*,IDWriteFontFileEnumerator*,BOOL,IDWriteFontCollection**) DECLSPEC_HIDDEN;
 173 extern HRESULT create_glyphrunanalysis(const struct glyphrunanalysis_desc*,IDWriteGlyphRunAnalysis**) DECLSPEC_HIDDEN;
 174 extern BOOL    is_system_collection(IDWriteFontCollection*) DECLSPEC_HIDDEN;
 175 extern HRESULT get_local_refkey(const WCHAR*,const FILETIME*,void**,UINT32*) DECLSPEC_HIDDEN;
 176 extern HRESULT get_filestream_from_file(IDWriteFontFile*,IDWriteFontFileStream**) DECLSPEC_HIDDEN;
 177 extern BOOL    is_face_type_supported(DWRITE_FONT_FACE_TYPE) DECLSPEC_HIDDEN;
 178 extern HRESULT get_family_names_from_stream(IDWriteFontFileStream*,UINT32,DWRITE_FONT_FACE_TYPE,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 179 extern HRESULT create_colorglyphenum(FLOAT,FLOAT,const DWRITE_GLYPH_RUN*,const DWRITE_GLYPH_RUN_DESCRIPTION*,DWRITE_MEASURING_MODE,
 180     const DWRITE_MATRIX*,UINT32,IDWriteColorGlyphRunEnumerator**) DECLSPEC_HIDDEN;
 181 extern BOOL lb_is_newline_char(WCHAR) DECLSPEC_HIDDEN;
 182 extern HRESULT create_system_fontfallback(IDWriteFactory3*,IDWriteFontFallback**) DECLSPEC_HIDDEN;
 183 extern void    release_system_fontfallback(IDWriteFontFallback*) DECLSPEC_HIDDEN;
 184 extern HRESULT create_matching_font(IDWriteFontCollection*,const WCHAR*,DWRITE_FONT_WEIGHT,DWRITE_FONT_STYLE,DWRITE_FONT_STRETCH,
 185     IDWriteFont**) DECLSPEC_HIDDEN;
 186 extern HRESULT create_fontfacereference(IDWriteFactory3*,IDWriteFontFile*,UINT32,DWRITE_FONT_SIMULATIONS,
 187     IDWriteFontFaceReference**) DECLSPEC_HIDDEN;
 188
 189 /* Opentype font table functions */
 190 struct dwrite_font_props {
 191     DWRITE_FONT_STYLE style;
 192     DWRITE_FONT_STRETCH stretch;
 193     DWRITE_FONT_WEIGHT weight;
 194     DWRITE_PANOSE panose;
 195 };
 196
 197 struct file_stream_desc {
 198     IDWriteFontFileStream *stream;
 199     DWRITE_FONT_FACE_TYPE face_type;
 200     UINT32 face_index;
 201 };
 202
 203 extern HRESULT opentype_analyze_font(IDWriteFontFileStream*,UINT32*,DWRITE_FONT_FILE_TYPE*,DWRITE_FONT_FACE_TYPE*,BOOL*) DECLSPEC_HIDDEN;
 204 extern HRESULT opentype_get_font_table(struct file_stream_desc*,UINT32,const void**,void**,UINT32*,BOOL*) DECLSPEC_HIDDEN;
 205 extern HRESULT opentype_cmap_get_unicode_ranges(void*,UINT32,DWRITE_UNICODE_RANGE*,UINT32*) DECLSPEC_HIDDEN;
 206 extern void opentype_get_font_properties(struct file_stream_desc*,struct dwrite_font_props*) DECLSPEC_HIDDEN;
 207 extern void opentype_get_font_metrics(struct file_stream_desc*,DWRITE_FONT_METRICS1*,DWRITE_CARET_METRICS*) DECLSPEC_HIDDEN;
 208 extern HRESULT opentype_get_font_info_strings(const void*,DWRITE_INFORMATIONAL_STRING_ID,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 209 extern HRESULT opentype_get_font_familyname(struct file_stream_desc*,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 210 extern HRESULT opentype_get_font_facename(struct file_stream_desc*,IDWriteLocalizedStrings**) DECLSPEC_HIDDEN;
 211 extern HRESULT opentype_get_typographic_features(IDWriteFontFace*,UINT32,UINT32,UINT32,UINT32*,DWRITE_FONT_FEATURE_TAG*) DECLSPEC_HIDDEN;
 212 extern BOOL opentype_get_vdmx_size(const void*,INT,UINT16*,UINT16*) DECLSPEC_HIDDEN;
 213 extern UINT32 opentype_get_cpal_palettecount(const void*) DECLSPEC_HIDDEN;
 214 extern UINT32 opentype_get_cpal_paletteentrycount(const void*) DECLSPEC_HIDDEN;
 215 extern HRESULT opentype_get_cpal_entries(const void*,UINT32,UINT32,UINT32,DWRITE_COLOR_F*) DECLSPEC_HIDDEN;
 216 extern HRESULT opentype_get_font_signature(struct file_stream_desc*,FONTSIGNATURE*) DECLSPEC_HIDDEN;
 217
 218 struct dwrite_colorglyph {
 219     USHORT layer; /* [0, num_layers) index indicating current layer */
 220     /* base glyph record data, set once on initialization */
 221     USHORT first_layer;
 222     USHORT num_layers;
 223     /* current layer record data, updated every time glyph is switched to next layer */
 224     UINT16 glyph;
 225     UINT16 palette_index;
 226 };
 227
 228 extern HRESULT opentype_get_colr_glyph(const void*,UINT16,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 229 extern void opentype_colr_next_glyph(const void*,struct dwrite_colorglyph*) DECLSPEC_HIDDEN;
 230
 231 enum gasp_flags {
 232     GASP_GRIDFIT             = 0x0001,
 233     GASP_DOGRAY              = 0x0002,
 234     GASP_SYMMETRIC_GRIDFIT   = 0x0004,
 235     GASP_SYMMETRIC_SMOOTHING = 0x0008,
 236 };
 237
 238 extern WORD opentype_get_gasp_flags(const WORD*,UINT32,INT) DECLSPEC_HIDDEN;
 239
 240 /* BiDi helpers */
 241 extern HRESULT bidi_computelevels(const WCHAR*,UINT32,UINT8,UINT8*,UINT8*) DECLSPEC_HIDDEN;
 242 extern WCHAR bidi_get_mirrored_char(WCHAR) DECLSPEC_HIDDEN;
 243
 244 /* FreeType integration */
 245 struct dwrite_glyphbitmap {
 246     IDWriteFontFace3 *fontface;
 247     FLOAT emsize;
 248     BOOL nohint;
 249     UINT16 index;
 250     INT pitch;
 251     RECT bbox;
 252     BYTE *buf;
 253     DWRITE_TEXTURE_TYPE type;
 254     DWRITE_MATRIX *m;
 255 };
 256
 257 extern BOOL init_freetype(void) DECLSPEC_HIDDEN;
 258 extern void release_freetype(void) DECLSPEC_HIDDEN;
 259 extern HRESULT freetype_get_design_glyph_metrics(IDWriteFontFace3*,UINT16,UINT16,DWRITE_GLYPH_METRICS*) DECLSPEC_HIDDEN;
 260 extern void freetype_notify_cacheremove(IDWriteFontFace3*) DECLSPEC_HIDDEN;
 261 extern BOOL freetype_is_monospaced(IDWriteFontFace3*) DECLSPEC_HIDDEN;
 262 extern HRESULT freetype_get_glyphrun_outline(IDWriteFontFace3*,FLOAT,UINT16 const*,FLOAT const*, DWRITE_GLYPH_OFFSET const*,
 263     UINT32,BOOL,IDWriteGeometrySink*) DECLSPEC_HIDDEN;
 264 extern UINT16 freetype_get_glyphcount(IDWriteFontFace3*) DECLSPEC_HIDDEN;
 265 extern void freetype_get_glyphs(IDWriteFontFace3*,INT,UINT32 const*,UINT32,UINT16*) DECLSPEC_HIDDEN;
 266 extern BOOL freetype_has_kerning_pairs(IDWriteFontFace3*) DECLSPEC_HIDDEN;
 267 extern INT32 freetype_get_kerning_pair_adjustment(IDWriteFontFace3*,UINT16,UINT16) DECLSPEC_HIDDEN;
 268 extern void freetype_get_glyph_bbox(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 269 extern BOOL freetype_get_glyph_bitmap(struct dwrite_glyphbitmap*) DECLSPEC_HIDDEN;
 270 extern INT freetype_get_charmap_index(IDWriteFontFace3*,BOOL*) DECLSPEC_HIDDEN;
 271 extern INT32 freetype_get_glyph_advance(IDWriteFontFace3*,FLOAT,UINT16,DWRITE_MEASURING_MODE) DECLSPEC_HIDDEN;
 272
 273 /* Glyph shaping */
 274 enum SCRIPT_JUSTIFY
 275 {
 276     SCRIPT_JUSTIFY_NONE,
 277     SCRIPT_JUSTIFY_ARABIC_BLANK,
 278     SCRIPT_JUSTIFY_CHARACTER,
 279     SCRIPT_JUSTIFY_RESERVED1,
 280     SCRIPT_JUSTIFY_BLANK,
 281     SCRIPT_JUSTIFY_RESERVED2,
 282     SCRIPT_JUSTIFY_RESERVED3,
 283     SCRIPT_JUSTIFY_ARABIC_NORMAL,
 284     SCRIPT_JUSTIFY_ARABIC_KASHIDA,
 285     SCRIPT_JUSTIFY_ARABIC_ALEF,
 286     SCRIPT_JUSTIFY_ARABIC_HA,
 287     SCRIPT_JUSTIFY_ARABIC_RA,
 288     SCRIPT_JUSTIFY_ARABIC_BA,
 289     SCRIPT_JUSTIFY_ARABIC_BARA,
 290     SCRIPT_JUSTIFY_ARABIC_SEEN,
 291     SCRIPT_JUSTIFY_ARABIC_SEEN_M
 292 };
 293
 294 struct scriptshaping_cache;
 295
 296 struct scriptshaping_context
 297 {
 298     struct scriptshaping_cache *cache;
 299     UINT32 language_tag;
 300
 301     const WCHAR *text;
 302     UINT32 length;
 303     BOOL is_rtl;
 304
 305     UINT32 max_glyph_count;
 306 };
 307
 308 extern HRESULT create_scriptshaping_cache(IDWriteFontFace*,struct scriptshaping_cache**) DECLSPEC_HIDDEN;
 309 extern void release_scriptshaping_cache(struct scriptshaping_cache*) DECLSPEC_HIDDEN;
 310
 311 struct scriptshaping_ops
 312 {
 313     HRESULT (*contextual_shaping)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices, UINT32* actual_glyph_count);
 314     HRESULT (*set_text_glyphs_props)(struct scriptshaping_context *context, UINT16 *clustermap, UINT16 *glyph_indices,
 315                                      UINT32 glyphcount, DWRITE_SHAPING_TEXT_PROPERTIES *text_props, DWRITE_SHAPING_GLYPH_PROPERTIES *glyph_props);
 316 };
 317
 318 extern const struct scriptshaping_ops default_shaping_ops DECLSPEC_HIDDEN;
 319 extern const struct scriptshaping_ops latn_shaping_ops DECLSPEC_HIDDEN;