Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 1 | """create and manipulate C data types in Python""" |
| 2 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 3 | import os as _os, sys as _sys |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 4 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 5 | __version__ = "1.1.0" |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 6 | |
| 7 | from _ctypes import Union, Structure, Array |
| 8 | from _ctypes import _Pointer |
| 9 | from _ctypes import CFuncPtr as _CFuncPtr |
| 10 | from _ctypes import __version__ as _ctypes_version |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 11 | from _ctypes import RTLD_LOCAL, RTLD_GLOBAL |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 12 | from _ctypes import ArgumentError |
| 13 | |
| 14 | from struct import calcsize as _calcsize |
| 15 | |
| 16 | if __version__ != _ctypes_version: |
Collin Winter | a73bfee | 2007-08-30 03:47:13 +0000 | [diff] [blame] | 17 | raise Exception("Version number mismatch", __version__, _ctypes_version) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 18 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 19 | if _os.name == "nt": |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 20 | from _ctypes import FormatError |
| 21 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 22 | DEFAULT_MODE = RTLD_LOCAL |
| 23 | if _os.name == "posix" and _sys.platform == "darwin": |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 24 | # On OS X 10.3, we use RTLD_GLOBAL as default mode |
| 25 | # because RTLD_LOCAL does not work at least on some |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 26 | # libraries. OS X 10.3 is Darwin 7, so we check for |
| 27 | # that. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 28 | |
Larry Hastings | 605a62d | 2012-06-24 04:33:36 -0700 | [diff] [blame] | 29 | if int(_os.uname().release.split('.')[0]) < 8: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 30 | DEFAULT_MODE = RTLD_GLOBAL |
| 31 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 32 | from _ctypes import FUNCFLAG_CDECL as _FUNCFLAG_CDECL, \ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 33 | FUNCFLAG_PYTHONAPI as _FUNCFLAG_PYTHONAPI, \ |
| 34 | FUNCFLAG_USE_ERRNO as _FUNCFLAG_USE_ERRNO, \ |
| 35 | FUNCFLAG_USE_LASTERROR as _FUNCFLAG_USE_LASTERROR |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 36 | |
Victor Stinner | 765531d | 2013-03-26 01:11:54 +0100 | [diff] [blame] | 37 | # WINOLEAPI -> HRESULT |
| 38 | # WINOLEAPI_(type) |
| 39 | # |
| 40 | # STDMETHODCALLTYPE |
| 41 | # |
| 42 | # STDMETHOD(name) |
| 43 | # STDMETHOD_(type, name) |
| 44 | # |
| 45 | # STDAPICALLTYPE |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 46 | |
| 47 | def create_string_buffer(init, size=None): |
Guido van Rossum | 97f9d4f | 2007-10-24 18:41:19 +0000 | [diff] [blame] | 48 | """create_string_buffer(aBytes) -> character array |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 49 | create_string_buffer(anInteger) -> character array |
Ezio Melotti | ee2a392 | 2016-01-09 16:08:24 +0200 | [diff] [blame] | 50 | create_string_buffer(aBytes, anInteger) -> character array |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 51 | """ |
Serhiy Storchaka | 4f06d60 | 2014-08-09 09:33:05 +0300 | [diff] [blame] | 52 | if isinstance(init, bytes): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 53 | if size is None: |
| 54 | size = len(init)+1 |
| 55 | buftype = c_char * size |
| 56 | buf = buftype() |
| 57 | buf.value = init |
| 58 | return buf |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 59 | elif isinstance(init, int): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 60 | buftype = c_char * init |
| 61 | buf = buftype() |
| 62 | return buf |
Collin Winter | a73bfee | 2007-08-30 03:47:13 +0000 | [diff] [blame] | 63 | raise TypeError(init) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 64 | |
| 65 | def c_buffer(init, size=None): |
| 66 | ## "deprecated, use create_string_buffer instead" |
| 67 | ## import warnings |
| 68 | ## warnings.warn("c_buffer is deprecated, use create_string_buffer instead", |
| 69 | ## DeprecationWarning, stacklevel=2) |
| 70 | return create_string_buffer(init, size) |
| 71 | |
| 72 | _c_functype_cache = {} |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 73 | def CFUNCTYPE(restype, *argtypes, **kw): |
| 74 | """CFUNCTYPE(restype, *argtypes, |
| 75 | use_errno=False, use_last_error=False) -> function prototype. |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 76 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 77 | restype: the result type |
| 78 | argtypes: a sequence specifying the argument types |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 79 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 80 | The function prototype can be called in different ways to create a |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 81 | callable object: |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 82 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 83 | prototype(integer address) -> foreign function |
| 84 | prototype(callable) -> create and return a C callable function from callable |
| 85 | prototype(integer index, method name[, paramflags]) -> foreign function calling a COM method |
| 86 | prototype((ordinal number, dll object)[, paramflags]) -> foreign function exported by ordinal |
| 87 | prototype((function name, dll object)[, paramflags]) -> foreign function exported by name |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 88 | """ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 89 | flags = _FUNCFLAG_CDECL |
| 90 | if kw.pop("use_errno", False): |
| 91 | flags |= _FUNCFLAG_USE_ERRNO |
| 92 | if kw.pop("use_last_error", False): |
| 93 | flags |= _FUNCFLAG_USE_LASTERROR |
| 94 | if kw: |
| 95 | raise ValueError("unexpected keyword argument(s) %s" % kw.keys()) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 96 | try: |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 97 | return _c_functype_cache[(restype, argtypes, flags)] |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 98 | except KeyError: |
| 99 | class CFunctionType(_CFuncPtr): |
| 100 | _argtypes_ = argtypes |
| 101 | _restype_ = restype |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 102 | _flags_ = flags |
| 103 | _c_functype_cache[(restype, argtypes, flags)] = CFunctionType |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 104 | return CFunctionType |
| 105 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 106 | if _os.name == "nt": |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 107 | from _ctypes import LoadLibrary as _dlopen |
| 108 | from _ctypes import FUNCFLAG_STDCALL as _FUNCFLAG_STDCALL |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 109 | |
| 110 | _win_functype_cache = {} |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 111 | def WINFUNCTYPE(restype, *argtypes, **kw): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 112 | # docstring set later (very similar to CFUNCTYPE.__doc__) |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 113 | flags = _FUNCFLAG_STDCALL |
| 114 | if kw.pop("use_errno", False): |
| 115 | flags |= _FUNCFLAG_USE_ERRNO |
| 116 | if kw.pop("use_last_error", False): |
| 117 | flags |= _FUNCFLAG_USE_LASTERROR |
| 118 | if kw: |
| 119 | raise ValueError("unexpected keyword argument(s) %s" % kw.keys()) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 120 | try: |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 121 | return _win_functype_cache[(restype, argtypes, flags)] |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 122 | except KeyError: |
| 123 | class WinFunctionType(_CFuncPtr): |
| 124 | _argtypes_ = argtypes |
| 125 | _restype_ = restype |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 126 | _flags_ = flags |
| 127 | _win_functype_cache[(restype, argtypes, flags)] = WinFunctionType |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 128 | return WinFunctionType |
| 129 | if WINFUNCTYPE.__doc__: |
| 130 | WINFUNCTYPE.__doc__ = CFUNCTYPE.__doc__.replace("CFUNCTYPE", "WINFUNCTYPE") |
| 131 | |
| 132 | elif _os.name == "posix": |
| 133 | from _ctypes import dlopen as _dlopen |
| 134 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 135 | from _ctypes import sizeof, byref, addressof, alignment, resize |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 136 | from _ctypes import get_errno, set_errno |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 137 | from _ctypes import _SimpleCData |
| 138 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 139 | def _check_size(typ, typecode=None): |
| 140 | # Check if sizeof(ctypes_type) against struct.calcsize. This |
| 141 | # should protect somewhat against a misconfigured libffi. |
| 142 | from struct import calcsize |
| 143 | if typecode is None: |
| 144 | # Most _type_ codes are the same as used in struct |
| 145 | typecode = typ._type_ |
| 146 | actual, required = sizeof(typ), calcsize(typecode) |
| 147 | if actual != required: |
| 148 | raise SystemError("sizeof(%s) wrong: %d instead of %d" % \ |
| 149 | (typ, actual, required)) |
| 150 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 151 | class py_object(_SimpleCData): |
| 152 | _type_ = "O" |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 153 | def __repr__(self): |
| 154 | try: |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 155 | return super().__repr__() |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 156 | except ValueError: |
| 157 | return "%s(<NULL>)" % type(self).__name__ |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 158 | _check_size(py_object, "P") |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 159 | |
| 160 | class c_short(_SimpleCData): |
| 161 | _type_ = "h" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 162 | _check_size(c_short) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 163 | |
| 164 | class c_ushort(_SimpleCData): |
| 165 | _type_ = "H" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 166 | _check_size(c_ushort) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 167 | |
| 168 | class c_long(_SimpleCData): |
| 169 | _type_ = "l" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 170 | _check_size(c_long) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 171 | |
| 172 | class c_ulong(_SimpleCData): |
| 173 | _type_ = "L" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 174 | _check_size(c_ulong) |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 175 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 176 | if _calcsize("i") == _calcsize("l"): |
| 177 | # if int and long have the same size, make c_int an alias for c_long |
| 178 | c_int = c_long |
| 179 | c_uint = c_ulong |
| 180 | else: |
| 181 | class c_int(_SimpleCData): |
| 182 | _type_ = "i" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 183 | _check_size(c_int) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 184 | |
| 185 | class c_uint(_SimpleCData): |
| 186 | _type_ = "I" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 187 | _check_size(c_uint) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 188 | |
| 189 | class c_float(_SimpleCData): |
| 190 | _type_ = "f" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 191 | _check_size(c_float) |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 192 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 193 | class c_double(_SimpleCData): |
| 194 | _type_ = "d" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 195 | _check_size(c_double) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 196 | |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 197 | class c_longdouble(_SimpleCData): |
Thomas Heller | ff72122 | 2008-01-17 18:46:55 +0000 | [diff] [blame] | 198 | _type_ = "g" |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 199 | if sizeof(c_longdouble) == sizeof(c_double): |
| 200 | c_longdouble = c_double |
| 201 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 202 | if _calcsize("l") == _calcsize("q"): |
| 203 | # if long and long long have the same size, make c_longlong an alias for c_long |
| 204 | c_longlong = c_long |
| 205 | c_ulonglong = c_ulong |
| 206 | else: |
| 207 | class c_longlong(_SimpleCData): |
| 208 | _type_ = "q" |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 209 | _check_size(c_longlong) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 210 | |
| 211 | class c_ulonglong(_SimpleCData): |
| 212 | _type_ = "Q" |
| 213 | ## def from_param(cls, val): |
| 214 | ## return ('d', float(val), val) |
| 215 | ## from_param = classmethod(from_param) |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 216 | _check_size(c_ulonglong) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 217 | |
| 218 | class c_ubyte(_SimpleCData): |
| 219 | _type_ = "B" |
| 220 | c_ubyte.__ctype_le__ = c_ubyte.__ctype_be__ = c_ubyte |
| 221 | # backward compatibility: |
| 222 | ##c_uchar = c_ubyte |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 223 | _check_size(c_ubyte) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 224 | |
| 225 | class c_byte(_SimpleCData): |
| 226 | _type_ = "b" |
| 227 | c_byte.__ctype_le__ = c_byte.__ctype_be__ = c_byte |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 228 | _check_size(c_byte) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 229 | |
| 230 | class c_char(_SimpleCData): |
| 231 | _type_ = "c" |
| 232 | c_char.__ctype_le__ = c_char.__ctype_be__ = c_char |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 233 | _check_size(c_char) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 234 | |
| 235 | class c_char_p(_SimpleCData): |
| 236 | _type_ = "z" |
Steve Dower | e6bb7eb | 2015-03-25 21:58:36 -0700 | [diff] [blame] | 237 | def __repr__(self): |
| 238 | return "%s(%s)" % (self.__class__.__name__, c_void_p.from_buffer(self).value) |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 239 | _check_size(c_char_p, "P") |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 240 | |
| 241 | class c_void_p(_SimpleCData): |
| 242 | _type_ = "P" |
| 243 | c_voidp = c_void_p # backwards compatibility (to a bug) |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 244 | _check_size(c_void_p) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 245 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 246 | class c_bool(_SimpleCData): |
Christian Heimes | dd15f6c | 2008-03-16 00:07:10 +0000 | [diff] [blame] | 247 | _type_ = "?" |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 248 | |
Thomas Heller | 3071f81 | 2008-04-14 16:17:33 +0000 | [diff] [blame] | 249 | from _ctypes import POINTER, pointer, _pointer_type_cache |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 250 | |
Victor Stinner | cf44883 | 2010-07-28 00:15:03 +0000 | [diff] [blame] | 251 | class c_wchar_p(_SimpleCData): |
| 252 | _type_ = "Z" |
Steve Dower | e6bb7eb | 2015-03-25 21:58:36 -0700 | [diff] [blame] | 253 | def __repr__(self): |
| 254 | return "%s(%s)" % (self.__class__.__name__, c_void_p.from_buffer(self).value) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 255 | |
Victor Stinner | cf44883 | 2010-07-28 00:15:03 +0000 | [diff] [blame] | 256 | class c_wchar(_SimpleCData): |
| 257 | _type_ = "u" |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 258 | |
Meador Inge | 11e3813 | 2011-11-25 22:33:32 -0600 | [diff] [blame] | 259 | def _reset_cache(): |
| 260 | _pointer_type_cache.clear() |
| 261 | _c_functype_cache.clear() |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 262 | if _os.name == "nt": |
Meador Inge | 11e3813 | 2011-11-25 22:33:32 -0600 | [diff] [blame] | 263 | _win_functype_cache.clear() |
| 264 | # _SimpleCData.c_wchar_p_from_param |
| 265 | POINTER(c_wchar).from_param = c_wchar_p.from_param |
| 266 | # _SimpleCData.c_char_p_from_param |
| 267 | POINTER(c_char).from_param = c_char_p.from_param |
| 268 | _pointer_type_cache[None] = c_void_p |
| 269 | # XXX for whatever reasons, creating the first instance of a callback |
| 270 | # function is needed for the unittests on Win64 to succeed. This MAY |
| 271 | # be a compiler bug, since the problem occurs only when _ctypes is |
| 272 | # compiled with the MS SDK compiler. Or an uninitialized variable? |
| 273 | CFUNCTYPE(c_int)(lambda: None) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 274 | |
Victor Stinner | cf44883 | 2010-07-28 00:15:03 +0000 | [diff] [blame] | 275 | def create_unicode_buffer(init, size=None): |
| 276 | """create_unicode_buffer(aString) -> character array |
| 277 | create_unicode_buffer(anInteger) -> character array |
| 278 | create_unicode_buffer(aString, anInteger) -> character array |
| 279 | """ |
Serhiy Storchaka | 4f06d60 | 2014-08-09 09:33:05 +0300 | [diff] [blame] | 280 | if isinstance(init, str): |
Victor Stinner | cf44883 | 2010-07-28 00:15:03 +0000 | [diff] [blame] | 281 | if size is None: |
| 282 | size = len(init)+1 |
| 283 | buftype = c_wchar * size |
| 284 | buf = buftype() |
| 285 | buf.value = init |
| 286 | return buf |
| 287 | elif isinstance(init, int): |
| 288 | buftype = c_wchar * init |
| 289 | buf = buftype() |
| 290 | return buf |
| 291 | raise TypeError(init) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 292 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 293 | |
| 294 | # XXX Deprecated |
| 295 | def SetPointerType(pointer, cls): |
| 296 | if _pointer_type_cache.get(cls, None) is not None: |
Collin Winter | a73bfee | 2007-08-30 03:47:13 +0000 | [diff] [blame] | 297 | raise RuntimeError("This type already exists in the cache") |
Guido van Rossum | 1b01e5c | 2006-08-19 02:45:06 +0000 | [diff] [blame] | 298 | if id(pointer) not in _pointer_type_cache: |
Collin Winter | a73bfee | 2007-08-30 03:47:13 +0000 | [diff] [blame] | 299 | raise RuntimeError("What's this???") |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 300 | pointer.set_type(cls) |
| 301 | _pointer_type_cache[cls] = pointer |
| 302 | del _pointer_type_cache[id(pointer)] |
| 303 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 304 | # XXX Deprecated |
| 305 | def ARRAY(typ, len): |
| 306 | return typ * len |
| 307 | |
| 308 | ################################################################ |
| 309 | |
| 310 | |
| 311 | class CDLL(object): |
| 312 | """An instance of this class represents a loaded dll/shared |
| 313 | library, exporting functions using the standard C calling |
| 314 | convention (named 'cdecl' on Windows). |
| 315 | |
| 316 | The exported functions can be accessed as attributes, or by |
| 317 | indexing with the function name. Examples: |
| 318 | |
| 319 | <obj>.qsort -> callable object |
| 320 | <obj>['qsort'] -> callable object |
| 321 | |
| 322 | Calling the functions releases the Python GIL during the call and |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 323 | reacquires it afterwards. |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 324 | """ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 325 | _func_flags_ = _FUNCFLAG_CDECL |
| 326 | _func_restype_ = c_int |
Serhiy Storchaka | 4b318f8 | 2017-01-13 09:37:56 +0200 | [diff] [blame] | 327 | # default values for repr |
| 328 | _name = '<uninitialized>' |
| 329 | _handle = 0 |
| 330 | _FuncPtr = None |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 331 | |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 332 | def __init__(self, name, mode=DEFAULT_MODE, handle=None, |
| 333 | use_errno=False, |
| 334 | use_last_error=False): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 335 | self._name = name |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 336 | flags = self._func_flags_ |
| 337 | if use_errno: |
| 338 | flags |= _FUNCFLAG_USE_ERRNO |
| 339 | if use_last_error: |
| 340 | flags |= _FUNCFLAG_USE_LASTERROR |
Michael Felt | c5ae169 | 2017-12-19 13:58:49 +0100 | [diff] [blame] | 341 | if _sys.platform.startswith("aix"): |
| 342 | """When the name contains ".a(" and ends with ")", |
| 343 | e.g., "libFOO.a(libFOO.so)" - this is taken to be an |
| 344 | archive(member) syntax for dlopen(), and the mode is adjusted. |
| 345 | Otherwise, name is presented to dlopen() as a file argument. |
| 346 | """ |
| 347 | if name and name.endswith(")") and ".a(" in name: |
| 348 | mode |= ( _os.RTLD_MEMBER | _os.RTLD_NOW ) |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 349 | |
| 350 | class _FuncPtr(_CFuncPtr): |
| 351 | _flags_ = flags |
| 352 | _restype_ = self._func_restype_ |
| 353 | self._FuncPtr = _FuncPtr |
| 354 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 355 | if handle is None: |
| 356 | self._handle = _dlopen(self._name, mode) |
| 357 | else: |
| 358 | self._handle = handle |
| 359 | |
| 360 | def __repr__(self): |
Serhiy Storchaka | 0c937b3 | 2014-07-22 12:14:52 +0300 | [diff] [blame] | 361 | return "<%s '%s', handle %x at %#x>" % \ |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 362 | (self.__class__.__name__, self._name, |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 363 | (self._handle & (_sys.maxsize*2 + 1)), |
| 364 | id(self) & (_sys.maxsize*2 + 1)) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 365 | |
| 366 | def __getattr__(self, name): |
| 367 | if name.startswith('__') and name.endswith('__'): |
Collin Winter | a73bfee | 2007-08-30 03:47:13 +0000 | [diff] [blame] | 368 | raise AttributeError(name) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 369 | func = self.__getitem__(name) |
| 370 | setattr(self, name, func) |
| 371 | return func |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 372 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 373 | def __getitem__(self, name_or_ordinal): |
| 374 | func = self._FuncPtr((name_or_ordinal, self)) |
Walter Dörwald | aa97f04 | 2007-05-03 21:05:51 +0000 | [diff] [blame] | 375 | if not isinstance(name_or_ordinal, int): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 376 | func.__name__ = name_or_ordinal |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 377 | return func |
| 378 | |
| 379 | class PyDLL(CDLL): |
Martin Panter | c04fb56 | 2016-02-10 05:44:01 +0000 | [diff] [blame] | 380 | """This class represents the Python library itself. It allows |
| 381 | accessing Python API functions. The GIL is not released, and |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 382 | Python exceptions are handled correctly. |
| 383 | """ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 384 | _func_flags_ = _FUNCFLAG_CDECL | _FUNCFLAG_PYTHONAPI |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 385 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 386 | if _os.name == "nt": |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 387 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 388 | class WinDLL(CDLL): |
| 389 | """This class represents a dll exporting functions using the |
| 390 | Windows stdcall calling convention. |
| 391 | """ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 392 | _func_flags_ = _FUNCFLAG_STDCALL |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 393 | |
| 394 | # XXX Hm, what about HRESULT as normal parameter? |
| 395 | # Mustn't it derive from c_long then? |
| 396 | from _ctypes import _check_HRESULT, _SimpleCData |
| 397 | class HRESULT(_SimpleCData): |
| 398 | _type_ = "l" |
| 399 | # _check_retval_ is called with the function's result when it |
| 400 | # is used as restype. It checks for the FAILED bit, and |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 401 | # raises an OSError if it is set. |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 402 | # |
| 403 | # The _check_retval_ method is implemented in C, so that the |
| 404 | # method definition itself is not included in the traceback |
| 405 | # when it raises an error - that is what we want (and Python |
| 406 | # doesn't have a way to raise an exception in the caller's |
| 407 | # frame). |
| 408 | _check_retval_ = _check_HRESULT |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 409 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 410 | class OleDLL(CDLL): |
| 411 | """This class represents a dll exporting functions using the |
| 412 | Windows stdcall calling convention, and returning HRESULT. |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 413 | HRESULT error values are automatically raised as OSError |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 414 | exceptions. |
| 415 | """ |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 416 | _func_flags_ = _FUNCFLAG_STDCALL |
| 417 | _func_restype_ = HRESULT |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 418 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 419 | class LibraryLoader(object): |
| 420 | def __init__(self, dlltype): |
| 421 | self._dlltype = dlltype |
| 422 | |
| 423 | def __getattr__(self, name): |
| 424 | if name[0] == '_': |
| 425 | raise AttributeError(name) |
| 426 | dll = self._dlltype(name) |
| 427 | setattr(self, name, dll) |
| 428 | return dll |
| 429 | |
| 430 | def __getitem__(self, name): |
| 431 | return getattr(self, name) |
| 432 | |
| 433 | def LoadLibrary(self, name): |
| 434 | return self._dlltype(name) |
| 435 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 436 | cdll = LibraryLoader(CDLL) |
| 437 | pydll = LibraryLoader(PyDLL) |
| 438 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 439 | if _os.name == "nt": |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 440 | pythonapi = PyDLL("python dll", None, _sys.dllhandle) |
| 441 | elif _sys.platform == "cygwin": |
| 442 | pythonapi = PyDLL("libpython%d.%d.dll" % _sys.version_info[:2]) |
| 443 | else: |
| 444 | pythonapi = PyDLL(None) |
| 445 | |
| 446 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 447 | if _os.name == "nt": |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 448 | windll = LibraryLoader(WinDLL) |
| 449 | oledll = LibraryLoader(OleDLL) |
| 450 | |
Alex Gaynor | cb76029 | 2017-08-30 07:43:14 -0400 | [diff] [blame] | 451 | GetLastError = windll.kernel32.GetLastError |
Thomas Heller | 9cac7b6 | 2008-06-06 09:31:40 +0000 | [diff] [blame] | 452 | from _ctypes import get_last_error, set_last_error |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 453 | |
| 454 | def WinError(code=None, descr=None): |
| 455 | if code is None: |
| 456 | code = GetLastError() |
| 457 | if descr is None: |
| 458 | descr = FormatError(code).strip() |
Andrew Svetlov | 2606a6f | 2012-12-19 14:33:35 +0200 | [diff] [blame] | 459 | return OSError(None, descr, None, code) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 460 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 461 | if sizeof(c_uint) == sizeof(c_void_p): |
| 462 | c_size_t = c_uint |
Gregory P. Smith | 1a53091 | 2010-03-01 04:59:27 +0000 | [diff] [blame] | 463 | c_ssize_t = c_int |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 464 | elif sizeof(c_ulong) == sizeof(c_void_p): |
| 465 | c_size_t = c_ulong |
Gregory P. Smith | 1a53091 | 2010-03-01 04:59:27 +0000 | [diff] [blame] | 466 | c_ssize_t = c_long |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 467 | elif sizeof(c_ulonglong) == sizeof(c_void_p): |
| 468 | c_size_t = c_ulonglong |
Gregory P. Smith | 1a53091 | 2010-03-01 04:59:27 +0000 | [diff] [blame] | 469 | c_ssize_t = c_longlong |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 470 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 471 | # functions |
| 472 | |
| 473 | from _ctypes import _memmove_addr, _memset_addr, _string_at_addr, _cast_addr |
| 474 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 475 | ## void *memmove(void *, const void *, size_t); |
| 476 | memmove = CFUNCTYPE(c_void_p, c_void_p, c_void_p, c_size_t)(_memmove_addr) |
| 477 | |
| 478 | ## void *memset(void *, int, size_t) |
| 479 | memset = CFUNCTYPE(c_void_p, c_void_p, c_int, c_size_t)(_memset_addr) |
| 480 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 481 | def PYFUNCTYPE(restype, *argtypes): |
| 482 | class CFunctionType(_CFuncPtr): |
| 483 | _argtypes_ = argtypes |
| 484 | _restype_ = restype |
| 485 | _flags_ = _FUNCFLAG_CDECL | _FUNCFLAG_PYTHONAPI |
| 486 | return CFunctionType |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 487 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 488 | _cast = PYFUNCTYPE(py_object, c_void_p, py_object, py_object)(_cast_addr) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 489 | def cast(obj, typ): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 490 | return _cast(obj, obj, typ) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 491 | |
Thomas Heller | 47bc809 | 2008-08-19 06:38:12 +0000 | [diff] [blame] | 492 | _string_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_string_at_addr) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 493 | def string_at(ptr, size=-1): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 494 | """string_at(addr[, size]) -> string |
| 495 | |
| 496 | Return the string at addr.""" |
| 497 | return _string_at(ptr, size) |
| 498 | |
| 499 | try: |
| 500 | from _ctypes import _wstring_at_addr |
| 501 | except ImportError: |
| 502 | pass |
| 503 | else: |
Thomas Heller | 47bc809 | 2008-08-19 06:38:12 +0000 | [diff] [blame] | 504 | _wstring_at = PYFUNCTYPE(py_object, c_void_p, c_int)(_wstring_at_addr) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 505 | def wstring_at(ptr, size=-1): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 506 | """wstring_at(addr[, size]) -> string |
| 507 | |
| 508 | Return the string at addr.""" |
| 509 | return _wstring_at(ptr, size) |
Tim Peters | e8d09e5 | 2006-03-09 01:15:05 +0000 | [diff] [blame] | 510 | |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 511 | |
Larry Hastings | 10108a7 | 2016-09-05 15:11:23 -0700 | [diff] [blame] | 512 | if _os.name == "nt": # COM stuff |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 513 | def DllGetClassObject(rclsid, riid, ppv): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 514 | try: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 515 | ccom = __import__("comtypes.server.inprocserver", globals(), locals(), ['*']) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 516 | except ImportError: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 517 | return -2147221231 # CLASS_E_CLASSNOTAVAILABLE |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 518 | else: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 519 | return ccom.DllGetClassObject(rclsid, riid, ppv) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 520 | |
| 521 | def DllCanUnloadNow(): |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 522 | try: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 523 | ccom = __import__("comtypes.server.inprocserver", globals(), locals(), ['*']) |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 524 | except ImportError: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 525 | return 0 # S_OK |
| 526 | return ccom.DllCanUnloadNow() |
Thomas Heller | babddfc | 2006-03-08 19:56:54 +0000 | [diff] [blame] | 527 | |
| 528 | from ctypes._endian import BigEndianStructure, LittleEndianStructure |
| 529 | |
| 530 | # Fill in specifically-sized types |
| 531 | c_int8 = c_byte |
| 532 | c_uint8 = c_ubyte |
| 533 | for kind in [c_short, c_int, c_long, c_longlong]: |
| 534 | if sizeof(kind) == 2: c_int16 = kind |
| 535 | elif sizeof(kind) == 4: c_int32 = kind |
| 536 | elif sizeof(kind) == 8: c_int64 = kind |
| 537 | for kind in [c_ushort, c_uint, c_ulong, c_ulonglong]: |
| 538 | if sizeof(kind) == 2: c_uint16 = kind |
| 539 | elif sizeof(kind) == 4: c_uint32 = kind |
| 540 | elif sizeof(kind) == 8: c_uint64 = kind |
| 541 | del(kind) |
Thomas Heller | 674e938 | 2007-08-31 13:06:44 +0000 | [diff] [blame] | 542 | |
Meador Inge | 11e3813 | 2011-11-25 22:33:32 -0600 | [diff] [blame] | 543 | _reset_cache() |