2 Copyright (C) 2002, 2003, 2004, 2007 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 3, 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 COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
23 #include "coretypes.h"
26 #include "tree-inline.h"
27 #include "diagnostic.h"
31 #define TB_OUT_FILE stdout
32 #define TB_IN_FILE stdin
33 #define TB_NIY fprintf (TB_OUT_FILE, "Sorry this command is not yet implemented.\n")
34 #define TB_WF fprintf (TB_OUT_FILE, "Warning, this command failed.\n")
37 /* Structures for handling Tree Browser's commands. */
38 #define DEFTBCODE(COMMAND, STRING, HELP) COMMAND,
40 #include "tree-browser.def"
44 typedef enum TB_Comm_code TB_CODE
;
48 const char *comm_text
;
53 #define DEFTBCODE(code, str, help) { help, str, sizeof(str) - 1, code },
54 static const struct tb_command tb_commands
[] =
56 #include "tree-browser.def"
60 #define TB_COMMAND_LEN(N) (tb_commands[N].comm_len)
61 #define TB_COMMAND_TEXT(N) (tb_commands[N].comm_text)
62 #define TB_COMMAND_CODE(N) (tb_commands[N].comm_code)
63 #define TB_COMMAND_HELP(N) (tb_commands[N].help_msg)
66 /* Next structure is for parsing TREE_CODEs. */
69 const char *code_string
;
70 size_t code_string_len
;
73 #define DEFTREECODE(SYM, STRING, TYPE, NARGS) { SYM, STRING, sizeof (STRING) - 1 },
74 static const struct tb_tree_code tb_tree_codes
[] =
80 #define TB_TREE_CODE(N) (tb_tree_codes[N].code)
81 #define TB_TREE_CODE_TEXT(N) (tb_tree_codes[N].code_string)
82 #define TB_TREE_CODE_LEN(N) (tb_tree_codes[N].code_string_len)
85 /* Function declarations. */
87 static long TB_getline (char **, long *, FILE *);
88 static TB_CODE
TB_get_command (char *);
89 static enum tree_code
TB_get_tree_code (char *);
90 static tree
find_node_with_code (tree
*, int *, void *);
91 static tree
store_child_info (tree
*, int *, void *);
92 static void TB_update_up (tree
);
93 static tree
TB_current_chain_node (tree
);
94 static tree
TB_prev_expr (tree
);
95 static tree
TB_next_expr (tree
);
96 static tree
TB_up_expr (tree
);
97 static tree
TB_first_in_bind (tree
);
98 static tree
TB_last_in_bind (tree
);
99 static int TB_parent_eq (const void *, const void *);
100 static tree
TB_history_prev (void);
102 /* FIXME: To be declared in a .h file. */
103 void browse_tree (tree
);
105 /* Static variables. */
106 static htab_t TB_up_ht
;
107 static tree TB_history_stack
= NULL_TREE
;
108 static int TB_verbose
= 1;
111 /* Entry point in the Tree Browser. */
114 browse_tree (tree begin
)
117 TB_CODE tbc
= TB_UNUSED_COMMAND
;
122 fprintf (TB_OUT_FILE
, "\nTree Browser\n");
124 #define TB_SET_HEAD(N) do { \
125 TB_history_stack = tree_cons (NULL_TREE, (N), TB_history_stack); \
130 print_generic_expr (TB_OUT_FILE, head, 0); \
131 fprintf (TB_OUT_FILE, "\n"); \
137 /* Store in a hashtable information about previous and upper statements. */
139 TB_up_ht
= htab_create (1023, htab_hash_pointer
, &TB_parent_eq
, NULL
);
145 fprintf (TB_OUT_FILE
, "TB> ");
146 rd
= TB_getline (&input
, &input_size
, TB_IN_FILE
);
153 /* Get a new command. Otherwise the user just pressed enter, and thus
154 she expects the last command to be reexecuted. */
155 tbc
= TB_get_command (input
);
164 if (head
&& (INTEGRAL_TYPE_P (head
)
165 || TREE_CODE (head
) == REAL_TYPE
166 || TREE_CODE (head
) == FIXED_POINT_TYPE
))
167 TB_SET_HEAD (TYPE_MAX_VALUE (head
));
173 if (head
&& (INTEGRAL_TYPE_P (head
)
174 || TREE_CODE (head
) == REAL_TYPE
175 || TREE_CODE (head
) == FIXED_POINT_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
));
318 if (head
&& TREE_CODE (head
) == PARM_DECL
)
319 TB_SET_HEAD (DECL_ARG_TYPE (head
));
325 if (head
&& DECL_P (head
))
326 TB_SET_HEAD (DECL_INITIAL (head
));
332 if (head
&& DECL_P (head
))
333 TB_SET_HEAD (DECL_RESULT_FLD (head
));
339 if (head
&& DECL_P (head
))
340 TB_SET_HEAD (DECL_ARGUMENTS (head
));
345 case TB_ABSTRACT_ORIGIN
:
346 if (head
&& DECL_P (head
))
347 TB_SET_HEAD (DECL_ABSTRACT_ORIGIN (head
));
348 else if (head
&& TREE_CODE (head
) == BLOCK
)
349 TB_SET_HEAD (BLOCK_ABSTRACT_ORIGIN (head
));
355 if (head
&& DECL_P (head
))
356 TB_SET_HEAD (DECL_ATTRIBUTES (head
));
357 else if (head
&& TYPE_P (head
))
358 TB_SET_HEAD (TYPE_ATTRIBUTES (head
));
364 if (head
&& DECL_P (head
))
365 TB_SET_HEAD (DECL_CONTEXT (head
));
366 else if (head
&& TYPE_P (head
)
367 && TYPE_CONTEXT (head
))
368 TB_SET_HEAD (TYPE_CONTEXT (head
));
374 if (head
&& TREE_CODE (head
) == FIELD_DECL
)
375 TB_SET_HEAD (DECL_FIELD_OFFSET (head
));
381 if (head
&& TREE_CODE (head
) == FIELD_DECL
)
382 TB_SET_HEAD (DECL_FIELD_BIT_OFFSET (head
));
388 if (head
&& DECL_P (head
))
389 TB_SET_HEAD (DECL_SIZE_UNIT (head
));
390 else if (head
&& TYPE_P (head
))
391 TB_SET_HEAD (TYPE_SIZE_UNIT (head
));
397 if (head
&& DECL_P (head
))
398 TB_SET_HEAD (DECL_SIZE (head
));
399 else if (head
&& TYPE_P (head
))
400 TB_SET_HEAD (TYPE_SIZE (head
));
406 if (head
&& TREE_TYPE (head
))
407 TB_SET_HEAD (TREE_TYPE (head
));
412 case TB_DECL_SAVED_TREE
:
413 if (head
&& TREE_CODE (head
) == FUNCTION_DECL
414 && DECL_SAVED_TREE (head
))
415 TB_SET_HEAD (DECL_SAVED_TREE (head
));
421 if (head
&& TREE_CODE (head
) == BIND_EXPR
)
422 TB_SET_HEAD (TREE_OPERAND (head
, 1));
428 if (head
&& EXPR_P (head
) && TREE_OPERAND (head
, 0))
429 TB_SET_HEAD (TREE_OPERAND (head
, 0));
435 if (head
&& EXPR_P (head
) && TREE_OPERAND (head
, 1))
436 TB_SET_HEAD (TREE_OPERAND (head
, 1));
442 if (head
&& EXPR_P (head
) && TREE_OPERAND (head
, 2))
443 TB_SET_HEAD (TREE_OPERAND (head
, 2));
449 if (head
&& EXPR_P (head
) && TREE_OPERAND (head
, 3))
450 TB_SET_HEAD (TREE_OPERAND (head
, 3));
462 case TB_PRETTY_PRINT
:
465 print_generic_stmt (TB_OUT_FILE
, head
, 0);
466 fprintf (TB_OUT_FILE
, "\n");
481 arg_text
= strchr (input
, ' ');
482 if (arg_text
== NULL
)
484 fprintf (TB_OUT_FILE
, "First argument is missing. This isn't a valid search command. \n");
487 code
= TB_get_tree_code (arg_text
+ 1);
489 /* Search in the subtree a node with the given code. */
493 res
= walk_tree (&head
, find_node_with_code
, &code
, NULL
);
494 if (res
== NULL_TREE
)
496 fprintf (TB_OUT_FILE
, "There's no node with this code (reachable via the walk_tree function from this node).\n");
500 fprintf (TB_OUT_FILE
, "Achoo! I got this node in the tree.\n");
507 #define TB_MOVE_HEAD(FCT) do { \
522 TB_MOVE_HEAD (TB_first_in_bind
);
526 TB_MOVE_HEAD (TB_last_in_bind
);
530 TB_MOVE_HEAD (TB_up_expr
);
534 TB_MOVE_HEAD (TB_prev_expr
);
538 TB_MOVE_HEAD (TB_next_expr
);
542 /* This command is a little bit special, since it deals with history
543 stack. For this reason it should keep the "head = ..." statement
544 and not use TB_MOVE_HEAD. */
548 t
= TB_history_prev ();
554 print_generic_expr (TB_OUT_FILE
, head
, 0);
555 fprintf (TB_OUT_FILE
, "\n");
566 /* Don't go further if it's the last node in this chain. */
567 if (head
&& TREE_CODE (head
) == BLOCK
)
568 TB_SET_HEAD (BLOCK_CHAIN (head
));
569 else if (head
&& TREE_CHAIN (head
))
570 TB_SET_HEAD (TREE_CHAIN (head
));
576 /* Go up to the current function declaration. */
577 TB_SET_HEAD (current_function_decl
);
578 fprintf (TB_OUT_FILE
, "Current function declaration.\n");
582 /* Display a help message. */
585 fprintf (TB_OUT_FILE
, "Possible commands are:\n\n");
586 for (i
= 0; i
< TB_UNUSED_COMMAND
; i
++)
588 fprintf (TB_OUT_FILE
, "%20s - %s\n", TB_COMMAND_TEXT (i
), TB_COMMAND_HELP (i
));
597 fprintf (TB_OUT_FILE
, "Verbose on.\n");
602 fprintf (TB_OUT_FILE
, "Verbose off.\n");
608 /* Just exit from this function. */
617 htab_delete (TB_up_ht
);
622 /* Search the first node in this BIND_EXPR. */
625 TB_first_in_bind (tree node
)
629 if (node
== NULL_TREE
)
632 while ((t
= TB_prev_expr (node
)))
638 /* Search the last node in this BIND_EXPR. */
641 TB_last_in_bind (tree node
)
645 if (node
== NULL_TREE
)
648 while ((t
= TB_next_expr (node
)))
654 /* Search the parent expression for this node. */
657 TB_up_expr (tree node
)
660 if (node
== NULL_TREE
)
663 res
= (tree
) htab_find (TB_up_ht
, node
);
667 /* Search the previous expression in this BIND_EXPR. */
670 TB_prev_expr (tree node
)
672 node
= TB_current_chain_node (node
);
674 if (node
== NULL_TREE
)
677 node
= TB_up_expr (node
);
678 if (node
&& TREE_CODE (node
) == COMPOUND_EXPR
)
684 /* Search the next expression in this BIND_EXPR. */
687 TB_next_expr (tree node
)
689 node
= TB_current_chain_node (node
);
691 if (node
== NULL_TREE
)
694 node
= TREE_OPERAND (node
, 1);
699 TB_current_chain_node (tree node
)
701 if (node
== NULL_TREE
)
704 if (TREE_CODE (node
) == COMPOUND_EXPR
)
707 node
= TB_up_expr (node
);
710 if (TREE_CODE (node
) == COMPOUND_EXPR
)
713 node
= TB_up_expr (node
);
714 if (TREE_CODE (node
) == COMPOUND_EXPR
)
721 /* For each node store in its children nodes that the current node is their
722 parent. This function is used by walk_tree. */
725 store_child_info (tree
*tp
, int *walk_subtrees ATTRIBUTE_UNUSED
,
726 void *data ATTRIBUTE_UNUSED
)
733 /* 'node' is the parent of 'TREE_OPERAND (node, *)'. */
736 int n
= TREE_OPERAND_LENGTH (node
);
738 for (i
= 0; i
< n
; i
++)
740 tree op
= TREE_OPERAND (node
, i
);
741 slot
= htab_find_slot (TB_up_ht
, op
, INSERT
);
742 *slot
= (void *) node
;
746 /* Never stop walk_tree. */
750 /* Function used in TB_up_ht. */
753 TB_parent_eq (const void *p1
, const void *p2
)
755 const_tree
const node
= (const_tree
)p2
;
756 const_tree
const parent
= (const_tree
) p1
;
758 if (p1
== NULL
|| p2
== NULL
)
763 int n
= TREE_OPERAND_LENGTH (parent
);
765 for (i
= 0; i
< n
; i
++)
766 if (node
== TREE_OPERAND (parent
, i
))
772 /* Update information about upper expressions in the hash table. */
775 TB_update_up (tree node
)
779 walk_tree (&node
, store_child_info
, NULL
, NULL
);
781 /* Walk function's body. */
782 if (TREE_CODE (node
) == FUNCTION_DECL
)
783 if (DECL_SAVED_TREE (node
))
784 walk_tree (&DECL_SAVED_TREE (node
), store_child_info
, NULL
, NULL
);
786 /* Walk rest of the chain. */
787 node
= TREE_CHAIN (node
);
789 fprintf (TB_OUT_FILE
, "Up/prev expressions updated.\n");
792 /* Parse the input string for determining the command the user asked for. */
795 TB_get_command (char *input
)
797 unsigned int mn
, size_tok
;
801 space
= strchr (input
, ' ');
803 size_tok
= strlen (input
) - strlen (space
);
805 size_tok
= strlen (input
) - 1;
807 for (mn
= 0; mn
< TB_UNUSED_COMMAND
; mn
++)
809 if (size_tok
!= TB_COMMAND_LEN (mn
))
812 comp
= memcmp (input
, TB_COMMAND_TEXT (mn
), TB_COMMAND_LEN (mn
));
814 /* Here we just determined the command. If this command takes
815 an argument, then the argument is determined later. */
816 return TB_COMMAND_CODE (mn
);
819 /* Not a valid command. */
820 return TB_UNUSED_COMMAND
;
823 /* Parse the input string for determining the tree code. */
825 static enum tree_code
826 TB_get_tree_code (char *input
)
828 unsigned int mn
, size_tok
;
832 space
= strchr (input
, ' ');
834 size_tok
= strlen (input
) - strlen (space
);
836 size_tok
= strlen (input
) - 1;
838 for (mn
= 0; mn
< LAST_AND_UNUSED_TREE_CODE
; mn
++)
840 if (size_tok
!= TB_TREE_CODE_LEN (mn
))
843 comp
= memcmp (input
, TB_TREE_CODE_TEXT (mn
), TB_TREE_CODE_LEN (mn
));
846 fprintf (TB_OUT_FILE
, "%s\n", TB_TREE_CODE_TEXT (mn
));
847 return TB_TREE_CODE (mn
);
851 /* This isn't a valid code. */
852 return LAST_AND_UNUSED_TREE_CODE
;
855 /* Find a node with a given code. This function is used as an argument to
859 find_node_with_code (tree
*tp
, int *walk_subtrees ATTRIBUTE_UNUSED
,
862 enum tree_code
*code
;
863 code
= (enum tree_code
*) data
;
864 if (*code
== TREE_CODE (*tp
))
870 /* Returns a pointer to the last visited node. */
873 TB_history_prev (void)
875 if (TB_history_stack
)
877 TB_history_stack
= TREE_CHAIN (TB_history_stack
);
878 if (TB_history_stack
)
879 return TREE_VALUE (TB_history_stack
);
884 /* Read up to (and including) a '\n' from STREAM into *LINEPTR
885 (and null-terminate it). *LINEPTR is a pointer returned from malloc
886 (or NULL), pointing to *N characters of space. It is realloc'd as
887 necessary. Returns the number of characters read (not including the
888 null terminator), or -1 on error or EOF.
889 This function comes from sed (and is supposed to be a portable version
893 TB_getline (char **lineptr
, long *n
, FILE *stream
)
898 if (lineptr
== NULL
|| n
== NULL
)
907 /* Make sure we have a line buffer to start with. */
908 if (*lineptr
== NULL
|| *n
< 2) /* !seen and no buf yet need 2 chars. */
911 #define MAX_CANON 256
913 line
= (char *) xrealloc (*lineptr
, MAX_CANON
);
932 register int c
= getc (stream
);
935 else if ((*p
++ = c
) == '\n')
939 /* Need to enlarge the line buffer. */
942 line
= (char *) xrealloc (line
, size
);
955 /* Return a partial line since we got an error in the middle. */
957 #if defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__) || defined(MSDOS)
958 if (p
- 2 >= *lineptr
&& p
[-2] == '\r')