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