git.cworth.org Git - apitrace/blob - specs/winapi.py

   1 ##########################################################################
   2 #
   3 # Copyright 2008-2009 VMware, Inc.
   4 # All Rights Reserved.
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a copy
   7 # of this software and associated documentation files (the "Software"), to deal
   8 # in the Software without restriction, including without limitation the rights
   9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 # copies of the Software, and to permit persons to whom the Software is
  11 # furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 # THE SOFTWARE.
  23 #
  24 ##########################################################################/
  25
  26 """Win32 API type description."""
  27
  28
  29 from stdapi import *
  30
  31
  32 SHORT = Alias("SHORT", Short)
  33 USHORT = Alias("USHORT", UShort)
  34 INT = Alias("INT", Int)
  35 UINT = Alias("UINT", UInt)
  36 LONG = Alias("LONG", Long)
  37 ULONG = Alias("ULONG", ULong)
  38 LONGLONG = Alias("LONGLONG", LongLong)
  39 FLOAT = Alias("FLOAT", Float)
  40
  41 INT8 = Alias("INT8", Int8)
  42 UINT8 = Alias("UINT8", UInt8)
  43 INT16 = Alias("INT16", Int16)
  44 UINT16 = Alias("UINT16", UInt16)
  45 INT32 = Alias("INT32", Int32)
  46 UINT32 = Alias("UINT32", UInt32)
  47 INT64 = Alias("INT64", Int64)
  48 UINT64 = Alias("UINT64", UInt64)
  49
  50 BYTE = Alias("BYTE", UInt8)
  51 WORD = Alias("WORD", UInt16)
  52 DWORD = Alias("DWORD", UInt32)
  53
  54 WCHAR = Alias("WCHAR", Short)
  55
  56 BOOL = Enum("BOOL", [
  57     "FALSE",
  58     "TRUE",
  59 ])
  60
  61 LPLONG = Pointer(LONG)
  62 LPWORD = Pointer(WORD)
  63 LPDWORD = Pointer(DWORD)
  64 LPBOOL = Pointer(BOOL)
  65
  66 LPSTR = CString
  67 LPCSTR = Const(CString)
  68 LPWSTR = WString
  69 LPCWSTR = Const(WString)
  70
  71 LARGE_INTEGER = Struct("LARGE_INTEGER", [
  72     (LONGLONG, 'QuadPart'),
  73 ])
  74
  75 SIZE_T = Alias("SIZE_T", SizeT)
  76
  77 VOID = Void
  78 PVOID = Opaque("PVOID")
  79 LPVOID = PVOID
  80
  81 def DECLARE_HANDLE(expr):
  82     return Handle(expr, IntPointer(expr))
  83
  84 HANDLE = DECLARE_HANDLE("HANDLE")
  85 HWND = DECLARE_HANDLE("HWND")
  86 HDC = DECLARE_HANDLE("HDC")
  87 HMONITOR = DECLARE_HANDLE("HMONITOR")
  88
  89 GUID = Struct("GUID", [
  90     (DWORD, "Data1"),
  91     (WORD, "Data2"),
  92     (WORD, "Data3"),
  93     (Array(BYTE, 8), "Data4"),
  94 ])
  95 LPGUID = Pointer(GUID)
  96
  97 REFGUID = Alias("REFGUID", Reference(GUID))
  98
  99 IID = Alias("IID", GUID)
 100 REFIID = Alias("REFIID", Reference(IID))
 101
 102 CLSID = Alias("CLSID", GUID)
 103 REFCLSID = Alias("REFCLSID", Reference(CLSID))
 104
 105 LUID = Struct("LUID", [
 106     (DWORD, "LowPart"),
 107     (LONG, "HighPart"),
 108 ])
 109
 110 POINT = Struct("POINT", (
 111   (LONG, "x"),
 112   (LONG, "y"),
 113 ))
 114 LPPOINT = Pointer(POINT)
 115
 116 SIZE = Struct("SIZE", (
 117   (LONG, "cx"),
 118   (LONG, "cy"),
 119 ))
 120 LPSIZE = Pointer(SIZE)
 121
 122 RECT = Struct("RECT", (
 123   (LONG, "left"),
 124   (LONG, "top"),
 125   (LONG, "right"),
 126   (LONG, "bottom"),
 127 ))
 128 LPRECT = Pointer(RECT)
 129
 130 PALETTEENTRY = Struct("PALETTEENTRY", (
 131   (BYTE, "peRed"),
 132   (BYTE, "peGreen"),
 133   (BYTE, "peBlue"),
 134   (BYTE, "peFlags"),
 135 ))
 136 LPPALETTEENTRY = Pointer(PALETTEENTRY)
 137
 138
 139 RGNDATAHEADER = Struct("RGNDATAHEADER", [
 140     (DWORD, "dwSize"),
 141     (DWORD, "iType"),
 142     (DWORD, "nCount"),
 143     (DWORD, "nRgnSize"),
 144     (RECT, "rcBound"),
 145 ])
 146
 147 RGNDATA = Struct("RGNDATA", [
 148     (RGNDATAHEADER, "rdh"),
 149     #(Char, "Buffer[1]"),
 150 ])
 151 LPRGNDATA = Pointer(RGNDATA)
 152
 153 HMODULE = DECLARE_HANDLE("HMODULE")
 154
 155 FILETIME = Struct("FILETIME", [
 156     (DWORD, "dwLowDateTime"),
 157     (DWORD, "dwHighDateTime"),
 158 ])
 159
 160 COLORREF = Alias("COLORREF", DWORD)
 161
 162 LOGFONTW = Struct("LOGFONTW", [
 163     (LONG, "lfHeight"),
 164     (LONG, "lfWidth"),
 165     (LONG, "lfEscapement"),
 166     (LONG, "lfOrientation"),
 167     (LONG, "lfWeight"),
 168     (BYTE, "lfItalic"),
 169     (BYTE, "lfUnderline"),
 170     (BYTE, "lfStrikeOut"),
 171     (BYTE, "lfCharSet"),
 172     (BYTE, "lfOutPrecision"),
 173     (BYTE, "lfClipPrecision"),
 174     (BYTE, "lfQuality"),
 175     (BYTE, "lfPitchAndFamily"),
 176     (WString, "lfFaceName"),
 177 ])
 178
 179
 180 # http://msdn.microsoft.com/en-us/library/ff485842.aspx
 181 # http://msdn.microsoft.com/en-us/library/windows/desktop/ms681381.aspx
 182 HRESULT = Enum("HRESULT", [
 183     "S_OK", # 0x0
 184     "S_FALSE", # 0x1
 185     "E_PENDING", # 0x8000000A
 186     "E_NOTIMPL", # 0x80004001
 187     "E_NOINTERFACE", # 0x80004002
 188     "E_POINTER", # 0x80004003
 189     "E_ABORT", # 0x80004004
 190     "E_FAIL", # 0x80004005
 191     "E_UNEXPECTED", # 0x8000FFFF
 192     "E_ACCESSDENIED", # 0x80070005
 193     "E_HANDLE", # 0x80070006
 194     "E_OUTOFMEMORY", # 0x8007000E
 195     "E_INVALIDARG", # 0x80070057
 196 ])
 197
 198
 199 IUnknown = Interface("IUnknown")
 200
 201 IUnknown.methods = (
 202         Method(HRESULT, "QueryInterface", ((REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppvObj"))),
 203         Method(ULONG, "AddRef", ()),
 204         Method(ULONG, "Release", ()),
 205 )
 206
 207