/*

   +----------------------------------------------------------------------+

   | Zend Engine                                                          |

   +----------------------------------------------------------------------+

   | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |

   +----------------------------------------------------------------------+

   | This source file is subject to version 2.00 of the Zend license,     |

   | that is bundled with this package in the file LICENSE, and is        |

   | available through the world-wide-web at the following url:           |

   | http://www.zend.com/license/2_00.txt.                                |

   | If you did not receive a copy of the Zend license and are unable to  |

   | obtain it through the world-wide-web, please send a note to          |

   | license@zend.com so we can mail you a copy immediately.              |

   +----------------------------------------------------------------------+

   | Authors: Andi Gutmans <andi@php.net>                                 |

   |          Zeev Suraski <zeev@php.net>                                 |

   +----------------------------------------------------------------------+

*/

#ifndef ZEND_EXTENSIONS_H

#define ZEND_EXTENSIONS_H

#include "zend_compile.h"

#include "zend_build.h"

/*

The constants below are derived from ext/opcache/ZendAccelerator.h

You can use the following macro to check the extension API version for compatibilities:

#define ZEND_EXTENSION_API_NO_5_0_X 220040412

#define ZEND_EXTENSION_API_NO_5_1_X 220051025

#define ZEND_EXTENSION_API_NO_5_2_X 220060519

#define ZEND_EXTENSION_API_NO_5_3_X 220090626

#define ZEND_EXTENSION_API_NO_5_4_X 220100525

#define ZEND_EXTENSION_API_NO_5_5_X 220121212

#define ZEND_EXTENSION_API_NO_5_6_X 220131226

#define ZEND_EXTENSION_API_NO_7_0_X 320151012

#if ZEND_EXTENSION_API_NO < ZEND_EXTENSION_API_NO_5_5_X

   // do something for php versions lower than 5.5.x

#endif

*/

/* The first number is the engine version and the rest is the date (YYYYMMDD).

 * This way engine 2/3 API no. is always greater than engine 1 API no..  */

#define ZEND_EXTENSION_API_NO 420190128

typedef struct _zend_extension_version_info {

  int zend_extension_api_no;

  char *build_id;

} zend_extension_version_info;

#define ZEND_EXTENSION_BUILD_ID "API" ZEND_TOSTR(ZEND_EXTENSION_API_NO) ZEND_BUILD_TS ZEND_BUILD_DEBUG ZEND_BUILD_SYSTEM ZEND_BUILD_EXTRA

typedef struct _zend_extension zend_extension;

/* Typedef's for zend_extension function pointers */

typedef int (*startup_func_t)(zend_extension *extension);

typedef void (*shutdown_func_t)(zend_extension *extension);

typedef void (*activate_func_t)(void);

typedef void (*deactivate_func_t)(void);

typedef void (*message_handler_func_t)(int message, void *arg);

typedef void (*op_array_handler_func_t)(zend_op_array *op_array);

typedef void (*statement_handler_func_t)(zend_execute_data *frame);

typedef void (*fcall_begin_handler_func_t)(zend_execute_data *frame);

typedef void (*fcall_end_handler_func_t)(zend_execute_data *frame);

typedef void (*op_array_ctor_func_t)(zend_op_array *op_array);

typedef void (*op_array_dtor_func_t)(zend_op_array *op_array);

typedef size_t (*op_array_persist_calc_func_t)(zend_op_array *op_array);

typedef size_t (*op_array_persist_func_t)(zend_op_array *op_array, void *mem);

struct _zend_extension {

  char *name;

  char *version;

  char *author;

  char *URL;

  char *copyright;

  startup_func_t startup;

  shutdown_func_t shutdown;

  activate_func_t activate;

  deactivate_func_t deactivate;

  message_handler_func_t message_handler;

  op_array_handler_func_t op_array_handler;

  statement_handler_func_t statement_handler;

  fcall_begin_handler_func_t fcall_begin_handler;

  fcall_end_handler_func_t fcall_end_handler;

  op_array_ctor_func_t op_array_ctor;

  op_array_dtor_func_t op_array_dtor;

  int (*api_no_check)(int api_no);

  int (*build_id_check)(const char* build_id);

  op_array_persist_calc_func_t op_array_persist_calc;

  op_array_persist_func_t op_array_persist;

  void *reserved5;

  void *reserved6;

  void *reserved7;

  void *reserved8;

  DL_HANDLE handle;

  int resource_number;

};

BEGIN_EXTERN_C()

extern ZEND_API int zend_op_array_extension_handles;

ZEND_API int zend_get_resource_handle(zend_extension *extension);

ZEND_API int zend_get_op_array_extension_handle(void);

ZEND_API void zend_extension_dispatch_message(int message, void *arg);

END_EXTERN_C()

#define ZEND_EXTMSG_NEW_EXTENSION   1

#define ZEND_EXTENSION()  \

  ZEND_EXT_API zend_extension_version_info extension_version_info = { ZEND_EXTENSION_API_NO, ZEND_EXTENSION_BUILD_ID }

#define STANDARD_ZEND_EXTENSION_PROPERTIES       NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, -1

#define COMPAT_ZEND_EXTENSION_PROPERTIES         NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, -1

#define BUILD_COMPAT_ZEND_EXTENSION_PROPERTIES   NULL, NULL, NULL, NULL, NULL, NULL, NULL, -1

ZEND_API extern zend_llist zend_extensions;

ZEND_API extern uint32_t zend_extension_flags;

#define ZEND_EXTENSIONS_HAVE_OP_ARRAY_CTOR         (1<<0)

#define ZEND_EXTENSIONS_HAVE_OP_ARRAY_DTOR         (1<<1)

#define ZEND_EXTENSIONS_HAVE_OP_ARRAY_HANDLER      (1<<2)

#define ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST_CALC (1<<3)

#define ZEND_EXTENSIONS_HAVE_OP_ARRAY_PERSIST      (1<<4)

void zend_extension_dtor(zend_extension *extension);

ZEND_API void zend_append_version_info(const zend_extension *extension);

int zend_startup_extensions_mechanism(void);

int zend_startup_extensions(void);

void zend_shutdown_extensions(void);

BEGIN_EXTERN_C()

ZEND_API int zend_load_extension(const char *path);

ZEND_API int zend_load_extension_handle(DL_HANDLE handle, const char *path);

ZEND_API int zend_register_extension(zend_extension *new_extension, DL_HANDLE handle);

ZEND_API zend_extension *zend_get_extension(const char *extension_name);

ZEND_API size_t zend_extensions_op_array_persist_calc(zend_op_array *op_array);

ZEND_API size_t zend_extensions_op_array_persist(zend_op_array *op_array, void *mem);

END_EXTERN_C()

#endif /* ZEND_EXTENSIONS_H */