2 * Wine exception handling
4 * Copyright (c) 1999 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __WINE_WINE_EXCEPTION_H
22 #define __WINE_WINE_EXCEPTION_H
27 /* The following definitions allow using exceptions in Wine and Winelib code
29 * They should be used like this:
33 * do some stuff that can raise an exception
35 * __EXCEPT(filter_func,param)
37 * handle the exception here
45 * do some stuff that can raise an exception
47 * __FINALLY(finally_func,param)
49 * The filter_func must be defined with the WINE_EXCEPTION_FILTER
50 * macro, and return one of the EXCEPTION_* code; it can use
51 * GetExceptionInformation and GetExceptionCode to retrieve the
54 * The finally_func must be defined with the WINE_FINALLY_FUNC macro.
56 * Warning: inside a __TRY or __EXCEPT block, 'break' or 'continue' statements
57 * break out of the current block. You cannot use 'return', 'goto'
58 * or 'longjmp' to leave a __TRY block, as this will surely crash.
59 * You can use them to leave a __EXCEPT block though.
64 /* Define this if you want to use your compiler built-in __try/__except support.
65 * This is only useful when compiling to a native Windows binary, as the built-in
66 * compiler exceptions will most certainly not work under Winelib.
68 #ifdef USE_COMPILER_EXCEPTIONS
71 #define __EXCEPT(func) __except((func)(GetExceptionInformation()))
72 #define __FINALLY(func) __finally { (func)(!AbnormalTermination()); }
73 #define __ENDTRY /*nothing*/
75 #else /* USE_COMPILER_EXCEPTIONS */
78 #define __attribute__(x) /* nothing */
82 do { __WINE_FRAME __f; \
84 for (;;) if (!__first) \
88 #define __EXCEPT(func) \
90 __wine_pop_frame( &__f.frame ); \
93 __f.frame.Handler = __wine_exception_handler; \
94 __f.u.filter = (func); \
95 __wine_push_frame( &__f.frame ); \
96 if (sigsetjmp( __f.jmp, 1 )) { \
97 const __WINE_FRAME * const __eptr __attribute__((unused)) = &__f; \
108 #define __FINALLY(func) \
110 __wine_pop_frame( &__f.frame ); \
114 __f.frame.Handler = __wine_finally_handler; \
115 __f.u.finally_func = (func); \
116 __wine_push_frame( &__f.frame ); \
122 typedef DWORD (CALLBACK
*__WINE_FILTER
)(PEXCEPTION_POINTERS
);
123 typedef void (CALLBACK
*__WINE_FINALLY
)(BOOL
);
125 #define WINE_EXCEPTION_FILTER(func) DWORD WINAPI func( EXCEPTION_POINTERS *__eptr )
126 #define WINE_FINALLY_FUNC(func) void WINAPI func( BOOL __normal )
128 #define GetExceptionInformation() (__eptr)
129 #define GetExceptionCode() (__eptr->ExceptionRecord->ExceptionCode)
130 #define AbnormalTermination() (!__normal)
132 typedef struct __tagWINE_FRAME
134 EXCEPTION_REGISTRATION_RECORD frame
;
138 __WINE_FILTER filter
;
140 __WINE_FINALLY finally_func
;
143 /* hack to make GetExceptionCode() work in handler */
145 const struct __tagWINE_FRAME
*ExceptionRecord
;
148 extern DWORD
__wine_exception_handler( PEXCEPTION_RECORD record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
149 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**pdispatcher
);
150 extern DWORD
__wine_finally_handler( PEXCEPTION_RECORD record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
151 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**pdispatcher
);
153 #endif /* USE_COMPILER_EXCEPTIONS */
155 static inline EXCEPTION_REGISTRATION_RECORD
*__wine_push_frame( EXCEPTION_REGISTRATION_RECORD
*frame
)
157 #if defined(__GNUC__) && defined(__i386__)
158 EXCEPTION_REGISTRATION_RECORD
*prev
;
159 __asm__
__volatile__(".byte 0x64\n\tmovl (0),%0"
161 "\n\t.byte 0x64\n\tmovl %1,(0)"
162 : "=&r" (prev
) : "r" (frame
) : "memory" );
165 NT_TIB
*teb
= (NT_TIB
*)NtCurrentTeb();
166 frame
->Prev
= (void *)teb
->ExceptionList
;
167 teb
->ExceptionList
= (void *)frame
;
172 static inline EXCEPTION_REGISTRATION_RECORD
*__wine_pop_frame( EXCEPTION_REGISTRATION_RECORD
*frame
)
174 #if defined(__GNUC__) && defined(__i386__)
175 __asm__
__volatile__(".byte 0x64\n\tmovl %0,(0)"
176 : : "r" (frame
->Prev
) : "memory" );
180 NT_TIB
*teb
= (NT_TIB
*)NtCurrentTeb();
181 teb
->ExceptionList
= (void *)frame
->Prev
;
187 /* Wine-specific exceptions codes */
189 #define EXCEPTION_WINE_STUB 0x80000100 /* stub entry point called */
190 #define EXCEPTION_WINE_ASSERTION 0x80000101 /* assertion failed */
192 /* unhandled return status from vm86 mode */
193 #define EXCEPTION_VM86_INTx 0x80000110
194 #define EXCEPTION_VM86_STI 0x80000111
195 #define EXCEPTION_VM86_PICRETURN 0x80000112
197 extern void __wine_enter_vm86( CONTEXT
*context
);
199 #endif /* __WINE_WINE_EXCEPTION_H */