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