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