2 Copyright (C) 2002, 2003, 2004, 2007, 2008, 2010
3 Free Software Foundation, Inc.
4 Contributed by Sebastian Pop <s.pop@laposte.net>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
24 #include "coretypes.h"
26 #include "tree-pretty-print.h"
28 #define TB_OUT_FILE stdout
29 #define TB_IN_FILE stdin
30 #define TB_NIY fprintf (TB_OUT_FILE, "Sorry this command is not yet implemented.\n")
31 #define TB_WF fprintf (TB_OUT_FILE, "Warning, this command failed.\n")
33 /* Structures for handling Tree Browser's commands. */
34 #define DEFTBCODE(COMMAND, STRING, HELP) COMMAND,
36 #include "tree-browser.def"
40 typedef enum TB_Comm_code TB_CODE;
44 const char *comm_text;
49 #define DEFTBCODE(code, str, help) { help, str, sizeof(str) - 1, code },
50 static const struct tb_command tb_commands[] =
52 #include "tree-browser.def"
56 #define TB_COMMAND_LEN(N) (tb_commands[N].comm_len)
57 #define TB_COMMAND_TEXT(N) (tb_commands[N].comm_text)
58 #define TB_COMMAND_CODE(N) (tb_commands[N].comm_code)
59 #define TB_COMMAND_HELP(N) (tb_commands[N].help_msg)
62 /* Next structure is for parsing TREE_CODEs. */
65 const char *code_string;
66 size_t code_string_len;
69 #define DEFTREECODE(SYM, STRING, TYPE, NARGS) { SYM, STRING, sizeof (STRING) - 1 },
70 #define END_OF_BASE_TREE_CODES \
71 { LAST_AND_UNUSED_TREE_CODE, "@dummy", sizeof ("@dummy") - 1 },
72 static const struct tb_tree_code tb_tree_codes[] =
74 #include "all-tree.def"
77 #undef END_OF_BASE_TREE_CODES
79 #define TB_TREE_CODE(N) (tb_tree_codes[N].code)
80 #define TB_TREE_CODE_TEXT(N) (tb_tree_codes[N].code_string)
81 #define TB_TREE_CODE_LEN(N) (tb_tree_codes[N].code_string_len)
84 /* Function declarations. */
86 static long TB_getline (char **, long *, FILE *);
87 static TB_CODE TB_get_command (char *);
88 static enum tree_code TB_get_tree_code (char *);
89 static tree find_node_with_code (tree *, int *, void *);
90 static tree store_child_info (tree *, int *, void *);
91 static void TB_update_up (tree);
92 static tree TB_current_chain_node (tree);
93 static tree TB_prev_expr (tree);
94 static tree TB_next_expr (tree);
95 static tree TB_up_expr (tree);
96 static tree TB_first_in_bind (tree);
97 static tree TB_last_in_bind (tree);
98 static int TB_parent_eq (const void *, const void *);
99 static tree TB_history_prev (void);
101 /* FIXME: To be declared in a .h file. */
102 void browse_tree (tree);
104 /* Static variables. */
105 static htab_t TB_up_ht;
106 static VEC(tree,gc) *TB_history_stack;
107 static int TB_verbose = 1;
110 /* Entry point in the Tree Browser. */
113 browse_tree (tree begin)
116 TB_CODE tbc = TB_UNUSED_COMMAND;
121 fprintf (TB_OUT_FILE, "\nTree Browser\n");
123 #define TB_SET_HEAD(N) do { \
124 VEC_safe_push (tree, gc, TB_history_stack, N); \
129 print_generic_expr (TB_OUT_FILE, head, 0); \
130 fprintf (TB_OUT_FILE, "\n"); \
136 /* Store in a hashtable information about previous and upper statements. */
138 TB_up_ht = htab_create (1023, htab_hash_pointer, &TB_parent_eq, NULL);
144 fprintf (TB_OUT_FILE, "TB> ");
145 rd = TB_getline (&input, &input_size, TB_IN_FILE);
152 /* Get a new command. Otherwise the user just pressed enter, and thus
153 she expects the last command to be reexecuted. */
154 tbc = TB_get_command (input);
163 if (head && (INTEGRAL_TYPE_P (head)
164 || TREE_CODE (head) == REAL_TYPE
165 || TREE_CODE (head) == FIXED_POINT_TYPE))
166 TB_SET_HEAD (TYPE_MAX_VALUE (head));
172 if (head && (INTEGRAL_TYPE_P (head)
173 || TREE_CODE (head) == REAL_TYPE
174 || TREE_CODE (head) == FIXED_POINT_TYPE))
175 TB_SET_HEAD (TYPE_MIN_VALUE (head));
181 if (head && TREE_CODE (head) == TREE_VEC)
183 /* This command takes another argument: the element number:
184 for example "elt 1". */
187 else if (head && TREE_CODE (head) == VECTOR_CST)
189 /* This command takes another argument: the element number:
190 for example "elt 1". */
198 if (head && TREE_CODE (head) == TREE_LIST)
199 TB_SET_HEAD (TREE_VALUE (head));
205 if (head && TREE_CODE (head) == TREE_LIST)
206 TB_SET_HEAD (TREE_PURPOSE (head));
212 if (head && TREE_CODE (head) == COMPLEX_CST)
213 TB_SET_HEAD (TREE_IMAGPART (head));
219 if (head && TREE_CODE (head) == COMPLEX_CST)
220 TB_SET_HEAD (TREE_REALPART (head));
226 if (head && TREE_CODE (head) == BIND_EXPR)
227 TB_SET_HEAD (TREE_OPERAND (head, 2));
233 if (head && TREE_CODE (head) == BLOCK)
234 TB_SET_HEAD (BLOCK_SUBBLOCKS (head));
239 case TB_SUPERCONTEXT:
240 if (head && TREE_CODE (head) == BLOCK)
241 TB_SET_HEAD (BLOCK_SUPERCONTEXT (head));
247 if (head && TREE_CODE (head) == BLOCK)
248 TB_SET_HEAD (BLOCK_VARS (head));
249 else if (head && TREE_CODE (head) == BIND_EXPR)
250 TB_SET_HEAD (TREE_OPERAND (head, 0));
255 case TB_REFERENCE_TO_THIS:
256 if (head && TYPE_P (head))
257 TB_SET_HEAD (TYPE_REFERENCE_TO (head));
262 case TB_POINTER_TO_THIS:
263 if (head && TYPE_P (head))
264 TB_SET_HEAD (TYPE_POINTER_TO (head));
270 if (head && TREE_CODE (head) == OFFSET_TYPE)
271 TB_SET_HEAD (TYPE_OFFSET_BASETYPE (head));
277 if (head && (TREE_CODE (head) == FUNCTION_TYPE
278 || TREE_CODE (head) == METHOD_TYPE))
279 TB_SET_HEAD (TYPE_ARG_TYPES (head));
284 case TB_METHOD_BASE_TYPE:
285 if (head && (TREE_CODE (head) == FUNCTION_TYPE
286 || TREE_CODE (head) == METHOD_TYPE)
287 && TYPE_METHOD_BASETYPE (head))
288 TB_SET_HEAD (TYPE_METHOD_BASETYPE (head));
294 if (head && (TREE_CODE (head) == RECORD_TYPE
295 || TREE_CODE (head) == UNION_TYPE
296 || TREE_CODE (head) == QUAL_UNION_TYPE))
297 TB_SET_HEAD (TYPE_FIELDS (head));
303 if (head && TREE_CODE (head) == ARRAY_TYPE)
304 TB_SET_HEAD (TYPE_DOMAIN (head));
310 if (head && TREE_CODE (head) == ENUMERAL_TYPE)
311 TB_SET_HEAD (TYPE_VALUES (head));
317 if (head && TREE_CODE (head) == PARM_DECL)
318 TB_SET_HEAD (DECL_ARG_TYPE (head));
324 if (head && DECL_P (head))
325 TB_SET_HEAD (DECL_INITIAL (head));
331 if (head && DECL_P (head))
332 TB_SET_HEAD (DECL_RESULT_FLD (head));
338 if (head && DECL_P (head))
339 TB_SET_HEAD (DECL_ARGUMENTS (head));
344 case TB_ABSTRACT_ORIGIN:
345 if (head && DECL_P (head))
346 TB_SET_HEAD (DECL_ABSTRACT_ORIGIN (head));
347 else if (head && TREE_CODE (head) == BLOCK)
348 TB_SET_HEAD (BLOCK_ABSTRACT_ORIGIN (head));
354 if (head && DECL_P (head))
355 TB_SET_HEAD (DECL_ATTRIBUTES (head));
356 else if (head && TYPE_P (head))
357 TB_SET_HEAD (TYPE_ATTRIBUTES (head));
363 if (head && DECL_P (head))
364 TB_SET_HEAD (DECL_CONTEXT (head));
365 else if (head && TYPE_P (head)
366 && TYPE_CONTEXT (head))
367 TB_SET_HEAD (TYPE_CONTEXT (head));
373 if (head && TREE_CODE (head) == FIELD_DECL)
374 TB_SET_HEAD (DECL_FIELD_OFFSET (head));
380 if (head && TREE_CODE (head) == FIELD_DECL)
381 TB_SET_HEAD (DECL_FIELD_BIT_OFFSET (head));
387 if (head && DECL_P (head))
388 TB_SET_HEAD (DECL_SIZE_UNIT (head));
389 else if (head && TYPE_P (head))
390 TB_SET_HEAD (TYPE_SIZE_UNIT (head));
396 if (head && DECL_P (head))
397 TB_SET_HEAD (DECL_SIZE (head));
398 else if (head && TYPE_P (head))
399 TB_SET_HEAD (TYPE_SIZE (head));
405 if (head && TREE_TYPE (head))
406 TB_SET_HEAD (TREE_TYPE (head));
411 case TB_DECL_SAVED_TREE:
412 if (head && TREE_CODE (head) == FUNCTION_DECL
413 && DECL_SAVED_TREE (head))
414 TB_SET_HEAD (DECL_SAVED_TREE (head));
420 if (head && TREE_CODE (head) == BIND_EXPR)
421 TB_SET_HEAD (TREE_OPERAND (head, 1));
427 if (head && EXPR_P (head) && TREE_OPERAND (head, 0))
428 TB_SET_HEAD (TREE_OPERAND (head, 0));
434 if (head && EXPR_P (head) && TREE_OPERAND (head, 1))
435 TB_SET_HEAD (TREE_OPERAND (head, 1));
441 if (head && EXPR_P (head) && TREE_OPERAND (head, 2))
442 TB_SET_HEAD (TREE_OPERAND (head, 2));
448 if (head && EXPR_P (head) && TREE_OPERAND (head, 3))
449 TB_SET_HEAD (TREE_OPERAND (head, 3));
461 case TB_PRETTY_PRINT:
464 print_generic_stmt (TB_OUT_FILE, head, 0);
465 fprintf (TB_OUT_FILE, "\n");
480 arg_text = strchr (input, ' ');
481 if (arg_text == NULL)
483 fprintf (TB_OUT_FILE, "First argument is missing. This isn't a valid search command. \n");
486 code = TB_get_tree_code (arg_text + 1);
488 /* Search in the subtree a node with the given code. */
492 res = walk_tree (&head, find_node_with_code, &code, NULL);
493 if (res == NULL_TREE)
495 fprintf (TB_OUT_FILE, "There's no node with this code (reachable via the walk_tree function from this node).\n");
499 fprintf (TB_OUT_FILE, "Achoo! I got this node in the tree.\n");
506 #define TB_MOVE_HEAD(FCT) do { \
521 TB_MOVE_HEAD (TB_first_in_bind);
525 TB_MOVE_HEAD (TB_last_in_bind);
529 TB_MOVE_HEAD (TB_up_expr);
533 TB_MOVE_HEAD (TB_prev_expr);
537 TB_MOVE_HEAD (TB_next_expr);
541 /* This command is a little bit special, since it deals with history
542 stack. For this reason it should keep the "head = ..." statement
543 and not use TB_MOVE_HEAD. */
547 t = TB_history_prev ();
553 print_generic_expr (TB_OUT_FILE, head, 0);
554 fprintf (TB_OUT_FILE, "\n");
565 /* Don't go further if it's the last node in this chain. */
566 if (head && TREE_CODE (head) == BLOCK)
567 TB_SET_HEAD (BLOCK_CHAIN (head));
568 else if (head && TREE_CHAIN (head))
569 TB_SET_HEAD (TREE_CHAIN (head));
575 /* Go up to the current function declaration. */
576 TB_SET_HEAD (current_function_decl);
577 fprintf (TB_OUT_FILE, "Current function declaration.\n");
581 /* Display a help message. */
584 fprintf (TB_OUT_FILE, "Possible commands are:\n\n");
585 for (i = 0; i < TB_UNUSED_COMMAND; i++)
587 fprintf (TB_OUT_FILE, "%20s - %s\n", TB_COMMAND_TEXT (i), TB_COMMAND_HELP (i));
596 fprintf (TB_OUT_FILE, "Verbose on.\n");
601 fprintf (TB_OUT_FILE, "Verbose off.\n");
607 /* Just exit from this function. */
616 htab_delete (TB_up_ht);
621 /* Search the first node in this BIND_EXPR. */
624 TB_first_in_bind (tree node)
628 if (node == NULL_TREE)
631 while ((t = TB_prev_expr (node)))
637 /* Search the last node in this BIND_EXPR. */
640 TB_last_in_bind (tree node)
644 if (node == NULL_TREE)
647 while ((t = TB_next_expr (node)))
653 /* Search the parent expression for this node. */
656 TB_up_expr (tree node)
659 if (node == NULL_TREE)
662 res = (tree) htab_find (TB_up_ht, node);
666 /* Search the previous expression in this BIND_EXPR. */
669 TB_prev_expr (tree node)
671 node = TB_current_chain_node (node);
673 if (node == NULL_TREE)
676 node = TB_up_expr (node);
677 if (node && TREE_CODE (node) == COMPOUND_EXPR)
683 /* Search the next expression in this BIND_EXPR. */
686 TB_next_expr (tree node)
688 node = TB_current_chain_node (node);
690 if (node == NULL_TREE)
693 node = TREE_OPERAND (node, 1);
698 TB_current_chain_node (tree node)
700 if (node == NULL_TREE)
703 if (TREE_CODE (node) == COMPOUND_EXPR)
706 node = TB_up_expr (node);
709 if (TREE_CODE (node) == COMPOUND_EXPR)
712 node = TB_up_expr (node);
713 if (TREE_CODE (node) == COMPOUND_EXPR)
720 /* For each node store in its children nodes that the current node is their
721 parent. This function is used by walk_tree. */
724 store_child_info (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED,
725 void *data ATTRIBUTE_UNUSED)
732 /* 'node' is the parent of 'TREE_OPERAND (node, *)'. */
735 int n = TREE_OPERAND_LENGTH (node);
737 for (i = 0; i < n; i++)
739 tree op = TREE_OPERAND (node, i);
740 slot = htab_find_slot (TB_up_ht, op, INSERT);
741 *slot = (void *) node;
745 /* Never stop walk_tree. */
749 /* Function used in TB_up_ht. */
752 TB_parent_eq (const void *p1, const void *p2)
754 const_tree const node = (const_tree)p2;
755 const_tree const parent = (const_tree) p1;
757 if (p1 == NULL || p2 == NULL)
762 int n = TREE_OPERAND_LENGTH (parent);
764 for (i = 0; i < n; i++)
765 if (node == TREE_OPERAND (parent, i))
771 /* Update information about upper expressions in the hash table. */
774 TB_update_up (tree node)
778 walk_tree (&node, store_child_info, NULL, NULL);
780 /* Walk function's body. */
781 if (TREE_CODE (node) == FUNCTION_DECL)
782 if (DECL_SAVED_TREE (node))
783 walk_tree (&DECL_SAVED_TREE (node), store_child_info, NULL, NULL);
785 /* Walk rest of the chain. */
786 node = TREE_CHAIN (node);
788 fprintf (TB_OUT_FILE, "Up/prev expressions updated.\n");
791 /* Parse the input string for determining the command the user asked for. */
794 TB_get_command (char *input)
796 unsigned int mn, size_tok;
800 space = strchr (input, ' ');
802 size_tok = strlen (input) - strlen (space);
804 size_tok = strlen (input) - 1;
806 for (mn = 0; mn < TB_UNUSED_COMMAND; mn++)
808 if (size_tok != TB_COMMAND_LEN (mn))
811 comp = memcmp (input, TB_COMMAND_TEXT (mn), TB_COMMAND_LEN (mn));
813 /* Here we just determined the command. If this command takes
814 an argument, then the argument is determined later. */
815 return TB_COMMAND_CODE (mn);
818 /* Not a valid command. */
819 return TB_UNUSED_COMMAND;
822 /* Parse the input string for determining the tree code. */
824 static enum tree_code
825 TB_get_tree_code (char *input)
827 unsigned int mn, size_tok;
831 space = strchr (input, ' ');
833 size_tok = strlen (input) - strlen (space);
835 size_tok = strlen (input) - 1;
837 for (mn = 0; mn < LAST_AND_UNUSED_TREE_CODE; mn++)
839 if (size_tok != TB_TREE_CODE_LEN (mn))
842 comp = memcmp (input, TB_TREE_CODE_TEXT (mn), TB_TREE_CODE_LEN (mn));
845 fprintf (TB_OUT_FILE, "%s\n", TB_TREE_CODE_TEXT (mn));
846 return TB_TREE_CODE (mn);
850 /* This isn't a valid code. */
851 return LAST_AND_UNUSED_TREE_CODE;
854 /* Find a node with a given code. This function is used as an argument to
858 find_node_with_code (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED,
861 enum tree_code *code;
862 code = (enum tree_code *) data;
863 if (*code == TREE_CODE (*tp))
869 /* Returns a pointer to the last visited node. */
872 TB_history_prev (void)
874 if (!VEC_empty (tree, TB_history_stack))
876 tree last = VEC_last (tree, TB_history_stack);
877 VEC_pop (tree, TB_history_stack);
883 /* Read up to (and including) a '\n' from STREAM into *LINEPTR
884 (and null-terminate it). *LINEPTR is a pointer returned from malloc
885 (or NULL), pointing to *N characters of space. It is realloc'd as
886 necessary. Returns the number of characters read (not including the
887 null terminator), or -1 on error or EOF.
888 This function comes from sed (and is supposed to be a portable version
892 TB_getline (char **lineptr, long *n, FILE *stream)
897 if (lineptr == NULL || n == NULL)
906 /* Make sure we have a line buffer to start with. */
907 if (*lineptr == NULL || *n < 2) /* !seen and no buf yet need 2 chars. */
910 #define MAX_CANON 256
912 line = (char *) xrealloc (*lineptr, MAX_CANON);
931 register int c = getc (stream);
934 else if ((*p++ = c) == '\n')
938 /* Need to enlarge the line buffer. */
941 line = (char *) xrealloc (line, size);
954 /* Return a partial line since we got an error in the middle. */
956 #if defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__) || defined(MSDOS)
957 if (p - 2 >= *lineptr && p[-2] == '\r')