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 CHARFORMAT2W
*ME_ToCF2W(CHARFORMAT2W
*to
, 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
);
71 return (from
->cbSize
>= sizeof(CHARFORMAT2W
)) ? from
: NULL
;
74 static CHARFORMAT2W
*ME_ToCFAny(CHARFORMAT2W
*to
, CHARFORMAT2W
*from
)
76 assert(from
->cbSize
== sizeof(CHARFORMAT2W
));
77 if (to
->cbSize
== sizeof(CHARFORMATA
))
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
)
84 switch (from
->bUnderlineType
)
86 case CFU_CF1UNDERLINE
:
87 to
->dwMask
|= CFM_UNDERLINE
;
88 to
->dwEffects
|= CFE_UNDERLINE
;
90 case CFU_UNDERLINENONE
:
91 to
->dwMask
|= CFM_UNDERLINE
;
92 to
->dwEffects
&= ~CFE_UNDERLINE
;
96 t
->cbSize
= sizeof(*t
); /* it was overwritten by CopyMemory */
99 if (to
->cbSize
== sizeof(CHARFORMATW
))
101 CHARFORMATW
*t
= (CHARFORMATW
*)to
;
102 CopyMemory(t
, from
, sizeof(*t
));
103 if (from
->dwMask
& CFM_UNDERLINETYPE
)
105 switch (from
->bUnderlineType
)
107 case CFU_CF1UNDERLINE
:
108 to
->dwMask
|= CFM_UNDERLINE
;
109 to
->dwEffects
|= CFE_UNDERLINE
;
111 case CFU_UNDERLINENONE
:
112 to
->dwMask
|= CFM_UNDERLINE
;
113 to
->dwEffects
&= ~CFE_UNDERLINE
;
117 t
->cbSize
= sizeof(*t
); /* it was overwritten by CopyMemory */
120 if (to
->cbSize
== sizeof(CHARFORMAT2A
))
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 */
132 assert(to
->cbSize
>= sizeof(CHARFORMAT2W
));
136 void ME_CopyToCFAny(CHARFORMAT2W
*to
, CHARFORMAT2W
*from
)
138 if (ME_ToCFAny(to
, from
) == from
)
139 CopyMemory(to
, from
, to
->cbSize
);
142 ME_Style
*ME_MakeStyle(CHARFORMAT2W
*style
)
144 ME_Style
*s
= ALLOC_OBJ(ME_Style
);
146 assert(style
->cbSize
== sizeof(CHARFORMAT2W
));
150 memset(&s
->tm
, 0, sizeof(s
->tm
));
153 TRACE_(richedit_style
)("ME_MakeStyle %p, total refs=%d\n", s
, all_refs
);
157 #define COPY_STYLE_ITEM(mask, member) \
158 if (style->dwMask & mask) { \
159 s->fmt.dwMask |= mask;\
160 s->fmt.member = style->member;\
163 #define COPY_STYLE_ITEM_MEMCPY(mask, member) \
164 if (style->dwMask & mask) { \
165 s->fmt.dwMask |= mask;\
166 CopyMemory(s->fmt.member, style->member, sizeof(style->member));\
169 void ME_InitCharFormat2W(CHARFORMAT2W
*pFmt
)
171 ZeroMemory(pFmt
, sizeof(CHARFORMAT2W
));
172 pFmt
->cbSize
= sizeof(CHARFORMAT2W
);
175 ME_Style
*ME_ApplyStyle(ME_Style
*sSrc
, CHARFORMAT2W
*style
)
177 ME_Style
*s
= ME_MakeStyle(&sSrc
->fmt
);
178 assert(style
->cbSize
== sizeof(CHARFORMAT2W
));
179 COPY_STYLE_ITEM(CFM_ANIMATION
, bAnimation
);
180 COPY_STYLE_ITEM(CFM_BACKCOLOR
, crBackColor
);
181 COPY_STYLE_ITEM(CFM_CHARSET
, bCharSet
);
182 COPY_STYLE_ITEM(CFM_COLOR
, crTextColor
);
183 COPY_STYLE_ITEM_MEMCPY(CFM_FACE
, szFaceName
);
184 COPY_STYLE_ITEM(CFM_KERNING
, wKerning
);
185 COPY_STYLE_ITEM(CFM_LCID
, lcid
);
186 COPY_STYLE_ITEM(CFM_OFFSET
, yOffset
);
187 COPY_STYLE_ITEM(CFM_REVAUTHOR
, bRevAuthor
);
188 if (style
->dwMask
& CFM_SIZE
) {
189 s
->fmt
.dwMask
|= CFM_SIZE
;
190 s
->fmt
.yHeight
= min(style
->yHeight
, yHeightCharPtsMost
* 20);
192 COPY_STYLE_ITEM(CFM_SPACING
, sSpacing
);
193 COPY_STYLE_ITEM(CFM_STYLE
, sStyle
);
194 COPY_STYLE_ITEM(CFM_UNDERLINETYPE
, bUnderlineType
);
195 COPY_STYLE_ITEM(CFM_WEIGHT
, wWeight
);
196 /* FIXME: this is not documented this way, but that's the more logical */
197 COPY_STYLE_ITEM(CFM_FACE
, bPitchAndFamily
);
199 s
->fmt
.dwEffects
&= ~(style
->dwMask
);
200 s
->fmt
.dwEffects
|= style
->dwEffects
& style
->dwMask
;
201 s
->fmt
.dwMask
|= style
->dwMask
;
202 if (style
->dwMask
& CFM_COLOR
)
204 if (style
->dwEffects
& CFE_AUTOCOLOR
)
205 s
->fmt
.dwEffects
|= CFE_AUTOCOLOR
;
207 s
->fmt
.dwEffects
&= ~CFE_AUTOCOLOR
;
209 if (style
->dwMask
& CFM_UNDERLINE
)
211 s
->fmt
.dwMask
|= CFM_UNDERLINETYPE
;
212 s
->fmt
.bUnderlineType
= (style
->dwEffects
& CFM_UNDERLINE
) ?
213 CFU_CF1UNDERLINE
: CFU_UNDERLINENONE
;
215 if (style
->dwMask
& CFM_BOLD
&& !(style
->dwMask
& CFM_WEIGHT
))
217 s
->fmt
.wWeight
= (style
->dwEffects
& CFE_BOLD
) ? FW_BOLD
: FW_NORMAL
;
218 } else if (style
->dwMask
& CFM_WEIGHT
&& !(style
->dwMask
& CFM_BOLD
)) {
219 if (style
->wWeight
> FW_NORMAL
)
220 s
->fmt
.dwEffects
|= CFE_BOLD
;
222 s
->fmt
.dwEffects
&= ~CFE_BOLD
;
227 void ME_CopyCharFormat(CHARFORMAT2W
*pDest
, const CHARFORMAT2W
*pSrc
)
229 /* using this with non-2W structs is forbidden */
230 assert(pSrc
->cbSize
== sizeof(CHARFORMAT2W
));
231 assert(pDest
->cbSize
== sizeof(CHARFORMAT2W
));
235 static void ME_DumpStyleEffect(char **p
, const char *name
, const CHARFORMAT2W
*fmt
, int mask
)
237 *p
+= sprintf(*p
, "%-22s%s\n", name
, (fmt
->dwMask
& mask
) ? ((fmt
->dwEffects
& mask
) ? "YES" : "no") : "N/A");
240 void ME_DumpStyle(ME_Style
*s
)
243 ME_DumpStyleToBuf(&s
->fmt
, buf
);
244 TRACE_(richedit_style
)("%s\n", buf
);
247 void ME_DumpStyleToBuf(CHARFORMAT2W
*pFmt
, char buf
[2048])
249 /* FIXME only CHARFORMAT styles implemented */
250 /* this function sucks, doesn't check for buffer overruns but it's "good enough" as for debug code */
253 p
+= sprintf(p
, "Font face: ");
254 if (pFmt
->dwMask
& CFM_FACE
) {
255 WCHAR
*q
= pFmt
->szFaceName
;
257 *p
++ = (*q
> 255) ? '?' : *q
;
261 p
+= sprintf(p
, "N/A");
263 if (pFmt
->dwMask
& CFM_SIZE
)
264 p
+= sprintf(p
, "\nFont size: %d\n", pFmt
->yHeight
);
266 p
+= sprintf(p
, "\nFont size: N/A\n");
268 if (pFmt
->dwMask
& CFM_OFFSET
)
269 p
+= sprintf(p
, "Char offset: %d\n", pFmt
->yOffset
);
271 p
+= sprintf(p
, "Char offset: N/A\n");
273 if (pFmt
->dwMask
& CFM_CHARSET
)
274 p
+= sprintf(p
, "Font charset: %d\n", (int)pFmt
->bCharSet
);
276 p
+= sprintf(p
, "Font charset: N/A\n");
278 /* I'm assuming CFM_xxx and CFE_xxx are the same values, fortunately it IS true wrt used flags*/
279 ME_DumpStyleEffect(&p
, "Font bold:", pFmt
, CFM_BOLD
);
280 ME_DumpStyleEffect(&p
, "Font italic:", pFmt
, CFM_ITALIC
);
281 ME_DumpStyleEffect(&p
, "Font underline:", pFmt
, CFM_UNDERLINE
);
282 ME_DumpStyleEffect(&p
, "Font strikeout:", pFmt
, CFM_STRIKEOUT
);
283 ME_DumpStyleEffect(&p
, "Hidden text:", pFmt
, CFM_HIDDEN
);
284 p
+= sprintf(p
, "Text color: ");
285 if (pFmt
->dwMask
& CFM_COLOR
)
287 if (pFmt
->dwEffects
& CFE_AUTOCOLOR
)
288 p
+= sprintf(p
, "auto\n");
290 p
+= sprintf(p
, "%06x\n", (int)pFmt
->crTextColor
);
293 p
+= sprintf(p
, "N/A\n");
294 ME_DumpStyleEffect(&p
, "Text protected:", pFmt
, CFM_PROTECTED
);
299 ME_LogFontFromStyle(ME_Context
* c
, LOGFONTW
*lf
, const ME_Style
*s
)
301 ZeroMemory(lf
, sizeof(LOGFONTW
));
302 lstrcpyW(lf
->lfFaceName
, s
->fmt
.szFaceName
);
304 lf
->lfHeight
= ME_twips2pointsY(c
, -s
->fmt
.yHeight
);
306 lf
->lfWeight
= FW_NORMAL
;
307 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_BOLD
)
308 lf
->lfWeight
= FW_BOLD
;
309 if (s
->fmt
.dwMask
& CFM_WEIGHT
)
310 lf
->lfWeight
= s
->fmt
.wWeight
;
311 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_ITALIC
)
313 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& (CFM_UNDERLINE
| CFE_LINK
))
315 if (s
->fmt
.dwMask
& CFM_UNDERLINETYPE
&& s
->fmt
.bUnderlineType
== CFU_CF1UNDERLINE
)
317 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& CFM_STRIKEOUT
)
319 if (s
->fmt
.dwEffects
& s
->fmt
.dwMask
& (CFM_SUBSCRIPT
|CFM_SUPERSCRIPT
))
320 lf
->lfHeight
= (lf
->lfHeight
*2)/3;
321 /*lf.lfQuality = PROOF_QUALITY; */
322 if (s
->fmt
.dwMask
& CFM_FACE
)
323 lf
->lfPitchAndFamily
= s
->fmt
.bPitchAndFamily
;
324 if (s
->fmt
.dwMask
& CFM_CHARSET
)
325 lf
->lfCharSet
= s
->fmt
.bCharSet
;
328 void ME_CharFormatFromLogFont(HDC hDC
, const LOGFONTW
*lf
, CHARFORMAT2W
*fmt
)
332 ME_InitCharFormat2W(fmt
);
333 ry
= GetDeviceCaps(hDC
, LOGPIXELSY
);
334 lstrcpyW(fmt
->szFaceName
, lf
->lfFaceName
);
336 fmt
->dwMask
= CFM_WEIGHT
|CFM_BOLD
|CFM_ITALIC
|CFM_UNDERLINE
|CFM_STRIKEOUT
|CFM_SIZE
|CFM_FACE
|CFM_CHARSET
;
337 fmt
->wWeight
= lf
->lfWeight
;
338 fmt
->yHeight
= -lf
->lfHeight
*1440/ry
;
339 if (lf
->lfWeight
> FW_NORMAL
) fmt
->dwEffects
|= CFM_BOLD
;
340 if (lf
->lfItalic
) fmt
->dwEffects
|= CFM_ITALIC
;
341 if (lf
->lfUnderline
) fmt
->dwEffects
|= CFM_UNDERLINE
;
342 /* notice that if a logfont was created with underline due to CFM_LINK, this
343 would add an erroneous CFM_UNDERLINE. This isn't currently ever a problem. */
344 if (lf
->lfStrikeOut
) fmt
->dwEffects
|= CFM_STRIKEOUT
;
345 fmt
->bPitchAndFamily
= lf
->lfPitchAndFamily
;
346 fmt
->bCharSet
= lf
->lfCharSet
;
349 static BOOL
ME_IsFontEqual(const LOGFONTW
*p1
, const LOGFONTW
*p2
)
351 if (memcmp(p1
, p2
, sizeof(LOGFONTW
)-sizeof(p1
->lfFaceName
)))
353 if (lstrcmpW(p1
->lfFaceName
, p2
->lfFaceName
))
358 HFONT
ME_SelectStyleFont(ME_Context
*c
, ME_Style
*s
)
362 int i
, nEmpty
, nAge
= 0x7FFFFFFF;
363 ME_FontCacheItem
*item
;
366 ME_LogFontFromStyle(c
, &lf
, s
);
368 for (i
=0; i
<HFONT_CACHE_SIZE
; i
++)
369 c
->editor
->pFontCache
[i
].nAge
++;
370 for (i
=0, nEmpty
=-1, nAge
=0; i
<HFONT_CACHE_SIZE
; i
++)
372 item
= &c
->editor
->pFontCache
[i
];
375 if (item
->nAge
> nAge
)
376 nEmpty
= i
, nAge
= item
->nAge
;
378 if (item
->hFont
&& ME_IsFontEqual(&item
->lfSpecs
, &lf
))
381 if (i
< HFONT_CACHE_SIZE
) /* found */
383 item
= &c
->editor
->pFontCache
[i
];
384 TRACE_(richedit_style
)("font reused %d\n", i
);
386 s
->hFont
= item
->hFont
;
391 item
= &c
->editor
->pFontCache
[nEmpty
]; /* this legal even when nEmpty == -1, as we don't dereference it */
393 assert(nEmpty
!= -1); /* otherwise we leak cache entries or get too many fonts at once*/
395 TRACE_(richedit_style
)("font deleted %d\n", nEmpty
);
396 DeleteObject(item
->hFont
);
399 s
->hFont
= CreateFontIndirectW(&lf
);
401 TRACE_(richedit_style
)("font created %d\n", nEmpty
);
402 item
->hFont
= s
->hFont
;
406 hOldFont
= SelectObject(c
->hDC
, s
->hFont
);
407 /* should be cached too, maybe ? */
408 GetTextMetricsW(c
->hDC
, &s
->tm
);
412 void ME_UnselectStyleFont(ME_Context
*c
, ME_Style
*s
, HFONT hOldFont
)
417 SelectObject(c
->hDC
, hOldFont
);
418 for (i
=0; i
<HFONT_CACHE_SIZE
; i
++)
420 ME_FontCacheItem
*pItem
= &c
->editor
->pFontCache
[i
];
421 if (pItem
->hFont
== s
->hFont
&& pItem
->nRefs
> 0)
429 assert(0 == "UnselectStyleFont without SelectStyleFont");
432 static void ME_DestroyStyle(ME_Style
*s
) {
435 DeleteObject(s
->hFont
);
441 void ME_AddRefStyle(ME_Style
*s
)
443 assert(s
->nRefs
>0); /* style with 0 references isn't supposed to exist */
446 TRACE_(richedit_style
)("ME_AddRefStyle %p, new refs=%d, total refs=%d\n", s
, s
->nRefs
, all_refs
);
449 void ME_ReleaseStyle(ME_Style
*s
)
454 TRACE_(richedit_style
)("destroy style %p, total refs=%d\n", s
, all_refs
);
456 TRACE_(richedit_style
)("release style %p, new refs=%d, total refs=%d\n", s
, s
->nRefs
, all_refs
);
457 if (!all_refs
) TRACE("all style references freed (good!)\n");
463 ME_Style
*ME_GetInsertStyle(ME_TextEditor
*editor
, int nCursor
)
465 if (ME_IsSelection(editor
))
467 ME_Cursor
*from
, *to
;
469 ME_GetSelection(editor
, &from
, &to
);
470 ME_AddRefStyle(from
->pRun
->member
.run
.style
);
471 return from
->pRun
->member
.run
.style
;
473 if (editor
->pBuffer
->pCharStyle
) {
474 ME_AddRefStyle(editor
->pBuffer
->pCharStyle
);
475 return editor
->pBuffer
->pCharStyle
;
479 ME_Cursor
*pCursor
= &editor
->pCursors
[nCursor
];
480 ME_DisplayItem
*pRunItem
= pCursor
->pRun
;
481 ME_DisplayItem
*pPrevItem
= NULL
;
482 if (pCursor
->nOffset
) {
483 ME_Run
*pRun
= &pRunItem
->member
.run
;
484 ME_AddRefStyle(pRun
->style
);
487 pPrevItem
= ME_FindItemBack(pRunItem
, diRunOrParagraph
);
488 if (pPrevItem
->type
== diRun
)
490 ME_AddRefStyle(pPrevItem
->member
.run
.style
);
491 return pPrevItem
->member
.run
.style
;
495 ME_AddRefStyle(pRunItem
->member
.run
.style
);
496 return pRunItem
->member
.run
.style
;
501 void ME_SaveTempStyle(ME_TextEditor
*editor
)
503 ME_Style
*old_style
= editor
->pBuffer
->pCharStyle
;
504 editor
->pBuffer
->pCharStyle
= ME_GetInsertStyle(editor
, 0);
506 ME_ReleaseStyle(old_style
);
509 void ME_ClearTempStyle(ME_TextEditor
*editor
)
511 if (!editor
->pBuffer
->pCharStyle
) return;
512 ME_ReleaseStyle(editor
->pBuffer
->pCharStyle
);
513 editor
->pBuffer
->pCharStyle
= NULL
;