Lib/ctypes/wintypes.py

   1 ######################################################################
   2 #  This file should be kept compatible with Python 2.3, see PEP 291. #
   3 ######################################################################
   4
   5 # The most useful windows datatypes
   6 from ctypes import *
   7
   8 BYTE = c_byte
   9 WORD = c_ushort
  10 DWORD = c_ulong
  11
  12 WCHAR = c_wchar
  13 UINT = c_uint
  14
  15 DOUBLE = c_double
  16
  17 BOOLEAN = BYTE
  18 BOOL = c_long
  19
  20 from ctypes import _SimpleCData
  21 class VARIANT_BOOL(_SimpleCData):
  22     _type_ = "v"
  23     def __repr__(self):
  24         return "%s(%r)" % (self.__class__.__name__, self.value)
  25
  26 ULONG = c_ulong
  27 LONG = c_long
  28
  29 # in the windows header files, these are structures.
  30 _LARGE_INTEGER = LARGE_INTEGER = c_longlong
  31 _ULARGE_INTEGER = ULARGE_INTEGER = c_ulonglong
  32
  33 LPCOLESTR = LPOLESTR = OLESTR = c_wchar_p
  34 LPCWSTR = LPWSTR = c_wchar_p
  35 LPCSTR = LPSTR = c_char_p
  36
  37 # WPARAM is defined as UINT_PTR (unsigned type)
  38 # LPARAM is defined as LONG_PTR (signed type)
  39 if sizeof(c_long) == sizeof(c_void_p):
  40     WPARAM = c_ulong
  41     LPARAM = c_long
  42 elif sizeof(c_longlong) == sizeof(c_void_p):
  43     WPARAM = c_ulonglong
  44     LPARAM = c_longlong
  45
  46 ATOM = WORD
  47 LANGID = WORD
  48
  49 COLORREF = DWORD
  50 LGRPID = DWORD
  51 LCTYPE = DWORD
  52
  53 LCID = DWORD
  54
  55 ################################################################
  56 # HANDLE types
  57 HANDLE = c_void_p # in the header files: void *
  58
  59 HACCEL = HANDLE
  60 HBITMAP = HANDLE
  61 HBRUSH = HANDLE
  62 HCOLORSPACE = HANDLE
  63 HDC = HANDLE
  64 HDESK = HANDLE
  65 HDWP = HANDLE
  66 HENHMETAFILE = HANDLE
  67 HFONT = HANDLE
  68 HGDIOBJ = HANDLE
  69 HGLOBAL = HANDLE
  70 HHOOK = HANDLE
  71 HICON = HANDLE
  72 HINSTANCE = HANDLE
  73 HKEY = HANDLE
  74 HKL = HANDLE
  75 HLOCAL = HANDLE
  76 HMENU = HANDLE
  77 HMETAFILE = HANDLE
  78 HMODULE = HANDLE
  79 HMONITOR = HANDLE
  80 HPALETTE = HANDLE
  81 HPEN = HANDLE
  82 HRGN = HANDLE
  83 HRSRC = HANDLE
  84 HSTR = HANDLE
  85 HTASK = HANDLE
  86 HWINSTA = HANDLE
  87 HWND = HANDLE
  88 SC_HANDLE = HANDLE
  89 SERVICE_STATUS_HANDLE = HANDLE
  90
  91 ################################################################
  92 # Some important structure definitions
  93
  94 class RECT(Structure):
  95     _fields_ = [("left", c_long),
  96                 ("top", c_long),
  97                 ("right", c_long),
  98                 ("bottom", c_long)]
  99 tagRECT = _RECTL = RECTL = RECT
 100
 101 class _SMALL_RECT(Structure):
 102     _fields_ = [('Left', c_short),
 103                 ('Top', c_short),
 104                 ('Right', c_short),
 105                 ('Bottom', c_short)]
 106 SMALL_RECT = _SMALL_RECT
 107
 108 class _COORD(Structure):
 109     _fields_ = [('X', c_short),
 110                 ('Y', c_short)]
 111
 112 class POINT(Structure):
 113     _fields_ = [("x", c_long),
 114                 ("y", c_long)]
 115 tagPOINT = _POINTL = POINTL = POINT
 116
 117 class SIZE(Structure):
 118     _fields_ = [("cx", c_long),
 119                 ("cy", c_long)]
 120 tagSIZE = SIZEL = SIZE
 121
 122 def RGB(red, green, blue):
 123     return red + (green << 8) + (blue << 16)
 124
 125 class FILETIME(Structure):
 126     _fields_ = [("dwLowDateTime", DWORD),
 127                 ("dwHighDateTime", DWORD)]
 128 _FILETIME = FILETIME
 129
 130 class MSG(Structure):
 131     _fields_ = [("hWnd", HWND),
 132                 ("message", c_uint),
 133                 ("wParam", WPARAM),
 134                 ("lParam", LPARAM),
 135                 ("time", DWORD),
 136                 ("pt", POINT)]
 137 tagMSG = MSG
 138 MAX_PATH = 260
 139
 140 class WIN32_FIND_DATAA(Structure):
 141     _fields_ = [("dwFileAttributes", DWORD),
 142                 ("ftCreationTime", FILETIME),
 143                 ("ftLastAccessTime", FILETIME),
 144                 ("ftLastWriteTime", FILETIME),
 145                 ("nFileSizeHigh", DWORD),
 146                 ("nFileSizeLow", DWORD),
 147                 ("dwReserved0", DWORD),
 148                 ("dwReserved1", DWORD),
 149                 ("cFileName", c_char * MAX_PATH),
 150                 ("cAlternameFileName", c_char * 14)]
 151
 152 class WIN32_FIND_DATAW(Structure):
 153     _fields_ = [("dwFileAttributes", DWORD),
 154                 ("ftCreationTime", FILETIME),
 155                 ("ftLastAccessTime", FILETIME),
 156                 ("ftLastWriteTime", FILETIME),
 157                 ("nFileSizeHigh", DWORD),
 158                 ("nFileSizeLow", DWORD),
 159                 ("dwReserved0", DWORD),
 160                 ("dwReserved1", DWORD),
 161                 ("cFileName", c_wchar * MAX_PATH),
 162                 ("cAlternameFileName", c_wchar * 14)]
 163
 164 __all__ = ['ATOM', 'BOOL', 'BOOLEAN', 'BYTE', 'COLORREF', 'DOUBLE',
 165            'DWORD', 'FILETIME', 'HACCEL', 'HANDLE', 'HBITMAP', 'HBRUSH',
 166            'HCOLORSPACE', 'HDC', 'HDESK', 'HDWP', 'HENHMETAFILE', 'HFONT',
 167            'HGDIOBJ', 'HGLOBAL', 'HHOOK', 'HICON', 'HINSTANCE', 'HKEY',
 168            'HKL', 'HLOCAL', 'HMENU', 'HMETAFILE', 'HMODULE', 'HMONITOR',
 169            'HPALETTE', 'HPEN', 'HRGN', 'HRSRC', 'HSTR', 'HTASK', 'HWINSTA',
 170            'HWND', 'LANGID', 'LARGE_INTEGER', 'LCID', 'LCTYPE', 'LGRPID',
 171            'LONG', 'LPARAM', 'LPCOLESTR', 'LPCSTR', 'LPCWSTR', 'LPOLESTR',
 172            'LPSTR', 'LPWSTR', 'MAX_PATH', 'MSG', 'OLESTR', 'POINT',
 173            'POINTL', 'RECT', 'RECTL', 'RGB', 'SC_HANDLE',
 174            'SERVICE_STATUS_HANDLE', 'SIZE', 'SIZEL', 'SMALL_RECT', 'UINT',
 175            'ULARGE_INTEGER', 'ULONG', 'VARIANT_BOOL', 'WCHAR',
 176            'WIN32_FIND_DATAA', 'WIN32_FIND_DATAW', 'WORD', 'WPARAM', '_COORD',
 177            '_FILETIME', '_LARGE_INTEGER', '_POINTL', '_RECTL', '_SMALL_RECT',
 178            '_ULARGE_INTEGER', 'tagMSG', 'tagPOINT', 'tagRECT', 'tagSIZE']