1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 2.00 of the Zend license, |
8 | that is bundled with this package in the file LICENSE, and is |
9 | available through the world-wide-web at the following url: |
10 | http://www.zend.com/license/2_00.txt. |
11 | If you did not receive a copy of the Zend license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@zend.com so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Authors: Andi Gutmans <andi@php.net> |
16 | Marcus Boerger <helly@php.net> |
17 | Sterling Hughes <sterling@php.net> |
18 | Zeev Suraski <zeev@php.net> |
19 +----------------------------------------------------------------------+
20 */
21
22 #ifndef ZEND_EXCEPTIONS_H
23 #define ZEND_EXCEPTIONS_H
24
25 #include "zend_types.h"
26
27 BEGIN_EXTERN_C()
28
29 extern ZEND_API zend_class_entry *zend_ce_throwable;
30 extern ZEND_API zend_class_entry *zend_ce_exception;
31 extern ZEND_API zend_class_entry *zend_ce_error_exception;
32 extern ZEND_API zend_class_entry *zend_ce_error;
33 extern ZEND_API zend_class_entry *zend_ce_compile_error;
34 extern ZEND_API zend_class_entry *zend_ce_parse_error;
35 extern ZEND_API zend_class_entry *zend_ce_type_error;
36 extern ZEND_API zend_class_entry *zend_ce_argument_count_error;
37 extern ZEND_API zend_class_entry *zend_ce_value_error;
38 extern ZEND_API zend_class_entry *zend_ce_arithmetic_error;
39 extern ZEND_API zend_class_entry *zend_ce_division_by_zero_error;
40 extern ZEND_API zend_class_entry *zend_ce_unhandled_match_error;
41 extern ZEND_API zend_class_entry *zend_ce_request_parse_body_exception;
42
43 ZEND_API void zend_exception_set_previous(zend_object *exception, zend_object *add_previous);
44 ZEND_API void zend_exception_save(void);
45 ZEND_API void zend_exception_restore(void);
46
47 ZEND_API ZEND_COLD void zend_throw_exception_internal(zend_object *exception);
48
49 void zend_register_default_exception(void);
50
51 ZEND_API zend_class_entry *zend_get_exception_base(zend_object *object);
52
53 /* Deprecated - Use zend_ce_exception directly instead */
54 ZEND_API zend_class_entry *zend_exception_get_default(void);
55
56 /* Deprecated - Use zend_ce_error_exception directly instead */
57 ZEND_API zend_class_entry *zend_get_error_exception(void);
58
59 ZEND_API void zend_register_default_classes(void);
60
61 /* exception_ce NULL, zend_ce_exception, zend_ce_error, or a derived class
62 * message NULL or the message of the exception */
63 ZEND_API ZEND_COLD zend_object *zend_throw_exception(zend_class_entry *exception_ce, const char *message, zend_long code);
64 ZEND_API ZEND_COLD zend_object *zend_throw_exception_ex(zend_class_entry *exception_ce, zend_long code, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 3, 4);
65 ZEND_API ZEND_COLD void zend_throw_exception_object(zval *exception);
66 ZEND_API void zend_clear_exception(void);
67
68 ZEND_API zend_object *zend_throw_error_exception(zend_class_entry *exception_ce, zend_string *message, zend_long code, int severity);
69
70 extern ZEND_API void (*zend_throw_exception_hook)(zend_object *ex);
71
72 /* show an exception using zend_error(severity,...), severity should be E_ERROR */
73 ZEND_API ZEND_COLD zend_result zend_exception_error(zend_object *exception, int severity);
74 ZEND_NORETURN void zend_exception_uncaught_error(const char *prefix, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);
75 ZEND_API zend_string *zend_trace_to_string(const HashTable *trace, bool include_main);
76
77 ZEND_API ZEND_COLD zend_object *zend_create_unwind_exit(void);
78 ZEND_API ZEND_COLD zend_object *zend_create_graceful_exit(void);
79 ZEND_API ZEND_COLD void zend_throw_unwind_exit(void);
80 ZEND_API ZEND_COLD void zend_throw_graceful_exit(void);
81 ZEND_API bool zend_is_unwind_exit(const zend_object *ex);
82 ZEND_API bool zend_is_graceful_exit(const zend_object *ex);
83
84 #include "zend_globals.h"
85
zend_rethrow_exception(zend_execute_data * execute_data)86 static zend_always_inline void zend_rethrow_exception(zend_execute_data *execute_data)
87 {
88 if (EX(opline)->opcode != ZEND_HANDLE_EXCEPTION) {
89 EG(opline_before_exception) = EX(opline);
90 EX(opline) = EG(exception_op);
91 }
92 }
93
94 END_EXTERN_C()
95
96 #endif
97