xref: /PHP-7.1/Zend/zend_exceptions.h (revision ccd4716e)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1998-2018 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@zend.com>                                |
16    |          Marcus Boerger <helly@php.net>                              |
17    |          Sterling Hughes <sterling@php.net>                          |
18    |          Zeev Suraski <zeev@zend.com>                                |
19    +----------------------------------------------------------------------+
20 */
21 
22 /* $Id$ */
23 
24 #ifndef ZEND_EXCEPTIONS_H
25 #define ZEND_EXCEPTIONS_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_parse_error;
34 extern ZEND_API zend_class_entry *zend_ce_type_error;
35 extern ZEND_API zend_class_entry *zend_ce_argument_count_error;
36 extern ZEND_API zend_class_entry *zend_ce_arithmetic_error;
37 extern ZEND_API zend_class_entry *zend_ce_division_by_zero_error;
38 
39 ZEND_API void zend_exception_set_previous(zend_object *exception, zend_object *add_previous);
40 ZEND_API void zend_exception_save(void);
41 ZEND_API void zend_exception_restore(void);
42 
43 ZEND_API ZEND_COLD void zend_throw_exception_internal(zval *exception);
44 
45 void zend_register_default_exception(void);
46 
47 ZEND_API zend_class_entry *zend_get_exception_base(zval *object);
48 
49 /* Deprecated - Use zend_ce_exception directly instead */
50 ZEND_API zend_class_entry *zend_exception_get_default(void);
51 
52 /* Deprecated - Use zend_ce_error_exception directly instead */
53 ZEND_API zend_class_entry *zend_get_error_exception(void);
54 
55 ZEND_API void zend_register_default_classes(void);
56 
57 /* exception_ce   NULL, zend_ce_exception, zend_ce_error, or a derived class
58  * message        NULL or the message of the exception */
59 ZEND_API ZEND_COLD zend_object *zend_throw_exception(zend_class_entry *exception_ce, const char *message, zend_long code);
60 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);
61 ZEND_API ZEND_COLD void zend_throw_exception_object(zval *exception);
62 ZEND_API void zend_clear_exception(void);
63 
64 ZEND_API zend_object *zend_throw_error_exception(zend_class_entry *exception_ce, const char *message, zend_long code, int severity);
65 
66 extern ZEND_API void (*zend_throw_exception_hook)(zval *ex);
67 
68 /* show an exception using zend_error(severity,...), severity should be E_ERROR */
69 ZEND_API ZEND_COLD void zend_exception_error(zend_object *exception, int severity);
70 
71 /* do not export, in php it's available thru spprintf directly */
72 size_t zend_spprintf(char **message, size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 3, 4);
73 zend_string *zend_strpprintf(size_t max_len, const char *format, ...) ZEND_ATTRIBUTE_FORMAT(printf, 2, 3);
74 
75 END_EXTERN_C()
76 
77 #endif
78 
79 /*
80  * Local variables:
81  * tab-width: 4
82  * c-basic-offset: 4
83  * indent-tabs-mode: t
84  * End:
85  */
86