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