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