Fix object allocation counters in compaction
[ruby.git] / rubyparser.h
blobf60dfddd5984a6fc6a4259b37641b63b345cda9a
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_node_case_t;
288 typedef struct RNode_CASE2 {
289 NODE node;
291 struct RNode *nd_head;
292 struct RNode *nd_body;
293 } rb_node_case2_t;
295 typedef struct RNode_CASE3 {
296 NODE node;
298 struct RNode *nd_head;
299 struct RNode *nd_body;
300 } rb_node_case3_t;
302 typedef struct RNode_WHEN {
303 NODE node;
305 struct RNode *nd_head;
306 struct RNode *nd_body;
307 struct RNode *nd_next;
308 } rb_node_when_t;
310 typedef struct RNode_IN {
311 NODE node;
313 struct RNode *nd_head;
314 struct RNode *nd_body;
315 struct RNode *nd_next;
316 } rb_node_in_t;
318 typedef struct RNode_LOOP {
319 NODE node;
321 struct RNode *nd_cond;
322 struct RNode *nd_body;
323 long nd_state;
324 } rb_node_while_t, rb_node_until_t;
326 typedef struct RNode_ITER {
327 NODE node;
329 struct RNode *nd_body;
330 struct RNode *nd_iter;
331 } rb_node_iter_t, rb_node_for_t;
333 typedef struct RNode_FOR_MASGN {
334 NODE node;
336 struct RNode *nd_var;
337 } rb_node_for_masgn_t;
339 typedef struct RNode_EXITS {
340 NODE node;
342 struct RNode *nd_chain;
343 struct RNode *nd_stts;
344 } rb_node_exits_t, rb_node_break_t, rb_node_next_t, rb_node_redo_t;
346 typedef struct RNode_RETRY {
347 NODE node;
348 } rb_node_retry_t;
350 typedef struct RNode_BEGIN {
351 NODE node;
353 struct RNode *nd_body;
354 } rb_node_begin_t;
356 typedef struct RNode_RESCUE {
357 NODE node;
359 struct RNode *nd_head;
360 struct RNode *nd_resq;
361 struct RNode *nd_else;
362 } rb_node_rescue_t;
364 typedef struct RNode_RESBODY {
365 NODE node;
367 struct RNode *nd_args;
368 struct RNode *nd_exc_var;
369 struct RNode *nd_body;
370 struct RNode *nd_next;
371 } rb_node_resbody_t;
373 typedef struct RNode_ENSURE {
374 NODE node;
376 struct RNode *nd_head;
377 struct RNode *nd_ensr;
378 } rb_node_ensure_t;
380 typedef struct {
381 NODE node;
383 struct RNode *nd_1st;
384 struct RNode *nd_2nd;
385 } rb_node_and_t, rb_node_or_t;
387 typedef struct RNode_MASGN {
388 NODE node;
390 struct RNode *nd_head;
391 struct RNode *nd_value;
392 struct RNode *nd_args;
393 } rb_node_masgn_t;
395 typedef struct RNode_LASGN {
396 NODE node;
398 ID nd_vid;
399 struct RNode *nd_value;
400 } rb_node_lasgn_t;
402 typedef struct RNode_DASGN {
403 NODE node;
405 ID nd_vid;
406 struct RNode *nd_value;
407 } rb_node_dasgn_t;
409 typedef struct RNode_GASGN {
410 NODE node;
412 ID nd_vid;
413 struct RNode *nd_value;
414 } rb_node_gasgn_t;
416 typedef struct RNode_IASGN {
417 NODE node;
419 ID nd_vid;
420 struct RNode *nd_value;
421 } rb_node_iasgn_t;
423 typedef struct RNode_CDECL {
424 NODE node;
426 ID nd_vid;
427 struct RNode *nd_value;
428 struct RNode *nd_else;
429 enum rb_parser_shareability shareability;
430 } rb_node_cdecl_t;
432 typedef struct RNode_CVASGN {
433 NODE node;
435 ID nd_vid;
436 struct RNode *nd_value;
437 } rb_node_cvasgn_t;
439 typedef struct RNode_OP_ASGN1 {
440 NODE node;
442 struct RNode *nd_recv;
443 ID nd_mid;
444 struct RNode *nd_index;
445 struct RNode *nd_rvalue;
446 } rb_node_op_asgn1_t;
448 typedef struct RNode_OP_ASGN2 {
449 NODE node;
451 struct RNode *nd_recv;
452 struct RNode *nd_value;
453 ID nd_vid;
454 ID nd_mid;
455 bool nd_aid;
456 } rb_node_op_asgn2_t;
458 typedef struct RNode_OP_ASGN_AND {
459 NODE node;
461 struct RNode *nd_head;
462 struct RNode *nd_value;
463 } rb_node_op_asgn_and_t;
465 typedef struct RNode_OP_ASGN_OR {
466 NODE node;
468 struct RNode *nd_head;
469 struct RNode *nd_value;
470 } rb_node_op_asgn_or_t;
472 typedef struct RNode_OP_CDECL {
473 NODE node;
475 struct RNode *nd_head;
476 struct RNode *nd_value;
477 ID nd_aid;
478 enum rb_parser_shareability shareability;
479 } rb_node_op_cdecl_t;
481 typedef struct RNode_CALL {
482 NODE node;
484 struct RNode *nd_recv;
485 ID nd_mid;
486 struct RNode *nd_args;
487 } rb_node_call_t;
489 typedef struct RNode_OPCALL {
490 NODE node;
492 struct RNode *nd_recv;
493 ID nd_mid;
494 struct RNode *nd_args;
495 } rb_node_opcall_t;
497 typedef struct RNode_FCALL {
498 NODE node;
500 ID nd_mid;
501 struct RNode *nd_args;
502 } rb_node_fcall_t;
504 typedef struct RNode_VCALL {
505 NODE node;
507 ID nd_mid;
508 } rb_node_vcall_t;
510 typedef struct RNode_QCALL {
511 NODE node;
513 struct RNode *nd_recv;
514 ID nd_mid;
515 struct RNode *nd_args;
516 } rb_node_qcall_t;
518 typedef struct RNode_SUPER {
519 NODE node;
521 struct RNode *nd_args;
522 } rb_node_super_t;
524 typedef struct RNode_ZSUPER {
525 NODE node;
526 } rb_node_zsuper_t;
530 Structure of LIST:
532 LIST +--> LIST
533 * head --> element | * head
534 * alen (length of list) | * nd_end (point to the last LIST)
535 * next -----------------+ * next
538 typedef struct RNode_LIST {
539 NODE node;
541 struct RNode *nd_head; /* element */
542 union {
543 long nd_alen;
544 struct RNode *nd_end; /* Second list node has this structure */
545 } as;
546 struct RNode *nd_next; /* next list node */
547 } rb_node_list_t;
549 typedef struct RNode_ZLIST {
550 NODE node;
551 } rb_node_zlist_t;
553 typedef struct RNode_HASH {
554 NODE node;
556 struct RNode *nd_head;
557 long nd_brace;
558 } rb_node_hash_t;
560 typedef struct RNode_RETURN {
561 NODE node;
563 struct RNode *nd_stts;
564 } rb_node_return_t;
566 typedef struct RNode_YIELD {
567 NODE node;
569 struct RNode *nd_head;
570 } rb_node_yield_t;
572 typedef struct RNode_LVAR {
573 NODE node;
575 ID nd_vid;
576 } rb_node_lvar_t;
578 typedef struct RNode_DVAR {
579 NODE node;
581 ID nd_vid;
582 } rb_node_dvar_t;
584 typedef struct RNode_GVAR {
585 NODE node;
587 ID nd_vid;
588 } rb_node_gvar_t;
590 typedef struct RNode_IVAR {
591 NODE node;
593 ID nd_vid;
594 } rb_node_ivar_t;
596 typedef struct RNode_CONST {
597 NODE node;
599 ID nd_vid;
600 } rb_node_const_t;
602 typedef struct RNode_CVAR {
603 NODE node;
605 ID nd_vid;
606 } rb_node_cvar_t;
608 typedef struct RNode_NTH_REF {
609 NODE node;
611 long nd_nth;
612 } rb_node_nth_ref_t;
614 typedef struct RNode_BACK_REF {
615 NODE node;
617 long nd_nth;
618 } rb_node_back_ref_t;
620 typedef struct RNode_MATCH2 {
621 NODE node;
623 struct RNode *nd_recv;
624 struct RNode *nd_value;
625 struct RNode *nd_args;
626 } rb_node_match2_t;
628 typedef struct RNode_MATCH3 {
629 NODE node;
631 struct RNode *nd_recv;
632 struct RNode *nd_value;
633 } rb_node_match3_t;
635 typedef struct RNode_INTEGER {
636 NODE node;
638 char *val;
639 int minus;
640 int base;
641 } rb_node_integer_t;
643 typedef struct RNode_FLOAT {
644 NODE node;
646 char *val;
647 int minus;
648 } rb_node_float_t;
650 typedef struct RNode_RATIONAL {
651 NODE node;
653 char *val;
654 int minus;
655 int base;
656 int seen_point;
657 } rb_node_rational_t;
659 enum rb_numeric_type {
660 integer_literal,
661 float_literal,
662 rational_literal
665 typedef struct RNode_IMAGINARY {
666 NODE node;
668 char *val;
669 int minus;
670 int base;
671 int seen_point;
672 enum rb_numeric_type type;
673 } rb_node_imaginary_t;
675 typedef struct RNode_STR {
676 NODE node;
678 struct rb_parser_string *string;
679 } rb_node_str_t;
681 /* NODE_DSTR, NODE_DXSTR, NODE_DREGX, NODE_DSYM */
682 typedef struct RNode_DSTR {
683 NODE node;
685 struct rb_parser_string *string;
686 union {
687 long nd_alen;
688 long nd_cflag;
689 struct RNode *nd_end; /* Second dstr node has this structure. See also RNode_LIST */
690 } as;
691 struct RNode_LIST *nd_next;
692 } rb_node_dstr_t;
694 typedef rb_node_str_t rb_node_xstr_t;
696 typedef rb_node_dstr_t rb_node_dxstr_t;
698 typedef struct RNode_EVSTR {
699 NODE node;
701 struct RNode *nd_body;
702 } rb_node_evstr_t;
704 typedef struct RNode_REGX { /* also RNode_MATCH */
705 NODE node;
707 struct rb_parser_string *string;
708 int options;
709 } rb_node_regx_t, rb_node_match_t;
711 typedef rb_node_dstr_t rb_node_dregx_t;
713 typedef struct RNode_ONCE {
714 NODE node;
716 struct RNode *nd_body;
717 } rb_node_once_t;
719 struct rb_args_info {
720 NODE *pre_init;
721 NODE *post_init;
723 int pre_args_num; /* count of mandatory pre-arguments */
724 int post_args_num; /* count of mandatory post-arguments */
726 ID first_post_arg;
728 ID rest_arg;
729 ID block_arg;
731 struct RNode_KW_ARG *kw_args;
732 NODE *kw_rest_arg;
734 struct RNode_OPT_ARG *opt_args;
735 unsigned int no_kwarg: 1;
736 unsigned int ruby2_keywords: 1;
737 unsigned int forwarding: 1;
740 typedef struct RNode_ARGS {
741 NODE node;
743 struct rb_args_info nd_ainfo;
744 } rb_node_args_t;
746 typedef struct RNode_ARGS_AUX {
747 NODE node;
749 ID nd_pid;
750 int nd_plen;
751 struct RNode *nd_next;
752 } rb_node_args_aux_t;
754 typedef struct RNode_OPT_ARG {
755 NODE node;
757 struct RNode *nd_body;
758 struct RNode_OPT_ARG *nd_next;
759 } rb_node_opt_arg_t;
761 typedef struct RNode_KW_ARG {
762 NODE node;
764 struct RNode *nd_body;
765 struct RNode_KW_ARG *nd_next;
766 } rb_node_kw_arg_t;
768 typedef struct RNode_POSTARG {
769 NODE node;
771 struct RNode *nd_1st;
772 struct RNode *nd_2nd;
773 } rb_node_postarg_t;
775 typedef struct RNode_ARGSCAT {
776 NODE node;
778 struct RNode *nd_head;
779 struct RNode *nd_body;
780 } rb_node_argscat_t;
782 typedef struct RNode_ARGSPUSH {
783 NODE node;
785 struct RNode *nd_head;
786 struct RNode *nd_body;
787 } rb_node_argspush_t;
789 typedef struct RNode_SPLAT {
790 NODE node;
792 struct RNode *nd_head;
793 } rb_node_splat_t;
795 typedef struct RNode_BLOCK_PASS {
796 NODE node;
798 struct RNode *nd_head;
799 struct RNode *nd_body;
800 unsigned int forwarding: 1;
801 } rb_node_block_pass_t;
803 typedef struct RNode_DEFN {
804 NODE node;
806 ID nd_mid;
807 struct RNode *nd_defn;
808 } rb_node_defn_t;
810 typedef struct RNode_DEFS {
811 NODE node;
813 struct RNode *nd_recv;
814 ID nd_mid;
815 struct RNode *nd_defn;
816 } rb_node_defs_t;
818 typedef struct RNode_ALIAS {
819 NODE node;
821 struct RNode *nd_1st;
822 struct RNode *nd_2nd;
823 } rb_node_alias_t;
825 typedef struct RNode_VALIAS {
826 NODE node;
828 ID nd_alias;
829 ID nd_orig;
830 } rb_node_valias_t;
832 typedef struct RNode_UNDEF {
833 NODE node;
835 rb_parser_ary_t *nd_undefs;
836 } rb_node_undef_t;
838 typedef struct RNode_CLASS {
839 NODE node;
841 struct RNode *nd_cpath;
842 struct RNode *nd_body;
843 struct RNode *nd_super;
844 } rb_node_class_t;
846 typedef struct RNode_MODULE {
847 NODE node;
849 struct RNode *nd_cpath;
850 struct RNode *nd_body;
851 } rb_node_module_t;
853 typedef struct RNode_SCLASS {
854 NODE node;
856 struct RNode *nd_recv;
857 struct RNode *nd_body;
858 } rb_node_sclass_t;
860 typedef struct RNode_COLON2 {
861 NODE node;
863 struct RNode *nd_head;
864 ID nd_mid;
865 } rb_node_colon2_t;
867 typedef struct RNode_COLON3 {
868 NODE node;
870 ID nd_mid;
871 } rb_node_colon3_t;
873 /* NODE_DOT2, NODE_DOT3, NODE_FLIP2, NODE_FLIP3 */
874 typedef struct RNode_DOTS {
875 NODE node;
877 struct RNode *nd_beg;
878 struct RNode *nd_end;
879 } rb_node_dot2_t, rb_node_dot3_t, rb_node_flip2_t, rb_node_flip3_t;
881 typedef struct RNode_SELF {
882 NODE node;
884 long nd_state; /* Default 1. See NEW_SELF. */
885 } rb_node_self_t;
887 typedef struct RNode_NIL {
888 NODE node;
889 } rb_node_nil_t;
891 typedef struct RNode_TRUE {
892 NODE node;
893 } rb_node_true_t;
895 typedef struct RNode_FALSE {
896 NODE node;
897 } rb_node_false_t;
899 typedef struct RNode_ERRINFO {
900 NODE node;
901 } rb_node_errinfo_t;
903 typedef struct RNode_DEFINED {
904 NODE node;
906 struct RNode *nd_head;
907 } rb_node_defined_t;
909 typedef struct RNode_POSTEXE {
910 NODE node;
912 struct RNode *nd_body;
913 } rb_node_postexe_t;
915 typedef struct RNode_SYM {
916 NODE node;
918 struct rb_parser_string *string;
919 } rb_node_sym_t;
921 typedef rb_node_dstr_t rb_node_dsym_t;
923 typedef struct RNode_ATTRASGN {
924 NODE node;
926 struct RNode *nd_recv;
927 ID nd_mid;
928 struct RNode *nd_args;
929 } rb_node_attrasgn_t;
931 typedef struct RNode_LAMBDA {
932 NODE node;
934 struct RNode *nd_body;
935 } rb_node_lambda_t;
937 typedef struct RNode_ARYPTN {
938 NODE node;
940 struct RNode *nd_pconst;
941 NODE *pre_args;
942 NODE *rest_arg;
943 NODE *post_args;
944 } rb_node_aryptn_t;
946 typedef struct RNode_HSHPTN {
947 NODE node;
949 struct RNode *nd_pconst;
950 struct RNode *nd_pkwargs;
951 struct RNode *nd_pkwrestarg;
952 } rb_node_hshptn_t;
954 typedef struct RNode_FNDPTN {
955 NODE node;
957 struct RNode *nd_pconst;
958 NODE *pre_rest_arg;
959 NODE *args;
960 NODE *post_rest_arg;
961 } rb_node_fndptn_t;
963 typedef struct RNode_LINE {
964 NODE node;
965 } rb_node_line_t;
967 typedef struct RNode_FILE {
968 NODE node;
970 struct rb_parser_string *path;
971 } rb_node_file_t;
973 typedef struct RNode_ENCODING {
974 NODE node;
975 rb_encoding *enc;
976 } rb_node_encoding_t;
978 typedef struct RNode_ERROR {
979 NODE node;
980 } rb_node_error_t;
982 #define RNODE(obj) ((NODE *)(obj))
984 #define RNODE_SCOPE(node) ((rb_node_scope_t *)(node))
985 #define RNODE_BLOCK(node) ((rb_node_block_t *)(node))
986 #define RNODE_IF(node) ((rb_node_if_t *)(node))
987 #define RNODE_UNLESS(node) ((rb_node_unless_t *)(node))
988 #define RNODE_CASE(node) ((rb_node_case_t *)(node))
989 #define RNODE_CASE2(node) ((rb_node_case2_t *)(node))
990 #define RNODE_CASE3(node) ((rb_node_case3_t *)(node))
991 #define RNODE_WHEN(node) ((rb_node_when_t *)(node))
992 #define RNODE_IN(node) ((rb_node_in_t *)(node))
993 #define RNODE_WHILE(node) ((rb_node_while_t *)(node))
994 #define RNODE_UNTIL(node) ((rb_node_until_t *)(node))
995 #define RNODE_ITER(node) ((rb_node_iter_t *)(node))
996 #define RNODE_FOR(node) ((rb_node_for_t *)(node))
997 #define RNODE_FOR_MASGN(node) ((rb_node_for_masgn_t *)(node))
998 #define RNODE_BREAK(node) ((rb_node_break_t *)(node))
999 #define RNODE_NEXT(node) ((rb_node_next_t *)(node))
1000 #define RNODE_REDO(node) ((rb_node_redo_t *)(node))
1001 #define RNODE_RETRY(node) ((rb_node_retry_t *)(node))
1002 #define RNODE_BEGIN(node) ((rb_node_begin_t *)(node))
1003 #define RNODE_RESCUE(node) ((rb_node_rescue_t *)(node))
1004 #define RNODE_RESBODY(node) ((rb_node_resbody_t *)(node))
1005 #define RNODE_ENSURE(node) ((rb_node_ensure_t *)(node))
1006 #define RNODE_AND(node) ((rb_node_and_t *)(node))
1007 #define RNODE_OR(node) ((rb_node_or_t *)(node))
1008 #define RNODE_MASGN(node) ((rb_node_masgn_t *)(node))
1009 #define RNODE_LASGN(node) ((rb_node_lasgn_t *)(node))
1010 #define RNODE_DASGN(node) ((rb_node_dasgn_t *)(node))
1011 #define RNODE_GASGN(node) ((rb_node_gasgn_t *)(node))
1012 #define RNODE_IASGN(node) ((rb_node_iasgn_t *)(node))
1013 #define RNODE_CDECL(node) ((rb_node_cdecl_t *)(node))
1014 #define RNODE_CVASGN(node) ((rb_node_cvasgn_t *)(node))
1015 #define RNODE_OP_ASGN1(node) ((rb_node_op_asgn1_t *)(node))
1016 #define RNODE_OP_ASGN2(node) ((rb_node_op_asgn2_t *)(node))
1017 #define RNODE_OP_ASGN_AND(node) ((rb_node_op_asgn_and_t *)(node))
1018 #define RNODE_OP_ASGN_OR(node) ((rb_node_op_asgn_or_t *)(node))
1019 #define RNODE_OP_CDECL(node) ((rb_node_op_cdecl_t *)(node))
1020 #define RNODE_CALL(node) ((rb_node_call_t *)(node))
1021 #define RNODE_OPCALL(node) ((rb_node_opcall_t *)(node))
1022 #define RNODE_FCALL(node) ((rb_node_fcall_t *)(node))
1023 #define RNODE_VCALL(node) ((rb_node_vcall_t *)(node))
1024 #define RNODE_QCALL(node) ((rb_node_qcall_t *)(node))
1025 #define RNODE_SUPER(node) ((rb_node_super_t *)(node))
1026 #define RNODE_ZSUPER(node) ((rb_node_zsuper_t *)(node))
1027 #define RNODE_LIST(node) ((rb_node_list_t *)(node))
1028 #define RNODE_ZLIST(node) ((rb_node_zlist_t *)(node))
1029 #define RNODE_HASH(node) ((rb_node_hash_t *)(node))
1030 #define RNODE_RETURN(node) ((rb_node_return_t *)(node))
1031 #define RNODE_YIELD(node) ((rb_node_yield_t *)(node))
1032 #define RNODE_LVAR(node) ((rb_node_lvar_t *)(node))
1033 #define RNODE_DVAR(node) ((rb_node_dvar_t *)(node))
1034 #define RNODE_GVAR(node) ((rb_node_gvar_t *)(node))
1035 #define RNODE_IVAR(node) ((rb_node_ivar_t *)(node))
1036 #define RNODE_CONST(node) ((rb_node_const_t *)(node))
1037 #define RNODE_CVAR(node) ((rb_node_cvar_t *)(node))
1038 #define RNODE_NTH_REF(node) ((rb_node_nth_ref_t *)(node))
1039 #define RNODE_BACK_REF(node) ((rb_node_back_ref_t *)(node))
1040 #define RNODE_MATCH(node) ((rb_node_match_t *)(node))
1041 #define RNODE_MATCH2(node) ((rb_node_match2_t *)(node))
1042 #define RNODE_MATCH3(node) ((rb_node_match3_t *)(node))
1043 #define RNODE_INTEGER(node) ((rb_node_integer_t *)(node))
1044 #define RNODE_FLOAT(node) ((rb_node_float_t *)(node))
1045 #define RNODE_RATIONAL(node) ((rb_node_rational_t *)(node))
1046 #define RNODE_IMAGINARY(node) ((rb_node_imaginary_t *)(node))
1047 #define RNODE_STR(node) ((rb_node_str_t *)(node))
1048 #define RNODE_DSTR(node) ((rb_node_dstr_t *)(node))
1049 #define RNODE_XSTR(node) ((rb_node_xstr_t *)(node))
1050 #define RNODE_DXSTR(node) ((rb_node_dxstr_t *)(node))
1051 #define RNODE_EVSTR(node) ((rb_node_evstr_t *)(node))
1052 #define RNODE_REGX(node) ((rb_node_regx_t *)(node))
1053 #define RNODE_DREGX(node) ((rb_node_dregx_t *)(node))
1054 #define RNODE_ONCE(node) ((rb_node_once_t *)(node))
1055 #define RNODE_ARGS(node) ((rb_node_args_t *)(node))
1056 #define RNODE_ARGS_AUX(node) ((rb_node_args_aux_t *)(node))
1057 #define RNODE_OPT_ARG(node) ((rb_node_opt_arg_t *)(node))
1058 #define RNODE_KW_ARG(node) ((rb_node_kw_arg_t *)(node))
1059 #define RNODE_POSTARG(node) ((rb_node_postarg_t *)(node))
1060 #define RNODE_ARGSCAT(node) ((rb_node_argscat_t *)(node))
1061 #define RNODE_ARGSPUSH(node) ((rb_node_argspush_t *)(node))
1062 #define RNODE_SPLAT(node) ((rb_node_splat_t *)(node))
1063 #define RNODE_BLOCK_PASS(node) ((rb_node_block_pass_t *)(node))
1064 #define RNODE_DEFN(node) ((rb_node_defn_t *)(node))
1065 #define RNODE_DEFS(node) ((rb_node_defs_t *)(node))
1066 #define RNODE_ALIAS(node) ((rb_node_alias_t *)(node))
1067 #define RNODE_VALIAS(node) ((rb_node_valias_t *)(node))
1068 #define RNODE_UNDEF(node) ((rb_node_undef_t *)(node))
1069 #define RNODE_CLASS(node) ((rb_node_class_t *)(node))
1070 #define RNODE_MODULE(node) ((rb_node_module_t *)(node))
1071 #define RNODE_SCLASS(node) ((rb_node_sclass_t *)(node))
1072 #define RNODE_COLON2(node) ((rb_node_colon2_t *)(node))
1073 #define RNODE_COLON3(node) ((rb_node_colon3_t *)(node))
1074 #define RNODE_DOT2(node) ((rb_node_dot2_t *)(node))
1075 #define RNODE_DOT3(node) ((rb_node_dot3_t *)(node))
1076 #define RNODE_FLIP2(node) ((rb_node_flip2_t *)(node))
1077 #define RNODE_FLIP3(node) ((rb_node_flip3_t *)(node))
1078 #define RNODE_SELF(node) ((rb_node_self_t *)(node))
1079 #define RNODE_NIL(node) ((rb_node_nil_t *)(node))
1080 #define RNODE_TRUE(node) ((rb_node_true_t *)(node))
1081 #define RNODE_FALSE(node) ((rb_node_false_t *)(node))
1082 #define RNODE_ERRINFO(node) ((rb_node_errinfo_t *)(node))
1083 #define RNODE_DEFINED(node) ((rb_node_defined_t *)(node))
1084 #define RNODE_POSTEXE(node) ((rb_node_postexe_t *)(node))
1085 #define RNODE_SYM(node) ((rb_node_sym_t *)(node))
1086 #define RNODE_DSYM(node) ((rb_node_dsym_t *)(node))
1087 #define RNODE_ATTRASGN(node) ((rb_node_attrasgn_t *)(node))
1088 #define RNODE_LAMBDA(node) ((rb_node_lambda_t *)(node))
1089 #define RNODE_ARYPTN(node) ((rb_node_aryptn_t *)(node))
1090 #define RNODE_HSHPTN(node) ((rb_node_hshptn_t *)(node))
1091 #define RNODE_FNDPTN(node) ((rb_node_fndptn_t *)(node))
1092 #define RNODE_LINE(node) ((rb_node_line_t *)(node))
1093 #define RNODE_FILE(node) ((rb_node_file_t *)(node))
1094 #define RNODE_ENCODING(node) ((rb_node_encoding_t *)(node))
1096 /* FL : 0..4: T_TYPES, 5: KEEP_WB, 6: PROMOTED, 7: FINALIZE, 8: UNUSED, 9: UNUSED, 10: EXIVAR, 11: FREEZE */
1097 /* NODE_FL: 0..4: UNUSED, 5: UNUSED, 6: UNUSED, 7: NODE_FL_NEWLINE,
1098 * 8..14: nd_type,
1099 * 15..: nd_line
1101 #define NODE_FL_NEWLINE (((VALUE)1)<<7)
1103 #define NODE_TYPESHIFT 8
1104 #define NODE_TYPEMASK (((VALUE)0x7f)<<NODE_TYPESHIFT)
1106 #define nd_fl_newline(n) ((n)->flags & NODE_FL_NEWLINE)
1107 #define nd_set_fl_newline(n) ((n)->flags |= NODE_FL_NEWLINE)
1108 #define nd_unset_fl_newline(n) ((n)->flags &= ~NODE_FL_NEWLINE)
1110 #define nd_type(n) ((int) ((RNODE(n)->flags & NODE_TYPEMASK)>>NODE_TYPESHIFT))
1111 #define nd_set_type(n,t) \
1112 rb_node_set_type(n, t)
1113 #define nd_init_type(n,t) \
1114 (n)->flags=(((n)->flags&~NODE_TYPEMASK)|((((unsigned long)(t))<<NODE_TYPESHIFT)&NODE_TYPEMASK))
1116 typedef struct node_buffer_struct node_buffer_t;
1118 #ifdef UNIVERSAL_PARSER
1119 typedef struct rb_parser_config_struct rb_parser_config_t;
1120 #endif
1122 typedef struct rb_ast_body_struct {
1123 const NODE *root;
1124 rb_parser_ary_t *script_lines;
1125 int line_count;
1126 signed int frozen_string_literal:2; /* -1: not specified, 0: false, 1: true */
1127 signed int coverage_enabled:2; /* -1: not specified, 0: false, 1: true */
1128 } rb_ast_body_t;
1129 typedef struct rb_ast_struct {
1130 node_buffer_t *node_buffer;
1131 rb_ast_body_t body;
1132 #ifdef UNIVERSAL_PARSER
1133 const rb_parser_config_t *config;
1134 #endif
1135 } rb_ast_t;
1140 * Parser Interface
1144 typedef struct parser_params rb_parser_t;
1145 #ifndef INTERNAL_IMEMO_H
1146 typedef struct rb_imemo_tmpbuf_struct rb_imemo_tmpbuf_t;
1147 #endif
1149 #ifdef UNIVERSAL_PARSER
1150 typedef struct rb_parser_config_struct {
1151 /* Memory */
1152 void *(*malloc)(size_t size);
1153 void *(*calloc)(size_t number, size_t size);
1154 void *(*realloc)(void *ptr, size_t newsiz);
1155 void (*free)(void *ptr);
1156 void *(*alloc_n)(size_t nelems, size_t elemsiz);
1157 void *(*alloc)(size_t elemsiz);
1158 void *(*realloc_n)(void *ptr, size_t newelems, size_t newsiz);
1159 void *(*zalloc)(size_t elemsiz);
1160 void *(*rb_memmove)(void *dest, const void *src, size_t t, size_t n);
1161 void *(*nonempty_memcpy)(void *dest, const void *src, size_t t, size_t n);
1162 void *(*xmalloc_mul_add)(size_t x, size_t y, size_t z);
1164 // VALUE rb_suppress_tracing(VALUE (*func)(VALUE), VALUE arg);
1165 VALUE (*compile_callback)(VALUE (*func)(VALUE), VALUE arg);
1166 NODE *(*reg_named_capture_assign)(struct parser_params* p, VALUE regexp, const rb_code_location_t *loc);
1168 /* Variable */
1169 VALUE (*attr_get)(VALUE obj, ID id);
1171 /* Array */
1172 VALUE (*ary_new)(void);
1173 VALUE (*ary_push)(VALUE ary, VALUE elem);
1174 VALUE (*ary_new_from_args)(long n, ...);
1175 VALUE (*ary_unshift)(VALUE ary, VALUE item);
1177 /* Symbol */
1178 ID (*make_temporary_id)(size_t n);
1179 int (*is_local_id)(ID);
1180 int (*is_attrset_id)(ID);
1181 int (*is_global_name_punct)(const int c);
1182 int (*id_type)(ID id);
1183 ID (*id_attrset)(ID);
1184 ID (*intern)(const char *name);
1185 ID (*intern2)(const char *name, long len);
1186 ID (*intern3)(const char *name, long len, rb_encoding *enc);
1187 ID (*intern_str)(VALUE str);
1188 int (*is_notop_id)(ID);
1189 int (*enc_symname_type)(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset);
1190 const char *(*id2name)(ID id);
1191 VALUE (*id2str)(ID id);
1192 VALUE (*id2sym)(ID x);
1193 ID (*sym2id)(VALUE sym);
1195 /* String */
1196 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1197 VALUE (*str_catf)(VALUE str, const char *format, ...);
1198 VALUE (*str_cat_cstr)(VALUE str, const char *ptr);
1199 void (*str_modify)(VALUE str);
1200 void (*str_set_len)(VALUE str, long len);
1201 VALUE (*str_cat)(VALUE str, const char *ptr, long len);
1202 VALUE (*str_resize)(VALUE str, long len);
1203 VALUE (*str_new)(const char *ptr, long len);
1204 VALUE (*str_new_cstr)(const char *ptr);
1205 VALUE (*str_to_interned_str)(VALUE);
1206 int (*is_ascii_string)(VALUE str);
1207 VALUE (*enc_str_new)(const char *ptr, long len, rb_encoding *enc);
1208 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 0)
1209 VALUE (*str_vcatf)(VALUE str, const char *fmt, va_list ap);
1210 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
1211 VALUE (*rb_sprintf)(const char *format, ...);
1212 char *(*rstring_ptr)(VALUE str);
1213 char *(*rstring_end)(VALUE str);
1214 long (*rstring_len)(VALUE str);
1215 VALUE (*obj_as_string)(VALUE);
1217 /* Numeric */
1218 VALUE (*int2num)(int v);
1220 /* IO */
1221 int (*stderr_tty_p)(void);
1222 void (*write_error_str)(VALUE mesg);
1223 VALUE (*io_write)(VALUE io, VALUE str);
1224 VALUE (*io_flush)(VALUE io);
1225 VALUE (*io_puts)(int argc, const VALUE *argv, VALUE out);
1227 /* IO (Ractor) */
1228 VALUE (*debug_output_stdout)(void);
1229 VALUE (*debug_output_stderr)(void);
1231 /* Encoding */
1232 int (*is_usascii_enc)(rb_encoding *enc);
1233 int (*enc_isalnum)(OnigCodePoint c, rb_encoding *enc);
1234 int (*enc_precise_mbclen)(const char *p, const char *e, rb_encoding *enc);
1235 int (*mbclen_charfound_p)(int len);
1236 int (*mbclen_charfound_len)(int len);
1237 const char *(*enc_name)(rb_encoding *enc);
1238 char *(*enc_prev_char)(const char *s, const char *p, const char *e, rb_encoding *enc);
1239 rb_encoding* (*enc_get)(VALUE obj);
1240 int (*enc_asciicompat)(rb_encoding *enc);
1241 rb_encoding *(*utf8_encoding)(void);
1242 VALUE (*enc_associate)(VALUE obj, rb_encoding *enc);
1243 rb_encoding *(*ascii8bit_encoding)(void);
1244 int (*enc_codelen)(int c, rb_encoding *enc);
1245 int (*enc_mbcput)(unsigned int c, void *buf, rb_encoding *enc);
1246 int (*enc_find_index)(const char *name);
1247 rb_encoding *(*enc_from_index)(int idx);
1248 int (*enc_isspace)(OnigCodePoint c, rb_encoding *enc);
1249 rb_encoding *(*usascii_encoding)(void);
1250 int enc_coderange_broken;
1251 int (*enc_mbminlen)(rb_encoding *enc);
1252 bool (*enc_isascii)(OnigCodePoint c, rb_encoding *enc);
1253 OnigCodePoint (*enc_mbc_to_codepoint)(const char *p, const char *e, rb_encoding *enc);
1255 /* Compile */
1256 // int rb_local_defined(ID id, const rb_iseq_t *iseq);
1257 int (*local_defined)(ID, const void*);
1258 // int rb_dvar_defined(ID id, const rb_iseq_t *iseq);
1259 int (*dvar_defined)(ID, const void*);
1261 /* Error (Exception) */
1262 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 6, 0)
1263 VALUE (*syntax_error_append)(VALUE, VALUE, int, int, rb_encoding*, const char*, va_list);
1264 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1265 void (*raise)(VALUE exc, const char *fmt, ...);
1266 VALUE (*syntax_error_new)(void);
1268 /* Eval */
1269 VALUE (*errinfo)(void);
1270 void (*set_errinfo)(VALUE err);
1271 void (*exc_raise)(VALUE mesg);
1272 VALUE (*make_exception)(int argc, const VALUE *argv);
1274 /* GC */
1275 void (*sized_xfree)(void *x, size_t size);
1276 void *(*sized_realloc_n)(void *ptr, size_t new_count, size_t element_size, size_t old_count);
1277 void (*gc_guard)(VALUE);
1278 void (*gc_mark)(VALUE);
1280 /* Re */
1281 VALUE (*reg_compile)(VALUE str, int options, const char *sourcefile, int sourceline);
1282 VALUE (*reg_check_preprocess)(VALUE str);
1283 int (*memcicmp)(const void *x, const void *y, long len);
1285 /* Error */
1286 void (*compile_warn)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1287 void (*compile_warning)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1288 void (*bug)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1289 void (*fatal)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1290 VALUE (*verbose)(void);
1291 int *(*errno_ptr)(void);
1293 /* VM */
1294 VALUE (*make_backtrace)(void);
1296 /* Util */
1297 unsigned long (*scan_hex)(const char *start, size_t len, size_t *retlen);
1298 unsigned long (*scan_oct)(const char *start, size_t len, size_t *retlen);
1299 unsigned long (*scan_digits)(const char *str, ssize_t len, int base, size_t *retlen, int *overflow);
1300 double (*strtod)(const char *s00, char **se);
1302 /* Misc */
1303 int (*rtest)(VALUE obj);
1304 int (*nil_p)(VALUE obj);
1305 VALUE qnil;
1306 VALUE qfalse;
1307 VALUE (*eArgError)(void);
1308 int (*long2int)(long);
1310 /* For Ripper */
1311 int enc_coderange_7bit;
1312 int enc_coderange_unknown;
1313 VALUE (*static_id2sym)(ID id);
1314 long (*str_coderange_scan_restartable)(const char *s, const char *e, rb_encoding *enc, int *cr);
1315 } rb_parser_config_t;
1317 #undef rb_encoding
1318 #undef OnigCodePoint
1319 #endif /* UNIVERSAL_PARSER */
1321 RUBY_SYMBOL_EXPORT_BEGIN
1322 void rb_ruby_parser_free(void *ptr);
1324 #ifdef UNIVERSAL_PARSER
1325 rb_parser_t *rb_ruby_parser_allocate(const rb_parser_config_t *config);
1326 rb_parser_t *rb_ruby_parser_new(const rb_parser_config_t *config);
1327 #endif
1329 RUBY_SYMBOL_EXPORT_END
1331 #endif /* RUBY_RUBYPARSER_H */