source/programcompiler.h

   1 #ifndef MSP_GL_PROGRAMCOMPILER_H_
   2 #define MSP_GL_PROGRAMCOMPILER_H_
   3
   4 #include <set>
   5 #include "programparser.h"
   6 #include "programsyntax.h"
   7
   8 namespace Msp {
   9 namespace GL {
  10
  11 class Program;
  12 class Resources;
  13
  14 class ProgramCompiler
  15 {
  16 private:
  17         struct Visitor: ProgramSyntax::TraversingVisitor
  18         {
  19                 typedef void ResultType;
  20
  21                 ProgramSyntax::Stage *stage;
  22
  23                 Visitor();
  24
  25                 virtual void apply(ProgramSyntax::Stage &);
  26                 void get_result() const { }
  27         };
  28
  29         struct Formatter: Visitor
  30         {
  31                 typedef std::string ResultType;
  32
  33                 std::string formatted;
  34                 unsigned indent;
  35                 bool parameter_list;
  36                 unsigned else_if;
  37                 std::string block_interface;
  38
  39                 Formatter();
  40
  41                 virtual void apply(ProgramSyntax::Stage &);
  42                 const std::string &get_result() const { return formatted; }
  43                 virtual void visit(ProgramSyntax::Block &);
  44                 virtual void visit(ProgramSyntax::Literal &);
  45                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
  46                 virtual void visit(ProgramSyntax::VariableReference &);
  47                 virtual void visit(ProgramSyntax::MemberAccess &);
  48                 virtual void visit(ProgramSyntax::UnaryExpression &);
  49                 virtual void visit(ProgramSyntax::BinaryExpression &);
  50                 virtual void visit(ProgramSyntax::Assignment &);
  51                 virtual void visit(ProgramSyntax::FunctionCall &);
  52                 virtual void visit(ProgramSyntax::ExpressionStatement &);
  53                 virtual void visit(ProgramSyntax::Import &);
  54                 virtual void visit(ProgramSyntax::Layout &);
  55                 virtual void visit(ProgramSyntax::InterfaceLayout &);
  56                 virtual void visit(ProgramSyntax::StructDeclaration &);
  57                 virtual void visit(ProgramSyntax::VariableDeclaration &);
  58                 virtual void visit(ProgramSyntax::InterfaceBlock &);
  59                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
  60                 virtual void visit(ProgramSyntax::Conditional &);
  61                 virtual void visit(ProgramSyntax::Iteration &);
  62                 virtual void visit(ProgramSyntax::Return &);
  63         };
  64
  65         template<typename T>
  66         struct NodeGatherer: Visitor
  67         {
  68                 typedef std::list<T *> ResultType;
  69
  70                 std::list<T *> nodes;
  71
  72                 const ResultType &get_result() const { return nodes; }
  73                 virtual void visit(T &n) { nodes.push_back(&n); }
  74         };
  75
  76         struct DeclarationCombiner: Visitor
  77         {
  78                 bool toplevel;
  79                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
  80                 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
  81                 bool remove_node;
  82
  83                 DeclarationCombiner();
  84
  85                 virtual void visit(ProgramSyntax::Block &);
  86                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
  87                 virtual void visit(ProgramSyntax::VariableDeclaration &);
  88         };
  89
  90         struct VariableResolver: Visitor
  91         {
  92                 std::vector<ProgramSyntax::Block *> blocks;
  93                 ProgramSyntax::StructDeclaration *type;
  94                 bool anonymous;
  95                 std::string block_interface;
  96                 bool record_target;
  97                 ProgramSyntax::VariableDeclaration *assignment_target;
  98                 bool self_referencing;
  99
 100                 VariableResolver();
 101
 102                 virtual void apply(ProgramSyntax::Stage &);
 103                 virtual void visit(ProgramSyntax::Block &);
 104                 virtual void visit(ProgramSyntax::VariableReference &);
 105                 virtual void visit(ProgramSyntax::MemberAccess &);
 106                 virtual void visit(ProgramSyntax::BinaryExpression &);
 107                 virtual void visit(ProgramSyntax::Assignment &);
 108                 virtual void visit(ProgramSyntax::StructDeclaration &);
 109                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 110                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 111         };
 112
 113         struct FunctionResolver: Visitor
 114         {
 115                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
 116
 117                 virtual void visit(ProgramSyntax::FunctionCall &);
 118                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 119         };
 120
 121         struct BlockModifier: Visitor
 122         {
 123                 bool remove_node;
 124                 std::list<RefPtr<ProgramSyntax::Node> > insert_nodes;
 125
 126                 BlockModifier();
 127
 128                 void flatten_block(ProgramSyntax::Block &);
 129                 void apply_and_increment(ProgramSyntax::Block &, std::list<RefPtr<ProgramSyntax::Node> >::iterator &);
 130                 virtual void visit(ProgramSyntax::Block &);
 131         };
 132
 133         struct InterfaceGenerator: BlockModifier
 134         {
 135                 std::string in_prefix;
 136                 std::string out_prefix;
 137                 unsigned scope_level;
 138                 std::map<std::string, RefPtr<ProgramSyntax::VariableDeclaration> > iface_declarations;
 139
 140                 InterfaceGenerator();
 141
 142                 static std::string get_out_prefix(ProgramSyntax::StageType);
 143                 virtual void apply(ProgramSyntax::Stage &);
 144                 virtual void visit(ProgramSyntax::Block &);
 145                 std::string change_prefix(const std::string &, const std::string &) const;
 146                 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
 147                 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
 148                 virtual void visit(ProgramSyntax::VariableReference &);
 149                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 150                 virtual void visit(ProgramSyntax::Passthrough &);
 151         };
 152
 153         struct VariableRenamer: Visitor
 154         {
 155                 virtual void visit(ProgramSyntax::VariableReference &);
 156                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 157         };
 158
 159         struct DeclarationReorderer: Visitor
 160         {
 161                 enum DeclarationKind
 162                 {
 163                         NO_DECLARATION,
 164                         LAYOUT,
 165                         STRUCT,
 166                         VARIABLE,
 167                         FUNCTION
 168                 };
 169
 170                 DeclarationKind kind;
 171
 172                 DeclarationReorderer();
 173
 174                 virtual void visit(ProgramSyntax::Block &);
 175                 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
 176                 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
 177                 virtual void visit(ProgramSyntax::VariableDeclaration &) { kind = VARIABLE; }
 178                 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
 179                 virtual void visit(ProgramSyntax::FunctionDeclaration &) { kind = FUNCTION; }
 180         };
 181
 182         struct InlineableFunctionLocator: Visitor
 183         {
 184                 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
 185
 186                 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
 187                 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
 188                 ProgramSyntax::FunctionDeclaration *in_function;
 189
 190                 InlineableFunctionLocator();
 191
 192                 const ResultType &get_result() const { return inlineable; }
 193                 virtual void visit(ProgramSyntax::FunctionCall &);
 194                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 195         };
 196
 197         struct FunctionInliner: Visitor
 198         {
 199                 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
 200                 unsigned extract_result;
 201                 RefPtr<ProgramSyntax::Expression> inline_result;
 202
 203                 FunctionInliner();
 204                 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
 205
 206                 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
 207                 virtual void visit(ProgramSyntax::Block &);
 208                 virtual void visit(ProgramSyntax::UnaryExpression &);
 209                 virtual void visit(ProgramSyntax::BinaryExpression &);
 210                 virtual void visit(ProgramSyntax::FunctionCall &);
 211                 virtual void visit(ProgramSyntax::Return &);
 212         };
 213
 214         struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
 215         {
 216                 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
 217
 218                 const ValueMap *variable_values;
 219                 float result;
 220                 bool result_valid;
 221
 222                 ExpressionEvaluator();
 223                 ExpressionEvaluator(const ValueMap &);
 224
 225                 virtual void visit(ProgramSyntax::Literal &);
 226                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
 227                 virtual void visit(ProgramSyntax::VariableReference &);
 228                 virtual void visit(ProgramSyntax::UnaryExpression &);
 229                 virtual void visit(ProgramSyntax::BinaryExpression &);
 230         };
 231
 232         struct ConstantConditionEliminator: BlockModifier
 233         {
 234                 unsigned scope_level;
 235                 ExpressionEvaluator::ValueMap variable_values;
 236
 237                 ConstantConditionEliminator();
 238
 239                 virtual void visit(ProgramSyntax::Block &);
 240                 virtual void visit(ProgramSyntax::Assignment &);
 241                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 242                 virtual void visit(ProgramSyntax::Conditional &);
 243                 virtual void visit(ProgramSyntax::Iteration &);
 244         };
 245
 246         struct UnusedVariableLocator: Visitor
 247         {
 248                 struct AssignmentList
 249                 {
 250                         std::vector<ProgramSyntax::Node *> nodes;
 251                         bool conditional;
 252                         bool self_referencing;
 253                 };
 254
 255                 typedef std::set<ProgramSyntax::Node *> ResultType;
 256                 typedef std::map<ProgramSyntax::VariableDeclaration *, AssignmentList> BlockAssignmentMap;
 257
 258                 std::set<ProgramSyntax::Node *> unused_nodes;
 259                 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
 260                 ProgramSyntax::Node *aggregate;
 261                 std::vector<BlockAssignmentMap> assignments;
 262                 ProgramSyntax::Assignment *assignment;
 263                 bool assignment_target;
 264
 265                 UnusedVariableLocator();
 266
 267                 virtual void apply(ProgramSyntax::Stage &);
 268                 const ResultType &get_result() const { return unused_nodes; }
 269                 virtual void visit(ProgramSyntax::VariableReference &);
 270                 virtual void visit(ProgramSyntax::MemberAccess &);
 271                 virtual void visit(ProgramSyntax::BinaryExpression &);
 272                 virtual void visit(ProgramSyntax::Assignment &);
 273                 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
 274                 virtual void visit(ProgramSyntax::ExpressionStatement &);
 275                 virtual void visit(ProgramSyntax::StructDeclaration &);
 276                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 277                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 278                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 279                 void merge_down_assignments();
 280                 virtual void visit(ProgramSyntax::Conditional &);
 281                 virtual void visit(ProgramSyntax::Iteration &);
 282         };
 283
 284         struct UnusedFunctionLocator: Visitor
 285         {
 286                 typedef std::set<ProgramSyntax::Node *> ResultType;
 287
 288                 std::set<ProgramSyntax::Node *> unused_nodes;
 289                 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
 290
 291                 const ResultType &get_result() const { return unused_nodes; }
 292                 virtual void visit(ProgramSyntax::FunctionCall &);
 293                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 294         };
 295
 296         struct NodeRemover: Visitor
 297         {
 298                 std::set<ProgramSyntax::Node *> to_remove;
 299
 300                 NodeRemover() { }
 301                 NodeRemover(const std::set<ProgramSyntax::Node *> &);
 302
 303                 virtual void visit(ProgramSyntax::Block &);
 304                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 305         };
 306
 307         struct LegacyConverter: BlockModifier
 308         {
 309                 Version target_version;
 310                 std::string type;
 311                 std::string frag_out_name;
 312
 313                 LegacyConverter();
 314                 LegacyConverter(const Version &);
 315
 316                 bool check_version(const Version &);
 317                 virtual void visit(ProgramSyntax::VariableReference &);
 318                 virtual void visit(ProgramSyntax::FunctionCall &);
 319                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 320                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 321         };
 322
 323         Resources *resources;
 324         ProgramParser parser;
 325         ProgramSyntax::Module *module;
 326
 327 public:
 328         ProgramCompiler();
 329
 330         void compile(const std::string &);
 331         void compile(IO::Base &, Resources * = 0);
 332         void add_shaders(Program &);
 333
 334 private:
 335         static ProgramSyntax::Module *create_builtins_module();
 336         static ProgramSyntax::Module &get_builtins_module();
 337         static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
 338         void process();
 339         void import(const std::string &);
 340         void generate(ProgramSyntax::Stage &);
 341         bool optimize(ProgramSyntax::Stage &);
 342         static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
 343         template<typename T>
 344         static typename T::ResultType apply(ProgramSyntax::Stage &);
 345         template<typename T, typename A>
 346         static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);
 347 };
 348
 349 } // namespace GL
 350 } // namespace Msp
 351
 352 #endif