dinput: Silence incorrect warning and move it to a valid place.
[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     CopyMemory(to, from, sizeof(*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     CopyMemory(&s->fmt, style, sizeof(CHARFORMAT2W));
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.dwMask &= ~CFM_UNDERLINE;
222       s->fmt.bUnderlineType = (style->dwEffects & CFM_UNDERLINE) ?
223           CFU_CF1UNDERLINE : CFU_UNDERLINENONE;
224   }
225   return s;
226 }
227
228 void ME_CopyCharFormat(CHARFORMAT2W *pDest, const CHARFORMAT2W *pSrc)
229 {
230   /* using this with non-2W structs is forbidden */
231   assert(pSrc->cbSize == sizeof(CHARFORMAT2W));
232   assert(pDest->cbSize == sizeof(CHARFORMAT2W));
233   CopyMemory(pDest, pSrc, sizeof(CHARFORMAT2W));
234 }
235
236 static void ME_DumpStyleEffect(char **p, const char *name, const CHARFORMAT2W *fmt, int mask)
237 {
238   *p += sprintf(*p, "%-22s%s\n", name, (fmt->dwMask & mask) ? ((fmt->dwEffects & mask) ? "YES" : "no") : "N/A");
239 }
240
241 void ME_DumpStyle(ME_Style *s)
242 {
243   char buf[2048];
244   ME_DumpStyleToBuf(&s->fmt, buf);
245   TRACE_(richedit_style)("%s\n", buf);
246 }
247
248 void ME_DumpStyleToBuf(CHARFORMAT2W *pFmt, char buf[2048])
249 {
250   /* FIXME only CHARFORMAT styles implemented */
251   /* this function sucks, doesn't check for buffer overruns but it's "good enough" as for debug code */
252   char *p;
253   p = buf;
254   p += sprintf(p, "Font face:            ");
255   if (pFmt->dwMask & CFM_FACE) {
256     WCHAR *q = pFmt->szFaceName;
257     while(*q) {
258       *p++ = (*q > 255) ? '?' : *q;
259       q++;      
260     }       
261   } else
262     p += sprintf(p, "N/A");
263
264   if (pFmt->dwMask & CFM_SIZE)
265     p += sprintf(p, "\nFont size:            %d\n", (int)pFmt->yHeight);
266   else
267     p += sprintf(p, "\nFont size:            N/A\n");
268     
269   if (pFmt->dwMask & CFM_OFFSET)
270     p += sprintf(p, "Char offset:          %d\n", (int)pFmt->yOffset);
271   else
272     p += sprintf(p, "Char offset:          N/A\n");
273
274   if (pFmt->dwMask & CFM_CHARSET)
275     p += sprintf(p, "Font charset:         %d\n", (int)pFmt->bCharSet);
276   else
277     p += sprintf(p, "Font charset:         N/A\n");
278     
279   /* I'm assuming CFM_xxx and CFE_xxx are the same values, fortunately it IS true wrt used flags*/
280   ME_DumpStyleEffect(&p, "Font bold:", pFmt, CFM_BOLD);
281   ME_DumpStyleEffect(&p, "Font italic:", pFmt, CFM_ITALIC);
282   ME_DumpStyleEffect(&p, "Font underline:", pFmt, CFM_UNDERLINE);
283   ME_DumpStyleEffect(&p, "Font strikeout:", pFmt, CFM_STRIKEOUT);
284   ME_DumpStyleEffect(&p, "Hidden text:", pFmt, CFM_HIDDEN);
285   p += sprintf(p, "Text color:           ");
286   if (pFmt->dwMask & CFM_COLOR)
287   {
288     if (pFmt->dwEffects & CFE_AUTOCOLOR)
289       p += sprintf(p, "auto\n");
290     else
291       p += sprintf(p, "%06x\n", (int)pFmt->crTextColor);
292   }
293   else
294     p += sprintf(p, "N/A\n");
295   ME_DumpStyleEffect(&p, "Text protected:", pFmt, CFM_PROTECTED);
296 }
297
298
299 static void
300 ME_LogFontFromStyle(ME_Context* c, LOGFONTW *lf, const ME_Style *s)
301 {
302   ZeroMemory(lf, sizeof(LOGFONTW));
303   lstrcpyW(lf->lfFaceName, s->fmt.szFaceName);
304
305   lf->lfHeight = ME_twips2pointsY(c, -s->fmt.yHeight);
306   
307   lf->lfWeight = 400;
308   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_BOLD)
309     lf->lfWeight = 700;
310   if (s->fmt.dwMask & CFM_WEIGHT)
311     lf->lfWeight = s->fmt.wWeight;
312   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_ITALIC)
313     lf->lfItalic = 1;
314   if (s->fmt.dwEffects & s->fmt.dwMask & (CFM_UNDERLINE | CFE_LINK))
315     lf->lfUnderline = 1;
316   if (s->fmt.dwMask & CFM_UNDERLINETYPE && s->fmt.bUnderlineType == CFU_CF1UNDERLINE)
317     lf->lfUnderline = 1;
318   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_STRIKEOUT)
319     lf->lfStrikeOut = 1;
320   if (s->fmt.dwEffects & s->fmt.dwMask & (CFM_SUBSCRIPT|CFM_SUPERSCRIPT))
321     lf->lfHeight = (lf->lfHeight*2)/3;
322 /*lf.lfQuality = PROOF_QUALITY; */
323   if (s->fmt.dwMask & CFM_FACE)
324     lf->lfPitchAndFamily = s->fmt.bPitchAndFamily;
325   if (s->fmt.dwMask & CFM_CHARSET)
326     lf->lfCharSet = s->fmt.bCharSet;
327 }
328
329 void ME_CharFormatFromLogFont(HDC hDC, const LOGFONTW *lf, CHARFORMAT2W *fmt)
330 {
331   int rx, ry;
332
333   ME_InitCharFormat2W(fmt);
334   rx = GetDeviceCaps(hDC, LOGPIXELSX);
335   ry = GetDeviceCaps(hDC, LOGPIXELSY);
336   lstrcpyW(fmt->szFaceName, lf->lfFaceName);
337   fmt->dwEffects = 0;
338   fmt->dwMask = CFM_WEIGHT|CFM_BOLD|CFM_ITALIC|CFM_UNDERLINE|CFM_STRIKEOUT|CFM_SIZE|CFM_FACE|CFM_CHARSET;
339   fmt->wWeight = lf->lfWeight;
340   fmt->yHeight = -lf->lfHeight*1440/ry;
341   if (lf->lfWeight>400) fmt->dwEffects |= CFM_BOLD;
342   if (lf->lfItalic) fmt->dwEffects |= CFM_ITALIC;
343   if (lf->lfUnderline) fmt->dwEffects |= CFM_UNDERLINE;
344   /* notice that if a logfont was created with underline due to CFM_LINK, this
345       would add an erronious CFM_UNDERLINE. This isn't currently ever a problem */
346   if (lf->lfStrikeOut) fmt->dwEffects |= CFM_STRIKEOUT;
347   fmt->bPitchAndFamily = lf->lfPitchAndFamily;
348   fmt->bCharSet = lf->lfCharSet;
349 }
350
351 static BOOL ME_IsFontEqual(const LOGFONTW *p1, const LOGFONTW *p2)
352 {
353   if (memcmp(p1, p2, sizeof(LOGFONTW)-sizeof(p1->lfFaceName)))
354     return FALSE;
355   if (lstrcmpW(p1->lfFaceName, p2->lfFaceName))
356     return FALSE;
357   return TRUE;
358 }
359
360 HFONT ME_SelectStyleFont(ME_Context *c, ME_Style *s)
361 {
362   HFONT hOldFont;
363   LOGFONTW lf;
364   int i, nEmpty, nAge = 0x7FFFFFFF;
365   ME_FontCacheItem *item;
366   assert(c->hDC);
367   assert(s);
368   
369   ME_LogFontFromStyle(c, &lf, s);
370   
371   for (i=0; i<HFONT_CACHE_SIZE; i++)
372     c->editor->pFontCache[i].nAge++;
373   for (i=0, nEmpty=-1, nAge=0; i<HFONT_CACHE_SIZE; i++)
374   {
375     item = &c->editor->pFontCache[i];
376     if (!item->nRefs)
377     {
378       if (item->nAge > nAge)
379         nEmpty = i, nAge = item->nAge;
380     }
381     if (item->hFont && ME_IsFontEqual(&item->lfSpecs, &lf))
382       break;
383   }
384   if (i < HFONT_CACHE_SIZE) /* found */
385   {
386     item = &c->editor->pFontCache[i];
387     TRACE_(richedit_style)("font reused %d\n", i);
388
389     s->hFont = item->hFont;
390     item->nRefs++;
391   }
392   else
393   {
394     item = &c->editor->pFontCache[nEmpty]; /* this legal even when nEmpty == -1, as we don't dereference it */
395
396     assert(nEmpty != -1); /* otherwise we leak cache entries or get too many fonts at once*/
397     if (item->hFont) {
398       TRACE_(richedit_style)("font deleted %d\n", nEmpty);
399       DeleteObject(item->hFont);
400       item->hFont = NULL;
401     }
402     s->hFont = CreateFontIndirectW(&lf);
403     assert(s->hFont);
404     TRACE_(richedit_style)("font created %d\n", nEmpty);
405     item->hFont = s->hFont;
406     item->nRefs = 1;
407     memcpy(&item->lfSpecs, &lf, sizeof(LOGFONTW));
408   }
409   hOldFont = SelectObject(c->hDC, s->hFont);
410   /* should be cached too, maybe ? */
411   GetTextMetricsW(c->hDC, &s->tm);
412   return hOldFont;
413 }
414
415 void ME_UnselectStyleFont(ME_Context *c, ME_Style *s, HFONT hOldFont)
416 {
417   int i;
418   
419   assert(c->hDC);
420   assert(s);
421   SelectObject(c->hDC, hOldFont);
422   for (i=0; i<HFONT_CACHE_SIZE; i++)
423   {
424     ME_FontCacheItem *pItem = &c->editor->pFontCache[i];
425     if (pItem->hFont == s->hFont && pItem->nRefs > 0)
426     {
427       pItem->nRefs--;
428       pItem->nAge = 0;
429       s->hFont = NULL;
430       return;
431     }
432   }
433   assert(0 == "UnselectStyleFont without SelectStyleFont");
434 }
435
436 static void ME_DestroyStyle(ME_Style *s) {
437   if (s->hFont)
438   {
439     DeleteObject(s->hFont);
440     s->hFont = NULL;
441   }
442   FREE_OBJ(s);
443 }
444
445 void ME_AddRefStyle(ME_Style *s)
446 {
447   assert(s->nRefs>0); /* style with 0 references isn't supposed to exist */
448   s->nRefs++;
449   all_refs++;
450 }
451
452 void ME_ReleaseStyle(ME_Style *s)
453 {
454   s->nRefs--;
455   all_refs--;
456   if (s->nRefs==0)
457     TRACE_(richedit_style)("destroy style %p, total refs=%d\n", s, all_refs);
458   else
459     TRACE_(richedit_style)("release style %p, new refs=%d, total refs=%d\n", s, s->nRefs, all_refs);
460   if (!all_refs) TRACE("all style references freed (good!)\n");
461   assert(s->nRefs>=0);
462   if (!s->nRefs)
463     ME_DestroyStyle(s);
464 }
465
466 ME_Style *ME_GetInsertStyle(ME_TextEditor *editor, int nCursor) {
467   if (ME_IsSelection(editor))
468   {
469     ME_Cursor c;
470     int from, to;
471     
472     ME_GetSelection(editor, &from, &to);
473     ME_CursorFromCharOfs(editor, from, &c);
474     ME_AddRefStyle(c.pRun->member.run.style);
475     return c.pRun->member.run.style;
476   }
477   if (editor->pBuffer->pCharStyle) {
478     ME_AddRefStyle(editor->pBuffer->pCharStyle);
479     return editor->pBuffer->pCharStyle;
480   }
481   else
482   {
483     ME_Cursor *pCursor = &editor->pCursors[nCursor];
484     ME_DisplayItem *pRunItem = pCursor->pRun;
485     ME_DisplayItem *pPrevItem = NULL;
486     if (pCursor->nOffset) {
487       ME_Run *pRun = &pRunItem->member.run;
488       ME_AddRefStyle(pRun->style);
489       return pRun->style;
490     }
491     pPrevItem = ME_FindItemBack(pRunItem, diRunOrParagraph);
492     if (pPrevItem->type == diRun)
493     {
494       ME_AddRefStyle(pPrevItem->member.run.style);
495       return pPrevItem->member.run.style;
496     }
497     else
498     {
499       ME_AddRefStyle(pRunItem->member.run.style);
500       return pRunItem->member.run.style;
501     }
502   }
503 }
504
505 void ME_SaveTempStyle(ME_TextEditor *editor)
506 {
507   ME_Style *old_style = editor->pBuffer->pCharStyle;
508   editor->pBuffer->pCharStyle = ME_GetInsertStyle(editor, 0);
509   if (old_style)
510     ME_ReleaseStyle(old_style);
511 }
512
513 void ME_ClearTempStyle(ME_TextEditor *editor)
514 {
515   if (!editor->pBuffer->pCharStyle) return;
516   ME_ReleaseStyle(editor->pBuffer->pCharStyle);
517   editor->pBuffer->pCharStyle = NULL;
518 }