1
0
mirror of https://github.com/php/php-src.git synced 2026-03-24 00:02:20 +01:00
Files
archived-php-src/ext/intl/timezone/timezone_class.h
Gina Peter Banyard 6600d0e00f ext/intl: Refactor error handling (#19196)
This is a comprehensive refactoring of the error mechanism of the Intl extension.

By moving the prefixing of the current method/function being executed to actual error message creation by accessing the execution context, we get the following benefits:
- Accurate error messages indicating *what* call caused the error
  - As we *always* "copy" the message, the `copyMsg` arg becomes unused, meaning we can reduce the size of the `intl_error` struct by 4 bytes.
  - Saving it as a zend_string means we know the length of the message
- Remove the need to pass around a "function name" `char*` across multiple calls
- Use Intl's exception mechanism to generate exceptions for constructor call
  - This removes the need for replacing the error handler
  - Which didn't do anything anyway in silent mode, which required throwing non-descriptive exceptions
2025-07-30 16:00:37 +01:00

80 lines
2.8 KiB
C

/*
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| https://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Authors: Gustavo Lopes <cataphract@netcabo.pt> |
+----------------------------------------------------------------------+
*/
#ifndef TIMEZONE_CLASS_H
#define TIMEZONE_CLASS_H
//redefinition of inline in PHP headers causes problems, so include this before
#include <math.h>
//fixes the build on windows for old versions of ICU
#include <stdio.h>
#include <php.h>
#include "intl_error.h"
#include "intl_data.h"
#ifndef USE_TIMEZONE_POINTER
typedef void TimeZone;
#else
using icu::TimeZone;
#endif
typedef struct {
// error handling
intl_error err;
// ICU TimeZone
// TODO?: a direct change isn't possible due to C inclusion (also it s a const)
// but see later it can be made possible through different ICU class usages
const TimeZone *utimezone;
//whether to delete the timezone on object free
bool should_delete;
zend_object zo;
} TimeZone_object;
static inline TimeZone_object *php_intl_timezone_fetch_object(zend_object *obj) {
return (TimeZone_object *)((char*)(obj) - XtOffsetOf(TimeZone_object, zo));
}
#define Z_INTL_TIMEZONE_P(zv) php_intl_timezone_fetch_object(Z_OBJ_P(zv))
#define TIMEZONE_ERROR(to) (to)->err
#define TIMEZONE_ERROR_P(to) &(TIMEZONE_ERROR(to))
#define TIMEZONE_ERROR_CODE(co) INTL_ERROR_CODE(TIMEZONE_ERROR(to))
#define TIMEZONE_ERROR_CODE_P(co) &(INTL_ERROR_CODE(TIMEZONE_ERROR(to)))
#define TIMEZONE_METHOD_INIT_VARS INTL_METHOD_INIT_VARS(TimeZone, to)
#define TIMEZONE_METHOD_FETCH_OBJECT_NO_CHECK INTL_METHOD_FETCH_OBJECT(INTL_TIMEZONE, to)
#define TIMEZONE_METHOD_FETCH_OBJECT\
TIMEZONE_METHOD_FETCH_OBJECT_NO_CHECK; \
if (to->utimezone == NULL) { \
zend_throw_error(NULL, "Found unconstructed IntlTimeZone"); \
RETURN_THROWS(); \
}
zval *timezone_convert_to_datetimezone(const TimeZone *timeZone, intl_error *outside_error, zval *ret);
TimeZone *timezone_process_timezone_argument(zval *zv_timezone, intl_error *error);
void timezone_object_construct(const TimeZone *zone, zval *object, int owned);
void timezone_register_IntlTimeZone_class(void);
extern zend_class_entry *TimeZone_ce_ptr;
extern zend_object_handlers TimeZone_handlers;
#endif /* #ifndef TIMEZONE_CLASS_H */