/* * file_py3.i: Typemaps for FILE* for Python 3 * * Copyright (c) 2011, Karel Slany (karel.slany AT nic.cz) * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * * Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of the organization nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ %{ #include #include #ifdef __MINGW32__ #define WIN32_LEAN_AND_MEAN #include #endif %} %types(FILE *); //#define SWIG_FILE3_DEBUG %{ #ifdef __MINGW32__ typedef LONG NTSTATUS; typedef struct _IO_STATUS_BLOCK { union { NTSTATUS Status; PVOID Pointer; }; ULONG_PTR Information; } IO_STATUS_BLOCK, * PIO_STATUS_BLOCK; typedef enum _FILE_INFORMATION_CLASS { FileAccessInformation = 8, } FILE_INFORMATION_CLASS, * PFILE_INFORMATION_CLASS; typedef struct _FILE_ACCESS_INFORMATION { ACCESS_MASK AccessFlags; } FILE_ACCESS_INFORMATION, * PFILE_ACCESS_INFORMATION; extern NTSTATUS __stdcall NtQueryInformationFile( /*IN*/ HANDLE FileHandle, /*OUT*/ PIO_STATUS_BLOCK IoStatusBlock, /*OUT*/ PVOID FileInformation, /*IN*/ ULONG Length, /*IN*/ FILE_INFORMATION_CLASS FileInformationClass ); int fcntl_getfl(int fd) { intptr_t fh; NTSTATUS ntrc; IO_STATUS_BLOCK sb; FILE_ACCESS_INFORMATION fi; int is_r, is_w; fh = _get_osfhandle(fh); if (fh == -1) { return -1; } ntrc = NtQueryInformationFile((HANDLE)fh, &sb, &fi, sizeof(fi), FileAccessInformation); if (ntrc != 0) { return -1; } is_r = (fi.AccessFlags & FILE_READ_DATA) == FILE_READ_DATA; is_w = (fi.AccessFlags & FILE_WRITE_DATA) == FILE_WRITE_DATA; if (is_r && is_w) { return _O_RDWR; } if (is_w) { return _O_WRONLY; } if (is_r) { return _O_RDONLY; } return -1; } #endif %} /* converts basic file descriptor flags onto a string */ %fragment("fdfl_to_str", "header") { const char * fdfl_to_str(int fdfl) { static const char * const file_mode[] = {"w+", "w", "r"}; if (fdfl & O_RDWR) { return file_mode[0]; } else if (fdfl & O_WRONLY) { return file_mode[1]; } else { return file_mode[2]; } } } %fragment("is_obj_file", "header") { int is_obj_file(PyObject *obj) { int fd, fdfl; if (!PyLong_Check(obj) && /* is not an integer */ PyObject_HasAttrString(obj, "fileno") && /* has fileno method */ (PyObject_CallMethod(obj, "flush", NULL) != NULL) && /* flush() succeeded */ ((fd = PyObject_AsFileDescriptor(obj)) != -1) && /* got file descriptor */ %#ifdef __MINGW32__ ((fdfl = fcntl_getfl(fd)) != -1) %#else ((fdfl = fcntl(fd, F_GETFL)) != -1) /* got descriptor flags */ %#endif ) { return 1; } else { return 0; } } } %fragment("obj_to_file","header", fragment="fdfl_to_str,is_obj_file") { FILE * obj_to_file(PyObject *obj) { int fd, fdfl; FILE *fp; if (is_obj_file(obj)) { fd = PyObject_AsFileDescriptor(obj); %#ifdef __MINGW32__ fdfl = fcntl_getfl(fd); %#else fdfl = fcntl(fd, F_GETFL); %#endif fp = fdopen(dup(fd), fdfl_to_str(fdfl)); /* the FILE* must be flushed and closed after being used */ #ifdef SWIG_FILE3_DEBUG fprintf(stderr, "opening fd %d (fl %d \"%s\") as FILE %p\n", fd, fdfl, fdfl_to_str(fdfl), (void *)fp); #endif return fp; } return NULL; } } /* returns -1 if error occurred */ /* caused magic SWIG Syntax errors when was commented out */ #if 0 %fragment("dispose_file", "header") { int dispose_file(FILE **fp) { #ifdef SWIG_FILE3_DEBUG fprintf(stderr, "flushing FILE %p\n", (void *)fp); #endif if (*fp == NULL) { return 0; } if ((fflush(*fp) == 0) && /* flush file */ (fclose(*fp) == 0)) { /* close file */ *fp = NULL; return 0; } return -1; } } #endif %typemap(arginit, noblock = 1) FILE* { $1 = NULL; } /* * added due to ub_ctx_debugout since since it is overloaded: * takes void* and FILE*. In reality only FILE* but the wrapper * and the function is declared in such way. */ %typemap(typecheck, noblock = 1, fragment = "is_obj_file", precedence = SWIG_TYPECHECK_POINTER) FILE* { $1 = is_obj_file($input); } %typemap(check, noblock = 1) FILE* { if ($1 == NULL) { /* The generated wrapper function raises TypeError on mismatching types. */ SWIG_exception_fail(SWIG_TypeError, "in method '" "$symname" "', argument " "$argnum"" of type '" "$type""'"); } } %typemap(in, noblock = 1, fragment = "obj_to_file") FILE* { $1 = obj_to_file($input); } /* * Commented out due the way how ub_ctx_debugout() uses the parameter. * This typemap would cause the FILE* to be closed after return from * the function. This caused Python interpreter to crash, since the * function just stores the FILE* internally in ctx and use it for * logging. So we'll leave the closing of the file on the OS. */ /*%typemap(freearg, noblock = 1, fragment = "dispose_file") FILE* { if (dispose_file(&$1) == -1) { SWIG_exception_fail(SWIG_IOError, "closing file in method '" "$symname" "', argument " "$argnum"" of type '" "$type""'"); } }*/