4 * Copyright 1993, 1994 Alexandre Julliard
5 * Copyright 2002 Bill Medland
8 * 1. DrawText functions
9 * 2. GrayString functions
10 * 3. TabbedText functions
12 * This library is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public
14 * License as published by the Free Software Foundation; either
15 * version 2.1 of the License, or (at your option) any later version.
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include "wine/port.h"
35 #include "wine/winuser16.h"
36 #include "wine/unicode.h"
42 #include "wine/debug.h"
44 WINE_DEFAULT_DEBUG_CHANNEL(text);
46 /*********************************************************************
51 * How many buffers to use
52 * While processing in DrawText there are potentially three different forms
53 * of the text that need to be held. How are they best held?
54 * 1. The original text is needed, of course, to see what to display.
55 * 2. The text that will be returned to the user if the DT_MODIFYSTRING is
57 * 3. The buffered text that is about to be displayed e.g. the current line.
58 * Typically this will exclude the ampersands used for prefixing etc.
61 * a. If the buffered text to be displayed includes the ampersands then
62 * we will need special measurement and draw functions that will ignore
63 * the ampersands (e.g. by copying to a buffer without the prefix and
64 * then using the normal forms). This may involve less space but may
65 * require more processing. e.g. since a line containing tabs may
66 * contain several underlined characters either we need to carry around
67 * a list of prefix locations or we may need to locate them several
69 * b. If we actually directly modify the "original text" as we go then we
70 * will need some special "caching" to handle the fact that when we
71 * ellipsify the text the ellipsis may modify the next line of text,
72 * which we have not yet processed. (e.g. ellipsification of a W at the
73 * end of a line will overwrite the W, the \n and the first character of
74 * the next line, and a \0 will overwrite the second. Try it!!)
76 * Option 1. Three separate storages. (To be implemented)
77 * If DT_MODIFYSTRING is in effect then allocate an extra buffer to hold
78 * the edited string in some form, either as the string itself or as some
79 * sort of "edit list" to be applied just before returning.
80 * Use a buffer that holds the ellipsified current line sans ampersands
81 * and accept the need occasionally to recalculate the prefixes (if
82 * DT_EXPANDTABS and not DT_NOPREFIX and not DT_HIDEPREFIX)
91 #define FORWARD_SLASH '/'
92 #define BACK_SLASH '\\'
94 static const WCHAR ELLIPSISW[] = {'.','.','.', 0};
96 typedef struct tag_ellipsis_data
104 /*********************************************************************
105 * TEXT_Ellipsify (static)
107 * Add an ellipsis to the end of the given string whilst ensuring it fits.
109 * If the ellipsis alone doesn't fit then it will be returned anyway.
111 * See Also TEXT_PathEllipsify
114 * hdc [in] The handle to the DC that defines the font.
115 * str [in/out] The string that needs to be modified.
116 * max_str [in] The dimension of str (number of WCHAR).
117 * len_str [in/out] The number of characters in str
118 * width [in] The maximum width permitted (in logical coordinates)
119 * size [out] The dimensions of the text
120 * modstr [out] The modified form of the string, to be returned to the
121 * calling program. It is assumed that the caller has
122 * made sufficient space available so we don't need to
123 * know the size of the space. This pointer may be NULL if
124 * the modified string is not required.
125 * len_before [out] The number of characters before the ellipsis.
126 * len_ellip [out] The number of characters in the ellipsis.
128 * See for example Microsoft article Q249678.
130 * For now we will simply use three dots rather than worrying about whether
131 * the font contains an explicit ellipsis character.
133 static void TEXT_Ellipsify (HDC hdc, WCHAR *str, unsigned int max_len,
134 unsigned int *len_str, int width, SIZE *size,
136 int *len_before, int *len_ellip)
138 unsigned int len_ellipsis;
139 unsigned int lo, mid, hi;
141 len_ellipsis = strlenW (ELLIPSISW);
142 if (len_ellipsis > max_len) len_ellipsis = max_len;
143 if (*len_str > max_len - len_ellipsis)
144 *len_str = max_len - len_ellipsis;
146 /* First do a quick binary search to get an upper bound for *len_str. */
148 GetTextExtentExPointW(hdc, str, *len_str, width, NULL, NULL, size) &&
151 for (lo = 0, hi = *len_str; lo < hi; )
154 if (!GetTextExtentExPointW(hdc, str, mid, width, NULL, NULL, size))
156 if (size->cx > width)
163 /* Now this should take only a couple iterations at most. */
166 strncpyW (str + *len_str, ELLIPSISW, len_ellipsis);
168 if (!GetTextExtentExPointW (hdc, str, *len_str + len_ellipsis, width,
169 NULL, NULL, size)) break;
171 if (!*len_str || size->cx <= width) break;
175 *len_ellip = len_ellipsis;
176 *len_before = *len_str;
177 *len_str += len_ellipsis;
181 strncpyW (modstr, str, *len_str);
182 *(str+*len_str) = '\0';
186 /*********************************************************************
187 * TEXT_PathEllipsify (static)
189 * Add an ellipsis to the provided string in order to make it fit within
190 * the width. The ellipsis is added as specified for the DT_PATH_ELLIPSIS
193 * See Also TEXT_Ellipsify
196 * hdc [in] The handle to the DC that defines the font.
197 * str [in/out] The string that needs to be modified
198 * max_str [in] The dimension of str (number of WCHAR).
199 * len_str [in/out] The number of characters in str
200 * width [in] The maximum width permitted (in logical coordinates)
201 * size [out] The dimensions of the text
202 * modstr [out] The modified form of the string, to be returned to the
203 * calling program. It is assumed that the caller has
204 * made sufficient space available so we don't need to
205 * know the size of the space. This pointer may be NULL if
206 * the modified string is not required.
207 * pellip [out] The ellipsification results
209 * For now we will simply use three dots rather than worrying about whether
210 * the font contains an explicit ellipsis character.
212 * The following applies, I think to Win95. We will need to extend it for
213 * Win98 which can have both path and end ellipsis at the same time (e.g.
214 * C:\MyLongFileName.Txt becomes ...\MyLongFileN...)
216 * The resulting string consists of as much as possible of the following:
217 * 1. The ellipsis itself
218 * 2. The last \ or / of the string (if any)
219 * 3. Everything after the last \ or / of the string (if any) or the whole
220 * string if there is no / or \. I believe that under Win95 this would
221 * include everything even though some might be clipped off the end whereas
222 * under Win98 that might be ellipsified too.
223 * Yet to be investigated is whether this would include wordbreaking if the
224 * filename is more than 1 word and splitting if DT_EDITCONTROL was in
225 * effect. (If DT_EDITCONTROL is in effect then on occasions text will be
226 * broken within words).
227 * 4. All the stuff before the / or \, which is placed before the ellipsis.
229 static void TEXT_PathEllipsify (HDC hdc, WCHAR *str, unsigned int max_len,
230 unsigned int *len_str, int width, SIZE *size,
231 WCHAR *modstr, ellipsis_data *pellip)
236 WCHAR *lastBkSlash, *lastFwdSlash, *lastSlash;
238 len_ellipsis = strlenW (ELLIPSISW);
239 if (!max_len) return;
240 if (len_ellipsis >= max_len) len_ellipsis = max_len - 1;
241 if (*len_str + len_ellipsis >= max_len)
242 *len_str = max_len - len_ellipsis-1;
243 /* Hopefully this will never happen, otherwise it would probably lose
244 * the wrong character
246 str[*len_str] = '\0'; /* to simplify things */
248 lastBkSlash = strrchrW (str, BACK_SLASH);
249 lastFwdSlash = strrchrW (str, FORWARD_SLASH);
250 lastSlash = lastBkSlash > lastFwdSlash ? lastBkSlash : lastFwdSlash;
251 if (!lastSlash) lastSlash = str;
252 len_trailing = *len_str - (lastSlash - str);
254 /* overlap-safe movement to the right */
255 memmove (lastSlash+len_ellipsis, lastSlash, len_trailing * sizeof(WCHAR));
256 strncpyW (lastSlash, ELLIPSISW, len_ellipsis);
257 len_trailing += len_ellipsis;
258 /* From this point on lastSlash actually points to the ellipsis in front
259 * of the last slash and len_trailing includes the ellipsis
265 if (!GetTextExtentExPointW (hdc, str, *len_str + len_ellipsis, width,
266 NULL, NULL, size)) break;
268 if (lastSlash == str || size->cx <= width) break;
270 /* overlap-safe movement to the left */
271 memmove (lastSlash-1, lastSlash, len_trailing * sizeof(WCHAR));
278 pellip->before = lastSlash-str;
279 pellip->len = len_ellipsis;
280 pellip->under = len_under;
281 pellip->after = len_trailing - len_ellipsis;
282 *len_str += len_ellipsis;
286 strncpyW (modstr, str, *len_str);
287 *(str+*len_str) = '\0';
291 /*********************************************************************
292 * TEXT_WordBreak (static)
294 * Perform wordbreak processing on the given string
296 * Assumes that DT_WORDBREAK has been specified and not all the characters
297 * fit. Note that this function should even be called when the first character
298 * that doesn't fit is known to be a space or tab, so that it can swallow them.
300 * Note that the Windows processing has some strange properties.
301 * 1. If the text is left-justified and there is room for some of the spaces
302 * that follow the last word on the line then those that fit are included on
304 * 2. If the text is centred or right-justified and there is room for some of
305 * the spaces that follow the last word on the line then all but one of those
306 * that fit are included on the line.
307 * 3. (Reasonable behaviour) If the word breaking causes a space to be the first
308 * character of a new line it will be skipped.
311 * hdc [in] The handle to the DC that defines the font.
312 * str [in/out] The string that needs to be broken.
313 * max_str [in] The dimension of str (number of WCHAR).
314 * len_str [in/out] The number of characters in str
315 * width [in] The maximum width permitted
316 * format [in] The format flags in effect
317 * chars_fit [in] The maximum number of characters of str that are already
318 * known to fit; chars_fit+1 is known not to fit.
319 * chars_used [out] The number of characters of str that have been "used" and
320 * do not need to be included in later text. For example this will
321 * include any spaces that have been discarded from the start of
323 * size [out] The size of the returned text in logical coordinates
325 * Pedantic assumption - Assumes that the text length is monotonically
326 * increasing with number of characters (i.e. no weird kernings)
330 * Work back from the last character that did fit to either a space or the last
331 * character of a word, whichever is met first.
332 * If there was one or the first character didn't fit then
333 * If the text is centred or right justified and that one character was a
334 * space then break the line before that character
335 * Otherwise break the line after that character
336 * and if the next character is a space then discard it.
337 * Suppose there was none (and the first character did fit).
338 * If Break Within Word is permitted
339 * break the word after the last character that fits (there must be
340 * at least one; none is caught earlier).
342 * discard any trailing space.
343 * include the whole word; it may be ellipsified later
345 * Break Within Word is permitted under a set of circumstances that are not
346 * totally clear yet. Currently our best guess is:
347 * If DT_EDITCONTROL is in effect and neither DT_WORD_ELLIPSIS nor
348 * DT_PATH_ELLIPSIS is
351 static void TEXT_WordBreak (HDC hdc, WCHAR *str, unsigned int max_str,
352 unsigned int *len_str,
353 int width, int format, unsigned int chars_fit,
354 unsigned int *chars_used, SIZE *size)
358 assert (format & DT_WORDBREAK);
359 assert (chars_fit < *len_str);
361 /* Work back from the last character that did fit to either a space or the
362 * last character of a word, whichever is met first.
364 p = str + chars_fit; /* The character that doesn't fit */
367 ; /* we pretend that it fits anyway */
368 else if (*p == SPACE) /* chars_fit < *len_str so this is valid */
369 p--; /* the word just fitted */
372 while (p > str && *(--p) != SPACE)
374 word_fits = (p != str || *p == SPACE);
376 /* If there was one or the first character didn't fit then */
380 /* break the line before/after that character */
381 if (!(format & (DT_RIGHT | DT_CENTER)) || *p != SPACE)
383 next_is_space = (p - str) < *len_str && *p == SPACE;
385 /* and if the next character is a space then discard it. */
386 *chars_used = *len_str;
390 /* Suppose there was none. */
393 if ((format & (DT_EDITCONTROL | DT_WORD_ELLIPSIS | DT_PATH_ELLIPSIS)) ==
396 /* break the word after the last character that fits (there must be
397 * at least one; none is caught earlier).
399 *len_str = chars_fit;
400 *chars_used = chars_fit;
402 /* FIXME - possible error. Since the next character is now removed
403 * this could make the text longer so that it no longer fits, and
404 * so we need a loop to test and shrink.
410 /* discard any trailing space. */
411 const WCHAR *e = str + *len_str;
413 while (p < e && *p != SPACE)
415 *chars_used = p - str;
416 if (p < e) /* i.e. loop failed because *p == SPACE */
419 /* include the whole word; it may be ellipsified later */
421 /* Possible optimisation; if DT_WORD_ELLIPSIS only use chars_fit+1
422 * so that it will be too long
426 /* Remeasure the string */
427 GetTextExtentExPointW (hdc, str, *len_str, 0, NULL, NULL, size);
430 /*********************************************************************
433 * Skip over the given number of characters, bearing in mind prefix
434 * substitution and the fact that a character may take more than one
435 * WCHAR (Unicode surrogates are two words long) (and there may have been
439 * new_count [out] The updated count
440 * new_str [out] The updated pointer
441 * start_count [in] The count of remaining characters corresponding to the
442 * start of the string
443 * start_str [in] The starting point of the string
444 * max [in] The number of characters actually in this segment of the
445 * string (the & counts)
446 * n [in] The number of characters to skip (if prefix then
448 * prefix [in] Apply prefix substitution
454 * There must be at least n characters in the string
455 * We need max because the "line" may have ended with a & followed by a tab
456 * or newline etc. which we don't want to swallow
459 static void TEXT_SkipChars (int *new_count, const WCHAR **new_str,
460 int start_count, const WCHAR *start_str,
461 int max, int n, int prefix)
463 /* This is specific to wide characters, MSDN doesn't say anything much
464 * about Unicode surrogates yet and it isn't clear if _wcsinc will
465 * correctly handle them so we'll just do this the easy way for now
470 const WCHAR *str_on_entry = start_str;
474 if (*start_str++ == PREFIX && max--)
477 start_count -= (start_str - str_on_entry);
484 *new_str = start_str;
485 *new_count = start_count;
488 /*********************************************************************
491 * Reanalyse the text to find the prefixed character. This is called when
492 * wordbreaking or ellipsification has shortened the string such that the
493 * previously noted prefixed character is no longer visible.
496 * str [in] The original string segment (including all characters)
497 * ns [in] The number of characters in str (including prefixes)
498 * pe [in] The ellipsification data
501 * The prefix offset within the new string segment (the one that contains the
502 * ellipses and does not contain the prefix characters) (-1 if none)
505 static int TEXT_Reprefix (const WCHAR *str, unsigned int ns,
506 const ellipsis_data *pe)
510 unsigned int n = pe->before + pe->under + pe->after;
516 /* Reached the path ellipsis; jump over it */
517 if (ns < pe->under) break;
521 if (!pe->after) break; /* Nothing after the path ellipsis */
525 if (*str++ == PREFIX)
529 result = (i < pe->before || pe->under == 0) ? i : i - pe->under + pe->len;
530 /* pe->len may be non-zero while pe_under is zero */
540 /*********************************************************************
541 * Returns true if and only if the remainder of the line is a single
542 * newline representation or nothing
545 static int remainder_is_none_or_newline (int num_chars, const WCHAR *str)
547 if (!num_chars) return TRUE;
548 if (*str != LF && *str != CR) return FALSE;
549 if (!--num_chars) return TRUE;
550 if (*str == *(str+1)) return FALSE;
552 if (*str != CR && *str != LF) return FALSE;
553 if (--num_chars) return FALSE;
557 /*********************************************************************
558 * Return next line of text from a string.
560 * hdc - handle to DC.
561 * str - string to parse into lines.
562 * count - length of str.
563 * dest - destination in which to return line.
564 * len - dest buffer size in chars on input, copied length into dest on output.
565 * width - maximum width of line in pixels.
566 * format - format type passed to DrawText.
567 * retsize - returned size of the line in pixels.
568 * last_line - TRUE if is the last line that will be processed
569 * p_retstr - If DT_MODIFYSTRING this points to a cursor in the buffer in which
570 * the return string is built.
571 * tabwidth - The width of a tab in logical coordinates
572 * pprefix_offset - Here is where we return the offset within dest of the first
573 * prefixed (underlined) character. -1 is returned if there
574 * are none. Note that there may be more; the calling code
575 * will need to use TEXT_Reprefix to find any later ones.
576 * pellip - Here is where we return the information about any ellipsification
577 * that was carried out. Note that if tabs are being expanded then
578 * this data will correspond to the last text segment actually
579 * returned in dest; by definition there would not have been any
580 * ellipsification in earlier text segments of the line.
582 * Returns pointer to next char in str after end of the line
583 * or NULL if end of str reached.
585 static const WCHAR *TEXT_NextLineW( HDC hdc, const WCHAR *str, int *count,
586 WCHAR *dest, int *len, int width, DWORD format,
587 SIZE *retsize, int last_line, WCHAR **p_retstr,
588 int tabwidth, int *pprefix_offset,
589 ellipsis_data *pellip)
595 int seg_i, seg_count, seg_j;
602 *pprefix_offset = -1;
604 /* For each text segment in the line */
610 /* Skip any leading tabs */
612 if (str[i] == TAB && (format & DT_EXPANDTABS))
614 plen = ((plen/tabwidth)+1)*tabwidth;
615 (*count)--; if (j < maxl) dest[j++] = str[i++]; else i++;
616 while (*count && str[i] == TAB)
619 (*count)--; if (j < maxl) dest[j++] = str[i++]; else i++;
624 /* Now copy as far as the next tab or cr/lf or eos */
631 (str[i] != TAB || !(format & DT_EXPANDTABS)) &&
632 ((str[i] != CR && str[i] != LF) || (format & DT_SINGLELINE)))
634 if (str[i] == PREFIX && !(format & DT_NOPREFIX) && *count > 1)
636 (*count)--, i++; /* Throw away the prefix itself */
637 if (str[i] == PREFIX)
639 /* Swallow it before we see it again */
640 (*count)--; if (j < maxl) dest[j++] = str[i++]; else i++;
642 else if (*pprefix_offset == -1 || *pprefix_offset >= seg_j)
646 /* else the previous prefix was in an earlier segment of the
647 * line; we will leave it to the drawing code to catch this
653 (*count)--; if (j < maxl) dest[j++] = str[i++]; else i++;
658 /* Measure the whole text segment and possibly WordBreak and
662 j_in_seg = j - seg_j;
663 max_seg_width = width - plen;
664 GetTextExtentExPointW (hdc, dest + seg_j, j_in_seg, max_seg_width, &num_fit, NULL, &size);
666 /* The Microsoft handling of various combinations of formats is weird.
667 * The following may very easily be incorrect if several formats are
668 * combined, and may differ between versions (to say nothing of the
669 * several bugs in the Microsoft versions).
672 line_fits = (num_fit >= j_in_seg);
673 if (!line_fits && (format & DT_WORDBREAK))
677 TEXT_WordBreak (hdc, dest+seg_j, maxl-seg_j, &j_in_seg,
678 max_seg_width, format, num_fit, &chars_used, &size);
679 line_fits = (size.cx <= max_seg_width);
680 /* and correct the counts */
681 TEXT_SkipChars (count, &s, seg_count, str+seg_i, i-seg_i,
682 chars_used, !(format & DT_NOPREFIX));
686 pellip->before = j_in_seg;
691 if (!line_fits && (format & DT_PATH_ELLIPSIS))
693 TEXT_PathEllipsify (hdc, dest + seg_j, maxl-seg_j, &j_in_seg,
694 max_seg_width, &size, *p_retstr, pellip);
695 line_fits = (size.cx <= max_seg_width);
698 /* NB we may end up ellipsifying a word-broken or path_ellipsified
700 if ((!line_fits && (format & DT_WORD_ELLIPSIS)) ||
701 ((format & DT_END_ELLIPSIS) &&
702 ((last_line && *count) ||
703 (remainder_is_none_or_newline (*count, &str[i]) && !line_fits))))
705 int before, len_ellipsis;
706 TEXT_Ellipsify (hdc, dest + seg_j, maxl-seg_j, &j_in_seg,
707 max_seg_width, &size, *p_retstr, &before, &len_ellipsis);
708 if (before > pellip->before)
710 /* We must have done a path ellipsis too */
711 pellip->after = before - pellip->before - pellip->len;
712 /* Leave the len as the length of the first ellipsis */
716 /* If we are here after a path ellipsification it must be
717 * because even the ellipsis itself didn't fit.
719 assert (pellip->under == 0 && pellip->after == 0);
720 pellip->before = before;
721 pellip->len = len_ellipsis;
722 /* pellip->after remains as zero as does
726 line_fits = (size.cx <= max_seg_width);
729 /* As an optimisation if we have ellipsified and we are expanding
730 * tabs and we haven't reached the end of the line we can skip to it
731 * now rather than going around the loop again.
733 if ((format & DT_EXPANDTABS) && ellipsified)
735 if (format & DT_SINGLELINE)
739 while ((*count) && str[i] != CR && str[i] != LF)
746 j = seg_j + j_in_seg;
747 if (*pprefix_offset >= seg_j + pellip->before)
749 *pprefix_offset = TEXT_Reprefix (str + seg_i, i - seg_i, pellip);
750 if (*pprefix_offset != -1)
751 *pprefix_offset += seg_j;
755 if (size.cy > retsize->cy)
756 retsize->cy = size.cy;
762 else if (str[i] == CR || str[i] == LF)
765 if (*count && (str[i] == CR || str[i] == LF) && str[i] != str[i-1])
771 /* else it was a Tab and we go around again */
783 /***********************************************************************
784 * TEXT_DrawUnderscore
786 * Draw the underline under the prefixed character
789 * hdc [in] The handle of the DC for drawing
790 * x [in] The x location of the line segment (logical coordinates)
791 * y [in] The y location of where the underscore should appear
792 * (logical coordinates)
793 * str [in] The text of the line segment
794 * offset [in] The offset of the underscored character within str
797 static void TEXT_DrawUnderscore (HDC hdc, int x, int y, const WCHAR *str, int offset)
805 GetTextExtentPointW (hdc, str, offset, &size);
806 prefix_x = x + size.cx;
807 GetTextExtentPointW (hdc, str, offset+1, &size);
808 prefix_end = x + size.cx - 1;
809 /* The above method may eventually be slightly wrong due to kerning etc. */
811 hpen = CreatePen (PS_SOLID, 1, GetTextColor (hdc));
812 oldPen = SelectObject (hdc, hpen);
813 MoveToEx (hdc, prefix_x, y, NULL);
814 LineTo (hdc, prefix_end, y);
815 SelectObject (hdc, oldPen);
819 /***********************************************************************
820 * DrawTextExW (USER32.@)
822 * The documentation on the extra space required for DT_MODIFYSTRING at MSDN
823 * is not quite complete, especially with regard to \0. We will assume that
824 * the returned string could have a length of up to i_count+3 and also have
825 * a trailing \0 (which would be 4 more than a not-null-terminated string but
826 * 3 more than a null-terminated string). If this is not so then increase
827 * the allowance in DrawTextExA.
829 #define MAX_STATIC_BUFFER 1024
830 INT WINAPI DrawTextExW( HDC hdc, LPWSTR str, INT i_count,
831 LPRECT rect, UINT flags, LPDRAWTEXTPARAMS dtp )
835 WCHAR *retstr, *p_retstr;
837 static WCHAR line[MAX_STATIC_BUFFER];
838 int len, lh, count=i_count;
840 int lmargin = 0, rmargin = 0;
841 int x = rect->left, y = rect->top;
842 int width = rect->right - rect->left;
845 int tabwidth /* to keep gcc happy */ = 0;
849 TRACE("%s, %d , [(%d,%d),(%d,%d)]\n", debugstr_wn (str, count), count,
850 rect->left, rect->top, rect->right, rect->bottom);
852 if (dtp) TRACE("Params: iTabLength=%d, iLeftMargin=%d, iRightMargin=%d\n",
853 dtp->iTabLength, dtp->iLeftMargin, dtp->iRightMargin);
856 if (count == -1) count = strlenW(str);
857 if (count == 0) return 0;
860 if (flags & DT_SINGLELINE)
861 flags &= ~DT_WORDBREAK;
863 GetTextMetricsW(hdc, &tm);
864 if (flags & DT_EXTERNALLEADING)
865 lh = tm.tmHeight + tm.tmExternalLeading;
871 lmargin = dtp->iLeftMargin * tm.tmAveCharWidth;
872 rmargin = dtp->iRightMargin * tm.tmAveCharWidth;
873 if (!(flags & (DT_CENTER | DT_RIGHT)))
875 dtp->uiLengthDrawn = 0; /* This param RECEIVES number of chars processed */
878 if (flags & DT_EXPANDTABS)
880 int tabstop = ((flags & DT_TABSTOP) && dtp) ? dtp->iTabLength : 8;
881 tabwidth = tm.tmAveCharWidth * tabstop;
884 if (flags & DT_CALCRECT) flags |= DT_NOCLIP;
886 if (flags & DT_MODIFYSTRING)
888 size_retstr = (count + 4) * sizeof (WCHAR);
889 retstr = HeapAlloc(GetProcessHeap(), 0, size_retstr);
890 if (!retstr) return 0;
891 memcpy (retstr, str, size_retstr);
902 len = MAX_STATIC_BUFFER;
903 last_line = !(flags & DT_NOCLIP) && y + ((flags & DT_EDITCONTROL) ? 2*lh-1 : lh) > rect->bottom;
904 strPtr = TEXT_NextLineW(hdc, strPtr, &count, line, &len, width, flags, &size, last_line, &p_retstr, tabwidth, &prefix_offset, &ellip);
906 if (flags & DT_CENTER) x = (rect->left + rect->right -
908 else if (flags & DT_RIGHT) x = rect->right - size.cx;
910 if (flags & DT_SINGLELINE)
912 if (flags & DT_VCENTER) y = rect->top +
913 (rect->bottom - rect->top) / 2 - size.cy / 2;
914 else if (flags & DT_BOTTOM) y = rect->bottom - size.cy;
917 if (!(flags & DT_CALCRECT))
919 const WCHAR *str = line;
925 if ((flags & DT_EXPANDTABS))
928 p = str; while (p < str+len && *p != TAB) p++;
930 if (len_seg != len && !GetTextExtentPointW(hdc, str, len_seg, &size))
936 if (!ExtTextOutW( hdc, xseg, y,
937 ((flags & DT_NOCLIP) ? 0 : ETO_CLIPPED) |
938 ((flags & DT_RTLREADING) ? ETO_RTLREADING : 0),
939 rect, str, len_seg, NULL )) return 0;
940 if (prefix_offset != -1 && prefix_offset < len_seg)
942 TEXT_DrawUnderscore (hdc, xseg, y + tm.tmAscent + 1, str, prefix_offset);
948 assert ((flags & DT_EXPANDTABS) && *str == TAB);
950 xseg += ((size.cx/tabwidth)+1)*tabwidth;
951 if (prefix_offset != -1)
953 if (prefix_offset < len_seg)
955 /* We have just drawn an underscore; we ought to
956 * figure out where the next one is. I am going
957 * to leave it for now until I have a better model
958 * for the line, which will make reprefixing easier.
959 * This is where ellip would be used.
964 prefix_offset -= len_seg;
969 else if (size.cx > max_width)
974 dtp->uiLengthDrawn += len;
976 while (strPtr && !last_line);
978 if (flags & DT_CALCRECT)
980 rect->right = rect->left + max_width;
983 rect->right += lmargin + rmargin;
987 memcpy (str, retstr, size_retstr);
988 HeapFree (GetProcessHeap(), 0, retstr);
990 return y - rect->top;
993 /***********************************************************************
994 * DrawTextExA (USER32.@)
996 * If DT_MODIFYSTRING is specified then there must be room for up to
997 * 4 extra characters. We take great care about just how much modified
1000 INT WINAPI DrawTextExA( HDC hdc, LPSTR str, INT count,
1001 LPRECT rect, UINT flags, LPDRAWTEXTPARAMS dtp )
1012 if (count == -1) count = strlen(str);
1013 if (!count) return 0;
1014 wcount = MultiByteToWideChar( CP_ACP, 0, str, count, NULL, 0 );
1017 if (flags & DT_MODIFYSTRING)
1022 wstr = HeapAlloc(GetProcessHeap(), 0, wmax * sizeof(WCHAR));
1025 MultiByteToWideChar( CP_ACP, 0, str, count, wstr, wcount );
1026 if (flags & DT_MODIFYSTRING)
1027 for (i=4, p=wstr+wcount; i--; p++) *p=0xFFFE;
1028 /* Initialise the extra characters so that we can see which ones
1029 * change. U+FFFE is guaranteed to be not a unicode character and
1030 * so will not be generated by DrawTextEx itself.
1032 ret = DrawTextExW( hdc, wstr, wcount, rect, flags, NULL );
1033 if (flags & DT_MODIFYSTRING)
1035 /* Unfortunately the returned string may contain multiple \0s
1036 * and so we need to measure it ourselves.
1038 for (i=4, p=wstr+wcount; i-- && *p != 0xFFFE; p++) wcount++;
1039 WideCharToMultiByte( CP_ACP, 0, wstr, wcount, str, amax, NULL, NULL );
1041 HeapFree(GetProcessHeap(), 0, wstr);
1046 /***********************************************************************
1047 * DrawTextW (USER32.@)
1049 INT WINAPI DrawTextW( HDC hdc, LPCWSTR str, INT count, LPRECT rect, UINT flags )
1053 memset (&dtp, 0, sizeof(dtp));
1054 if (flags & DT_TABSTOP)
1056 dtp.iTabLength = (flags >> 8) && 0xff;
1057 flags &= 0xffff00ff;
1059 return DrawTextExW(hdc, (LPWSTR)str, count, rect, flags, &dtp);
1062 /***********************************************************************
1063 * DrawTextA (USER32.@)
1065 INT WINAPI DrawTextA( HDC hdc, LPCSTR str, INT count, LPRECT rect, UINT flags )
1069 memset (&dtp, 0, sizeof(dtp));
1070 if (flags & DT_TABSTOP)
1072 dtp.iTabLength = (flags >> 8) && 0xff;
1073 flags &= 0xffff00ff;
1075 return DrawTextExA( hdc, (LPSTR)str, count, rect, flags, &dtp );
1078 /***********************************************************************
1079 * DrawText (USER.85)
1081 INT16 WINAPI DrawText16( HDC16 hdc, LPCSTR str, INT16 count, LPRECT16 rect, UINT16 flags )
1088 CONV_RECT16TO32( rect, &rect32 );
1089 ret = DrawTextA( hdc, str, count, &rect32, flags );
1090 CONV_RECT32TO16( &rect32, rect );
1092 else ret = DrawTextA( hdc, str, count, NULL, flags);
1097 /***********************************************************************
1099 * GrayString functions
1102 /* ### start build ### */
1103 extern WORD CALLBACK TEXT_CallTo16_word_wlw(GRAYSTRINGPROC16,WORD,LONG,WORD);
1104 /* ### stop build ### */
1106 struct gray_string_info
1108 GRAYSTRINGPROC16 proc;
1112 /* callback for 16-bit gray string proc */
1113 static BOOL CALLBACK gray_string_callback( HDC hdc, LPARAM param, INT len )
1115 const struct gray_string_info *info = (struct gray_string_info *)param;
1116 return TEXT_CallTo16_word_wlw( info->proc, hdc, info->param, len );
1119 /***********************************************************************
1122 * FIXME: The call to 16-bit code only works because the wine GDI is a 16-bit
1123 * heap and we can guarantee that the handles fit in an INT16. We have to
1124 * rethink the strategy once the migration to NT handles is complete.
1125 * We are going to get a lot of code-duplication once this migration is
1129 static BOOL TEXT_GrayString(HDC hdc, HBRUSH hb, GRAYSTRINGPROC fn, LPARAM lp, INT len,
1130 INT x, INT y, INT cx, INT cy, BOOL unicode, BOOL _32bit)
1132 HBITMAP hbm, hbmsave;
1140 if(!hdc) return FALSE;
1141 if (!(memdc = CreateCompatibleDC(hdc))) return FALSE;
1146 slen = lstrlenW((LPCWSTR)lp);
1148 slen = strlen((LPCSTR)lp);
1150 slen = strlen(MapSL(lp));
1153 if((cx == 0 || cy == 0) && slen != -1)
1157 GetTextExtentPoint32W(hdc, (LPCWSTR)lp, slen, &s);
1159 GetTextExtentPoint32A(hdc, (LPCSTR)lp, slen, &s);
1161 GetTextExtentPoint32A(hdc, MapSL(lp), slen, &s);
1162 if(cx == 0) cx = s.cx;
1163 if(cy == 0) cy = s.cy;
1166 hbm = CreateBitmap(cx, cy, 1, 1, NULL);
1167 hbmsave = (HBITMAP)SelectObject(memdc, hbm);
1168 hbsave = SelectObject( memdc, GetStockObject(BLACK_BRUSH) );
1169 PatBlt( memdc, 0, 0, cx, cy, PATCOPY );
1170 SelectObject( memdc, hbsave );
1171 SetTextColor(memdc, RGB(255, 255, 255));
1172 SetBkColor(memdc, RGB(0, 0, 0));
1173 hfsave = (HFONT)SelectObject(memdc, GetCurrentObject(hdc, OBJ_FONT));
1178 retval = fn(memdc, lp, slen);
1180 retval = (BOOL)((BOOL16)((GRAYSTRINGPROC16)fn)(HDC_16(memdc), lp, (INT16)slen));
1185 TextOutW(memdc, 0, 0, (LPCWSTR)lp, slen);
1187 TextOutA(memdc, 0, 0, (LPCSTR)lp, slen);
1189 TextOutA(memdc, 0, 0, MapSL(lp), slen);
1192 SelectObject(memdc, hfsave);
1195 * Windows doc says that the bitmap isn't grayed when len == -1 and
1196 * the callback function returns FALSE. However, testing this on
1197 * win95 showed otherwise...
1199 #ifdef GRAYSTRING_USING_DOCUMENTED_BEHAVIOUR
1200 if(retval || len != -1)
1203 hbsave = (HBRUSH)SelectObject(memdc, CACHE_GetPattern55AABrush());
1204 PatBlt(memdc, 0, 0, cx, cy, 0x000A0329);
1205 SelectObject(memdc, hbsave);
1208 if(hb) hbsave = (HBRUSH)SelectObject(hdc, hb);
1209 fg = SetTextColor(hdc, RGB(0, 0, 0));
1210 bg = SetBkColor(hdc, RGB(255, 255, 255));
1211 BitBlt(hdc, x, y, cx, cy, memdc, 0, 0, 0x00E20746);
1212 SetTextColor(hdc, fg);
1213 SetBkColor(hdc, bg);
1214 if(hb) SelectObject(hdc, hbsave);
1216 SelectObject(memdc, hbmsave);
1223 /***********************************************************************
1224 * GrayString (USER.185)
1226 BOOL16 WINAPI GrayString16( HDC16 hdc, HBRUSH16 hbr, GRAYSTRINGPROC16 gsprc,
1227 LPARAM lParam, INT16 cch, INT16 x, INT16 y,
1228 INT16 cx, INT16 cy )
1230 struct gray_string_info info;
1232 if (!gsprc) return TEXT_GrayString(hdc, hbr, NULL, lParam, cch, x, y, cx, cy, FALSE, FALSE);
1234 info.param = lParam;
1235 return TEXT_GrayString( hdc, hbr, gray_string_callback, (LPARAM)&info,
1236 cch, x, y, cx, cy, FALSE, FALSE);
1240 /***********************************************************************
1241 * GrayStringA (USER32.@)
1243 BOOL WINAPI GrayStringA( HDC hdc, HBRUSH hbr, GRAYSTRINGPROC gsprc,
1244 LPARAM lParam, INT cch, INT x, INT y,
1247 return TEXT_GrayString(hdc, hbr, gsprc, lParam, cch, x, y, cx, cy,
1252 /***********************************************************************
1253 * GrayStringW (USER32.@)
1255 BOOL WINAPI GrayStringW( HDC hdc, HBRUSH hbr, GRAYSTRINGPROC gsprc,
1256 LPARAM lParam, INT cch, INT x, INT y,
1259 return TEXT_GrayString(hdc, hbr, gsprc, lParam, cch, x, y, cx, cy,
1263 /***********************************************************************
1265 * TabbedText functions
1268 /***********************************************************************
1269 * TEXT_TabbedTextOut
1271 * Helper function for TabbedTextOut() and GetTabbedTextExtent().
1272 * Note: this doesn't work too well for text-alignment modes other
1273 * than TA_LEFT|TA_TOP. But we want bug-for-bug compatibility :-)
1275 static LONG TEXT_TabbedTextOut( HDC hdc, INT x, INT y, LPCSTR lpstr,
1276 INT count, INT cTabStops, const INT16 *lpTabPos16,
1277 const INT *lpTabPos32, INT nTabOrg,
1290 defWidth = lpTabPos32 ? *lpTabPos32 : *lpTabPos16;
1296 GetTextMetricsA( hdc, &tm );
1297 defWidth = 8 * tm.tmAveCharWidth;
1302 for (i = 0; i < count; i++)
1303 if (lpstr[i] == '\t') break;
1304 GetTextExtentPointA( hdc, lpstr, i, &extent );
1307 while ((cTabStops > 0) &&
1308 (nTabOrg + *lpTabPos32 <= x + extent.cx))
1316 while ((cTabStops > 0) &&
1317 (nTabOrg + *lpTabPos16 <= x + extent.cx))
1324 tabPos = x + extent.cx;
1325 else if (cTabStops > 0)
1326 tabPos = nTabOrg + (lpTabPos32 ? *lpTabPos32 : *lpTabPos16);
1328 tabPos = nTabOrg + ((x + extent.cx - nTabOrg) / defWidth + 1) * defWidth;
1335 r.bottom = y + extent.cy;
1336 ExtTextOutA( hdc, x, y,
1337 GetBkMode(hdc) == OPAQUE ? ETO_OPAQUE : 0,
1338 &r, lpstr, i, NULL );
1344 return MAKELONG(tabPos - start, extent.cy);
1348 /***********************************************************************
1349 * TabbedTextOut (USER.196)
1351 LONG WINAPI TabbedTextOut16( HDC16 hdc, INT16 x, INT16 y, LPCSTR lpstr,
1352 INT16 count, INT16 cTabStops,
1353 const INT16 *lpTabPos, INT16 nTabOrg )
1355 TRACE("%04x %d,%d %s %d\n", hdc, x, y, debugstr_an(lpstr,count), count );
1356 return TEXT_TabbedTextOut( hdc, x, y, lpstr, count, cTabStops,
1357 lpTabPos, NULL, nTabOrg, TRUE );
1361 /***********************************************************************
1362 * TabbedTextOutA (USER32.@)
1364 LONG WINAPI TabbedTextOutA( HDC hdc, INT x, INT y, LPCSTR lpstr, INT count,
1365 INT cTabStops, const INT *lpTabPos, INT nTabOrg )
1367 TRACE("%04x %d,%d %s %d\n", hdc, x, y, debugstr_an(lpstr,count), count );
1368 return TEXT_TabbedTextOut( hdc, x, y, lpstr, count, cTabStops,
1369 NULL, lpTabPos, nTabOrg, TRUE );
1373 /***********************************************************************
1374 * TabbedTextOutW (USER32.@)
1376 LONG WINAPI TabbedTextOutW( HDC hdc, INT x, INT y, LPCWSTR str, INT count,
1377 INT cTabStops, const INT *lpTabPos, INT nTabOrg )
1382 UINT codepage = CP_ACP; /* FIXME: get codepage of font charset */
1384 acount = WideCharToMultiByte(codepage,0,str,count,NULL,0,NULL,NULL);
1385 p = HeapAlloc( GetProcessHeap(), 0, acount );
1386 if(p == NULL) return 0; /* FIXME: is this the correct return on failure */
1387 acount = WideCharToMultiByte(codepage,0,str,count,p,acount,NULL,NULL);
1388 ret = TabbedTextOutA( hdc, x, y, p, acount, cTabStops, lpTabPos, nTabOrg );
1389 HeapFree( GetProcessHeap(), 0, p );
1394 /***********************************************************************
1395 * GetTabbedTextExtent (USER.197)
1397 DWORD WINAPI GetTabbedTextExtent16( HDC16 hdc, LPCSTR lpstr, INT16 count,
1398 INT16 cTabStops, const INT16 *lpTabPos )
1400 TRACE("%04x %s %d\n", hdc, debugstr_an(lpstr,count), count );
1401 return TEXT_TabbedTextOut( hdc, 0, 0, lpstr, count, cTabStops,
1402 lpTabPos, NULL, 0, FALSE );
1406 /***********************************************************************
1407 * GetTabbedTextExtentA (USER32.@)
1409 DWORD WINAPI GetTabbedTextExtentA( HDC hdc, LPCSTR lpstr, INT count,
1410 INT cTabStops, const INT *lpTabPos )
1412 TRACE("%04x %s %d\n", hdc, debugstr_an(lpstr,count), count );
1413 return TEXT_TabbedTextOut( hdc, 0, 0, lpstr, count, cTabStops,
1414 NULL, lpTabPos, 0, FALSE );
1418 /***********************************************************************
1419 * GetTabbedTextExtentW (USER32.@)
1421 DWORD WINAPI GetTabbedTextExtentW( HDC hdc, LPCWSTR lpstr, INT count,
1422 INT cTabStops, const INT *lpTabPos )
1427 UINT codepage = CP_ACP; /* FIXME: get codepage of font charset */
1429 acount = WideCharToMultiByte(codepage,0,lpstr,count,NULL,0,NULL,NULL);
1430 p = HeapAlloc( GetProcessHeap(), 0, acount );
1431 if(p == NULL) return 0; /* FIXME: is this the correct failure value? */
1432 acount = WideCharToMultiByte(codepage,0,lpstr,count,p,acount,NULL,NULL);
1433 ret = GetTabbedTextExtentA( hdc, p, acount, cTabStops, lpTabPos );
1434 HeapFree( GetProcessHeap(), 0, p );