2 Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Sebastian Pop <s.pop@laposte.net>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
24 #include "coretypes.h"
28 #include "tree-inline.h"
29 #include "diagnostic.h"
33 #define TB_OUT_FILE stdout
34 #define TB_IN_FILE stdin
35 #define TB_NIY fprintf (TB_OUT_FILE, "Sorry this command is not yet implemented.\n")
36 #define TB_WF fprintf (TB_OUT_FILE, "Warning, this command failed.\n")
39 /* Structures for handling Tree Browser's commands. */
40 #define DEFTBCODE(COMMAND, STRING, HELP) COMMAND,
42 #include "tree-browser.def"
46 typedef enum TB_Comm_code TB_CODE;
50 const char *comm_text;
55 #define DEFTBCODE(code, str, help) { help, str, sizeof(str) - 1, code },
56 static const struct tb_command tb_commands[] =
58 #include "tree-browser.def"
62 #define TB_COMMAND_LEN(N) (tb_commands[N].comm_len)
63 #define TB_COMMAND_TEXT(N) (tb_commands[N].comm_text)
64 #define TB_COMMAND_CODE(N) (tb_commands[N].comm_code)
65 #define TB_COMMAND_HELP(N) (tb_commands[N].help_msg)
68 /* Next structure is for parsing TREE_CODEs. */
71 const char *code_string;
72 size_t code_string_len;
75 #define DEFTREECODE(SYM, STRING, TYPE, NARGS) { SYM, STRING, sizeof (STRING) - 1 },
76 static const struct tb_tree_code tb_tree_codes[] =
82 #define TB_TREE_CODE(N) (tb_tree_codes[N].code)
83 #define TB_TREE_CODE_TEXT(N) (tb_tree_codes[N].code_string)
84 #define TB_TREE_CODE_LEN(N) (tb_tree_codes[N].code_string_len)
87 /* Function declarations. */
89 static long TB_getline (char **, long *, FILE *);
90 static TB_CODE TB_get_command (char *);
91 static enum tree_code TB_get_tree_code (char *);
92 static tree find_node_with_code (tree *, int *, void *);
93 static tree store_child_info (tree *, int *, void *);
94 static void TB_update_up (tree);
95 static tree TB_current_chain_node (tree);
96 static tree TB_prev_expr (tree);
97 static tree TB_next_expr (tree);
98 static tree TB_up_expr (tree);
99 static tree TB_first_in_bind (tree);
100 static tree TB_last_in_bind (tree);
101 static int TB_parent_eq (const void *, const void *);
102 static tree TB_history_prev (void);
104 /* FIXME: To be declared in a .h file. */
105 void browse_tree (tree);
107 /* Static variables. */
108 static htab_t TB_up_ht;
109 static tree TB_history_stack = NULL_TREE;
110 static int TB_verbose = 1;
113 /* Entry point in the Tree Browser. */
116 browse_tree (tree begin)
119 TB_CODE tbc = TB_UNUSED_COMMAND;
124 fprintf (TB_OUT_FILE, "\nTree Browser\n");
126 #define TB_SET_HEAD(N) do { \
127 TB_history_stack = tree_cons (NULL_TREE, (N), TB_history_stack); \
132 print_generic_expr (TB_OUT_FILE, head, 0); \
133 fprintf (TB_OUT_FILE, "\n"); \
139 /* Store in a hashtable information about previous and upper statements. */
141 TB_up_ht = htab_create (1023, htab_hash_pointer, &TB_parent_eq, NULL);
147 fprintf (TB_OUT_FILE, "TB> ");
148 rd = TB_getline (&input, &input_size, TB_IN_FILE);
155 /* Get a new command. Otherwise the user just pressed enter, and thus
156 she expects the last command to be reexecuted. */
157 tbc = TB_get_command (input);
166 if (head && (INTEGRAL_TYPE_P (head)
167 || TREE_CODE (head) == REAL_TYPE))
168 TB_SET_HEAD (TYPE_MAX_VALUE (head));
174 if (head && (INTEGRAL_TYPE_P (head)
175 || TREE_CODE (head) == REAL_TYPE))
176 TB_SET_HEAD (TYPE_MIN_VALUE (head));
182 if (head && TREE_CODE (head) == TREE_VEC)
184 /* This command takes another argument: the element number:
185 for example "elt 1". */
188 else if (head && TREE_CODE (head) == VECTOR_CST)
190 /* This command takes another argument: the element number:
191 for example "elt 1". */
199 if (head && TREE_CODE (head) == TREE_LIST)
200 TB_SET_HEAD (TREE_VALUE (head));
206 if (head && TREE_CODE (head) == TREE_LIST)
207 TB_SET_HEAD (TREE_PURPOSE (head));
213 if (head && TREE_CODE (head) == COMPLEX_CST)
214 TB_SET_HEAD (TREE_IMAGPART (head));
220 if (head && TREE_CODE (head) == COMPLEX_CST)
221 TB_SET_HEAD (TREE_REALPART (head));
227 if (head && TREE_CODE (head) == BIND_EXPR)
228 TB_SET_HEAD (TREE_OPERAND (head, 2));
234 if (head && TREE_CODE (head) == BLOCK)
235 TB_SET_HEAD (BLOCK_SUBBLOCKS (head));
240 case TB_SUPERCONTEXT:
241 if (head && TREE_CODE (head) == BLOCK)
242 TB_SET_HEAD (BLOCK_SUPERCONTEXT (head));
248 if (head && TREE_CODE (head) == BLOCK)
249 TB_SET_HEAD (BLOCK_VARS (head));
250 else if (head && TREE_CODE (head) == BIND_EXPR)
251 TB_SET_HEAD (TREE_OPERAND (head, 0));
256 case TB_REFERENCE_TO_THIS:
257 if (head && TYPE_P (head))
258 TB_SET_HEAD (TYPE_REFERENCE_TO (head));
263 case TB_POINTER_TO_THIS:
264 if (head && TYPE_P (head))
265 TB_SET_HEAD (TYPE_POINTER_TO (head));
271 if (head && TREE_CODE (head) == OFFSET_TYPE)
272 TB_SET_HEAD (TYPE_OFFSET_BASETYPE (head));
278 if (head && (TREE_CODE (head) == FUNCTION_TYPE
279 || TREE_CODE (head) == METHOD_TYPE))
280 TB_SET_HEAD (TYPE_ARG_TYPES (head));
285 case TB_METHOD_BASE_TYPE:
286 if (head && (TREE_CODE (head) == FUNCTION_TYPE
287 || TREE_CODE (head) == METHOD_TYPE)
288 && TYPE_METHOD_BASETYPE (head))
289 TB_SET_HEAD (TYPE_METHOD_BASETYPE (head));
295 if (head && (TREE_CODE (head) == RECORD_TYPE
296 || TREE_CODE (head) == UNION_TYPE
297 || TREE_CODE (head) == QUAL_UNION_TYPE))
298 TB_SET_HEAD (TYPE_FIELDS (head));
304 if (head && TREE_CODE (head) == ARRAY_TYPE)
305 TB_SET_HEAD (TYPE_DOMAIN (head));
311 if (head && TREE_CODE (head) == ENUMERAL_TYPE)
312 TB_SET_HEAD (TYPE_VALUES (head));
317 case TB_ARG_TYPE_AS_WRITTEN:
318 if (head && TREE_CODE (head) == PARM_DECL)
319 TB_SET_HEAD (DECL_ARG_TYPE_AS_WRITTEN (head));
325 if (head && TREE_CODE (head) == PARM_DECL)
326 TB_SET_HEAD (DECL_ARG_TYPE (head));
332 if (head && DECL_P (head))
333 TB_SET_HEAD (DECL_INITIAL (head));
339 if (head && DECL_P (head))
340 TB_SET_HEAD (DECL_RESULT_FLD (head));
346 if (head && DECL_P (head))
347 TB_SET_HEAD (DECL_ARGUMENTS (head));
352 case TB_ABSTRACT_ORIGIN:
353 if (head && DECL_P (head))
354 TB_SET_HEAD (DECL_ABSTRACT_ORIGIN (head));
355 else if (head && TREE_CODE (head) == BLOCK)
356 TB_SET_HEAD (BLOCK_ABSTRACT_ORIGIN (head));
362 if (head && DECL_P (head))
363 TB_SET_HEAD (DECL_ATTRIBUTES (head));
364 else if (head && TYPE_P (head))
365 TB_SET_HEAD (TYPE_ATTRIBUTES (head));
371 if (head && DECL_P (head))
372 TB_SET_HEAD (DECL_CONTEXT (head));
373 else if (head && TYPE_P (head)
374 && TYPE_CONTEXT (head))
375 TB_SET_HEAD (TYPE_CONTEXT (head));
381 if (head && TREE_CODE (head) == FIELD_DECL)
382 TB_SET_HEAD (DECL_FIELD_OFFSET (head));
388 if (head && TREE_CODE (head) == FIELD_DECL)
389 TB_SET_HEAD (DECL_FIELD_BIT_OFFSET (head));
395 if (head && DECL_P (head))
396 TB_SET_HEAD (DECL_SIZE_UNIT (head));
397 else if (head && TYPE_P (head))
398 TB_SET_HEAD (TYPE_SIZE_UNIT (head));
404 if (head && DECL_P (head))
405 TB_SET_HEAD (DECL_SIZE (head));
406 else if (head && TYPE_P (head))
407 TB_SET_HEAD (TYPE_SIZE (head));
413 if (head && TREE_TYPE (head))
414 TB_SET_HEAD (TREE_TYPE (head));
419 case TB_DECL_SAVED_TREE:
420 if (head && TREE_CODE (head) == FUNCTION_DECL
421 && DECL_SAVED_TREE (head))
422 TB_SET_HEAD (DECL_SAVED_TREE (head));
428 if (head && TREE_CODE (head) == BIND_EXPR)
429 TB_SET_HEAD (TREE_OPERAND (head, 1));
435 if (head && EXPR_P (head) && TREE_OPERAND (head, 0))
436 TB_SET_HEAD (TREE_OPERAND (head, 0));
442 if (head && EXPR_P (head) && TREE_OPERAND (head, 1))
443 TB_SET_HEAD (TREE_OPERAND (head, 1));
449 if (head && EXPR_P (head) && TREE_OPERAND (head, 2))
450 TB_SET_HEAD (TREE_OPERAND (head, 2));
456 if (head && EXPR_P (head) && TREE_OPERAND (head, 3))
457 TB_SET_HEAD (TREE_OPERAND (head, 3));
469 case TB_PRETTY_PRINT:
472 print_generic_stmt (TB_OUT_FILE, head, 0);
473 fprintf (TB_OUT_FILE, "\n");
488 arg_text = strchr (input, ' ');
489 if (arg_text == NULL)
491 fprintf (TB_OUT_FILE, "First argument is missing. This isn't a valid search command. \n");
494 code = TB_get_tree_code (arg_text + 1);
496 /* Search in the subtree a node with the given code. */
500 res = walk_tree (&head, find_node_with_code, &code, NULL);
501 if (res == NULL_TREE)
503 fprintf (TB_OUT_FILE, "There's no node with this code (reachable via the walk_tree function from this node).\n");
507 fprintf (TB_OUT_FILE, "Achoo! I got this node in the tree.\n");
514 #define TB_MOVE_HEAD(FCT) do { \
529 TB_MOVE_HEAD (TB_first_in_bind);
533 TB_MOVE_HEAD (TB_last_in_bind);
537 TB_MOVE_HEAD (TB_up_expr);
541 TB_MOVE_HEAD (TB_prev_expr);
545 TB_MOVE_HEAD (TB_next_expr);
549 /* This command is a little bit special, since it deals with history
550 stack. For this reason it should keep the "head = ..." statement
551 and not use TB_MOVE_HEAD. */
555 t = TB_history_prev ();
561 print_generic_expr (TB_OUT_FILE, head, 0);
562 fprintf (TB_OUT_FILE, "\n");
573 /* Don't go further if it's the last node in this chain. */
574 if (head && TREE_CODE (head) == BLOCK)
575 TB_SET_HEAD (BLOCK_CHAIN (head));
576 else if (head && TREE_CHAIN (head))
577 TB_SET_HEAD (TREE_CHAIN (head));
583 /* Go up to the current function declaration. */
584 TB_SET_HEAD (current_function_decl);
585 fprintf (TB_OUT_FILE, "Current function declaration.\n");
589 /* Display a help message. */
592 fprintf (TB_OUT_FILE, "Possible commands are:\n\n");
593 for (i = 0; i < TB_UNUSED_COMMAND; i++)
595 fprintf (TB_OUT_FILE, "%20s - %s\n", TB_COMMAND_TEXT (i), TB_COMMAND_HELP (i));
604 fprintf (TB_OUT_FILE, "Verbose on.\n");
609 fprintf (TB_OUT_FILE, "Verbose off.\n");
615 /* Just exit from this function. */
624 htab_delete (TB_up_ht);
629 /* Search the first node in this BIND_EXPR. */
632 TB_first_in_bind (tree node)
636 if (node == NULL_TREE)
639 while ((t = TB_prev_expr (node)))
645 /* Search the last node in this BIND_EXPR. */
648 TB_last_in_bind (tree node)
652 if (node == NULL_TREE)
655 while ((t = TB_next_expr (node)))
661 /* Search the parent expression for this node. */
664 TB_up_expr (tree node)
667 if (node == NULL_TREE)
670 res = (tree) htab_find (TB_up_ht, node);
674 /* Search the previous expression in this BIND_EXPR. */
677 TB_prev_expr (tree node)
679 node = TB_current_chain_node (node);
681 if (node == NULL_TREE)
684 node = TB_up_expr (node);
685 if (node && TREE_CODE (node) == COMPOUND_EXPR)
691 /* Search the next expression in this BIND_EXPR. */
694 TB_next_expr (tree node)
696 node = TB_current_chain_node (node);
698 if (node == NULL_TREE)
701 node = TREE_OPERAND (node, 1);
706 TB_current_chain_node (tree node)
708 if (node == NULL_TREE)
711 if (TREE_CODE (node) == COMPOUND_EXPR)
714 node = TB_up_expr (node);
717 if (TREE_CODE (node) == COMPOUND_EXPR)
720 node = TB_up_expr (node);
721 if (TREE_CODE (node) == COMPOUND_EXPR)
728 /* For each node store in its children nodes that the current node is their
729 parent. This function is used by walk_tree. */
732 store_child_info (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED,
733 void *data ATTRIBUTE_UNUSED)
740 /* 'node' is the parent of 'TREE_OPERAND (node, *)'. */
741 if (EXPRESSION_CLASS_P (node))
744 #define STORE_CHILD(N) do { \
745 tree op = TREE_OPERAND (node, N); \
746 slot = htab_find_slot (TB_up_ht, op, INSERT); \
747 *slot = (void *) node; \
750 switch (TREE_CODE_LENGTH (TREE_CODE (node)))
776 /* No children: nothing to do. */
782 /* Never stop walk_tree. */
786 /* Function used in TB_up_ht. */
789 TB_parent_eq (const void *p1, const void *p2)
795 if (p1 == NULL || p2 == NULL)
798 if (EXPRESSION_CLASS_P (parent))
801 #define TEST_CHILD(N) do { \
802 if (node == TREE_OPERAND (parent, N)) \
806 switch (TREE_CODE_LENGTH (TREE_CODE (parent)))
832 /* No children: nothing to do. */
841 /* Update information about upper expressions in the hash table. */
844 TB_update_up (tree node)
848 walk_tree (&node, store_child_info, NULL, NULL);
850 /* Walk function's body. */
851 if (TREE_CODE (node) == FUNCTION_DECL)
852 if (DECL_SAVED_TREE (node))
853 walk_tree (&DECL_SAVED_TREE (node), store_child_info, NULL, NULL);
855 /* Walk rest of the chain. */
856 node = TREE_CHAIN (node);
858 fprintf (TB_OUT_FILE, "Up/prev expressions updated.\n");
861 /* Parse the input string for determining the command the user asked for. */
864 TB_get_command (char *input)
866 unsigned int mn, size_tok;
870 space = strchr (input, ' ');
872 size_tok = strlen (input) - strlen (space);
874 size_tok = strlen (input) - 1;
876 for (mn = 0; mn < TB_UNUSED_COMMAND; mn++)
878 if (size_tok != TB_COMMAND_LEN (mn))
881 comp = memcmp (input, TB_COMMAND_TEXT (mn), TB_COMMAND_LEN (mn));
883 /* Here we just determined the command. If this command takes
884 an argument, then the argument is determined later. */
885 return TB_COMMAND_CODE (mn);
888 /* Not a valid command. */
889 return TB_UNUSED_COMMAND;
892 /* Parse the input string for determining the tree code. */
894 static enum tree_code
895 TB_get_tree_code (char *input)
897 unsigned int mn, size_tok;
901 space = strchr (input, ' ');
903 size_tok = strlen (input) - strlen (space);
905 size_tok = strlen (input) - 1;
907 for (mn = 0; mn < LAST_AND_UNUSED_TREE_CODE; mn++)
909 if (size_tok != TB_TREE_CODE_LEN (mn))
912 comp = memcmp (input, TB_TREE_CODE_TEXT (mn), TB_TREE_CODE_LEN (mn));
915 fprintf (TB_OUT_FILE, "%s\n", TB_TREE_CODE_TEXT (mn));
916 return TB_TREE_CODE (mn);
920 /* This isn't a valid code. */
921 return LAST_AND_UNUSED_TREE_CODE;
924 /* Find a node with a given code. This function is used as an argument to
928 find_node_with_code (tree *tp, int *walk_subtrees ATTRIBUTE_UNUSED,
931 enum tree_code *code;
932 code = (enum tree_code *) data;
933 if (*code == TREE_CODE (*tp))
939 /* Returns a pointer to the last visited node. */
942 TB_history_prev (void)
944 if (TB_history_stack)
946 TB_history_stack = TREE_CHAIN (TB_history_stack);
947 if (TB_history_stack)
948 return TREE_VALUE (TB_history_stack);
953 /* Read up to (and including) a '\n' from STREAM into *LINEPTR
954 (and null-terminate it). *LINEPTR is a pointer returned from malloc
955 (or NULL), pointing to *N characters of space. It is realloc'd as
956 necessary. Returns the number of characters read (not including the
957 null terminator), or -1 on error or EOF.
958 This function comes from sed (and is supposed to be a portable version
962 TB_getline (char **lineptr, long *n, FILE *stream)
967 if (lineptr == NULL || n == NULL)
976 /* Make sure we have a line buffer to start with. */
977 if (*lineptr == NULL || *n < 2) /* !seen and no buf yet need 2 chars. */
980 #define MAX_CANON 256
982 line = (char *) xrealloc (*lineptr, MAX_CANON);
1001 register int c = getc (stream);
1004 else if ((*p++ = c) == '\n')
1008 /* Need to enlarge the line buffer. */
1011 line = (char *) xrealloc (line, size);
1024 /* Return a partial line since we got an error in the middle. */
1026 #if defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__) || defined(MSDOS)
1027 if (p - 2 >= *lineptr && p[-2] == '\r')
1031 return p - *lineptr;