xref: /php-src/main/php_main.h (revision afc57381)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Andi Gutmans <andi@php.net>                                 |
14    |          Zeev Suraski <zeev@php.net>                                 |
15    +----------------------------------------------------------------------+
16  */
17 
18 #ifndef PHP_MAIN_H
19 #define PHP_MAIN_H
20 
21 #include "zend_globals.h"
22 #include "php_globals.h"
23 #include "SAPI.h"
24 
25 BEGIN_EXTERN_C()
26 
27 /* Returns the PHP version the engine was built with. This is useful for
28  * extensions which want to know the version of PHP at run-time, rather than
29  * the version they were built with at compile-time.
30  */
31 PHPAPI const char *php_version(void);
32 
33 /* Returns the PHP version id the engine was built with. This is useful for
34  * extensions which want to know the version of PHP at run-time, rather than
35  * the version they were built with at compile-time.
36  */
37 PHPAPI unsigned int php_version_id(void);
38 
39 /* Prints the PHP version string for the -v option. It's in main/ so that
40  * it can be shared between SAPIs.
41  */
42 PHPAPI char *php_get_version(sapi_module_struct *sapi_module);
43 PHPAPI void php_print_version(sapi_module_struct *sapi_module);
44 
45 PHPAPI zend_result php_request_startup(void);
46 PHPAPI void php_request_shutdown(void *dummy);
47 PHPAPI zend_result php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_module);
48 PHPAPI void php_module_shutdown(void);
49 PHPAPI int php_module_shutdown_wrapper(sapi_module_struct *sapi_globals);
50 
51 PHPAPI zend_result php_register_extensions(zend_module_entry * const * ptr, int count);
52 
53 PHPAPI bool php_execute_script(zend_file_handle *primary_file);
54 PHPAPI bool php_execute_script_ex(zend_file_handle *primary_file, zval *retval);
55 PHPAPI int php_execute_simple_script(zend_file_handle *primary_file, zval *ret);
56 PHPAPI zend_result php_lint_script(zend_file_handle *file);
57 
58 PHPAPI void php_handle_aborted_connection(void);
59 PHPAPI int php_handle_auth_data(const char *auth);
60 
61 PHPAPI void php_html_puts(const char *str, size_t siz);
62 PHPAPI zend_result php_stream_open_for_zend_ex(zend_file_handle *handle, int mode);
63 
64 /* environment module */
65 extern int php_init_environ(void);
66 extern int php_shutdown_environ(void);
67 
68 #ifdef ZTS
69 PHPAPI void php_reserve_tsrm_memory(void);
70 PHPAPI bool php_tsrm_startup_ex(int expected_threads);
71 PHPAPI bool php_tsrm_startup(void);
72 
73 #define PHP_ZTS 1
74 #else
75 #define PHP_ZTS 0
76 #endif
77 
78 #ifdef PHP_WIN32
79 #define PHP_OS_STR "WINNT"
80 #else
81 #define PHP_OS_STR PHP_OS
82 #endif
83 
84 END_EXTERN_C()
85 
86 #endif
87