Added tracking support and fixed loading of resource strings.
[wine] / include / gdi.h
1 /*
2  * GDI definitions
3  *
4  * Copyright 1993 Alexandre Julliard
5  */
6
7 #ifndef __WINE_GDI_H
8 #define __WINE_GDI_H
9
10 #include "windows.h"
11 #include "ldt.h"
12 #include "local.h"
13 #include "x11drv.h"
14 #include "path.h"
15 #include <math.h>
16
17   /* GDI objects magic numbers */
18 #define PEN_MAGIC             0x4f47
19 #define BRUSH_MAGIC           0x4f48
20 #define FONT_MAGIC            0x4f49
21 #define PALETTE_MAGIC         0x4f4a
22 #define BITMAP_MAGIC          0x4f4b
23 #define REGION_MAGIC          0x4f4c
24 #define DC_MAGIC              0x4f4d
25 #define DISABLED_DC_MAGIC     0x4f4e
26 #define META_DC_MAGIC         0x4f4f
27 #define METAFILE_MAGIC        0x4f50
28 #define METAFILE_DC_MAGIC     0x4f51
29 #define MAGIC_DONTCARE        0xffff
30
31 typedef struct tagGDIOBJHDR
32 {
33     HANDLE16    hNext;
34     WORD        wMagic;
35     DWORD       dwCount;
36 } GDIOBJHDR;
37
38
39 #define OBJ_PEN             1 
40 #define OBJ_BRUSH           2 
41 #define OBJ_DC              3 
42 #define OBJ_METADC          4 
43 #define OBJ_PAL             5 
44 #define OBJ_FONT            6 
45 #define OBJ_BITMAP          7 
46 #define OBJ_REGION          8 
47 #define OBJ_METAFILE        9 
48 #define OBJ_MEMDC           10 
49 #define OBJ_EXTPEN          11 
50 #define OBJ_ENHMETADC       12 
51 #define OBJ_ENHMETAFILE     13 
52
53
54 typedef struct tagDeviceCaps
55 {
56     WORD   version;       /*   0: driver version */
57     WORD   technology;    /*   2: device technology */
58     WORD   horzSize;      /*   4: width of display in mm */
59     WORD   vertSize;      /*   6: height of display in mm */
60     WORD   horzRes;       /*   8: width of display in pixels */
61     WORD   vertRes;       /*  10: width of display in pixels */
62     WORD   bitsPixel;     /*  12: bits per pixel */
63     WORD   planes;        /*  14: color planes */
64     WORD   numBrushes;    /*  16: device-specific brushes */
65     WORD   numPens;       /*  18: device-specific pens */
66     WORD   numMarkers;    /*  20: device-specific markers */
67     WORD   numFonts;      /*  22: device-specific fonts */
68     WORD   numColors;     /*  24: size of color table */
69     WORD   pdeviceSize;   /*  26: size of PDEVICE structure */
70     WORD   curveCaps;     /*  28: curve capabilities */
71     WORD   lineCaps;      /*  30: line capabilities */
72     WORD   polygonalCaps; /*  32: polygon capabilities */
73     WORD   textCaps;      /*  34: text capabilities */
74     WORD   clipCaps;      /*  36: clipping capabilities */
75     WORD   rasterCaps;    /*  38: raster capabilities */
76     WORD   aspectX;       /*  40: relative width of device pixel */
77     WORD   aspectY;       /*  42: relative height of device pixel */
78     WORD   aspectXY;      /*  44: relative diagonal width of device pixel */
79     WORD   pad1[21];      /*  46-86: reserved */
80     WORD   logPixelsX;    /*  88: pixels / logical X inch */
81     WORD   logPixelsY;    /*  90: pixels / logical Y inch */
82     WORD   pad2[6];       /*  92-102: reserved */
83     WORD   sizePalette;   /* 104: entries in system palette */
84     WORD   numReserved;   /* 106: reserved entries */
85     WORD   colorRes;      /* 108: color resolution */    
86 } DeviceCaps;
87
88
89   /* Device independent DC information */
90 typedef struct
91 {
92     int           flags;
93     const DeviceCaps *devCaps;
94
95     HRGN16        hClipRgn;     /* Clip region (may be 0) */
96     HRGN16        hVisRgn;      /* Visible region (must never be 0) */
97     HRGN16        hGCClipRgn;   /* GC clip region (ClipRgn AND VisRgn) */
98     HPEN16        hPen;
99     HBRUSH16      hBrush;
100     HFONT16       hFont;
101     HBITMAP16     hBitmap;
102     HBITMAP16     hFirstBitmap; /* Bitmap selected at creation of the DC */
103     HANDLE16      hDevice;
104     HPALETTE16    hPalette;
105     
106     GdiPath       path;
107
108     WORD          ROPmode;
109     WORD          polyFillMode;
110     WORD          stretchBltMode;
111     WORD          relAbsMode;
112     WORD          backgroundMode;
113     COLORREF      backgroundColor;
114     COLORREF      textColor;
115     short         brushOrgX;
116     short         brushOrgY;
117
118     WORD          textAlign;         /* Text alignment from SetTextAlign() */
119     short         charExtra;         /* Spacing from SetTextCharacterExtra() */
120     short         breakTotalExtra;   /* Total extra space for justification */
121     short         breakCount;        /* Break char. count */
122     short         breakExtra;        /* breakTotalExtra / breakCount */
123     short         breakRem;          /* breakTotalExtra % breakCount */
124
125     BYTE          bitsPerPixel;
126
127     INT32         MapMode;
128     INT32         GraphicsMode;      /* Graphics mode */
129     INT32         DCOrgX;            /* DC origin */
130     INT32         DCOrgY;
131     FARPROC16     lpfnPrint;         /* AbortProc for Printing */
132     INT32         CursPosX;          /* Current position */
133     INT32         CursPosY;
134     INT32         ArcDirection;
135     XFORM         xformWorld2Wnd;    /* World-to-window transformation */
136     XFORM         xformWorld2Vport;  /* World-to-viewport transformation */
137     XFORM         xformVport2World;  /* Inverse of the above transformation */
138     BOOL32        vport2WorldValid;  /* Is xformVport2World valid? */
139 } WIN_DC_INFO;
140
141 typedef X11DRV_PDEVICE X_DC_INFO;  /* Temporary */
142
143 typedef struct tagDC
144 {
145     GDIOBJHDR      header;
146     HDC32          hSelf;            /* Handle to this DC */
147     const struct tagDC_FUNCS *funcs; /* DC function table */
148     void          *physDev;          /* Physical device (driver-specific) */
149     INT32          saveLevel;
150     DWORD          dwHookData;
151     FARPROC16      hookProc;
152
153     INT32          wndOrgX;          /* Window origin */
154     INT32          wndOrgY;
155     INT32          wndExtX;          /* Window extent */
156     INT32          wndExtY;
157     INT32          vportOrgX;        /* Viewport origin */
158     INT32          vportOrgY;
159     INT32          vportExtX;        /* Viewport extent */
160     INT32          vportExtY;
161
162     WIN_DC_INFO w;
163     union
164     {
165         X_DC_INFO x;
166         /* other devices (e.g. printer) */
167     } u;
168 } DC;
169
170 /* Device functions for the Wine driver interface */
171 typedef struct tagDC_FUNCS
172 {
173     BOOL32     (*pArc)(DC*,INT32,INT32,INT32,INT32,INT32,INT32,INT32,INT32);
174     BOOL32     (*pBitBlt)(DC*,INT32,INT32,INT32,INT32,DC*,INT32,INT32,DWORD);
175     BOOL32     (*pChord)(DC*,INT32,INT32,INT32,INT32,INT32,INT32,INT32,INT32);
176     BOOL32     (*pCreateDC)(DC*,LPCSTR,LPCSTR,LPCSTR,const DEVMODE16*);
177     BOOL32     (*pDeleteDC)(DC*);
178     BOOL32     (*pDeleteObject)(HGDIOBJ16);
179     BOOL32     (*pEllipse)(DC*,INT32,INT32,INT32,INT32);
180     BOOL32     (*pEnumDeviceFonts)(DC*,LPLOGFONT16,DEVICEFONTENUMPROC,LPARAM);
181     INT32      (*pEscape)(DC*,INT32,INT32,SEGPTR,SEGPTR);
182     INT32      (*pExcludeClipRect)(DC*,INT32,INT32,INT32,INT32);
183     INT32      (*pExcludeVisRect)(DC*,INT32,INT32,INT32,INT32);
184     BOOL32     (*pExtFloodFill)(DC*,INT32,INT32,COLORREF,UINT32);
185     BOOL32     (*pExtTextOut)(DC*,INT32,INT32,UINT32,const RECT32*,LPCSTR,UINT32,const INT32*);
186     BOOL32     (*pGetCharWidth)(DC*,UINT32,UINT32,LPINT32);
187     COLORREF   (*pGetPixel)(DC*,INT32,INT32);
188     BOOL32     (*pGetTextExtentPoint)(DC*,LPCSTR,INT32,LPSIZE32);
189     BOOL32     (*pGetTextMetrics)(DC*,TEXTMETRIC32A*);
190     INT32      (*pIntersectClipRect)(DC*,INT32,INT32,INT32,INT32);
191     INT32      (*pIntersectVisRect)(DC*,INT32,INT32,INT32,INT32);
192     BOOL32     (*pLineTo)(DC*,INT32,INT32);
193     BOOL32     (*pMoveToEx)(DC*,INT32,INT32,LPPOINT32);
194     INT32      (*pOffsetClipRgn)(DC*,INT32,INT32);
195     BOOL32     (*pOffsetViewportOrg)(DC*,INT32,INT32);
196     BOOL32     (*pOffsetWindowOrg)(DC*,INT32,INT32);
197     BOOL32     (*pPaintRgn)(DC*,HRGN32);
198     BOOL32     (*pPatBlt)(DC*,INT32,INT32,INT32,INT32,DWORD);
199     BOOL32     (*pPie)(DC*,INT32,INT32,INT32,INT32,INT32,INT32,INT32,INT32);
200     BOOL32     (*pPolyPolygon)(DC*,LPPOINT32,LPINT32,UINT32);
201     BOOL32     (*pPolyPolyline)(DC*,LPPOINT32,LPDWORD,DWORD);
202     BOOL32     (*pPolygon)(DC*,LPPOINT32,INT32);
203     BOOL32     (*pPolyline)(DC*,LPPOINT32,INT32);
204     BOOL32     (*pPolyBezier)(DC*,POINT32, LPPOINT32,DWORD);
205     UINT32     (*pRealizePalette)(DC*);
206     BOOL32     (*pRectangle)(DC*,INT32,INT32,INT32,INT32);
207     BOOL32     (*pRestoreDC)(DC*,INT32);
208     BOOL32     (*pRoundRect)(DC*,INT32,INT32,INT32,INT32,INT32,INT32);
209     INT32      (*pSaveDC)(DC*);
210     BOOL32     (*pScaleViewportExt)(DC*,INT32,INT32,INT32,INT32);
211     BOOL32     (*pScaleWindowExt)(DC*,INT32,INT32,INT32,INT32);
212     INT32      (*pSelectClipRgn)(DC*,HRGN32);
213     HANDLE32   (*pSelectObject)(DC*,HANDLE32);
214     HPALETTE32 (*pSelectPalette)(DC*,HPALETTE32,BOOL32);
215     COLORREF   (*pSetBkColor)(DC*,COLORREF);
216     WORD       (*pSetBkMode)(DC*,WORD);
217     VOID       (*pSetDeviceClipping)(DC*);
218     INT32      (*pSetDIBitsToDevice)(DC*,INT32,INT32,DWORD,DWORD,INT32,INT32,UINT32,UINT32,LPCVOID,const BITMAPINFO*,UINT32);
219     INT32      (*pSetMapMode)(DC*,INT32);
220     DWORD      (*pSetMapperFlags)(DC*,DWORD);
221     COLORREF   (*pSetPixel)(DC*,INT32,INT32,COLORREF);
222     WORD       (*pSetPolyFillMode)(DC*,WORD);
223     WORD       (*pSetROP2)(DC*,WORD);
224     WORD       (*pSetRelAbs)(DC*,WORD);
225     WORD       (*pSetStretchBltMode)(DC*,WORD);
226     WORD       (*pSetTextAlign)(DC*,WORD);
227     INT32      (*pSetTextCharacterExtra)(DC*,INT32);
228     DWORD      (*pSetTextColor)(DC*,DWORD);
229     INT32      (*pSetTextJustification)(DC*,INT32,INT32);
230     BOOL32     (*pSetViewportExt)(DC*,INT32,INT32);
231     BOOL32     (*pSetViewportOrg)(DC*,INT32,INT32);
232     BOOL32     (*pSetWindowExt)(DC*,INT32,INT32);
233     BOOL32     (*pSetWindowOrg)(DC*,INT32,INT32);
234     BOOL32     (*pStretchBlt)(DC*,INT32,INT32,INT32,INT32,DC*,INT32,INT32,INT32,INT32,DWORD);
235     INT32      (*pStretchDIBits)(DC*,INT32,INT32,INT32,INT32,INT32,INT32,INT32,INT32,LPSTR,LPBITMAPINFO,WORD,DWORD);
236 } DC_FUNCTIONS;
237
238   /* DC hook codes */
239 #define DCHC_INVALIDVISRGN      0x0001
240 #define DCHC_DELETEDC           0x0002
241
242 #define DCHF_INVALIDATEVISRGN   0x0001
243 #define DCHF_VALIDATEVISRGN     0x0002
244
245   /* DC flags */
246 #define DC_MEMORY     0x0001   /* It is a memory DC */
247 #define DC_SAVED      0x0002   /* It is a saved DC */
248 #define DC_DIRTY      0x0004   /* hVisRgn has to be updated */
249 #define DC_THUNKHOOK  0x0008   /* DC hook is in the 16-bit code */ 
250
251   /* Last 32 bytes are reserved for stock object handles */
252 #define GDI_HEAP_SIZE               0xffe0
253
254   /* First handle possible for stock objects (must be >= GDI_HEAP_SIZE) */
255 #define FIRST_STOCK_HANDLE          GDI_HEAP_SIZE
256
257   /* Stock objects handles */
258
259 #define NB_STOCK_OBJECTS          (DEFAULT_GUI_FONT + 1)
260
261 #define STOCK_WHITE_BRUSH       ((HBRUSH16)(FIRST_STOCK_HANDLE+WHITE_BRUSH))
262 #define STOCK_LTGRAY_BRUSH      ((HBRUSH16)(FIRST_STOCK_HANDLE+LTGRAY_BRUSH))
263 #define STOCK_GRAY_BRUSH        ((HBRUSH16)(FIRST_STOCK_HANDLE+GRAY_BRUSH))
264 #define STOCK_DKGRAY_BRUSH      ((HBRUSH16)(FIRST_STOCK_HANDLE+DKGRAY_BRUSH))
265 #define STOCK_BLACK_BRUSH       ((HBRUSH16)(FIRST_STOCK_HANDLE+BLACK_BRUSH))
266 #define STOCK_NULL_BRUSH        ((HBRUSH16)(FIRST_STOCK_HANDLE+NULL_BRUSH))
267 #define STOCK_HOLLOW_BRUSH      ((HBRUSH16)(FIRST_STOCK_HANDLE+HOLLOW_BRUSH))
268 #define STOCK_WHITE_PEN         ((HPEN16)(FIRST_STOCK_HANDLE+WHITE_PEN))
269 #define STOCK_BLACK_PEN         ((HPEN16)(FIRST_STOCK_HANDLE+BLACK_PEN))
270 #define STOCK_NULL_PEN          ((HPEN16)(FIRST_STOCK_HANDLE+NULL_PEN))
271 #define STOCK_OEM_FIXED_FONT    ((HFONT16)(FIRST_STOCK_HANDLE+OEM_FIXED_FONT))
272 #define STOCK_ANSI_FIXED_FONT   ((HFONT16)(FIRST_STOCK_HANDLE+ANSI_FIXED_FONT))
273 #define STOCK_ANSI_VAR_FONT     ((HFONT16)(FIRST_STOCK_HANDLE+ANSI_VAR_FONT))
274 #define STOCK_SYSTEM_FONT       ((HFONT16)(FIRST_STOCK_HANDLE+SYSTEM_FONT))
275 #define STOCK_DEVICE_DEFAULT_FONT ((HFONT16)(FIRST_STOCK_HANDLE+DEVICE_DEFAULT_FONT))
276 #define STOCK_DEFAULT_PALETTE   ((HPALETTE16)(FIRST_STOCK_HANDLE+DEFAULT_PALETTE))
277 #define STOCK_SYSTEM_FIXED_FONT ((HFONT16)(FIRST_STOCK_HANDLE+SYSTEM_FIXED_FONT))
278 #define STOCK_DEFAULT_GUI_FONT  ((HFONT16)(FIRST_STOCK_HANDLE+DEFAULT_GUI_FONT))
279
280 #define FIRST_STOCK_FONT        STOCK_OEM_FIXED_FONT
281 #define LAST_STOCK_FONT         STOCK_DEFAULT_GUI_FONT
282
283 #define LAST_STOCK_HANDLE       ((DWORD)STOCK_DEFAULT_GUI_FONT)
284
285   /* Device <-> logical coords conversion */
286
287 /* A floating point version of the POINT structure */
288 typedef struct tagFLOAT_POINT
289 {
290    FLOAT x, y;
291 } FLOAT_POINT;
292
293 /* Rounds a floating point number to integer. The world-to-viewport
294  * transformation process is done in floating point internally. This function
295  * is then used to round these coordinates to integer values.
296  */
297 static __inline__ INT32 GDI_ROUND(FLOAT val)
298 {
299    return (int)floor(val + 0.5);
300 }
301
302 /* Performs a viewport-to-world transformation on the specified point (which
303  * is in floating point format). Returns TRUE if successful, else FALSE.
304  */
305 static __inline__ BOOL32 INTERNAL_DPTOLP_FLOAT(DC *dc, FLOAT_POINT *point)
306 {
307     FLOAT x, y;
308     
309     /* Check that the viewport-to-world transformation is valid */
310     if (!dc->w.vport2WorldValid)
311         return FALSE;
312
313     /* Perform the transformation */
314     x = point->x;
315     y = point->y;
316     point->x = x * dc->w.xformVport2World.eM11 +
317                y * dc->w.xformVport2World.eM21 +
318                dc->w.xformVport2World.eDx;
319     point->y = x * dc->w.xformVport2World.eM12 +
320                y * dc->w.xformVport2World.eM22 +
321                dc->w.xformVport2World.eDy;
322
323     return TRUE;
324 }
325
326 /* Performs a viewport-to-world transformation on the specified point (which
327  * is in integer format). Returns TRUE if successful, else FALSE.
328  */
329 static __inline__ BOOL32 INTERNAL_DPTOLP(DC *dc, LPPOINT32 point)
330 {
331     FLOAT_POINT floatPoint;
332     
333     /* Perform operation with floating point */
334     floatPoint.x=(FLOAT)point->x;
335     floatPoint.y=(FLOAT)point->y;
336     if (!INTERNAL_DPTOLP_FLOAT(dc, &floatPoint))
337         return FALSE;
338     
339     /* Round to integers */
340     point->x = GDI_ROUND(floatPoint.x);
341     point->y = GDI_ROUND(floatPoint.y);
342
343     return TRUE;
344 }
345
346 /* Performs a world-to-viewport transformation on the specified point (which
347  * is in floating point format).
348  */
349 static __inline__ void INTERNAL_LPTODP_FLOAT(DC *dc, FLOAT_POINT *point)
350 {
351     FLOAT x, y;
352     
353     /* Perform the transformation */
354     x = point->x;
355     y = point->y;
356     point->x = x * dc->w.xformWorld2Vport.eM11 +
357                y * dc->w.xformWorld2Vport.eM21 +
358                dc->w.xformWorld2Vport.eDx;
359     point->y = x * dc->w.xformWorld2Vport.eM12 +
360                y * dc->w.xformWorld2Vport.eM22 +
361                dc->w.xformWorld2Vport.eDy;
362 }
363
364 /* Performs a world-to-viewport transformation on the specified point (which
365  * is in integer format).
366  */
367 static __inline__ void INTERNAL_LPTODP(DC *dc, LPPOINT32 point)
368 {
369     FLOAT_POINT floatPoint;
370     
371     /* Perform operation with floating point */
372     floatPoint.x=(FLOAT)point->x;
373     floatPoint.y=(FLOAT)point->y;
374     INTERNAL_LPTODP_FLOAT(dc, &floatPoint);
375     
376     /* Round to integers */
377     point->x = GDI_ROUND(floatPoint.x);
378     point->y = GDI_ROUND(floatPoint.y);
379 }
380
381 #define XDPTOLP(dc,x) \
382     (((x)-(dc)->vportOrgX) * (dc)->wndExtX / (dc)->vportExtX+(dc)->wndOrgX)
383 #define YDPTOLP(dc,y) \
384     (((y)-(dc)->vportOrgY) * (dc)->wndExtY / (dc)->vportExtY+(dc)->wndOrgY)
385 #define XLPTODP(dc,x) \
386     (((x)-(dc)->wndOrgX) * (dc)->vportExtX / (dc)->wndExtX+(dc)->vportOrgX)
387 #define YLPTODP(dc,y) \
388     (((y)-(dc)->wndOrgY) * (dc)->vportExtY / (dc)->wndExtY+(dc)->vportOrgY)
389
390   /* Device <-> logical size conversion */
391
392 #define XDSTOLS(dc,x) \
393     ((x) * (dc)->wndExtX / (dc)->vportExtX)
394 #define YDSTOLS(dc,y) \
395     ((y) * (dc)->wndExtY / (dc)->vportExtY)
396 #define XLSTODS(dc,x) \
397     ((x) * (dc)->vportExtX / (dc)->wndExtX)
398 #define YLSTODS(dc,y) \
399     ((y) * (dc)->vportExtY / (dc)->wndExtY)
400
401   /* GDI local heap */
402
403 extern WORD GDI_HeapSel;
404
405 #define GDI_HEAP_ALLOC(size) \
406             LOCAL_Alloc( GDI_HeapSel, LMEM_FIXED, (size) )
407 #define GDI_HEAP_ALLOC_MOVEABLE(size) \
408             LOCAL_Alloc( GDI_HeapSel, LMEM_MOVEABLE, (size) )
409 #define GDI_HEAP_REALLOC(handle,size) \
410             LOCAL_ReAlloc( GDI_HeapSel, (handle), (size), LMEM_FIXED )
411 #define GDI_HEAP_FREE(handle) \
412             LOCAL_Free( GDI_HeapSel, (handle) )
413
414 #define GDI_HEAP_LOCK(handle) \
415             LOCAL_Lock( GDI_HeapSel, (handle) )
416 #define GDI_HEAP_LOCK_SEGPTR(handle) \
417             LOCAL_LockSegptr( GDI_HeapSel, (handle) )
418 #define GDI_HEAP_UNLOCK(handle) \
419     ((((HGDIOBJ16)(handle) >= FIRST_STOCK_HANDLE) && \
420       ((HGDIOBJ16)(handle)<=LAST_STOCK_HANDLE)) ? \
421       0 : LOCAL_Unlock( GDI_HeapSel, (handle) ))
422
423 extern BOOL32 GDI_Init(void);
424 extern HGDIOBJ16 GDI_AllocObject( WORD, WORD );
425 extern BOOL32 GDI_FreeObject( HGDIOBJ16 );
426 extern GDIOBJHDR * GDI_GetObjPtr( HGDIOBJ16, WORD );
427
428 extern BOOL32 DRIVER_RegisterDriver( LPCSTR name, const DC_FUNCTIONS *funcs );
429 extern const DC_FUNCTIONS *DRIVER_FindDriver( LPCSTR name );
430 extern BOOL32 DRIVER_UnregisterDriver( LPCSTR name );
431
432 extern BOOL32 DIB_Init(void);
433
434 extern Display * display;
435 extern Screen * screen;
436 extern Window rootWindow;
437 extern int screenWidth, screenHeight, screenDepth;
438
439 #endif  /* __WINE_GDI_H */