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 BlockModifier: Visitor
  30         {
  31                 bool remove_node;
  32                 std::vector<RefPtr<ProgramSyntax::Statement> > insert_nodes;
  33
  34                 BlockModifier();
  35
  36                 void flatten_block(ProgramSyntax::Block &);
  37                 void apply_and_increment(ProgramSyntax::Block &, ProgramSyntax::NodeList<ProgramSyntax::Statement>::iterator &);
  38                 using Visitor::visit;
  39                 virtual void visit(ProgramSyntax::Block &);
  40         };
  41
  42         struct Formatter: Visitor
  43         {
  44                 typedef std::string ResultType;
  45
  46                 std::string formatted;
  47                 unsigned indent;
  48                 bool parameter_list;
  49                 std::string block_interface;
  50
  51                 Formatter();
  52
  53                 virtual void apply(ProgramSyntax::Stage &);
  54                 const std::string &get_result() const { return formatted; }
  55                 using Visitor::visit;
  56                 void append(const std::string &);
  57                 void append(char);
  58                 virtual void visit(ProgramSyntax::Block &);
  59                 virtual void visit(ProgramSyntax::Literal &);
  60                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
  61                 virtual void visit(ProgramSyntax::VariableReference &);
  62                 virtual void visit(ProgramSyntax::MemberAccess &);
  63                 virtual void visit(ProgramSyntax::UnaryExpression &);
  64                 virtual void visit(ProgramSyntax::BinaryExpression &);
  65                 virtual void visit(ProgramSyntax::Assignment &);
  66                 virtual void visit(ProgramSyntax::FunctionCall &);
  67                 virtual void visit(ProgramSyntax::ExpressionStatement &);
  68                 virtual void visit(ProgramSyntax::Import &);
  69                 virtual void visit(ProgramSyntax::Precision &);
  70                 virtual void visit(ProgramSyntax::Layout &);
  71                 virtual void visit(ProgramSyntax::InterfaceLayout &);
  72                 virtual void visit(ProgramSyntax::StructDeclaration &);
  73                 virtual void visit(ProgramSyntax::VariableDeclaration &);
  74                 virtual void visit(ProgramSyntax::InterfaceBlock &);
  75                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
  76                 virtual void visit(ProgramSyntax::Conditional &);
  77                 virtual void visit(ProgramSyntax::Iteration &);
  78                 virtual void visit(ProgramSyntax::Return &);
  79                 virtual void visit(ProgramSyntax::Jump &);
  80         };
  81
  82         template<typename T>
  83         struct NodeGatherer: Visitor
  84         {
  85                 typedef std::vector<T *> ResultType;
  86
  87                 std::vector<T *> nodes;
  88
  89                 const ResultType &get_result() const { return nodes; }
  90                 using Visitor::visit;
  91                 virtual void visit(T &n) { nodes.push_back(&n); }
  92         };
  93
  94         struct DeclarationCombiner: BlockModifier
  95         {
  96                 bool toplevel;
  97                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
  98                 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
  99
 100                 DeclarationCombiner();
 101
 102                 using Visitor::visit;
 103                 virtual void visit(ProgramSyntax::Block &);
 104                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 105                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 106         };
 107
 108         struct VariableResolver: Visitor
 109         {
 110                 std::vector<ProgramSyntax::Block *> blocks;
 111                 ProgramSyntax::StructDeclaration *type;
 112                 bool anonymous;
 113                 std::string block_interface;
 114                 bool record_target;
 115                 ProgramSyntax::VariableDeclaration *assignment_target;
 116                 bool self_referencing;
 117
 118                 VariableResolver();
 119
 120                 virtual void apply(ProgramSyntax::Stage &);
 121                 using Visitor::visit;
 122                 virtual void visit(ProgramSyntax::Block &);
 123                 virtual void visit(ProgramSyntax::VariableReference &);
 124                 virtual void visit(ProgramSyntax::MemberAccess &);
 125                 virtual void visit(ProgramSyntax::BinaryExpression &);
 126                 virtual void visit(ProgramSyntax::Assignment &);
 127                 virtual void visit(ProgramSyntax::StructDeclaration &);
 128                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 129                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 130         };
 131
 132         struct FunctionResolver: Visitor
 133         {
 134                 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
 135
 136                 using Visitor::visit;
 137                 virtual void visit(ProgramSyntax::FunctionCall &);
 138                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 139         };
 140
 141         struct InterfaceGenerator: BlockModifier
 142         {
 143                 std::string in_prefix;
 144                 std::string out_prefix;
 145                 unsigned scope_level;
 146                 std::map<std::string, RefPtr<ProgramSyntax::VariableDeclaration> > iface_declarations;
 147
 148                 InterfaceGenerator();
 149
 150                 static std::string get_out_prefix(ProgramSyntax::StageType);
 151                 virtual void apply(ProgramSyntax::Stage &);
 152                 using Visitor::visit;
 153                 virtual void visit(ProgramSyntax::Block &);
 154                 std::string change_prefix(const std::string &, const std::string &) const;
 155                 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
 156                 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
 157                 virtual void visit(ProgramSyntax::VariableReference &);
 158                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 159                 virtual void visit(ProgramSyntax::Passthrough &);
 160         };
 161
 162         struct DeclarationReorderer: Visitor
 163         {
 164                 enum DeclarationKind
 165                 {
 166                         NO_DECLARATION,
 167                         LAYOUT,
 168                         STRUCT,
 169                         VARIABLE,
 170                         FUNCTION
 171                 };
 172
 173                 unsigned scope_level;
 174                 DeclarationKind kind;
 175                 std::set<ProgramSyntax::Node *> ordered_funcs;
 176                 std::set<ProgramSyntax::Node *> needed_funcs;
 177
 178                 DeclarationReorderer();
 179
 180                 using Visitor::visit;
 181                 virtual void visit(ProgramSyntax::Block &);
 182                 virtual void visit(ProgramSyntax::FunctionCall &);
 183                 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
 184                 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
 185                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 186                 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
 187                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 188         };
 189
 190         struct InlineableFunctionLocator: Visitor
 191         {
 192                 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
 193
 194                 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
 195                 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
 196                 ProgramSyntax::FunctionDeclaration *in_function;
 197
 198                 InlineableFunctionLocator();
 199
 200                 const ResultType &get_result() const { return inlineable; }
 201                 using Visitor::visit;
 202                 virtual void visit(ProgramSyntax::FunctionCall &);
 203                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 204         };
 205
 206         struct FunctionInliner: Visitor
 207         {
 208                 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
 209                 unsigned extract_result;
 210                 RefPtr<ProgramSyntax::Expression> inline_result;
 211
 212                 FunctionInliner();
 213                 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
 214
 215                 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
 216                 using Visitor::visit;
 217                 virtual void visit(ProgramSyntax::Block &);
 218                 virtual void visit(ProgramSyntax::UnaryExpression &);
 219                 virtual void visit(ProgramSyntax::BinaryExpression &);
 220                 virtual void visit(ProgramSyntax::MemberAccess &);
 221                 virtual void visit(ProgramSyntax::FunctionCall &);
 222                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 223                 virtual void visit(ProgramSyntax::Return &);
 224         };
 225
 226         struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
 227         {
 228                 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
 229
 230                 const ValueMap *variable_values;
 231                 float result;
 232                 bool result_valid;
 233
 234                 ExpressionEvaluator();
 235                 ExpressionEvaluator(const ValueMap &);
 236
 237                 using ProgramSyntax::NodeVisitor::visit;
 238                 virtual void visit(ProgramSyntax::Literal &);
 239                 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
 240                 virtual void visit(ProgramSyntax::VariableReference &);
 241                 virtual void visit(ProgramSyntax::UnaryExpression &);
 242                 virtual void visit(ProgramSyntax::BinaryExpression &);
 243         };
 244
 245         struct ConstantConditionEliminator: BlockModifier
 246         {
 247                 unsigned scope_level;
 248                 bool record_only;
 249                 ExpressionEvaluator::ValueMap variable_values;
 250
 251                 ConstantConditionEliminator();
 252
 253                 using Visitor::visit;
 254                 virtual void visit(ProgramSyntax::Block &);
 255                 virtual void visit(ProgramSyntax::UnaryExpression &);
 256                 virtual void visit(ProgramSyntax::Assignment &);
 257                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 258                 virtual void visit(ProgramSyntax::Conditional &);
 259                 virtual void visit(ProgramSyntax::Iteration &);
 260         };
 261
 262         struct UnusedVariableLocator: Visitor
 263         {
 264                 struct VariableInfo
 265                 {
 266                         bool local;
 267                         std::vector<ProgramSyntax::Node *> assignments;
 268                         bool conditionally_assigned;
 269                         bool referenced;
 270
 271                         VariableInfo();
 272                 };
 273
 274                 typedef std::set<ProgramSyntax::Node *> ResultType;
 275                 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
 276
 277                 std::set<ProgramSyntax::Node *> unused_nodes;
 278                 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
 279                 ProgramSyntax::Node *aggregate;
 280                 std::vector<BlockVariableMap> variables;
 281                 ProgramSyntax::Assignment *assignment;
 282                 bool assignment_target;
 283                 bool assign_to_subscript;
 284                 bool global_scope;
 285
 286                 UnusedVariableLocator();
 287
 288                 virtual void apply(ProgramSyntax::Stage &);
 289                 const ResultType &get_result() const { return unused_nodes; }
 290                 using Visitor::visit;
 291                 virtual void visit(ProgramSyntax::VariableReference &);
 292                 virtual void visit(ProgramSyntax::MemberAccess &);
 293                 virtual void visit(ProgramSyntax::BinaryExpression &);
 294                 virtual void visit(ProgramSyntax::Assignment &);
 295                 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
 296                 void clear_assignments(VariableInfo &, bool);
 297                 virtual void visit(ProgramSyntax::ExpressionStatement &);
 298                 virtual void visit(ProgramSyntax::StructDeclaration &);
 299                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 300                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 301                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 302                 void merge_down_variables();
 303                 virtual void visit(ProgramSyntax::Conditional &);
 304                 virtual void visit(ProgramSyntax::Iteration &);
 305         };
 306
 307         struct UnusedFunctionLocator: Visitor
 308         {
 309                 typedef std::set<ProgramSyntax::Node *> ResultType;
 310
 311                 std::set<ProgramSyntax::Node *> unused_nodes;
 312                 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
 313
 314                 const ResultType &get_result() const { return unused_nodes; }
 315                 using Visitor::visit;
 316                 virtual void visit(ProgramSyntax::FunctionCall &);
 317                 virtual void visit(ProgramSyntax::FunctionDeclaration &);
 318         };
 319
 320         struct NodeRemover: Visitor
 321         {
 322                 std::set<ProgramSyntax::Node *> to_remove;
 323
 324                 NodeRemover() { }
 325                 NodeRemover(const std::set<ProgramSyntax::Node *> &);
 326
 327                 using Visitor::visit;
 328                 virtual void visit(ProgramSyntax::Block &);
 329                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 330                 virtual void visit(ProgramSyntax::Iteration &);
 331         };
 332
 333         struct PrecisionRemover: BlockModifier
 334         {
 335                 using Visitor::visit;
 336                 virtual void visit(ProgramSyntax::Precision &);
 337                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 338         };
 339
 340         struct DefaultPrecisionGenerator: BlockModifier
 341         {
 342                 bool toplevel;
 343                 std::set<std::string> have_default;
 344
 345                 DefaultPrecisionGenerator();
 346
 347                 using Visitor::visit;
 348                 virtual void visit(ProgramSyntax::Block &);
 349                 virtual void visit(ProgramSyntax::Precision &);
 350                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 351         };
 352
 353         struct LegacyConverter: BlockModifier
 354         {
 355                 GLApi target_api;
 356                 Version target_version;
 357                 std::string type;
 358                 ProgramSyntax::VariableDeclaration *frag_out;
 359
 360                 LegacyConverter();
 361                 LegacyConverter(const Version &);
 362
 363                 bool check_version(const Version &) const;
 364                 bool check_extension(const Extension &) const;
 365                 using Visitor::visit;
 366                 bool supports_unified_interface_syntax() const;
 367                 virtual void visit(ProgramSyntax::VariableReference &);
 368                 virtual void visit(ProgramSyntax::Assignment &);
 369                 bool supports_unified_sampling_functions() const;
 370                 virtual void visit(ProgramSyntax::FunctionCall &);
 371                 bool supports_interface_layouts() const;
 372                 bool supports_centroid_sampling() const;
 373                 bool supports_sample_sampling() const;
 374                 virtual void visit(ProgramSyntax::VariableDeclaration &);
 375                 bool supports_interface_blocks(const std::string &) const;
 376                 virtual void visit(ProgramSyntax::InterfaceBlock &);
 377         };
 378
 379         Resources *resources;
 380         ProgramSyntax::Module *module;
 381         std::set<std::string> imported_names;
 382
 383 public:
 384         ProgramCompiler();
 385         ~ProgramCompiler();
 386
 387         void compile(const std::string &, const std::string & = "<string>");
 388         void compile(IO::Base &, Resources * = 0, const std::string & = "<file>");
 389         void compile(IO::Base &, const std::string &);
 390         void add_shaders(Program &);
 391
 392 private:
 393         static ProgramSyntax::Module *create_builtins_module();
 394         static ProgramSyntax::Module &get_builtins_module();
 395         static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
 396         void append_module(ProgramSyntax::Module &);
 397         void append_stage(ProgramSyntax::Stage &);
 398         void process();
 399         void import(const std::string &);
 400         void generate(ProgramSyntax::Stage &);
 401         bool optimize(ProgramSyntax::Stage &);
 402         void finalize(ProgramSyntax::Stage &);
 403         static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
 404         template<typename T>
 405         static typename T::ResultType apply(ProgramSyntax::Stage &);
 406         template<typename T, typename A>
 407         static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);
 408 };
 409
 410 } // namespace GL
 411 } // namespace Msp
 412
 413 #endif