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