4 #include <msp/gl/extensions/arb_uniform_buffer_object.h>
5 #include <msp/strings/format.h>
6 #include <msp/strings/utils.h>
9 #include "programbuilder.h"
11 #include "vertexformat.h"
21 l_* Lighting component
25 tbn_* Tangent-Binormal-Normal space
27 env_* Environment space
28 *_dir Direction vector
30 zzz_* Wildcard space, resolved by the builder
31 All wildcard spaces within an expression must match
33 xxx_yyy_* Matrix that transforms between yyy to xxx
34 The vector is on the side of its designated space, result will be
36 *_matrix A matrix (duh)
37 *_rmatrix A mat4 that works with a row vector
39 rgb_* Color with rgb components only
40 color_* Color with rgba components
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[] =
47 { FRAGMENT, "gl_FragColor", "vec4", "frag_color", 0 },
48 { FRAGMENT, "frag_color", "vec4", "incoming_color", "!f" },
49 { FRAGMENT, "frag_color", "vec4", "vec4(mix(fog_color.rgb, incoming_color.rgb, fog_value), incoming_color.a)", "f" },
50 { FRAGMENT, "fog_value", "float", "exp(-fog_coord*fog_density)", 0 },
52 { FRAGMENT, "incoming_color", "vec4", "basic_color", "!e!l" },
53 { FRAGMENT, "incoming_color", "vec4", "vec4(rgb_surface, surface_alpha)", "!el" },
54 { FRAGMENT, "incoming_color", "vec4", "vec4(rgb_surface+rgb_reflection, surface_alpha)", "e" },
56 { FRAGMENT, "rgb_reflection", "vec3", "reflect_sample.rgb*reflectivity", 0 },
57 { FRAGMENT, "reflect_sample", "vec4", "textureCube(environment, env_reflect_dir)", 0 },
58 { FRAGMENT, "env_reflect_dir", "vec3", "env_eye_matrix*eye_reflect_dir", 0 },
59 { FRAGMENT, "eye_reflect_dir", "vec3", "eye_tbn_matrix*tbn_reflect_dir", "n" },
61 { FRAGMENT, "rgb_surface", "vec3", "rgb_unlit_surface", "!l" },
62 { FRAGMENT, "rgb_surface", "vec3", "rgb_lit_surface", "l" },
63 { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb", "!s" },
64 { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb*l_shadow", "s" },
65 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse", "!m!t" },
66 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse*diffuse_sample.rgb", "!mt" },
67 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse", "m!p" },
68 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse+rgb_surface_specular", "mp" },
70 { FRAGMENT, "surface_alpha", "float", "basic_color.a", "!m" },
71 { FRAGMENT, "surface_alpha", "float", "basic_color.a", "m!l" },
72 { FRAGMENT, "surface_alpha", "float", "material.diffuse.a", "ml!t" },
73 { FRAGMENT, "surface_alpha", "float", "material.diffuse.a*diffuse_sample.a", "mlt" },
74 { FRAGMENT, "basic_color", "vec4", "vec4(1.0)", "!m!t" },
75 { FRAGMENT, "basic_color", "vec4", "diffuse_sample", "!mt" },
76 { FRAGMENT, "basic_color", "vec4", "color", "m!t" },
77 { FRAGMENT, "basic_color", "vec4", "color*diffuse_sample", "mt" },
79 { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb", "!t" },
80 { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb*diffuse_sample.rgb", "t" },
81 { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb", "!y" },
82 { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb+l_skylight*sky_color.rgb", "y" },
83 { FRAGMENT, "l_skylight", "float", "dot(n_zzz_normal, zzz_sky_dir)*0.5+0.5", 0 },
85 { FRAGMENT, "rgb_surface_specular", "vec3", "rgb_illumination_specular*material.specular.rgb", 0 },
86 { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct", "!y|e" },
87 { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct+l_sky_specular*sky_color.rgb", "y!e" },
88 { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular", "!s" },
89 { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular*l_shadow", "s" },
90 { FRAGMENT, "rgb_light_specular[i]", "vec3", "l_specular[i]*light_sources[i].specular.rgb", 0 },
91 { 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 },
92 { FRAGMENT, "l_specular[i]", "float", "pow(max(dot(n_zzz_half_vec[i], n_zzz_normal), 0.0), material.shininess)", 0 },
94 { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb", "!t" },
95 { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb*diffuse_sample.rgb", "t" },
96 { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse", "!s" },
97 { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse*l_shadow", "s" },
98 { FRAGMENT, "rgb_light_diffuse[i]", "vec3", "l_diffuse[i]*light_sources[i].diffuse.rgb", 0 },
99 { FRAGMENT, "l_diffuse[i]", "float", "max(dot(n_zzz_normal, n_zzz_light_dir[i]), 0.0)", 0 },
101 { FRAGMENT, "l_shadow", "float", "mix(1.0, shadow_sample, shadow_darkness)", 0 },
102 { FRAGMENT, "shadow_sample", "float", "shadow2D(shadow, shd_vertex)", 0 },
104 { FRAGMENT, "zzz_reflect_dir", "vec3", "reflect(zzz_incident_dir, n_zzz_normal)", 0 },
105 { FRAGMENT, "n_zzz_half_vec[i]", "vec3", "normalize(zzz_light_dir[i]-zzz_incident_dir)", 0 },
106 { FRAGMENT, "n_zzz_light_dir[i]", "vec3", "normalize(zzz_light_dir[i])", 0 },
107 { FRAGMENT, "n_tbn_normal", "vec3", "normal_sample*2.0-1.0", "n" },
108 { FRAGMENT, "n_eye_normal", "vec3", "normalize(eye_normal)", "!n" },
109 { FRAGMENT, "normal_sample", "vec3", "texture2D(normalmap, texture_coord).xyz", 0 },
110 { FRAGMENT, "diffuse_sample", "vec4", "texture2D(diffusemap, texture_coord)", 0 },
112 { VERTEX, "gl_Position", "vec4", "projection_matrix*eye_vertex", 0 },
113 { VERTEX, "gl_ClipDistance[i]", "float", "dot(eye_vertex, clip_planes[i].equation)", "c" },
114 { VERTEX, "fog_coord", "float", "-eye_vertex.z", 0 },
115 { VERTEX, "shd_vertex", "vec3", "(shd_eye_matrix*eye_vertex).xyz", 0 },
116 { VERTEX, "tbn_sky_dir", "vec3", "eye_sky_dir*eye_tbn_matrix", "n" },
117 { VERTEX, "tbn_light_dir[i]", "vec3", "eye_light_dir[i]*eye_tbn_matrix", 0 },
118 { VERTEX, "eye_light_dir[i]", "vec3", "normalize(eye_light_position[i].xyz-eye_vertex.xyz*eye_light_position[i].w)", 0 },
119 { VERTEX, "eye_light_position[i]", "vec4", "light_sources[i].position", 0 },
120 { VERTEX, "tbn_incident_dir", "vec3", "eye_incident_dir*eye_tbn_matrix", 0 },
121 { VERTEX, "eye_incident_dir", "vec3", "normalize(eye_vertex.xyz)", 0 },
122 { VERTEX, "eye_tbn_matrix", "mat3", "mat3(eye_tangent, eye_binormal, eye_normal)", 0 },
123 { VERTEX, "eye_vertex", "vec4", "eye_obj_matrix*vertex", 0 },
124 { VERTEX, "eye_normal", "vec3", "eye_obj_normal_matrix*normal", 0 },
125 { VERTEX, "eye_tangent", "vec3", "eye_obj_normal_matrix*tangent", 0 },
126 { VERTEX, "eye_binormal", "vec3", "eye_obj_normal_matrix*binormal", 0 },
127 { VERTEX, "texture_coord", "vec2", "texcoord.xy", 0 },
129 { ATTRIBUTE, "vertex", "vec4", "gl_Vertex", 0 },
130 { ATTRIBUTE, "texcoord", "vec4", "gl_MultiTexCoord0", 0 },
131 { ATTRIBUTE, "color", "vec4", "gl_Color", 0 },
132 { ATTRIBUTE, "normal", "vec3", "gl_Normal", 0 },
133 { ATTRIBUTE, "tangent", "vec3", 0, 0 },
134 { ATTRIBUTE, "binormal", "vec3", 0, 0 },
136 { UNIFORM, "diffusemap", "sampler2D", 0, 0 },
137 { UNIFORM, "shadow", "sampler2DShadow", 0, 0 },
138 { UNIFORM, "ShadowMap::shadow_darkness", "float", 0, 0 },
139 { UNIFORM, "normalmap", "sampler2D", 0, 0 },
140 { UNIFORM, "environment", "samplerCube", 0, 0 },
141 { UNIFORM, "EnvMap::env_eye_matrix", "mat3", 0, 0 },
142 { UNIFORM, "Material::reflectivity", "float", 0, 0 },
143 { UNIFORM, "eye_obj_matrix", "mat4", "gl_ModelViewMatrix", 0 },
144 { UNIFORM, "eye_obj_normal_matrix", "mat3", "gl_NormalMatrix", 0 },
145 { UNIFORM, "Transform::projection_matrix", "mat4", "gl_ProjectionMatrix", 0 },
146 { UNIFORM, "ShadowMap::shd_eye_matrix", "mat4", 0, 0 },
147 { UNIFORM, "Lighting::light_sources", "LightSourceParameters[MAX_LIGHTS]", "gl_LightSource[i]", 0 },
148 { UNIFORM, "Lighting::ambient_color", "vec4", "gl_LightModel.ambient", 0 },
149 { UNIFORM, "Lighting::sky_color", "vec4", 0, 0 },
150 { UNIFORM, "Lighting::eye_sky_dir", "vec3", 0, 0 },
151 { UNIFORM, "Lighting::horizon_limit", "float", 0, 0 },
152 { UNIFORM, "Lighting::fog_color", "vec4", "gl_Fog.color", 0 },
153 { UNIFORM, "Lighting::fog_density", "float", "gl_Fog.density", 0 },
154 { UNIFORM, "Material::material", "MaterialParameters", "gl_FrontMaterial", 0 },
155 { UNIFORM, "Clipping::clip_planes", "ClipPlane[MAX_CLIP_PLANES]", 0, 0 },
157 { TYPE, "LightSourceParameters", "struct { vec4 position; vec4 diffuse; vec4 specular; }", "gl_LightSourceParameters", 0 },
158 { TYPE, "MaterialParameters", "struct { vec4 ambient; vec4 diffuse; vec4 specular; float shininess; }", "gl_MaterialParameters", 0 },
159 { TYPE, "ClipPlane", "struct { vec4 equation; }", 0, 0 },
162 { NO_SCOPE, 0, 0, 0, 0 }
165 const char ProgramBuilder::interfaces[] = { 0, 0, 0, 0, 'v', 0 };
167 ProgramBuilder::ProgramBuilder(const StandardFeatures &f):
169 feature_flags(features.create_flags()),
172 if(!features.custom.empty())
174 const char *whitespace = " \t\n";
175 string::size_type start = 0;
178 start = features.custom.find_first_not_of(whitespace, start);
179 if(start==string::npos)
182 string::size_type semicolon = features.custom.find(';', start);
188 else if(semicolon==string::npos)
189 throw invalid_variable_definition(features.custom.substr(start));
191 string::size_type equals = features.custom.find('=', start);
193 equals = string::npos;
195 VariableDefinition var;
196 string::size_type decl_end = min(equals, semicolon);
197 for(unsigned i=0;; ++i)
199 string::size_type word_end = features.custom.find_first_of(whitespace, start);
200 word_end = min(word_end, decl_end);
201 features.custom[word_end] = 0;
203 const char *word = &features.custom[start];
206 if(!strcmp(word, "uniform"))
208 else if(!strcmp(word, "attribute"))
209 var.scope = ATTRIBUTE;
210 else if(!strcmp(word, "vertex"))
212 else if(!strcmp(word, "fragment"))
213 var.scope = FRAGMENT;
215 throw invalid_variable_definition(word);
222 start = features.custom.find_first_not_of(whitespace, word_end+1);
227 if(equals!=string::npos)
229 start = features.custom.find_first_not_of(whitespace, equals+1);
231 throw invalid_variable_definition("no expression");
232 features.custom[semicolon] = 0;
233 var.expression = &features.custom[start];
239 for(const VariableDefinition *j=standard_variables; j->name; ++j)
240 if(!strcmp(var.name, j->name))
243 custom_variables.push_front(var);
251 aliases["texture1D"] = "texture";
252 aliases["texture2D"] = "texture";
253 aliases["texture3D"] = "texture";
254 aliases["textureCube"] = "texture";
255 aliases["shadow2D"] = "texture";
258 aliases["shadow2D"] = "shadow2D(...).r";
261 void ProgramBuilder::set_optimize(bool o)
266 Program *ProgramBuilder::create_program() const
268 Program *prog = new Program;
273 void ProgramBuilder::add_shaders(Program &prog) const
275 list<ShaderVariable> variables;
276 list<ShaderVariable *> resolved_vars;
278 if(features.clipping)
279 variables.push_back(ShaderVariable("gl_ClipDistance[i]"));
280 variables.push_front(ShaderVariable("gl_Position"));
281 variables.push_front(ShaderVariable(features.legacy ? "gl_FragColor" : "frag_color"));
283 list<VariableDefinition>::const_iterator next_custom = custom_variables.begin();
284 for(const VariableDefinition *i=standard_variables; i->name; )
286 const VariableDefinition *def = 0;
287 if(next_custom!=custom_variables.end() && (!strcmp(next_custom->name, i->name) || !next_custom->flags))
297 // Skip over anything that isn't used with the supplied flags
298 if(def->flags && !evaluate_flags(def->flags))
304 for(list<ShaderVariable *>::iterator j=resolved_vars.begin(); j!=resolved_vars.end(); ++j)
305 if(!(*j)->type && name_match(def->name, (*j)->variable->type))
306 (*j)->resolve_type(*def);
311 const char *def_uq_name = unqualified_name(def->name);
313 // See if this variable can satisfy any unresolved variables
314 ShaderVariable *last_resolved = 0;
315 for(list<ShaderVariable>::iterator j=variables.begin(); j!=variables.end(); ++j)
320 if(!name_match(def_uq_name, j->resolved_name.c_str()))
325 /* We've already resolved a non-fuzzy variable in this iteration.
326 If there are multiple variables that can be resolved, they refer
327 to the same variable. */
328 j->resolve(*last_resolved);
333 resolved_vars.push_front(&*j);
340 vector<string> identifiers = extract_identifiers(def->expression);
341 for(vector<string>::const_iterator k=identifiers.begin(); k!=identifiers.end(); ++k)
343 // Use an existing variable if possible, but only if it's not fuzzy
344 ShaderVariable *var = 0;
345 for(list<ShaderVariable>::iterator l=variables.begin(); (!var && l!=variables.end()); ++l)
346 if(!l->fuzzy_space && l->resolved_name==*k)
351 variables.push_back(ShaderVariable(*k));
352 var = &variables.back();
354 j->add_reference(*var);
359 // Array sizes need to be resolved for inline processing
360 for(list<ShaderVariable>::iterator i=variables.end(); i!=variables.begin(); )
361 (--i)->resolve_array(features);
363 bool legacy_variables = evaluate_flags("g");
364 for(list<ShaderVariable *>::const_iterator i=resolved_vars.begin(); i!=resolved_vars.end(); ++i)
365 (*i)->check_inline(legacy_variables, !optimize);
367 prog.attach_shader_owned(new VertexShader(create_source(resolved_vars, VERTEX)));
368 prog.attach_shader_owned(new FragmentShader(create_source(resolved_vars, FRAGMENT)));
372 // OpenGL ES does not support binding fragment shader outputs
373 if(get_gl_api()!=OPENGL_ES2)
374 prog.bind_fragment_data(0, "frag_color");
376 prog.bind_attribute(VERTEX4, "vertex");
377 if(features.lighting)
378 prog.bind_attribute(NORMAL3, "normal");
379 else if(features.material)
380 prog.bind_attribute(COLOR4_FLOAT, "color");
381 if(features.texture || features.normalmap)
382 prog.bind_attribute(TEXCOORD4, "texcoord");
384 if(features.normalmap)
386 prog.bind_attribute(get_component_type(TANGENT3), "tangent");
387 prog.bind_attribute(get_component_type(BINORMAL3), "binormal");
391 string ProgramBuilder::create_source(const list<ShaderVariable *> &variables, VariableScope scope) const
395 bool use_blocks = !features.legacy && ARB_uniform_buffer_object;
399 if(get_gl_api()==OPENGL_ES2)
402 source += "#version 300 es\n";
406 source += "#version 130\n";
408 source += "#extension GL_ARB_uniform_buffer_object: require\n";
412 if(get_gl_api()==OPENGL_ES2)
413 source += "precision mediump float;\n";
415 set<const VariableDefinition *> declared_types;
416 set<string> uniform_blocks;
417 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
418 if((*i)->variable->scope==UNIFORM && (*i)->is_referenced_from(scope) && !(*i)->inlined)
420 if((*i)->type && !declared_types.count((*i)->type))
422 source += format("%s;\n", (*i)->create_type_declaration());
423 declared_types.insert((*i)->type);
426 if(!(*i)->resolved_block.empty() && use_blocks)
427 uniform_blocks.insert((*i)->resolved_block);
429 source += format("uniform %s;\n", (*i)->create_declaration());
432 for(set<string>::const_iterator i=uniform_blocks.begin(); i!=uniform_blocks.end(); ++i)
434 source += format("uniform %s\n{\n", *i);
435 for(list<ShaderVariable *>::const_iterator j=variables.begin(); j!=variables.end(); ++j)
436 if((*j)->resolved_block==*i)
437 source += format("\t%s;\n", (*j)->create_declaration());
441 /* Interface variables need to have global declarations. */
442 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
444 if(!(*i)->resolved_name.compare(0, 3, "gl_"))
447 InterfaceFlags iface = (*i)->get_interface_flags(scope);
451 const char *qualifier = (features.legacy ? scope==VERTEX ? "attribute" : "varying" : "in");
452 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope-1]));
457 const char *qualifier = (features.legacy ? "varying" : "out");
458 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope]));
462 // The clip distance array must be declared manually to give it a size
463 if(scope==VERTEX && features.clipping)
464 source += format("out float gl_ClipDistance[%d];\n", features.max_clip_planes);
466 source += "void main()\n{\n";
468 list<ShaderVariable *> loop_vars;
469 unsigned loop_size = 0;
470 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
472 if(!loop_vars.empty() && !loop_vars.back()->in_loop && (*i)->array_size!=loop_size)
474 /* Declare all variables that need to be visible outside the loop.
475 Output variables are already declared. */
476 for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
478 InterfaceFlags iface = (*j)->get_interface_flags(scope);
479 if(!(*j)->in_loop && !(iface&OUTPUT))
480 source += format("\t%s;\n", (*j)->create_declaration());
483 source += format("\tfor(int i=0; i<%d; ++i)\n\t{\n", loop_size);
484 for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
486 if((*j)->variable->scope==scope && !(*j)->inlined)
490 decl = (*j)->create_declaration(0, true);
493 decl = (*j)->resolved_name;
497 const char *oper = ((*j)->array_sum ? "+=" : "=");
498 source += format("\t\t%s %s %s;\n", decl, oper, create_expression(**j, "i"));
501 InterfaceFlags iface = (*j)->get_interface_flags(scope);
502 if((iface&(OUTPUT|GOAL))==OUTPUT)
504 string expr = ((*j)->inlined ? create_expression(**j, "i") : (*j)->resolved_name+"[i]");
505 source += format("\t\t%c_%s[i] = %s;\n", interfaces[scope], (*j)->resolved_name, expr);
513 InterfaceFlags iface = (*i)->get_interface_flags(scope);
515 if((*i)->array_size>1 || ((*i)->array_size==1 && (iface&GOAL)))
517 if((*i)->variable->scope==scope || (iface&OUTPUT))
519 loop_size = (*i)->array_size;
520 loop_vars.push_back(*i);
525 if((*i)->variable->scope==scope && !(*i)->inlined)
527 string decl = ((iface&GOAL) ? (*i)->resolved_name : (*i)->create_declaration());
528 source += format("\t%s = %s;\n", decl, create_expression(**i));
531 if((iface&(OUTPUT|GOAL))==OUTPUT)
533 string expr = ((*i)->inlined ? create_expression(**i) : (*i)->resolved_name);
534 source += format("\t%c_%s = %s;\n", interfaces[scope], (*i)->resolved_name, expr);
543 bool ProgramBuilder::evaluate_flags(const char *flags) const
550 for(const char *i=flags; *i; ++i)
552 if(*i>='a' && *i<='z')
554 bool found = (feature_flags.find(*i)!=string::npos);
556 cond = (cond || found);
558 cond = (cond && !found);
560 cond = (cond && found);
570 const char *ProgramBuilder::unqualified_name(const char *name)
572 for(const char *p=name; *p; ++p)
573 if(*p==':' && *++p==':')
578 ProgramBuilder::MatchType ProgramBuilder::name_match(const char *n1, const char *n2, const char **space)
585 if(*n1==*n2 || *n1=='z' || *n2=='z')
589 int side = (*n1=='z' ? 1 : 2);
602 else if(i>=zzz+3 || side!=zside)
612 return (!*n1 && !*n2) ? (zzz>=0 ? FUZZY : EXACT) : ((*n1=='[' || *n2=='[') ? ARRAY : NO_MATCH);
615 bool ProgramBuilder::parse_identifier(const char *ptr, unsigned &start, unsigned &length)
619 bool subscript = false;
620 for(const char *i=ptr;; ++i)
626 if(isalpha(*i) || *i=='_')
645 length = i+1-(ptr+start);
648 else if(!isalpha(*i) || i>ptr+start+length+1)
651 else if(!isalnum(*i) && *i!='_')
653 length = i-(ptr+start);
663 vector<string> ProgramBuilder::extract_identifiers(const char *expression)
665 vector<string> result;
666 const char *ptr = expression;
669 while(parse_identifier(ptr, start, length))
671 result.push_back(string(ptr+start, length));
677 string ProgramBuilder::replace_identifiers(const char *expression, const map<string, string> &replace_map, bool with_functions)
680 const char *ptr = expression;
683 while(parse_identifier(ptr, start, length))
685 result.append(ptr, start);
686 string identifier(ptr+start, length);
687 map<string, string>::const_iterator i = replace_map.find(identifier);
688 if(i!=replace_map.end())
690 if(with_functions && ptr[start+length]=='(')
692 string::size_type lparen = i->second.find('(');
693 string::size_type rparen = i->second.rfind(')');
694 if(lparen!=string::npos && rparen!=string::npos)
698 for(j=start+length+1; (ptr[j] && level); ++j)
700 level += (ptr[j]=='(');
701 level -= (ptr[j]==')');
706 string subexpr(ptr+start+length, ptr+j);
707 result += i->second.substr(0, lparen);
708 result += replace_identifiers(subexpr.c_str(), replace_map, with_functions);
709 result += i->second.substr(rparen+1);
719 result += identifier;
726 string ProgramBuilder::create_expression(const ShaderVariable &var, const char *loop) const
728 string expr = var.create_expression(loop);
729 return replace_identifiers(expr.c_str(), aliases, true);
733 ProgramBuilder::StandardFeatures::StandardFeatures():
747 if(get_gl_api()==OPENGL_ES2)
748 legacy = !(get_glsl_version()>=Version(3, 0));
750 legacy = !(get_glsl_version()>=Version(1, 30));
753 string ProgramBuilder::StandardFeatures::create_flags() const
778 if(legacy && get_gl_api()==OPENGL)
785 ProgramBuilder::ShaderVariable::ShaderVariable(const std::string &n):
790 fuzzy_space(name.find("zzz")!=string::npos),
794 inline_parens(false),
797 string::size_type bracket = name.find('[');
798 if(bracket!=string::npos)
799 array_subscript = name.substr(bracket+1, name.size()-bracket-2);
802 void ProgramBuilder::ShaderVariable::resolve(const VariableDefinition &var)
805 const char *space = 0;
806 const char *var_uq_name = unqualified_name(variable->name);
807 MatchType match = name_match(var_uq_name, resolved_name.c_str(), &space);
809 if(var_uq_name!=variable->name)
810 resolved_block.assign(variable->name, var_uq_name-2);
813 resolve_space(string(space, 3));
814 else if(match==ARRAY)
816 if(array_subscript.empty())
818 else if(var.scope==UNIFORM)
820 const char *bracket = strrchr(variable->type, '[');
822 array_subscript = string(bracket+1, strlen(bracket)-2);
827 void ProgramBuilder::ShaderVariable::resolve(ShaderVariable &var)
829 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
830 (*i)->update_reference(*this, var);
831 var.referenced_by.insert(var.referenced_by.end(), referenced_by.begin(), referenced_by.end());
834 void ProgramBuilder::ShaderVariable::resolve_type(const VariableDefinition &var)
839 void ProgramBuilder::ShaderVariable::resolve_space(const string &space)
843 resolved_space = space;
845 string::size_type zzz = resolved_name.find("zzz");
846 resolved_name.replace(zzz, 3, resolved_space);
849 // Resolving the space could have affected other variables that use this one
850 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
851 (*i)->resolve_space(space);
854 for(list<ShaderVariable *>::iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
855 if((*i)->fuzzy_space)
856 (*i)->resolve_space(space);
859 void ProgramBuilder::ShaderVariable::resolve_array(const StandardFeatures &features, unsigned size_hint)
863 if(!array_sum && array_subscript.empty())
866 if(!array_subscript.empty())
868 string::size_type bracket = resolved_name.find('[');
869 if(bracket!=string::npos)
870 resolved_name = resolved_name.substr(0, bracket);
873 if(variable && variable->scope==UNIFORM)
875 if(array_subscript=="MAX_LIGHTS")
876 array_size = features.max_lights;
877 else if(array_subscript=="MAX_CLIP_PLANES")
878 array_size = features.max_clip_planes;
879 else if(isnumrc(array_subscript))
880 array_size = lexical_cast<unsigned>(array_subscript);
882 throw invalid_variable_definition("invalid array size");
887 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
890 array_size = (*i)->array_size;
895 if(!array_size && size_hint)
896 array_size = size_hint;
900 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
901 if(!(*i)->array_subscript.empty() && !(*i)->array_size)
902 (*i)->resolve_array(features, array_size);
906 void ProgramBuilder::ShaderVariable::add_reference(ShaderVariable &var)
908 referenced_vars.push_back(&var);
909 var.referenced_by.push_back(this);
910 if(var.fuzzy_space && !resolved_space.empty())
911 var.resolve_space(resolved_space);
914 void ProgramBuilder::ShaderVariable::update_reference(ShaderVariable &from, ShaderVariable &to)
916 replace(referenced_vars.begin(), referenced_vars.end(), &from, &to);
917 replace(referenced_by.begin(), referenced_by.end(), &from, &to);
918 if(from.fuzzy_space && !to.fuzzy_space && !to.resolved_space.empty())
919 resolve_space(to.resolved_space);
922 void ProgramBuilder::ShaderVariable::check_inline(bool allow_legacy, bool trivial_only)
924 if(variable->expression)
926 if(array_sum && array_size>1)
928 if(!allow_legacy && !strncmp(variable->expression, "gl_", 3))
931 // Never inline goal variables
932 if(referenced_by.empty())
935 // Inline an expression consisting of a single identifier
936 unsigned start, length;
937 if(parse_identifier(variable->expression, start, length))
938 if(start==0 && variable->expression[length]==0)
947 /* If all references to the variable come from arrays in the same scope
948 and of the same size, the variable can be embedded in the loop. */
949 in_loop = (array_size>1 && !array_sum);
950 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
951 if((*i)->variable->scope!=variable->scope || (*i)->array_size!=array_size)
954 /* Count all refs to this variable. Refs from array variables count once
955 per loop iteration. */
956 unsigned total_refs = 0;
957 unsigned in_scope_refs = 0;
958 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
960 unsigned count = max((*i)->array_size*!in_loop, 1U);
962 if((*i)->variable->scope==variable->scope)
963 in_scope_refs += count;
966 /* Inline if there's only one ref, or if all refs are in other scopes.
967 In the latter case, the actual inlining will happen in the interface
968 variable assignment. */
969 if(total_refs==1 || in_scope_refs==0)
973 for(const char *c=variable->expression; (!inline_parens && *c); ++c)
979 else if(level==0 && !isalnum(*c) && *c!='_' && *c!='.')
980 inline_parens = true;
986 bool ProgramBuilder::ShaderVariable::is_referenced_from(VariableScope scope) const
988 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
989 if((*i)->variable->scope==scope)
994 ProgramBuilder::InterfaceFlags ProgramBuilder::ShaderVariable::get_interface_flags(VariableScope scope) const
996 /* Uniforms are available to all stages and are not passed through
998 if(variable->scope==UNIFORM)
1001 int flags = NO_INTERFACE;
1003 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
1005 /* Variables used in a later scope than they are declared in need to go
1006 through the interface */
1007 if((*i)->variable->scope>scope && variable->scope<=scope)
1009 if((*i)->variable->scope>=scope && variable->scope<scope)
1010 if(!inlined || variable->scope!=ATTRIBUTE || scope!=VERTEX)
1014 // Variables without any references are goals and also outputs.
1015 if(referenced_by.empty() && variable->scope==scope)
1016 flags |= OUTPUT|GOAL;
1018 return static_cast<InterfaceFlags>(flags);
1021 string ProgramBuilder::ShaderVariable::create_type_declaration() const
1024 throw logic_error("no type");
1026 if(!strncmp(type->type, "struct", 6))
1028 const char *brace = strchr(type->type, '{');
1030 return format("struct %s %s", type->name, brace);
1033 throw invalid_variable_definition("invalid typedef");
1036 string ProgramBuilder::ShaderVariable::create_declaration(char iface, bool loop) const
1038 if(variable->scope==UNIFORM && !array_subscript.empty())
1040 const char *bracket = strrchr(variable->type, '[');
1042 return format("%s %s[%d]", string(variable->type, bracket), resolved_name, array_size);
1046 if(!array_sum && array_size>1 && !loop)
1047 array = format("[%d]", array_size);
1050 return format("%s %c_%s%s", variable->type, iface, resolved_name, array);
1052 return format("%s %s%s", variable->type, resolved_name, array);
1055 string ProgramBuilder::ShaderVariable::create_replacement(VariableScope from_scope, const char *loop) const
1057 string replacement = resolved_name;
1058 InterfaceFlags iface = NO_INTERFACE;
1061 iface = get_interface_flags(from_scope);
1062 if((iface&INPUT) && interfaces[from_scope-1])
1063 replacement = format("%c_%s", interfaces[from_scope-1], replacement);
1066 replacement = create_expression(loop);
1068 replacement = "("+replacement+")";
1073 // Add an array subscript, unless the variable is embedded in a loop
1074 if(!array_subscript.empty() && !in_loop)
1077 return format("%s[%s]", replacement, loop);
1078 else if(!variable || variable->scope==UNIFORM)
1079 return replacement+"[0]";
1085 string ProgramBuilder::ShaderVariable::create_expression(const char *loop) const
1087 map<string, string> replace_map;
1088 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
1090 string replacement = (*i)->create_replacement(variable->scope, loop);
1091 if(replacement!=(*i)->name)
1092 replace_map[(*i)->name] = replacement;
1095 if(replace_map.empty())
1096 return variable->expression;
1098 return replace_identifiers(variable->expression, replace_map);
1102 ProgramBuilder::StandardFeatures::Loader::Loader(StandardFeatures &f):
1103 DataFile::ObjectLoader<StandardFeatures>(f)
1105 add("clipping", &StandardFeatures::clipping);
1106 add("custom", &StandardFeatures::custom);
1107 add("fog", &StandardFeatures::fog);
1108 add("lighting", &StandardFeatures::lighting);
1109 add("material", &StandardFeatures::material);
1110 add("max_clip_planes", &StandardFeatures::max_clip_planes);
1111 add("max_lights", &StandardFeatures::max_lights);
1112 add("normalmap", &StandardFeatures::normalmap);
1113 add("reflection", &StandardFeatures::reflection);
1114 add("shadow", &StandardFeatures::shadow);
1115 add("skylight", &StandardFeatures::skylight);
1116 add("specular", &StandardFeatures::specular);
1117 add("texture", &StandardFeatures::texture);