Store a bitmap of active hooks on the client side to try to avoid
[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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "editor.h"
22
23 WINE_DEFAULT_DEBUG_CHANNEL(richedit);
24
25 static int all_refs = 0;
26
27 CHARFORMAT2W *ME_ToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from)
28 {
29   if (from->cbSize == sizeof(CHARFORMATA))
30   {
31     CHARFORMATA *f = (CHARFORMATA *)from;
32     CopyMemory(to, f, sizeof(*f)-sizeof(f->szFaceName));
33     to->cbSize = sizeof(CHARFORMAT2W);
34     if (f->dwMask & CFM_FACE) {
35       MultiByteToWideChar(0, 0, f->szFaceName, -1, to->szFaceName, sizeof(to->szFaceName)/sizeof(WCHAR));
36     }
37     return to;
38   }
39   if (from->cbSize == sizeof(CHARFORMATW))
40   {
41     CHARFORMATW *f = (CHARFORMATW *)from;
42     CopyMemory(to, f, sizeof(*f));
43     /* theoretically, we don't need to zero the remaining memory */
44     ZeroMemory(((CHARFORMATW *)to)+1, sizeof(CHARFORMAT2W)-sizeof(CHARFORMATW));
45     to->cbSize = sizeof(CHARFORMAT2W);
46     return to;
47   }
48   if (from->cbSize == sizeof(CHARFORMAT2A))
49   {
50     CHARFORMATA *f = (CHARFORMATA *)from;
51     /* copy the A structure without face name */
52     CopyMemory(to, f, sizeof(CHARFORMATA)-sizeof(f->szFaceName));
53     /* convert face name */
54     if (f->dwMask & CFM_FACE)
55       MultiByteToWideChar(0, 0, f->szFaceName, -1, to->szFaceName, sizeof(to->szFaceName));
56     /* copy the rest of the 2A structure to 2W */
57     CopyMemory(1+((CHARFORMATW *)to), f+1, sizeof(CHARFORMAT2A)-sizeof(CHARFORMATA));
58     to->cbSize = sizeof(CHARFORMAT2W);
59     return to;
60   }
61
62   assert(from->cbSize >= sizeof(CHARFORMAT2W));  
63   return from;
64 }
65
66 void ME_CopyToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from)
67 {
68   if (ME_ToCF2W(to, from) == from)
69     CopyMemory(to, from, sizeof(*from));
70 }
71
72 CHARFORMAT2W *ME_ToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from)
73 {
74   assert(from->cbSize == sizeof(CHARFORMAT2W));
75   if (to->cbSize == sizeof(CHARFORMATA))
76   {
77     CHARFORMATA *t = (CHARFORMATA *)to;
78     CopyMemory(t, from, sizeof(*t)-sizeof(t->szFaceName));
79     WideCharToMultiByte(0, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), 0, 0);
80     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
81     return to;
82   }
83   if (to->cbSize == sizeof(CHARFORMATW))
84   {
85     CHARFORMATW *t = (CHARFORMATW *)to;
86     CopyMemory(t, from, sizeof(*t));
87     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
88     return to;
89   }
90   if (to->cbSize == sizeof(CHARFORMAT2A))
91   {
92     CHARFORMAT2A *t = (CHARFORMAT2A *)to;
93     /* copy the A structure without face name */
94     CopyMemory(t, from, sizeof(CHARFORMATA)-sizeof(t->szFaceName));
95     /* convert face name */
96     WideCharToMultiByte(0, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), 0, 0);
97     /* copy the rest of the 2A structure to 2W */
98     CopyMemory(&t->wWeight, &from->wWeight, sizeof(CHARFORMAT2A)-sizeof(CHARFORMATA));
99     t->cbSize = sizeof(*t); /* it was overwritten by CopyMemory */
100     return to;
101   }
102   assert(to->cbSize >= sizeof(CHARFORMAT2W));  
103   return from;
104 }
105
106 void ME_CopyToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from)
107 {
108   if (ME_ToCFAny(to, from) == from)
109     CopyMemory(to, from, to->cbSize);
110 }
111
112 ME_Style *ME_MakeStyle(CHARFORMAT2W *style) {
113   CHARFORMAT2W styledata;
114   ME_Style *s = ALLOC_OBJ(ME_Style);
115   
116   style = ME_ToCF2W(&styledata, style);
117   memset(s, 0, sizeof(ME_Style));
118   if (style->cbSize <= sizeof(CHARFORMAT2W))
119     CopyMemory(&s->fmt, style, style->cbSize);
120   else
121     CopyMemory(&s->fmt, style, sizeof(CHARFORMAT2W));
122   s->fmt.cbSize = sizeof(CHARFORMAT2W);
123
124   s->nSequence = -2;
125   s->nRefs = 1;
126   s->hFont = NULL;
127   s->tm.tmAscent = -1;
128   all_refs++;
129   return s;
130 }
131
132 #define COPY_STYLE_ITEM(mask, member) \
133   if (style->dwMask & mask) { \
134     s->fmt.dwMask |= mask;\
135     s->fmt.member = style->member;\
136   }
137
138 #define COPY_STYLE_ITEM_MEMCPY(mask, member) \
139   if (style->dwMask & mask) { \
140     s->fmt.dwMask |= mask;\
141     CopyMemory(s->fmt.member, style->member, sizeof(style->member));\
142   }
143   
144 void ME_InitCharFormat2W(CHARFORMAT2W *pFmt)
145 {
146   ZeroMemory(pFmt, sizeof(CHARFORMAT2W));
147   pFmt->cbSize = sizeof(CHARFORMAT2W);
148 }
149
150 ME_Style *ME_ApplyStyle(ME_Style *sSrc, CHARFORMAT2W *style)
151 {
152   CHARFORMAT2W styledata;
153   ME_Style *s = ME_MakeStyle(&sSrc->fmt);
154   style = ME_ToCF2W(&styledata, style);
155   COPY_STYLE_ITEM(CFM_ANIMATION, bAnimation);
156   COPY_STYLE_ITEM(CFM_BACKCOLOR, crBackColor);
157   COPY_STYLE_ITEM(CFM_CHARSET, bCharSet);
158   COPY_STYLE_ITEM(CFM_COLOR, crTextColor);
159   COPY_STYLE_ITEM_MEMCPY(CFM_FACE, szFaceName);
160   COPY_STYLE_ITEM(CFM_KERNING, wKerning);
161   COPY_STYLE_ITEM(CFM_LCID, lcid);
162   COPY_STYLE_ITEM(CFM_OFFSET, yOffset);
163   COPY_STYLE_ITEM(CFM_REVAUTHOR, bRevAuthor);
164   COPY_STYLE_ITEM(CFM_SIZE, yHeight);
165   COPY_STYLE_ITEM(CFM_SPACING, sSpacing);
166   COPY_STYLE_ITEM(CFM_STYLE, sStyle);
167   COPY_STYLE_ITEM(CFM_UNDERLINETYPE, bUnderlineType);
168   COPY_STYLE_ITEM(CFM_WEIGHT, wWeight);
169   
170   s->fmt.dwEffects &= ~(style->dwMask);
171   s->fmt.dwEffects |= style->dwEffects & style->dwMask;
172   s->fmt.dwMask |= style->dwMask;
173   if (style->dwMask & CFM_COLOR)
174   {
175     if (style->dwEffects & CFE_AUTOCOLOR)
176       s->fmt.dwEffects |= CFE_AUTOCOLOR;
177     else
178       s->fmt.dwEffects &= ~CFE_AUTOCOLOR;
179   }
180   return s;
181 }
182
183 void ME_CopyCharFormat(CHARFORMAT2W *pDest, CHARFORMAT2W *pSrc)
184 {
185   /* using this with non-2W structs is forbidden */
186   assert(pSrc->cbSize == sizeof(CHARFORMAT2W));
187   assert(pDest->cbSize == sizeof(CHARFORMAT2W));
188   CopyMemory(pDest, pSrc, sizeof(CHARFORMAT2W));
189 }
190
191 static void ME_DumpStyleEffect(char **p, const char *name, CHARFORMAT2W *fmt, int mask)
192 {
193   *p += sprintf(*p, "%-22s%s\n", name, (fmt->dwMask & mask) ? ((fmt->dwEffects & mask) ? "YES" : "no") : "N/A");
194 }
195
196 void ME_DumpStyle(ME_Style *s)
197 {
198   char buf[2048];
199   ME_DumpStyleToBuf(&s->fmt, buf);
200   TRACE("%s\n", buf);
201 }
202
203 void ME_DumpStyleToBuf(CHARFORMAT2W *pFmt, char buf[2048])
204 {
205   /* FIXME only CHARFORMAT styles implemented */
206   /* this function sucks, doesn't check for buffer overruns but it's "good enough" as for debug code */
207   char *p;
208   p = buf;
209   p += sprintf(p, "Font face:            ");
210   if (pFmt->dwMask & CFM_FACE) {
211     WCHAR *q = pFmt->szFaceName;
212     while(*q) {
213       *p++ = (*q > 255) ? '?' : *q;
214       q++;      
215     }       
216   } else
217     p += sprintf(p, "N/A");
218
219   if (pFmt->dwMask & CFM_SIZE)
220     p += sprintf(p, "\nFont size:            %d\n", (int)pFmt->yHeight);
221   else
222     p += sprintf(p, "\nFont size:            N/A\n");
223     
224   if (pFmt->dwMask & CFM_OFFSET)
225     p += sprintf(p, "Char offset:          %d\n", (int)pFmt->yOffset);
226   else
227     p += sprintf(p, "Char offset:          N/A\n");
228
229   if (pFmt->dwMask & CFM_CHARSET)
230     p += sprintf(p, "Font charset:         %d\n", (int)pFmt->bCharSet);
231   else
232     p += sprintf(p, "Font charset:         N/A\n");
233     
234   /* I'm assuming CFM_xxx and CFE_xxx are the same values, fortunately it IS true wrt used flags*/
235   ME_DumpStyleEffect(&p, "Font bold:", pFmt, CFM_BOLD);
236   ME_DumpStyleEffect(&p, "Font italic:", pFmt, CFM_ITALIC);
237   ME_DumpStyleEffect(&p, "Font underline:", pFmt, CFM_UNDERLINE);
238   ME_DumpStyleEffect(&p, "Font strikeout:", pFmt, CFM_STRIKEOUT);
239   p += sprintf(p, "Text color:           ");
240   if (pFmt->dwMask & CFM_COLOR)
241   {
242     if (pFmt->dwEffects & CFE_AUTOCOLOR)
243       p += sprintf(p, "auto\n");
244     else
245       p += sprintf(p, "%06x\n", (int)pFmt->crTextColor);
246   }
247   else
248     p += sprintf(p, "N/A\n");
249   ME_DumpStyleEffect(&p, "Text protected:", pFmt, CFM_PROTECTED);
250 }
251
252 void ME_LogFontFromStyle(HDC hDC, LOGFONTW *lf, ME_Style *s)
253 {
254   int rx, ry;
255   rx = GetDeviceCaps(hDC, LOGPIXELSX);
256   ry = GetDeviceCaps(hDC, LOGPIXELSY);
257   ZeroMemory(lf, sizeof(LOGFONTW));
258   lstrcpyW(lf->lfFaceName, s->fmt.szFaceName);
259   lf->lfHeight = -s->fmt.yHeight*ry/1440;
260   lf->lfWeight = 400;
261   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_BOLD)
262     lf->lfWeight = 700;
263   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_WEIGHT)
264     lf->lfWeight = s->fmt.wWeight;
265   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_ITALIC)
266     lf->lfItalic = 1;
267   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_UNDERLINE)
268     lf->lfUnderline = 1;
269   if (s->fmt.dwEffects & s->fmt.dwMask & CFM_STRIKEOUT)
270     lf->lfStrikeOut = 1;
271 /*lf.lfQuality = PROOF_QUALITY; */
272   lf->lfPitchAndFamily = s->fmt.bPitchAndFamily;
273   lf->lfCharSet = s->fmt.bCharSet;
274 }
275
276
277 BOOL ME_IsFontEqual(LOGFONTW *p1, LOGFONTW *p2)
278 {
279   if (memcmp(p1, p2, sizeof(LOGFONTW)-sizeof(p1->lfFaceName)))
280     return FALSE;
281   if (lstrcmpW(p1->lfFaceName, p2->lfFaceName))
282     return FALSE;
283   return TRUE;
284 }
285
286 HFONT ME_SelectStyleFont(ME_TextEditor *editor, HDC hDC, ME_Style *s)
287 {
288   HFONT hOldFont;
289   LOGFONTW lf;
290   int i, nEmpty, nAge = 0x7FFFFFFF;
291   ME_FontCacheItem *item;
292   assert(hDC);
293   assert(s);
294   
295   ME_LogFontFromStyle(hDC, &lf, s);
296   
297   for (i=0; i<HFONT_CACHE_SIZE; i++)
298     editor->pFontCache[i].nAge++;
299   for (i=0, nEmpty=-1, nAge=0; i<HFONT_CACHE_SIZE; i++)
300   {
301     item = &editor->pFontCache[i];
302     if (!item->nRefs)
303     {
304       if (item->nAge > nAge)
305         nEmpty = i, nAge = item->nAge;
306     }
307     if (ME_IsFontEqual(&item->lfSpecs, &lf))
308       break;
309   }
310   if (i < HFONT_CACHE_SIZE) /* found */
311   {
312     item = &editor->pFontCache[i];
313     TRACE("font reused %d\n", i);
314
315     s->hFont = item->hFont;
316     item->nRefs++;
317   }
318   else
319   {
320     item = &editor->pFontCache[nEmpty]; /* this legal even when nEmpty == -1, as we don't dereference it */
321
322     assert(nEmpty != -1); /* otherwise we leak cache entries or get too many fonts at once*/
323     if (item->hFont) {
324       TRACE("font deleted %d\n", nEmpty);
325       DeleteObject(item->hFont);
326       item->hFont = NULL;
327     }
328     s->hFont = CreateFontIndirectW(&lf);
329     assert(s->hFont);
330     TRACE("font created %d\n", nEmpty);
331     item->hFont = s->hFont;
332     item->nRefs = 1;
333     memcpy(&item->lfSpecs, &lf, sizeof(LOGFONTW));
334   }
335   hOldFont = SelectObject(hDC, s->hFont);
336   /* should be cached too, maybe ? */
337   GetTextMetricsW(hDC, &s->tm);
338   return hOldFont;
339 }
340
341 void ME_UnselectStyleFont(ME_TextEditor *editor, HDC hDC, ME_Style *s, HFONT hOldFont)
342 {
343   int i;
344   
345   assert(hDC);
346   assert(s);
347   SelectObject(hDC, hOldFont);
348   for (i=0; i<HFONT_CACHE_SIZE; i++)
349   {
350     ME_FontCacheItem *pItem = &editor->pFontCache[i];
351     if (pItem->hFont == s->hFont && pItem->nRefs > 0)
352     {
353       pItem->nRefs--;
354       pItem->nAge = 0;
355       s->hFont = NULL;
356       return;
357     }
358   }
359   assert(0 == "UnselectStyleFont without SelectStyleFont");
360 }
361
362 void ME_DestroyStyle(ME_Style *s) {
363   if (s->hFont)
364   {
365     DeleteObject(s->hFont);
366     s->hFont = NULL;
367   }
368   FREE_OBJ(s);
369 }
370
371 void ME_AddRefStyle(ME_Style *s)
372 {
373   assert(s->nRefs>0); /* style with 0 references isn't supposed to exist */
374   s->nRefs++;
375   all_refs++;
376 }
377
378 void ME_ReleaseStyle(ME_Style *s)
379 {
380   s->nRefs--;
381   all_refs--;
382   if (s->nRefs==0)
383     TRACE("destroy style %p, total refs=%d\n", s, all_refs);
384   else
385     TRACE("release style %p, new refs=%d, total refs=%d\n", s, s->nRefs, all_refs);
386   if (!all_refs) FIXME("all style references freed (good!)\n");
387   assert(s->nRefs>=0);
388   if (!s->nRefs)
389     ME_DestroyStyle(s);
390 }
391
392 ME_Style *ME_GetInsertStyle(ME_TextEditor *editor, int nCursor) {
393   if (ME_IsSelection(editor))
394   {
395     ME_Cursor c;
396     int from, to;
397     
398     ME_GetSelection(editor, &from, &to);
399     ME_CursorFromCharOfs(editor, from, &c);
400     ME_AddRefStyle(c.pRun->member.run.style);
401     return c.pRun->member.run.style;
402   }
403   if (editor->pBuffer->pCharStyle) {
404     ME_AddRefStyle(editor->pBuffer->pCharStyle);
405     return editor->pBuffer->pCharStyle;
406   }
407   else
408   {
409     ME_Cursor *pCursor = &editor->pCursors[nCursor];
410     ME_DisplayItem *pRunItem = pCursor->pRun;
411     ME_DisplayItem *pPrevItem = NULL;
412     if (pCursor->nOffset) {
413       ME_Run *pRun = &pRunItem->member.run;
414       ME_AddRefStyle(pRun->style);
415       return pRun->style;
416     }
417     pPrevItem = ME_FindItemBack(pRunItem, diRunOrParagraph);
418     if (pPrevItem->type == diRun)
419     {
420       ME_AddRefStyle(pPrevItem->member.run.style);
421       return pPrevItem->member.run.style;
422     }
423     else
424     {
425       ME_AddRefStyle(pRunItem->member.run.style);
426       return pRunItem->member.run.style;
427     }
428   }
429 }
430
431 void ME_SaveTempStyle(ME_TextEditor *editor)
432 {
433   ME_Style *old_style = editor->pBuffer->pCharStyle;
434   editor->pBuffer->pCharStyle = ME_GetInsertStyle(editor, 0);
435   if (old_style)
436     ME_ReleaseStyle(old_style);
437 }
438
439 void ME_ClearTempStyle(ME_TextEditor *editor)
440 {
441   if (!editor->pBuffer->pCharStyle) return;
442   ME_ReleaseStyle(editor->pBuffer->pCharStyle);
443   editor->pBuffer->pCharStyle = NULL;
444 }