glsl/glcpp: Fix glcpp to catch garbage after #if 1 ... #else
[mesa.git] / src / glsl / glcpp / glcpp-parse.y
index 6cb5009e86193a4dc2d3705af6ff06529dea94fc..82e310270d6324b5dff100926c50f733a9d51429 100644 (file)
@@ -135,7 +135,7 @@ _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc);
 
 static void
 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
-                                         const char *ident);
+                                         const char *ident, bool explicitly_set);
 
 static int
 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser);
@@ -194,12 +194,15 @@ line:
        control_line {
                ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length, "\n");
        }
-|      HASH_LINE pp_tokens NEWLINE {
+|      HASH_LINE {
+               glcpp_parser_resolve_implicit_version(parser);
+       } pp_tokens NEWLINE {
+
                if (parser->skip_stack == NULL ||
                    parser->skip_stack->type == SKIP_NO_SKIP)
                {
                        _glcpp_parser_expand_and_lex_from (parser,
-                                                          LINE_EXPANDED, $2);
+                                                          LINE_EXPANDED, $3);
                }
        }
 |      text_line {
@@ -238,25 +241,41 @@ expanded_line:
        }
 ;
 
-control_line:
-       HASH_DEFINE OBJ_IDENTIFIER replacement_list NEWLINE {
-               _define_object_macro (parser, & @2, $2, $3);
+define:
+       OBJ_IDENTIFIER replacement_list NEWLINE {
+               _define_object_macro (parser, & @1, $1, $2);
        }
-|      HASH_DEFINE FUNC_IDENTIFIER '(' ')' replacement_list NEWLINE {
-               _define_function_macro (parser, & @2, $2, NULL, $5);
+|      FUNC_IDENTIFIER '(' ')' replacement_list NEWLINE {
+               _define_function_macro (parser, & @1, $1, NULL, $4);
        }
-|      HASH_DEFINE FUNC_IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
-               _define_function_macro (parser, & @2, $2, $4, $6);
+|      FUNC_IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
+               _define_function_macro (parser, & @1, $1, $3, $5);
        }
-|      HASH_UNDEF IDENTIFIER NEWLINE {
-               macro_t *macro = hash_table_find (parser->defines, $2);
+;
+
+control_line:
+       HASH_DEFINE {
+               glcpp_parser_resolve_implicit_version(parser);
+       } define
+|      HASH_UNDEF {
+               glcpp_parser_resolve_implicit_version(parser);
+       } IDENTIFIER NEWLINE {
+               if (strcmp("__LINE__", $3) == 0
+                   || strcmp("__FILE__", $3) == 0
+                   || strcmp("__VERSION__", $3) == 0)
+                       glcpp_error(& @1, parser, "Built-in (pre-defined)"
+                                   " macro names can not be undefined.");
+
+               macro_t *macro = hash_table_find (parser->defines, $3);
                if (macro) {
-                       hash_table_remove (parser->defines, $2);
+                       hash_table_remove (parser->defines, $3);
                        ralloc_free (macro);
                }
-               ralloc_free ($2);
+               ralloc_free ($3);
        }
-|      HASH_IF conditional_tokens NEWLINE {
+|      HASH_IF {
+               glcpp_parser_resolve_implicit_version(parser);
+       } conditional_tokens NEWLINE {
                /* Be careful to only evaluate the 'if' expression if
                 * we are not skipping. When we are skipping, we
                 * simply push a new 0-valued 'if' onto the skip
@@ -268,7 +287,7 @@ control_line:
                    parser->skip_stack->type == SKIP_NO_SKIP)
                {
                        _glcpp_parser_expand_and_lex_from (parser,
-                                                          IF_EXPANDED, $2);
+                                                          IF_EXPANDED, $3);
                }       
                else
                {
@@ -286,15 +305,19 @@ control_line:
                }       
                _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
        }
-|      HASH_IFDEF IDENTIFIER junk NEWLINE {
-               macro_t *macro = hash_table_find (parser->defines, $2);
-               ralloc_free ($2);
+|      HASH_IFDEF {
+               glcpp_parser_resolve_implicit_version(parser);
+       } IDENTIFIER junk NEWLINE {
+               macro_t *macro = hash_table_find (parser->defines, $3);
+               ralloc_free ($3);
                _glcpp_parser_skip_stack_push_if (parser, & @1, macro != NULL);
        }
-|      HASH_IFNDEF IDENTIFIER junk NEWLINE {
-               macro_t *macro = hash_table_find (parser->defines, $2);
-               ralloc_free ($2);
-               _glcpp_parser_skip_stack_push_if (parser, & @1, macro == NULL);
+|      HASH_IFNDEF {
+               glcpp_parser_resolve_implicit_version(parser);
+       } IDENTIFIER junk NEWLINE {
+               macro_t *macro = hash_table_find (parser->defines, $3);
+               ralloc_free ($3);
+               _glcpp_parser_skip_stack_push_if (parser, & @2, macro == NULL);
        }
 |      HASH_ELIF conditional_tokens NEWLINE {
                /* Be careful to only evaluate the 'elif' expression
@@ -310,6 +333,11 @@ control_line:
                        _glcpp_parser_expand_and_lex_from (parser,
                                                           ELIF_EXPANDED, $2);
                }
+               else if (parser->skip_stack &&
+                   parser->skip_stack->has_else)
+               {
+                       glcpp_error(& @1, parser, "#elif after #else");
+               }
                else
                {
                        _glcpp_parser_skip_stack_change_if (parser, & @1,
@@ -324,6 +352,11 @@ control_line:
                {
                        glcpp_error(& @1, parser, "#elif with no expression");
                }
+               else if (parser->skip_stack &&
+                   parser->skip_stack->has_else)
+               {
+                       glcpp_error(& @1, parser, "#elif after #else");
+               }
                else
                {
                        _glcpp_parser_skip_stack_change_if (parser, & @1,
@@ -331,19 +364,37 @@ control_line:
                        glcpp_warning(& @1, parser, "ignoring illegal #elif without expression");
                }
        }
-|      HASH_ELSE {
-               _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
-       } NEWLINE
+|      HASH_ELSE { parser->lexing_directive = 1; } NEWLINE {
+               if (parser->skip_stack &&
+                   parser->skip_stack->has_else)
+               {
+                       glcpp_error(& @1, parser, "multiple #else");
+               }
+               else
+               {
+                       _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
+                       if (parser->skip_stack)
+                               parser->skip_stack->has_else = true;
+               }
+       }
 |      HASH_ENDIF {
                _glcpp_parser_skip_stack_pop (parser, & @1);
        } NEWLINE
 |      HASH_VERSION integer_constant NEWLINE {
-               _glcpp_parser_handle_version_declaration(parser, $2, NULL);
+               if (parser->version_resolved) {
+                       glcpp_error(& @1, parser, "#version must appear on the first line");
+               }
+               _glcpp_parser_handle_version_declaration(parser, $2, NULL, true);
        }
 |      HASH_VERSION integer_constant IDENTIFIER NEWLINE {
-               _glcpp_parser_handle_version_declaration(parser, $2, $3);
+               if (parser->version_resolved) {
+                       glcpp_error(& @1, parser, "#version must appear on the first line");
+               }
+               _glcpp_parser_handle_version_declaration(parser, $2, $3, true);
+       }
+|      HASH NEWLINE {
+               glcpp_parser_resolve_implicit_version(parser);
        }
-|      HASH NEWLINE
 ;
 
 integer_constant:
@@ -888,14 +939,16 @@ _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
 
                if (node_a == NULL || node_b == NULL)
                        return 0;
-
-               if (node_a->token->type == SPACE) {
-                       node_a = node_a->next;
-                       continue;
-               }
-
-               if (node_b->token->type == SPACE) {
-                       node_b = node_b->next;
+               /* Make sure whitespace appears in the same places in both.
+                * It need not be exactly the same amount of whitespace,
+                * though.
+                */
+               if (node_a->token->type == SPACE
+                   && node_b->token->type == SPACE) {
+                       while (node_a->token->type == SPACE)
+                               node_a = node_a->next;
+                       while (node_b->token->type == SPACE)
+                               node_b = node_b->next;
                        continue;
                }
 
@@ -1148,10 +1201,9 @@ static void add_builtin_define(glcpp_parser_t *parser,
 }
 
 glcpp_parser_t *
-glcpp_parser_create (const struct gl_extensions *extensions, int api)
+glcpp_parser_create (const struct gl_extensions *extensions, gl_api api)
 {
        glcpp_parser_t *parser;
-       int language_version;
 
        parser = ralloc (NULL, glcpp_parser_t);
 
@@ -1159,11 +1211,12 @@ glcpp_parser_create (const struct gl_extensions *extensions, int api)
        parser->defines = hash_table_ctor (32, hash_table_string_hash,
                                           hash_table_string_compare);
        parser->active = NULL;
-       parser->lexing_if = 0;
+       parser->lexing_directive = 0;
        parser->space_tokens = 1;
        parser->newline_as_space = 0;
        parser->in_control_line = 0;
        parser->paren_count = 0;
+        parser->commented_newlines = 0;
 
        parser->skip_stack = NULL;
 
@@ -1176,78 +1229,15 @@ glcpp_parser_create (const struct gl_extensions *extensions, int api)
        parser->info_log_length = 0;
        parser->error = 0;
 
+        parser->extensions = extensions;
+        parser->api = api;
+        parser->version_resolved = false;
+
        parser->has_new_line_number = 0;
        parser->new_line_number = 1;
        parser->has_new_source_number = 0;
        parser->new_source_number = 0;
 
-       parser->is_gles = false;
-
-       /* Add pre-defined macros. */
-       if (api == API_OPENGLES2) {
-           parser->is_gles = true;
-           add_builtin_define(parser, "GL_ES", 1);
-
-           if (extensions != NULL) {
-              if (extensions->OES_EGL_image_external)
-                 add_builtin_define(parser, "GL_OES_EGL_image_external", 1);
-           }
-       } else {
-          add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
-          add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
-
-          if (extensions != NULL) {
-             if (extensions->EXT_texture_array) {
-                add_builtin_define(parser, "GL_EXT_texture_array", 1);
-             }
-
-             if (extensions->ARB_fragment_coord_conventions)
-                add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
-                                   1);
-
-             if (extensions->ARB_explicit_attrib_location)
-                add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
-
-             if (extensions->ARB_shader_texture_lod)
-                add_builtin_define(parser, "GL_ARB_shader_texture_lod", 1);
-
-             if (extensions->ARB_draw_instanced)
-                add_builtin_define(parser, "GL_ARB_draw_instanced", 1);
-
-             if (extensions->ARB_conservative_depth) {
-                add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
-                add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
-             }
-
-             if (extensions->ARB_shader_bit_encoding)
-                add_builtin_define(parser, "GL_ARB_shader_bit_encoding", 1);
-
-             if (extensions->ARB_uniform_buffer_object)
-                add_builtin_define(parser, "GL_ARB_uniform_buffer_object", 1);
-
-             if (extensions->ARB_texture_cube_map_array)
-                add_builtin_define(parser, "GL_ARB_texture_cube_map_array", 1);
-
-             if (extensions->ARB_shading_language_packing)
-                add_builtin_define(parser, "GL_ARB_shading_language_packing", 1);
-
-             if (extensions->ARB_texture_multisample)
-                add_builtin_define(parser, "GL_ARB_texture_multisample", 1);
-
-             if (extensions->ARB_texture_query_lod)
-                add_builtin_define(parser, "GL_ARB_texture_query_lod", 1);
-
-             if (extensions->ARB_gpu_shader5)
-                add_builtin_define(parser, "GL_ARB_gpu_shader5", 1);
-
-             if (extensions->AMD_vertex_shader_layer)
-                add_builtin_define(parser, "GL_AMD_vertex_shader_layer", 1);
-          }
-       }
-
-       language_version = 110;
-       add_builtin_define(parser, "__VERSION__", language_version);
-
        return parser;
 }
 
@@ -1788,11 +1778,27 @@ static void
 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
                                const char *identifier)
 {
-       /* According to the GLSL specification, macro names starting with "__"
-        * or "GL_" are reserved for future use.  So, don't allow them.
+       /* Section 3.3 (Preprocessor) of the GLSL 1.30 spec (and later) and
+        * the GLSL ES spec (all versions) say:
+        *
+        *     "All macro names containing two consecutive underscores ( __ )
+        *     are reserved for future use as predefined macro names. All
+        *     macro names prefixed with "GL_" ("GL" followed by a single
+        *     underscore) are also reserved."
+        *
+        * The intention is that names containing __ are reserved for internal
+        * use by the implementation, and names prefixed with GL_ are reserved
+        * for use by Khronos.  Since every extension adds a name prefixed
+        * with GL_ (i.e., the name of the extension), that should be an
+        * error.  Names simply containing __ are dangerous to use, but should
+        * be allowed.
+        *
+        * A future version of the GLSL specification will clarify this.
         */
        if (strstr(identifier, "__")) {
-               glcpp_error (loc, parser, "Macro names containing \"__\" are reserved.\n");
+               glcpp_warning(loc, parser,
+                             "Macro names containing \"__\" are reserved "
+                             "for use by the implementation.\n");
        }
        if (strncmp(identifier, "GL_", 3) == 0) {
                glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
@@ -2006,6 +2012,7 @@ _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
                node->type = SKIP_TO_ENDIF;
        }
 
+       node->has_else = false;
        node->next = parser->skip_stack;
        parser->skip_stack = node;
 }
@@ -2044,24 +2051,125 @@ _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
 
 static void
 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
-                                         const char *es_identifier)
+                                         const char *es_identifier,
+                                         bool explicitly_set)
 {
-       macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
-       if (macro) {
-               hash_table_remove (parser->defines, "__VERSION__");
-               ralloc_free (macro);
-       }
+       const struct gl_extensions *extensions = parser->extensions;
+
+       if (parser->version_resolved)
+               return;
+
+       parser->version_resolved = true;
+
        add_builtin_define (parser, "__VERSION__", version);
 
-       /* If we didn't have a GLES context to begin with, (indicated
-        * by parser->api), then the version declaration here might
-        * indicate GLES. */
-       if (! parser->is_gles &&
-           (version == 100 ||
-            (es_identifier && (strcmp(es_identifier, "es") == 0))))
-       {
-               parser->is_gles = true;
-               add_builtin_define (parser, "GL_ES", 1);
+       parser->is_gles = (version == 100) ||
+                          (es_identifier &&
+                           (strcmp(es_identifier, "es") == 0));
+
+       /* Add pre-defined macros. */
+       if (parser->is_gles) {
+          add_builtin_define(parser, "GL_ES", 1);
+           add_builtin_define(parser, "GL_EXT_separate_shader_objects", 1);
+
+          if (extensions != NULL) {
+             if (extensions->OES_EGL_image_external)
+                add_builtin_define(parser, "GL_OES_EGL_image_external", 1);
+          }
+       } else {
+          add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
+           add_builtin_define(parser, "GL_ARB_separate_shader_objects", 1);
+          add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
+           add_builtin_define(parser, "GL_AMD_shader_trinary_minmax", 1);
+
+
+          if (extensions != NULL) {
+             if (extensions->EXT_texture_array)
+                add_builtin_define(parser, "GL_EXT_texture_array", 1);
+
+             if (extensions->ARB_arrays_of_arrays)
+                 add_builtin_define(parser, "GL_ARB_arrays_of_arrays", 1);
+
+             if (extensions->ARB_fragment_coord_conventions)
+                add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
+                                   1);
+
+              if (extensions->ARB_fragment_layer_viewport)
+                 add_builtin_define(parser, "GL_ARB_fragment_layer_viewport", 1);
+
+             if (extensions->ARB_explicit_attrib_location)
+                add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
+
+             if (extensions->ARB_explicit_uniform_location)
+                add_builtin_define(parser, "GL_ARB_explicit_uniform_location", 1);
+
+             if (extensions->ARB_shader_texture_lod)
+                add_builtin_define(parser, "GL_ARB_shader_texture_lod", 1);
+
+             if (extensions->ARB_draw_instanced)
+                add_builtin_define(parser, "GL_ARB_draw_instanced", 1);
+
+             if (extensions->ARB_conservative_depth) {
+                add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
+                add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
+             }
+
+             if (extensions->ARB_shader_bit_encoding)
+                add_builtin_define(parser, "GL_ARB_shader_bit_encoding", 1);
+
+             if (extensions->ARB_uniform_buffer_object)
+                add_builtin_define(parser, "GL_ARB_uniform_buffer_object", 1);
+
+             if (extensions->ARB_texture_cube_map_array)
+                add_builtin_define(parser, "GL_ARB_texture_cube_map_array", 1);
+
+             if (extensions->ARB_shading_language_packing)
+                add_builtin_define(parser, "GL_ARB_shading_language_packing", 1);
+
+             if (extensions->ARB_texture_multisample)
+                add_builtin_define(parser, "GL_ARB_texture_multisample", 1);
+
+             if (extensions->ARB_texture_query_levels)
+                add_builtin_define(parser, "GL_ARB_texture_query_levels", 1);
+
+             if (extensions->ARB_texture_query_lod)
+                add_builtin_define(parser, "GL_ARB_texture_query_lod", 1);
+
+             if (extensions->ARB_gpu_shader5)
+                add_builtin_define(parser, "GL_ARB_gpu_shader5", 1);
+
+             if (extensions->AMD_vertex_shader_layer)
+                add_builtin_define(parser, "GL_AMD_vertex_shader_layer", 1);
+
+             if (extensions->AMD_vertex_shader_viewport_index)
+                add_builtin_define(parser, "GL_AMD_vertex_shader_viewport_index", 1);
+
+             if (extensions->ARB_shading_language_420pack)
+                add_builtin_define(parser, "GL_ARB_shading_language_420pack", 1);
+
+             if (extensions->ARB_sample_shading)
+                add_builtin_define(parser, "GL_ARB_sample_shading", 1);
+
+             if (extensions->ARB_texture_gather)
+                add_builtin_define(parser, "GL_ARB_texture_gather", 1);
+
+             if (extensions->ARB_shader_atomic_counters)
+                add_builtin_define(parser, "GL_ARB_shader_atomic_counters", 1);
+
+             if (extensions->ARB_viewport_array)
+                add_builtin_define(parser, "GL_ARB_viewport_array", 1);
+
+              if (extensions->ARB_compute_shader)
+                 add_builtin_define(parser, "GL_ARB_compute_shader", 1);
+
+             if (extensions->ARB_shader_image_load_store)
+                add_builtin_define(parser, "GL_ARB_shader_image_load_store", 1);
+          }
+       }
+
+       if (extensions != NULL) {
+          if (extensions->EXT_shader_integer_mix)
+             add_builtin_define(parser, "GL_EXT_shader_integer_mix", 1);
        }
 
        if (version >= 150)
@@ -2075,8 +2183,27 @@ _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t versio
        if (version >= 130 || parser->is_gles)
                add_builtin_define (parser, "GL_FRAGMENT_PRECISION_HIGH", 1);
 
-       ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length,
-                                      "#version %" PRIiMAX "%s%s", version,
-                                      es_identifier ? " " : "",
-                                      es_identifier ? es_identifier : "");
+       if (explicitly_set) {
+          ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length,
+                                        "#version %" PRIiMAX "%s%s", version,
+                                        es_identifier ? " " : "",
+                                        es_identifier ? es_identifier : "");
+       }
+}
+
+/* GLSL version if no version is explicitly specified. */
+#define IMPLICIT_GLSL_VERSION 110
+
+/* GLSL ES version if no version is explicitly specified. */
+#define IMPLICIT_GLSL_ES_VERSION 100
+
+void
+glcpp_parser_resolve_implicit_version(glcpp_parser_t *parser)
+{
+       int language_version = parser->api == API_OPENGLES2 ?
+                              IMPLICIT_GLSL_ES_VERSION :
+                              IMPLICIT_GLSL_VERSION;
+
+       _glcpp_parser_handle_version_declaration(parser, language_version,
+                                                NULL, false);
 }