Spelling fixes.
[wine] / dlls / riched20 / style.c
1 /*
2  * RichEdit style management functions
3  *
4  * Copyright 2004 by Krzysztof Foltman
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "editor.h"
22
23 WINE_DEFAULT_DEBUG_CHANNEL(richedit);
24 WINE_DECLARE_DEBUG_CHANNEL(richedit_style);
25
26 static int all_refs = 0;
27
28 /* the following routines assume that:
29  * - char2[AW] extends char[AW] by adding fields at the end of the charA form)
30  * - szFaceName is the last field of char[AW] form, and wWeight the first of 2[AW]
31  * - the difference between A and W form is the szFaceName as Ansi vs Unicode string
32  * - because of alignment, offset of wWeight field in 2[AW] structure *IS NOT*
33  *   sizeof(char[AW])
34  */
35
36 CHARFORMAT2W *ME_ToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from)
37 {
38   if (from->cbSize == sizeof(CHARFORMATA))
39   {
40     CHARFORMATA *f = (CHARFORMATA *)from;
41     CopyMemory(to, f, FIELD_OFFSET(CHARFORMATA, szFaceName));
42     to->cbSize = sizeof(CHARFORMAT2W);
43     if (f->dwMask & CFM_FACE) {
44       MultiByteToWideChar(0, 0, f->szFaceName, -1, to->szFaceName, sizeof(to->szFaceName)/sizeof(WCHAR));
45     }
46     return to;
47   }
48   if (from->cbSize == sizeof(CHARFORMATW))
49   {
50     CHARFORMATW *f = (CHARFORMATW *)from;
51     CopyMemory(to, f, sizeof(*f));
52     /* theoretically, we don't need to zero the remaining memory */
53     ZeroMemory(&to->wWeight, sizeof(CHARFORMAT2W)-FIELD_OFFSET(CHARFORMAT2W, wWeight));
54     to->cbSize = sizeof(CHARFORMAT2W);
55     return to;
56   }
57   if (from->cbSize == sizeof(CHARFORMAT2A))
58   {
59     CHARFORMAT2A *f = (CHARFORMAT2A *)from;
60     /* copy the A structure without face name */
61     CopyMemory(to, f, FIELD_OFFSET(CHARFORMATA, szFaceName));
62     /* convert face name */
63     if (f->dwMask & CFM_FACE)
64       MultiByteToWideChar(0, 0, f->szFaceName, -1, to->szFaceName, sizeof(to->szFaceName)/sizeof(WCHAR));
65     /* copy the rest of the 2A structure to 2W */
66     CopyMemory(&to->wWeight, &f->wWeight, sizeof(CHARFORMAT2A)-FIELD_OFFSET(CHARFORMAT2A, wWeight));
67     to->cbSize = sizeof(CHARFORMAT2W);
68     return to;
69   }
70
71   return (from->cbSize >= sizeof(CHARFORMAT2W)) ? from : NULL;
72 }
73
74 void ME_CopyToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from)
75 {
76   if (ME_ToCF2W(to, from) == from)
77     *to = *from;
78 }
79
80 CHARFORMAT2W *ME_ToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from)
81 {
82   assert(from->cbSize == sizeof(CHARFORMAT2W));
83   if (to->cbSize == sizeof(CHARFORMATA))
84   {
85     CHARFORMATA *t = (CHARFORMATA *)to;
86     CopyMemory(t, from, FIELD_OFFSET(CHARFORMATA, szFaceName));
87     WideCharToMultiByte(0, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), 0, 0);
88     if (from->dwMask & CFM_UNDERLINETYPE)
89     {
90         switch (from->bUnderlineType)
91         {
92         case CFU_CF1UNDERLINE:
93             to->dwMask |= CFM_UNDERLINE;
94             to->dwEffects |= CFE_UNDERLINE;
95             break;
96         case CFU_UNDERLINENONE:
97             to->dwMask |= CFM_UNDERLINE;
98             to->dwEffects &= ~CFE_UNDERLINE;
99             break;
100         }
101     }
102     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
103     return to;
104   }
105   if (to->cbSize == sizeof(CHARFORMATW))
106   {
107     CHARFORMATW *t = (CHARFORMATW *)to;
108     CopyMemory(t, from, sizeof(*t));
109     if (from->dwMask & CFM_UNDERLINETYPE)
110     {
111         switch (from->bUnderlineType)
112         {
113         case CFU_CF1UNDERLINE:
114             to->dwMask |= CFM_UNDERLINE;
115             to->dwEffects |= CFE_UNDERLINE;
116             break;
117         case CFU_UNDERLINENONE:
118             to->dwMask |= CFM_UNDERLINE;
119             to->dwEffects &= ~CFE_UNDERLINE;
120             break;
121         }
122     }
123     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
124     return to;
125   }
126   if (to->cbSize == sizeof(CHARFORMAT2A))
127   {
128     CHARFORMAT2A *t = (CHARFORMAT2A *)to;
129     /* copy the A structure without face name */
130     CopyMemory(t, from, FIELD_OFFSET(CHARFORMATA, szFaceName));
131     /* convert face name */
132     WideCharToMultiByte(0, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), 0, 0);
133     /* copy the rest of the 2A structure to 2W */
134     CopyMemory(&t->wWeight, &from->wWeight, sizeof(CHARFORMAT2W)-FIELD_OFFSET(CHARFORMAT2W,wWeight));
135     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
136     return to;
137   }
138   assert(to->cbSize >= sizeof(CHARFORMAT2W));
139   return from;
140 }
141
142 void ME_CopyToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from)
143 {
144   if (ME_ToCFAny(to, from) == from)
145     CopyMemory(to, from, to->cbSize);
146 }
147
148 ME_Style *ME_MakeStyle(CHARFORMAT2W *style) {
149   CHARFORMAT2W styledata;
150   ME_Style *s = ALLOC_OBJ(ME_Style);
151   
152   style = ME_ToCF2W(&styledata, style);
153   memset(s, 0, sizeof(ME_Style));
154   if (style->cbSize <= sizeof(CHARFORMAT2W))
155     CopyMemory(&s->fmt, style, style->cbSize);
156   else
157     s->fmt = *style;
158   s->fmt.cbSize = sizeof(CHARFORMAT2W);
159
160   s->nSequence = -2;
161   s->nRefs = 1;
162   s->hFont = NULL;
163   s->tm.tmAscent = -1;
164   all_refs++;
165   return s;
166 }
167
168 #define COPY_STYLE_ITEM(mask, member) \
169   if (style->dwMask & mask) { \
170     s->fmt.dwMask |= mask;\
171     s->fmt.member = style->member;\
172   }
173
174 #define COPY_STYLE_ITEM_MEMCPY(mask, member) \
175   if (style->dwMask & mask) { \
176     s->fmt.dwMask |= mask;\
177     CopyMemory(s->fmt.member, style->member, sizeof(style->member));\
178   }
179   
180 void ME_InitCharFormat2W(CHARFORMAT2W *pFmt)
181 {
182   ZeroMemory(pFmt, sizeof(CHARFORMAT2W));
183   pFmt->cbSize = sizeof(CHARFORMAT2W);
184 }
185
186 ME_Style *ME_ApplyStyle(ME_Style *sSrc, CHARFORMAT2W *style)
187 {
188   CHARFORMAT2W styledata;
189   ME_Style *s = ME_MakeStyle(&sSrc->fmt);
190   style = ME_ToCF2W(&styledata, style);
191   COPY_STYLE_ITEM(CFM_ANIMATION, bAnimation);
192   COPY_STYLE_ITEM(CFM_BACKCOLOR, crBackColor);
193   COPY_STYLE_ITEM(CFM_CHARSET, bCharSet);
194   COPY_STYLE_ITEM(CFM_COLOR, crTextColor);
195   COPY_STYLE_ITEM_MEMCPY(CFM_FACE, szFaceName);
196   COPY_STYLE_ITEM(CFM_KERNING, wKerning);
197   COPY_STYLE_ITEM(CFM_LCID, lcid);
198   COPY_STYLE_ITEM(CFM_OFFSET, yOffset);
199   COPY_STYLE_ITEM(CFM_REVAUTHOR, bRevAuthor);
200   COPY_STYLE_ITEM(CFM_SIZE, yHeight);
201   COPY_STYLE_ITEM(CFM_SPACING, sSpacing);
202   COPY_STYLE_ITEM(CFM_STYLE, sStyle);
203   COPY_STYLE_ITEM(CFM_UNDERLINETYPE, bUnderlineType);
204   COPY_STYLE_ITEM(CFM_WEIGHT, wWeight);
205   /* FIXME: this is not documented this way, but that's the more logical */
206   COPY_STYLE_ITEM(CFM_FACE, bPitchAndFamily);
207
208   s->fmt.dwEffects &= ~(style->dwMask);
209   s->fmt.dwEffects |= style->dwEffects & style->dwMask;
210   s->fmt.dwMask |= style->dwMask;
211   if (style->dwMask & CFM_COLOR)
212   {
213     if (style->dwEffects & CFE_AUTOCOLOR)
214       s->fmt.dwEffects |= CFE_AUTOCOLOR;
215     else
216       s->fmt.dwEffects &= ~CFE_AUTOCOLOR;
217   }
218   if (style->dwMask & CFM_UNDERLINE)
219   {
220       s->fmt.dwMask |= CFM_UNDERLINETYPE;
221       s->fmt.bUnderlineType = (style->dwEffects & CFM_UNDERLINE) ?
222           CFU_CF1UNDERLINE : CFU_UNDERLINENONE;
223   }
224   return s;
225 }
226
227 void ME_CopyCharFormat(CHARFORMAT2W *pDest, const CHARFORMAT2W *pSrc)
228 {
229   /* using this with non-2W structs is forbidden */
230   assert(pSrc->cbSize == sizeof(CHARFORMAT2W));
231   assert(pDest->cbSize == sizeof(CHARFORMAT2W));
232   *pDest = *pSrc;
233 }
234
235 static void ME_DumpStyleEffect(char **p, const char *name, const CHARFORMAT2W *fmt, int mask)
236 {
237   *p += sprintf(*p, "%-22s%s\n", name, (fmt->dwMask & mask) ? ((fmt->dwEffects & mask) ? "YES" : "no") : "N/A");
238 }
239
240 void ME_DumpStyle(ME_Style *s)
241 {
242   char buf[2048];
243   ME_DumpStyleToBuf(&s->fmt, buf);
244   TRACE_(richedit_style)("%s\n", buf);
245 }
246
247 void ME_DumpStyleToBuf(CHARFORMAT2W *pFmt, char buf[2048])
248 {
249   /* FIXME only CHARFORMAT styles implemented */
250   /* this function sucks, doesn't check for buffer overruns but it's "good enough" as for debug code */
251   char *p;
252   p = buf;
253   p += sprintf(p, "Font face:            ");
254   if (pFmt->dwMask & CFM_FACE) {
255     WCHAR *q = pFmt->szFaceName;
256     while(*q) {
257       *p++ = (*q > 255) ? '?' : *q;
258       q++;      
259     }       
260   } else
261     p += sprintf(p, "N/A");
262
263   if (pFmt->dwMask & CFM_SIZE)
264     p += sprintf(p, "\nFont size:            %d\n", pFmt->yHeight);
265   else
266     p += sprintf(p, "\nFont size:            N/A\n");
267
268   if (pFmt->dwMask & CFM_OFFSET)
269     p += sprintf(p, "Char offset:          %d\n", pFmt->yOffset);
270   else
271     p += sprintf(p, "Char offset:          N/A\n");
272
273   if (pFmt->dwMask & CFM_CHARSET)
274     p += sprintf(p, "Font charset:         %d\n", (int)pFmt->bCharSet);
275   else
276     p += sprintf(p, "Font charset:         N/A\n");
277     
278   /* I'm assuming CFM_xxx and CFE_xxx are the same values, fortunately it IS true wrt used flags*/
279   ME_DumpStyleEffect(&p, "Font bold:", pFmt, CFM_BOLD);
280   ME_DumpStyleEffect(&p, "Font italic:", pFmt, CFM_ITALIC);
281   ME_DumpStyleEffect(&p, "Font underline:", pFmt, CFM_UNDERLINE);
282   ME_DumpStyleEffect(&p, "Font strikeout:", pFmt, CFM_STRIKEOUT);
283   ME_DumpStyleEffect(&p, "Hidden text:", pFmt, CFM_HIDDEN);
284   p += sprintf(p, "Text color:           ");
285   if (pFmt->dwMask & CFM_COLOR)
286   {
287     if (pFmt->dwEffects & CFE_AUTOCOLOR)
288       p += sprintf(p, "auto\n");
289     else
290       p += sprintf(p, "%06x\n", (int)pFmt->crTextColor);
291   }
292   else
293     p += sprintf(p, "N/A\n");
294   ME_DumpStyleEffect(&p, "Text protected:", pFmt, CFM_PROTECTED);
295 }
296
297
298 static void
299 ME_LogFontFromStyle(ME_Context* c, LOGFONTW *lf, const ME_Style *s)
300 {
301   ZeroMemory(lf, sizeof(LOGFONTW));
302   lstrcpyW(lf->lfFaceName, s->fmt.szFaceName);
303
304   lf->lfHeight = ME_twips2pointsY(c, -s->fmt.yHeight);
305   
306   lf->lfWeight = FW_NORMAL;
307   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_BOLD)
308     lf->lfWeight = FW_BOLD;
309   if (s->fmt.dwMask & CFM_WEIGHT)
310     lf->lfWeight = s->fmt.wWeight;
311   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_ITALIC)
312     lf->lfItalic = 1;
313   if (s->fmt.dwEffects & s->fmt.dwMask & (CFM_UNDERLINE | CFE_LINK))
314     lf->lfUnderline = 1;
315   if (s->fmt.dwMask & CFM_UNDERLINETYPE && s->fmt.bUnderlineType == CFU_CF1UNDERLINE)
316     lf->lfUnderline = 1;
317   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_STRIKEOUT)
318     lf->lfStrikeOut = 1;
319   if (s->fmt.dwEffects & s->fmt.dwMask & (CFM_SUBSCRIPT|CFM_SUPERSCRIPT))
320     lf->lfHeight = (lf->lfHeight*2)/3;
321 /*lf.lfQuality = PROOF_QUALITY; */
322   if (s->fmt.dwMask & CFM_FACE)
323     lf->lfPitchAndFamily = s->fmt.bPitchAndFamily;
324   if (s->fmt.dwMask & CFM_CHARSET)
325     lf->lfCharSet = s->fmt.bCharSet;
326 }
327
328 void ME_CharFormatFromLogFont(HDC hDC, const LOGFONTW *lf, CHARFORMAT2W *fmt)
329 {
330   int rx, ry;
331
332   ME_InitCharFormat2W(fmt);
333   rx = GetDeviceCaps(hDC, LOGPIXELSX);
334   ry = GetDeviceCaps(hDC, LOGPIXELSY);
335   lstrcpyW(fmt->szFaceName, lf->lfFaceName);
336   fmt->dwEffects = 0;
337   fmt->dwMask = CFM_WEIGHT|CFM_BOLD|CFM_ITALIC|CFM_UNDERLINE|CFM_STRIKEOUT|CFM_SIZE|CFM_FACE|CFM_CHARSET;
338   fmt->wWeight = lf->lfWeight;
339   fmt->yHeight = -lf->lfHeight*1440/ry;
340   if (lf->lfWeight > FW_NORMAL) fmt->dwEffects |= CFM_BOLD;
341   if (lf->lfItalic) fmt->dwEffects |= CFM_ITALIC;
342   if (lf->lfUnderline) fmt->dwEffects |= CFM_UNDERLINE;
343   /* notice that if a logfont was created with underline due to CFM_LINK, this
344       would add an erronous CFM_UNDERLINE. This isn't currently ever a problem */
345   if (lf->lfStrikeOut) fmt->dwEffects |= CFM_STRIKEOUT;
346   fmt->bPitchAndFamily = lf->lfPitchAndFamily;
347   fmt->bCharSet = lf->lfCharSet;
348 }
349
350 static BOOL ME_IsFontEqual(const LOGFONTW *p1, const LOGFONTW *p2)
351 {
352   if (memcmp(p1, p2, sizeof(LOGFONTW)-sizeof(p1->lfFaceName)))
353     return FALSE;
354   if (lstrcmpW(p1->lfFaceName, p2->lfFaceName))
355     return FALSE;
356   return TRUE;
357 }
358
359 HFONT ME_SelectStyleFont(ME_Context *c, ME_Style *s)
360 {
361   HFONT hOldFont;
362   LOGFONTW lf;
363   int i, nEmpty, nAge = 0x7FFFFFFF;
364   ME_FontCacheItem *item;
365   assert(c->hDC);
366   assert(s);
367   
368   ME_LogFontFromStyle(c, &lf, s);
369   
370   for (i=0; i<HFONT_CACHE_SIZE; i++)
371     c->editor->pFontCache[i].nAge++;
372   for (i=0, nEmpty=-1, nAge=0; i<HFONT_CACHE_SIZE; i++)
373   {
374     item = &c->editor->pFontCache[i];
375     if (!item->nRefs)
376     {
377       if (item->nAge > nAge)
378         nEmpty = i, nAge = item->nAge;
379     }
380     if (item->hFont && ME_IsFontEqual(&item->lfSpecs, &lf))
381       break;
382   }
383   if (i < HFONT_CACHE_SIZE) /* found */
384   {
385     item = &c->editor->pFontCache[i];
386     TRACE_(richedit_style)("font reused %d\n", i);
387
388     s->hFont = item->hFont;
389     item->nRefs++;
390   }
391   else
392   {
393     item = &c->editor->pFontCache[nEmpty]; /* this legal even when nEmpty == -1, as we don't dereference it */
394
395     assert(nEmpty != -1); /* otherwise we leak cache entries or get too many fonts at once*/
396     if (item->hFont) {
397       TRACE_(richedit_style)("font deleted %d\n", nEmpty);
398       DeleteObject(item->hFont);
399       item->hFont = NULL;
400     }
401     s->hFont = CreateFontIndirectW(&lf);
402     assert(s->hFont);
403     TRACE_(richedit_style)("font created %d\n", nEmpty);
404     item->hFont = s->hFont;
405     item->nRefs = 1;
406     item->lfSpecs = lf;
407   }
408   hOldFont = SelectObject(c->hDC, s->hFont);
409   /* should be cached too, maybe ? */
410   GetTextMetricsW(c->hDC, &s->tm);
411   return hOldFont;
412 }
413
414 void ME_UnselectStyleFont(ME_Context *c, ME_Style *s, HFONT hOldFont)
415 {
416   int i;
417   
418   assert(c->hDC);
419   assert(s);
420   SelectObject(c->hDC, hOldFont);
421   for (i=0; i<HFONT_CACHE_SIZE; i++)
422   {
423     ME_FontCacheItem *pItem = &c->editor->pFontCache[i];
424     if (pItem->hFont == s->hFont && pItem->nRefs > 0)
425     {
426       pItem->nRefs--;
427       pItem->nAge = 0;
428       s->hFont = NULL;
429       return;
430     }
431   }
432   assert(0 == "UnselectStyleFont without SelectStyleFont");
433 }
434
435 static void ME_DestroyStyle(ME_Style *s) {
436   if (s->hFont)
437   {
438     DeleteObject(s->hFont);
439     s->hFont = NULL;
440   }
441   FREE_OBJ(s);
442 }
443
444 void ME_AddRefStyle(ME_Style *s)
445 {
446   assert(s->nRefs>0); /* style with 0 references isn't supposed to exist */
447   s->nRefs++;
448   all_refs++;
449 }
450
451 void ME_ReleaseStyle(ME_Style *s)
452 {
453   s->nRefs--;
454   all_refs--;
455   if (s->nRefs==0)
456     TRACE_(richedit_style)("destroy style %p, total refs=%d\n", s, all_refs);
457   else
458     TRACE_(richedit_style)("release style %p, new refs=%d, total refs=%d\n", s, s->nRefs, all_refs);
459   if (!all_refs) TRACE("all style references freed (good!)\n");
460   assert(s->nRefs>=0);
461   if (!s->nRefs)
462     ME_DestroyStyle(s);
463 }
464
465 ME_Style *ME_GetInsertStyle(ME_TextEditor *editor, int nCursor) {
466   if (ME_IsSelection(editor))
467   {
468     ME_Cursor c;
469     int from, to;
470     
471     ME_GetSelection(editor, &from, &to);
472     ME_CursorFromCharOfs(editor, from, &c);
473     ME_AddRefStyle(c.pRun->member.run.style);
474     return c.pRun->member.run.style;
475   }
476   if (editor->pBuffer->pCharStyle) {
477     ME_AddRefStyle(editor->pBuffer->pCharStyle);
478     return editor->pBuffer->pCharStyle;
479   }
480   else
481   {
482     ME_Cursor *pCursor = &editor->pCursors[nCursor];
483     ME_DisplayItem *pRunItem = pCursor->pRun;
484     ME_DisplayItem *pPrevItem = NULL;
485     if (pCursor->nOffset) {
486       ME_Run *pRun = &pRunItem->member.run;
487       ME_AddRefStyle(pRun->style);
488       return pRun->style;
489     }
490     pPrevItem = ME_FindItemBack(pRunItem, diRunOrParagraph);
491     if (pPrevItem->type == diRun)
492     {
493       ME_AddRefStyle(pPrevItem->member.run.style);
494       return pPrevItem->member.run.style;
495     }
496     else
497     {
498       ME_AddRefStyle(pRunItem->member.run.style);
499       return pRunItem->member.run.style;
500     }
501   }
502 }
503
504 void ME_SaveTempStyle(ME_TextEditor *editor)
505 {
506   ME_Style *old_style = editor->pBuffer->pCharStyle;
507   editor->pBuffer->pCharStyle = ME_GetInsertStyle(editor, 0);
508   if (old_style)
509     ME_ReleaseStyle(old_style);
510 }
511
512 void ME_ClearTempStyle(ME_TextEditor *editor)
513 {
514   if (!editor->pBuffer->pCharStyle) return;
515   ME_ReleaseStyle(editor->pBuffer->pCharStyle);
516   editor->pBuffer->pCharStyle = NULL;
517 }