xref: /PHP-5.3/Zend/zend_compile.h (revision 831fbcf3)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1998-2013 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    | Authors: Andi Gutmans <andi@zend.com>                                |
16    |          Zeev Suraski <zeev@zend.com>                                |
17    +----------------------------------------------------------------------+
18 */
19 
20 /* $Id$ */
21 
22 #ifndef ZEND_COMPILE_H
23 #define ZEND_COMPILE_H
24 
25 #include "zend.h"
26 
27 #ifdef HAVE_STDARG_H
28 # include <stdarg.h>
29 #endif
30 
31 #include "zend_llist.h"
32 
33 #define DEBUG_ZEND 0
34 
35 #define FREE_PNODE(znode)	zval_dtor(&znode->u.constant);
36 
37 #define SET_UNUSED(op)  (op).op_type = IS_UNUSED
38 
39 #define INC_BPC(op_array)	if (op_array->fn_flags & ZEND_ACC_INTERACTIVE) { ((op_array)->backpatch_count++); }
40 #define DEC_BPC(op_array)	if (op_array->fn_flags & ZEND_ACC_INTERACTIVE) { ((op_array)->backpatch_count--); }
41 #define HANDLE_INTERACTIVE()  if (CG(active_op_array)->fn_flags & ZEND_ACC_INTERACTIVE) { execute_new_code(TSRMLS_C); }
42 #define DO_TICKS()            if (Z_LVAL(CG(declarables).ticks)) { zend_do_ticks(TSRMLS_C); }
43 
44 #define RESET_DOC_COMMENT()        \
45     {                              \
46         if (CG(doc_comment)) {     \
47           efree(CG(doc_comment));  \
48           CG(doc_comment) = NULL;  \
49         }                          \
50         CG(doc_comment_len) = 0;   \
51     }
52 
53 typedef struct _zend_op_array zend_op_array;
54 typedef struct _zend_op zend_op;
55 
56 typedef struct _znode {
57 	int op_type;
58 	union {
59 		zval constant;
60 
61 		zend_uint var;
62 		zend_uint opline_num; /*  Needs to be signed */
63 		zend_op_array *op_array;
64 		zend_op *jmp_addr;
65 		struct {
66 			zend_uint var;	/* dummy */
67 			zend_uint type;
68 		} EA;
69 	} u;
70 } znode;
71 
72 typedef struct _zend_execute_data zend_execute_data;
73 
74 #define ZEND_OPCODE_HANDLER_ARGS zend_execute_data *execute_data TSRMLS_DC
75 #define ZEND_OPCODE_HANDLER_ARGS_PASSTHRU execute_data TSRMLS_CC
76 
77 typedef int (*user_opcode_handler_t) (ZEND_OPCODE_HANDLER_ARGS);
78 typedef int (ZEND_FASTCALL *opcode_handler_t) (ZEND_OPCODE_HANDLER_ARGS);
79 
80 extern ZEND_API opcode_handler_t *zend_opcode_handlers;
81 
82 struct _zend_op {
83 	opcode_handler_t handler;
84 	znode result;
85 	znode op1;
86 	znode op2;
87 	ulong extended_value;
88 	uint lineno;
89 	zend_uchar opcode;
90 };
91 
92 
93 typedef struct _zend_brk_cont_element {
94 	int start;
95 	int cont;
96 	int brk;
97 	int parent;
98 } zend_brk_cont_element;
99 
100 typedef struct _zend_label {
101 	int brk_cont;
102 	zend_uint opline_num;
103 } zend_label;
104 
105 typedef struct _zend_try_catch_element {
106 	zend_uint try_op;
107 	zend_uint catch_op;  /* ketchup! */
108 } zend_try_catch_element;
109 
110 
111 /* method flags (types) */
112 #define ZEND_ACC_STATIC			0x01
113 #define ZEND_ACC_ABSTRACT		0x02
114 #define ZEND_ACC_FINAL			0x04
115 #define ZEND_ACC_IMPLEMENTED_ABSTRACT		0x08
116 
117 /* class flags (types) */
118 /* ZEND_ACC_IMPLICIT_ABSTRACT_CLASS is used for abstract classes (since it is set by any abstract method even interfaces MAY have it set, too). */
119 /* ZEND_ACC_EXPLICIT_ABSTRACT_CLASS denotes that a class was explicitly defined as abstract by using the keyword. */
120 #define ZEND_ACC_IMPLICIT_ABSTRACT_CLASS	0x10
121 #define ZEND_ACC_EXPLICIT_ABSTRACT_CLASS	0x20
122 #define ZEND_ACC_FINAL_CLASS	            0x40
123 #define ZEND_ACC_INTERFACE		            0x80
124 
125 /* op_array flags */
126 #define ZEND_ACC_INTERACTIVE				0x10
127 
128 /* method flags (visibility) */
129 /* The order of those must be kept - public < protected < private */
130 #define ZEND_ACC_PUBLIC		0x100
131 #define ZEND_ACC_PROTECTED	0x200
132 #define ZEND_ACC_PRIVATE	0x400
133 #define ZEND_ACC_PPP_MASK  (ZEND_ACC_PUBLIC | ZEND_ACC_PROTECTED | ZEND_ACC_PRIVATE)
134 
135 #define ZEND_ACC_CHANGED	0x800
136 #define ZEND_ACC_IMPLICIT_PUBLIC	0x1000
137 
138 /* method flags (special method detection) */
139 #define ZEND_ACC_CTOR		0x2000
140 #define ZEND_ACC_DTOR		0x4000
141 #define ZEND_ACC_CLONE		0x8000
142 
143 /* method flag (bc only), any method that has this flag can be used statically and non statically. */
144 #define ZEND_ACC_ALLOW_STATIC	0x10000
145 
146 /* shadow of parent's private method/property */
147 #define ZEND_ACC_SHADOW 0x20000
148 
149 /* deprecation flag */
150 #define ZEND_ACC_DEPRECATED 0x40000
151 
152 /* class implement interface(s) flag */
153 #define ZEND_ACC_IMPLEMENT_INTERFACES 0x80000
154 
155 #define ZEND_ACC_CLOSURE              0x100000
156 
157 /* function flag for internal user call handlers __call, __callstatic */
158 #define ZEND_ACC_CALL_VIA_HANDLER     0x200000
159 
160 char *zend_visibility_string(zend_uint fn_flags);
161 
162 
163 typedef struct _zend_property_info {
164 	zend_uint flags;
165 	char *name;
166 	int name_length;
167 	ulong h;
168 	char *doc_comment;
169 	int doc_comment_len;
170 	zend_class_entry *ce;
171 } zend_property_info;
172 
173 
174 typedef struct _zend_arg_info {
175 	const char *name;
176 	zend_uint name_len;
177 	const char *class_name;
178 	zend_uint class_name_len;
179 	zend_bool array_type_hint;
180 	zend_bool allow_null;
181 	zend_bool pass_by_reference;
182 	zend_bool return_reference;
183 	int required_num_args;
184 } zend_arg_info;
185 
186 typedef struct _zend_compiled_variable {
187 	char *name;
188 	int name_len;
189 	ulong hash_value;
190 } zend_compiled_variable;
191 
192 struct _zend_op_array {
193 	/* Common elements */
194 	zend_uchar type;
195 	char *function_name;
196 	zend_class_entry *scope;
197 	zend_uint fn_flags;
198 	union _zend_function *prototype;
199 	zend_uint num_args;
200 	zend_uint required_num_args;
201 	zend_arg_info *arg_info;
202 	zend_bool pass_rest_by_reference;
203 	unsigned char return_reference;
204 	/* END of common elements */
205 
206 	zend_bool done_pass_two;
207 
208 	zend_uint *refcount;
209 
210 	zend_op *opcodes;
211 	zend_uint last, size;
212 
213 	zend_compiled_variable *vars;
214 	int last_var, size_var;
215 
216 	zend_uint T;
217 
218 	zend_brk_cont_element *brk_cont_array;
219 	int last_brk_cont;
220 	int current_brk_cont;
221 
222 	zend_try_catch_element *try_catch_array;
223 	int last_try_catch;
224 
225 	/* static variables support */
226 	HashTable *static_variables;
227 
228 	zend_op *start_op;
229 	int backpatch_count;
230 
231 	zend_uint this_var;
232 
233 	char *filename;
234 	zend_uint line_start;
235 	zend_uint line_end;
236 	char *doc_comment;
237 	zend_uint doc_comment_len;
238 	zend_uint early_binding; /* the linked list of delayed declarations */
239 
240 	void *reserved[ZEND_MAX_RESERVED_RESOURCES];
241 };
242 
243 
244 #define ZEND_RETURN_VALUE				0
245 #define ZEND_RETURN_REFERENCE			1
246 
247 typedef struct _zend_internal_function {
248 	/* Common elements */
249 	zend_uchar type;
250 	char * function_name;
251 	zend_class_entry *scope;
252 	zend_uint fn_flags;
253 	union _zend_function *prototype;
254 	zend_uint num_args;
255 	zend_uint required_num_args;
256 	zend_arg_info *arg_info;
257 	zend_bool pass_rest_by_reference;
258 	unsigned char return_reference;
259 	/* END of common elements */
260 
261 	void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
262 	struct _zend_module_entry *module;
263 } zend_internal_function;
264 
265 #define ZEND_FN_SCOPE_NAME(function)  ((function) && (function)->common.scope ? (function)->common.scope->name : "")
266 
267 typedef union _zend_function {
268 	zend_uchar type;	/* MUST be the first element of this struct! */
269 
270 	struct {
271 		zend_uchar type;  /* never used */
272 		char *function_name;
273 		zend_class_entry *scope;
274 		zend_uint fn_flags;
275 		union _zend_function *prototype;
276 		zend_uint num_args;
277 		zend_uint required_num_args;
278 		zend_arg_info *arg_info;
279 		zend_bool pass_rest_by_reference;
280 		unsigned char return_reference;
281 	} common;
282 
283 	zend_op_array op_array;
284 	zend_internal_function internal_function;
285 } zend_function;
286 
287 
288 typedef struct _zend_function_state {
289 	zend_function *function;
290 	void **arguments;
291 } zend_function_state;
292 
293 
294 typedef struct _zend_switch_entry {
295 	znode cond;
296 	int default_case;
297 	int control_var;
298 } zend_switch_entry;
299 
300 
301 typedef struct _list_llist_element {
302 	znode var;
303 	zend_llist dimensions;
304 	znode value;
305 } list_llist_element;
306 
307 union _temp_variable;
308 
309 struct _zend_execute_data {
310 	struct _zend_op *opline;
311 	zend_function_state function_state;
312 	zend_function *fbc; /* Function Being Called */
313 	zend_class_entry *called_scope;
314 	zend_op_array *op_array;
315 	zval *object;
316 	union _temp_variable *Ts;
317 	zval ***CVs;
318 	HashTable *symbol_table;
319 	struct _zend_execute_data *prev_execute_data;
320 	zval *old_error_reporting;
321 	zend_bool nested;
322 	zval **original_return_value;
323 	zend_class_entry *current_scope;
324 	zend_class_entry *current_called_scope;
325 	zval *current_this;
326 	zval *current_object;
327 	struct _zend_op *call_opline;
328 };
329 
330 #define EX(element) execute_data.element
331 
332 
333 #define IS_CONST	(1<<0)
334 #define IS_TMP_VAR	(1<<1)
335 #define IS_VAR		(1<<2)
336 #define IS_UNUSED	(1<<3)	/* Unused variable */
337 #define IS_CV		(1<<4)	/* Compiled variable */
338 
339 #define EXT_TYPE_UNUSED				(1<<0)
340 #define EXT_TYPE_FREE_ON_RETURN		(2<<0)
341 
342 #include "zend_globals.h"
343 
344 BEGIN_EXTERN_C()
345 
346 void init_compiler(TSRMLS_D);
347 void shutdown_compiler(TSRMLS_D);
348 void zend_init_compiler_data_structures(TSRMLS_D);
349 
350 extern ZEND_API zend_op_array *(*zend_compile_file)(zend_file_handle *file_handle, int type TSRMLS_DC);
351 extern ZEND_API zend_op_array *(*zend_compile_string)(zval *source_string, char *filename TSRMLS_DC);
352 
353 ZEND_API int lex_scan(zval *zendlval TSRMLS_DC);
354 void startup_scanner(TSRMLS_D);
355 void shutdown_scanner(TSRMLS_D);
356 
357 ZEND_API char *zend_set_compiled_filename(const char *new_compiled_filename TSRMLS_DC);
358 ZEND_API void zend_restore_compiled_filename(char *original_compiled_filename TSRMLS_DC);
359 ZEND_API char *zend_get_compiled_filename(TSRMLS_D);
360 ZEND_API int zend_get_compiled_lineno(TSRMLS_D);
361 ZEND_API size_t zend_get_scanned_file_offset(TSRMLS_D);
362 
363 void zend_resolve_non_class_name(znode *element_name, zend_bool check_namespace TSRMLS_DC);
364 void zend_resolve_class_name(znode *class_name, ulong *fetch_type, int check_ns_name TSRMLS_DC);
365 ZEND_API char* zend_get_compiled_variable_name(const zend_op_array *op_array, zend_uint var, int* name_len);
366 
367 #ifdef ZTS
368 const char *zend_get_zendtext(TSRMLS_D);
369 int zend_get_zendleng(TSRMLS_D);
370 #endif
371 
372 
373 /* parser-driven code generators */
374 void zend_do_binary_op(zend_uchar op, znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
375 void zend_do_unary_op(zend_uchar op, znode *result, const znode *op1 TSRMLS_DC);
376 void zend_do_binary_assign_op(zend_uchar op, znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
377 void zend_do_assign(znode *result, znode *variable, const znode *value TSRMLS_DC);
378 void zend_do_assign_ref(znode *result, const znode *lvar, const znode *rvar TSRMLS_DC);
379 void fetch_simple_variable(znode *result, znode *varname, int bp TSRMLS_DC);
380 void fetch_simple_variable_ex(znode *result, znode *varname, int bp, zend_uchar op TSRMLS_DC);
381 void zend_do_indirect_references(znode *result, const znode *num_references, znode *variable TSRMLS_DC);
382 void zend_do_fetch_static_variable(znode *varname, const znode *static_assignment, int fetch_type TSRMLS_DC);
383 void zend_do_fetch_global_variable(znode *varname, const znode *static_assignment, int fetch_type TSRMLS_DC);
384 
385 void fetch_array_begin(znode *result, znode *varname, znode *first_dim TSRMLS_DC);
386 void fetch_array_dim(znode *result, const znode *parent, const znode *dim TSRMLS_DC);
387 void fetch_string_offset(znode *result, const znode *parent, const znode *offset TSRMLS_DC);
388 void zend_do_fetch_static_member(znode *result, znode *class_znode TSRMLS_DC);
389 void zend_do_print(znode *result, const znode *arg TSRMLS_DC);
390 void zend_do_echo(const znode *arg TSRMLS_DC);
391 typedef int (*unary_op_type)(zval *, zval * TSRMLS_DC);
392 typedef int (*binary_op_type)(zval *, zval *, zval * TSRMLS_DC);
393 ZEND_API unary_op_type get_unary_op(int opcode);
394 ZEND_API binary_op_type get_binary_op(int opcode);
395 
396 void zend_do_while_cond(const znode *expr, znode *close_bracket_token TSRMLS_DC);
397 void zend_do_while_end(const znode *while_token, const znode *close_bracket_token TSRMLS_DC);
398 void zend_do_do_while_begin(TSRMLS_D);
399 void zend_do_do_while_end(const znode *do_token, const znode *expr_open_bracket, const znode *expr TSRMLS_DC);
400 
401 
402 void zend_do_if_cond(const znode *cond, znode *closing_bracket_token TSRMLS_DC);
403 void zend_do_if_after_statement(const znode *closing_bracket_token, unsigned char initialize TSRMLS_DC);
404 void zend_do_if_end(TSRMLS_D);
405 
406 void zend_do_for_cond(const znode *expr, znode *second_semicolon_token TSRMLS_DC);
407 void zend_do_for_before_statement(const znode *cond_start, const znode *second_semicolon_token TSRMLS_DC);
408 void zend_do_for_end(const znode *second_semicolon_token TSRMLS_DC);
409 
410 void zend_do_pre_incdec(znode *result, const znode *op1, zend_uchar op TSRMLS_DC);
411 void zend_do_post_incdec(znode *result, const znode *op1, zend_uchar op TSRMLS_DC);
412 
413 void zend_do_begin_variable_parse(TSRMLS_D);
414 void zend_do_end_variable_parse(znode *variable, int type, int arg_offset TSRMLS_DC);
415 
416 void zend_check_writable_variable(const znode *variable);
417 
418 void zend_do_free(znode *op1 TSRMLS_DC);
419 
420 void zend_do_add_string(znode *result, const znode *op1, znode *op2 TSRMLS_DC);
421 void zend_do_add_variable(znode *result, const znode *op1, const znode *op2 TSRMLS_DC);
422 
423 int zend_do_verify_access_types(const znode *current_access_type, const znode *new_modifier);
424 void zend_do_begin_function_declaration(znode *function_token, znode *function_name, int is_method, int return_reference, znode *fn_flags_znode TSRMLS_DC);
425 void zend_do_end_function_declaration(const znode *function_token TSRMLS_DC);
426 void zend_do_receive_arg(zend_uchar op, const znode *var, const znode *offset, const znode *initialization, znode *class_type, const znode *varname, zend_bool pass_by_reference TSRMLS_DC);
427 int zend_do_begin_function_call(znode *function_name, zend_bool check_namespace TSRMLS_DC);
428 void zend_do_begin_method_call(znode *left_bracket TSRMLS_DC);
429 void zend_do_clone(znode *result, const znode *expr TSRMLS_DC);
430 void zend_do_begin_dynamic_function_call(znode *function_name, int prefix_len TSRMLS_DC);
431 void zend_do_fetch_class(znode *result, znode *class_name TSRMLS_DC);
432 void zend_do_build_full_name(znode *result, znode *prefix, znode *name, int is_class_member TSRMLS_DC);
433 int zend_do_begin_class_member_function_call(znode *class_name, znode *method_name TSRMLS_DC);
434 void zend_do_end_function_call(znode *function_name, znode *result, const znode *argument_list, int is_method, int is_dynamic_fcall TSRMLS_DC);
435 void zend_do_return(znode *expr, int do_end_vparse TSRMLS_DC);
436 void zend_do_handle_exception(TSRMLS_D);
437 
438 void zend_do_begin_lambda_function_declaration(znode *result, znode *function_token, int return_reference TSRMLS_DC);
439 void zend_do_fetch_lexical_variable(znode *varname, zend_bool is_ref TSRMLS_DC);
440 
441 void zend_do_try(znode *try_token TSRMLS_DC);
442 void zend_do_begin_catch(znode *try_token, znode *catch_class, const znode *catch_var, znode *first_catch TSRMLS_DC);
443 void zend_do_end_catch(const znode *try_token TSRMLS_DC);
444 void zend_do_throw(const znode *expr TSRMLS_DC);
445 
446 ZEND_API int do_bind_function(zend_op *opline, HashTable *function_table, zend_bool compile_time);
447 ZEND_API zend_class_entry *do_bind_class(const zend_op *opline, HashTable *class_table, zend_bool compile_time TSRMLS_DC);
448 ZEND_API zend_class_entry *do_bind_inherited_class(const zend_op *opline, HashTable *class_table, zend_class_entry *parent_ce, zend_bool compile_time TSRMLS_DC);
449 ZEND_API void zend_do_inherit_interfaces(zend_class_entry *ce, const zend_class_entry *iface TSRMLS_DC);
450 ZEND_API void zend_do_implement_interface(zend_class_entry *ce, zend_class_entry *iface TSRMLS_DC);
451 void zend_do_implements_interface(znode *interface_znode TSRMLS_DC);
452 
453 ZEND_API void zend_do_inheritance(zend_class_entry *ce, zend_class_entry *parent_ce TSRMLS_DC);
454 void zend_do_early_binding(TSRMLS_D);
455 ZEND_API void zend_do_delayed_early_binding(const zend_op_array *op_array TSRMLS_DC);
456 
457 void zend_do_pass_param(znode *param, zend_uchar op, int offset TSRMLS_DC);
458 
459 
460 void zend_do_boolean_or_begin(znode *expr1, znode *op_token TSRMLS_DC);
461 void zend_do_boolean_or_end(znode *result, const znode *expr1, const znode *expr2, znode *op_token TSRMLS_DC);
462 void zend_do_boolean_and_begin(znode *expr1, znode *op_token TSRMLS_DC);
463 void zend_do_boolean_and_end(znode *result, const znode *expr1, const znode *expr2, const znode *op_token TSRMLS_DC);
464 
465 void zend_do_brk_cont(zend_uchar op, const znode *expr TSRMLS_DC);
466 
467 void zend_do_switch_cond(const znode *cond TSRMLS_DC);
468 void zend_do_switch_end(const znode *case_list TSRMLS_DC);
469 void zend_do_case_before_statement(const znode *case_list, znode *case_token, const znode *case_expr TSRMLS_DC);
470 void zend_do_case_after_statement(znode *result, const znode *case_token TSRMLS_DC);
471 void zend_do_default_before_statement(const znode *case_list, znode *default_token TSRMLS_DC);
472 
473 void zend_do_begin_class_declaration(const znode *class_token, znode *class_name, const znode *parent_class_name TSRMLS_DC);
474 void zend_do_end_class_declaration(const znode *class_token, const znode *parent_token TSRMLS_DC);
475 void zend_do_declare_property(const znode *var_name, const znode *value, zend_uint access_type TSRMLS_DC);
476 void zend_do_declare_implicit_property(TSRMLS_D);
477 void zend_do_declare_class_constant(znode *var_name, const znode *value TSRMLS_DC);
478 
479 void zend_do_fetch_property(znode *result, znode *object, const znode *property TSRMLS_DC);
480 
481 void zend_do_halt_compiler_register(TSRMLS_D);
482 
483 void zend_do_push_object(const znode *object TSRMLS_DC);
484 void zend_do_pop_object(znode *object TSRMLS_DC);
485 
486 
487 void zend_do_begin_new_object(znode *new_token, znode *class_type TSRMLS_DC);
488 void zend_do_end_new_object(znode *result, const znode *new_token, const znode *argument_list TSRMLS_DC);
489 
490 void zend_do_fetch_constant(znode *result, znode *constant_container, znode *constant_name, int mode, zend_bool check_namespace TSRMLS_DC);
491 
492 void zend_do_shell_exec(znode *result, const znode *cmd TSRMLS_DC);
493 
494 void zend_do_init_array(znode *result, const znode *expr, const znode *offset, zend_bool is_ref TSRMLS_DC);
495 void zend_do_add_array_element(znode *result, const znode *expr, const znode *offset, zend_bool is_ref TSRMLS_DC);
496 void zend_do_add_static_array_element(znode *result, znode *offset, const znode *expr);
497 void zend_do_list_init(TSRMLS_D);
498 void zend_do_list_end(znode *result, znode *expr TSRMLS_DC);
499 void zend_do_add_list_element(const znode *element TSRMLS_DC);
500 void zend_do_new_list_begin(TSRMLS_D);
501 void zend_do_new_list_end(TSRMLS_D);
502 
503 void zend_do_cast(znode *result, const znode *expr, int type TSRMLS_DC);
504 void zend_do_include_or_eval(int type, znode *result, const znode *op1 TSRMLS_DC);
505 
506 void zend_do_unset(const znode *variable TSRMLS_DC);
507 void zend_do_isset_or_isempty(int type, znode *result, znode *variable TSRMLS_DC);
508 
509 void zend_do_instanceof(znode *result, const znode *expr, const znode *class_znode, int type TSRMLS_DC);
510 
511 void zend_do_foreach_begin(znode *foreach_token, znode *open_brackets_token, znode *array, znode *as_token, int variable TSRMLS_DC);
512 void zend_do_foreach_cont(znode *foreach_token, const znode *open_brackets_token, const znode *as_token, znode *value, znode *key TSRMLS_DC);
513 void zend_do_foreach_end(const znode *foreach_token, const znode *as_token TSRMLS_DC);
514 
515 void zend_do_declare_begin(TSRMLS_D);
516 void zend_do_declare_stmt(znode *var, znode *val TSRMLS_DC);
517 void zend_do_declare_end(const znode *declare_token TSRMLS_DC);
518 
519 void zend_do_exit(znode *result, const znode *message TSRMLS_DC);
520 
521 void zend_do_begin_silence(znode *strudel_token TSRMLS_DC);
522 void zend_do_end_silence(const znode *strudel_token TSRMLS_DC);
523 
524 void zend_do_jmp_set(const znode *value, znode *jmp_token, znode *colon_token TSRMLS_DC);
525 void zend_do_jmp_set_else(znode *result, const znode *false_value, const znode *jmp_token, const znode *colon_token TSRMLS_DC);
526 
527 void zend_do_begin_qm_op(const znode *cond, znode *qm_token TSRMLS_DC);
528 void zend_do_qm_true(const znode *true_value, znode *qm_token, znode *colon_token TSRMLS_DC);
529 void zend_do_qm_false(znode *result, const znode *false_value, const znode *qm_token, const znode *colon_token TSRMLS_DC);
530 
531 void zend_do_extended_info(TSRMLS_D);
532 void zend_do_extended_fcall_begin(TSRMLS_D);
533 void zend_do_extended_fcall_end(TSRMLS_D);
534 
535 void zend_do_ticks(TSRMLS_D);
536 
537 void zend_do_abstract_method(const znode *function_name, znode *modifiers, const znode *body TSRMLS_DC);
538 
539 void zend_do_declare_constant(znode *name, znode *value TSRMLS_DC);
540 void zend_do_build_namespace_name(znode *result, znode *prefix, znode *name TSRMLS_DC);
541 void zend_do_begin_namespace(const znode *name, zend_bool with_brackets TSRMLS_DC);
542 void zend_do_end_namespace(TSRMLS_D);
543 void zend_verify_namespace(TSRMLS_D);
544 void zend_do_use(znode *name, znode *new_name, int is_global TSRMLS_DC);
545 void zend_do_end_compilation(TSRMLS_D);
546 
547 void zend_do_label(znode *label TSRMLS_DC);
548 void zend_do_goto(const znode *label TSRMLS_DC);
549 void zend_resolve_goto_label(zend_op_array *op_array, zend_op *opline, int pass2 TSRMLS_DC);
550 void zend_release_labels(TSRMLS_D);
551 
552 ZEND_API void function_add_ref(zend_function *function);
553 
554 #define INITIAL_OP_ARRAY_SIZE 64
555 
556 
557 /* helper functions in zend_language_scanner.l */
558 ZEND_API zend_op_array *compile_file(zend_file_handle *file_handle, int type TSRMLS_DC);
559 ZEND_API zend_op_array *compile_string(zval *source_string, char *filename TSRMLS_DC);
560 ZEND_API zend_op_array *compile_filename(int type, zval *filename TSRMLS_DC);
561 ZEND_API int zend_execute_scripts(int type TSRMLS_DC, zval **retval, int file_count, ...);
562 ZEND_API int open_file_for_scanning(zend_file_handle *file_handle TSRMLS_DC);
563 ZEND_API void init_op_array(zend_op_array *op_array, zend_uchar type, int initial_ops_size TSRMLS_DC);
564 ZEND_API void destroy_op_array(zend_op_array *op_array TSRMLS_DC);
565 ZEND_API void zend_destroy_file_handle(zend_file_handle *file_handle TSRMLS_DC);
566 ZEND_API int zend_cleanup_class_data(zend_class_entry **pce TSRMLS_DC);
567 ZEND_API int zend_cleanup_function_data(zend_function *function TSRMLS_DC);
568 ZEND_API int zend_cleanup_function_data_full(zend_function *function TSRMLS_DC);
569 
570 ZEND_API void destroy_zend_function(zend_function *function TSRMLS_DC);
571 ZEND_API void zend_function_dtor(zend_function *function);
572 ZEND_API void destroy_zend_class(zend_class_entry **pce);
573 void zend_class_add_ref(zend_class_entry **ce);
574 
575 ZEND_API void zend_mangle_property_name(char **dest, int *dest_length, const char *src1, int src1_length, const char *src2, int src2_length, int internal);
576 ZEND_API int zend_unmangle_property_name(char *mangled_property, int mangled_property_len, char **prop_name, char **class_name);
577 
578 #define ZEND_FUNCTION_DTOR (void (*)(void *)) zend_function_dtor
579 #define ZEND_CLASS_DTOR (void (*)(void *)) destroy_zend_class
580 
581 zend_op *get_next_op(zend_op_array *op_array TSRMLS_DC);
582 void init_op(zend_op *op TSRMLS_DC);
583 int get_next_op_number(zend_op_array *op_array);
584 int print_class(zend_class_entry *class_entry TSRMLS_DC);
585 void print_op_array(zend_op_array *op_array, int optimizations);
586 ZEND_API int pass_two(zend_op_array *op_array TSRMLS_DC);
587 zend_brk_cont_element *get_next_brk_cont_element(zend_op_array *op_array);
588 void zend_do_first_catch(znode *open_parentheses TSRMLS_DC);
589 void zend_initialize_try_catch_element(const znode *try_token TSRMLS_DC);
590 void zend_do_mark_last_catch(const znode *first_catch, const znode *last_additional_catch TSRMLS_DC);
591 ZEND_API zend_bool zend_is_compiling(TSRMLS_D);
592 ZEND_API char *zend_make_compiled_string_description(const char *name TSRMLS_DC);
593 ZEND_API void zend_initialize_class_data(zend_class_entry *ce, zend_bool nullify_handlers TSRMLS_DC);
594 int zend_get_class_fetch_type(const char *class_name, uint class_name_len);
595 
596 typedef zend_bool (*zend_auto_global_callback)(char *name, uint name_len TSRMLS_DC);
597 typedef struct _zend_auto_global {
598 	char *name;
599 	uint name_len;
600 	zend_auto_global_callback auto_global_callback;
601 	zend_bool armed;
602 } zend_auto_global;
603 
604 void zend_auto_global_dtor(zend_auto_global *auto_global);
605 ZEND_API int zend_register_auto_global(const char *name, uint name_len, zend_auto_global_callback auto_global_callback TSRMLS_DC);
606 ZEND_API zend_bool zend_is_auto_global(const char *name, uint name_len TSRMLS_DC);
607 ZEND_API int zend_auto_global_disable_jit(const char *varname, zend_uint varname_length TSRMLS_DC);
608 ZEND_API size_t zend_dirname(char *path, size_t len);
609 
610 int zendlex(znode *zendlval TSRMLS_DC);
611 
612 /* BEGIN: OPCODES */
613 
614 #include "zend_vm_opcodes.h"
615 
616 #define ZEND_OP_DATA				137
617 
618 /* END: OPCODES */
619 
620 
621 
622 
623 /* global/local fetches */
624 #define ZEND_FETCH_GLOBAL			0
625 #define ZEND_FETCH_LOCAL			1
626 #define ZEND_FETCH_STATIC			2
627 #define ZEND_FETCH_STATIC_MEMBER	3
628 #define ZEND_FETCH_GLOBAL_LOCK		4
629 #define ZEND_FETCH_LEXICAL			5
630 
631 
632 /* class fetches */
633 #define ZEND_FETCH_CLASS_DEFAULT	0
634 #define ZEND_FETCH_CLASS_SELF		1
635 #define ZEND_FETCH_CLASS_PARENT		2
636 #define ZEND_FETCH_CLASS_MAIN		3
637 #define ZEND_FETCH_CLASS_GLOBAL		4
638 #define ZEND_FETCH_CLASS_AUTO		5
639 #define ZEND_FETCH_CLASS_INTERFACE	6
640 #define ZEND_FETCH_CLASS_STATIC		7
641 #define ZEND_FETCH_CLASS_MASK        0x0f
642 #define ZEND_FETCH_CLASS_NO_AUTOLOAD 0x80
643 #define ZEND_FETCH_CLASS_SILENT      0x0100
644 
645 /* variable parsing type (compile-time) */
646 #define ZEND_PARSED_MEMBER				(1<<0)
647 #define ZEND_PARSED_METHOD_CALL			(1<<1)
648 #define ZEND_PARSED_STATIC_MEMBER		(1<<2)
649 #define ZEND_PARSED_FUNCTION_CALL		(1<<3)
650 #define ZEND_PARSED_VARIABLE			(1<<4)
651 #define ZEND_PARSED_REFERENCE_VARIABLE	(1<<5)
652 #define ZEND_PARSED_NEW					(1<<6)
653 
654 
655 /* unset types */
656 #define ZEND_UNSET_REG 0
657 
658 /* var status for backpatching */
659 #define BP_VAR_R			0
660 #define BP_VAR_W			1
661 #define BP_VAR_RW			2
662 #define BP_VAR_IS			3
663 #define BP_VAR_NA			4	/* if not applicable */
664 #define BP_VAR_FUNC_ARG		5
665 #define BP_VAR_UNSET		6
666 
667 
668 #define ZEND_INTERNAL_FUNCTION				1
669 #define ZEND_USER_FUNCTION					2
670 #define ZEND_OVERLOADED_FUNCTION			3
671 #define	ZEND_EVAL_CODE						4
672 #define ZEND_OVERLOADED_FUNCTION_TEMPORARY	5
673 
674 #define ZEND_INTERNAL_CLASS         1
675 #define ZEND_USER_CLASS             2
676 
677 #define ZEND_EVAL				(1<<0)
678 #define ZEND_INCLUDE			(1<<1)
679 #define ZEND_INCLUDE_ONCE		(1<<2)
680 #define ZEND_REQUIRE			(1<<3)
681 #define ZEND_REQUIRE_ONCE		(1<<4)
682 
683 #define ZEND_ISSET				(1<<0)
684 #define ZEND_ISEMPTY			(1<<1)
685 #define ZEND_ISSET_ISEMPTY_MASK	(ZEND_ISSET | ZEND_ISEMPTY)
686 #define ZEND_QUICK_SET			(1<<2)
687 
688 #define ZEND_CT	(1<<0)
689 #define ZEND_RT (1<<1)
690 
691 #define ZEND_FETCH_STANDARD	    0x00000000
692 #define ZEND_FETCH_ADD_LOCK	    0x08000000
693 #define ZEND_FETCH_MAKE_REF	    0x04000000
694 
695 #define ZEND_FE_FETCH_BYREF	1
696 #define ZEND_FE_FETCH_WITH_KEY	2
697 
698 #define ZEND_FE_RESET_VARIABLE 		1
699 #define ZEND_FE_RESET_REFERENCE		2
700 
701 #define ZEND_MEMBER_FUNC_CALL	1<<0
702 
703 #define ZEND_ARG_SEND_BY_REF (1<<0)
704 #define ZEND_ARG_COMPILE_TIME_BOUND (1<<1)
705 #define ZEND_ARG_SEND_FUNCTION (1<<2)
706 #define ZEND_ARG_SEND_SILENT   (1<<3)
707 
708 #define ZEND_SEND_BY_VAL     0
709 #define ZEND_SEND_BY_REF     1
710 #define ZEND_SEND_PREFER_REF 2
711 
712 #define ARG_SEND_TYPE(zf, arg_num)												\
713 	((zf) ?                                                                     \
714 	 ((((zend_function*)(zf))->common.arg_info &&                               \
715 	   arg_num<=((zend_function*)(zf))->common.num_args) ?                      \
716 	  ((zend_function *)(zf))->common.arg_info[arg_num-1].pass_by_reference :   \
717 	  ((zend_function *)(zf))->common.pass_rest_by_reference) :                 \
718 	 ZEND_SEND_BY_VAL)
719 
720 #define ARG_MUST_BE_SENT_BY_REF(zf, arg_num) \
721 	(ARG_SEND_TYPE(zf, arg_num) == ZEND_SEND_BY_REF)
722 
723 #define ARG_SHOULD_BE_SENT_BY_REF(zf, arg_num) \
724 	(ARG_SEND_TYPE(zf, arg_num) & (ZEND_SEND_BY_REF|ZEND_SEND_PREFER_REF))
725 
726 #define ARG_MAY_BE_SENT_BY_REF(zf, arg_num) \
727 	(ARG_SEND_TYPE(zf, arg_num) == ZEND_SEND_PREFER_REF)
728 
729 #define ZEND_RETURN_VAL 0
730 #define ZEND_RETURN_REF 1
731 
732 
733 #define ZEND_RETURNS_FUNCTION 1<<0
734 #define ZEND_RETURNS_NEW      1<<1
735 
736 END_EXTERN_C()
737 
738 #define ZEND_CLONE_FUNC_NAME		"__clone"
739 #define ZEND_CONSTRUCTOR_FUNC_NAME	"__construct"
740 #define ZEND_DESTRUCTOR_FUNC_NAME	"__destruct"
741 #define ZEND_GET_FUNC_NAME          "__get"
742 #define ZEND_SET_FUNC_NAME          "__set"
743 #define ZEND_UNSET_FUNC_NAME        "__unset"
744 #define ZEND_ISSET_FUNC_NAME        "__isset"
745 #define ZEND_CALL_FUNC_NAME         "__call"
746 #define ZEND_CALLSTATIC_FUNC_NAME   "__callstatic"
747 #define ZEND_TOSTRING_FUNC_NAME     "__tostring"
748 #define ZEND_AUTOLOAD_FUNC_NAME     "__autoload"
749 
750 /* The following constants may be combined in CG(compiler_options)
751  * to change the default compiler behavior */
752 
753 /* generate extended debug information */
754 #define ZEND_COMPILE_EXTENDED_INFO				(1<<0)
755 
756 /* call op_array handler of extendions */
757 #define ZEND_COMPILE_HANDLE_OP_ARRAY            (1<<1)
758 
759 /* generate ZEND_DO_FCALL_BY_NAME for internal functions instead of ZEND_DO_FCALL */
760 #define ZEND_COMPILE_IGNORE_INTERNAL_FUNCTIONS	(1<<2)
761 
762 /* don't perform early binding for classes inherited form internal ones;
763  * in namespaces assume that internal class that doesn't exist at compile-time
764  * may apper in run-time */
765 #define ZEND_COMPILE_IGNORE_INTERNAL_CLASSES	(1<<3)
766 
767 /* generate ZEND_DECLARE_INHERITED_CLASS_DELAYED opcode to delay early binding */
768 #define ZEND_COMPILE_DELAYED_BINDING			(1<<4)
769 
770 /* disable constant substitution at compile-time */
771 #define ZEND_COMPILE_NO_CONSTANT_SUBSTITUTION	(1<<5)
772 
773 /* The default value for CG(compiler_options) */
774 #define ZEND_COMPILE_DEFAULT					ZEND_COMPILE_HANDLE_OP_ARRAY
775 
776 /* The default value for CG(compiler_options) during eval() */
777 #define ZEND_COMPILE_DEFAULT_FOR_EVAL			0
778 
779 #endif /* ZEND_COMPILE_H */
780 
781 /*
782  * Local variables:
783  * tab-width: 4
784  * c-basic-offset: 4
785  * indent-tabs-mode: t
786  * End:
787  */
788