tree-dump.h revision 96489
1/* Tree-dumping functionality for intermediate representation.
2   Copyright (C) 1999, 2000 Free Software Foundation, Inc.
3   Written by Mark Mitchell <mark@codesourcery.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 2, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to the Free
19Software Foundation, 59 Temple Place - Suite 330, Boston, MA
2002111-1307, USA.  */
21
22#ifndef GCC_TREE_DUMP_H
23#define GCC_TREE_DUMP_H
24
25/* Flags used with queue functions.  */
26#define DUMP_NONE     0
27#define DUMP_BINFO    1
28
29/* Information about a node to be dumped.  */
30
31typedef struct dump_node_info
32{
33  /* The index for the node.  */
34  unsigned int index;
35  /* Nonzero if the node is a binfo.  */
36  unsigned int binfo_p : 1;
37} *dump_node_info_p;
38
39/* A dump_queue is a link in the queue of things to be dumped.  */
40
41typedef struct dump_queue
42{
43  /* The queued tree node.  */
44  splay_tree_node node;
45  /* The next node in the queue.  */
46  struct dump_queue *next;
47} *dump_queue_p;
48
49/* A dump_info gives information about how we should perform the dump
50   and about the current state of the dump.  */
51
52struct dump_info
53{
54  /* The stream on which to dump the information.  */
55  FILE *stream;
56  /* The original node.  */
57  tree node;
58  /* User flags.  */
59  int flags;
60  /* The next unused node index.  */
61  unsigned int index;
62  /* The next column.  */
63  unsigned int column;
64  /* The first node in the queue of nodes to be written out.  */
65  dump_queue_p queue;
66  /* The last node in the queue.  */
67  dump_queue_p queue_end;
68  /* Free queue nodes.  */
69  dump_queue_p free_list;
70  /* The tree nodes which we have already written out.  The
71     keys are the addresses of the nodes; the values are the integer
72     indices we assigned them.  */
73  splay_tree nodes;
74};
75
76/* Dump the CHILD and its children.  */
77#define dump_child(field, child) \
78  queue_and_dump_index (di, field, child, DUMP_NONE)
79
80extern void dump_pointer
81  PARAMS ((dump_info_p, const char *, void *));
82extern void dump_int
83  PARAMS ((dump_info_p, const char *, int));
84extern void dump_string
85  PARAMS ((dump_info_p, const char *));
86extern void dump_stmt
87  PARAMS ((dump_info_p, tree));
88extern void dump_next_stmt
89  PARAMS ((dump_info_p, tree));
90extern void queue_and_dump_index
91  PARAMS ((dump_info_p, const char *, tree, int));
92extern void queue_and_dump_type
93  PARAMS ((dump_info_p, tree));
94
95#endif /* ! GCC_TREE_DUMP_H */
96