1/* -*- c++ -*- */
2/*
3 * Copyright © 2010 Intel Corporation
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef IR_PRINT_VISITOR_H
26#define IR_PRINT_VISITOR_H
27
28#include "ir.h"
29#include "ir_visitor.h"
30
31#include "program/symbol_table.h"
32
33/**
34 * Abstract base class of visitors of IR instruction trees
35 */
36class ir_print_visitor : public ir_visitor {
37public:
38   ir_print_visitor(FILE *f);
39   virtual ~ir_print_visitor();
40
41   void indent(void);
42
43   /**
44    * \name Visit methods
45    *
46    * As typical for the visitor pattern, there must be one \c visit method for
47    * each concrete subclass of \c ir_instruction.  Virtual base classes within
48    * the hierarchy should not have \c visit methods.
49    */
50   /*@{*/
51   virtual void visit(ir_rvalue *);
52   virtual void visit(ir_variable *);
53   virtual void visit(ir_function_signature *);
54   virtual void visit(ir_function *);
55   virtual void visit(ir_expression *);
56   virtual void visit(ir_texture *);
57   virtual void visit(ir_swizzle *);
58   virtual void visit(ir_dereference_variable *);
59   virtual void visit(ir_dereference_array *);
60   virtual void visit(ir_dereference_record *);
61   virtual void visit(ir_assignment *);
62   virtual void visit(ir_constant *);
63   virtual void visit(ir_call *);
64   virtual void visit(ir_return *);
65   virtual void visit(ir_discard *);
66   virtual void visit(ir_demote *);
67   virtual void visit(ir_if *);
68   virtual void visit(ir_loop *);
69   virtual void visit(ir_loop_jump *);
70   virtual void visit(ir_emit_vertex *);
71   virtual void visit(ir_end_primitive *);
72   virtual void visit(ir_barrier *);
73   /*@}*/
74
75private:
76   /**
77    * Fetch/generate a unique name for ir_variable.
78    *
79    * GLSL IR permits multiple ir_variables to share the same name.  This works
80    * fine until we try to print it, when we really need a unique one.
81    */
82   const char *unique_name(ir_variable *var);
83
84   /** A mapping from ir_variable * -> unique printable names. */
85   hash_table *printable_names;
86   _mesa_symbol_table *symbols;
87
88   void *mem_ctx;
89   FILE *f;
90
91   int indentation;
92};
93
94#endif /* IR_PRINT_VISITOR_H */
95