3 /**********************************************************************
8 created at: Fri May 28 15:14:02 JST 1993
10 Copyright (C) 1993-2007 Yukihiro Matsumoto
12 **********************************************************************/
14 #include "internal/compilers.h"
16 #if defined(__cplusplus)
19 } /* satisfy cc-mode */
131 typedef struct rb_code_position_struct
{
134 } rb_code_position_t
;
136 typedef struct rb_code_location_struct
{
137 rb_code_position_t beg_pos
;
138 rb_code_position_t end_pos
;
139 } rb_code_location_t
;
141 static inline rb_code_location_t
142 code_loc_gen(const rb_code_location_t
*loc1
, const rb_code_location_t
*loc2
)
144 rb_code_location_t loc
;
145 loc
.beg_pos
= loc1
->beg_pos
;
146 loc
.end_pos
= loc2
->end_pos
;
150 typedef struct rb_ast_id_table
{
152 ID ids
[FLEX_ARY_LEN
];
155 typedef struct RNode
{
161 rb_ast_id_table_t
*tbl
;
173 struct rb_args_info
*args
;
174 struct rb_ary_pattern_info
*apinfo
;
175 struct rb_fnd_pattern_info
*fpinfo
;
178 rb_code_location_t nd_loc
;
182 #define RNODE(obj) ((struct RNode *)(obj))
184 /* FL : 0..4: T_TYPES, 5: KEEP_WB, 6: PROMOTED, 7: FINALIZE, 8: UNUSED, 9: UNUSED, 10: EXIVAR, 11: FREEZE */
185 /* NODE_FL: 0..4: T_TYPES, 5: KEEP_WB, 6: PROMOTED, 7: NODE_FL_NEWLINE,
189 #define NODE_FL_NEWLINE (((VALUE)1)<<7)
191 #define NODE_TYPESHIFT 8
192 #define NODE_TYPEMASK (((VALUE)0x7f)<<NODE_TYPESHIFT)
194 #define nd_type(n) ((int) (((n)->flags & NODE_TYPEMASK)>>NODE_TYPESHIFT))
195 #define nd_set_type(n,t) \
196 rb_node_set_type(n, t)
197 #define nd_init_type(n,t) \
198 (n)->flags=(((n)->flags&~NODE_TYPEMASK)|((((unsigned long)(t))<<NODE_TYPESHIFT)&NODE_TYPEMASK))
200 #define NODE_LSHIFT (NODE_TYPESHIFT+7)
201 #define NODE_LMASK (((SIGNED_VALUE)1<<(sizeof(VALUE)*CHAR_BIT-NODE_LSHIFT))-1)
202 #define nd_line(n) (int)(((SIGNED_VALUE)(n)->flags)>>NODE_LSHIFT)
203 #define nd_set_line(n,l) \
204 (n)->flags=(((n)->flags&~((VALUE)(-1)<<NODE_LSHIFT))|((VALUE)((l)&NODE_LMASK)<<NODE_LSHIFT))
206 #define nd_first_column(n) ((int)((n)->nd_loc.beg_pos.column))
207 #define nd_set_first_column(n, v) ((n)->nd_loc.beg_pos.column = (v))
208 #define nd_first_lineno(n) ((int)((n)->nd_loc.beg_pos.lineno))
209 #define nd_set_first_lineno(n, v) ((n)->nd_loc.beg_pos.lineno = (v))
210 #define nd_first_loc(n) ((n)->nd_loc.beg_pos)
211 #define nd_set_first_loc(n, v) (nd_first_loc(n) = (v))
213 #define nd_last_column(n) ((int)((n)->nd_loc.end_pos.column))
214 #define nd_set_last_column(n, v) ((n)->nd_loc.end_pos.column = (v))
215 #define nd_last_lineno(n) ((int)((n)->nd_loc.end_pos.lineno))
216 #define nd_set_last_lineno(n, v) ((n)->nd_loc.end_pos.lineno = (v))
217 #define nd_last_loc(n) ((n)->nd_loc.end_pos)
218 #define nd_set_last_loc(n, v) (nd_last_loc(n) = (v))
219 #define nd_node_id(n) ((n)->node_id)
220 #define nd_set_node_id(n,id) ((n)->node_id = (id))
222 #define nd_head u1.node
223 #define nd_alen u2.argc
224 #define nd_next u3.node
226 #define nd_cond u1.node
227 #define nd_body u2.node
228 #define nd_else u3.node
230 #define nd_resq u2.node
231 #define nd_ensr u3.node
233 #define nd_1st u1.node
234 #define nd_2nd u2.node
236 #define nd_stts u1.node
238 #define nd_entry u3.id
241 #define nd_var u1.node
242 #define nd_iter u3.node
244 #define nd_value u2.node
247 #define nd_lit u1.value
249 #define nd_recv u1.node
251 #define nd_args u3.node
252 #define nd_ainfo u3.args
254 #define nd_defn u3.node
256 #define nd_cpath u1.node
257 #define nd_super u3.node
259 #define nd_beg u1.node
260 #define nd_end u2.node
261 #define nd_state u3.state
263 #define nd_nth u2.argc
265 #define nd_alias u1.id
266 #define nd_orig u2.id
267 #define nd_undef u2.node
269 #define nd_brace u2.argc
271 #define nd_pconst u1.node
272 #define nd_pkwargs u2.node
273 #define nd_pkwrestarg u3.node
275 #define nd_apinfo u3.apinfo
277 #define nd_fpinfo u3.fpinfo
280 #define nd_tbl u1.tbl
284 #define nd_plen u2.argc
285 #define nd_cflag u2.id
288 #define nd_cval u3.value
289 #define nd_rval u2.value
292 #define NEW_NODE(t,a0,a1,a2,loc) rb_node_newnode((t),(VALUE)(a0),(VALUE)(a1),(VALUE)(a2),loc)
293 #define NEW_NODE_WITH_LOCALS(t,a1,a2,loc) node_newnode_with_locals(p, (t),(VALUE)(a1),(VALUE)(a2),loc)
295 #define NEW_DEFN(i,a,d,loc) NEW_NODE(NODE_DEFN,0,i,NEW_SCOPE(a,d,loc),loc)
296 #define NEW_DEFS(r,i,a,d,loc) NEW_NODE(NODE_DEFS,r,i,NEW_SCOPE(a,d,loc),loc)
297 #define NEW_SCOPE(a,b,loc) NEW_NODE_WITH_LOCALS(NODE_SCOPE,b,a,loc)
298 #define NEW_BLOCK(a,loc) NEW_NODE(NODE_BLOCK,a,0,0,loc)
299 #define NEW_IF(c,t,e,loc) NEW_NODE(NODE_IF,c,t,e,loc)
300 #define NEW_UNLESS(c,t,e,loc) NEW_NODE(NODE_UNLESS,c,t,e,loc)
301 #define NEW_CASE(h,b,loc) NEW_NODE(NODE_CASE,h,b,0,loc)
302 #define NEW_CASE2(b,loc) NEW_NODE(NODE_CASE2,0,b,0,loc)
303 #define NEW_CASE3(h,b,loc) NEW_NODE(NODE_CASE3,h,b,0,loc)
304 #define NEW_WHEN(c,t,e,loc) NEW_NODE(NODE_WHEN,c,t,e,loc)
305 #define NEW_IN(c,t,e,loc) NEW_NODE(NODE_IN,c,t,e,loc)
306 #define NEW_WHILE(c,b,n,loc) NEW_NODE(NODE_WHILE,c,b,n,loc)
307 #define NEW_UNTIL(c,b,n,loc) NEW_NODE(NODE_UNTIL,c,b,n,loc)
308 #define NEW_FOR(i,b,loc) NEW_NODE(NODE_FOR,0,b,i,loc)
309 #define NEW_FOR_MASGN(v,loc) NEW_NODE(NODE_FOR_MASGN,v,0,0,loc)
310 #define NEW_ITER(a,b,loc) NEW_NODE(NODE_ITER,0,NEW_SCOPE(a,b,loc),0,loc)
311 #define NEW_LAMBDA(a,b,loc) NEW_NODE(NODE_LAMBDA,0,NEW_SCOPE(a,b,loc),0,loc)
312 #define NEW_BREAK(s,loc) NEW_NODE(NODE_BREAK,s,0,0,loc)
313 #define NEW_NEXT(s,loc) NEW_NODE(NODE_NEXT,s,0,0,loc)
314 #define NEW_REDO(loc) NEW_NODE(NODE_REDO,0,0,0,loc)
315 #define NEW_RETRY(loc) NEW_NODE(NODE_RETRY,0,0,0,loc)
316 #define NEW_BEGIN(b,loc) NEW_NODE(NODE_BEGIN,0,b,0,loc)
317 #define NEW_RESCUE(b,res,e,loc) NEW_NODE(NODE_RESCUE,b,res,e,loc)
318 #define NEW_RESBODY(a,ex,n,loc) NEW_NODE(NODE_RESBODY,n,ex,a,loc)
319 #define NEW_ENSURE(b,en,loc) NEW_NODE(NODE_ENSURE,b,0,en,loc)
320 #define NEW_RETURN(s,loc) NEW_NODE(NODE_RETURN,s,0,0,loc)
321 #define NEW_YIELD(a,loc) NEW_NODE(NODE_YIELD,a,0,0,loc)
322 #define NEW_LIST(a,loc) NEW_NODE(NODE_LIST,a,1,0,loc)
323 #define NEW_ZLIST(loc) NEW_NODE(NODE_ZLIST,0,0,0,loc)
324 #define NEW_HASH(a,loc) NEW_NODE(NODE_HASH,a,0,0,loc)
325 #define NEW_MASGN(l,r,loc) NEW_NODE(NODE_MASGN,l,0,r,loc)
326 #define NEW_GASGN(v,val,loc) NEW_NODE(NODE_GASGN,v,val,v,loc)
327 #define NEW_LASGN(v,val,loc) NEW_NODE(NODE_LASGN,v,val,0,loc)
328 #define NEW_DASGN(v,val,loc) NEW_NODE(NODE_DASGN,v,val,0,loc)
329 #define NEW_IASGN(v,val,loc) NEW_NODE(NODE_IASGN,v,val,0,loc)
330 #define NEW_CDECL(v,val,path,loc) NEW_NODE(NODE_CDECL,v,val,path,loc)
331 #define NEW_CVASGN(v,val,loc) NEW_NODE(NODE_CVASGN,v,val,0,loc)
332 #define NEW_OP_ASGN1(p,id,a,loc) NEW_NODE(NODE_OP_ASGN1,p,id,a,loc)
333 #define NEW_OP_ASGN2(r,t,i,o,val,loc) NEW_NODE(NODE_OP_ASGN2,r,val,NEW_OP_ASGN22(i,o,t,loc),loc)
334 #define NEW_OP_ASGN22(i,o,t,loc) NEW_NODE(NODE_OP_ASGN2,i,o,t,loc)
335 #define NEW_OP_ASGN_OR(i,val,loc) NEW_NODE(NODE_OP_ASGN_OR,i,val,0,loc)
336 #define NEW_OP_ASGN_AND(i,val,loc) NEW_NODE(NODE_OP_ASGN_AND,i,val,0,loc)
337 #define NEW_OP_CDECL(v,op,val,loc) NEW_NODE(NODE_OP_CDECL,v,val,op,loc)
338 #define NEW_GVAR(v,loc) NEW_NODE(NODE_GVAR,v,0,v,loc)
339 #define NEW_LVAR(v,loc) NEW_NODE(NODE_LVAR,v,0,0,loc)
340 #define NEW_DVAR(v,loc) NEW_NODE(NODE_DVAR,v,0,0,loc)
341 #define NEW_IVAR(v,loc) NEW_NODE(NODE_IVAR,v,0,0,loc)
342 #define NEW_CONST(v,loc) NEW_NODE(NODE_CONST,v,0,0,loc)
343 #define NEW_CVAR(v,loc) NEW_NODE(NODE_CVAR,v,0,0,loc)
344 #define NEW_NTH_REF(n,loc) NEW_NODE(NODE_NTH_REF,0,n,0,loc)
345 #define NEW_BACK_REF(n,loc) NEW_NODE(NODE_BACK_REF,0,n,0,loc)
346 #define NEW_MATCH(c,loc) NEW_NODE(NODE_MATCH,c,0,0,loc)
347 #define NEW_MATCH2(n1,n2,loc) NEW_NODE(NODE_MATCH2,n1,n2,0,loc)
348 #define NEW_MATCH3(r,n2,loc) NEW_NODE(NODE_MATCH3,r,n2,0,loc)
349 #define NEW_LIT(l,loc) NEW_NODE(NODE_LIT,l,0,0,loc)
350 #define NEW_STR(s,loc) NEW_NODE(NODE_STR,s,0,0,loc)
351 #define NEW_DSTR(s,loc) NEW_NODE(NODE_DSTR,s,1,0,loc)
352 #define NEW_XSTR(s,loc) NEW_NODE(NODE_XSTR,s,0,0,loc)
353 #define NEW_DXSTR(s,loc) NEW_NODE(NODE_DXSTR,s,0,0,loc)
354 #define NEW_DSYM(s,loc) NEW_NODE(NODE_DSYM,s,0,0,loc)
355 #define NEW_EVSTR(n,loc) NEW_NODE(NODE_EVSTR,0,(n),0,loc)
356 #define NEW_CALL(r,m,a,loc) NEW_NODE(NODE_CALL,r,m,a,loc)
357 #define NEW_OPCALL(r,m,a,loc) NEW_NODE(NODE_OPCALL,r,m,a,loc)
358 #define NEW_FCALL(m,a,loc) NEW_NODE(NODE_FCALL,0,m,a,loc)
359 #define NEW_VCALL(m,loc) NEW_NODE(NODE_VCALL,0,m,0,loc)
360 #define NEW_SUPER(a,loc) NEW_NODE(NODE_SUPER,0,0,a,loc)
361 #define NEW_ZSUPER(loc) NEW_NODE(NODE_ZSUPER,0,0,0,loc)
362 #define NEW_ARGS_AUX(r,b,loc) NEW_NODE(NODE_ARGS_AUX,r,b,0,loc)
363 #define NEW_OPT_ARG(i,v,loc) NEW_NODE(NODE_OPT_ARG,i,v,0,loc)
364 #define NEW_KW_ARG(i,v,loc) NEW_NODE(NODE_KW_ARG,i,v,0,loc)
365 #define NEW_POSTARG(i,v,loc) NEW_NODE(NODE_POSTARG,i,v,0,loc)
366 #define NEW_ARGSCAT(a,b,loc) NEW_NODE(NODE_ARGSCAT,a,b,0,loc)
367 #define NEW_ARGSPUSH(a,b,loc) NEW_NODE(NODE_ARGSPUSH,a,b,0,loc)
368 #define NEW_SPLAT(a,loc) NEW_NODE(NODE_SPLAT,a,0,0,loc)
369 #define NEW_BLOCK_PASS(b,loc) NEW_NODE(NODE_BLOCK_PASS,0,b,0,loc)
370 #define NEW_ALIAS(n,o,loc) NEW_NODE(NODE_ALIAS,n,o,0,loc)
371 #define NEW_VALIAS(n,o,loc) NEW_NODE(NODE_VALIAS,n,o,0,loc)
372 #define NEW_UNDEF(i,loc) NEW_NODE(NODE_UNDEF,0,i,0,loc)
373 #define NEW_CLASS(n,b,s,loc) NEW_NODE(NODE_CLASS,n,NEW_SCOPE(0,b,loc),(s),loc)
374 #define NEW_SCLASS(r,b,loc) NEW_NODE(NODE_SCLASS,r,NEW_SCOPE(0,b,loc),0,loc)
375 #define NEW_MODULE(n,b,loc) NEW_NODE(NODE_MODULE,n,NEW_SCOPE(0,b,loc),0,loc)
376 #define NEW_COLON2(c,i,loc) NEW_NODE(NODE_COLON2,c,i,0,loc)
377 #define NEW_COLON3(i,loc) NEW_NODE(NODE_COLON3,0,i,0,loc)
378 #define NEW_DOT2(b,e,loc) NEW_NODE(NODE_DOT2,b,e,0,loc)
379 #define NEW_DOT3(b,e,loc) NEW_NODE(NODE_DOT3,b,e,0,loc)
380 #define NEW_SELF(loc) NEW_NODE(NODE_SELF,0,0,1,loc)
381 #define NEW_NIL(loc) NEW_NODE(NODE_NIL,0,0,0,loc)
382 #define NEW_TRUE(loc) NEW_NODE(NODE_TRUE,0,0,0,loc)
383 #define NEW_FALSE(loc) NEW_NODE(NODE_FALSE,0,0,0,loc)
384 #define NEW_ERRINFO(loc) NEW_NODE(NODE_ERRINFO,0,0,0,loc)
385 #define NEW_DEFINED(e,loc) NEW_NODE(NODE_DEFINED,e,0,0,loc)
386 #define NEW_PREEXE(b,loc) NEW_SCOPE(b,loc)
387 #define NEW_POSTEXE(b,loc) NEW_NODE(NODE_POSTEXE,0,b,0,loc)
388 #define NEW_ATTRASGN(r,m,a,loc) NEW_NODE(NODE_ATTRASGN,r,m,a,loc)
390 #define NODE_SPECIAL_REQUIRED_KEYWORD ((NODE *)-1)
391 #define NODE_REQUIRED_KEYWORD_P(node) ((node)->nd_value == NODE_SPECIAL_REQUIRED_KEYWORD)
392 #define NODE_SPECIAL_NO_NAME_REST ((NODE *)-1)
393 #define NODE_NAMED_REST_P(node) ((node) != NODE_SPECIAL_NO_NAME_REST)
394 #define NODE_SPECIAL_EXCESSIVE_COMMA ((ID)1)
395 #define NODE_SPECIAL_NO_REST_KEYWORD ((NODE *)-1)
397 VALUE
rb_node_case_when_optimizable_literal(const NODE
*const node
);
399 RUBY_SYMBOL_EXPORT_BEGIN
401 typedef struct node_buffer_struct node_buffer_t
;
403 typedef struct rb_ast_body_struct
{
405 VALUE compile_option
;
407 // script_lines is either:
408 // - a Fixnum that represents the line count of the original source, or
409 // - an Array that contains the lines of the original source
411 typedef struct rb_ast_struct
{
413 node_buffer_t
*node_buffer
;
416 rb_ast_t
*rb_ast_new(void);
417 void rb_ast_mark(rb_ast_t
*);
418 void rb_ast_update_references(rb_ast_t
*);
419 void rb_ast_dispose(rb_ast_t
*);
420 void rb_ast_free(rb_ast_t
*);
421 size_t rb_ast_memsize(const rb_ast_t
*);
422 void rb_ast_add_mark_object(rb_ast_t
*, VALUE
);
423 NODE
*rb_ast_newnode(rb_ast_t
*, enum node_type type
);
424 void rb_ast_delete_node(rb_ast_t
*, NODE
*n
);
425 rb_ast_id_table_t
*rb_ast_new_local_table(rb_ast_t
*, int);
426 rb_ast_id_table_t
*rb_ast_resize_latest_local_table(rb_ast_t
*, int);
428 VALUE
rb_parser_new(void);
429 VALUE
rb_parser_end_seen_p(VALUE
);
430 VALUE
rb_parser_encoding(VALUE
);
431 VALUE
rb_parser_set_yydebug(VALUE
, VALUE
);
432 VALUE
rb_parser_dump_tree(const NODE
*node
, int comment
);
433 void rb_parser_set_options(VALUE
, int, int, int, int);
435 rb_ast_t
*rb_parser_compile_string(VALUE
, const char*, VALUE
, int);
436 rb_ast_t
*rb_parser_compile_string_path(VALUE vparser
, VALUE fname
, VALUE src
, int line
);
437 rb_ast_t
*rb_parser_compile_file_path(VALUE vparser
, VALUE fname
, VALUE input
, int line
);
438 rb_ast_t
*rb_parser_compile_generic(VALUE vparser
, VALUE (*lex_gets
)(VALUE
, int), VALUE fname
, VALUE input
, int line
);
440 void rb_node_init(NODE
*n
, enum node_type type
, VALUE a0
, VALUE a1
, VALUE a2
);
441 const char *ruby_node_name(int node
);
443 const struct kwtable
*rb_reserved_word(const char *, unsigned int);
445 struct rb_args_info
{
449 int pre_args_num
; /* count of mandatory pre-arguments */
450 int post_args_num
; /* count of mandatory post-arguments */
461 unsigned int no_kwarg
: 1;
462 unsigned int ruby2_keywords
: 1;
467 struct rb_ary_pattern_info
{
473 struct rb_fnd_pattern_info
{
479 struct parser_params
;
480 void *rb_parser_malloc(struct parser_params
*, size_t);
481 void *rb_parser_realloc(struct parser_params
*, void *, size_t);
482 void *rb_parser_calloc(struct parser_params
*, size_t, size_t);
483 void rb_parser_free(struct parser_params
*, void *);
484 PRINTF_ARGS(void rb_parser_printf(struct parser_params
*parser
, const char *fmt
, ...), 2, 3);
485 void rb_ast_node_type_change(NODE
*n
, enum node_type type
);
487 RUBY_SYMBOL_EXPORT_END
490 rb_node_set_type(NODE
*n
, enum node_type t
)
493 rb_ast_node_type_change(n
, t
);
495 return nd_init_type(n
, t
);
499 nd_type_p(const NODE
*n
, enum node_type t
)
501 return (enum node_type
)nd_type(n
) == t
;
503 #if defined(__cplusplus)
505 { /* satisfy cc-mode */
510 #endif /* RUBY_NODE_H */