source/programbuilder.cpp

   1 #include <algorithm>
   2 #include <cstring>
   3 #include <set>
   4 #include <msp/gl/extensions/arb_uniform_buffer_object.h>
   5 #include <msp/strings/format.h>
   6 #include <msp/strings/utils.h>
   7 #include "extension.h"
   8 #include "program.h"
   9 #include "programbuilder.h"
  10 #include "shader.h"
  11 #include "vertexformat.h"
  12
  13 using namespace std;
  14
  15 namespace Msp {
  16 namespace GL {
  17
  18 /*
  19 Naming conventions:
  20   n_*        Normalized vector
  21   l_*        Lighting component
  22
  23   obj_*      Object space
  24   eye_*      Eye space
  25   tbn_*      Tangent-Binormal-Normal space
  26   shd_*      Shadow space
  27   env_*      Environment space
  28   *_dir      Direction vector
  29
  30   zzz_*      Wildcard space, resolved by the builder
  31              All wildcard spaces within an expression must match
  32
  33   xxx_yyy_*  Matrix that transforms between yyy to xxx
  34              The vector is on the side of its designated space, result will be
  35              in the other space
  36   *_matrix   A matrix (duh)
  37   *_rmatrix  A mat4 that works with a row vector
  38
  39   rgb_*      Color with rgb components only
  40   color_*    Color with rgba components
  41 */
  42
  43 /* The array is stored in reverse order, so that variables always come after
  44 anything that might need them. */
  45 const ProgramBuilder::VariableDefinition ProgramBuilder::standard_variables[] =
  46 {
  47         { FRAGMENT, "gl_FragColor", "vec4", "frag_color", 0 },
  48         { FRAGMENT, "frag_color", "vec4", "basic_color", "!e!l" },
  49         { FRAGMENT, "frag_color", "vec4", "vec4(rgb_surface, surface_alpha)", "!el" },
  50         { FRAGMENT, "frag_color", "vec4", "vec4(rgb_surface+rgb_reflection, surface_alpha)", "e" },
  51
  52         { FRAGMENT, "rgb_reflection", "vec3", "reflect_sample.rgb*reflectivity", 0 },
  53         { FRAGMENT, "reflect_sample", "vec4", "textureCube(environment, env_reflect_dir)", 0 },
  54         { FRAGMENT, "env_reflect_dir", "vec3", "env_eye_matrix*eye_reflect_dir", 0 },
  55         { FRAGMENT, "eye_reflect_dir", "vec3", "eye_tbn_matrix*tbn_reflect_dir", "n" },
  56
  57         { FRAGMENT, "rgb_surface", "vec3", "rgb_unlit_surface", "!l" },
  58         { FRAGMENT, "rgb_surface", "vec3", "rgb_lit_surface", "l" },
  59         { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb", "!s" },
  60         { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb*l_shadow", "s" },
  61         { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse", "!m!t" },
  62         { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse*diffuse_sample.rgb", "!mt" },
  63         { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse", "m!p" },
  64         { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse+rgb_surface_specular", "mp" },
  65
  66         { FRAGMENT, "surface_alpha", "float", "basic_color.a", "!m" },
  67         { FRAGMENT, "surface_alpha", "float", "basic_color.a", "m!l" },
  68         { FRAGMENT, "surface_alpha", "float", "material.diffuse.a", "ml!t" },
  69         { FRAGMENT, "surface_alpha", "float", "material.diffuse.a*diffuse_sample.a", "mlt" },
  70         { FRAGMENT, "basic_color", "vec4", "vec4(1.0)", "!m!t" },
  71         { FRAGMENT, "basic_color", "vec4", "diffuse_sample", "!mt" },
  72         { FRAGMENT, "basic_color", "vec4", "color", "m!t" },
  73         { FRAGMENT, "basic_color", "vec4", "color*diffuse_sample", "mt" },
  74
  75         { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb", "!t" },
  76         { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb*diffuse_sample.rgb", "t" },
  77         { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb", "!y" },
  78         { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb+l_skylight*sky_color.rgb", "y" },
  79         { FRAGMENT, "l_skylight", "float", "dot(n_zzz_normal, zzz_sky_dir)*0.5+0.5", 0 },
  80
  81         { FRAGMENT, "rgb_surface_specular", "vec3", "rgb_illumination_specular*material.specular.rgb", 0 },
  82         { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct", "!y|e" },
  83         { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct+l_sky_specular*sky_color.rgb", "y!e" },
  84         { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular", "!s" },
  85         { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular*l_shadow", "s" },
  86         { FRAGMENT, "rgb_light_specular[i]", "vec3", "l_specular[i]*light_sources[i].specular.rgb", 0 },
  87         { FRAGMENT, "l_sky_specular", "float", "pow((1.0-pow(clamp(dot(zzz_reflect_dir, zzz_sky_dir)-horizon_limit, -1.0, 0.0), 2.0)), material.shininess/2.0)", 0 },
  88         { FRAGMENT, "l_specular[i]", "float", "pow(max(dot(n_zzz_half_vec[i], n_zzz_normal), 0.0), material.shininess)", 0 },
  89
  90         { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb", "!t" },
  91         { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb*diffuse_sample.rgb", "t" },
  92         { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse", "!s" },
  93         { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse*l_shadow", "s" },
  94         { FRAGMENT, "rgb_light_diffuse[i]", "vec3", "l_diffuse[i]*light_sources[i].diffuse.rgb", 0 },
  95         { FRAGMENT, "l_diffuse[i]", "float", "max(dot(n_zzz_normal, n_zzz_light_dir[i]), 0.0)", 0 },
  96
  97         { FRAGMENT, "l_shadow", "float", "mix(1.0, shadow_sample, shadow_darkness)", 0 },
  98         { FRAGMENT, "shadow_sample", "float", "shadow2D(shadow, shd_vertex)", 0 },
  99
 100         { FRAGMENT, "zzz_reflect_dir", "vec3", "reflect(zzz_incident_dir, n_zzz_normal)", 0 },
 101         { FRAGMENT, "n_zzz_half_vec[i]", "vec3", "normalize(zzz_light_dir[i]-zzz_incident_dir)", 0 },
 102         { FRAGMENT, "n_zzz_light_dir[i]", "vec3", "normalize(zzz_light_dir[i])", 0 },
 103         { FRAGMENT, "n_tbn_normal", "vec3", "normal_sample*2.0-1.0", "n" },
 104         { FRAGMENT, "n_eye_normal", "vec3", "normalize(eye_normal)", "!n" },
 105         { FRAGMENT, "normal_sample", "vec3", "texture2D(normalmap, texture_coord).xyz", 0 },
 106         { FRAGMENT, "diffuse_sample", "vec4", "texture2D(diffusemap, texture_coord)", 0 },
 107
 108         { VERTEX, "gl_Position", "vec4", "projection_matrix*eye_vertex", 0 },
 109         { VERTEX, "shd_vertex", "vec3", "(shd_eye_matrix*eye_vertex).xyz", 0 },
 110         { VERTEX, "tbn_sky_dir", "vec3", "eye_sky_dir*eye_tbn_matrix", "n" },
 111         { VERTEX, "tbn_light_dir[i]", "vec3", "eye_light_dir[i]*eye_tbn_matrix", 0 },
 112         { VERTEX, "eye_light_dir[i]", "vec3", "normalize(eye_light_position[i].xyz-eye_vertex.xyz*eye_light_position[i].w)", 0 },
 113         { VERTEX, "eye_light_position[i]", "vec4", "light_sources[i].position", 0 },
 114         { VERTEX, "tbn_incident_dir", "vec3", "eye_incident_dir*eye_tbn_matrix", 0 },
 115         { VERTEX, "eye_incident_dir", "vec3", "normalize(eye_vertex.xyz)", 0 },
 116         { VERTEX, "eye_tbn_matrix", "mat3", "mat3(eye_tangent, eye_binormal, eye_normal)", 0 },
 117         { VERTEX, "eye_vertex", "vec4", "eye_obj_matrix*vertex", 0 },
 118         { VERTEX, "eye_normal", "vec3", "eye_obj_normal_matrix*normal", 0 },
 119         { VERTEX, "eye_tangent", "vec3", "eye_obj_normal_matrix*tangent", 0 },
 120         { VERTEX, "eye_binormal", "vec3", "eye_obj_normal_matrix*binormal", 0 },
 121         { VERTEX, "texture_coord", "vec2", "texcoord.xy", 0 },
 122
 123         { ATTRIBUTE, "vertex", "vec4", "gl_Vertex", 0 },
 124         { ATTRIBUTE, "texcoord", "vec4", "gl_MultiTexCoord0", 0 },
 125         { ATTRIBUTE, "color", "vec4", "gl_Color", 0 },
 126         { ATTRIBUTE, "normal", "vec3", "gl_Normal", 0 },
 127         { ATTRIBUTE, "tangent", "vec3", 0, 0 },
 128         { ATTRIBUTE, "binormal", "vec3", 0, 0 },
 129
 130         { UNIFORM, "diffusemap", "sampler2D", 0, 0 },
 131         { UNIFORM, "shadow", "sampler2DShadow", 0, 0 },
 132         { UNIFORM, "ShadowMap::shadow_darkness", "float", 0, 0 },
 133         { UNIFORM, "normalmap", "sampler2D", 0, 0 },
 134         { UNIFORM, "environment", "samplerCube", 0, 0 },
 135         { UNIFORM, "EnvMap::env_eye_matrix", "mat3", 0, 0 },
 136         { UNIFORM, "Material::reflectivity", "float", 0, 0 },
 137         { UNIFORM, "eye_obj_matrix", "mat4", "gl_ModelViewMatrix", 0 },
 138         { UNIFORM, "eye_obj_normal_matrix", "mat3", "gl_NormalMatrix", 0 },
 139         { UNIFORM, "Transform::projection_matrix", "mat4", "gl_ProjectionMatrix", 0 },
 140         { UNIFORM, "ShadowMap::shd_eye_matrix", "mat4", 0, 0 },
 141         { UNIFORM, "Lighting::light_sources", "LightSourceParameters[MAX_LIGHTS]", "gl_LightSource[i]", 0 },
 142         { UNIFORM, "Lighting::ambient_color", "vec4", "gl_LightModel.ambient", 0 },
 143         { UNIFORM, "Lighting::sky_color", "vec4", 0, 0 },
 144         { UNIFORM, "Lighting::eye_sky_dir", "vec3", 0, 0 },
 145         { UNIFORM, "Lighting::horizon_limit", "float", 0, 0 },
 146         { UNIFORM, "Material::material", "MaterialParameters", "gl_FrontMaterial", 0 },
 147
 148         { TYPE, "LightSourceParameters", "struct { vec4 position; vec4 diffuse; vec4 specular; }", "gl_LightSourceParameters", 0 },
 149         { TYPE, "MaterialParameters", "struct { vec4 ambient; vec4 diffuse; vec4 specular; float shininess; }", "gl_MaterialParameters", 0 },
 150
 151         // Terminator entry
 152         { NO_SCOPE, 0, 0, 0, 0 }
 153 };
 154
 155 const char ProgramBuilder::interfaces[] = { 0, 0, 0, 0, 'v', 0 };
 156
 157 ProgramBuilder::ProgramBuilder(const StandardFeatures &f):
 158         features(f),
 159         feature_flags(features.create_flags()),
 160         optimize(true)
 161 {
 162         if(!features.custom.empty())
 163         {
 164                 const char *whitespace = " \t\n";
 165                 string::size_type start = 0;
 166                 while(1)
 167                 {
 168                         start = features.custom.find_first_not_of(whitespace, start);
 169                         if(start==string::npos)
 170                                 break;
 171
 172                         string::size_type semicolon = features.custom.find(';', start);
 173                         if(semicolon==start)
 174                         {
 175                                 ++start;
 176                                 continue;
 177                         }
 178                         else if(semicolon==string::npos)
 179                                 throw invalid_variable_definition(features.custom.substr(start));
 180
 181                         string::size_type equals = features.custom.find('=', start);
 182                         if(equals>semicolon)
 183                                 equals = string::npos;
 184
 185                         VariableDefinition var;
 186                         string::size_type decl_end = min(equals, semicolon);
 187                         for(unsigned i=0;; ++i)
 188                         {
 189                                 string::size_type word_end = features.custom.find_first_of(whitespace, start);
 190                                 word_end = min(word_end, decl_end);
 191                                 features.custom[word_end] = 0;
 192
 193                                 const char *word = &features.custom[start];
 194                                 if(i==0)
 195                                 {
 196                                         if(!strcmp(word, "uniform"))
 197                                                 var.scope = UNIFORM;
 198                                         else if(!strcmp(word, "attribute"))
 199                                                 var.scope = ATTRIBUTE;
 200                                         else if(!strcmp(word, "vertex"))
 201                                                 var.scope = VERTEX;
 202                                         else if(!strcmp(word, "fragment"))
 203                                                 var.scope = FRAGMENT;
 204                                         else
 205                                                 throw invalid_variable_definition(word);
 206                                 }
 207                                 else if(i==1)
 208                                         var.type = word;
 209                                 else if(i==2)
 210                                         var.name = word;
 211
 212                                 start = features.custom.find_first_not_of(whitespace, word_end+1);
 213                                 if(start>=decl_end)
 214                                         break;
 215                         }
 216
 217                         if(equals!=string::npos)
 218                         {
 219                                 start = features.custom.find_first_not_of(whitespace, equals+1);
 220                                 if(start>=semicolon)
 221                                         throw invalid_variable_definition("no expression");
 222                                 features.custom[semicolon] = 0;
 223                                 var.expression = &features.custom[start];
 224                         }
 225                         else
 226                                 var.expression = 0;
 227
 228                         var.flags = 0;
 229                         for(const VariableDefinition *j=standard_variables; j->name; ++j)
 230                                 if(!strcmp(var.name, j->name))
 231                                         var.flags = "o";
 232
 233                         custom_variables.push_front(var);
 234
 235                         start = semicolon+1;
 236                 }
 237         }
 238
 239         if(!features.legacy)
 240         {
 241                 aliases["texture2D"] = "texture";
 242                 aliases["shadow2D"] = "texture";
 243         }
 244         else
 245                 aliases["shadow2D"] = "shadow2D(...).r";
 246 }
 247
 248 void ProgramBuilder::set_optimize(bool o)
 249 {
 250         optimize = o;
 251 }
 252
 253 Program *ProgramBuilder::create_program() const
 254 {
 255         Program *prog = new Program;
 256         add_shaders(*prog);
 257         return prog;
 258 }
 259
 260 void ProgramBuilder::add_shaders(Program &prog) const
 261 {
 262         list<ShaderVariable> variables;
 263         list<ShaderVariable *> resolved_vars;
 264
 265         variables.push_front(ShaderVariable("gl_Position"));
 266         variables.push_front(ShaderVariable(features.legacy ? "gl_FragColor" : "frag_color"));
 267
 268         list<VariableDefinition>::const_iterator next_custom = custom_variables.begin();
 269         for(const VariableDefinition *i=standard_variables; i->name; )
 270         {
 271                 const VariableDefinition *def = 0;
 272                 if(next_custom!=custom_variables.end() && (!strcmp(next_custom->name, i->name) || !next_custom->flags))
 273                 {
 274                         def = &*next_custom;
 275                         ++next_custom;
 276                 }
 277                 else
 278                 {
 279                         def = i;
 280                         ++i;
 281
 282                         // Skip over anything that isn't used with the supplied flags
 283                         if(def->flags && !evaluate_flags(def->flags))
 284                                 continue;
 285                 }
 286
 287                 if(def->scope==TYPE)
 288                 {
 289                         for(list<ShaderVariable *>::iterator j=resolved_vars.begin(); j!=resolved_vars.end(); ++j)
 290                                 if(!(*j)->type && name_match(def->name, (*j)->variable->type))
 291                                         (*j)->resolve_type(*def);
 292
 293                         continue;
 294                 }
 295
 296                 const char *def_uq_name = unqualified_name(def->name);
 297
 298                 // See if this variable can satisfy any unresolved variables
 299                 ShaderVariable *last_resolved = 0;
 300                 for(list<ShaderVariable>::iterator j=variables.begin(); j!=variables.end(); ++j)
 301                 {
 302                         if(j->variable)
 303                                 continue;
 304
 305                         if(!name_match(def_uq_name, j->resolved_name.c_str()))
 306                                 continue;
 307
 308                         if(last_resolved)
 309                         {
 310                                 /* We've already resolved a non-fuzzy variable in this iteration.
 311                                 If there are multiple variables that can be resolved, they refer
 312                                 to the same variable. */
 313                                 j->resolve(*last_resolved);
 314                                 continue;
 315                         }
 316
 317                         j->resolve(*def);
 318                         resolved_vars.push_front(&*j);
 319                         if(!j->fuzzy_space)
 320                                 last_resolved = &*j;
 321
 322                         if(!def->expression)
 323                                 continue;
 324
 325                         vector<string> identifiers = extract_identifiers(def->expression);
 326                         for(vector<string>::const_iterator k=identifiers.begin(); k!=identifiers.end(); ++k)
 327                         {
 328                                 // Use an existing variable if possible, but only if it's not fuzzy
 329                                 ShaderVariable *var = 0;
 330                                 for(list<ShaderVariable>::iterator l=variables.begin(); (!var && l!=variables.end()); ++l)
 331                                         if(!l->fuzzy_space && l->resolved_name==*k)
 332                                                 var = &*l;
 333
 334                                 if(!var)
 335                                 {
 336                                         variables.push_back(ShaderVariable(*k));
 337                                         var = &variables.back();
 338                                 }
 339                                 j->add_reference(*var);
 340                         }
 341                 }
 342         }
 343
 344         // Array sizes need to be resolved for inline processing
 345         for(list<ShaderVariable>::iterator i=variables.end(); i!=variables.begin(); )
 346                 (--i)->resolve_array(features);
 347
 348         bool legacy_variables = evaluate_flags("g");
 349         for(list<ShaderVariable *>::const_iterator i=resolved_vars.begin(); i!=resolved_vars.end(); ++i)
 350                 (*i)->check_inline(legacy_variables, !optimize);
 351
 352         prog.attach_shader_owned(new VertexShader(create_source(resolved_vars, VERTEX)));
 353         prog.attach_shader_owned(new FragmentShader(create_source(resolved_vars, FRAGMENT)));
 354
 355         if(!features.legacy)
 356         {
 357                 // OpenGL ES does not support binding fragment shader outputs
 358                 if(get_gl_api()!=OPENGL_ES2)
 359                         prog.bind_fragment_data(0, "frag_color");
 360
 361                 prog.bind_attribute(VERTEX4, "vertex");
 362                 if(features.lighting)
 363                         prog.bind_attribute(NORMAL3, "normal");
 364                 else if(features.material)
 365                         prog.bind_attribute(COLOR4_FLOAT, "color");
 366                 if(features.texture || features.normalmap)
 367                         prog.bind_attribute(TEXCOORD4, "texcoord");
 368         }
 369         if(features.normalmap)
 370         {
 371                 prog.bind_attribute(get_component_type(TANGENT3), "tangent");
 372                 prog.bind_attribute(get_component_type(BINORMAL3), "binormal");
 373         }
 374 }
 375
 376 string ProgramBuilder::create_source(const list<ShaderVariable *> &variables, VariableScope scope) const
 377 {
 378         string source;
 379
 380         bool use_blocks = !features.legacy && ARB_uniform_buffer_object;
 381
 382         if(!features.legacy)
 383         {
 384                 if(get_gl_api()==OPENGL_ES2)
 385                 {
 386                         if(use_blocks)
 387                                 source += "#version 300 es\n";
 388                 }
 389                 else
 390                 {
 391                         source += "#version 130\n";
 392                         if(use_blocks)
 393                                 source += "#extension GL_ARB_uniform_buffer_object: require\n";
 394                 }
 395         }
 396
 397         if(get_gl_api()==OPENGL_ES2)
 398                 source += "precision mediump float;\n";
 399
 400         set<const VariableDefinition *> declared_types;
 401         set<string> uniform_blocks;
 402         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 403                 if((*i)->variable->scope==UNIFORM && (*i)->is_referenced_from(scope) && !(*i)->inlined)
 404                 {
 405                         if((*i)->type && !declared_types.count((*i)->type))
 406                         {
 407                                 source += format("%s;\n", (*i)->create_type_declaration());
 408                                 declared_types.insert((*i)->type);
 409                         }
 410
 411                         if(!(*i)->resolved_block.empty() && use_blocks)
 412                                 uniform_blocks.insert((*i)->resolved_block);
 413                         else
 414                                 source += format("uniform %s;\n", (*i)->create_declaration());
 415                 }
 416
 417         for(set<string>::const_iterator i=uniform_blocks.begin(); i!=uniform_blocks.end(); ++i)
 418         {
 419                 source += format("uniform %s\n{\n", *i);
 420                 for(list<ShaderVariable *>::const_iterator j=variables.begin(); j!=variables.end(); ++j)
 421                         if((*j)->resolved_block==*i)
 422                                 source += format("\t%s;\n", (*j)->create_declaration());
 423                 source += "};\n";
 424         }
 425
 426         /* Interface variables need to have global declarations. */
 427         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 428         {
 429                 if(!(*i)->resolved_name.compare(0, 3, "gl_"))
 430                         continue;
 431
 432                 InterfaceFlags iface = (*i)->get_interface_flags(scope);
 433
 434                 if(iface&INPUT)
 435                 {
 436                         const char *qualifier = (features.legacy ? scope==VERTEX ? "attribute" : "varying" : "in");
 437                         source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope-1]));
 438                 }
 439
 440                 if(iface&OUTPUT)
 441                 {
 442                         const char *qualifier = (features.legacy ? "varying" : "out");
 443                         source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope]));
 444                 }
 445         }
 446
 447         source += "void main()\n{\n";
 448
 449         list<ShaderVariable *> loop_vars;
 450         unsigned loop_size = 0;
 451         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 452         {
 453                 if(!loop_vars.empty() && !loop_vars.back()->in_loop && (*i)->array_size!=loop_size)
 454                 {
 455                         /* Declare all variables that need to be visible outside the loop.
 456                         Output variables are already declared. */
 457                         for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
 458                         {
 459                                 InterfaceFlags iface = (*j)->get_interface_flags(scope);
 460                                 if(!(*j)->in_loop && !(iface&OUTPUT))
 461                                         source += format("\t%s;\n", (*j)->create_declaration());
 462                         }
 463
 464                         source += format("\tfor(int i=0; i<%d; ++i)\n\t{\n", loop_size);
 465                         for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
 466                         {
 467                                 if((*j)->variable->scope==scope && !(*j)->inlined)
 468                                 {
 469                                         string decl;
 470                                         if((*j)->in_loop)
 471                                                 decl = (*j)->create_declaration(0, true);
 472                                         else
 473                                         {
 474                                                 decl = (*j)->resolved_name;
 475                                                 if(!(*j)->array_sum)
 476                                                         decl += "[i]";
 477                                         }
 478                                         const char *oper = ((*j)->array_sum ? "+=" : "=");
 479                                         source += format("\t\t%s %s %s;\n", decl, oper, create_expression(**j, "i"));
 480                                 }
 481
 482                                 InterfaceFlags iface = (*j)->get_interface_flags(scope);
 483                                 if(iface&OUTPUT)
 484                                 {
 485                                         string expr = ((*j)->inlined ? create_expression(**j, "i") : (*j)->resolved_name+"[i]");
 486                                         source += format("\t\t%c_%s[i] = %s;\n", interfaces[scope], (*j)->resolved_name, expr);
 487                                 }
 488                         }
 489                         source += "\t}\n";
 490
 491                         loop_vars.clear();
 492                 }
 493
 494                 InterfaceFlags iface = (*i)->get_interface_flags(scope);
 495
 496                 if((*i)->array_size>1)
 497                 {
 498                         if((*i)->variable->scope==scope || (iface&OUTPUT))
 499                         {
 500                                 loop_size = (*i)->array_size;
 501                                 loop_vars.push_back(*i);
 502                         }
 503                         continue;
 504                 }
 505
 506                 if((*i)->variable->scope==scope && !(*i)->inlined)
 507                 {
 508                         string decl = ((iface&GOAL) ? (*i)->resolved_name : (*i)->create_declaration());
 509                         source += format("\t%s = %s;\n", decl, create_expression(**i));
 510                 }
 511
 512                 if((iface&(OUTPUT|GOAL))==OUTPUT)
 513                 {
 514                         string expr = ((*i)->inlined ? create_expression(**i) : (*i)->resolved_name);
 515                         source += format("\t%c_%s = %s;\n", interfaces[scope], (*i)->resolved_name, expr);
 516                 }
 517         }
 518
 519         source += '}';
 520
 521         return source;
 522 }
 523
 524 bool ProgramBuilder::evaluate_flags(const char *flags) const
 525 {
 526         if(!flags)
 527                 return true;
 528
 529         bool cond = true;
 530         char oper = '&';
 531         for(const char *i=flags; *i; ++i)
 532         {
 533                 if(*i>='a' && *i<='z')
 534                 {
 535                         bool found = (feature_flags.find(*i)!=string::npos);
 536                         if(oper=='|')
 537                                 cond = (cond || found);
 538                         else if(oper=='!')
 539                                 cond = (cond && !found);
 540                         else if(oper=='&')
 541                                 cond = (cond && found);
 542                         oper = '&';
 543                 }
 544                 else
 545                         oper = *i;
 546         }
 547
 548         return cond;
 549 }
 550
 551 const char *ProgramBuilder::unqualified_name(const char *name)
 552 {
 553         for(const char *p=name; *p; ++p)
 554                 if(*p==':' && *++p==':')
 555                         name = p+1;
 556         return name;
 557 }
 558
 559 ProgramBuilder::MatchType ProgramBuilder::name_match(const char *n1, const char *n2, const char **space)
 560 {
 561         int i = 0;
 562         int zzz = -1;
 563         int zside = 0;
 564         while(*n1 && *n2)
 565         {
 566                 if(*n1==*n2 || *n1=='z' || *n2=='z')
 567                 {
 568                         if(*n1!=*n2)
 569                         {
 570                                 int side = (*n1=='z' ? 1 : 2);
 571                                 if(zzz<0)
 572                                 {
 573                                         zzz = i;
 574                                         zside = side;
 575                                         if(space)
 576                                         {
 577                                                 if(*n1=='z')
 578                                                         *space = n2;
 579                                                 else
 580                                                         *space = n1;
 581                                         }
 582                                 }
 583                                 else if(i>=zzz+3 || side!=zside)
 584                                         return NO_MATCH;
 585                         }
 586                 }
 587                 else
 588                         return NO_MATCH;
 589                 ++n1;
 590                 ++n2;
 591                 ++i;
 592         }
 593         return (!*n1 && !*n2) ? (zzz>=0 ? FUZZY : EXACT) : ((*n1=='[' || *n2=='[') ? ARRAY : NO_MATCH);
 594 }
 595
 596 bool ProgramBuilder::parse_identifier(const char *ptr, unsigned &start, unsigned &length)
 597 {
 598         bool found = false;
 599         bool member = false;
 600         bool subscript = false;
 601         for(const char *i=ptr;; ++i)
 602         {
 603                 if(!found)
 604                 {
 605                         if(!*i)
 606                                 return false;
 607                         if(isalpha(*i) || *i=='_')
 608                         {
 609                                 if(!member)
 610                                 {
 611                                         start = i-ptr;
 612                                         found = true;
 613                                 }
 614                         }
 615                         else if(*i=='.')
 616                                 member = true;
 617                         else
 618                                 member = false;
 619                 }
 620                 else
 621                 {
 622                         if(subscript)
 623                         {
 624                                 if(*i==']')
 625                                 {
 626                                         length = i+1-(ptr+start);
 627                                         return true;
 628                                 }
 629                                 else if(!isalpha(*i) || i>ptr+start+length+1)
 630                                         return true;
 631                         }
 632                         else if(!isalnum(*i) && *i!='_')
 633                         {
 634                                 length = i-(ptr+start);
 635                                 if(*i=='[')
 636                                         subscript = true;
 637                                 else
 638                                         return true;
 639                         }
 640                 }
 641         }
 642 }
 643
 644 vector<string> ProgramBuilder::extract_identifiers(const char *expression)
 645 {
 646         vector<string> result;
 647         const char *ptr = expression;
 648         unsigned start = 0;
 649         unsigned length = 0;
 650         while(parse_identifier(ptr, start, length))
 651         {
 652                 result.push_back(string(ptr+start, length));
 653                 ptr += start+length;
 654         }
 655         return result;
 656 }
 657
 658 string ProgramBuilder::replace_identifiers(const char *expression, const map<string, string> &replace_map, bool with_functions)
 659 {
 660         string result;
 661         const char *ptr = expression;
 662         unsigned start = 0;
 663         unsigned length = 0;
 664         while(parse_identifier(ptr, start, length))
 665         {
 666                 result.append(ptr, start);
 667                 string identifier(ptr+start, length);
 668                 map<string, string>::const_iterator i = replace_map.find(identifier);
 669                 if(i!=replace_map.end())
 670                 {
 671                         if(with_functions && ptr[start+length]=='(')
 672                         {
 673                                 string::size_type lparen = i->second.find('(');
 674                                 string::size_type rparen = i->second.rfind(')');
 675                                 if(lparen!=string::npos && rparen!=string::npos)
 676                                 {
 677                                         unsigned level = 1;
 678                                         unsigned j;
 679                                         for(j=start+length+1; (ptr[j] && level); ++j)
 680                                         {
 681                                                 level += (ptr[j]=='(');
 682                                                 level -= (ptr[j]==')');
 683                                         }
 684
 685                                         if(!level)
 686                                         {
 687                                                 string subexpr(ptr+start+length, ptr+j);
 688                                                 result += i->second.substr(0, lparen);
 689                                                 result += replace_identifiers(subexpr.c_str(), replace_map, with_functions);
 690                                                 result += i->second.substr(rparen+1);
 691                                                 ptr += j;
 692                                                 continue;
 693                                         }
 694                                 }
 695                         }
 696
 697                         result += i->second;
 698                 }
 699                 else
 700                         result += identifier;
 701                 ptr += start+length;
 702         }
 703         result += ptr;
 704         return result;
 705 }
 706
 707 string ProgramBuilder::create_expression(const ShaderVariable &var, const char *loop) const
 708 {
 709         string expr = var.create_expression(loop);
 710         return replace_identifiers(expr.c_str(), aliases, true);
 711 }
 712
 713
 714 ProgramBuilder::StandardFeatures::StandardFeatures():
 715         texture(false),
 716         material(false),
 717         lighting(false),
 718         max_lights(1),
 719         skylight(false),
 720         specular(false),
 721         normalmap(false),
 722         shadow(false),
 723         reflection(false)
 724 {
 725         if(get_gl_api()==OPENGL_ES2)
 726                 legacy = !(get_glsl_version()>=Version(3, 0));
 727         else
 728                 legacy = !(get_glsl_version()>=Version(1, 30));
 729 }
 730
 731 string ProgramBuilder::StandardFeatures::create_flags() const
 732 {
 733         string flags;
 734         if(texture)
 735                 flags += 't';
 736         if(material)
 737                 flags += 'm';
 738         if(lighting)
 739         {
 740                 flags += 'l';
 741                 if(skylight)
 742                         flags += 'y';
 743                 if(specular)
 744                         flags += 'p';
 745                 if(normalmap)
 746                         flags += 'n';
 747         }
 748         if(shadow)
 749                 flags += 's';
 750         if(reflection)
 751                 flags += 'e';
 752         if(legacy && get_gl_api()==OPENGL)
 753                 flags += 'g';
 754
 755         return flags;
 756 }
 757
 758
 759 ProgramBuilder::ShaderVariable::ShaderVariable(const std::string &n):
 760         name(n),
 761         variable(0),
 762         type(0),
 763         resolved_name(n),
 764         fuzzy_space(name.find("zzz")!=string::npos),
 765         array_sum(false),
 766         array_size(0),
 767         inlined(false),
 768         inline_parens(false),
 769         in_loop(false)
 770 {
 771         string::size_type bracket = name.find('[');
 772         if(bracket!=string::npos)
 773                 array_subscript = name.substr(bracket+1, name.size()-bracket-2);
 774 }
 775
 776 void ProgramBuilder::ShaderVariable::resolve(const VariableDefinition &var)
 777 {
 778         variable = &var;
 779         const char *space = 0;
 780         const char *var_uq_name = unqualified_name(variable->name);
 781         MatchType match = name_match(var_uq_name, resolved_name.c_str(), &space);
 782
 783         if(var_uq_name!=variable->name)
 784                 resolved_block.assign(variable->name, var_uq_name-2);
 785
 786         if(match==FUZZY)
 787                 resolve_space(string(space, 3));
 788         else if(match==ARRAY)
 789         {
 790                 if(array_subscript.empty())
 791                         array_sum = true;
 792                 else if(var.scope==UNIFORM)
 793                 {
 794                         const char *bracket = strrchr(variable->type, '[');
 795                         if(bracket)
 796                                 array_subscript = string(bracket+1, strlen(bracket)-2);
 797                 }
 798         }
 799 }
 800
 801 void ProgramBuilder::ShaderVariable::resolve(ShaderVariable &var)
 802 {
 803         for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 804                 (*i)->update_reference(*this, var);
 805         var.referenced_by.insert(var.referenced_by.end(), referenced_by.begin(), referenced_by.end());
 806 }
 807
 808 void ProgramBuilder::ShaderVariable::resolve_type(const VariableDefinition &var)
 809 {
 810         type = &var;
 811 }
 812
 813 void ProgramBuilder::ShaderVariable::resolve_space(const string &space)
 814 {
 815         if(fuzzy_space)
 816         {
 817                 resolved_space = space;
 818
 819                 string::size_type zzz = resolved_name.find("zzz");
 820                 resolved_name.replace(zzz, 3, resolved_space);
 821                 fuzzy_space = false;
 822
 823                 // Resolving the space could have affected other variables that use this one
 824                 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 825                         (*i)->resolve_space(space);
 826         }
 827
 828         for(list<ShaderVariable *>::iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 829                 if((*i)->fuzzy_space)
 830                         (*i)->resolve_space(space);
 831 }
 832
 833 void ProgramBuilder::ShaderVariable::resolve_array(const StandardFeatures &features, unsigned size_hint)
 834 {
 835         if(array_size)
 836                 return;
 837         if(!array_sum && array_subscript.empty())
 838                 return;
 839
 840         if(!array_subscript.empty())
 841         {
 842                 string::size_type bracket = resolved_name.find('[');
 843                 if(bracket!=string::npos)
 844                         resolved_name = resolved_name.substr(0, bracket);
 845         }
 846
 847         if(variable && variable->scope==UNIFORM)
 848         {
 849                 if(array_subscript=="MAX_LIGHTS")
 850                         array_size = features.max_lights;
 851                 else if(isnumrc(array_subscript))
 852                         array_size = lexical_cast<unsigned>(array_subscript);
 853                 else
 854                         throw invalid_variable_definition("invalid array size");
 855         }
 856
 857         if(!array_size)
 858         {
 859                 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 860                         if((*i)->array_size)
 861                         {
 862                                 array_size = (*i)->array_size;
 863                                 break;
 864                         }
 865         }
 866
 867         if(!array_size && size_hint)
 868                 array_size = size_hint;
 869
 870         if(array_size)
 871         {
 872                 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 873                         if(!(*i)->array_subscript.empty() && !(*i)->array_size)
 874                                 (*i)->resolve_array(features, array_size);
 875         }
 876 }
 877
 878 void ProgramBuilder::ShaderVariable::add_reference(ShaderVariable &var)
 879 {
 880         referenced_vars.push_back(&var);
 881         var.referenced_by.push_back(this);
 882         if(var.fuzzy_space && !resolved_space.empty())
 883                 var.resolve_space(resolved_space);
 884 }
 885
 886 void ProgramBuilder::ShaderVariable::update_reference(ShaderVariable &from, ShaderVariable &to)
 887 {
 888         replace(referenced_vars.begin(), referenced_vars.end(), &from, &to);
 889         replace(referenced_by.begin(), referenced_by.end(), &from, &to);
 890         if(from.fuzzy_space && !to.fuzzy_space && !to.resolved_space.empty())
 891                 resolve_space(to.resolved_space);
 892 }
 893
 894 void ProgramBuilder::ShaderVariable::check_inline(bool allow_legacy, bool trivial_only)
 895 {
 896         if(variable->expression)
 897         {
 898                 if(array_sum && array_size>1)
 899                         return;
 900                 if(!allow_legacy && !strncmp(variable->expression, "gl_", 3))
 901                         return;
 902
 903                 // Never inline goal variables
 904                 if(referenced_by.empty())
 905                         return;
 906
 907                 // Inline an expression consisting of a single identifier
 908                 unsigned start, length;
 909                 if(parse_identifier(variable->expression, start, length))
 910                         if(start==0 && variable->expression[length]==0)
 911                         {
 912                                 inlined = true;
 913                                 return;
 914                         }
 915
 916                 if(trivial_only)
 917                         return;
 918
 919                 /* If all references to the variable come from arrays in the same scope
 920                 and of the same size, the variable can be embedded in the loop. */
 921                 in_loop = (array_size>1 && !array_sum);
 922                 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 923                         if((*i)->variable->scope!=variable->scope || (*i)->array_size!=array_size)
 924                                 in_loop = false;
 925
 926                 /* Count all refs to this variable.  Refs from array variables count once
 927                 per loop iteration. */
 928                 unsigned total_refs = 0;
 929                 unsigned in_scope_refs = 0;
 930                 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 931                 {
 932                         unsigned count = max((*i)->array_size*!in_loop, 1U);
 933                         total_refs += count;
 934                         if((*i)->variable->scope==variable->scope)
 935                                 in_scope_refs += count;
 936                 }
 937
 938                 /* Inline if there's only one ref, or if all refs are in other scopes.
 939                 In the latter case, the actual inlining will happen in the interface
 940                 variable assignment. */
 941                 if(total_refs==1 || in_scope_refs==0)
 942                 {
 943                         inlined = true;
 944                         unsigned level = 0;
 945                         for(const char *c=variable->expression; (!inline_parens && *c); ++c)
 946                         {
 947                                 if(*c=='(')
 948                                         ++level;
 949                                 else if(*c==')')
 950                                         --level;
 951                                 else if(level==0 && !isalnum(*c) && *c!='_' && *c!='.')
 952                                         inline_parens = true;
 953                         }
 954                 }
 955         }
 956 }
 957
 958 bool ProgramBuilder::ShaderVariable::is_referenced_from(VariableScope scope) const
 959 {
 960         for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 961                 if((*i)->variable->scope==scope)
 962                         return true;
 963         return false;
 964 }
 965
 966 ProgramBuilder::InterfaceFlags ProgramBuilder::ShaderVariable::get_interface_flags(VariableScope scope) const
 967 {
 968         /* Uniforms are available to all stages and are not passed through
 969         interfaces */
 970         if(variable->scope==UNIFORM)
 971                 return NO_INTERFACE;
 972
 973         int flags = NO_INTERFACE;
 974
 975         for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 976         {
 977                 /* Variables used in a later scope than they are declared in need to go
 978                 through the interface */
 979                 if((*i)->variable->scope>scope && variable->scope<=scope)
 980                         flags |= OUTPUT;
 981                 if((*i)->variable->scope>=scope && variable->scope<scope)
 982                         if(!inlined || variable->scope!=ATTRIBUTE || scope!=VERTEX)
 983                                 flags |= INPUT;
 984         }
 985
 986         // Variables without any references are goals and also outputs.
 987         if(referenced_by.empty() && variable->scope==scope)
 988                 flags |= OUTPUT|GOAL;
 989
 990         return static_cast<InterfaceFlags>(flags);
 991 }
 992
 993 string ProgramBuilder::ShaderVariable::create_type_declaration() const
 994 {
 995         if(!type)
 996                 throw logic_error("no type");
 997
 998         if(!strncmp(type->type, "struct", 6))
 999         {
1000                 const char *brace = strchr(type->type, '{');
1001                 if(brace)
1002                         return format("struct %s %s", type->name, brace);
1003         }
1004
1005         throw invalid_variable_definition("invalid typedef");
1006 }
1007
1008 string ProgramBuilder::ShaderVariable::create_declaration(char iface, bool loop) const
1009 {
1010         if(variable->scope==UNIFORM && !array_subscript.empty())
1011         {
1012                 const char *bracket = strrchr(variable->type, '[');
1013                 if(bracket)
1014                         return format("%s %s[%d]", string(variable->type, bracket), resolved_name, array_size);
1015         }
1016
1017         string array;
1018         if(!array_sum && array_size>1 && !loop)
1019                 array = format("[%d]", array_size);
1020
1021         if(iface)
1022                 return format("%s %c_%s%s", variable->type, iface, resolved_name, array);
1023         else
1024                 return format("%s %s%s", variable->type, resolved_name, array);
1025 }
1026
1027 string ProgramBuilder::ShaderVariable::create_replacement(VariableScope from_scope, const char *loop) const
1028 {
1029         string replacement = resolved_name;
1030         InterfaceFlags iface = NO_INTERFACE;
1031         if(variable)
1032         {
1033                 iface = get_interface_flags(from_scope);
1034                 if((iface&INPUT) && interfaces[from_scope-1])
1035                         replacement = format("%c_%s", interfaces[from_scope-1], replacement);
1036                 else if(inlined)
1037                 {
1038                         replacement = create_expression(loop);
1039                         if(inline_parens)
1040                                 replacement = "("+replacement+")";
1041                         return replacement;
1042                 }
1043         }
1044
1045         // Add an array subscript, unless the variable is embedded in a loop
1046         if(!array_subscript.empty() && !in_loop)
1047         {
1048                 if(loop)
1049                         return format("%s[%s]", replacement, loop);
1050                 else if(!variable || variable->scope==UNIFORM)
1051                         return replacement+"[0]";
1052         }
1053
1054         return replacement;
1055 }
1056
1057 string ProgramBuilder::ShaderVariable::create_expression(const char *loop) const
1058 {
1059         map<string, string> replace_map;
1060         for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
1061         {
1062                 string replacement = (*i)->create_replacement(variable->scope, loop);
1063                 if(replacement!=(*i)->name)
1064                         replace_map[(*i)->name] = replacement;
1065         }
1066
1067         if(replace_map.empty())
1068                 return variable->expression;
1069         else
1070                 return replace_identifiers(variable->expression, replace_map);
1071 }
1072
1073
1074 ProgramBuilder::StandardFeatures::Loader::Loader(StandardFeatures &f):
1075         DataFile::ObjectLoader<StandardFeatures>(f)
1076 {
1077         add("custom",    &StandardFeatures::custom);
1078         add("lighting",  &StandardFeatures::lighting);
1079         add("material",  &StandardFeatures::material);
1080         add("max_lights", &StandardFeatures::max_lights);
1081         add("normalmap", &StandardFeatures::normalmap);
1082         add("reflection", &StandardFeatures::reflection);
1083         add("shadow",    &StandardFeatures::shadow);
1084         add("skylight",  &StandardFeatures::skylight);
1085         add("specular",  &StandardFeatures::specular);
1086         add("texture",   &StandardFeatures::texture);
1087 }
1088
1089 } // namespace GL
1090 } // namespace Msp