zend_ini.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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. | Author: Zeev Suraski <zeev@zend.com> |
  16. +----------------------------------------------------------------------+
  17. */
  18. /* $Id$ */
  19. #ifndef ZEND_INI_H
  20. #define ZEND_INI_H
  21. #define ZEND_INI_USER (1<<0)
  22. #define ZEND_INI_PERDIR (1<<1)
  23. #define ZEND_INI_SYSTEM (1<<2)
  24. #define ZEND_INI_ALL (ZEND_INI_USER|ZEND_INI_PERDIR|ZEND_INI_SYSTEM)
  25. #ifndef XtOffsetOf
  26. # if defined(CRAY) || (defined(__ARMCC_VERSION) && !defined(LINUX))
  27. # ifdef __STDC__
  28. # define XtOffset(p_type, field) _Offsetof(p_type, field)
  29. # else
  30. # ifdef CRAY2
  31. # define XtOffset(p_type, field) \
  32. (sizeof(int)*((unsigned int)&(((p_type)NULL)->field)))
  33. # else /* !CRAY2 */
  34. # define XtOffset(p_type, field) ((unsigned int)&(((p_type)NULL)->field))
  35. # endif /* !CRAY2 */
  36. # endif /* __STDC__ */
  37. # else /* ! (CRAY || __arm) */
  38. # define XtOffset(p_type, field) \
  39. ((long) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
  40. # endif /* !CRAY */
  41. # ifdef offsetof
  42. # define XtOffsetOf(s_type, field) offsetof(s_type, field)
  43. # else
  44. # define XtOffsetOf(s_type, field) XtOffset(s_type*, field)
  45. # endif
  46. #endif
  47. #define ZEND_INI_MH(name) int name(zend_ini_entry *entry, char *new_value, uint new_value_length, void *mh_arg1, void *mh_arg2, void *mh_arg3, int stage TSRMLS_DC)
  48. #define ZEND_INI_DISP(name) void name(zend_ini_entry *ini_entry, int type)
  49. struct _zend_ini_entry {
  50. int module_number;
  51. int modifiable;
  52. char *name;
  53. uint name_length;
  54. ZEND_INI_MH((*on_modify));
  55. void *mh_arg1;
  56. void *mh_arg2;
  57. void *mh_arg3;
  58. char *value;
  59. uint value_length;
  60. char *orig_value;
  61. uint orig_value_length;
  62. int orig_modifiable;
  63. int modified;
  64. void (*displayer)(zend_ini_entry *ini_entry, int type);
  65. };
  66. BEGIN_EXTERN_C()
  67. ZEND_API int zend_ini_startup(TSRMLS_D);
  68. ZEND_API int zend_ini_shutdown(TSRMLS_D);
  69. ZEND_API int zend_ini_global_shutdown(TSRMLS_D);
  70. ZEND_API int zend_ini_deactivate(TSRMLS_D);
  71. ZEND_API int zend_copy_ini_directives(TSRMLS_D);
  72. ZEND_API void zend_ini_sort_entries(TSRMLS_D);
  73. ZEND_API int zend_register_ini_entries(const zend_ini_entry *ini_entry, int module_number TSRMLS_DC);
  74. ZEND_API void zend_unregister_ini_entries(int module_number TSRMLS_DC);
  75. ZEND_API void zend_ini_refresh_caches(int stage TSRMLS_DC);
  76. ZEND_API int zend_alter_ini_entry(char *name, uint name_length, char *new_value, uint new_value_length, int modify_type, int stage);
  77. ZEND_API int zend_alter_ini_entry_ex(char *name, uint name_length, char *new_value, uint new_value_length, int modify_type, int stage, int force_change TSRMLS_DC);
  78. ZEND_API int zend_restore_ini_entry(char *name, uint name_length, int stage);
  79. ZEND_API void display_ini_entries(zend_module_entry *module);
  80. ZEND_API long zend_ini_long(char *name, uint name_length, int orig);
  81. ZEND_API double zend_ini_double(char *name, uint name_length, int orig);
  82. ZEND_API char *zend_ini_string(char *name, uint name_length, int orig);
  83. ZEND_API char *zend_ini_string_ex(char *name, uint name_length, int orig, zend_bool *exists);
  84. ZEND_API int zend_ini_register_displayer(char *name, uint name_length, void (*displayer)(zend_ini_entry *ini_entry, int type));
  85. ZEND_API ZEND_INI_DISP(zend_ini_boolean_displayer_cb);
  86. ZEND_API ZEND_INI_DISP(zend_ini_color_displayer_cb);
  87. ZEND_API ZEND_INI_DISP(display_link_numbers);
  88. END_EXTERN_C()
  89. #define ZEND_INI_BEGIN() static const zend_ini_entry ini_entries[] = {
  90. #define ZEND_INI_END() { 0, 0, NULL, 0, NULL, NULL, NULL, NULL, NULL, 0, NULL, 0, 0, 0, NULL } };
  91. #define ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, displayer) \
  92. { 0, modifiable, name, sizeof(name), on_modify, arg1, arg2, arg3, default_value, sizeof(default_value)-1, NULL, 0, 0, 0, displayer },
  93. #define ZEND_INI_ENTRY3(name, default_value, modifiable, on_modify, arg1, arg2, arg3) \
  94. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, NULL)
  95. #define ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, displayer) \
  96. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL, displayer)
  97. #define ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, arg1, arg2) \
  98. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL)
  99. #define ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, displayer) \
  100. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, NULL, NULL, displayer)
  101. #define ZEND_INI_ENTRY1(name, default_value, modifiable, on_modify, arg1) \
  102. ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, NULL)
  103. #define ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, displayer) \
  104. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, NULL, NULL, NULL, displayer)
  105. #define ZEND_INI_ENTRY(name, default_value, modifiable, on_modify) \
  106. ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, NULL)
  107. #ifdef ZTS
  108. #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  109. ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id)
  110. #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \
  111. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, displayer)
  112. #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  113. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, NULL, zend_ini_boolean_displayer_cb)
  114. #else
  115. #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  116. ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr)
  117. #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \
  118. ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, displayer)
  119. #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \
  120. ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, NULL, zend_ini_boolean_displayer_cb)
  121. #endif
  122. #define INI_INT(name) zend_ini_long((name), sizeof(name), 0)
  123. #define INI_FLT(name) zend_ini_double((name), sizeof(name), 0)
  124. #define INI_STR(name) zend_ini_string_ex((name), sizeof(name), 0, NULL)
  125. #define INI_BOOL(name) ((zend_bool) INI_INT(name))
  126. #define INI_ORIG_INT(name) zend_ini_long((name), sizeof(name), 1)
  127. #define INI_ORIG_FLT(name) zend_ini_double((name), sizeof(name), 1)
  128. #define INI_ORIG_STR(name) zend_ini_string((name), sizeof(name), 1)
  129. #define INI_ORIG_BOOL(name) ((zend_bool) INI_ORIG_INT(name))
  130. #define REGISTER_INI_ENTRIES() zend_register_ini_entries(ini_entries, module_number TSRMLS_CC)
  131. #define UNREGISTER_INI_ENTRIES() zend_unregister_ini_entries(module_number TSRMLS_CC)
  132. #define DISPLAY_INI_ENTRIES() display_ini_entries(zend_module)
  133. #define REGISTER_INI_DISPLAYER(name, displayer) zend_ini_register_displayer((name), sizeof(name), displayer)
  134. #define REGISTER_INI_BOOLEAN(name) REGISTER_INI_DISPLAYER(name, zend_ini_boolean_displayer_cb)
  135. /* Standard message handlers */
  136. BEGIN_EXTERN_C()
  137. ZEND_API ZEND_INI_MH(OnUpdateBool);
  138. ZEND_API ZEND_INI_MH(OnUpdateLong);
  139. ZEND_API ZEND_INI_MH(OnUpdateLongGEZero);
  140. ZEND_API ZEND_INI_MH(OnUpdateReal);
  141. ZEND_API ZEND_INI_MH(OnUpdateString);
  142. ZEND_API ZEND_INI_MH(OnUpdateStringUnempty);
  143. END_EXTERN_C()
  144. #define ZEND_INI_DISPLAY_ORIG 1
  145. #define ZEND_INI_DISPLAY_ACTIVE 2
  146. #define ZEND_INI_STAGE_STARTUP (1<<0)
  147. #define ZEND_INI_STAGE_SHUTDOWN (1<<1)
  148. #define ZEND_INI_STAGE_ACTIVATE (1<<2)
  149. #define ZEND_INI_STAGE_DEACTIVATE (1<<3)
  150. #define ZEND_INI_STAGE_RUNTIME (1<<4)
  151. #define ZEND_INI_STAGE_HTACCESS (1<<5)
  152. /* INI parsing engine */
  153. typedef void (*zend_ini_parser_cb_t)(zval *arg1, zval *arg2, zval *arg3, int callback_type, void *arg TSRMLS_DC);
  154. BEGIN_EXTERN_C()
  155. ZEND_API int zend_parse_ini_file(zend_file_handle *fh, zend_bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg TSRMLS_DC);
  156. ZEND_API int zend_parse_ini_string(char *str, zend_bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg TSRMLS_DC);
  157. END_EXTERN_C()
  158. /* INI entries */
  159. #define ZEND_INI_PARSER_ENTRY 1 /* Normal entry: foo = bar */
  160. #define ZEND_INI_PARSER_SECTION 2 /* Section: [foobar] */
  161. #define ZEND_INI_PARSER_POP_ENTRY 3 /* Offset entry: foo[] = bar */
  162. typedef struct _zend_ini_parser_param {
  163. zend_ini_parser_cb_t ini_parser_cb;
  164. void *arg;
  165. } zend_ini_parser_param;
  166. #endif /* ZEND_INI_H */
  167. /*
  168. * Local variables:
  169. * tab-width: 4
  170. * c-basic-offset: 4
  171. * indent-tabs-mode: t
  172. * End:
  173. */