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"
18 #pragma GCC diagnostic push
19 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
24 l_* Lighting component
28 tbn_* Tangent-Binormal-Normal space
30 env_* Environment space
31 *_dir Direction vector
33 zzz_* Wildcard space, resolved by the builder
34 All wildcard spaces within an expression must match
36 xxx_yyy_* Matrix that transforms between yyy to xxx
37 The vector is on the side of its designated space, result will be
39 *_matrix A matrix (duh)
40 *_rmatrix A mat4 that works with a row vector
42 rgb_* Color with rgb components only
43 color_* Color with rgba components
46 /* The array is stored in reverse order, so that variables always come after
47 anything that might need them. */
48 const ProgramBuilder::VariableDefinition ProgramBuilder::standard_variables[] =
50 { FRAGMENT, "gl_FragColor", "vec4", "frag_color", 0 },
51 { FRAGMENT, "frag_color", "vec4", "incoming_color", "!f" },
52 { FRAGMENT, "frag_color", "vec4", "vec4(mix(fog_color.rgb, incoming_color.rgb, fog_value), incoming_color.a)", "f" },
53 { FRAGMENT, "fog_value", "float", "exp(-fog_coord*fog_density)", 0 },
55 { FRAGMENT, "incoming_color", "vec4", "basic_color", "!e!l" },
56 { FRAGMENT, "incoming_color", "vec4", "vec4(rgb_surface, surface_alpha)", "!el" },
57 { FRAGMENT, "incoming_color", "vec4", "vec4(rgb_surface+rgb_reflection, surface_alpha)", "e" },
59 { FRAGMENT, "rgb_reflection", "vec3", "reflect_sample.rgb*reflectivity", 0 },
60 { FRAGMENT, "reflect_sample", "vec4", "textureCube(environment, env_reflect_dir)", 0 },
61 { FRAGMENT, "env_reflect_dir", "vec3", "env_eye_matrix*eye_reflect_dir", 0 },
62 { FRAGMENT, "eye_reflect_dir", "vec3", "eye_tbn_matrix*tbn_reflect_dir", "n" },
64 { FRAGMENT, "rgb_surface", "vec3", "rgb_unlit_surface", "!l" },
65 { FRAGMENT, "rgb_surface", "vec3", "rgb_lit_surface", "l" },
66 { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb", "!s" },
67 { FRAGMENT, "rgb_unlit_surface", "vec3", "basic_color.rgb*l_shadow", "s" },
68 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse", "!m!t" },
69 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_illumination_diffuse*diffuse_sample.rgb", "!mt" },
70 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse", "m!p" },
71 { FRAGMENT, "rgb_lit_surface", "vec3", "rgb_surface_ambient+rgb_surface_diffuse+rgb_surface_specular", "mp" },
73 { FRAGMENT, "surface_alpha", "float", "basic_color.a", "!m" },
74 { FRAGMENT, "surface_alpha", "float", "basic_color.a", "m!l" },
75 { FRAGMENT, "surface_alpha", "float", "material.diffuse.a", "ml!t" },
76 { FRAGMENT, "surface_alpha", "float", "material.diffuse.a*diffuse_sample.a", "mlt" },
77 { FRAGMENT, "basic_color", "vec4", "vec4(1.0)", "!m!t" },
78 { FRAGMENT, "basic_color", "vec4", "diffuse_sample", "!mt" },
79 { FRAGMENT, "basic_color", "vec4", "color", "m!t" },
80 { FRAGMENT, "basic_color", "vec4", "color*diffuse_sample", "mt" },
82 { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb", "!t" },
83 { FRAGMENT, "rgb_surface_ambient", "vec3", "rgb_illumination_ambient*material.ambient.rgb*diffuse_sample.rgb", "t" },
84 { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb", "!y" },
85 { FRAGMENT, "rgb_illumination_ambient", "vec3", "ambient_color.rgb+l_skylight*sky_color.rgb", "y" },
86 { FRAGMENT, "l_skylight", "float", "dot(n_zzz_normal, zzz_sky_dir)*0.5+0.5", 0 },
88 { FRAGMENT, "rgb_surface_specular", "vec3", "rgb_illumination_specular*material.specular.rgb", 0 },
89 { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct", "!y|e" },
90 { FRAGMENT, "rgb_illumination_specular", "vec3", "rgb_illumination_specular_direct+l_sky_specular*sky_color.rgb", "y!e" },
91 { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular", "!s" },
92 { FRAGMENT, "rgb_illumination_specular_direct", "vec3", "rgb_light_specular*l_shadow", "s" },
93 { FRAGMENT, "rgb_light_specular[i]", "vec3", "l_specular[i]*light_sources[i].specular.rgb", 0 },
94 { 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 },
95 { FRAGMENT, "l_specular[i]", "float", "pow(max(dot(n_zzz_half_vec[i], n_zzz_normal), 0.0), material.shininess)", 0 },
97 { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb", "!t" },
98 { FRAGMENT, "rgb_surface_diffuse", "vec3", "rgb_illumination_diffuse*material.diffuse.rgb*diffuse_sample.rgb", "t" },
99 { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse", "!s" },
100 { FRAGMENT, "rgb_illumination_diffuse", "vec3", "rgb_light_diffuse*l_shadow", "s" },
101 { FRAGMENT, "rgb_light_diffuse[i]", "vec3", "l_diffuse[i]*light_sources[i].diffuse.rgb", 0 },
102 { FRAGMENT, "l_diffuse[i]", "float", "max(dot(n_zzz_normal, n_zzz_light_dir[i]), 0.0)", 0 },
104 { FRAGMENT, "l_shadow", "float", "mix(1.0, shadow_sample, shadow_darkness)", 0 },
105 { FRAGMENT, "shadow_sample", "float", "shadow2D(shadow, shd_vertex)", 0 },
107 { FRAGMENT, "zzz_reflect_dir", "vec3", "reflect(zzz_incident_dir, n_zzz_normal)", 0 },
108 { FRAGMENT, "n_zzz_half_vec[i]", "vec3", "normalize(zzz_light_dir[i]-zzz_incident_dir)", 0 },
109 { FRAGMENT, "n_zzz_light_dir[i]", "vec3", "normalize(zzz_light_dir[i])", 0 },
110 { FRAGMENT, "n_tbn_normal", "vec3", "normal_sample*2.0-1.0", "n" },
111 { FRAGMENT, "n_eye_normal", "vec3", "normalize(eye_normal)", "!n" },
112 { FRAGMENT, "normal_sample", "vec3", "texture2D(normal_map, texture_coord).xyz", 0 },
113 { FRAGMENT, "diffuse_sample", "vec4", "texture2D(diffuse_map, texture_coord)", 0 },
115 { VERTEX, "gl_Position", "vec4", "projection_matrix*eye_vertex", 0 },
116 { VERTEX, "gl_ClipDistance[i]", "float", "dot(eye_vertex, clip_planes[i].equation)", "c" },
117 { VERTEX, "fog_coord", "float", "-eye_vertex.z", 0 },
118 { VERTEX, "shd_vertex", "vec3", "(shd_eye_matrix*eye_vertex).xyz", 0 },
119 { VERTEX, "tbn_sky_dir", "vec3", "eye_sky_dir*eye_tbn_matrix", "n" },
120 { VERTEX, "tbn_light_dir[i]", "vec3", "eye_light_dir[i]*eye_tbn_matrix", 0 },
121 { VERTEX, "eye_light_dir[i]", "vec3", "normalize(eye_light_position[i].xyz-eye_vertex.xyz*eye_light_position[i].w)", 0 },
122 { VERTEX, "eye_light_position[i]", "vec4", "light_sources[i].position", 0 },
123 { VERTEX, "tbn_incident_dir", "vec3", "eye_incident_dir*eye_tbn_matrix", 0 },
124 { VERTEX, "eye_incident_dir", "vec3", "normalize(eye_vertex.xyz)", 0 },
125 { VERTEX, "eye_tbn_matrix", "mat3", "mat3(eye_tangent, eye_binormal, eye_normal)", 0 },
126 { VERTEX, "eye_vertex", "vec4", "eye_obj_matrix*vertex", 0 },
127 { VERTEX, "eye_normal", "vec3", "eye_obj_normal_matrix*normal", 0 },
128 { VERTEX, "eye_tangent", "vec3", "eye_obj_normal_matrix*tangent", 0 },
129 { VERTEX, "eye_binormal", "vec3", "eye_obj_normal_matrix*binormal", 0 },
130 { VERTEX, "texture_coord", "vec2", "texcoord.xy", 0 },
132 { ATTRIBUTE, "vertex", "vec4", "gl_Vertex", 0 },
133 { ATTRIBUTE, "texcoord", "vec4", "gl_MultiTexCoord0", 0 },
134 { ATTRIBUTE, "color", "vec4", "gl_Color", 0 },
135 { ATTRIBUTE, "normal", "vec3", "gl_Normal", 0 },
136 { ATTRIBUTE, "tangent", "vec3", 0, 0 },
137 { ATTRIBUTE, "binormal", "vec3", 0, 0 },
139 { UNIFORM, "diffuse_map", "sampler2D", 0, 0 },
140 { UNIFORM, "shadow", "sampler2DShadow", 0, 0 },
141 { UNIFORM, "ShadowMap::shadow_darkness", "float", 0, 0 },
142 { UNIFORM, "normal_map", "sampler2D", 0, 0 },
143 { UNIFORM, "environment", "samplerCube", 0, 0 },
144 { UNIFORM, "EnvMap::env_eye_matrix", "mat3", 0, 0 },
145 { UNIFORM, "Material::reflectivity", "float", 0, 0 },
146 { UNIFORM, "eye_obj_matrix", "mat4", "gl_ModelViewMatrix", 0 },
147 { UNIFORM, "eye_obj_normal_matrix", "mat3", "gl_NormalMatrix", 0 },
148 { UNIFORM, "Transform::projection_matrix", "mat4", "gl_ProjectionMatrix", 0 },
149 { UNIFORM, "ShadowMap::shd_eye_matrix", "mat4", 0, 0 },
150 { UNIFORM, "Lighting::light_sources", "LightSourceParameters[MAX_LIGHTS]", "gl_LightSource[i]", 0 },
151 { UNIFORM, "Lighting::ambient_color", "vec4", "gl_LightModel.ambient", 0 },
152 { UNIFORM, "Lighting::sky_color", "vec4", 0, 0 },
153 { UNIFORM, "Lighting::eye_sky_dir", "vec3", 0, 0 },
154 { UNIFORM, "Lighting::horizon_limit", "float", 0, 0 },
155 { UNIFORM, "Lighting::fog_color", "vec4", "gl_Fog.color", 0 },
156 { UNIFORM, "Lighting::fog_density", "float", "gl_Fog.density", 0 },
157 { UNIFORM, "Material::material", "MaterialParameters", "gl_FrontMaterial", 0 },
158 { UNIFORM, "Clipping::clip_planes", "ClipPlane[MAX_CLIP_PLANES]", 0, 0 },
160 { TYPE, "LightSourceParameters", "struct { vec4 position; vec4 diffuse; vec4 specular; }", "gl_LightSourceParameters", 0 },
161 { TYPE, "MaterialParameters", "struct { vec4 ambient; vec4 diffuse; vec4 specular; float shininess; }", "gl_MaterialParameters", 0 },
162 { TYPE, "ClipPlane", "struct { vec4 equation; }", 0, 0 },
165 { NO_SCOPE, 0, 0, 0, 0 }
168 const char ProgramBuilder::interfaces[] = { 0, 0, 0, 0, 0, 'v', 'g', 0 };
170 ProgramBuilder::ProgramBuilder(const StandardFeatures &f):
172 feature_flags(features.create_flags()),
173 enabled_scopes((1<<N_SCOPES)-1),
176 if(!features.custom.empty())
178 const char *whitespace = " \t\n";
179 string::size_type start = 0;
182 start = features.custom.find_first_not_of(whitespace, start);
183 if(start==string::npos)
186 string::size_type semicolon = features.custom.find(';', start);
192 else if(semicolon==string::npos)
193 throw invalid_variable_definition(features.custom.substr(start));
195 string::size_type equals = features.custom.find('=', start);
197 equals = string::npos;
199 VariableDefinition var;
200 string::size_type decl_end = min(equals, semicolon);
201 for(unsigned i=0;; ++i)
203 string::size_type word_end = features.custom.find_first_of(whitespace, start);
204 word_end = min(word_end, decl_end);
205 features.custom[word_end] = 0;
207 const char *word = &features.custom[start];
210 if(!strcmp(word, "uniform"))
212 else if(!strcmp(word, "attribute"))
213 var.scope = ATTRIBUTE;
214 else if(!strcmp(word, "vertex"))
216 else if(!strcmp(word, "fragment"))
217 var.scope = FRAGMENT;
218 else if(!strcmp(word, "function"))
219 var.scope = FUNCTION;
221 throw invalid_variable_definition(word);
228 start = features.custom.find_first_not_of(whitespace, word_end+1);
229 if(start>=decl_end || (var.scope==FUNCTION && features.custom[start]=='('))
233 if(equals!=string::npos)
235 if(var.scope==FUNCTION)
236 throw invalid_variable_definition("function with expression");
237 start = features.custom.find_first_not_of(whitespace, equals+1);
239 throw invalid_variable_definition("no expression");
240 features.custom[semicolon] = 0;
241 var.expression = &features.custom[start];
243 else if(var.scope==FUNCTION)
245 string::size_type left_paren = features.custom.find('(', start);
246 string::size_type right_paren = features.custom.find(')', start);
247 if(left_paren>semicolon || right_paren>semicolon)
248 throw invalid_variable_definition("no argument list");
249 features.custom[right_paren] = 0;
250 var.expression = &features.custom[left_paren+1];
256 for(const VariableDefinition *j=standard_variables; j->name; ++j)
257 if(!strcmp(var.name, j->name))
260 custom_variables.push_front(var);
266 if(!features.geometry)
267 enabled_scopes &= ~(1<<GEOMETRY);
271 aliases["texture1D"] = "texture";
272 aliases["texture2D"] = "texture";
273 aliases["texture3D"] = "texture";
274 aliases["textureCube"] = "texture";
275 aliases["shadow2D"] = "texture";
278 aliases["shadow2D"] = "shadow2D(...).r";
281 void ProgramBuilder::set_optimize(bool o)
286 Program *ProgramBuilder::create_program() const
288 Program *prog = new Program;
293 void ProgramBuilder::add_shaders(Program &prog) const
295 list<ShaderVariable> variables;
296 list<ShaderVariable *> resolved_vars;
298 if(features.clipping)
299 variables.push_back(ShaderVariable("gl_ClipDistance[i]"));
300 variables.push_front(ShaderVariable("gl_Position"));
301 variables.push_front(ShaderVariable(features.legacy ? "gl_FragColor" : "frag_color"));
303 list<VariableDefinition>::const_iterator next_custom = custom_variables.begin();
304 for(const VariableDefinition *i=standard_variables; i->name; )
306 const VariableDefinition *def = 0;
307 if(next_custom!=custom_variables.end() && (!strcmp(next_custom->name, i->name) || !next_custom->flags))
317 // Skip over anything that isn't used with the supplied flags
318 if(def->flags && !evaluate_flags(def->flags))
324 for(list<ShaderVariable *>::iterator j=resolved_vars.begin(); j!=resolved_vars.end(); ++j)
325 if(!(*j)->type && name_match(def->name, (*j)->variable->type))
326 (*j)->resolve_type(*def);
331 const char *def_uq_name = unqualified_name(def->name);
333 // See if this variable can satisfy any unresolved variables
334 ShaderVariable *last_resolved = 0;
335 for(list<ShaderVariable>::iterator j=variables.begin(); j!=variables.end(); ++j)
340 if(!name_match(def_uq_name, j->resolved_name.c_str()))
345 /* We've already resolved a non-fuzzy variable in this iteration.
346 If there are multiple variables that can be resolved, they refer
347 to the same variable. */
348 j->resolve(*last_resolved);
353 resolved_vars.push_front(&*j);
360 vector<string> identifiers = extract_identifiers(def->expression);
361 for(vector<string>::const_iterator k=identifiers.begin(); k!=identifiers.end(); ++k)
363 // Use an existing variable if possible, but only if it's not fuzzy
364 ShaderVariable *var = 0;
365 for(list<ShaderVariable>::iterator l=variables.begin(); (!var && l!=variables.end()); ++l)
366 if(!l->fuzzy_space && l->resolved_name==*k)
371 variables.push_back(ShaderVariable(*k));
372 var = &variables.back();
374 j->add_reference(*var);
379 // Array sizes need to be resolved for inline processing
380 for(list<ShaderVariable>::iterator i=variables.end(); i!=variables.begin(); )
381 (--i)->resolve_array(features);
383 bool legacy_variables = evaluate_flags("g");
384 for(list<ShaderVariable *>::const_iterator i=resolved_vars.begin(); i!=resolved_vars.end(); ++i)
385 (*i)->check_inline(legacy_variables, !optimize);
387 prog.attach_shader_owned(new VertexShader(create_source(resolved_vars, VERTEX)));
388 prog.attach_shader_owned(new FragmentShader(create_source(resolved_vars, FRAGMENT)));
392 // OpenGL ES does not support binding fragment shader outputs
393 if(get_gl_api()!=OPENGL_ES2)
394 prog.bind_fragment_data(0, "frag_color");
396 prog.bind_attribute(VERTEX4, "vertex");
397 if(features.lighting)
398 prog.bind_attribute(NORMAL3, "normal");
399 else if(features.material)
400 prog.bind_attribute(COLOR4_FLOAT, "color");
401 if(features.texture || features.normal_map)
402 prog.bind_attribute(TEXCOORD4, "texcoord");
404 if(features.normal_map)
406 prog.bind_attribute(get_component_type(TANGENT3), "tangent");
407 prog.bind_attribute(get_component_type(BINORMAL3), "binormal");
411 string ProgramBuilder::create_source(const list<ShaderVariable *> &variables, VariableScope scope) const
415 bool use_blocks = !features.legacy && ARB_uniform_buffer_object;
419 if(get_gl_api()==OPENGL_ES2)
422 source += "#version 300 es\n";
426 source += "#version 130\n";
428 source += "#extension GL_ARB_uniform_buffer_object: require\n";
432 if(get_gl_api()==OPENGL_ES2)
433 source += "precision mediump float;\n";
435 set<const VariableDefinition *> declared_types;
436 set<string> uniform_blocks;
437 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
439 if(!(*i)->is_referenced_from(scope))
442 if((*i)->variable->scope==FUNCTION)
443 source += format("%s;\n", (*i)->create_declaration());
444 else if((*i)->variable->scope==UNIFORM && !(*i)->inlined)
446 if((*i)->type && !declared_types.count((*i)->type))
448 source += format("%s;\n", (*i)->create_type_declaration());
449 declared_types.insert((*i)->type);
452 if(!(*i)->resolved_block.empty() && use_blocks)
453 uniform_blocks.insert((*i)->resolved_block);
455 source += format("uniform %s;\n", (*i)->create_declaration());
459 for(set<string>::const_iterator i=uniform_blocks.begin(); i!=uniform_blocks.end(); ++i)
461 source += format("uniform %s\n{\n", *i);
462 for(list<ShaderVariable *>::const_iterator j=variables.begin(); j!=variables.end(); ++j)
463 if((*j)->resolved_block==*i)
464 source += format("\t%s;\n", (*j)->create_declaration());
468 /* Interface variables need to have global declarations. */
469 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
471 if(!(*i)->resolved_name.compare(0, 3, "gl_"))
474 InterfaceFlags iface = (*i)->get_interface_flags(scope);
478 const char *qualifier = (features.legacy ? scope==VERTEX ? "attribute" : "varying" : "in");
479 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[previous_scope(scope, enabled_scopes)]));
484 const char *qualifier = (features.legacy ? "varying" : "out");
485 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope]));
489 // The clip distance array must be declared manually to give it a size
490 if(scope==VERTEX && features.clipping)
491 source += format("out float gl_ClipDistance[%d];\n", features.max_clip_planes);
493 source += "void main()\n{\n";
495 list<ShaderVariable *> loop_vars;
496 unsigned loop_size = 0;
497 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
499 if(!loop_vars.empty() && !loop_vars.back()->in_loop && (*i)->array_size!=loop_size)
501 /* Declare all variables that need to be visible outside the loop.
502 Output variables are already declared. */
503 for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
505 InterfaceFlags iface = (*j)->get_interface_flags(scope);
506 if(!(*j)->in_loop && !(iface&OUTPUT))
507 source += format("\t%s;\n", (*j)->create_declaration());
510 source += format("\tfor(int i=0; i<%d; ++i)\n\t{\n", loop_size);
511 for(list<ShaderVariable *>::const_iterator j=loop_vars.begin(); j!=loop_vars.end(); ++j)
513 if((*j)->variable->scope==scope && !(*j)->inlined)
517 decl = (*j)->create_declaration(0, true);
520 decl = (*j)->resolved_name;
524 const char *oper = ((*j)->array_sum ? "+=" : "=");
525 source += format("\t\t%s %s %s;\n", decl, oper, create_expression(**j, "i"));
528 InterfaceFlags iface = (*j)->get_interface_flags(scope);
529 if((iface&(OUTPUT|GOAL))==OUTPUT)
531 string expr = ((*j)->inlined ? create_expression(**j, "i") : (*j)->resolved_name+"[i]");
532 source += format("\t\t%c_%s[i] = %s;\n", interfaces[scope], (*j)->resolved_name, expr);
540 InterfaceFlags iface = (*i)->get_interface_flags(scope);
542 if((*i)->array_size>1 || ((*i)->array_size==1 && (iface&GOAL)))
544 if((*i)->variable->scope==scope || (iface&OUTPUT))
546 loop_size = (*i)->array_size;
547 loop_vars.push_back(*i);
552 if((*i)->variable->scope==scope && !(*i)->inlined)
554 string decl = ((iface&GOAL) ? (*i)->resolved_name : (*i)->create_declaration());
555 source += format("\t%s = %s;\n", decl, create_expression(**i));
558 if((iface&(OUTPUT|GOAL))==OUTPUT)
560 string expr = ((*i)->inlined ? create_expression(**i) : (*i)->resolved_name);
561 source += format("\t%c_%s = %s;\n", interfaces[scope], (*i)->resolved_name, expr);
570 bool ProgramBuilder::evaluate_flags(const char *flags) const
577 for(const char *i=flags; *i; ++i)
579 if(*i>='a' && *i<='z')
581 bool found = (feature_flags.find(*i)!=string::npos);
583 cond = (cond || found);
585 cond = (cond && !found);
587 cond = (cond && found);
597 const char *ProgramBuilder::unqualified_name(const char *name)
599 for(const char *p=name; *p; ++p)
600 if(*p==':' && *++p==':')
605 ProgramBuilder::MatchType ProgramBuilder::name_match(const char *n1, const char *n2, const char **space)
612 if(*n1==*n2 || *n1=='z' || *n2=='z')
616 int side = (*n1=='z' ? 1 : 2);
629 else if(i>=zzz+3 || side!=zside)
639 return (!*n1 && !*n2) ? (zzz>=0 ? FUZZY : EXACT) : ((*n1=='[' || *n2=='[') ? ARRAY : NO_MATCH);
642 bool ProgramBuilder::parse_identifier(const char *ptr, unsigned &start, unsigned &length)
646 bool subscript = false;
647 for(const char *i=ptr;; ++i)
653 if(isalpha(*i) || *i=='_')
672 length = i+1-(ptr+start);
675 else if(!isalpha(*i) || i>ptr+start+length+1)
678 else if(!isalnum(*i) && *i!='_')
680 length = i-(ptr+start);
690 vector<string> ProgramBuilder::extract_identifiers(const char *expression)
692 vector<string> result;
693 const char *ptr = expression;
696 while(parse_identifier(ptr, start, length))
698 result.push_back(string(ptr+start, length));
704 string ProgramBuilder::replace_identifiers(const char *expression, const map<string, string> &replace_map, bool with_functions)
707 const char *ptr = expression;
710 while(parse_identifier(ptr, start, length))
712 result.append(ptr, start);
713 string identifier(ptr+start, length);
714 map<string, string>::const_iterator i = replace_map.find(identifier);
715 if(i!=replace_map.end())
717 if(with_functions && ptr[start+length]=='(')
719 string::size_type lparen = i->second.find('(');
720 string::size_type rparen = i->second.rfind(')');
721 if(lparen!=string::npos && rparen!=string::npos)
725 for(j=start+length+1; (ptr[j] && level); ++j)
727 level += (ptr[j]=='(');
728 level -= (ptr[j]==')');
733 string subexpr(ptr+start+length, ptr+j);
734 result += i->second.substr(0, lparen);
735 result += replace_identifiers(subexpr.c_str(), replace_map, with_functions);
736 result += i->second.substr(rparen+1);
746 result += identifier;
753 ProgramBuilder::VariableScope ProgramBuilder::previous_scope(VariableScope scope, unsigned enabled_scopes)
755 while(scope!=NO_SCOPE)
757 scope = static_cast<VariableScope>(scope-1);
758 if(enabled_scopes&(1<<scope))
765 string ProgramBuilder::create_expression(const ShaderVariable &var, const char *loop) const
767 string expr = var.create_expression(enabled_scopes, loop);
768 return replace_identifiers(expr.c_str(), aliases, true);
772 ProgramBuilder::StandardFeatures::StandardFeatures():
787 if(get_gl_api()==OPENGL_ES2)
788 legacy = get_glsl_version()<Version(3, 0);
790 legacy = get_glsl_version()<Version(1, 30);
793 string ProgramBuilder::StandardFeatures::create_flags() const
818 if(legacy && get_gl_api()==OPENGL)
825 ProgramBuilder::ShaderVariable::ShaderVariable(const std::string &n):
830 fuzzy_space(name.find("zzz")!=string::npos),
834 inline_parens(false),
837 string::size_type bracket = name.find('[');
838 if(bracket!=string::npos)
839 array_subscript = name.substr(bracket+1, name.size()-bracket-2);
842 void ProgramBuilder::ShaderVariable::resolve(const VariableDefinition &var)
845 const char *space = 0;
846 const char *var_uq_name = unqualified_name(variable->name);
847 MatchType match = name_match(var_uq_name, resolved_name.c_str(), &space);
849 if(var_uq_name!=variable->name)
850 resolved_block.assign(variable->name, var_uq_name-2);
853 resolve_space(string(space, 3));
854 else if(match==ARRAY)
856 if(array_subscript.empty())
858 else if(var.scope==UNIFORM)
860 const char *bracket = strrchr(variable->type, '[');
862 array_subscript = string(bracket+1, strlen(bracket)-2);
867 void ProgramBuilder::ShaderVariable::resolve(ShaderVariable &var)
869 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
870 (*i)->update_reference(*this, var);
871 var.referenced_by.insert(var.referenced_by.end(), referenced_by.begin(), referenced_by.end());
874 void ProgramBuilder::ShaderVariable::resolve_type(const VariableDefinition &var)
879 void ProgramBuilder::ShaderVariable::resolve_space(const string &space)
883 resolved_space = space;
885 string::size_type zzz = resolved_name.find("zzz");
886 resolved_name.replace(zzz, 3, resolved_space);
889 // Resolving the space could have affected other variables that use this one
890 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
891 (*i)->resolve_space(space);
894 for(list<ShaderVariable *>::iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
895 if((*i)->fuzzy_space)
896 (*i)->resolve_space(space);
899 void ProgramBuilder::ShaderVariable::resolve_array(const StandardFeatures &feat, unsigned size_hint)
903 if(!array_sum && array_subscript.empty())
906 if(!array_subscript.empty())
908 string::size_type bracket = resolved_name.find('[');
909 if(bracket!=string::npos)
910 resolved_name = resolved_name.substr(0, bracket);
913 if(variable && variable->scope==UNIFORM)
915 if(array_subscript=="MAX_LIGHTS")
916 array_size = feat.max_lights;
917 else if(array_subscript=="MAX_CLIP_PLANES")
918 array_size = feat.max_clip_planes;
919 else if(isnumrc(array_subscript))
920 array_size = lexical_cast<unsigned>(array_subscript);
922 throw invalid_variable_definition("invalid array size");
927 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
930 array_size = (*i)->array_size;
935 if(!array_size && size_hint)
936 array_size = size_hint;
940 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
941 if(!(*i)->array_subscript.empty() && !(*i)->array_size)
942 (*i)->resolve_array(feat, array_size);
946 void ProgramBuilder::ShaderVariable::add_reference(ShaderVariable &var)
948 referenced_vars.push_back(&var);
949 var.referenced_by.push_back(this);
950 if(var.fuzzy_space && !resolved_space.empty())
951 var.resolve_space(resolved_space);
954 void ProgramBuilder::ShaderVariable::update_reference(ShaderVariable &from, ShaderVariable &to)
956 replace(referenced_vars.begin(), referenced_vars.end(), &from, &to);
957 replace(referenced_by.begin(), referenced_by.end(), &from, &to);
958 if(from.fuzzy_space && !to.fuzzy_space && !to.resolved_space.empty())
959 resolve_space(to.resolved_space);
962 void ProgramBuilder::ShaderVariable::check_inline(bool allow_legacy, bool trivial_only)
964 if(variable->expression && variable->scope>=UNIFORM)
966 if(array_sum && array_size>1)
968 if(!allow_legacy && !strncmp(variable->expression, "gl_", 3))
971 // Never inline goal variables
972 if(referenced_by.empty())
975 // Inline an expression consisting of a single identifier
976 unsigned start, length;
977 if(parse_identifier(variable->expression, start, length))
978 if(start==0 && variable->expression[length]==0)
987 /* If all references to the variable come from arrays in the same scope
988 and of the same size, the variable can be embedded in the loop. */
989 in_loop = (array_size>1 && !array_sum);
990 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
991 if((*i)->variable->scope!=variable->scope || (*i)->array_size!=array_size)
994 /* Count all refs to this variable. Refs from array variables count once
995 per loop iteration. */
996 unsigned total_refs = 0;
997 unsigned in_scope_refs = 0;
998 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
1000 unsigned count = max((*i)->array_size*!in_loop, 1U);
1001 total_refs += count;
1002 if((*i)->variable->scope==variable->scope)
1003 in_scope_refs += count;
1006 /* Inline if there's only one ref, or if all refs are in other scopes.
1007 In the latter case, the actual inlining will happen in the interface
1008 variable assignment. */
1009 if(total_refs==1 || in_scope_refs==0)
1013 for(const char *c=variable->expression; (!inline_parens && *c); ++c)
1019 else if(level==0 && !isalnum(*c) && *c!='_' && *c!='.')
1020 inline_parens = true;
1026 bool ProgramBuilder::ShaderVariable::is_referenced_from(VariableScope scope) const
1028 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
1029 if((*i)->variable->scope==scope)
1034 ProgramBuilder::InterfaceFlags ProgramBuilder::ShaderVariable::get_interface_flags(VariableScope scope) const
1036 /* Uniforms are available to all stages and are not passed through
1038 if(variable->scope<=UNIFORM)
1039 return NO_INTERFACE;
1041 int flags = NO_INTERFACE;
1043 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
1045 /* Variables used in a later scope than they are declared in need to go
1046 through the interface */
1047 if((*i)->variable->scope>scope && variable->scope<=scope)
1049 if((*i)->variable->scope>=scope && variable->scope<scope)
1050 if(!inlined || variable->scope!=ATTRIBUTE || scope!=VERTEX)
1054 // Variables without any references are goals and also outputs.
1055 if(referenced_by.empty() && variable->scope==scope)
1056 flags |= OUTPUT|GOAL;
1058 return static_cast<InterfaceFlags>(flags);
1061 string ProgramBuilder::ShaderVariable::create_type_declaration() const
1064 throw logic_error("no type");
1066 if(!strncmp(type->type, "struct", 6))
1068 const char *brace = strchr(type->type, '{');
1070 return format("struct %s %s", type->name, brace);
1073 throw invalid_variable_definition("invalid typedef");
1076 string ProgramBuilder::ShaderVariable::create_declaration(char iface, bool loop) const
1078 if(variable->scope==FUNCTION)
1079 return format("%s %s(%s)", variable->type, resolved_name, variable->expression);
1081 if(variable->scope==UNIFORM && !array_subscript.empty())
1083 const char *bracket = strrchr(variable->type, '[');
1085 return format("%s %s[%d]", string(variable->type, bracket), resolved_name, array_size);
1089 if(!array_sum && array_size>1 && !loop)
1090 array = format("[%d]", array_size);
1093 return format("%s %c_%s%s", variable->type, iface, resolved_name, array);
1095 return format("%s %s%s", variable->type, resolved_name, array);
1098 string ProgramBuilder::ShaderVariable::create_replacement(VariableScope from_scope, unsigned scopes, const char *loop) const
1100 string replacement = resolved_name;
1101 InterfaceFlags iface = NO_INTERFACE;
1104 iface = get_interface_flags(from_scope);
1105 VariableScope prev_scope = previous_scope(from_scope, scopes);
1106 if((iface&INPUT) && interfaces[prev_scope])
1107 replacement = format("%c_%s", interfaces[prev_scope], replacement);
1110 replacement = create_expression(scopes, loop);
1112 replacement = "("+replacement+")";
1117 // Add an array subscript, unless the variable is embedded in a loop
1118 if(!array_subscript.empty() && !in_loop)
1121 return format("%s[%s]", replacement, loop);
1122 else if(!variable || variable->scope==UNIFORM)
1123 return replacement+"[0]";
1129 string ProgramBuilder::ShaderVariable::create_expression(unsigned scopes, const char *loop) const
1131 map<string, string> replace_map;
1132 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
1134 string replacement = (*i)->create_replacement(variable->scope, scopes, loop);
1135 if(replacement!=(*i)->name)
1136 replace_map[(*i)->name] = replacement;
1139 if(replace_map.empty())
1140 return variable->expression;
1142 return replace_identifiers(variable->expression, replace_map);
1146 ProgramBuilder::StandardFeatures::Loader::Loader(StandardFeatures &f):
1147 DataFile::ObjectLoader<StandardFeatures>(f)
1149 add("clipping", &StandardFeatures::clipping);
1150 add("custom", &StandardFeatures::custom);
1151 add("fog", &StandardFeatures::fog);
1152 add("geometry", &StandardFeatures::geometry);
1153 add("lighting", &StandardFeatures::lighting);
1154 add("material", &StandardFeatures::material);
1155 add("max_clip_planes", &StandardFeatures::max_clip_planes);
1156 add("max_lights", &StandardFeatures::max_lights);
1157 add("normal_map", &StandardFeatures::normal_map);
1158 add("reflection", &StandardFeatures::reflection);
1159 add("shadow", &StandardFeatures::shadow);
1160 add("skylight", &StandardFeatures::skylight);
1161 add("specular", &StandardFeatures::specular);
1162 add("texture", &StandardFeatures::texture);
1165 add("normalmap", &StandardFeatures::normal_map);
1168 #pragma GCC diagnostic pop