2 * RichEdit style management functions
4 * Copyright 2004 by Krzysztof Foltman
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.
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.
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
23 WINE_DEFAULT_DEBUG_CHANNEL(richedit
);
24 WINE_DECLARE_DEBUG_CHANNEL(richedit_style
);
26 static int all_refs
= 0;
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*
36 BOOL
cfany_to_cf2w(CHARFORMAT2W
*to
, const CHARFORMAT2W
*from
)
38 if (from
->cbSize
== sizeof(CHARFORMATA
))
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
));
48 if (from
->cbSize
== sizeof(CHARFORMATW
))
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
);
57 if (from
->cbSize
== sizeof(CHARFORMAT2A
))
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
);
70 if (from
->cbSize
== sizeof(CHARFORMAT2W
))
72 CopyMemory(to
, from
, sizeof(CHARFORMAT2W
));
79 BOOL
cf2w_to_cfany(CHARFORMAT2W
*to
, const CHARFORMAT2W
*from
)
81 assert(from
->cbSize
== sizeof(CHARFORMAT2W
));
82 if (to
->cbSize
== sizeof(CHARFORMATA
))
84 CHARFORMATA
*t
= (CHARFORMATA
*)to
;
85 CopyMemory(t
, from
, FIELD_OFFSET(CHARFORMATA
, szFaceName
));
86 WideCharToMultiByte(CP_ACP
, 0, from
->szFaceName
, -1, t
->szFaceName
, sizeof(t
->szFaceName
), NULL
, NULL
);
87 t
->cbSize
= sizeof(*t
); /* it was overwritten by CopyMemory */
90 if (to
->cbSize
== sizeof(CHARFORMATW
))
92 CHARFORMATW
*t
= (CHARFORMATW
*)to
;
93 CopyMemory(t
, from
, sizeof(*t
));
94 t
->cbSize
= sizeof(*t
); /* it was overwritten by CopyMemory */
97 if (to
->cbSize
== sizeof(CHARFORMAT2A
))
99 CHARFORMAT2A
*t
= (CHARFORMAT2A
*)to
;
100 /* copy the A structure without face name */
101 CopyMemory(t
, from
, FIELD_OFFSET(CHARFORMATA
, szFaceName
));
102 /* convert face name */
103 WideCharToMultiByte(CP_ACP
, 0, from
->szFaceName
, -1, t
->szFaceName
, sizeof(t
->szFaceName
), NULL
, NULL
);
104 /* copy the rest of the 2A structure to 2W */
105 CopyMemory(&t
->wWeight
, &from
->wWeight
, sizeof(CHARFORMAT2W
)-FIELD_OFFSET(CHARFORMAT2W
,wWeight
));
106 t
->cbSize
= sizeof(*t
); /* it was overwritten by CopyMemory */
109 if (to
->cbSize
== sizeof(CHARFORMAT2W
))
111 CopyMemory(to
, from
, sizeof(CHARFORMAT2W
));
117 ME_Style
*ME_MakeStyle(CHARFORMAT2W
*style
)
119 ME_Style
*s
= heap_alloc(sizeof(*s
));
121 assert(style
->cbSize
== sizeof(CHARFORMAT2W
));
124 s
->font_cache
= NULL
;
125 memset(&s
->tm
, 0, sizeof(s
->tm
));
127 s
->script_cache
= NULL
;
128 list_init(&s
->entry
);
130 TRACE_(richedit_style
)("ME_MakeStyle %p, total refs=%d\n", s
, all_refs
);
134 #define COPY_STYLE_ITEM(mask, member) \
135 if (mod->dwMask & mask) { \
137 fmt.member = mod->member;\
140 #define COPY_STYLE_ITEM_MEMCPY(mask, member) \
141 if (mod->dwMask & mask) { \
143 CopyMemory(fmt.member, mod->member, sizeof(mod->member));\
146 void ME_InitCharFormat2W(CHARFORMAT2W
*pFmt
)
148 ZeroMemory(pFmt
, sizeof(CHARFORMAT2W
));
149 pFmt
->cbSize
= sizeof(CHARFORMAT2W
);
152 ME_Style
*ME_ApplyStyle(ME_TextEditor
*editor
, ME_Style
*sSrc
, CHARFORMAT2W
*mod
)
154 CHARFORMAT2W fmt
= sSrc
->fmt
;
157 assert(mod
->cbSize
== sizeof(CHARFORMAT2W
));
158 COPY_STYLE_ITEM(CFM_ANIMATION
, bAnimation
);
159 COPY_STYLE_ITEM(CFM_BACKCOLOR
, crBackColor
);
160 COPY_STYLE_ITEM(CFM_CHARSET
, bCharSet
);
161 COPY_STYLE_ITEM(CFM_COLOR
, crTextColor
);
162 COPY_STYLE_ITEM_MEMCPY(CFM_FACE
, szFaceName
);
163 COPY_STYLE_ITEM(CFM_KERNING
, wKerning
);
164 COPY_STYLE_ITEM(CFM_LCID
, lcid
);
165 COPY_STYLE_ITEM(CFM_OFFSET
, yOffset
);
166 COPY_STYLE_ITEM(CFM_REVAUTHOR
, bRevAuthor
);
167 if (mod
->dwMask
& CFM_SIZE
) {
168 fmt
.dwMask
|= CFM_SIZE
;
169 fmt
.yHeight
= min(mod
->yHeight
, yHeightCharPtsMost
* 20);
171 COPY_STYLE_ITEM(CFM_SPACING
, sSpacing
);
172 COPY_STYLE_ITEM(CFM_STYLE
, sStyle
);
173 COPY_STYLE_ITEM(CFM_WEIGHT
, wWeight
);
174 /* FIXME: this is not documented this way, but that's the more logical */
175 COPY_STYLE_ITEM(CFM_FACE
, bPitchAndFamily
);
177 fmt
.dwEffects
&= ~(mod
->dwMask
);
178 fmt
.dwEffects
|= mod
->dwEffects
& mod
->dwMask
;
179 fmt
.dwMask
|= mod
->dwMask
;
180 if (mod
->dwMask
& CFM_COLOR
)
182 if (mod
->dwEffects
& CFE_AUTOCOLOR
)
183 fmt
.dwEffects
|= CFE_AUTOCOLOR
;
185 fmt
.dwEffects
&= ~CFE_AUTOCOLOR
;
188 COPY_STYLE_ITEM(CFM_UNDERLINETYPE
, bUnderlineType
);
189 /* If the CFM_UNDERLINE effect is not specified, set it appropriately */
190 if ((mod
->dwMask
& CFM_UNDERLINETYPE
) && !(mod
->dwMask
& CFM_UNDERLINE
))
192 fmt
.dwMask
|= CFM_UNDERLINE
;
193 if (mod
->bUnderlineType
== CFU_UNDERLINENONE
)
194 fmt
.dwEffects
&= ~CFE_UNDERLINE
;
196 fmt
.dwEffects
|= CFE_UNDERLINE
;
199 if (mod
->dwMask
& CFM_BOLD
&& !(mod
->dwMask
& CFM_WEIGHT
))
201 fmt
.wWeight
= (mod
->dwEffects
& CFE_BOLD
) ? FW_BOLD
: FW_NORMAL
;
202 } else if (mod
->dwMask
& CFM_WEIGHT
&& !(mod
->dwMask
& CFM_BOLD
)) {
203 if (mod
->wWeight
> FW_NORMAL
)
204 fmt
.dwEffects
|= CFE_BOLD
;
206 fmt
.dwEffects
&= ~CFE_BOLD
;
209 LIST_FOR_EACH_ENTRY(s
, &editor
->style_list
, ME_Style
, entry
)
211 if (!memcmp( &s
->fmt
, &fmt
, sizeof(fmt
) ))
213 TRACE_(richedit_style
)("found existing style %p\n", s
);
219 s
= ME_MakeStyle( &fmt
);
221 list_add_head( &editor
->style_list
, &s
->entry
);
222 TRACE_(richedit_style
)("created new style %p\n", s
);
226 void ME_CopyCharFormat(CHARFORMAT2W
*pDest
, const CHARFORMAT2W
*pSrc
)
228 /* using this with non-2W structs is forbidden */
229 assert(pSrc
->cbSize
== sizeof(CHARFORMAT2W
));
230 assert(pDest
->cbSize
== sizeof(CHARFORMAT2W
));
234 static void ME_DumpStyleEffect(char **p
, const char *name
, const CHARFORMAT2W
*fmt
, int mask
)
236 *p
+= sprintf(*p
, "%-22s%s\n", name
, (fmt
->dwMask
& mask
) ? ((fmt
->dwEffects
& mask
) ? "YES" : "no") : "N/A");
239 void ME_DumpStyle(ME_Style
*s
)
242 ME_DumpStyleToBuf(&s
->fmt
, buf
);
243 TRACE_(richedit_style
)("%s\n", buf
);
246 void ME_DumpStyleToBuf(CHARFORMAT2W
*pFmt
, char buf
[2048])
248 /* FIXME only CHARFORMAT styles implemented */
249 /* this function sucks, doesn't check for buffer overruns but it's "good enough" as for debug code */
252 p
+= sprintf(p
, "Font face: ");
253 if (pFmt
->dwMask
& CFM_FACE
) {
254 WCHAR
*q
= pFmt
->szFaceName
;
256 *p
++ = (*q
> 255) ? '?' : *q
;
260 p
+= sprintf(p
, "N/A");
262 if (pFmt
->dwMask
& CFM_SIZE
)
263 p
+= sprintf(p
, "\nFont size: %d\n", pFmt
->yHeight
);
265 p
+= sprintf(p
, "\nFont size: N/A\n");
267 if (pFmt
->dwMask
& CFM_OFFSET
)
268 p
+= sprintf(p
, "Char offset: %d\n", pFmt
->yOffset
);
270 p
+= sprintf(p
, "Char offset: N/A\n");
272 if (pFmt
->dwMask
& CFM_CHARSET
)
273 p
+= sprintf(p
, "Font charset: %d\n", (int)pFmt
->bCharSet
);
275 p
+= sprintf(p
, "Font charset: N/A\n");
277 /* I'm assuming CFM_xxx and CFE_xxx are the same values, fortunately it IS true wrt used flags*/
278 ME_DumpStyleEffect(&p
, "Font bold:", pFmt
, CFM_BOLD
);
279 ME_DumpStyleEffect(&p
, "Font italic:", pFmt
, CFM_ITALIC
);
280 ME_DumpStyleEffect(&p
, "Font underline:", pFmt
, CFM_UNDERLINE
);
281 ME_DumpStyleEffect(&p
, "Font strikeout:", pFmt
, CFM_STRIKEOUT
);
282 ME_DumpStyleEffect(&p
, "Hidden text:", pFmt
, CFM_HIDDEN
);
283 p
+= sprintf(p
, "Text color: ");
284 if (pFmt
->dwMask
& CFM_COLOR
)
286 if (pFmt
->dwEffects
& CFE_AUTOCOLOR
)
287 p
+= sprintf(p
, "auto\n");
289 p
+= sprintf(p
, "%06x\n", (int)pFmt
->crTextColor
);
292 p
+= sprintf(p
, "N/A\n");
293 ME_DumpStyleEffect(&p
, "Text protected:", pFmt
, CFM_PROTECTED
);
298 ME_LogFontFromStyle(ME_Context
* c
, LOGFONTW
*lf
, const ME_Style
*s
)
300 ZeroMemory(lf
, sizeof(LOGFONTW
));
301 lstrcpyW(lf
->lfFaceName
, s
->fmt
.szFaceName
);
303 lf
->lfHeight
= ME_twips2pointsY(c
, -s
->fmt
.yHeight
);
305 lf
->lfWeight
= FW_NORMAL
;
306 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_BOLD
)
307 lf
->lfWeight
= FW_BOLD
;
308 if (s
->fmt
.dwMask
& CFM_WEIGHT
)
309 lf
->lfWeight
= s
->fmt
.wWeight
;
310 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_ITALIC
)
312 if ((s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_UNDERLINE
) &&
313 !(s
->fmt
.dwEffects
& CFE_LINK
) &&
314 s
->fmt
.bUnderlineType
== CFU_CF1UNDERLINE
)
316 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_STRIKEOUT
)
318 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& (CFM_SUBSCRIPT
|CFM_SUPERSCRIPT
))
319 lf
->lfHeight
= (lf
->lfHeight
*2)/3;
320 /*lf.lfQuality = PROOF_QUALITY; */
321 if (s
->fmt
.dwMask
& CFM_FACE
)
322 lf
->lfPitchAndFamily
= s
->fmt
.bPitchAndFamily
;
323 if (s
->fmt
.dwMask
& CFM_CHARSET
)
324 lf
->lfCharSet
= s
->fmt
.bCharSet
;
327 void ME_CharFormatFromLogFont(HDC hDC
, const LOGFONTW
*lf
, CHARFORMAT2W
*fmt
)
331 ME_InitCharFormat2W(fmt
);
332 ry
= GetDeviceCaps(hDC
, LOGPIXELSY
);
333 lstrcpyW(fmt
->szFaceName
, lf
->lfFaceName
);
335 fmt
->dwMask
= CFM_WEIGHT
|CFM_BOLD
|CFM_ITALIC
|CFM_UNDERLINE
|CFM_UNDERLINETYPE
|CFM_STRIKEOUT
|CFM_SIZE
|CFM_FACE
|CFM_CHARSET
;
336 fmt
->wWeight
= lf
->lfWeight
;
337 fmt
->yHeight
= -lf
->lfHeight
*1440/ry
;
338 if (lf
->lfWeight
> FW_NORMAL
) fmt
->dwEffects
|= CFM_BOLD
;
339 if (lf
->lfItalic
) fmt
->dwEffects
|= CFM_ITALIC
;
340 if (lf
->lfUnderline
) fmt
->dwEffects
|= CFM_UNDERLINE
;
341 fmt
->bUnderlineType
= CFU_UNDERLINE
;
342 if (lf
->lfStrikeOut
) fmt
->dwEffects
|= CFM_STRIKEOUT
;
343 fmt
->bPitchAndFamily
= lf
->lfPitchAndFamily
;
344 fmt
->bCharSet
= lf
->lfCharSet
;
347 static BOOL
ME_IsFontEqual(const LOGFONTW
*p1
, const LOGFONTW
*p2
)
349 if (memcmp(p1
, p2
, sizeof(LOGFONTW
)-sizeof(p1
->lfFaceName
)))
351 if (lstrcmpW(p1
->lfFaceName
, p2
->lfFaceName
))
356 HFONT
ME_SelectStyleFont(ME_Context
*c
, ME_Style
*s
)
360 int i
, nEmpty
, nAge
= 0x7FFFFFFF;
361 ME_FontCacheItem
*item
;
364 ME_LogFontFromStyle(c
, &lf
, s
);
366 for (i
=0; i
<HFONT_CACHE_SIZE
; i
++)
367 c
->editor
->pFontCache
[i
].nAge
++;
368 for (i
=0, nEmpty
=-1, nAge
=0; i
<HFONT_CACHE_SIZE
; i
++)
370 item
= &c
->editor
->pFontCache
[i
];
373 if (item
->nAge
> nAge
)
374 nEmpty
= i
, nAge
= item
->nAge
;
376 if (item
->hFont
&& ME_IsFontEqual(&item
->lfSpecs
, &lf
))
379 if (i
< HFONT_CACHE_SIZE
) /* found */
381 item
= &c
->editor
->pFontCache
[i
];
382 TRACE_(richedit_style
)("font reused %d\n", i
);
387 item
= &c
->editor
->pFontCache
[nEmpty
]; /* this legal even when nEmpty == -1, as we don't dereference it */
389 assert(nEmpty
!= -1); /* otherwise we leak cache entries or get too many fonts at once*/
391 TRACE_(richedit_style
)("font deleted %d\n", nEmpty
);
392 DeleteObject(item
->hFont
);
395 item
->hFont
= CreateFontIndirectW(&lf
);
396 TRACE_(richedit_style
)("font created %d\n", nEmpty
);
400 s
->font_cache
= item
;
401 hOldFont
= SelectObject(c
->hDC
, item
->hFont
);
402 /* should be cached too, maybe ? */
403 GetTextMetricsW(c
->hDC
, &s
->tm
);
407 static void release_font_cache(ME_FontCacheItem
*item
)
416 void ME_UnselectStyleFont(ME_Context
*c
, ME_Style
*s
, HFONT hOldFont
)
418 SelectObject(c
->hDC
, hOldFont
);
419 release_font_cache(s
->font_cache
);
420 s
->font_cache
= NULL
;
423 void ME_DestroyStyle(ME_Style
*s
)
425 list_remove( &s
->entry
);
428 release_font_cache( s
->font_cache
);
429 s
->font_cache
= NULL
;
431 ScriptFreeCache( &s
->script_cache
);
435 void ME_AddRefStyle(ME_Style
*s
)
437 assert(s
->nRefs
>0); /* style with 0 references isn't supposed to exist */
440 TRACE_(richedit_style
)("ME_AddRefStyle %p, new refs=%d, total refs=%d\n", s
, s
->nRefs
, all_refs
);
443 void ME_ReleaseStyle(ME_Style
*s
)
448 TRACE_(richedit_style
)("destroy style %p, total refs=%d\n", s
, all_refs
);
450 TRACE_(richedit_style
)("release style %p, new refs=%d, total refs=%d\n", s
, s
->nRefs
, all_refs
);
451 if (!all_refs
) TRACE("all style references freed (good!)\n");
457 ME_Style
*ME_GetInsertStyle(ME_TextEditor
*editor
, int nCursor
)
459 if (ME_IsSelection(editor
))
461 ME_Cursor
*from
, *to
;
463 ME_GetSelection(editor
, &from
, &to
);
464 ME_AddRefStyle(from
->pRun
->member
.run
.style
);
465 return from
->pRun
->member
.run
.style
;
467 if (editor
->pBuffer
->pCharStyle
) {
468 ME_AddRefStyle(editor
->pBuffer
->pCharStyle
);
469 return editor
->pBuffer
->pCharStyle
;
473 ME_Cursor
*pCursor
= &editor
->pCursors
[nCursor
];
474 ME_DisplayItem
*pRunItem
= pCursor
->pRun
;
475 ME_DisplayItem
*pPrevItem
= NULL
;
476 if (pCursor
->nOffset
) {
477 ME_Run
*pRun
= &pRunItem
->member
.run
;
478 ME_AddRefStyle(pRun
->style
);
481 pPrevItem
= ME_FindItemBack(pRunItem
, diRunOrParagraph
);
482 if (pPrevItem
->type
== diRun
)
484 ME_AddRefStyle(pPrevItem
->member
.run
.style
);
485 return pPrevItem
->member
.run
.style
;
489 ME_AddRefStyle(pRunItem
->member
.run
.style
);
490 return pRunItem
->member
.run
.style
;
495 void ME_SaveTempStyle(ME_TextEditor
*editor
, ME_Style
*style
)
497 ME_Style
*old_style
= editor
->pBuffer
->pCharStyle
;
499 if (style
) ME_AddRefStyle( style
);
500 editor
->pBuffer
->pCharStyle
= style
;
501 if (old_style
) ME_ReleaseStyle( old_style
);
504 void ME_ClearTempStyle(ME_TextEditor
*editor
)
506 if (!editor
->pBuffer
->pCharStyle
) return;
507 ME_ReleaseStyle(editor
->pBuffer
->pCharStyle
);
508 editor
->pBuffer
->pCharStyle
= NULL
;
511 /******************************************************************************
512 * ME_SetDefaultCharFormat
514 * Applies a style change to the default character style.
516 * The default style is special in that it is mutable - runs
517 * in the document that have this style should change if the
518 * default style changes. That means we need to fix up this
521 void ME_SetDefaultCharFormat(ME_TextEditor
*editor
, CHARFORMAT2W
*mod
)
523 ME_Style
*style
, *def
= editor
->pBuffer
->pDefaultStyle
;
525 assert(mod
->cbSize
== sizeof(CHARFORMAT2W
));
526 style
= ME_ApplyStyle(editor
, def
, mod
);
527 def
->fmt
= style
->fmt
;
531 release_font_cache( def
->font_cache
);
532 def
->font_cache
= NULL
;
534 ScriptFreeCache( &def
->script_cache
);
535 ME_ReleaseStyle( style
);
536 ME_MarkAllForWrapping( editor
);