reactos/subsystems/win32/win32k/include/gdiobj.h

   1 /*
   2  *  GDI object common header definition
   3  *
   4  */
   5
   6 #ifndef __WIN32K_GDIOBJ_H
   7 #define __WIN32K_GDIOBJ_H
   8
   9 /* Public GDI Object/Handle definitions */
  10 #include <win32k/ntgdihdl.h>
  11 #include "win32.h"
  12
  13 typedef struct _GDI_HANDLE_TABLE
  14 {
  15 /* The table must be located at the beginning of this structure so it can be
  16  * properly mapped!
  17  */
  18 //////////////////////////////////////////////////////////////////////////////
  19   GDI_TABLE_ENTRY Entries[GDI_HANDLE_COUNT];
  20   DEVCAPS         DevCaps;                 // Device Capabilities.
  21   FLONG           flDeviceUniq;            // Device settings uniqueness.
  22   PVOID           pvLangPack;              // Language Pack.
  23   CFONT           cfPublic[GDI_CFONT_MAX]; // Public Fonts.
  24   DWORD           dwCFCount;
  25 //////////////////////////////////////////////////////////////////////////////
  26   PPAGED_LOOKASIDE_LIST LookasideLists;
  27
  28   ULONG           FirstFree;
  29   ULONG           FirstUnused;
  30
  31 } GDI_HANDLE_TABLE, *PGDI_HANDLE_TABLE;
  32
  33 extern PGDI_HANDLE_TABLE GdiHandleTable;
  34
  35 typedef PVOID PGDIOBJ;
  36
  37 typedef BOOL (INTERNAL_CALL *GDICLEANUPPROC)(PVOID ObjectBody);
  38
  39 /* Every GDI Object must have this standard type of header.
  40  * It's for thread locking. */
  41 typedef struct _BASEOBJECT
  42 {
  43   HGDIOBJ     hHmgr;
  44   ULONG       ulShareCount;
  45   USHORT      cExclusiveLock;
  46   USHORT      BaseFlags;
  47   PTHREADINFO Tid;
  48 } BASEOBJECT, *POBJ;
  49
  50 typedef struct _CLIENTOBJ
  51 {
  52   BASEOBJECT BaseObject;
  53 } CLIENTOBJ, *PCLIENTOBJ;
  54
  55 enum BASEFLAGS
  56 {
  57     BASEFLAG_LOOKASIDE = 0x80,
  58
  59     /* ReactOS specific: */
  60     BASEFLAG_READY_TO_DIE = 0x1000
  61 };
  62
  63 BOOL    INTERNAL_CALL GDIOBJ_OwnedByCurrentProcess(HGDIOBJ ObjectHandle);
  64 BOOL    INTERNAL_CALL GDIOBJ_SetOwnership(HGDIOBJ ObjectHandle, PEPROCESS Owner);
  65 BOOL    INTERNAL_CALL GDIOBJ_CopyOwnership(HGDIOBJ CopyFrom, HGDIOBJ CopyTo);
  66 BOOL    INTERNAL_CALL GDIOBJ_ConvertToStockObj(HGDIOBJ *hObj);
  67 //VOID    INTERNAL_CALL GDIOBJ_ShareUnlockObjByPtr(POBJ Object);
  68 BOOL    INTERNAL_CALL GDIOBJ_ValidateHandle(HGDIOBJ hObj, ULONG ObjectType);
  69 POBJ    INTERNAL_CALL GDIOBJ_AllocObj(UCHAR ObjectType);
  70 POBJ    INTERNAL_CALL GDIOBJ_AllocObjWithHandle(ULONG ObjectType);
  71 VOID    INTERNAL_CALL GDIOBJ_FreeObj (POBJ pObj, UCHAR ObjectType);
  72 BOOL    INTERNAL_CALL GDIOBJ_FreeObjByHandle (HGDIOBJ hObj, DWORD ObjectType);
  73 PGDIOBJ INTERNAL_CALL GDIOBJ_LockObj (HGDIOBJ hObj, DWORD ObjectType);
  74 PGDIOBJ INTERNAL_CALL GDIOBJ_ShareLockObj (HGDIOBJ hObj, DWORD ObjectType);
  75
  76 PVOID   INTERNAL_CALL GDI_MapHandleTable(PSECTION_OBJECT SectionObject, PEPROCESS Process);
  77
  78 #define GDIOBJ_GetObjectType(Handle) \
  79   GDI_HANDLE_GET_TYPE(Handle)
  80
  81 #define GDIOBJFLAG_DEFAULT      (0x0)
  82 #define GDIOBJFLAG_IGNOREPID    (0x1)
  83 #define GDIOBJFLAG_IGNORELOCK   (0x2)
  84
  85 BOOL FASTCALL GreDeleteObject(HGDIOBJ hObject);
  86 BOOL FASTCALL IsObjectDead(HGDIOBJ);
  87 BOOL FASTCALL IntGdiSetDCOwnerEx( HDC, DWORD, BOOL);
  88 BOOL FASTCALL IntGdiSetRegionOwner(HRGN,DWORD);
  89
  90 /*!
  91  * Release GDI object. Every object locked by GDIOBJ_LockObj() must be unlocked.
  92  * You should unlock the object
  93  * as soon as you don't need to have access to it's data.
  94
  95  * \param Object        Object pointer (as returned by GDIOBJ_LockObj).
  96  */
  97 ULONG
  98 FORCEINLINE
  99 GDIOBJ_UnlockObjByPtr(POBJ Object)
 100 {
 101     INT cLocks = InterlockedDecrement((PLONG)&Object->cExclusiveLock);
 102     ASSERT(cLocks >= 0);
 103     return cLocks;
 104 }
 105
 106 ULONG
 107 FORCEINLINE
 108 GDIOBJ_ShareUnlockObjByPtr(POBJ Object)
 109 {
 110     HGDIOBJ hobj = Object->hHmgr;
 111     USHORT flags = Object->BaseFlags;
 112     INT cLocks = InterlockedDecrement((PLONG)&Object->ulShareCount);
 113     ASSERT(cLocks >= 0);
 114     if ((flags & BASEFLAG_READY_TO_DIE) && (cLocks == 0))
 115     {
 116         GDIOBJ_FreeObjByHandle(hobj, GDI_OBJECT_TYPE_DONTCARE);
 117     }
 118     return cLocks;
 119 }
 120
 121 #ifdef GDI_DEBUG
 122 ULONG FASTCALL GDIOBJ_IncrementShareCount(POBJ Object);
 123 #else
 124 ULONG
 125 FORCEINLINE
 126 GDIOBJ_IncrementShareCount(POBJ Object)
 127 {
 128     INT cLocks = InterlockedIncrement((PLONG)&Object->ulShareCount);
 129     ASSERT(cLocks >= 1);
 130     return cLocks;
 131 }
 132 #endif
 133
 134 INT FASTCALL GreGetObjectOwner(HGDIOBJ, GDIOBJTYPE);
 135
 136 #endif