0817ea80004c227c6c0587c78cac2829e2b49e91
[reactos.git] / reactos / 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(CP_ACP, 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(CP_ACP, 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(CP_ACP, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), NULL, NULL);
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(CP_ACP, 0, from->szFaceName, -1, t->szFaceName, sizeof(t->szFaceName), NULL, NULL);
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 {
144 ME_Style *s = ALLOC_OBJ(ME_Style);
145
146 assert(style->cbSize == sizeof(CHARFORMAT2W));
147 s->fmt = *style;
148 s->nRefs = 1;
149 s->hFont = NULL;
150 memset(&s->tm, 0, sizeof(s->tm));
151 s->tm.tmAscent = -1;
152 s->script_cache = NULL;
153 all_refs++;
154 TRACE_(richedit_style)("ME_MakeStyle %p, total refs=%d\n", s, all_refs);
155 return s;
156 }
157
158 #define COPY_STYLE_ITEM(mask, member) \
159 if (style->dwMask & mask) { \
160 s->fmt.dwMask |= mask;\
161 s->fmt.member = style->member;\
162 }
163
164 #define COPY_STYLE_ITEM_MEMCPY(mask, member) \
165 if (style->dwMask & mask) { \
166 s->fmt.dwMask |= mask;\
167 CopyMemory(s->fmt.member, style->member, sizeof(style->member));\
168 }
169
170 void ME_InitCharFormat2W(CHARFORMAT2W *pFmt)
171 {
172 ZeroMemory(pFmt, sizeof(CHARFORMAT2W));
173 pFmt->cbSize = sizeof(CHARFORMAT2W);
174 }
175
176 ME_Style *ME_ApplyStyle(ME_Style *sSrc, CHARFORMAT2W *style)
177 {
178 ME_Style *s = ME_MakeStyle(&sSrc->fmt);
179 assert(style->cbSize == sizeof(CHARFORMAT2W));
180 COPY_STYLE_ITEM(CFM_ANIMATION, bAnimation);
181 COPY_STYLE_ITEM(CFM_BACKCOLOR, crBackColor);
182 COPY_STYLE_ITEM(CFM_CHARSET, bCharSet);
183 COPY_STYLE_ITEM(CFM_COLOR, crTextColor);
184 COPY_STYLE_ITEM_MEMCPY(CFM_FACE, szFaceName);
185 COPY_STYLE_ITEM(CFM_KERNING, wKerning);
186 COPY_STYLE_ITEM(CFM_LCID, lcid);
187 COPY_STYLE_ITEM(CFM_OFFSET, yOffset);
188 COPY_STYLE_ITEM(CFM_REVAUTHOR, bRevAuthor);
189 if (style->dwMask & CFM_SIZE) {
190 s->fmt.dwMask |= CFM_SIZE;
191 s->fmt.yHeight = min(style->yHeight, yHeightCharPtsMost * 20);
192 }
193 COPY_STYLE_ITEM(CFM_SPACING, sSpacing);
194 COPY_STYLE_ITEM(CFM_STYLE, sStyle);
195 COPY_STYLE_ITEM(CFM_UNDERLINETYPE, bUnderlineType);
196 COPY_STYLE_ITEM(CFM_WEIGHT, wWeight);
197 /* FIXME: this is not documented this way, but that's the more logical */
198 COPY_STYLE_ITEM(CFM_FACE, bPitchAndFamily);
199
200 s->fmt.dwEffects &= ~(style->dwMask);
201 s->fmt.dwEffects |= style->dwEffects & style->dwMask;
202 s->fmt.dwMask |= style->dwMask;
203 if (style->dwMask & CFM_COLOR)
204 {
205 if (style->dwEffects & CFE_AUTOCOLOR)
206 s->fmt.dwEffects |= CFE_AUTOCOLOR;
207 else
208 s->fmt.dwEffects &= ~CFE_AUTOCOLOR;
209 }
210 if (style->dwMask & CFM_UNDERLINE)
211 {
212 s->fmt.dwMask |= CFM_UNDERLINETYPE;
213 s->fmt.bUnderlineType = (style->dwEffects & CFM_UNDERLINE) ?
214 CFU_CF1UNDERLINE : CFU_UNDERLINENONE;
215 }
216 if (style->dwMask & CFM_BOLD && !(style->dwMask & CFM_WEIGHT))
217 {
218 s->fmt.wWeight = (style->dwEffects & CFE_BOLD) ? FW_BOLD : FW_NORMAL;
219 } else if (style->dwMask & CFM_WEIGHT && !(style->dwMask & CFM_BOLD)) {
220 if (style->wWeight > FW_NORMAL)
221 s->fmt.dwEffects |= CFE_BOLD;
222 else
223 s->fmt.dwEffects &= ~CFE_BOLD;
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 *pDest = *pSrc;
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", 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", 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 = FW_NORMAL;
308 if (s->fmt.dwEffects & s->fmt.dwMask & CFM_BOLD)
309 lf->lfWeight = FW_BOLD;
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 ry;
332
333 ME_InitCharFormat2W(fmt);
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 erroneous 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(s);
366
367 ME_LogFontFromStyle(c, &lf, s);
368
369 for (i=0; i<HFONT_CACHE_SIZE; i++)
370 c->editor->pFontCache[i].nAge++;
371 for (i=0, nEmpty=-1, nAge=0; i<HFONT_CACHE_SIZE; i++)
372 {
373 item = &c->editor->pFontCache[i];
374 if (!item->nRefs)
375 {
376 if (item->nAge > nAge)
377 nEmpty = i, nAge = item->nAge;
378 }
379 if (item->hFont && ME_IsFontEqual(&item->lfSpecs, &lf))
380 break;
381 }
382 if (i < HFONT_CACHE_SIZE) /* found */
383 {
384 item = &c->editor->pFontCache[i];
385 TRACE_(richedit_style)("font reused %d\n", i);
386
387 s->hFont = item->hFont;
388 item->nRefs++;
389 }
390 else
391 {
392 item = &c->editor->pFontCache[nEmpty]; /* this legal even when nEmpty == -1, as we don't dereference it */
393
394 assert(nEmpty != -1); /* otherwise we leak cache entries or get too many fonts at once*/
395 if (item->hFont) {
396 TRACE_(richedit_style)("font deleted %d\n", nEmpty);
397 DeleteObject(item->hFont);
398 item->hFont = NULL;
399 }
400 s->hFont = CreateFontIndirectW(&lf);
401 assert(s->hFont);
402 TRACE_(richedit_style)("font created %d\n", nEmpty);
403 item->hFont = s->hFont;
404 item->nRefs = 1;
405 item->lfSpecs = lf;
406 }
407 hOldFont = SelectObject(c->hDC, s->hFont);
408 /* should be cached too, maybe ? */
409 GetTextMetricsW(c->hDC, &s->tm);
410 return hOldFont;
411 }
412
413 void ME_UnselectStyleFont(ME_Context *c, ME_Style *s, HFONT hOldFont)
414 {
415 int i;
416
417 assert(s);
418 SelectObject(c->hDC, hOldFont);
419 for (i=0; i<HFONT_CACHE_SIZE; i++)
420 {
421 ME_FontCacheItem *pItem = &c->editor->pFontCache[i];
422 if (pItem->hFont == s->hFont && pItem->nRefs > 0)
423 {
424 pItem->nRefs--;
425 pItem->nAge = 0;
426 s->hFont = NULL;
427 return;
428 }
429 }
430 assert(0 == "UnselectStyleFont without SelectStyleFont");
431 }
432
433 static void ME_DestroyStyle(ME_Style *s) {
434 if (s->hFont)
435 {
436 DeleteObject(s->hFont);
437 s->hFont = NULL;
438 }
439 ScriptFreeCache( &s->script_cache );
440 FREE_OBJ(s);
441 }
442
443 void ME_AddRefStyle(ME_Style *s)
444 {
445 assert(s->nRefs>0); /* style with 0 references isn't supposed to exist */
446 s->nRefs++;
447 all_refs++;
448 TRACE_(richedit_style)("ME_AddRefStyle %p, new refs=%d, total refs=%d\n", s, s->nRefs, 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 {
467 if (ME_IsSelection(editor))
468 {
469 ME_Cursor *from, *to;
470
471 ME_GetSelection(editor, &from, &to);
472 ME_AddRefStyle(from->pRun->member.run.style);
473 return from->pRun->member.run.style;
474 }
475 if (editor->pBuffer->pCharStyle) {
476 ME_AddRefStyle(editor->pBuffer->pCharStyle);
477 return editor->pBuffer->pCharStyle;
478 }
479 else
480 {
481 ME_Cursor *pCursor = &editor->pCursors[nCursor];
482 ME_DisplayItem *pRunItem = pCursor->pRun;
483 ME_DisplayItem *pPrevItem = NULL;
484 if (pCursor->nOffset) {
485 ME_Run *pRun = &pRunItem->member.run;
486 ME_AddRefStyle(pRun->style);
487 return pRun->style;
488 }
489 pPrevItem = ME_FindItemBack(pRunItem, diRunOrParagraph);
490 if (pPrevItem->type == diRun)
491 {
492 ME_AddRefStyle(pPrevItem->member.run.style);
493 return pPrevItem->member.run.style;
494 }
495 else
496 {
497 ME_AddRefStyle(pRunItem->member.run.style);
498 return pRunItem->member.run.style;
499 }
500 }
501 }
502
503 void ME_SaveTempStyle(ME_TextEditor *editor)
504 {
505 ME_Style *old_style = editor->pBuffer->pCharStyle;
506 editor->pBuffer->pCharStyle = ME_GetInsertStyle(editor, 0);
507 if (old_style)
508 ME_ReleaseStyle(old_style);
509 }
510
511 void ME_ClearTempStyle(ME_TextEditor *editor)
512 {
513 if (!editor->pBuffer->pCharStyle) return;
514 ME_ReleaseStyle(editor->pBuffer->pCharStyle);
515 editor->pBuffer->pCharStyle = NULL;
516 }