src/glsl/ir_print_visitor.h

   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 #pragma once
  26 #ifndef IR_PRINT_VISITOR_H
  27 #define IR_PRINT_VISITOR_H
  28
  29 #include "ir.h"
  30 #include "ir_visitor.h"
  31
  32 extern "C" {
  33 #include "program/symbol_table.h"
  34 }
  35
  36 extern void _mesa_print_ir(exec_list *instructions,
  37                            struct _mesa_glsl_parse_state *state);
  38
  39 /**
  40  * Abstract base class of visitors of IR instruction trees
  41  */
  42 class ir_print_visitor : public ir_visitor {
  43 public:
  44    ir_print_visitor();
  45    virtual ~ir_print_visitor();
  46
  47    void indent(void);
  48
  49    /**
  50     * \name Visit methods
  51     *
  52     * As typical for the visitor pattern, there must be one \c visit method for
  53     * each concrete subclass of \c ir_instruction.  Virtual base classes within
  54     * the hierarchy should not have \c visit methods.
  55     */
  56    /*@{*/
  57    virtual void visit(ir_rvalue *);
  58    virtual void visit(ir_variable *);
  59    virtual void visit(ir_function_signature *);
  60    virtual void visit(ir_function *);
  61    virtual void visit(ir_expression *);
  62    virtual void visit(ir_texture *);
  63    virtual void visit(ir_swizzle *);
  64    virtual void visit(ir_dereference_variable *);
  65    virtual void visit(ir_dereference_array *);
  66    virtual void visit(ir_dereference_record *);
  67    virtual void visit(ir_assignment *);
  68    virtual void visit(ir_constant *);
  69    virtual void visit(ir_call *);
  70    virtual void visit(ir_return *);
  71    virtual void visit(ir_discard *);
  72    virtual void visit(ir_if *);
  73    virtual void visit(ir_loop *);
  74    virtual void visit(ir_loop_jump *);
  75    /*@}*/
  76
  77 private:
  78    /**
  79     * Fetch/generate a unique name for ir_variable.
  80     *
  81     * GLSL IR permits multiple ir_variables to share the same name.  This works
  82     * fine until we try to print it, when we really need a unique one.
  83     */
  84    const char *unique_name(ir_variable *var);
  85
  86    /** A mapping from ir_variable * -> unique printable names. */
  87    hash_table *printable_names;
  88    _mesa_symbol_table *symbols;
  89
  90    void *mem_ctx;
  91
  92    int indentation;
  93 };
  94
  95 #endif /* IR_PRINT_VISITOR_H */