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