tree-dump.h revision 302408 
1/* Tree-dumping functionality for intermediate representation.
2   Copyright (C) 1999, 2000, 2003, 2004, 2005 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, 51 Franklin Street, Fifth Floor, Boston, MA
2002110-1301, USA.  */
21
22#ifndef GCC_TREE_DUMP_H
23#define GCC_TREE_DUMP_H
24
25#include "splay-tree.h"
26#include "tree-pass.h"
27
28typedef struct dump_info *dump_info_p;
29
30/* Flags used with queue functions.  */
31#define DUMP_NONE     0
32#define DUMP_BINFO    1
33
34/* Information about a node to be dumped.  */
35
36typedef struct dump_node_info
37{
38  /* The index for the node.  */
39  unsigned int index;
40  /* Nonzero if the node is a binfo.  */
41  unsigned int binfo_p : 1;
42} *dump_node_info_p;
43
44/* A dump_queue is a link in the queue of things to be dumped.  */
45
46typedef struct dump_queue
47{
48  /* The queued tree node.  */
49  splay_tree_node node;
50  /* The next node in the queue.  */
51  struct dump_queue *next;
52} *dump_queue_p;
53
54/* A dump_info gives information about how we should perform the dump
55   and about the current state of the dump.  */
56
57struct dump_info
58{
59  /* The stream on which to dump the information.  */
60  FILE *stream;
61  /* The original node.  */
62  tree node;
63  /* User flags.  */
64  int flags;
65  /* The next unused node index.  */
66  unsigned int index;
67  /* The next column.  */
68  unsigned int column;
69  /* The first node in the queue of nodes to be written out.  */
70  dump_queue_p queue;
71  /* The last node in the queue.  */
72  dump_queue_p queue_end;
73  /* Free queue nodes.  */
74  dump_queue_p free_list;
75  /* The tree nodes which we have already written out.  The
76     keys are the addresses of the nodes; the values are the integer
77     indices we assigned them.  */
78  splay_tree nodes;
79};
80
81/* Dump the CHILD and its children.  */
82#define dump_child(field, child) \
83  queue_and_dump_index (di, field, child, DUMP_NONE)
84
85extern void dump_pointer (dump_info_p, const char *, void *);
86extern void dump_int (dump_info_p, const char *, int);
87extern void dump_string (dump_info_p, const char *);
88extern void dump_string_field (dump_info_p, const char *, const char *);
89extern void dump_stmt (dump_info_p, tree);
90extern void queue_and_dump_index (dump_info_p, const char *, tree, int);
91extern void queue_and_dump_type (dump_info_p, tree);
92extern void dump_function (enum tree_dump_index, tree);
93extern void dump_function_to_file (tree, FILE *, int);
94extern void debug_function (tree, int);
95extern int dump_flag (dump_info_p, int, tree);
96
97extern unsigned int dump_register (const char *, const char *, const char *,
98				   int, int);
99
100
101#endif /* ! GCC_TREE_DUMP_H */
102