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