php-src/ext/intl/spoofchecker/spoofchecker_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

84 lines
3.1 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: Scott MacVicar <scottmac@php.net> |
+----------------------------------------------------------------------+
*/
#ifndef SPOOFCHECKER_CLASS_H
#define SPOOFCHECKER_CLASS_H
#include <php.h>
#include "intl_common.h"
#include "intl_error.h"
#include "intl_data.h"
#include <unicode/uspoof.h>
typedef struct {
// error handling
intl_error err;
// ICU Spoofchecker
USpoofChecker* uspoof;
#if U_ICU_VERSION_MAJOR_NUM >= 58
USpoofCheckResult* uspoofres;
#endif
zend_object zo;
} Spoofchecker_object;
static inline Spoofchecker_object *php_intl_spoofchecker_fetch_object(zend_object *obj) {
return (Spoofchecker_object *)((char*)(obj) - XtOffsetOf(Spoofchecker_object, zo));
}
#define Z_INTL_SPOOFCHECKER_P(zv) php_intl_spoofchecker_fetch_object((Z_OBJ_P(zv)))
#define SPOOFCHECKER_ERROR(co) (co)->err
#define SPOOFCHECKER_ERROR_P(co) &(SPOOFCHECKER_ERROR(co))
#define SPOOFCHECKER_ERROR_CODE(co) INTL_ERROR_CODE(SPOOFCHECKER_ERROR(co))
#define SPOOFCHECKER_ERROR_CODE_P(co) &(INTL_ERROR_CODE(SPOOFCHECKER_ERROR(co)))
void spoofchecker_register_Spoofchecker_class(void);
void spoofchecker_object_init(Spoofchecker_object* co);
void spoofchecker_object_destroy(Spoofchecker_object* co);
extern zend_class_entry *Spoofchecker_ce_ptr;
/* Auxiliary macros */
#define SPOOFCHECKER_METHOD_INIT_VARS \
zval* object = ZEND_THIS; \
Spoofchecker_object* co = NULL; \
intl_error_reset(NULL); \
#define SPOOFCHECKER_METHOD_FETCH_OBJECT_NO_CHECK INTL_METHOD_FETCH_OBJECT(INTL_SPOOFCHECKER, co)
#define SPOOFCHECKER_METHOD_FETCH_OBJECT \
SPOOFCHECKER_METHOD_FETCH_OBJECT_NO_CHECK; \
if (co->uspoof == NULL) { \
zend_throw_error(NULL, "Found unconstructed Spoofchecker"); \
RETURN_THROWS(); \
}
// Macro to check return value of a ucol_* function call.
#define SPOOFCHECKER_CHECK_STATUS(co, msg) \
intl_error_set_code(NULL, SPOOFCHECKER_ERROR_CODE(co)); \
if (U_FAILURE(SPOOFCHECKER_ERROR_CODE(co))) { \
intl_errors_set_custom_msg(SPOOFCHECKER_ERROR_P(co), msg); \
RETURN_FALSE; \
} \
#if U_ICU_VERSION_MAJOR_NUM >= 58
#define SPOOFCHECKER_DEFAULT_RESTRICTION_LEVEL USPOOF_HIGHLY_RESTRICTIVE
#endif
#endif // #ifndef SPOOFCHECKER_CLASS_H