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