ScrollDC doesn't need to be in the graphics driver.
[wine] / dlls / x11drv / text.c
1 /*
2  * X11 graphics driver text functions
3  *
4  * Copyright 1993,1994 Alexandre Julliard
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "config.h"
22
23 #include <stdarg.h>
24 #include <stdlib.h>
25 #include <math.h>
26
27 #include "windef.h"
28 #include "winbase.h"
29 #include "winnls.h"
30 #include "wownt32.h"
31 #include "gdi.h"
32 #include "x11font.h"
33 #include "bitmap.h"
34 #include "wine/debug.h"
35
36 WINE_DEFAULT_DEBUG_CHANNEL(text);
37
38 #define SWAP_INT(a,b)  { int t = a; a = b; b = t; }
39 #define IROUND(x) (int)((x)>0? (x)+0.5 : (x) - 0.5)
40
41
42 /***********************************************************************
43  *           X11DRV_ExtTextOut
44  */
45 BOOL
46 X11DRV_ExtTextOut( X11DRV_PDEVICE *physDev, INT x, INT y, UINT flags,
47                    const RECT *lprect, LPCWSTR wstr, UINT count,
48                    const INT *lpDx )
49 {
50     int                 i;
51     fontObject*         pfo;
52     INT                 width, ascent, descent, xwidth, ywidth;
53     XFontStruct*        font;
54     RECT                rect;
55     char                dfBreakChar, lfUnderline, lfStrikeOut;
56     BOOL                rotated = FALSE;
57     XChar2b             *str2b = NULL;
58     BOOL                dibUpdateFlag = FALSE;
59     BOOL                result = TRUE;
60     POINT               pt;
61     DC *dc = physDev->dc;
62
63     if(dc->gdiFont)
64         return X11DRV_XRender_ExtTextOut(physDev, x, y, flags, lprect, wstr, count,
65                                          lpDx);
66
67
68     if (!X11DRV_SetupGCForText( physDev )) return TRUE;
69
70     pfo = XFONT_GetFontObject( physDev->font );
71     font = pfo->fs;
72
73     if (pfo->lf.lfEscapement && pfo->lpX11Trans)
74         rotated = TRUE;
75     dfBreakChar = (char)pfo->fi->df.dfBreakChar;
76     lfUnderline = (pfo->fo_flags & FO_SYNTH_UNDERLINE) ? 1 : 0;
77     lfStrikeOut = (pfo->fo_flags & FO_SYNTH_STRIKEOUT) ? 1 : 0;
78
79     TRACE("hdc=%p df=%04x %d,%d %s, %d  flags=%d lpDx=%p\n",
80           dc->hSelf, (UINT16)(physDev->font), x, y,
81           debugstr_wn (wstr, count), count, flags, lpDx);
82
83     /* some strings sent here end in a newline for whatever reason.  I have no
84        clue what the right treatment should be in general, but ignoring
85        terminating newlines seems ok.  MW, April 1998.  */
86     if (count > 0 && wstr[count - 1] == '\n') count--;
87
88     if (lprect != NULL) TRACE("\trect=(%ld,%ld - %ld,%ld)\n",
89                                      lprect->left, lprect->top,
90                                      lprect->right, lprect->bottom );
91       /* Setup coordinates */
92
93     if (dc->textAlign & TA_UPDATECP)
94     {
95         x = dc->CursPosX;
96         y = dc->CursPosY;
97     }
98
99     if (flags & (ETO_OPAQUE | ETO_CLIPPED))  /* there's a rectangle */
100     {
101         if (!lprect)  /* not always */
102         {
103             SIZE sz;
104             if (flags & ETO_CLIPPED)  /* Can't clip with no rectangle */
105               return FALSE;
106             if (!X11DRV_GetTextExtentPoint( physDev, wstr, count, &sz ))
107               return FALSE;
108             rect.left   = x;
109             rect.right  = x + sz.cx;
110             rect.top    = y;
111             rect.bottom = y + sz.cy;
112         }
113         else
114         {
115             rect = *lprect;
116         }
117         LPtoDP(physDev->hdc, (POINT*)&rect, 2);
118
119         if (rect.right < rect.left) SWAP_INT( rect.left, rect.right );
120         if (rect.bottom < rect.top) SWAP_INT( rect.top, rect.bottom );
121     }
122
123     pt.x = x;
124     pt.y = y;
125     LPtoDP(physDev->hdc, &pt, 1);
126     x = pt.x;
127     y = pt.y;
128
129     TRACE("\treal coord: x=%i, y=%i, rect=(%ld,%ld - %ld,%ld)\n",
130                           x, y, rect.left, rect.top, rect.right, rect.bottom);
131
132       /* Draw the rectangle */
133
134     if (flags & ETO_OPAQUE)
135     {
136         X11DRV_LockDIBSection( physDev, DIB_Status_GdiMod, FALSE );
137         dibUpdateFlag = TRUE;
138         wine_tsx11_lock();
139         XSetForeground( gdi_display, physDev->gc, physDev->backgroundPixel );
140         XFillRectangle( gdi_display, physDev->drawable, physDev->gc,
141                         physDev->org.x + rect.left, physDev->org.y + rect.top,
142                         rect.right-rect.left, rect.bottom-rect.top );
143         wine_tsx11_unlock();
144     }
145     if (!count) goto END;  /* Nothing more to do */
146
147       /* Compute text starting position */
148
149     if (lpDx) /* have explicit character cell x offsets in logical coordinates */
150     {
151         for (i = width = 0; i < count; i++) width += lpDx[i];
152         width = INTERNAL_XWSTODS(dc, width);
153     }
154     else
155     {
156         SIZE sz;
157         if (!X11DRV_GetTextExtentPoint( physDev, wstr, count, &sz ))
158         {
159             result = FALSE;
160             goto END;
161         }
162         width = INTERNAL_XWSTODS(dc, sz.cx);
163     }
164     ascent = pfo->lpX11Trans ? pfo->lpX11Trans->ascent : font->ascent;
165     descent = pfo->lpX11Trans ? pfo->lpX11Trans->descent : font->descent;
166     xwidth = pfo->lpX11Trans ? width * pfo->lpX11Trans->a /
167       pfo->lpX11Trans->pixelsize : width;
168     ywidth = pfo->lpX11Trans ? width * pfo->lpX11Trans->b /
169       pfo->lpX11Trans->pixelsize : 0;
170
171     switch( dc->textAlign & (TA_LEFT | TA_RIGHT | TA_CENTER) )
172     {
173       case TA_LEFT:
174           if (dc->textAlign & TA_UPDATECP) {
175               pt.x = x + xwidth;
176               pt.y = y - ywidth;
177               DPtoLP(physDev->hdc, &pt, 1);
178               dc->CursPosX = pt.x;
179               dc->CursPosY = pt.y;
180           }
181           break;
182       case TA_RIGHT:
183           x -= xwidth;
184           y += ywidth;
185           if (dc->textAlign & TA_UPDATECP) {
186               pt.x = x;
187               pt.y = y;
188               DPtoLP(physDev->hdc, &pt, 1);
189               dc->CursPosX = pt.x;
190               dc->CursPosY = pt.y;
191           }
192           break;
193       case TA_CENTER:
194           x -= xwidth / 2;
195           y += ywidth / 2;
196           break;
197     }
198
199     switch( dc->textAlign & (TA_TOP | TA_BOTTOM | TA_BASELINE) )
200     {
201       case TA_TOP:
202           x -= pfo->lpX11Trans ? ascent * pfo->lpX11Trans->c /
203             pfo->lpX11Trans->pixelsize : 0;
204           y += pfo->lpX11Trans ? ascent * pfo->lpX11Trans->d /
205             pfo->lpX11Trans->pixelsize : ascent;
206           break;
207       case TA_BOTTOM:
208           x += pfo->lpX11Trans ? descent * pfo->lpX11Trans->c /
209             pfo->lpX11Trans->pixelsize : 0;
210           y -= pfo->lpX11Trans ? descent * pfo->lpX11Trans->d /
211             pfo->lpX11Trans->pixelsize : descent;
212           break;
213       case TA_BASELINE:
214           break;
215     }
216
217       /* Set the clip region */
218
219     if (flags & ETO_CLIPPED)
220     {
221         SaveVisRgn16( HDC_16(dc->hSelf) );
222         IntersectVisRect16( HDC_16(dc->hSelf), lprect->left, lprect->top, lprect->right, lprect->bottom );
223     }
224
225       /* Draw the text background if necessary */
226
227     if (!dibUpdateFlag)
228     {
229         X11DRV_LockDIBSection( physDev, DIB_Status_GdiMod, FALSE );
230         dibUpdateFlag = TRUE;
231     }
232
233     if (GetBkMode( physDev->hdc ) != TRANSPARENT)
234     {
235           /* If rectangle is opaque and clipped, do nothing */
236         if (!(flags & ETO_CLIPPED) || !(flags & ETO_OPAQUE))
237         {
238               /* Only draw if rectangle is not opaque or if some */
239               /* text is outside the rectangle */
240             if (!(flags & ETO_OPAQUE) ||
241                 (x < rect.left) ||
242                 (x + width >= rect.right) ||
243                 (y - ascent < rect.top) ||
244                 (y + descent >= rect.bottom))
245             {
246                 wine_tsx11_lock();
247                 XSetForeground( gdi_display, physDev->gc, physDev->backgroundPixel );
248                 XFillRectangle( gdi_display, physDev->drawable, physDev->gc,
249                                 physDev->org.x + x, physDev->org.y + y - ascent,
250                                 width, ascent + descent );
251                 wine_tsx11_unlock();
252             }
253         }
254     }
255
256     /* Draw the text (count > 0 verified) */
257     if (!(str2b = X11DRV_cptable[pfo->fi->cptable].punicode_to_char2b( pfo, wstr, count )))
258         goto FAIL;
259
260     wine_tsx11_lock();
261     XSetForeground( gdi_display, physDev->gc, physDev->textPixel );
262     wine_tsx11_unlock();
263     if(!rotated)
264     {
265       if (!dc->charExtra && !dc->breakExtra && !lpDx)
266       {
267         X11DRV_cptable[pfo->fi->cptable].pDrawString(
268                 pfo, gdi_display, physDev->drawable, physDev->gc,
269                 physDev->org.x + x, physDev->org.y + y, str2b, count );
270       }
271       else  /* Now the fun begins... */
272       {
273         XTextItem16 *items, *pitem;
274         int delta;
275
276         /* allocate max items */
277
278         pitem = items = HeapAlloc( GetProcessHeap(), 0,
279                                    count * sizeof(XTextItem16) );
280         if(items == NULL) goto FAIL;
281         delta = i = 0;
282         if( lpDx ) /* explicit character widths */
283         {
284             long ve_we;
285             unsigned short err = 0;
286
287             ve_we = (LONG)(dc->xformWorld2Vport.eM11 * 0x10000);
288
289             while (i < count)
290             {
291                 /* initialize text item with accumulated delta */
292
293                 long sum;
294                 long fSum;
295                 sum = 0;
296                 pitem->chars  = str2b + i;
297                 pitem->delta  = delta;
298                 pitem->nchars = 0;
299                 pitem->font   = None;
300                 delta = 0;
301
302                 /* add characters to the same XTextItem
303                  * until new delta becomes non-zero */
304
305                 do
306                 {
307                     sum += lpDx[i];
308                     fSum = sum*ve_we+err;
309                     delta = (short)HIWORD(fSum)
310                       - X11DRV_cptable[pfo->fi->cptable].pTextWidth(
311                                                 pfo, pitem->chars, pitem->nchars+1);
312                     pitem->nchars++;
313                 } while ((++i < count) && !delta);
314                 pitem++;
315                 err = LOWORD(fSum);
316            }
317         }
318         else /* charExtra or breakExtra */
319         {
320             while (i < count)
321             {
322                 pitem->chars  = str2b + i;
323                 pitem->delta  = delta;
324                 pitem->nchars = 0;
325                 pitem->font   = None;
326                 delta = 0;
327
328                 do
329                 {
330                     delta += dc->charExtra;
331                     if (str2b[i].byte2 == (char)dfBreakChar)
332                       delta += dc->breakExtra;
333                     pitem->nchars++;
334                 } while ((++i < count) && !delta);
335                 pitem++;
336             }
337         }
338
339         X11DRV_cptable[pfo->fi->cptable].pDrawText( pfo, gdi_display,
340                 physDev->drawable, physDev->gc,
341                 physDev->org.x + x, physDev->org.y + y, items, pitem - items );
342         HeapFree( GetProcessHeap(), 0, items );
343       }
344     }
345     else /* rotated */
346     {
347       /* have to render character by character. */
348       double offset = 0.0;
349       int i;
350
351       for (i=0; i<count; i++)
352       {
353         int char_metric_offset = str2b[i].byte2 + (str2b[i].byte1 << 8)
354           - font->min_char_or_byte2;
355         int x_i = IROUND((double) (physDev->org.x + x) + offset *
356                          pfo->lpX11Trans->a / pfo->lpX11Trans->pixelsize );
357         int y_i = IROUND((double) (physDev->org.y + y) - offset *
358                          pfo->lpX11Trans->b / pfo->lpX11Trans->pixelsize );
359
360         X11DRV_cptable[pfo->fi->cptable].pDrawString(
361                 pfo, gdi_display, physDev->drawable, physDev->gc,
362                 x_i, y_i, &str2b[i], 1);
363         if (lpDx)
364         {
365           offset += INTERNAL_XWSTODS(dc, lpDx[i]);
366         }
367         else
368         {
369           offset += (double) (font->per_char ?
370                               font->per_char[char_metric_offset].attributes:
371                               font->min_bounds.attributes)
372                           * pfo->lpX11Trans->pixelsize / 1000.0;
373           offset += dc->charExtra;
374           if (str2b[i].byte2 == (char)dfBreakChar)
375             offset += dc->breakExtra;
376         }
377       }
378     }
379     HeapFree( GetProcessHeap(), 0, str2b );
380
381       /* Draw underline and strike-out if needed */
382
383     wine_tsx11_lock();
384     if (lfUnderline)
385     {
386         long linePos, lineWidth;
387
388         if (!XGetFontProperty( font, XA_UNDERLINE_POSITION, &linePos ))
389             linePos = descent - 1;
390         if (!XGetFontProperty( font, XA_UNDERLINE_THICKNESS, &lineWidth ))
391             lineWidth = 0;
392         else if (lineWidth == 1) lineWidth = 0;
393         XSetLineAttributes( gdi_display, physDev->gc, lineWidth,
394                             LineSolid, CapRound, JoinBevel );
395         XDrawLine( gdi_display, physDev->drawable, physDev->gc,
396                    physDev->org.x + x, physDev->org.y + y + linePos,
397                    physDev->org.x + x + width, physDev->org.y + y + linePos );
398     }
399     if (lfStrikeOut)
400     {
401         long lineAscent, lineDescent;
402         if (!XGetFontProperty( font, XA_STRIKEOUT_ASCENT, &lineAscent ))
403             lineAscent = ascent / 2;
404         if (!XGetFontProperty( font, XA_STRIKEOUT_DESCENT, &lineDescent ))
405             lineDescent = -lineAscent * 2 / 3;
406         XSetLineAttributes( gdi_display, physDev->gc, lineAscent + lineDescent,
407                             LineSolid, CapRound, JoinBevel );
408         XDrawLine( gdi_display, physDev->drawable, physDev->gc,
409                    physDev->org.x + x, physDev->org.y + y - lineAscent,
410                    physDev->org.x + x + width, physDev->org.y + y - lineAscent );
411     }
412     wine_tsx11_unlock();
413
414     if (flags & ETO_CLIPPED) RestoreVisRgn16( HDC_16(dc->hSelf) );
415     goto END;
416
417 FAIL:
418     if(str2b != NULL) HeapFree( GetProcessHeap(), 0, str2b );
419     result = FALSE;
420
421 END:
422     if (dibUpdateFlag) X11DRV_UnlockDIBSection( physDev, TRUE );
423     return result;
424 }
425
426
427 /***********************************************************************
428  *           X11DRV_GetTextExtentPoint
429  */
430 BOOL X11DRV_GetTextExtentPoint( X11DRV_PDEVICE *physDev, LPCWSTR str, INT count,
431                                   LPSIZE size )
432 {
433     DC *dc = physDev->dc;
434     fontObject* pfo = XFONT_GetFontObject( physDev->font );
435
436     TRACE("%s %d\n", debugstr_wn(str,count), count);
437     if( pfo ) {
438         XChar2b *p = X11DRV_cptable[pfo->fi->cptable].punicode_to_char2b( pfo, str, count );
439         if (!p) return FALSE;
440         if( !pfo->lpX11Trans ) {
441             int dir, ascent, descent;
442             int info_width;
443             X11DRV_cptable[pfo->fi->cptable].pTextExtents( pfo, p,
444                                 count, &dir, &ascent, &descent, &info_width );
445
446           size->cx = fabs((FLOAT)(info_width + dc->breakRem + count *
447                                   dc->charExtra) * dc->xformVport2World.eM11);
448           size->cy = fabs((FLOAT)(pfo->fs->ascent + pfo->fs->descent) *
449                           dc->xformVport2World.eM22);
450         } else {
451             INT i;
452             float x = 0.0, y = 0.0;
453             /* FIXME: Deal with *_char_or_byte2 != 0 situations */
454             for(i = 0; i < count; i++) {
455                 x += pfo->fs->per_char ?
456            pfo->fs->per_char[p[i].byte2 - pfo->fs->min_char_or_byte2].attributes :
457            pfo->fs->min_bounds.attributes;
458             }
459             y = pfo->lpX11Trans->RAW_ASCENT + pfo->lpX11Trans->RAW_DESCENT;
460             TRACE("x = %f y = %f\n", x, y);
461             x *= pfo->lpX11Trans->pixelsize / 1000.0;
462             y *= pfo->lpX11Trans->pixelsize / 1000.0;
463             size->cx = fabs((x + dc->breakRem + count * dc->charExtra) *
464                             dc->xformVport2World.eM11);
465             size->cy = fabs(y * dc->xformVport2World.eM22);
466         }
467         size->cx *= pfo->rescale;
468         size->cy *= pfo->rescale;
469         HeapFree( GetProcessHeap(), 0, p );
470         return TRUE;
471     }
472     return FALSE;
473 }