Release 950319
[wine.git] / objects / text.c
blob9e3347c7452c5a5f99ae42aead00e881e3c9b4d8
1 /*
2 * text functions
4 * Copyright 1993, 1994 Alexandre Julliard
6 static char Copyright[] = "Copyright Alexandre Julliard, 1993, 1994";
7 */
8 #include <stdlib.h>
9 #include <X11/Xatom.h>
10 #include "windows.h"
11 #include "dc.h"
12 #include "gdi.h"
13 #include "callback.h"
14 #include "metafile.h"
15 #include "stddebug.h"
16 /* #define DEBUG_TEXT */
17 #include "debug.h"
19 #define TAB 9
20 #define LF 10
21 #define CR 13
22 #define SPACE 32
23 #define PREFIX 38
25 #define SWAP_INT(a,b) { int t = a; a = b; b = t; }
27 static int tabstop = 8;
28 static int tabwidth;
29 static int spacewidth;
30 static int prefix_offset;
33 static char *TEXT_NextLine(HDC hdc, char *str, int *count, char *dest,
34 int *len, int width, WORD format)
36 /* Return next line of text from a string.
38 * hdc - handle to DC.
39 * str - string to parse into lines.
40 * count - length of str.
41 * dest - destination in which to return line.
42 * len - length of resultant line in dest in chars.
43 * width - maximum width of line in pixels.
44 * format - format type passed to DrawText.
46 * Returns pointer to next char in str after end of the line
47 * or NULL if end of str reached.
50 int i = 0, j = 0, k;
51 int plen = 0;
52 int numspaces;
53 SIZE size;
54 int lasttab = 0;
55 int wb_i = 0, wb_j = 0, wb_count = 0;
57 while (*count)
59 switch (str[i])
61 case CR:
62 case LF:
63 if (!(format & DT_SINGLELINE))
65 if (str[i] == CR && str[i+1] == LF)
66 i++;
67 i++;
68 *len = j;
69 (*count)--;
70 return (&str[i]);
72 dest[j++] = str[i++];
73 if (!(format & DT_NOCLIP) || !(format & DT_NOPREFIX) ||
74 (format & DT_WORDBREAK))
76 if (!GetTextExtentPoint(hdc, &dest[j-1], 1, &size))
77 return NULL;
78 plen += size.cx;
80 break;
82 case PREFIX:
83 if (!(format & DT_NOPREFIX))
85 prefix_offset = j;
86 i++;
88 else
90 dest[j++] = str[i++];
91 if (!(format & DT_NOCLIP) || (format & DT_WORDBREAK))
93 if (!GetTextExtentPoint(hdc, &dest[j-1], 1, &size))
94 return NULL;
95 plen += size.cx;
98 break;
100 case TAB:
101 if (format & DT_EXPANDTABS)
103 wb_i = ++i;
104 wb_j = j;
105 wb_count = *count;
107 if (!GetTextExtentPoint(hdc, &dest[lasttab], j - lasttab,
108 &size))
109 return NULL;
111 numspaces = (tabwidth - size.cx) / spacewidth;
112 for (k = 0; k < numspaces; k++)
113 dest[j++] = SPACE;
114 plen += tabwidth - size.cx;
115 lasttab = wb_j + numspaces;
117 else
119 dest[j++] = str[i++];
120 if (!(format & DT_NOCLIP) || !(format & DT_NOPREFIX) ||
121 (format & DT_WORDBREAK))
123 if (!GetTextExtentPoint(hdc, &dest[j-1], 1, &size))
124 return NULL;
125 plen += size.cx;
128 break;
130 case SPACE:
131 dest[j++] = str[i++];
132 if (!(format & DT_NOCLIP) || !(format & DT_NOPREFIX) ||
133 (format & DT_WORDBREAK))
135 wb_i = i;
136 wb_j = j - 1;
137 wb_count = *count;
138 if (!GetTextExtentPoint(hdc, &dest[j-1], 1, &size))
139 return NULL;
140 plen += size.cx;
142 break;
144 default:
145 dest[j++] = str[i++];
146 if (!(format & DT_NOCLIP) || !(format & DT_NOPREFIX) ||
147 (format & DT_WORDBREAK))
149 if (!GetTextExtentPoint(hdc, &dest[j-1], 1, &size))
150 return NULL;
151 plen += size.cx;
155 (*count)--;
156 if (!(format & DT_NOCLIP) || (format & DT_WORDBREAK))
158 if (plen > width)
160 if (format & DT_WORDBREAK)
162 if (wb_j)
164 *len = wb_j;
165 *count = wb_count - 1;
166 return (&str[wb_i]);
169 else
171 *len = j;
172 return (&str[i]);
178 *len = j;
179 return NULL;
183 /***********************************************************************
184 * DrawText (USER.85)
186 int DrawText( HDC hdc, LPSTR str, int count, LPRECT rect, WORD flags )
188 SIZE size;
189 char *strPtr;
190 static char line[1024];
191 int len, lh, prefix_x, prefix_end;
192 TEXTMETRIC tm;
193 int x = rect->left, y = rect->top;
194 int width = rect->right - rect->left;
195 int max_width = 0;
197 dprintf_text(stddeb,"DrawText: '%s', %d , [(%d,%d),(%d,%d)]\n", str, count,
198 rect->left, rect->top, rect->right, rect->bottom);
200 if (count == -1) count = strlen(str);
201 strPtr = str;
203 GetTextMetrics(hdc, &tm);
204 if (flags & DT_EXTERNALLEADING)
205 lh = tm.tmHeight + tm.tmExternalLeading;
206 else
207 lh = tm.tmHeight;
209 if (flags & DT_TABSTOP)
210 tabstop = flags >> 8;
212 if (flags & DT_EXPANDTABS)
214 GetTextExtentPoint(hdc, " ", 1, &size);
215 spacewidth = size.cx;
216 GetTextExtentPoint(hdc, "o", 1, &size);
217 tabwidth = size.cx * tabstop;
222 prefix_offset = -1;
223 strPtr = TEXT_NextLine(hdc, strPtr, &count, line, &len, width, flags);
225 if (prefix_offset != -1)
227 GetTextExtentPoint(hdc, line, prefix_offset, &size);
228 prefix_x = size.cx;
229 GetTextExtentPoint(hdc, line, prefix_offset + 1, &size);
230 prefix_end = size.cx - 1;
233 if (!GetTextExtentPoint(hdc, line, len, &size)) return 0;
234 if (flags & DT_CENTER) x = (rect->left + rect->right -
235 size.cx) / 2;
236 else if (flags & DT_RIGHT) x = rect->right - size.cx;
238 if (flags & DT_SINGLELINE)
240 if (flags & DT_VCENTER) y = rect->top +
241 (rect->bottom - rect->top) / 2 - size.cy / 2;
242 else if (flags & DT_BOTTOM) y = rect->bottom - size.cy;
244 if (!(flags & DT_CALCRECT))
246 if (!ExtTextOut( hdc, x, y, (flags & DT_NOCLIP) ? 0 : ETO_CLIPPED,
247 rect, line, len, NULL )) return 0;
249 else if (size.cx > max_width)
250 max_width = size.cx;
252 if (prefix_offset != -1)
254 HPEN hpen = CreatePen( PS_SOLID, 1, GetTextColor(hdc) );
255 HPEN oldPen = SelectObject( hdc, hpen );
256 MoveTo(hdc, x + prefix_x, y + tm.tmAscent + 1 );
257 LineTo(hdc, x + prefix_end, y + tm.tmAscent + 1 );
258 SelectObject( hdc, oldPen );
259 DeleteObject( hpen );
262 y += lh;
263 if (strPtr)
265 if (!(flags & DT_NOCLIP))
267 if (y > rect->bottom - lh)
268 break;
272 while (strPtr);
273 if (flags & DT_CALCRECT)
275 rect->right = rect->left + max_width;
276 rect->bottom = y;
278 return 1;
282 /***********************************************************************
283 * ExtTextOut (GDI.351)
285 BOOL ExtTextOut( HDC hdc, short x, short y, WORD flags, LPRECT lprect,
286 LPSTR str, WORD count, LPINT lpDx )
288 int dir, ascent, descent, i;
289 XCharStruct info;
290 XFontStruct *font;
291 RECT rect;
293 DC * dc = (DC *) GDI_GetObjPtr( hdc, DC_MAGIC );
294 if (!dc)
296 dc = (DC *)GDI_GetObjPtr( hdc, METAFILE_DC_MAGIC );
297 if (!dc) return FALSE;
298 MF_TextOut( dc, x, y, str, count );
299 return TRUE;
302 if (!DC_SetupGCForText( dc )) return TRUE;
303 font = dc->u.x.font.fstruct;
305 dprintf_text(stddeb,"ExtTextOut: %d,%d '%*.*s', %d flags=%d rect=%d,%d,%d,%d\n",
306 x, y, count, count, str, count, flags,
307 lprect->left, lprect->top, lprect->right, lprect->bottom );
309 /* Setup coordinates */
311 if (dc->w.textAlign & TA_UPDATECP)
313 x = dc->w.CursPosX;
314 y = dc->w.CursPosY;
316 x = XLPTODP( dc, x );
317 y = YLPTODP( dc, y );
318 if (flags & (ETO_OPAQUE | ETO_CLIPPED)) /* There's a rectangle */
320 rect.left = XLPTODP( dc, lprect->left );
321 rect.right = XLPTODP( dc, lprect->right );
322 rect.top = YLPTODP( dc, lprect->top );
323 rect.bottom = YLPTODP( dc, lprect->bottom );
324 if (rect.right < rect.left) SWAP_INT( rect.left, rect.right );
325 if (rect.bottom < rect.top) SWAP_INT( rect.top, rect.bottom );
328 /* Draw the rectangle */
330 if (flags & ETO_OPAQUE)
332 XSetForeground( display, dc->u.x.gc, dc->w.backgroundPixel );
333 XFillRectangle( display, dc->u.x.drawable, dc->u.x.gc,
334 dc->w.DCOrgX + rect.left, dc->w.DCOrgY + rect.top,
335 rect.right-rect.left, rect.bottom-rect.top );
337 if (!count) return TRUE; /* Nothing more to do */
339 /* Compute text starting position */
341 XTextExtents( font, str, count, &dir, &ascent, &descent, &info );
342 info.width += count*dc->w.charExtra + dc->w.breakExtra*dc->w.breakCount;
343 if (lpDx) for (i = 0; i < count; i++) info.width += lpDx[i];
345 switch( dc->w.textAlign & (TA_LEFT | TA_RIGHT | TA_CENTER) )
347 case TA_LEFT:
348 if (dc->w.textAlign & TA_UPDATECP)
349 dc->w.CursPosX = XDPTOLP( dc, x + info.width );
350 break;
351 case TA_RIGHT:
352 x -= info.width;
353 if (dc->w.textAlign & TA_UPDATECP) dc->w.CursPosX = XDPTOLP( dc, x );
354 break;
355 case TA_CENTER:
356 x -= info.width / 2;
357 break;
359 switch( dc->w.textAlign & (TA_TOP | TA_BOTTOM | TA_BASELINE) )
361 case TA_TOP:
362 y += font->ascent;
363 break;
364 case TA_BOTTOM:
365 y -= font->descent;
366 break;
367 case TA_BASELINE:
368 break;
371 /* Set the clip region */
373 if (flags & ETO_CLIPPED)
375 SaveVisRgn( hdc );
376 IntersectVisRect( hdc, rect.left, rect.top, rect.right, rect.bottom );
379 /* Draw the text background if necessary */
381 if (dc->w.backgroundMode != TRANSPARENT)
383 /* If rectangle is opaque and clipped, do nothing */
384 if (!(flags & ETO_CLIPPED) || !(flags & ETO_OPAQUE))
386 /* Only draw if rectangle is not opaque or if some */
387 /* text is outside the rectangle */
388 if (!(flags & ETO_OPAQUE) ||
389 (x < rect.left) ||
390 (x + info.width >= rect.right) ||
391 (y-font->ascent < rect.top) ||
392 (y+font->descent >= rect.bottom))
394 XSetForeground( display, dc->u.x.gc, dc->w.backgroundPixel );
395 XFillRectangle( display, dc->u.x.drawable, dc->u.x.gc,
396 dc->w.DCOrgX + x,
397 dc->w.DCOrgY + y - font->ascent,
398 info.width,
399 font->ascent + font->descent );
404 /* Draw the text */
406 XSetForeground( display, dc->u.x.gc, dc->w.textPixel );
407 if (!dc->w.charExtra && !dc->w.breakExtra && !lpDx)
409 XDrawString( display, dc->u.x.drawable, dc->u.x.gc,
410 dc->w.DCOrgX + x, dc->w.DCOrgY + y, str, count );
412 else /* Now the fun begins... */
414 XTextItem *items, *pitem;
416 items = malloc( count * sizeof(XTextItem) );
417 for (i = 0, pitem = items; i < count; i++, pitem++)
419 pitem->chars = str + i;
420 pitem->nchars = 1;
421 pitem->font = None;
422 if (i == 0)
424 pitem->delta = 0;
425 continue; /* First iteration -> no delta */
427 pitem->delta = dc->w.charExtra;
428 if (str[i] == (char)dc->u.x.font.metrics.tmBreakChar)
429 pitem->delta += dc->w.breakExtra;
430 if (lpDx)
432 INT width;
433 GetCharWidth( hdc, str[i], str[i], &width );
434 pitem->delta += lpDx[i-1] - width;
437 XDrawText( display, dc->u.x.drawable, dc->u.x.gc,
438 dc->w.DCOrgX + x, dc->w.DCOrgY + y, items, count );
439 free( items );
442 /* Draw underline and strike-out if needed */
444 if (dc->u.x.font.metrics.tmUnderlined)
446 long linePos, lineWidth;
447 if (!XGetFontProperty( font, XA_UNDERLINE_POSITION, &linePos ))
448 linePos = font->descent-1;
449 if (!XGetFontProperty( font, XA_UNDERLINE_THICKNESS, &lineWidth ))
450 lineWidth = 0;
451 else if (lineWidth == 1) lineWidth = 0;
452 XSetLineAttributes( display, dc->u.x.gc, lineWidth,
453 LineSolid, CapRound, JoinBevel );
454 XDrawLine( display, dc->u.x.drawable, dc->u.x.gc,
455 dc->w.DCOrgX + x, dc->w.DCOrgY + y + linePos,
456 dc->w.DCOrgX + x + info.width, dc->w.DCOrgY + y + linePos );
458 if (dc->u.x.font.metrics.tmStruckOut)
460 long lineAscent, lineDescent;
461 if (!XGetFontProperty( font, XA_STRIKEOUT_ASCENT, &lineAscent ))
462 lineAscent = font->ascent / 3;
463 if (!XGetFontProperty( font, XA_STRIKEOUT_DESCENT, &lineDescent ))
464 lineDescent = -lineAscent;
465 XSetLineAttributes( display, dc->u.x.gc, lineAscent + lineDescent,
466 LineSolid, CapRound, JoinBevel );
467 XDrawLine( display, dc->u.x.drawable, dc->u.x.gc,
468 dc->w.DCOrgX + x, dc->w.DCOrgY + y - lineAscent,
469 dc->w.DCOrgX + x + info.width, dc->w.DCOrgY + y - lineAscent );
471 if (flags & ETO_CLIPPED) RestoreVisRgn( hdc );
472 return TRUE;
476 /***********************************************************************
477 * TextOut (GDI.33)
479 BOOL TextOut( HDC hdc, short x, short y, LPSTR str, short count )
481 return ExtTextOut( hdc, x, y, 0, NULL, str, count, NULL );
485 /***********************************************************************
486 * GrayString (USER.185)
488 BOOL GrayString(HDC hdc, HBRUSH hbr, FARPROC gsprc, LPARAM lParam,
489 INT cch, INT x, INT y, INT cx, INT cy)
491 int s, current_color;
493 if (gsprc) {
494 return CallGrayStringProc(gsprc, hdc, lParam,
495 cch ? cch : lstrlen((LPCSTR) lParam) );
496 } else {
497 current_color = GetTextColor(hdc);
498 SetTextColor(hdc, GetSysColor(COLOR_GRAYTEXT) );
499 s = TextOut(hdc, x, y, (LPSTR) lParam,
500 cch ? cch : lstrlen((LPCSTR) lParam) );
501 SetTextColor(hdc, current_color);
503 return s;
508 /***********************************************************************
509 * TEXT_TabbedTextOut
511 * Helper function for TabbedTextOut() and GetTabbedTextExtent().
512 * Note: this doesn't work too well for text-alignment modes other
513 * than TA_LEFT|TA_TOP. But we want bug-for-bug compatibility :-)
515 LONG TEXT_TabbedTextOut( HDC hdc, int x, int y, LPSTR lpstr, int count,
516 int cTabStops, LPINT lpTabPos, int nTabOrg,
517 BOOL fDisplayText)
519 WORD defWidth;
520 DWORD extent;
521 int i, tabPos = 0;
523 if (cTabStops == 1) defWidth = *lpTabPos;
524 else
526 TEXTMETRIC tm;
527 GetTextMetrics( hdc, &tm );
528 defWidth = 8 * tm.tmAveCharWidth;
531 while (count > 0)
533 for (i = 0; i < count; i++)
534 if (lpstr[i] == '\t') break;
535 extent = GetTextExtent( hdc, lpstr, i );
536 while ((cTabStops > 0) && (nTabOrg + *lpTabPos < x + LOWORD(extent)))
538 lpTabPos++;
539 cTabStops--;
541 if (lpstr[i] != '\t')
542 tabPos = x + LOWORD(extent);
543 else if (cTabStops > 0)
544 tabPos = nTabOrg + *lpTabPos;
545 else
546 tabPos = (x + LOWORD(extent) + defWidth - 1) / defWidth * defWidth;
547 if (fDisplayText)
549 RECT r;
550 SetRect( &r, x, y, tabPos, y+HIWORD(extent) );
551 ExtTextOut( hdc, x, y,
552 GetBkMode(hdc) == OPAQUE ? ETO_OPAQUE : 0,
553 &r, lpstr, i, NULL );
555 x = tabPos;
556 count -= i+1;
557 lpstr += i+1;
559 return tabPos;
563 /***********************************************************************
564 * TabbedTextOut (USER.196)
566 LONG TabbedTextOut( HDC hdc, short x, short y, LPSTR lpstr, short count,
567 short cTabStops, LPINT lpTabPos, short nTabOrg )
569 dprintf_text( stddeb, "TabbedTextOut: %x %d,%d '%*.*s' %d\n",
570 hdc, x, y, count, count, lpstr, count );
571 return TEXT_TabbedTextOut( hdc, x, y, lpstr, count, cTabStops,
572 lpTabPos, nTabOrg, TRUE );
576 /***********************************************************************
577 * GetTabbedTextExtent (USER.197)
579 DWORD GetTabbedTextExtent( HDC hdc, LPSTR lpstr, int count,
580 int cTabStops, LPINT lpTabPos )
582 dprintf_text( stddeb, "GetTabbedTextExtent: %x '%*.*s' %d\n",
583 hdc, count, count, lpstr, count );
584 return TEXT_TabbedTextOut( hdc, 0, 0, lpstr, count, cTabStops,
585 lpTabPos, 0, FALSE );