Ruby 3.5.0dev (2025-08-27 revision 5ff7b2c582a56fe7d92248adf093fd278a334066)
rubyparser.h (5ff7b2c582a56fe7d92248adf093fd278a334066)
1#ifndef RUBY_RUBYPARSER_H
2#define RUBY_RUBYPARSER_H 1
3/*
4 * This is a header file for librubyparser interface
5 */
6
7#include <stdarg.h> /* for va_list */
8#include <assert.h>
9
10#ifdef UNIVERSAL_PARSER
11
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
18
19#else
20
21#include "ruby/encoding.h"
22
23#endif
24
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
36
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
48
49/*
50 * Parser String
51 */
52enum rb_parser_string_coderange_type {
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
58};
59
60typedef 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;
68
69enum rb_parser_shareability {
70 rb_parser_shareable_none,
71 rb_parser_shareable_literal,
72 rb_parser_shareable_copy,
73 rb_parser_shareable_everything,
74};
75
76typedef void* rb_parser_input_data;
77
78/*
79 * AST Node
80 */
81enum 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
195};
196
197typedef struct rb_ast_id_table {
198 int size;
199 ID ids[FLEX_ARY_LEN];
201
203 int lineno;
204 int column;
206
211#define YYLTYPE rb_code_location_t
212#define YYLTYPE_IS_DECLARED 1
213
214typedef struct rb_parser_ast_token {
215 int id;
216 const char *type_name;
220
221/*
222 * Array-like object for parser
223 */
224typedef void* rb_parser_ary_data;
225
226enum rb_parser_ary_data_type {
227 PARSER_ARY_DATA_AST_TOKEN = 1,
228 PARSER_ARY_DATA_SCRIPT_LINE,
229 PARSER_ARY_DATA_NODE
230};
231
232typedef 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
238
239/* Header part of AST Node */
240typedef struct RNode {
241 VALUE flags;
242 rb_code_location_t nd_loc;
243 int node_id;
244} NODE;
245
246typedef struct RNode_SCOPE {
247 NODE node;
248
249 rb_ast_id_table_t *nd_tbl;
250 struct RNode *nd_body;
251 struct RNode_ARGS *nd_args;
253
254typedef struct RNode_BLOCK {
255 NODE node;
256
257 struct RNode *nd_head;
258 struct RNode *nd_end;
259 struct RNode *nd_next;
261
262typedef struct RNode_IF {
263 NODE node;
264
265 struct RNode *nd_cond;
266 struct RNode *nd_body;
267 struct RNode *nd_else;
268 rb_code_location_t if_keyword_loc;
269 rb_code_location_t then_keyword_loc;
270 rb_code_location_t end_keyword_loc;
272
273typedef struct RNode_UNLESS {
274 NODE node;
275
276 struct RNode *nd_cond;
277 struct RNode *nd_body;
278 struct RNode *nd_else;
279 rb_code_location_t keyword_loc;
280 rb_code_location_t then_keyword_loc;
281 rb_code_location_t end_keyword_loc;
283
284typedef struct RNode_CASE {
285 NODE node;
286
287 struct RNode *nd_head;
288 struct RNode *nd_body;
289 rb_code_location_t case_keyword_loc;
290 rb_code_location_t end_keyword_loc;
292
293typedef struct RNode_CASE2 {
294 NODE node;
295
296 struct RNode *nd_head;
297 struct RNode *nd_body;
298 rb_code_location_t case_keyword_loc;
299 rb_code_location_t end_keyword_loc;
301
302typedef struct RNode_CASE3 {
303 NODE node;
304
305 struct RNode *nd_head;
306 struct RNode *nd_body;
307 rb_code_location_t case_keyword_loc;
308 rb_code_location_t end_keyword_loc;
310
311typedef struct RNode_WHEN {
312 NODE node;
313
314 struct RNode *nd_head;
315 struct RNode *nd_body;
316 struct RNode *nd_next;
317 rb_code_location_t keyword_loc;
318 rb_code_location_t then_keyword_loc;
320
321typedef struct RNode_IN {
322 NODE node;
323
324 struct RNode *nd_head;
325 struct RNode *nd_body;
326 struct RNode *nd_next;
327 rb_code_location_t in_keyword_loc;
328 rb_code_location_t then_keyword_loc;
329 rb_code_location_t operator_loc;
331
332typedef struct RNode_LOOP {
333 NODE node;
334
335 struct RNode *nd_cond;
336 struct RNode *nd_body;
337 long nd_state;
338 rb_code_location_t keyword_loc;
339 rb_code_location_t closing_loc;
341
342typedef struct RNode_ITER {
343 NODE node;
344
345 struct RNode *nd_body;
346 struct RNode *nd_iter;
348
349typedef struct RNode_FOR {
350 NODE node;
351
352 struct RNode *nd_body;
353 struct RNode *nd_iter;
354 rb_code_location_t for_keyword_loc;
355 rb_code_location_t in_keyword_loc;
356 rb_code_location_t do_keyword_loc;
357 rb_code_location_t end_keyword_loc;
359
360typedef struct RNode_FOR_MASGN {
361 NODE node;
362
363 struct RNode *nd_var;
365
366typedef struct RNode_EXITS {
367 NODE node;
368
369 struct RNode *nd_chain;
370 struct RNode *nd_stts;
371 rb_code_location_t keyword_loc;
373
374typedef struct RNode_RETRY {
375 NODE node;
377
378typedef struct RNode_BEGIN {
379 NODE node;
380
381 struct RNode *nd_body;
383
384typedef struct RNode_RESCUE {
385 NODE node;
386
387 struct RNode *nd_head;
388 struct RNode *nd_resq;
389 struct RNode *nd_else;
391
392typedef struct RNode_RESBODY {
393 NODE node;
394
395 struct RNode *nd_args;
396 struct RNode *nd_exc_var;
397 struct RNode *nd_body;
398 struct RNode *nd_next;
400
401typedef struct RNode_ENSURE {
402 NODE node;
403
404 struct RNode *nd_head;
405 struct RNode *nd_ensr;
407
408typedef struct {
409 NODE node;
410
411 struct RNode *nd_1st;
412 struct RNode *nd_2nd;
413 rb_code_location_t operator_loc;
415
416typedef struct RNode_MASGN {
417 NODE node;
418
419 struct RNode *nd_head;
420 struct RNode *nd_value;
421 struct RNode *nd_args;
423
424typedef struct RNode_LASGN {
425 NODE node;
426
427 ID nd_vid;
428 struct RNode *nd_value;
430
431typedef struct RNode_DASGN {
432 NODE node;
433
434 ID nd_vid;
435 struct RNode *nd_value;
437
438typedef struct RNode_GASGN {
439 NODE node;
440
441 ID nd_vid;
442 struct RNode *nd_value;
444
445typedef struct RNode_IASGN {
446 NODE node;
447
448 ID nd_vid;
449 struct RNode *nd_value;
451
452typedef struct RNode_CDECL {
453 NODE node;
454
455 ID nd_vid;
456 struct RNode *nd_value;
457 struct RNode *nd_else;
458 enum rb_parser_shareability shareability;
460
461typedef struct RNode_CVASGN {
462 NODE node;
463
464 ID nd_vid;
465 struct RNode *nd_value;
467
468typedef struct RNode_OP_ASGN1 {
469 NODE node;
470
471 struct RNode *nd_recv;
472 ID nd_mid;
473 struct RNode *nd_index;
474 struct RNode *nd_rvalue;
475 rb_code_location_t call_operator_loc;
476 rb_code_location_t opening_loc;
477 rb_code_location_t closing_loc;
478 rb_code_location_t binary_operator_loc;
480
481typedef struct RNode_OP_ASGN2 {
482 NODE node;
483
484 struct RNode *nd_recv;
485 struct RNode *nd_value;
486 ID nd_vid;
487 ID nd_mid;
488 bool nd_aid;
489 rb_code_location_t call_operator_loc;
490 rb_code_location_t message_loc;
491 rb_code_location_t binary_operator_loc;
493
494typedef struct RNode_OP_ASGN_AND {
495 NODE node;
496
497 struct RNode *nd_head;
498 struct RNode *nd_value;
500
501typedef struct RNode_OP_ASGN_OR {
502 NODE node;
503
504 struct RNode *nd_head;
505 struct RNode *nd_value;
507
508typedef struct RNode_OP_CDECL {
509 NODE node;
510
511 struct RNode *nd_head;
512 struct RNode *nd_value;
513 ID nd_aid;
514 enum rb_parser_shareability shareability;
516
517typedef struct RNode_CALL {
518 NODE node;
519
520 struct RNode *nd_recv;
521 ID nd_mid;
522 struct RNode *nd_args;
524
525typedef struct RNode_OPCALL {
526 NODE node;
527
528 struct RNode *nd_recv;
529 ID nd_mid;
530 struct RNode *nd_args;
532
533typedef struct RNode_FCALL {
534 NODE node;
535
536 ID nd_mid;
537 struct RNode *nd_args;
539
540typedef struct RNode_VCALL {
541 NODE node;
542
543 ID nd_mid;
545
546typedef struct RNode_QCALL {
547 NODE node;
548
549 struct RNode *nd_recv;
550 ID nd_mid;
551 struct RNode *nd_args;
553
554typedef struct RNode_SUPER {
555 NODE node;
556
557 struct RNode *nd_args;
558 rb_code_location_t keyword_loc;
559 rb_code_location_t lparen_loc;
560 rb_code_location_t rparen_loc;
562
563typedef struct RNode_ZSUPER {
564 NODE node;
566
567/*
568
569 Structure of LIST:
570
571 LIST +--> LIST
572 * head --> element | * head
573 * alen (length of list) | * nd_end (point to the last LIST)
574 * next -----------------+ * next
575
576*/
577typedef struct RNode_LIST {
578 NODE node;
579
580 struct RNode *nd_head; /* element */
581 union {
582 long nd_alen;
583 struct RNode *nd_end; /* Second list node has this structure */
584 } as;
585 struct RNode *nd_next; /* next list node */
587
588typedef struct RNode_ZLIST {
589 NODE node;
591
592typedef struct RNode_HASH {
593 NODE node;
594
595 struct RNode *nd_head;
596 long nd_brace;
598
599typedef struct RNode_RETURN {
600 NODE node;
601
602 struct RNode *nd_stts;
603 rb_code_location_t keyword_loc;
605
606typedef struct RNode_YIELD {
607 NODE node;
608
609 struct RNode *nd_head;
610 rb_code_location_t keyword_loc;
611 rb_code_location_t lparen_loc;
612 rb_code_location_t rparen_loc;
614
615typedef struct RNode_LVAR {
616 NODE node;
617
618 ID nd_vid;
620
621typedef struct RNode_DVAR {
622 NODE node;
623
624 ID nd_vid;
626
627typedef struct RNode_GVAR {
628 NODE node;
629
630 ID nd_vid;
632
633typedef struct RNode_IVAR {
634 NODE node;
635
636 ID nd_vid;
638
639typedef struct RNode_CONST {
640 NODE node;
641
642 ID nd_vid;
644
645typedef struct RNode_CVAR {
646 NODE node;
647
648 ID nd_vid;
650
651typedef struct RNode_NTH_REF {
652 NODE node;
653
654 long nd_nth;
656
657typedef struct RNode_BACK_REF {
658 NODE node;
659
660 long nd_nth;
662
663typedef struct RNode_MATCH2 {
664 NODE node;
665
666 struct RNode *nd_recv;
667 struct RNode *nd_value;
668 struct RNode *nd_args;
670
671typedef struct RNode_MATCH3 {
672 NODE node;
673
674 struct RNode *nd_recv;
675 struct RNode *nd_value;
677
678typedef struct RNode_INTEGER {
679 NODE node;
680
681 char *val;
682 int minus;
683 int base;
685
686typedef struct RNode_FLOAT {
687 NODE node;
688
689 char *val;
690 int minus;
692
693typedef struct RNode_RATIONAL {
694 NODE node;
695
696 char *val;
697 int minus;
698 int base;
699 int seen_point;
701
702enum rb_numeric_type {
703 integer_literal,
704 float_literal,
705 rational_literal
706};
707
708typedef struct RNode_IMAGINARY {
709 NODE node;
710
711 char *val;
712 int minus;
713 int base;
714 int seen_point;
715 enum rb_numeric_type type;
717
718typedef struct RNode_STR {
719 NODE node;
720
721 struct rb_parser_string *string;
723
724/* NODE_DSTR, NODE_DXSTR, NODE_DREGX, NODE_DSYM */
725typedef struct RNode_DSTR {
726 NODE node;
727
728 struct rb_parser_string *string;
729 union {
730 long nd_alen;
731 long nd_cflag;
732 struct RNode *nd_end; /* Second dstr node has this structure. See also RNode_LIST */
733 } as;
734 struct RNode_LIST *nd_next;
736
738
740
741typedef struct RNode_EVSTR {
742 NODE node;
743
744 struct RNode *nd_body;
745 rb_code_location_t opening_loc;
746 rb_code_location_t closing_loc;
748
749typedef struct RNode_REGX { /* also RNode_MATCH */
750 NODE node;
751
752 struct rb_parser_string *string;
753 int options;
754 rb_code_location_t opening_loc;
755 rb_code_location_t content_loc;
756 rb_code_location_t closing_loc;
758
760
761typedef struct RNode_ONCE {
762 NODE node;
763
764 struct RNode *nd_body;
766
768 NODE *pre_init;
769 NODE *post_init;
770
771 int pre_args_num; /* count of mandatory pre-arguments */
772 int post_args_num; /* count of mandatory post-arguments */
773
774 ID first_post_arg;
775
776 ID rest_arg;
777 ID block_arg;
778
779 struct RNode_KW_ARG *kw_args;
780 NODE *kw_rest_arg;
781
782 struct RNode_OPT_ARG *opt_args;
783 unsigned int no_kwarg: 1;
784 unsigned int ruby2_keywords: 1;
785 unsigned int forwarding: 1;
786};
787
788typedef struct RNode_ARGS {
789 NODE node;
790
791 struct rb_args_info nd_ainfo;
793
794typedef struct RNode_ARGS_AUX {
795 NODE node;
796
797 ID nd_pid;
798 int nd_plen;
799 struct RNode *nd_next;
801
802typedef struct RNode_OPT_ARG {
803 NODE node;
804
805 struct RNode *nd_body;
806 struct RNode_OPT_ARG *nd_next;
808
809typedef struct RNode_KW_ARG {
810 NODE node;
811
812 struct RNode *nd_body;
813 struct RNode_KW_ARG *nd_next;
815
816typedef struct RNode_POSTARG {
817 NODE node;
818
819 struct RNode *nd_1st;
820 struct RNode *nd_2nd;
822
823typedef struct RNode_ARGSCAT {
824 NODE node;
825
826 struct RNode *nd_head;
827 struct RNode *nd_body;
829
830typedef struct RNode_ARGSPUSH {
831 NODE node;
832
833 struct RNode *nd_head;
834 struct RNode *nd_body;
836
837typedef struct RNode_SPLAT {
838 NODE node;
839
840 struct RNode *nd_head;
841 rb_code_location_t operator_loc;
843
844typedef struct RNode_BLOCK_PASS {
845 NODE node;
846
847 struct RNode *nd_head;
848 struct RNode *nd_body;
849 unsigned int forwarding: 1;
850 rb_code_location_t operator_loc;
852
853typedef struct RNode_DEFN {
854 NODE node;
855
856 ID nd_mid;
857 struct RNode *nd_defn;
859
860typedef struct RNode_DEFS {
861 NODE node;
862
863 struct RNode *nd_recv;
864 ID nd_mid;
865 struct RNode *nd_defn;
867
868typedef struct RNode_ALIAS {
869 NODE node;
870
871 struct RNode *nd_1st;
872 struct RNode *nd_2nd;
873 rb_code_location_t keyword_loc;
875
876typedef struct RNode_VALIAS {
877 NODE node;
878
879 ID nd_alias;
880 ID nd_orig;
881 rb_code_location_t keyword_loc;
883
884typedef struct RNode_UNDEF {
885 NODE node;
886
887 rb_parser_ary_t *nd_undefs;
888 rb_code_location_t keyword_loc;
890
891typedef struct RNode_CLASS {
892 NODE node;
893
894 struct RNode *nd_cpath;
895 struct RNode *nd_body;
896 struct RNode *nd_super;
897 rb_code_location_t class_keyword_loc;
898 rb_code_location_t inheritance_operator_loc;
899 rb_code_location_t end_keyword_loc;
901
902typedef struct RNode_MODULE {
903 NODE node;
904
905 struct RNode *nd_cpath;
906 struct RNode *nd_body;
907 rb_code_location_t module_keyword_loc;
908 rb_code_location_t end_keyword_loc;
910
911typedef struct RNode_SCLASS {
912 NODE node;
913
914 struct RNode *nd_recv;
915 struct RNode *nd_body;
917
918typedef struct RNode_COLON2 {
919 NODE node;
920
921 struct RNode *nd_head;
922 ID nd_mid;
923 rb_code_location_t delimiter_loc;
924 rb_code_location_t name_loc;
926
927typedef struct RNode_COLON3 {
928 NODE node;
929
930 ID nd_mid;
931 rb_code_location_t delimiter_loc;
932 rb_code_location_t name_loc;
934
935/* NODE_DOT2, NODE_DOT3, NODE_FLIP2, NODE_FLIP3 */
936typedef struct RNode_DOTS {
937 NODE node;
938
939 struct RNode *nd_beg;
940 struct RNode *nd_end;
941 rb_code_location_t operator_loc;
943
944typedef struct RNode_SELF {
945 NODE node;
946
947 long nd_state; /* Default 1. See NEW_SELF. */
949
950typedef struct RNode_NIL {
951 NODE node;
953
954typedef struct RNode_TRUE {
955 NODE node;
957
958typedef struct RNode_FALSE {
959 NODE node;
961
962typedef struct RNode_ERRINFO {
963 NODE node;
965
966typedef struct RNode_DEFINED {
967 NODE node;
968
969 struct RNode *nd_head;
970 rb_code_location_t keyword_loc;
972
973typedef struct RNode_POSTEXE {
974 NODE node;
975
976 struct RNode *nd_body;
977 rb_code_location_t keyword_loc;
978 rb_code_location_t opening_loc;
979 rb_code_location_t closing_loc;
981
982typedef struct RNode_SYM {
983 NODE node;
984
985 struct rb_parser_string *string;
987
989
990typedef struct RNode_ATTRASGN {
991 NODE node;
992
993 struct RNode *nd_recv;
994 ID nd_mid;
995 struct RNode *nd_args;
997
998typedef struct RNode_LAMBDA {
999 NODE node;
1000
1001 struct RNode *nd_body;
1002 rb_code_location_t operator_loc;
1003 rb_code_location_t opening_loc;
1004 rb_code_location_t closing_loc;
1006
1007typedef struct RNode_ARYPTN {
1008 NODE node;
1009
1010 struct RNode *nd_pconst;
1011 NODE *pre_args;
1012 NODE *rest_arg;
1013 NODE *post_args;
1015
1016typedef struct RNode_HSHPTN {
1017 NODE node;
1018
1019 struct RNode *nd_pconst;
1020 struct RNode *nd_pkwargs;
1021 struct RNode *nd_pkwrestarg;
1023
1024typedef struct RNode_FNDPTN {
1025 NODE node;
1026
1027 struct RNode *nd_pconst;
1028 NODE *pre_rest_arg;
1029 NODE *args;
1030 NODE *post_rest_arg;
1032
1033typedef struct RNode_LINE {
1034 NODE node;
1036
1037typedef struct RNode_FILE {
1038 NODE node;
1039
1040 struct rb_parser_string *path;
1042
1043typedef struct RNode_ENCODING {
1044 NODE node;
1045 rb_encoding *enc;
1047
1048typedef struct RNode_ERROR {
1049 NODE node;
1051
1052#define RNODE(obj) ((NODE *)(obj))
1053
1054#define RNODE_SCOPE(node) ((rb_node_scope_t *)(node))
1055#define RNODE_BLOCK(node) ((rb_node_block_t *)(node))
1056#define RNODE_IF(node) ((rb_node_if_t *)(node))
1057#define RNODE_UNLESS(node) ((rb_node_unless_t *)(node))
1058#define RNODE_CASE(node) ((rb_node_case_t *)(node))
1059#define RNODE_CASE2(node) ((rb_node_case2_t *)(node))
1060#define RNODE_CASE3(node) ((rb_node_case3_t *)(node))
1061#define RNODE_WHEN(node) ((rb_node_when_t *)(node))
1062#define RNODE_IN(node) ((rb_node_in_t *)(node))
1063#define RNODE_WHILE(node) ((rb_node_while_t *)(node))
1064#define RNODE_UNTIL(node) ((rb_node_until_t *)(node))
1065#define RNODE_ITER(node) ((rb_node_iter_t *)(node))
1066#define RNODE_FOR(node) ((rb_node_for_t *)(node))
1067#define RNODE_FOR_MASGN(node) ((rb_node_for_masgn_t *)(node))
1068#define RNODE_BREAK(node) ((rb_node_break_t *)(node))
1069#define RNODE_NEXT(node) ((rb_node_next_t *)(node))
1070#define RNODE_REDO(node) ((rb_node_redo_t *)(node))
1071#define RNODE_RETRY(node) ((rb_node_retry_t *)(node))
1072#define RNODE_BEGIN(node) ((rb_node_begin_t *)(node))
1073#define RNODE_RESCUE(node) ((rb_node_rescue_t *)(node))
1074#define RNODE_RESBODY(node) ((rb_node_resbody_t *)(node))
1075#define RNODE_ENSURE(node) ((rb_node_ensure_t *)(node))
1076#define RNODE_AND(node) ((rb_node_and_t *)(node))
1077#define RNODE_OR(node) ((rb_node_or_t *)(node))
1078#define RNODE_MASGN(node) ((rb_node_masgn_t *)(node))
1079#define RNODE_LASGN(node) ((rb_node_lasgn_t *)(node))
1080#define RNODE_DASGN(node) ((rb_node_dasgn_t *)(node))
1081#define RNODE_GASGN(node) ((rb_node_gasgn_t *)(node))
1082#define RNODE_IASGN(node) ((rb_node_iasgn_t *)(node))
1083#define RNODE_CDECL(node) ((rb_node_cdecl_t *)(node))
1084#define RNODE_CVASGN(node) ((rb_node_cvasgn_t *)(node))
1085#define RNODE_OP_ASGN1(node) ((rb_node_op_asgn1_t *)(node))
1086#define RNODE_OP_ASGN2(node) ((rb_node_op_asgn2_t *)(node))
1087#define RNODE_OP_ASGN_AND(node) ((rb_node_op_asgn_and_t *)(node))
1088#define RNODE_OP_ASGN_OR(node) ((rb_node_op_asgn_or_t *)(node))
1089#define RNODE_OP_CDECL(node) ((rb_node_op_cdecl_t *)(node))
1090#define RNODE_CALL(node) ((rb_node_call_t *)(node))
1091#define RNODE_OPCALL(node) ((rb_node_opcall_t *)(node))
1092#define RNODE_FCALL(node) ((rb_node_fcall_t *)(node))
1093#define RNODE_VCALL(node) ((rb_node_vcall_t *)(node))
1094#define RNODE_QCALL(node) ((rb_node_qcall_t *)(node))
1095#define RNODE_SUPER(node) ((rb_node_super_t *)(node))
1096#define RNODE_ZSUPER(node) ((rb_node_zsuper_t *)(node))
1097#define RNODE_LIST(node) ((rb_node_list_t *)(node))
1098#define RNODE_ZLIST(node) ((rb_node_zlist_t *)(node))
1099#define RNODE_HASH(node) ((rb_node_hash_t *)(node))
1100#define RNODE_RETURN(node) ((rb_node_return_t *)(node))
1101#define RNODE_YIELD(node) ((rb_node_yield_t *)(node))
1102#define RNODE_LVAR(node) ((rb_node_lvar_t *)(node))
1103#define RNODE_DVAR(node) ((rb_node_dvar_t *)(node))
1104#define RNODE_GVAR(node) ((rb_node_gvar_t *)(node))
1105#define RNODE_IVAR(node) ((rb_node_ivar_t *)(node))
1106#define RNODE_CONST(node) ((rb_node_const_t *)(node))
1107#define RNODE_CVAR(node) ((rb_node_cvar_t *)(node))
1108#define RNODE_NTH_REF(node) ((rb_node_nth_ref_t *)(node))
1109#define RNODE_BACK_REF(node) ((rb_node_back_ref_t *)(node))
1110#define RNODE_MATCH(node) ((rb_node_match_t *)(node))
1111#define RNODE_MATCH2(node) ((rb_node_match2_t *)(node))
1112#define RNODE_MATCH3(node) ((rb_node_match3_t *)(node))
1113#define RNODE_INTEGER(node) ((rb_node_integer_t *)(node))
1114#define RNODE_FLOAT(node) ((rb_node_float_t *)(node))
1115#define RNODE_RATIONAL(node) ((rb_node_rational_t *)(node))
1116#define RNODE_IMAGINARY(node) ((rb_node_imaginary_t *)(node))
1117#define RNODE_STR(node) ((rb_node_str_t *)(node))
1118#define RNODE_DSTR(node) ((rb_node_dstr_t *)(node))
1119#define RNODE_XSTR(node) ((rb_node_xstr_t *)(node))
1120#define RNODE_DXSTR(node) ((rb_node_dxstr_t *)(node))
1121#define RNODE_EVSTR(node) ((rb_node_evstr_t *)(node))
1122#define RNODE_REGX(node) ((rb_node_regx_t *)(node))
1123#define RNODE_DREGX(node) ((rb_node_dregx_t *)(node))
1124#define RNODE_ONCE(node) ((rb_node_once_t *)(node))
1125#define RNODE_ARGS(node) ((rb_node_args_t *)(node))
1126#define RNODE_ARGS_AUX(node) ((rb_node_args_aux_t *)(node))
1127#define RNODE_OPT_ARG(node) ((rb_node_opt_arg_t *)(node))
1128#define RNODE_KW_ARG(node) ((rb_node_kw_arg_t *)(node))
1129#define RNODE_POSTARG(node) ((rb_node_postarg_t *)(node))
1130#define RNODE_ARGSCAT(node) ((rb_node_argscat_t *)(node))
1131#define RNODE_ARGSPUSH(node) ((rb_node_argspush_t *)(node))
1132#define RNODE_SPLAT(node) ((rb_node_splat_t *)(node))
1133#define RNODE_BLOCK_PASS(node) ((rb_node_block_pass_t *)(node))
1134#define RNODE_DEFN(node) ((rb_node_defn_t *)(node))
1135#define RNODE_DEFS(node) ((rb_node_defs_t *)(node))
1136#define RNODE_ALIAS(node) ((rb_node_alias_t *)(node))
1137#define RNODE_VALIAS(node) ((rb_node_valias_t *)(node))
1138#define RNODE_UNDEF(node) ((rb_node_undef_t *)(node))
1139#define RNODE_CLASS(node) ((rb_node_class_t *)(node))
1140#define RNODE_MODULE(node) ((rb_node_module_t *)(node))
1141#define RNODE_SCLASS(node) ((rb_node_sclass_t *)(node))
1142#define RNODE_COLON2(node) ((rb_node_colon2_t *)(node))
1143#define RNODE_COLON3(node) ((rb_node_colon3_t *)(node))
1144#define RNODE_DOT2(node) ((rb_node_dot2_t *)(node))
1145#define RNODE_DOT3(node) ((rb_node_dot3_t *)(node))
1146#define RNODE_FLIP2(node) ((rb_node_flip2_t *)(node))
1147#define RNODE_FLIP3(node) ((rb_node_flip3_t *)(node))
1148#define RNODE_SELF(node) ((rb_node_self_t *)(node))
1149#define RNODE_NIL(node) ((rb_node_nil_t *)(node))
1150#define RNODE_TRUE(node) ((rb_node_true_t *)(node))
1151#define RNODE_FALSE(node) ((rb_node_false_t *)(node))
1152#define RNODE_ERRINFO(node) ((rb_node_errinfo_t *)(node))
1153#define RNODE_DEFINED(node) ((rb_node_defined_t *)(node))
1154#define RNODE_POSTEXE(node) ((rb_node_postexe_t *)(node))
1155#define RNODE_SYM(node) ((rb_node_sym_t *)(node))
1156#define RNODE_DSYM(node) ((rb_node_dsym_t *)(node))
1157#define RNODE_ATTRASGN(node) ((rb_node_attrasgn_t *)(node))
1158#define RNODE_LAMBDA(node) ((rb_node_lambda_t *)(node))
1159#define RNODE_ARYPTN(node) ((rb_node_aryptn_t *)(node))
1160#define RNODE_HSHPTN(node) ((rb_node_hshptn_t *)(node))
1161#define RNODE_FNDPTN(node) ((rb_node_fndptn_t *)(node))
1162#define RNODE_LINE(node) ((rb_node_line_t *)(node))
1163#define RNODE_FILE(node) ((rb_node_file_t *)(node))
1164#define RNODE_ENCODING(node) ((rb_node_encoding_t *)(node))
1165
1166/* FL : 0..4: T_TYPES, 5: KEEP_WB, 6: PROMOTED, 7: FINALIZE, 8..10: UNUSED, 11: FREEZE */
1167/* NODE_FL: 0..4: UNUSED, 5: UNUSED, 6: UNUSED, 7: NODE_FL_NEWLINE,
1168 * 8..14: nd_type,
1169 * 15..: nd_line
1170 */
1171#define NODE_FL_NEWLINE (((VALUE)1)<<7)
1172
1173#define NODE_TYPESHIFT 8
1174#define NODE_TYPEMASK (((VALUE)0x7f)<<NODE_TYPESHIFT)
1175
1176#define nd_fl_newline(n) ((n)->flags & NODE_FL_NEWLINE)
1177#define nd_set_fl_newline(n) ((n)->flags |= NODE_FL_NEWLINE)
1178#define nd_unset_fl_newline(n) ((n)->flags &= ~NODE_FL_NEWLINE)
1179
1180#define nd_type(n) ((int) ((RNODE(n)->flags & NODE_TYPEMASK)>>NODE_TYPESHIFT))
1181#define nd_set_type(n,t) \
1182 rb_node_set_type(n, t)
1183#define nd_init_type(n,t) \
1184 (n)->flags=(((n)->flags&~NODE_TYPEMASK)|((((unsigned long)(t))<<NODE_TYPESHIFT)&NODE_TYPEMASK))
1185
1186typedef struct node_buffer_struct node_buffer_t;
1187
1188#ifdef UNIVERSAL_PARSER
1189typedef struct rb_parser_config_struct rb_parser_config_t;
1190#endif
1191
1192typedef struct rb_ast_body_struct {
1193 const NODE *root;
1194 rb_parser_ary_t *script_lines;
1195 int line_count;
1196 signed int frozen_string_literal:2; /* -1: not specified, 0: false, 1: true */
1197 signed int coverage_enabled:2; /* -1: not specified, 0: false, 1: true */
1199typedef struct rb_ast_struct {
1200 node_buffer_t *node_buffer;
1201 rb_ast_body_t body;
1202#ifdef UNIVERSAL_PARSER
1203 const rb_parser_config_t *config;
1204#endif
1205} rb_ast_t;
1206
1207
1208
1209/*
1210 * Parser Interface
1211 */
1212
1213
1214typedef struct parser_params rb_parser_t;
1215#ifndef INTERNAL_IMEMO_H
1217#endif
1218
1219typedef NODE *(*rb_parser_assignable_func)(struct parser_params *p, ID id, NODE *val, const rb_code_location_t *loc);
1220
1221#ifdef UNIVERSAL_PARSER
1222typedef struct rb_parser_config_struct {
1223 /* Memory */
1224 void *(*malloc)(size_t size);
1225 void *(*calloc)(size_t number, size_t size);
1226 void *(*realloc)(void *ptr, size_t newsiz);
1227 void (*free)(void *ptr);
1228 void *(*alloc_n)(size_t nelems, size_t elemsiz);
1229 void *(*alloc)(size_t elemsiz);
1230 void *(*realloc_n)(void *ptr, size_t newelems, size_t newsiz);
1231 void *(*zalloc)(size_t elemsiz);
1232 void *(*rb_memmove)(void *dest, const void *src, size_t t, size_t n);
1233 void *(*nonempty_memcpy)(void *dest, const void *src, size_t t, size_t n);
1234 void *(*xmalloc_mul_add)(size_t x, size_t y, size_t z);
1235
1236 // VALUE rb_suppress_tracing(VALUE (*func)(VALUE), VALUE arg);
1237 VALUE (*compile_callback)(VALUE (*func)(VALUE), VALUE arg);
1238 NODE *(*reg_named_capture_assign)(struct parser_params* p, VALUE regexp, const rb_code_location_t *loc, rb_parser_assignable_func assignable);
1239
1240 /* Variable */
1241 VALUE (*attr_get)(VALUE obj, ID id);
1242
1243 /* Array */
1244 VALUE (*ary_new_from_args)(long n, ...);
1245 VALUE (*ary_unshift)(VALUE ary, VALUE item);
1246
1247 /* Symbol */
1248 ID (*make_temporary_id)(size_t n);
1249 int (*is_local_id)(ID);
1250 int (*is_attrset_id)(ID);
1251 int (*is_global_name_punct)(const int c);
1252 int (*id_type)(ID id);
1253 ID (*id_attrset)(ID);
1254 ID (*intern)(const char *name);
1255 ID (*intern2)(const char *name, long len);
1256 ID (*intern3)(const char *name, long len, rb_encoding *enc);
1257 ID (*intern_str)(VALUE str);
1258 int (*is_notop_id)(ID);
1259 int (*enc_symname_type)(const char *name, long len, rb_encoding *enc, unsigned int allowed_attrset);
1260 const char *(*id2name)(ID id);
1261 VALUE (*id2str)(ID id);
1262 VALUE (*id2sym)(ID x);
1263
1264 /* String */
1265 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1266 VALUE (*str_catf)(VALUE str, const char *format, ...);
1267 VALUE (*str_cat_cstr)(VALUE str, const char *ptr);
1268 VALUE (*str_resize)(VALUE str, long len);
1269 VALUE (*str_new)(const char *ptr, long len);
1270 VALUE (*str_new_cstr)(const char *ptr);
1271 VALUE (*str_to_interned_str)(VALUE);
1272 VALUE (*enc_str_new)(const char *ptr, long len, rb_encoding *enc);
1273 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 0)
1274 VALUE (*str_vcatf)(VALUE str, const char *fmt, va_list ap);
1275 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
1276 VALUE (*rb_sprintf)(const char *format, ...);
1277 char *(*rstring_ptr)(VALUE str);
1278 long (*rstring_len)(VALUE str);
1279
1280 /* Numeric */
1281 VALUE (*int2num)(int v);
1282
1283 /* IO */
1284 int (*stderr_tty_p)(void);
1285 void (*write_error_str)(VALUE mesg);
1286 VALUE (*io_write)(VALUE io, VALUE str);
1287 VALUE (*io_flush)(VALUE io);
1288 VALUE (*io_puts)(int argc, const VALUE *argv, VALUE out);
1289
1290 /* IO (Ractor) */
1291 VALUE (*debug_output_stdout)(void);
1292 VALUE (*debug_output_stderr)(void);
1293
1294 /* Encoding */
1295 int (*is_usascii_enc)(rb_encoding *enc);
1296 int (*enc_isalnum)(OnigCodePoint c, rb_encoding *enc);
1297 int (*enc_precise_mbclen)(const char *p, const char *e, rb_encoding *enc);
1298 int (*mbclen_charfound_p)(int len);
1299 int (*mbclen_charfound_len)(int len);
1300 const char *(*enc_name)(rb_encoding *enc);
1301 char *(*enc_prev_char)(const char *s, const char *p, const char *e, rb_encoding *enc);
1302 rb_encoding* (*enc_get)(VALUE obj);
1303 int (*enc_asciicompat)(rb_encoding *enc);
1304 rb_encoding *(*utf8_encoding)(void);
1305 rb_encoding *(*ascii8bit_encoding)(void);
1306 int (*enc_codelen)(int c, rb_encoding *enc);
1307 int (*enc_mbcput)(unsigned int c, void *buf, rb_encoding *enc);
1308 int (*enc_find_index)(const char *name);
1309 rb_encoding *(*enc_from_index)(int idx);
1310 int (*enc_isspace)(OnigCodePoint c, rb_encoding *enc);
1311 int (*enc_mbminlen)(rb_encoding *enc);
1312 bool (*enc_isascii)(OnigCodePoint c, rb_encoding *enc);
1313 OnigCodePoint (*enc_mbc_to_codepoint)(const char *p, const char *e, rb_encoding *enc);
1314
1315 /* Compile */
1316 // int rb_local_defined(ID id, const rb_iseq_t *iseq);
1317 int (*local_defined)(ID, const void*);
1318 // int rb_dvar_defined(ID id, const rb_iseq_t *iseq);
1319 int (*dvar_defined)(ID, const void*);
1320
1321 /* Error (Exception) */
1322 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 6, 0)
1323 VALUE (*syntax_error_append)(VALUE, VALUE, int, int, rb_encoding*, const char*, va_list);
1324 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
1325 void (*raise)(VALUE exc, const char *fmt, ...);
1326 VALUE (*syntax_error_new)(void);
1327
1328 /* Eval */
1329 VALUE (*errinfo)(void);
1330 void (*set_errinfo)(VALUE err);
1331 VALUE (*make_exception)(int argc, const VALUE *argv);
1332
1333 /* GC */
1334 void (*sized_xfree)(void *x, size_t size);
1335 void *(*sized_realloc_n)(void *ptr, size_t new_count, size_t element_size, size_t old_count);
1336 void (*gc_guard)(VALUE);
1337 void (*gc_mark)(VALUE);
1338
1339 /* Re */
1340 VALUE (*reg_compile)(VALUE str, int options, const char *sourcefile, int sourceline);
1341 VALUE (*reg_check_preprocess)(VALUE str);
1342 int (*memcicmp)(const void *x, const void *y, long len);
1343
1344 /* Error */
1345 void (*compile_warn)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1346 void (*compile_warning)(const char *file, int line, const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(3, 4);
1347 void (*bug)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1348 void (*fatal)(const char *fmt, ...) RUBYPARSER_ATTRIBUTE_FORMAT(1, 2);
1349 VALUE (*verbose)(void);
1350 int *(*errno_ptr)(void);
1351
1352 /* VM */
1353 VALUE (*make_backtrace)(void);
1354
1355 /* Util */
1356 unsigned long (*scan_hex)(const char *start, size_t len, size_t *retlen);
1357 unsigned long (*scan_oct)(const char *start, size_t len, size_t *retlen);
1358 unsigned long (*scan_digits)(const char *str, ssize_t len, int base, size_t *retlen, int *overflow);
1359 double (*strtod)(const char *s00, char **se);
1360
1361 /* Misc */
1362 int (*rtest)(VALUE obj);
1363 int (*nil_p)(VALUE obj);
1364 VALUE qnil;
1365 VALUE qfalse;
1366 VALUE (*eArgError)(void);
1367 int (*long2int)(long);
1368
1369 /* For Ripper */
1370 int enc_coderange_7bit;
1371 int enc_coderange_unknown;
1372 VALUE (*static_id2sym)(ID id);
1373 long (*str_coderange_scan_restartable)(const char *s, const char *e, rb_encoding *enc, int *cr);
1374} rb_parser_config_t;
1375
1376#undef rb_encoding
1377#undef OnigCodePoint
1378#endif /* UNIVERSAL_PARSER */
1379
1380RUBY_SYMBOL_EXPORT_BEGIN
1381void rb_ruby_parser_free(void *ptr);
1382
1383#ifdef UNIVERSAL_PARSER
1384rb_parser_t *rb_ruby_parser_allocate(const rb_parser_config_t *config);
1385rb_parser_t *rb_ruby_parser_new(const rb_parser_config_t *config);
1386#endif
1387
1388RUBY_SYMBOL_EXPORT_END
1389
1390#endif /* RUBY_RUBYPARSER_H */
#define RBIMPL_ATTR_FORMAT(x, y, z)
Wraps (or simulates) __attribute__((format))
Definition format.h:29
#define scan_hex(s, l, e)
Old name of ruby_scan_hex.
Definition util.h:108
#define scan_oct(s, l, e)
Old name of ruby_scan_oct.
Definition util.h:85
Encoding relates APIs.
int len
Length of the buffer.
Definition io.h:8
#define strtod(s, e)
Just another name of ruby_strtod.
Definition util.h:223
Defines old _.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40