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", "g" },
  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, "Transform::eye_obj_matrix", "mat4", "gl_ModelViewMatrix", 0 },
 138         { UNIFORM, "Transform::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((get_gl_api()==OPENGL && !features.legacy) || (get_gl_api()==OPENGL_ES2 && get_glsl_version()>=Version(3, 0)))
 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         for(list<ShaderVariable *>::const_iterator i=resolved_vars.begin(); i!=resolved_vars.end(); ++i)
 349                 (*i)->check_inline(features.legacy, !optimize);
 350
 351         prog.attach_shader_owned(new VertexShader(create_source(resolved_vars, VERTEX)));
 352         prog.attach_shader_owned(new FragmentShader(create_source(resolved_vars, FRAGMENT)));
 353
 354         if(!features.legacy)
 355         {
 356                 // OpenGL ES does not support binding fragment shader outputs
 357                 if(get_gl_api()!=OPENGL_ES2)
 358                         prog.bind_fragment_data(0, "frag_color");
 359
 360                 prog.bind_attribute(VERTEX4, "vertex");
 361                 if(features.lighting)
 362                         prog.bind_attribute(NORMAL3, "normal");
 363                 else if(features.material)
 364                         prog.bind_attribute(COLOR4_FLOAT, "color");
 365                 if(features.texture || features.normalmap)
 366                         prog.bind_attribute(TEXCOORD4, "texcoord");
 367         }
 368         if(features.normalmap)
 369         {
 370                 prog.bind_attribute(get_component_type(TANGENT3), "tangent");
 371                 prog.bind_attribute(get_component_type(BINORMAL3), "binormal");
 372         }
 373 }
 374
 375 string ProgramBuilder::create_source(const list<ShaderVariable *> &variables, VariableScope scope) const
 376 {
 377         string source;
 378
 379         bool legacy_qualifiers = features.legacy || (get_gl_api()==OPENGL_ES2 && !(get_glsl_version()>=Version(3, 0)));
 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         set<const VariableDefinition *> declared_types;
 398         set<string> uniform_blocks;
 399         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 400                 if((*i)->variable->scope==UNIFORM && (*i)->is_referenced_from(scope) && !(*i)->inlined)
 401                 {
 402                         if((*i)->type && !declared_types.count((*i)->type))
 403                         {
 404                                 source += format("%s;\n", (*i)->create_type_declaration());
 405                                 declared_types.insert((*i)->type);
 406                         }
 407
 408                         if(!(*i)->resolved_block.empty() && use_blocks)
 409                                 uniform_blocks.insert((*i)->resolved_block);
 410                         else
 411                                 source += format("uniform %s;\n", (*i)->create_declaration());
 412                 }
 413
 414         for(set<string>::const_iterator i=uniform_blocks.begin(); i!=uniform_blocks.end(); ++i)
 415         {
 416                 source += format("uniform %s\n{\n", *i);
 417                 for(list<ShaderVariable *>::const_iterator j=variables.begin(); j!=variables.end(); ++j)
 418                         if((*j)->resolved_block==*i)
 419                                 source += format("\t%s;\n", (*j)->create_declaration());
 420                 source += "};\n";
 421         }
 422
 423         /* Interface variables need to have global declarations. */
 424         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 425         {
 426                 if(!(*i)->resolved_name.compare(0, 3, "gl_"))
 427                         continue;
 428
 429                 InterfaceFlags interface = (*i)->get_interface_flags(scope);
 430
 431                 if(interface&INPUT)
 432                 {
 433                         const char *qualifier = (legacy_qualifiers ? scope==VERTEX ? "attribute" : "varying" : "in");
 434                         source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope-1]));
 435                 }
 436
 437                 if(interface&OUTPUT)
 438                 {
 439                         const char *qualifier = (legacy_qualifiers ? "varying" : "out");
 440                         source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope]));
 441                 }
 442         }
 443
 444         source += "void main()\n{\n";
 445
 446         list<ShaderVariable *> loop_vars;
 447         unsigned loop_size = 0;
 448         for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
 449         {
 450                 if(!loop_vars.empty() && !loop_vars.back()->in_loop && (*i)->array_size!=loop_size)
 451                 {
 452                         /* Declare all variables that need to be visible outside the loop.
 453                         Output variables are already declared. */
 454                         for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
 455                         {
 456                                 InterfaceFlags interface = (*j)->get_interface_flags(scope);
 457                                 if(!(*j)->in_loop && !(interface&OUTPUT))
 458                                         source += format("\t%s;\n", (*j)->create_declaration());
 459                         }
 460
 461                         source += format("\tfor(int i=0; i<%d; ++i)\n\t{\n", loop_size);
 462                         for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
 463                         {
 464                                 if((*j)->variable->scope==scope && !(*j)->inlined)
 465                                 {
 466                                         string decl;
 467                                         if((*j)->in_loop)
 468                                                 decl = (*j)->create_declaration(0, true);
 469                                         else
 470                                         {
 471                                                 decl = (*j)->resolved_name;
 472                                                 if(!(*j)->array_sum)
 473                                                         decl += "[i]";
 474                                         }
 475                                         const char *oper = ((*j)->array_sum ? "+=" : "=");
 476                                         source += format("\t\t%s %s %s;\n", decl, oper, create_expression(**j, "i"));
 477                                 }
 478
 479                                 InterfaceFlags interface = (*j)->get_interface_flags(scope);
 480                                 if(interface&OUTPUT)
 481                                 {
 482                                         string expr = ((*j)->inlined ? create_expression(**j, "i") : (*j)->resolved_name+"[i]");
 483                                         source += format("\t\t%c_%s[i] = %s;\n", interfaces[scope], (*j)->resolved_name, expr);
 484                                 }
 485                         }
 486                         source += "\t}\n";
 487
 488                         loop_vars.clear();
 489                 }
 490
 491                 InterfaceFlags interface = (*i)->get_interface_flags(scope);
 492
 493                 if((*i)->array_size>1)
 494                 {
 495                         if((*i)->variable->scope==scope || (interface&OUTPUT))
 496                         {
 497                                 loop_size = (*i)->array_size;
 498                                 loop_vars.push_back(*i);
 499                         }
 500                         continue;
 501                 }
 502
 503                 if((*i)->variable->scope==scope && !(*i)->inlined)
 504                 {
 505                         string decl = ((interface&GOAL) ? (*i)->resolved_name : (*i)->create_declaration());
 506                         source += format("\t%s = %s;\n", decl, create_expression(**i));
 507                 }
 508
 509                 if((interface&(OUTPUT|GOAL))==OUTPUT)
 510                 {
 511                         string expr = ((*i)->inlined ? create_expression(**i) : (*i)->resolved_name);
 512                         source += format("\t%c_%s = %s;\n", interfaces[scope], (*i)->resolved_name, expr);
 513                 }
 514         }
 515
 516         source += '}';
 517
 518         return source;
 519 }
 520
 521 bool ProgramBuilder::evaluate_flags(const char *flags) const
 522 {
 523         if(!flags)
 524                 return true;
 525
 526         bool cond = true;
 527         char oper = '&';
 528         for(const char *i=flags; *i; ++i)
 529         {
 530                 if(*i>='a' && *i<='z')
 531                 {
 532                         bool found = (feature_flags.find(*i)!=string::npos);
 533                         if(oper=='|')
 534                                 cond = (cond || found);
 535                         else if(oper=='!')
 536                                 cond = (cond && !found);
 537                         else if(oper=='&')
 538                                 cond = (cond && found);
 539                         oper = '&';
 540                 }
 541                 else
 542                         oper = *i;
 543         }
 544
 545         return cond;
 546 }
 547
 548 const char *ProgramBuilder::unqualified_name(const char *name)
 549 {
 550         for(const char *p=name; *p; ++p)
 551                 if(*p==':' && *++p==':')
 552                         name = p+1;
 553         return name;
 554 }
 555
 556 ProgramBuilder::MatchType ProgramBuilder::name_match(const char *n1, const char *n2, const char **space)
 557 {
 558         int i = 0;
 559         int zzz = -1;
 560         int zside = 0;
 561         while(*n1 && *n2)
 562         {
 563                 if(*n1==*n2 || *n1=='z' || *n2=='z')
 564                 {
 565                         if(*n1!=*n2)
 566                         {
 567                                 int side = (*n1=='z' ? 1 : 2);
 568                                 if(zzz<0)
 569                                 {
 570                                         zzz = i;
 571                                         zside = side;
 572                                         if(space)
 573                                         {
 574                                                 if(*n1=='z')
 575                                                         *space = n2;
 576                                                 else
 577                                                         *space = n1;
 578                                         }
 579                                 }
 580                                 else if(i>=zzz+3 || side!=zside)
 581                                         return NO_MATCH;
 582                         }
 583                 }
 584                 else
 585                         return NO_MATCH;
 586                 ++n1;
 587                 ++n2;
 588                 ++i;
 589         }
 590         return (!*n1 && !*n2) ? (zzz>=0 ? FUZZY : EXACT) : ((*n1=='[' || *n2=='[') ? ARRAY : NO_MATCH);
 591 }
 592
 593 bool ProgramBuilder::parse_identifier(const char *ptr, unsigned &start, unsigned &length)
 594 {
 595         bool found = false;
 596         bool member = false;
 597         bool subscript = false;
 598         for(const char *i=ptr;; ++i)
 599         {
 600                 if(!found)
 601                 {
 602                         if(!*i)
 603                                 return false;
 604                         if(isalpha(*i) || *i=='_')
 605                         {
 606                                 if(!member)
 607                                 {
 608                                         start = i-ptr;
 609                                         found = true;
 610                                 }
 611                         }
 612                         else if(*i=='.')
 613                                 member = true;
 614                         else
 615                                 member = false;
 616                 }
 617                 else
 618                 {
 619                         if(subscript)
 620                         {
 621                                 if(*i==']')
 622                                 {
 623                                         length = i+1-(ptr+start);
 624                                         return true;
 625                                 }
 626                                 else if(!isalpha(*i) || i>ptr+start+length+1)
 627                                         return true;
 628                         }
 629                         else if(!isalnum(*i) && *i!='_')
 630                         {
 631                                 length = i-(ptr+start);
 632                                 if(*i=='[')
 633                                         subscript = true;
 634                                 else
 635                                         return true;
 636                         }
 637                 }
 638         }
 639 }
 640
 641 vector<string> ProgramBuilder::extract_identifiers(const char *expression)
 642 {
 643         vector<string> result;
 644         const char *ptr = expression;
 645         unsigned start = 0;
 646         unsigned length = 0;
 647         while(parse_identifier(ptr, start, length))
 648         {
 649                 result.push_back(string(ptr+start, length));
 650                 ptr += start+length;
 651         }
 652         return result;
 653 }
 654
 655 string ProgramBuilder::replace_identifiers(const char *expression, const map<string, string> &replace_map, bool with_functions)
 656 {
 657         string result;
 658         const char *ptr = expression;
 659         unsigned start = 0;
 660         unsigned length = 0;
 661         while(parse_identifier(ptr, start, length))
 662         {
 663                 result.append(ptr, start);
 664                 string identifier(ptr+start, length);
 665                 map<string, string>::const_iterator i = replace_map.find(identifier);
 666                 if(i!=replace_map.end())
 667                 {
 668                         if(with_functions && ptr[start+length]=='(')
 669                         {
 670                                 string::size_type lparen = i->second.find('(');
 671                                 string::size_type rparen = i->second.rfind(')');
 672                                 if(lparen!=string::npos && rparen!=string::npos)
 673                                 {
 674                                         unsigned level = 1;
 675                                         unsigned j;
 676                                         for(j=start+length+1; (ptr[j] && level); ++j)
 677                                         {
 678                                                 level += (ptr[j]=='(');
 679                                                 level -= (ptr[j]==')');
 680                                         }
 681
 682                                         if(!level)
 683                                         {
 684                                                 string subexpr(ptr+start+length, ptr+j);
 685                                                 result += i->second.substr(0, lparen);
 686                                                 result += replace_identifiers(subexpr.c_str(), replace_map, with_functions);
 687                                                 result += i->second.substr(rparen+1);
 688                                                 ptr += j;
 689                                                 continue;
 690                                         }
 691                                 }
 692                         }
 693
 694                         result += i->second;
 695                 }
 696                 else
 697                         result += identifier;
 698                 ptr += start+length;
 699         }
 700         result += ptr;
 701         return result;
 702 }
 703
 704 string ProgramBuilder::create_expression(const ShaderVariable &var, const char *loop) const
 705 {
 706         string expr = var.create_expression(loop);
 707         return replace_identifiers(expr.c_str(), aliases, true);
 708 }
 709
 710
 711 ProgramBuilder::StandardFeatures::StandardFeatures():
 712         texture(false),
 713         material(false),
 714         lighting(false),
 715         max_lights(1),
 716         skylight(false),
 717         specular(false),
 718         normalmap(false),
 719         shadow(false),
 720         reflection(false),
 721         legacy(get_gl_api()==OPENGL && !(get_glsl_version()>=Version(1, 30)))
 722 { }
 723
 724 string ProgramBuilder::StandardFeatures::create_flags() const
 725 {
 726         string flags;
 727         if(texture)
 728                 flags += 't';
 729         if(material)
 730                 flags += 'm';
 731         if(lighting)
 732         {
 733                 flags += 'l';
 734                 if(skylight)
 735                         flags += 'y';
 736                 if(specular)
 737                         flags += 'p';
 738                 if(normalmap)
 739                         flags += 'n';
 740         }
 741         if(shadow)
 742                 flags += 's';
 743         if(reflection)
 744                 flags += 'e';
 745         if(legacy)
 746                 flags += 'g';
 747
 748         return flags;
 749 }
 750
 751
 752 ProgramBuilder::ShaderVariable::ShaderVariable(const std::string &n):
 753         name(n),
 754         variable(0),
 755         type(0),
 756         resolved_name(n),
 757         fuzzy_space(name.find("zzz")!=string::npos),
 758         array_sum(false),
 759         array_size(0),
 760         inlined(false),
 761         inline_parens(false),
 762         in_loop(false)
 763 {
 764         string::size_type bracket = name.find('[');
 765         if(bracket!=string::npos)
 766                 array_subscript = name.substr(bracket+1, name.size()-bracket-2);
 767 }
 768
 769 void ProgramBuilder::ShaderVariable::resolve(const VariableDefinition &var)
 770 {
 771         variable = &var;
 772         const char *space = 0;
 773         const char *var_uq_name = unqualified_name(variable->name);
 774         MatchType match = name_match(var_uq_name, resolved_name.c_str(), &space);
 775
 776         if(var_uq_name!=variable->name)
 777                 resolved_block.assign(variable->name, var_uq_name-2);
 778
 779         if(match==FUZZY)
 780                 resolve_space(string(space, 3));
 781         else if(match==ARRAY)
 782         {
 783                 if(array_subscript.empty())
 784                         array_sum = true;
 785                 else if(var.scope==UNIFORM)
 786                 {
 787                         const char *bracket = strrchr(variable->type, '[');
 788                         if(bracket)
 789                                 array_subscript = string(bracket+1, strlen(bracket)-2);
 790                 }
 791         }
 792 }
 793
 794 void ProgramBuilder::ShaderVariable::resolve(ShaderVariable &var)
 795 {
 796         for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 797                 (*i)->update_reference(*this, var);
 798         var.referenced_by.insert(var.referenced_by.end(), referenced_by.begin(), referenced_by.end());
 799 }
 800
 801 void ProgramBuilder::ShaderVariable::resolve_type(const VariableDefinition &var)
 802 {
 803         type = &var;
 804 }
 805
 806 void ProgramBuilder::ShaderVariable::resolve_space(const string &space)
 807 {
 808         if(fuzzy_space)
 809         {
 810                 resolved_space = space;
 811
 812                 string::size_type zzz = resolved_name.find("zzz");
 813                 resolved_name.replace(zzz, 3, resolved_space);
 814                 fuzzy_space = false;
 815
 816                 // Resolving the space could have affected other variables that use this one
 817                 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 818                         (*i)->resolve_space(space);
 819         }
 820
 821         for(list<ShaderVariable *>::iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 822                 if((*i)->fuzzy_space)
 823                         (*i)->resolve_space(space);
 824 }
 825
 826 void ProgramBuilder::ShaderVariable::resolve_array(const StandardFeatures &features, unsigned size_hint)
 827 {
 828         if(array_size)
 829                 return;
 830         if(!array_sum && array_subscript.empty())
 831                 return;
 832
 833         if(!array_subscript.empty())
 834         {
 835                 string::size_type bracket = resolved_name.find('[');
 836                 if(bracket!=string::npos)
 837                         resolved_name = resolved_name.substr(0, bracket);
 838         }
 839
 840         if(variable && variable->scope==UNIFORM)
 841         {
 842                 if(array_subscript=="MAX_LIGHTS")
 843                         array_size = features.max_lights;
 844                 else if(isnumrc(array_subscript))
 845                         array_size = lexical_cast<unsigned>(array_subscript);
 846                 else
 847                         throw invalid_variable_definition("invalid array size");
 848         }
 849
 850         if(!array_size)
 851         {
 852                 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 853                         if((*i)->array_size)
 854                         {
 855                                 array_size = (*i)->array_size;
 856                                 break;
 857                         }
 858         }
 859
 860         if(!array_size && size_hint)
 861                 array_size = size_hint;
 862
 863         if(array_size)
 864         {
 865                 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
 866                         if(!(*i)->array_subscript.empty() && !(*i)->array_size)
 867                                 (*i)->resolve_array(features, array_size);
 868         }
 869 }
 870
 871 void ProgramBuilder::ShaderVariable::add_reference(ShaderVariable &var)
 872 {
 873         referenced_vars.push_back(&var);
 874         var.referenced_by.push_back(this);
 875         if(var.fuzzy_space && !resolved_space.empty())
 876                 var.resolve_space(resolved_space);
 877 }
 878
 879 void ProgramBuilder::ShaderVariable::update_reference(ShaderVariable &from, ShaderVariable &to)
 880 {
 881         replace(referenced_vars.begin(), referenced_vars.end(), &from, &to);
 882         replace(referenced_by.begin(), referenced_by.end(), &from, &to);
 883         if(from.fuzzy_space && !to.fuzzy_space && !to.resolved_space.empty())
 884                 resolve_space(to.resolved_space);
 885 }
 886
 887 void ProgramBuilder::ShaderVariable::check_inline(bool allow_legacy, bool trivial_only)
 888 {
 889         if(variable->expression)
 890         {
 891                 if(array_sum && array_size>1)
 892                         return;
 893                 if(!allow_legacy && !strncmp(variable->expression, "gl_", 3))
 894                         return;
 895
 896                 // Never inline goal variables
 897                 if(referenced_by.empty())
 898                         return;
 899
 900                 // Inline an expression consisting of a single identifier
 901                 unsigned start, length;
 902                 if(parse_identifier(variable->expression, start, length))
 903                         if(start==0 && variable->expression[length]==0)
 904                         {
 905                                 inlined = true;
 906                                 return;
 907                         }
 908
 909                 if(trivial_only)
 910                         return;
 911
 912                 /* If all references to the variable come from arrays in the same scope
 913                 and of the same size, the variable can be embedded in the loop. */
 914                 in_loop = (array_size>1 && !array_sum);
 915                 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 916                         if((*i)->variable->scope!=variable->scope || (*i)->array_size!=array_size)
 917                                 in_loop = false;
 918
 919                 /* Count all refs to this variable.  Refs from array variables count once
 920                 per loop iteration. */
 921                 unsigned total_refs = 0;
 922                 unsigned in_scope_refs = 0;
 923                 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 924                 {
 925                         unsigned count = max((*i)->array_size*!in_loop, 1U);
 926                         total_refs += count;
 927                         if((*i)->variable->scope==variable->scope)
 928                                 in_scope_refs += count;
 929                 }
 930
 931                 /* Inline if there's only one ref, or if all refs are in other scopes.
 932                 In the latter case, the actual inlining will happen in the interface
 933                 variable assignment. */
 934                 if(total_refs==1 || in_scope_refs==0)
 935                 {
 936                         inlined = true;
 937                         unsigned level = 0;
 938                         for(const char *c=variable->expression; (!inline_parens && *c); ++c)
 939                         {
 940                                 if(*c=='(')
 941                                         ++level;
 942                                 else if(*c==')')
 943                                         --level;
 944                                 else if(level==0 && !isalnum(*c) && *c!='_' && *c!='.')
 945                                         inline_parens = true;
 946                         }
 947                 }
 948         }
 949 }
 950
 951 bool ProgramBuilder::ShaderVariable::is_referenced_from(VariableScope scope) const
 952 {
 953         for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 954                 if((*i)->variable->scope==scope)
 955                         return true;
 956         return false;
 957 }
 958
 959 ProgramBuilder::InterfaceFlags ProgramBuilder::ShaderVariable::get_interface_flags(VariableScope scope) const
 960 {
 961         /* Uniforms are available to all stages and are not passed through
 962         interfaces */
 963         if(variable->scope==UNIFORM)
 964                 return NO_INTERFACE;
 965
 966         int flags = NO_INTERFACE;
 967
 968         for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
 969         {
 970                 /* Variables used in a later scope than they are declared in need to go
 971                 through the interface */
 972                 if((*i)->variable->scope>scope && variable->scope<=scope)
 973                         flags |= OUTPUT;
 974                 if((*i)->variable->scope>=scope && variable->scope<scope)
 975                         if(!inlined || variable->scope!=ATTRIBUTE || scope!=VERTEX)
 976                                 flags |= INPUT;
 977         }
 978
 979         // Variables without any references are goals and also outputs.
 980         if(referenced_by.empty() && variable->scope==scope)
 981                 flags |= OUTPUT|GOAL;
 982
 983         return static_cast<InterfaceFlags>(flags);
 984 }
 985
 986 string ProgramBuilder::ShaderVariable::create_type_declaration() const
 987 {
 988         if(!type)
 989                 throw logic_error("no type");
 990
 991         if(!strncmp(type->type, "struct", 6))
 992         {
 993                 const char *brace = strchr(type->type, '{');
 994                 if(brace)
 995                         return format("struct %s %s", type->name, brace);
 996         }
 997
 998         throw invalid_variable_definition("invalid typedef");
 999 }
1000
1001 string ProgramBuilder::ShaderVariable::create_declaration(char interface, bool loop) const
1002 {
1003         if(variable->scope==UNIFORM && !array_subscript.empty())
1004         {
1005                 const char *bracket = strrchr(variable->type, '[');
1006                 if(bracket)
1007                         return format("%s %s[%d]", string(variable->type, bracket), resolved_name, array_size);
1008         }
1009
1010         string array;
1011         if(!array_sum && array_size>1 && !loop)
1012                 array = format("[%d]", array_size);
1013
1014         if(interface)
1015                 return format("%s %c_%s%s", variable->type, interface, resolved_name, array);
1016         else
1017                 return format("%s %s%s", variable->type, resolved_name, array);
1018 }
1019
1020 string ProgramBuilder::ShaderVariable::create_replacement(VariableScope from_scope, const char *loop) const
1021 {
1022         string replacement = resolved_name;
1023         InterfaceFlags interface = NO_INTERFACE;
1024         if(variable)
1025         {
1026                 interface = get_interface_flags(from_scope);
1027                 if((interface&INPUT) && interfaces[from_scope-1])
1028                         replacement = format("%c_%s", interfaces[from_scope-1], replacement);
1029                 else if(inlined)
1030                 {
1031                         replacement = create_expression(loop);
1032                         if(inline_parens)
1033                                 replacement = "("+replacement+")";
1034                         return replacement;
1035                 }
1036         }
1037
1038         // Add an array subscript, unless the variable is embedded in a loop
1039         if(!array_subscript.empty() && !in_loop)
1040         {
1041                 if(loop)
1042                         return format("%s[%s]", replacement, loop);
1043                 else if(!variable || variable->scope==UNIFORM)
1044                         return replacement+"[0]";
1045         }
1046
1047         return replacement;
1048 }
1049
1050 string ProgramBuilder::ShaderVariable::create_expression(const char *loop) const
1051 {
1052         map<string, string> replace_map;
1053         for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
1054         {
1055                 string replacement = (*i)->create_replacement(variable->scope, loop);
1056                 if(replacement!=(*i)->name)
1057                         replace_map[(*i)->name] = replacement;
1058         }
1059
1060         if(replace_map.empty())
1061                 return variable->expression;
1062         else
1063                 return replace_identifiers(variable->expression, replace_map);
1064 }
1065
1066
1067 ProgramBuilder::StandardFeatures::Loader::Loader(StandardFeatures &f):
1068         DataFile::ObjectLoader<StandardFeatures>(f)
1069 {
1070         add("custom",    &StandardFeatures::custom);
1071         add("lighting",  &StandardFeatures::lighting);
1072         add("material",  &StandardFeatures::material);
1073         add("max_lights", &StandardFeatures::max_lights);
1074         add("normalmap", &StandardFeatures::normalmap);
1075         add("reflection", &StandardFeatures::reflection);
1076         add("shadow",    &StandardFeatures::shadow);
1077         add("skylight",  &StandardFeatures::skylight);
1078         add("specular",  &StandardFeatures::specular);
1079         add("texture",   &StandardFeatures::texture);
1080 }
1081
1082 } // namespace GL
1083 } // namespace Msp