Implement OP_ASGN1 NODE locations
[ruby.git] / rubyparser.h
blob2e7e6b63cb8b5a346f0d5421aafc617abcfcd109
1 #ifndef RUBY_RUBYPARSER_H
2 #define RUBY_RUBYPARSER_H 1
3 /*
4 * This is a header file for librubyparser interface
5 */
7 #include <stdarg.h> /* for va_list */
8 #include <assert.h>
10 #ifdef UNIVERSAL_PARSER
12 #define rb_encoding const void
13 #define OnigCodePoint unsigned int
14 #include "parser_st.h"
15 #ifndef RUBY_RUBY_H
16 #include "parser_value.h"
17 #endif
19 #else
21 #include "ruby/encoding.h"
23 #endif
25 #ifndef FLEX_ARY_LEN
26 /* From internal/compilers.h */
27 /* A macro for defining a flexible array, like: VALUE ary[FLEX_ARY_LEN]; */
28 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
29 # define FLEX_ARY_LEN /* VALUE ary[]; */
30 #elif defined(__GNUC__) && !defined(__STRICT_ANSI__)
31 # define FLEX_ARY_LEN 0 /* VALUE ary[0]; */
32 #else
33 # define FLEX_ARY_LEN 1 /* VALUE ary[1]; */
34 #endif
35 #endif
37 #if defined(__GNUC__)
38 # if defined(__MINGW_PRINTF_FORMAT)
39 # define RUBYPARSER_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((format(__MINGW_PRINTF_FORMAT, string_index, argument_index)))
40 # else
41 # define RUBYPARSER_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((format(printf, string_index, argument_index)))
42 # endif
43 #elif defined(__clang__)
44 # define RUBYPARSER_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((__format__(__printf__, string_index, argument_index)))
45 #else
46 # define RUBYPARSER_ATTRIBUTE_FORMAT(string_index, argument_index)
47 #endif
50 * Parser String
52 enum rb_parser_string_coderange_type {
53 /** The object's coderange is unclear yet. */
54 RB_PARSER_ENC_CODERANGE_UNKNOWN = 0,
55 RB_PARSER_ENC_CODERANGE_7BIT = 1,
56 RB_PARSER_ENC_CODERANGE_VALID = 2,
57 RB_PARSER_ENC_CODERANGE_BROKEN = 3
60 typedef struct rb_parser_string {
61 enum rb_parser_string_coderange_type coderange;
62 rb_encoding *enc;
63 /* Length of the string, not including terminating NUL character. */
64 long len;
65 /* Pointer to the contents of the string. */
66 char *ptr;
67 } rb_parser_string_t;
69 enum rb_parser_shareability {
70 rb_parser_shareable_none,
71 rb_parser_shareable_literal,
72 rb_parser_shareable_copy,
73 rb_parser_shareable_everything,
76 typedef void* rb_parser_input_data;
79 * AST Node
81 enum node_type {
82 NODE_SCOPE,
83 NODE_BLOCK,
84 NODE_IF,
85 NODE_UNLESS,
86 NODE_CASE,
87 NODE_CASE2,
88 NODE_CASE3,
89 NODE_WHEN,
90 NODE_IN,
91 NODE_WHILE,
92 NODE_UNTIL,
93 NODE_ITER,
94 NODE_FOR,
95 NODE_FOR_MASGN,
96 NODE_BREAK,
97 NODE_NEXT,
98 NODE_REDO,
99 NODE_RETRY,
100 NODE_BEGIN,
101 NODE_RESCUE,
102 NODE_RESBODY,
103 NODE_ENSURE,
104 NODE_AND,
105 NODE_OR,
106 NODE_MASGN,
107 NODE_LASGN,
108 NODE_DASGN,
109 NODE_GASGN,
110 NODE_IASGN,
111 NODE_CDECL,
112 NODE_CVASGN,
113 NODE_OP_ASGN1,
114 NODE_OP_ASGN2,
115 NODE_OP_ASGN_AND,
116 NODE_OP_ASGN_OR,
117 NODE_OP_CDECL,
118 NODE_CALL,
119 NODE_OPCALL,
120 NODE_FCALL,
121 NODE_VCALL,
122 NODE_QCALL,
123 NODE_SUPER,
124 NODE_ZSUPER,
125 NODE_LIST,
126 NODE_ZLIST,
127 NODE_HASH,
128 NODE_RETURN,
129 NODE_YIELD,
130 NODE_LVAR,
131 NODE_DVAR,
132 NODE_GVAR,
133 NODE_IVAR,
134 NODE_CONST,
135 NODE_CVAR,
136 NODE_NTH_REF,
137 NODE_BACK_REF,
138 NODE_MATCH,
139 NODE_MATCH2,
140 NODE_MATCH3,
141 NODE_INTEGER,
142 NODE_FLOAT,
143 NODE_RATIONAL,
144 NODE_IMAGINARY,
145 NODE_STR,
146 NODE_DSTR,
147 NODE_XSTR,
148 NODE_DXSTR,
149 NODE_EVSTR,
150 NODE_REGX,
151 NODE_DREGX,
152 NODE_ONCE,
153 NODE_ARGS,
154 NODE_ARGS_AUX,
155 NODE_OPT_ARG,
156 NODE_KW_ARG,
157 NODE_POSTARG,
158 NODE_ARGSCAT,
159 NODE_ARGSPUSH,
160 NODE_SPLAT,
161 NODE_BLOCK_PASS,
162 NODE_DEFN,
163 NODE_DEFS,
164 NODE_ALIAS,
165 NODE_VALIAS,
166 NODE_UNDEF,
167 NODE_CLASS,
168 NODE_MODULE,
169 NODE_SCLASS,
170 NODE_COLON2,
171 NODE_COLON3,
172 NODE_DOT2,
173 NODE_DOT3,
174 NODE_FLIP2,
175 NODE_FLIP3,
176 NODE_SELF,
177 NODE_NIL,
178 NODE_TRUE,
179 NODE_FALSE,
180 NODE_ERRINFO,
181 NODE_DEFINED,
182 NODE_POSTEXE,
183 NODE_SYM,
184 NODE_DSYM,
185 NODE_ATTRASGN,
186 NODE_LAMBDA,
187 NODE_ARYPTN,
188 NODE_HSHPTN,
189 NODE_FNDPTN,
190 NODE_ERROR,
191 NODE_LINE,
192 NODE_FILE,
193 NODE_ENCODING,
194 NODE_LAST
197 typedef struct rb_ast_id_table {
198 int size;
199 ID ids[FLEX_ARY_LEN];
200 } rb_ast_id_table_t;
202 typedef struct rb_code_position_struct {
203 int lineno;
204 int column;
205 } rb_code_position_t;
207 typedef struct rb_code_location_struct {
208 rb_code_position_t beg_pos;
209 rb_code_position_t end_pos;
210 } rb_code_location_t;
211 #define YYLTYPE rb_code_location_t
212 #define YYLTYPE_IS_DECLARED 1
214 typedef struct rb_parser_ast_token {
215 int id;
216 const char *type_name;
217 rb_parser_string_t *str;
218 rb_code_location_t loc;
219 } rb_parser_ast_token_t;
222 * Array-like object for parser
224 typedef void* rb_parser_ary_data;
226 enum rb_parser_ary_data_type {
227 PARSER_ARY_DATA_AST_TOKEN = 1,
228 PARSER_ARY_DATA_SCRIPT_LINE,
229 PARSER_ARY_DATA_NODE
232 typedef struct rb_parser_ary {
233 enum rb_parser_ary_data_type data_type;
234 rb_parser_ary_data *data;
235 long len; // current size
236 long capa; // capacity
237 } rb_parser_ary_t;
239 /* Header part of AST Node */
240 typedef struct RNode {
241 VALUE flags;
242 rb_code_location_t nd_loc;
243 int node_id;
244 } NODE;
246 typedef struct RNode_SCOPE {
247 NODE node;
249 rb_ast_id_table_t *nd_tbl;
250 struct RNode *nd_body;
251 struct RNode_ARGS *nd_args;
252 } rb_node_scope_t;
254 typedef struct RNode_BLOCK {
255 NODE node;
257 struct RNode *nd_head;
258 struct RNode *nd_end;
259 struct RNode *nd_next;
260 } rb_node_block_t;
262 typedef struct RNode_IF {
263 NODE node;
265 struct RNode *nd_cond;
266 struct RNode *nd_body;
267 struct RNode *nd_else;
268 } rb_node_if_t;
270 typedef struct RNode_UNLESS {
271 NODE node;
273 struct RNode *nd_cond;
274 struct RNode *nd_body;
275 struct RNode *nd_else;
276 rb_code_location_t keyword_loc;
277 rb_code_location_t then_keyword_loc;
278 rb_code_location_t end_keyword_loc;
279 } rb_node_unless_t;
281 typedef struct RNode_CASE {
282 NODE node;
284 struct RNode *nd_head;
285 struct RNode *nd_body;
286 rb_code_location_t case_keyword_loc;
287 rb_code_location_t end_keyword_loc;
288 } rb_node_case_t;
290 typedef struct RNode_CASE2 {
291 NODE node;
293 struct RNode *nd_head;
294 struct RNode *nd_body;
295 rb_code_location_t case_keyword_loc;
296 rb_code_location_t end_keyword_loc;
297 } rb_node_case2_t;
299 typedef struct RNode_CASE3 {
300 NODE node;
302 struct RNode *nd_head;
303 struct RNode *nd_body;
304 rb_code_location_t case_keyword_loc;
305 rb_code_location_t end_keyword_loc;
306 } rb_node_case3_t;
308 typedef struct RNode_WHEN {
309 NODE node;
311 struct RNode *nd_head;
312 struct RNode *nd_body;
313 struct RNode *nd_next;
314 rb_code_location_t keyword_loc;
315 rb_code_location_t then_keyword_loc;
316 } rb_node_when_t;
318 typedef struct RNode_IN {
319 NODE node;
321 struct RNode *nd_head;
322 struct RNode *nd_body;
323 struct RNode *nd_next;
324 } rb_node_in_t;
326 typedef struct RNode_LOOP {
327 NODE node;
329 struct RNode *nd_cond;
330 struct RNode *nd_body;
331 long nd_state;
332 rb_code_location_t keyword_loc;
333 rb_code_location_t closing_loc;
334 } rb_node_while_t, rb_node_until_t;
336 typedef struct RNode_ITER {
337 NODE node;
339 struct RNode *nd_body;
340 struct RNode *nd_iter;
341 } rb_node_iter_t, rb_node_for_t;
343 typedef struct RNode_FOR_MASGN {
344 NODE node;
346 struct RNode *nd_var;
347 } rb_node_for_masgn_t;
349 typedef struct RNode_EXITS {
350 NODE node;
352 struct RNode *nd_chain;
353 struct RNode *nd_stts;
354 rb_code_location_t keyword_loc;
355 } rb_node_exits_t, rb_node_break_t, rb_node_next_t, rb_node_redo_t;
357 typedef struct RNode_RETRY {
358 NODE node;
359 } rb_node_retry_t;
361 typedef struct RNode_BEGIN {
362 NODE node;
364 struct RNode *nd_body;
365 } rb_node_begin_t;
367 typedef struct RNode_RESCUE {
368 NODE node;
370 struct RNode *nd_head;
371 struct RNode *nd_resq;
372 struct RNode *nd_else;
373 } rb_node_rescue_t;
375 typedef struct RNode_RESBODY {
376 NODE node;
378 struct RNode *nd_args;
379 struct RNode *nd_exc_var;
380 struct RNode *nd_body;
381 struct RNode *nd_next;
382 } rb_node_resbody_t;
384 typedef struct RNode_ENSURE {
385 NODE node;
387 struct RNode *nd_head;
388 struct RNode *nd_ensr;
389 } rb_node_ensure_t;
391 typedef struct {
392 NODE node;
394 struct RNode *nd_1st;
395 struct RNode *nd_2nd;
396 rb_code_location_t operator_loc;
397 } rb_node_and_t, rb_node_or_t;
399 typedef struct RNode_MASGN {
400 NODE node;
402 struct RNode *nd_head;
403 struct RNode *nd_value;
404 struct RNode *nd_args;
405 } rb_node_masgn_t;
407 typedef struct RNode_LASGN {
408 NODE node;
410 ID nd_vid;
411 struct RNode *nd_value;
412 } rb_node_lasgn_t;
414 typedef struct RNode_DASGN {
415 NODE node;
417 ID nd_vid;
418 struct RNode *nd_value;
419 } rb_node_dasgn_t;
421 typedef struct RNode_GASGN {
422 NODE node;
424 ID nd_vid;
425 struct RNode *nd_value;
426 } rb_node_gasgn_t;
428 typedef struct RNode_IASGN {
429 NODE node;
431 ID nd_vid;
432 struct RNode *nd_value;
433 } rb_node_iasgn_t;
435 typedef struct RNode_CDECL {
436 NODE node;
438 ID nd_vid;
439 struct RNode *nd_value;
440 struct RNode *nd_else;
441 enum rb_parser_shareability shareability;
442 } rb_node_cdecl_t;
444 typedef struct RNode_CVASGN {
445 NODE node;
447 ID nd_vid;
448 struct RNode *nd_value;
449 } rb_node_cvasgn_t;
451 typedef struct RNode_OP_ASGN1 {
452 NODE node;
454 struct RNode *nd_recv;
455 ID nd_mid;
456 struct RNode *nd_index;
457 struct RNode *nd_rvalue;
458 rb_code_location_t call_operator_loc;
459 rb_code_location_t opening_loc;
460 rb_code_location_t closing_loc;
461 rb_code_location_t binary_operator_loc;
462 } rb_node_op_asgn1_t;
464 typedef struct RNode_OP_ASGN2 {
465 NODE node;
467 struct RNode *nd_recv;
468 struct RNode *nd_value;
469 ID nd_vid;
470 ID nd_mid;
471 bool nd_aid;
472 } rb_node_op_asgn2_t;
474 typedef struct RNode_OP_ASGN_AND {
475 NODE node;
477 struct RNode *nd_head;
478 struct RNode *nd_value;
479 } rb_node_op_asgn_and_t;
481 typedef struct RNode_OP_ASGN_OR {
482 NODE node;
484 struct RNode *nd_head;
485 struct RNode *nd_value;
486 } rb_node_op_asgn_or_t;
488 typedef struct RNode_OP_CDECL {
489 NODE node;
491 struct RNode *nd_head;
492 struct RNode *nd_value;
493 ID nd_aid;
494 enum rb_parser_shareability shareability;
495 } rb_node_op_cdecl_t;
497 typedef struct RNode_CALL {
498 NODE node;
500 struct RNode *nd_recv;
501 ID nd_mid;
502 struct RNode *nd_args;
503 } rb_node_call_t;
505 typedef struct RNode_OPCALL {
506 NODE node;
508 struct RNode *nd_recv;
509 ID nd_mid;
510 struct RNode *nd_args;
511 } rb_node_opcall_t;
513 typedef struct RNode_FCALL {
514 NODE node;
516 ID nd_mid;
517 struct RNode *nd_args;
518 } rb_node_fcall_t;
520 typedef struct RNode_VCALL {
521 NODE node;
523 ID nd_mid;
524 } rb_node_vcall_t;
526 typedef struct RNode_QCALL {
527 NODE node;
529 struct RNode *nd_recv;
530 ID nd_mid;
531 struct RNode *nd_args;
532 } rb_node_qcall_t;
534 typedef struct RNode_SUPER {
535 NODE node;
537 struct RNode *nd_args;
538 } rb_node_super_t;
540 typedef struct RNode_ZSUPER {
541 NODE node;
542 } rb_node_zsuper_t;
546 Structure of LIST:
548 LIST +--> LIST
549 * head --> element | * head
550 * alen (length of list) | * nd_end (point to the last LIST)
551 * next -----------------+ * next
554 typedef struct RNode_LIST {
555 NODE node;
557 struct RNode *nd_head; /* element */
558 union {
559 long nd_alen;
560 struct RNode *nd_end; /* Second list node has this structure */
561 } as;
562 struct RNode *nd_next; /* next list node */
563 } rb_node_list_t;
565 typedef struct RNode_ZLIST {
566 NODE node;
567 } rb_node_zlist_t;
569 typedef struct RNode_HASH {
570 NODE node;
572 struct RNode *nd_head;
573 long nd_brace;
574 } rb_node_hash_t;
576 typedef struct RNode_RETURN {
577 NODE node;
579 struct RNode *nd_stts;
580 rb_code_location_t keyword_loc;
581 } rb_node_return_t;
583 typedef struct RNode_YIELD {
584 NODE node;
586 struct RNode *nd_head;
587 } rb_node_yield_t;
589 typedef struct RNode_LVAR {
590 NODE node;
592 ID nd_vid;
593 } rb_node_lvar_t;
595 typedef struct RNode_DVAR {
596 NODE node;
598 ID nd_vid;
599 } rb_node_dvar_t;
601 typedef struct RNode_GVAR {
602 NODE node;
604 ID nd_vid;
605 } rb_node_gvar_t;
607 typedef struct RNode_IVAR {
608 NODE node;
610 ID nd_vid;
611 } rb_node_ivar_t;
613 typedef struct RNode_CONST {
614 NODE node;
616 ID nd_vid;
617 } rb_node_const_t;
619 typedef struct RNode_CVAR {
620 NODE node;
622 ID nd_vid;
623 } rb_node_cvar_t;
625 typedef struct RNode_NTH_REF {
626 NODE node;
628 long nd_nth;
629 } rb_node_nth_ref_t;
631 typedef struct RNode_BACK_REF {
632 NODE node;
634 long nd_nth;
635 } rb_node_back_ref_t;
637 typedef struct RNode_MATCH2 {
638 NODE node;
640 struct RNode *nd_recv;
641 struct RNode *nd_value;
642 struct RNode *nd_args;
643 } rb_node_match2_t;
645 typedef struct RNode_MATCH3 {
646 NODE node;
648 struct RNode *nd_recv;
649 struct RNode *nd_value;
650 } rb_node_match3_t;
652 typedef struct RNode_INTEGER {
653 NODE node;
655 char *val;
656 int minus;
657 int base;
658 } rb_node_integer_t;
660 typedef struct RNode_FLOAT {
661 NODE node;
663 char *val;
664 int minus;
665 } rb_node_float_t;
667 typedef struct RNode_RATIONAL {
668 NODE node;
670 char *val;
671 int minus;
672 int base;
673 int seen_point;
674 } rb_node_rational_t;
676 enum rb_numeric_type {
677 integer_literal,
678 float_literal,
679 rational_literal
682 typedef struct RNode_IMAGINARY {
683 NODE node;
685 char *val;
686 int minus;
687 int base;
688 int seen_point;
689 enum rb_numeric_type type;
690 } rb_node_imaginary_t;
692 typedef struct RNode_STR {
693 NODE node;
695 struct rb_parser_string *string;
696 } rb_node_str_t;
698 /* NODE_DSTR, NODE_DXSTR, NODE_DREGX, NODE_DSYM */
699 typedef struct RNode_DSTR {
700 NODE node;
702 struct rb_parser_string *string;
703 union {
704 long nd_alen;
705 long nd_cflag;
706 struct RNode *nd_end; /* Second dstr node has this structure. See also RNode_LIST */
707 } as;
708 struct RNode_LIST *nd_next;
709 } rb_node_dstr_t;
711 typedef rb_node_str_t rb_node_xstr_t;
713 typedef rb_node_dstr_t rb_node_dxstr_t;
715 typedef struct RNode_EVSTR {
716 NODE node;
718 struct RNode *nd_body;
719 } rb_node_evstr_t;
721 typedef struct RNode_REGX { /* also RNode_MATCH */
722 NODE node;
724 struct rb_parser_string *string;
725 int options;
726 } rb_node_regx_t, rb_node_match_t;
728 typedef rb_node_dstr_t rb_node_dregx_t;
730 typedef struct RNode_ONCE {
731 NODE node;
733 struct RNode *nd_body;
734 } rb_node_once_t;
736 struct rb_args_info {
737 NODE *pre_init;
738 NODE *post_init;
740 int pre_args_num; /* count of mandatory pre-arguments */
741 int post_args_num; /* count of mandatory post-arguments */
743 ID first_post_arg;
745 ID rest_arg;
746 ID block_arg;
748 struct RNode_KW_ARG *kw_args;
749 NODE *kw_rest_arg;
751 struct RNode_OPT_ARG *opt_args;
752 unsigned int no_kwarg: 1;
753 unsigned int ruby2_keywords: 1;
754 unsigned int forwarding: 1;
757 typedef struct RNode_ARGS {
758 NODE node;
760 struct rb_args_info nd_ainfo;
761 } rb_node_args_t;
763 typedef struct RNode_ARGS_AUX {
764 NODE node;
766 ID nd_pid;
767 int nd_plen;
768 struct RNode *nd_next;
769 } rb_node_args_aux_t;
771 typedef struct RNode_OPT_ARG {
772 NODE node;
774 struct RNode *nd_body;
775 struct RNode_OPT_ARG *nd_next;
776 } rb_node_opt_arg_t;
778 typedef struct RNode_KW_ARG {
779 NODE node;
781 struct RNode *nd_body;
782 struct RNode_KW_ARG *nd_next;
783 } rb_node_kw_arg_t;
785 typedef struct RNode_POSTARG {
786 NODE node;
788 struct RNode *nd_1st;
789 struct RNode *nd_2nd;
790 } rb_node_postarg_t;
792 typedef struct RNode_ARGSCAT {
793 NODE node;
795 struct RNode *nd_head;
796 struct RNode *nd_body;
797 } rb_node_argscat_t;
799 typedef struct RNode_ARGSPUSH {
800 NODE node;
802 struct RNode *nd_head;
803 struct RNode *nd_body;
804 } rb_node_argspush_t;
806 typedef struct RNode_SPLAT {
807 NODE node;
809 struct RNode *nd_head;
810 } rb_node_splat_t;
812 typedef struct RNode_BLOCK_PASS {
813 NODE node;
815 struct RNode *nd_head;
816 struct RNode *nd_body;
817 unsigned int forwarding: 1;
818 rb_code_location_t operator_loc;
819 } rb_node_block_pass_t;
821 typedef struct RNode_DEFN {
822 NODE node;
824 ID nd_mid;
825 struct RNode *nd_defn;
826 } rb_node_defn_t;
828 typedef struct RNode_DEFS {
829 NODE node;
831 struct RNode *nd_recv;
832 ID nd_mid;
833 struct RNode *nd_defn;
834 } rb_node_defs_t;
836 typedef struct RNode_ALIAS {
837 NODE node;
839 struct RNode *nd_1st;
840 struct RNode *nd_2nd;
841 rb_code_location_t keyword_loc;
842 } rb_node_alias_t;
844 typedef struct RNode_VALIAS {
845 NODE node;
847 ID nd_alias;
848 ID nd_orig;
849 rb_code_location_t keyword_loc;
850 } rb_node_valias_t;
852 typedef struct RNode_UNDEF {
853 NODE node;
855 rb_parser_ary_t *nd_undefs;
856 rb_code_location_t keyword_loc;
857 } rb_node_undef_t;
859 typedef struct RNode_CLASS {
860 NODE node;
862 struct RNode *nd_cpath;
863 struct RNode *nd_body;
864 struct RNode *nd_super;
865 } rb_node_class_t;
867 typedef struct RNode_MODULE {
868 NODE node;
870 struct RNode *nd_cpath;
871 struct RNode *nd_body;
872 } rb_node_module_t;
874 typedef struct RNode_SCLASS {
875 NODE node;
877 struct RNode *nd_recv;
878 struct RNode *nd_body;
879 } rb_node_sclass_t;
881 typedef struct RNode_COLON2 {
882 NODE node;
884 struct RNode *nd_head;
885 ID nd_mid;
886 } rb_node_colon2_t;
888 typedef struct RNode_COLON3 {
889 NODE node;
891 ID nd_mid;
892 } rb_node_colon3_t;
894 /* NODE_DOT2, NODE_DOT3, NODE_FLIP2, NODE_FLIP3 */
895 typedef struct RNode_DOTS {
896 NODE node;
898 struct RNode *nd_beg;
899 struct RNode *nd_end;
900 } rb_node_dot2_t, rb_node_dot3_t, rb_node_flip2_t, rb_node_flip3_t;
902 typedef struct RNode_SELF {
903 NODE node;
905 long nd_state; /* Default 1. See NEW_SELF. */
906 } rb_node_self_t;
908 typedef struct RNode_NIL {
909 NODE node;
910 } rb_node_nil_t;
912 typedef struct RNode_TRUE {
913 NODE node;
914 } rb_node_true_t;
916 typedef struct RNode_FALSE {
917 NODE node;
918 } rb_node_false_t;
920 typedef struct RNode_ERRINFO {
921 NODE node;
922 } rb_node_errinfo_t;
924 typedef struct RNode_DEFINED {
925 NODE node;
927 struct RNode *nd_head;
928 } rb_node_defined_t;
930 typedef struct RNode_POSTEXE {
931 NODE node;
933 struct RNode *nd_body;
934 } rb_node_postexe_t;
936 typedef struct RNode_SYM {
937 NODE node;
939 struct rb_parser_string *string;
940 } rb_node_sym_t;
942 typedef rb_node_dstr_t rb_node_dsym_t;
944 typedef struct RNode_ATTRASGN {
945 NODE node;
947 struct RNode *nd_recv;
948 ID nd_mid;
949 struct RNode *nd_args;
950 } rb_node_attrasgn_t;
952 typedef struct RNode_LAMBDA {
953 NODE node;
955 struct RNode *nd_body;
956 } rb_node_lambda_t;
958 typedef struct RNode_ARYPTN {
959 NODE node;
961 struct RNode *nd_pconst;
962 NODE *pre_args;
963 NODE *rest_arg;
964 NODE *post_args;
965 } rb_node_aryptn_t;
967 typedef struct RNode_HSHPTN {
968 NODE node;
970 struct RNode *nd_pconst;
971 struct RNode *nd_pkwargs;
972 struct RNode *nd_pkwrestarg;
973 } rb_node_hshptn_t;
975 typedef struct RNode_FNDPTN {
976 NODE node;
978 struct RNode *nd_pconst;
979 NODE *pre_rest_arg;
980 NODE *args;
981 NODE *post_rest_arg;
982 } rb_node_fndptn_t;
984 typedef struct RNode_LINE {
985 NODE node;
986 } rb_node_line_t;
988 typedef struct RNode_FILE {
989 NODE node;
991 struct rb_parser_string *path;
992 } rb_node_file_t;
994 typedef struct RNode_ENCODING {
995 NODE node;
996 rb_encoding *enc;
997 } rb_node_encoding_t;
999 typedef struct RNode_ERROR {
1000 NODE node;
1001 } rb_node_error_t;
1003 #define RNODE(obj) ((NODE *)(obj))
1005 #define RNODE_SCOPE(node) ((rb_node_scope_t *)(node))
1006 #define RNODE_BLOCK(node) ((rb_node_block_t *)(node))
1007 #define RNODE_IF(node) ((rb_node_if_t *)(node))
1008 #define RNODE_UNLESS(node) ((rb_node_unless_t *)(node))
1009 #define RNODE_CASE(node) ((rb_node_case_t *)(node))
1010 #define RNODE_CASE2(node) ((rb_node_case2_t *)(node))
1011 #define RNODE_CASE3(node) ((rb_node_case3_t *)(node))
1012 #define RNODE_WHEN(node) ((rb_node_when_t *)(node))
1013 #define RNODE_IN(node) ((rb_node_in_t *)(node))
1014 #define RNODE_WHILE(node) ((rb_node_while_t *)(node))
1015 #define RNODE_UNTIL(node) ((rb_node_until_t *)(node))
1016 #define RNODE_ITER(node) ((rb_node_iter_t *)(node))
1017 #define RNODE_FOR(node) ((rb_node_for_t *)(node))
1018 #define RNODE_FOR_MASGN(node) ((rb_node_for_masgn_t *)(node))
1019 #define RNODE_BREAK(node) ((rb_node_break_t *)(node))
1020 #define RNODE_NEXT(node) ((rb_node_next_t *)(node))
1021 #define RNODE_REDO(node) ((rb_node_redo_t *)(node))
1022 #define RNODE_RETRY(node) ((rb_node_retry_t *)(node))
1023 #define RNODE_BEGIN(node) ((rb_node_begin_t *)(node))
1024 #define RNODE_RESCUE(node) ((rb_node_rescue_t *)(node))
1025 #define RNODE_RESBODY(node) ((rb_node_resbody_t *)(node))
1026 #define RNODE_ENSURE(node) ((rb_node_ensure_t *)(node))
1027 #define RNODE_AND(node) ((rb_node_and_t *)(node))
1028 #define RNODE_OR(node) ((rb_node_or_t *)(node))
1029 #define RNODE_MASGN(node) ((rb_node_masgn_t *)(node))
1030 #define RNODE_LASGN(node) ((rb_node_lasgn_t *)(node))
1031 #define RNODE_DASGN(node) ((rb_node_dasgn_t *)(node))
1032 #define RNODE_GASGN(node) ((rb_node_gasgn_t *)(node))
1033 #define RNODE_IASGN(node) ((rb_node_iasgn_t *)(node))
1034 #define RNODE_CDECL(node) ((rb_node_cdecl_t *)(node))
1035 #define RNODE_CVASGN(node) ((rb_node_cvasgn_t *)(node))
1036 #define RNODE_OP_ASGN1(node) ((rb_node_op_asgn1_t *)(node))
1037 #define RNODE_OP_ASGN2(node) ((rb_node_op_asgn2_t *)(node))
1038 #define RNODE_OP_ASGN_AND(node) ((rb_node_op_asgn_and_t *)(node))
1039 #define RNODE_OP_ASGN_OR(node) ((rb_node_op_asgn_or_t *)(node))
1040 #define RNODE_OP_CDECL(node) ((rb_node_op_cdecl_t *)(node))
1041 #define RNODE_CALL(node) ((rb_node_call_t *)(node))
1042 #define RNODE_OPCALL(node) ((rb_node_opcall_t *)(node))
1043 #define RNODE_FCALL(node) ((rb_node_fcall_t *)(node))
1044 #define RNODE_VCALL(node) ((rb_node_vcall_t *)(node))
1045 #define RNODE_QCALL(node) ((rb_node_qcall_t *)(node))
1046 #define RNODE_SUPER(node) ((rb_node_super_t *)(node))
1047 #define RNODE_ZSUPER(node) ((rb_node_zsuper_t *)(node))
1048 #define RNODE_LIST(node) ((rb_node_list_t *)(node))
1049 #define RNODE_ZLIST(node) ((rb_node_zlist_t *)(node))
1050 #define RNODE_HASH(node) ((rb_node_hash_t *)(node))
1051 #define RNODE_RETURN(node) ((rb_node_return_t *)(node))
1052 #define RNODE_YIELD(node) ((rb_node_yield_t *)(node))
1053 #define RNODE_LVAR(node) ((rb_node_lvar_t *)(node))
1054 #define RNODE_DVAR(node) ((rb_node_dvar_t *)(node))
1055 #define RNODE_GVAR(node) ((rb_node_gvar_t *)(node))
1056 #define RNODE_IVAR(node) ((rb_node_ivar_t *)(node))
1057 #define RNODE_CONST(node) ((rb_node_const_t *)(node))
1058 #define RNODE_CVAR(node) ((rb_node_cvar_t *)(node))
1059 #define RNODE_NTH_REF(node) ((rb_node_nth_ref_t *)(node))
1060 #define RNODE_BACK_REF(node) ((rb_node_back_ref_t *)(node))
1061 #define RNODE_MATCH(node) ((rb_node_match_t *)(node))
1062 #define RNODE_MATCH2(node) ((rb_node_match2_t *)(node))
1063 #define RNODE_MATCH3(node) ((rb_node_match3_t *)(node))
1064 #define RNODE_INTEGER(node) ((rb_node_integer_t *)(node))
1065 #define RNODE_FLOAT(node) ((rb_node_float_t *)(node))
1066 #define RNODE_RATIONAL(node) ((rb_node_rational_t *)(node))
1067 #define RNODE_IMAGINARY(node) ((rb_node_imaginary_t *)(node))
1068 #define RNODE_STR(node) ((rb_node_str_t *)(node))
1069 #define RNODE_DSTR(node) ((rb_node_dstr_t *)(node))
1070 #define RNODE_XSTR(node) ((rb_node_xstr_t *)(node))
1071 #define RNODE_DXSTR(node) ((rb_node_dxstr_t *)(node))
1072 #define RNODE_EVSTR(node) ((rb_node_evstr_t *)(node))
1073 #define RNODE_REGX(node) ((rb_node_regx_t *)(node))
1074 #define RNODE_DREGX(node) ((rb_node_dregx_t *)(node))
1075 #define RNODE_ONCE(node) ((rb_node_once_t *)(node))
1076 #define RNODE_ARGS(node) ((rb_node_args_t *)(node))
1077 #define RNODE_ARGS_AUX(node) ((rb_node_args_aux_t *)(node))
1078 #define RNODE_OPT_ARG(node) ((rb_node_opt_arg_t *)(node))
1079 #define RNODE_KW_ARG(node) ((rb_node_kw_arg_t *)(node))
1080 #define RNODE_POSTARG(node) ((rb_node_postarg_t *)(node))
1081 #define RNODE_ARGSCAT(node) ((rb_node_argscat_t *)(node))
1082 #define RNODE_ARGSPUSH(node) ((rb_node_argspush_t *)(node))
1083 #define RNODE_SPLAT(node) ((rb_node_splat_t *)(node))
1084 #define RNODE_BLOCK_PASS(node) ((rb_node_block_pass_t *)(node))
1085 #define RNODE_DEFN(node) ((rb_node_defn_t *)(node))
1086 #define RNODE_DEFS(node) ((rb_node_defs_t *)(node))
1087 #define RNODE_ALIAS(node) ((rb_node_alias_t *)(node))
1088 #define RNODE_VALIAS(node) ((rb_node_valias_t *)(node))
1089 #define RNODE_UNDEF(node) ((rb_node_undef_t *)(node))
1090 #define RNODE_CLASS(node) ((rb_node_class_t *)(node))
1091 #define RNODE_MODULE(node) ((rb_node_module_t *)(node))
1092 #define RNODE_SCLASS(node) ((rb_node_sclass_t *)(node))
1093 #define RNODE_COLON2(node) ((rb_node_colon2_t *)(node))
1094 #define RNODE_COLON3(node) ((rb_node_colon3_t *)(node))
1095 #define RNODE_DOT2(node) ((rb_node_dot2_t *)(node))
1096 #define RNODE_DOT3(node) ((rb_node_dot3_t *)(node))
1097 #define RNODE_FLIP2(node) ((rb_node_flip2_t *)(node))
1098 #define RNODE_FLIP3(node) ((rb_node_flip3_t *)(node))
1099 #define RNODE_SELF(node) ((rb_node_self_t *)(node))
1100 #define RNODE_NIL(node) ((rb_node_nil_t *)(node))
1101 #define RNODE_TRUE(node) ((rb_node_true_t *)(node))
1102 #define RNODE_FALSE(node) ((rb_node_false_t *)(node))
1103 #define RNODE_ERRINFO(node) ((rb_node_errinfo_t *)(node))
1104 #define RNODE_DEFINED(node) ((rb_node_defined_t *)(node))
1105 #define RNODE_POSTEXE(node) ((rb_node_postexe_t *)(node))
1106 #define RNODE_SYM(node) ((rb_node_sym_t *)(node))
1107 #define RNODE_DSYM(node) ((rb_node_dsym_t *)(node))
1108 #define RNODE_ATTRASGN(node) ((rb_node_attrasgn_t *)(node))
1109 #define RNODE_LAMBDA(node) ((rb_node_lambda_t *)(node))
1110 #define RNODE_ARYPTN(node) ((rb_node_aryptn_t *)(node))
1111 #define RNODE_HSHPTN(node) ((rb_node_hshptn_t *)(node))
1112 #define RNODE_FNDPTN(node) ((rb_node_fndptn_t *)(node))
1113 #define RNODE_LINE(node) ((rb_node_line_t *)(node))
1114 #define RNODE_FILE(node) ((rb_node_file_t *)(node))
1115 #define RNODE_ENCODING(node) ((rb_node_encoding_t *)(node))
1117 /* FL : 0..4: T_TYPES, 5: KEEP_WB, 6: PROMOTED, 7: FINALIZE, 8: UNUSED, 9: UNUSED, 10: EXIVAR, 11: FREEZE */
1118 /* NODE_FL: 0..4: UNUSED, 5: UNUSED, 6: UNUSED, 7: NODE_FL_NEWLINE,
1119 * 8..14: nd_type,
1120 * 15..: nd_line
1122 #define NODE_FL_NEWLINE (((VALUE)1)<<7)
1124 #define NODE_TYPESHIFT 8
1125 #define NODE_TYPEMASK (((VALUE)0x7f)<<NODE_TYPESHIFT)
1127 #define nd_fl_newline(n) ((n)->flags & NODE_FL_NEWLINE)
1128 #define nd_set_fl_newline(n) ((n)->flags |= NODE_FL_NEWLINE)
1129 #define nd_unset_fl_newline(n) ((n)->flags &= ~NODE_FL_NEWLINE)
1131 #define nd_type(n) ((int) ((RNODE(n)->flags & NODE_TYPEMASK)>>NODE_TYPESHIFT))
1132 #define nd_set_type(n,t) \
1133 rb_node_set_type(n, t)
1134 #define nd_init_type(n,t) \
1135 (n)->flags=(((n)->flags&~NODE_TYPEMASK)|((((unsigned long)(t))<<NODE_TYPESHIFT)&NODE_TYPEMASK))
1137 typedef struct node_buffer_struct node_buffer_t;
1139 #ifdef UNIVERSAL_PARSER
1140 typedef struct rb_parser_config_struct rb_parser_config_t;
1141 #endif
1143 typedef struct rb_ast_body_struct {
1144 const NODE *root;
1145 rb_parser_ary_t *script_lines;
1146 int line_count;
1147 signed int frozen_string_literal:2; /* -1: not specified, 0: false, 1: true */
1148 signed int coverage_enabled:2; /* -1: not specified, 0: false, 1: true */
1149 } rb_ast_body_t;
1150 typedef struct rb_ast_struct {
1151 node_buffer_t *node_buffer;
1152 rb_ast_body_t body;
1153 #ifdef UNIVERSAL_PARSER
1154 const rb_parser_config_t *config;
1155 #endif
1156 } rb_ast_t;
1161 * Parser Interface
1165 typedef struct parser_params rb_parser_t;
1166 #ifndef INTERNAL_IMEMO_H
1167 typedef struct rb_imemo_tmpbuf_struct rb_imemo_tmpbuf_t;
1168 #endif
1170 #ifdef UNIVERSAL_PARSER
1171 typedef struct rb_parser_config_struct {
1172 /* Memory */
1173 void *(*malloc)(size_t size);
1174 void *(*calloc)(size_t number, size_t size);
1175 void *(*realloc)(void *ptr, size_t newsiz);
1176 void (*free)(void *ptr);
1177 void *(*alloc_n)(size_t nelems, size_t elemsiz);
1178 void *(*alloc)(size_t elemsiz);
1179 void *(*realloc_n)(void *ptr, size_t newelems, size_t newsiz);
1180 void *(*zalloc)(size_t elemsiz);
1181 void *(*rb_memmove)(void *dest, const void *src, size_t t, size_t n);
1182 void *(*nonempty_memcpy)(void *dest, const void *src, size_t t, size_t n);
1183 void *(*xmalloc_mul_add)(size_t x, size_t y, size_t z);
1185 // VALUE rb_suppress_tracing(VALUE (*func)(VALUE), VALUE arg);
1186 VALUE (*compile_callback)(VALUE (*func)(VALUE), VALUE arg);
1187 NODE *(*reg_named_capture_assign)(struct parser_params* p, VALUE regexp, const rb_code_location_t *loc);
1189 /* Variable */
1190 VALUE (*attr_get)(VALUE obj, ID id);
1192 /* Array */
1193 VALUE (*ary_new)(void);
1194 VALUE (*ary_push)(VALUE ary, VALUE elem);
1195 VALUE (*ary_new_from_args)(long n, ...);
1196 VALUE (*ary_unshift)(VALUE ary, VALUE item);
1198 /* Symbol */
1199 ID (*make_temporary_id)(size_t n);
1200 int (*is_local_id)(ID);
1201 int (*is_attrset_id)(ID);
1202 int (*is_global_name_punct)(const int c);
1203 int (*id_type)(ID id);
1204 ID (*id_attrset)(ID);
1205 ID (*intern)(const char *name);
1206 ID (*intern2)(const char *name, long len);
1207 ID (*intern3)(const char *name, long len, rb_encoding *enc);
1208 ID (*intern_str)(VALUE str);
1209 int (*is_notop_id)(ID);
1210 int (*enc_symname_type)(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset);
1211 const char *(*id2name)(ID id);
1212 VALUE (*id2str)(ID id);
1213 VALUE (*id2sym)(ID x);
1214 ID (*sym2id)(VALUE sym);
1216 /* String */
1217 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1218 VALUE (*str_catf)(VALUE str, const char *format, ...);
1219 VALUE (*str_cat_cstr)(VALUE str, const char *ptr);
1220 VALUE (*str_resize)(VALUE str, long len);
1221 VALUE (*str_new)(const char *ptr, long len);
1222 VALUE (*str_new_cstr)(const char *ptr);
1223 VALUE (*str_to_interned_str)(VALUE);
1224 int (*is_ascii_string)(VALUE str);
1225 VALUE (*enc_str_new)(const char *ptr, long len, rb_encoding *enc);
1226 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 0)
1227 VALUE (*str_vcatf)(VALUE str, const char *fmt, va_list ap);
1228 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
1229 VALUE (*rb_sprintf)(const char *format, ...);
1230 char *(*rstring_ptr)(VALUE str);
1231 char *(*rstring_end)(VALUE str);
1232 long (*rstring_len)(VALUE str);
1233 VALUE (*obj_as_string)(VALUE);
1235 /* Numeric */
1236 VALUE (*int2num)(int v);
1238 /* IO */
1239 int (*stderr_tty_p)(void);
1240 void (*write_error_str)(VALUE mesg);
1241 VALUE (*io_write)(VALUE io, VALUE str);
1242 VALUE (*io_flush)(VALUE io);
1243 VALUE (*io_puts)(int argc, const VALUE *argv, VALUE out);
1245 /* IO (Ractor) */
1246 VALUE (*debug_output_stdout)(void);
1247 VALUE (*debug_output_stderr)(void);
1249 /* Encoding */
1250 int (*is_usascii_enc)(rb_encoding *enc);
1251 int (*enc_isalnum)(OnigCodePoint c, rb_encoding *enc);
1252 int (*enc_precise_mbclen)(const char *p, const char *e, rb_encoding *enc);
1253 int (*mbclen_charfound_p)(int len);
1254 int (*mbclen_charfound_len)(int len);
1255 const char *(*enc_name)(rb_encoding *enc);
1256 char *(*enc_prev_char)(const char *s, const char *p, const char *e, rb_encoding *enc);
1257 rb_encoding* (*enc_get)(VALUE obj);
1258 int (*enc_asciicompat)(rb_encoding *enc);
1259 rb_encoding *(*utf8_encoding)(void);
1260 VALUE (*enc_associate)(VALUE obj, rb_encoding *enc);
1261 rb_encoding *(*ascii8bit_encoding)(void);
1262 int (*enc_codelen)(int c, rb_encoding *enc);
1263 int (*enc_mbcput)(unsigned int c, void *buf, rb_encoding *enc);
1264 int (*enc_find_index)(const char *name);
1265 rb_encoding *(*enc_from_index)(int idx);
1266 int (*enc_isspace)(OnigCodePoint c, rb_encoding *enc);
1267 rb_encoding *(*usascii_encoding)(void);
1268 int (*enc_mbminlen)(rb_encoding *enc);
1269 bool (*enc_isascii)(OnigCodePoint c, rb_encoding *enc);
1270 OnigCodePoint (*enc_mbc_to_codepoint)(const char *p, const char *e, rb_encoding *enc);
1272 /* Compile */
1273 // int rb_local_defined(ID id, const rb_iseq_t *iseq);
1274 int (*local_defined)(ID, const void*);
1275 // int rb_dvar_defined(ID id, const rb_iseq_t *iseq);
1276 int (*dvar_defined)(ID, const void*);
1278 /* Error (Exception) */
1279 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 6, 0)
1280 VALUE (*syntax_error_append)(VALUE, VALUE, int, int, rb_encoding*, const char*, va_list);
1281 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1282 void (*raise)(VALUE exc, const char *fmt, ...);
1283 VALUE (*syntax_error_new)(void);
1285 /* Eval */
1286 VALUE (*errinfo)(void);
1287 void (*set_errinfo)(VALUE err);
1288 void (*exc_raise)(VALUE mesg);
1289 VALUE (*make_exception)(int argc, const VALUE *argv);
1291 /* GC */
1292 void (*sized_xfree)(void *x, size_t size);
1293 void *(*sized_realloc_n)(void *ptr, size_t new_count, size_t element_size, size_t old_count);
1294 void (*gc_guard)(VALUE);
1295 void (*gc_mark)(VALUE);
1297 /* Re */
1298 VALUE (*reg_compile)(VALUE str, int options, const char *sourcefile, int sourceline);
1299 VALUE (*reg_check_preprocess)(VALUE str);
1300 int (*memcicmp)(const void *x, const void *y, long len);
1302 /* Error */
1303 void (*compile_warn)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1304 void (*compile_warning)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1305 void (*bug)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1306 void (*fatal)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1307 VALUE (*verbose)(void);
1308 int *(*errno_ptr)(void);
1310 /* VM */
1311 VALUE (*make_backtrace)(void);
1313 /* Util */
1314 unsigned long (*scan_hex)(const char *start, size_t len, size_t *retlen);
1315 unsigned long (*scan_oct)(const char *start, size_t len, size_t *retlen);
1316 unsigned long (*scan_digits)(const char *str, ssize_t len, int base, size_t *retlen, int *overflow);
1317 double (*strtod)(const char *s00, char **se);
1319 /* Misc */
1320 int (*rtest)(VALUE obj);
1321 int (*nil_p)(VALUE obj);
1322 VALUE qnil;
1323 VALUE qfalse;
1324 VALUE (*eArgError)(void);
1325 int (*long2int)(long);
1327 /* For Ripper */
1328 int enc_coderange_7bit;
1329 int enc_coderange_unknown;
1330 VALUE (*static_id2sym)(ID id);
1331 long (*str_coderange_scan_restartable)(const char *s, const char *e, rb_encoding *enc, int *cr);
1332 } rb_parser_config_t;
1334 #undef rb_encoding
1335 #undef OnigCodePoint
1336 #endif /* UNIVERSAL_PARSER */
1338 RUBY_SYMBOL_EXPORT_BEGIN
1339 void rb_ruby_parser_free(void *ptr);
1341 #ifdef UNIVERSAL_PARSER
1342 rb_parser_t *rb_ruby_parser_allocate(const rb_parser_config_t *config);
1343 rb_parser_t *rb_ruby_parser_new(const rb_parser_config_t *config);
1344 #endif
1346 RUBY_SYMBOL_EXPORT_END
1348 #endif /* RUBY_RUBYPARSER_H */