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