1 ##########################################################################
3 # Copyright 2008-2009 VMware, Inc.
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:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
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
24 ##########################################################################/
26 """Win32 API type description."""
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)
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)
50 BYTE = Alias("BYTE", UInt8)
51 WORD = Alias("WORD", UInt16)
52 DWORD = Alias("DWORD", UInt32)
54 WCHAR = Alias("WCHAR", Short)
56 BOOL = Alias("BOOL", Bool)
58 LPLONG = Pointer(LONG)
59 LPWORD = Pointer(WORD)
60 LPDWORD = Pointer(DWORD)
61 LPBOOL = Pointer(BOOL)
64 LPCSTR = Const(CString)
66 LPCWSTR = Const(WString)
68 LARGE_INTEGER = Struct("LARGE_INTEGER", [
69 (LONGLONG, 'QuadPart'),
72 SIZE_T = Alias("SIZE_T", SizeT)
75 PVOID = Opaque("PVOID")
78 def DECLARE_HANDLE(expr):
79 return Handle(expr, IntPointer(expr))
81 HANDLE = DECLARE_HANDLE("HANDLE")
82 HWND = DECLARE_HANDLE("HWND")
83 HDC = DECLARE_HANDLE("HDC")
84 HMONITOR = DECLARE_HANDLE("HMONITOR")
86 GUID = Struct("GUID", [
90 (Array(BYTE, 8), "Data4"),
92 LPGUID = Pointer(GUID)
94 REFGUID = Alias("REFGUID", Reference(GUID))
96 IID = Alias("IID", GUID)
97 REFIID = Alias("REFIID", Reference(IID))
99 CLSID = Alias("CLSID", GUID)
100 REFCLSID = Alias("REFCLSID", Reference(CLSID))
102 LUID = Struct("LUID", [
107 POINT = Struct("POINT", (
111 LPPOINT = Pointer(POINT)
113 SIZE = Struct("SIZE", (
117 LPSIZE = Pointer(SIZE)
119 RECT = Struct("RECT", (
125 LPRECT = Pointer(RECT)
127 PALETTEENTRY = Struct("PALETTEENTRY", (
133 LPPALETTEENTRY = Pointer(PALETTEENTRY)
136 RGNDATAHEADER = Struct("RGNDATAHEADER", [
144 RGNDATA = Struct("RGNDATA", [
145 (RGNDATAHEADER, "rdh"),
146 #(Char, "Buffer[1]"),
148 LPRGNDATA = Pointer(RGNDATA)
150 HMODULE = DECLARE_HANDLE("HMODULE")
152 FILETIME = Struct("FILETIME", [
153 (DWORD, "dwLowDateTime"),
154 (DWORD, "dwHighDateTime"),
157 COLORREF = Alias("COLORREF", DWORD)
159 LOGFONTW = Struct("LOGFONTW", [
162 (LONG, "lfEscapement"),
163 (LONG, "lfOrientation"),
166 (BYTE, "lfUnderline"),
167 (BYTE, "lfStrikeOut"),
169 (BYTE, "lfOutPrecision"),
170 (BYTE, "lfClipPrecision"),
172 (BYTE, "lfPitchAndFamily"),
173 (WString, "lfFaceName"),
177 # http://msdn.microsoft.com/en-us/library/ff485842.aspx
178 # http://msdn.microsoft.com/en-us/library/windows/desktop/ms681381.aspx
179 HRESULT = Enum("HRESULT", [
182 "E_PENDING", # 0x8000000A
183 "E_NOTIMPL", # 0x80004001
184 "E_NOINTERFACE", # 0x80004002
185 "E_POINTER", # 0x80004003
186 "E_ABORT", # 0x80004004
187 "E_FAIL", # 0x80004005
188 "E_UNEXPECTED", # 0x8000FFFF
189 "E_ACCESSDENIED", # 0x80070005
190 "E_HANDLE", # 0x80070006
191 "E_OUTOFMEMORY", # 0x8007000E
192 "E_INVALIDARG", # 0x80070057
196 IUnknown = Interface("IUnknown")
199 Method(HRESULT, "QueryInterface", ((REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppvObj"))),
200 Method(ULONG, "AddRef", ()),
201 Method(ULONG, "Release", ()),