root/Zend/zend_exceptions.h

INCLUDED FROM

   1 /*
   2    +----------------------------------------------------------------------+
   3    | Zend Engine                                                          |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 1998-2016 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_arithmetic_error;
  36 extern ZEND_API zend_class_entry *zend_ce_division_by_zero_error;
  37 
  38 ZEND_API void zend_exception_set_previous(zend_object *exception, zend_object *add_previous);
  39 ZEND_API void zend_exception_save(void);
  40 ZEND_API void zend_exception_restore(void);
  41 
  42 ZEND_API ZEND_COLD void zend_throw_exception_internal(zval *exception);
  43 
  44 void zend_register_default_exception(void);
  45 
  46 ZEND_API zend_class_entry *zend_get_exception_base(zval *object);
  47 
  48 /* Deprecated - Use zend_ce_exception directly instead */
  49 ZEND_API zend_class_entry *zend_exception_get_default(void);
  50 
  51 /* Deprecated - Use zend_ce_error_exception directly instead */
  52 ZEND_API zend_class_entry *zend_get_error_exception(void);
  53 
  54 ZEND_API void zend_register_default_classes(void);
  55 
  56 /* exception_ce   NULL, zend_ce_exception, zend_ce_error, or a derived class
  57  * message        NULL or the message of the exception */
  58 ZEND_API ZEND_COLD zend_object *zend_throw_exception(zend_class_entry *exception_ce, const char *message, zend_long code);
  59 ZEND_API ZEND_COLD zend_object *zend_throw_exception_ex(zend_class_entry *exception_ce, zend_long code, const char *format, ...);
  60 ZEND_API ZEND_COLD void zend_throw_exception_object(zval *exception);
  61 ZEND_API void zend_clear_exception(void);
  62 
  63 ZEND_API zend_object *zend_throw_error_exception(zend_class_entry *exception_ce, const char *message, zend_long code, int severity);
  64 
  65 extern ZEND_API void (*zend_throw_exception_hook)(zval *ex);
  66 
  67 /* show an exception using zend_error(severity,...), severity should be E_ERROR */
  68 ZEND_API ZEND_COLD void zend_exception_error(zend_object *exception, int severity);
  69 
  70 /* do not export, in php it's available thru spprintf directly */
  71 size_t zend_spprintf(char **message, size_t max_len, const char *format, ...);
  72 zend_string *zend_strpprintf(size_t max_len, const char *format, ...);
  73 
  74 END_EXTERN_C()
  75 
  76 #endif
  77 
  78 /*
  79  * Local variables:
  80  * tab-width: 4
  81  * c-basic-offset: 4
  82  * indent-tabs-mode: t
  83  * End:
  84  */