3 * Copyright © 2009 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
31 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
37 struct _mesa_glsl_parse_state
;
38 struct glsl_symbol_table
;
41 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
44 _mesa_glsl_release_types(void);
62 enum glsl_sampler_dim
{
63 GLSL_SAMPLER_DIM_1D
= 0,
66 GLSL_SAMPLER_DIM_CUBE
,
67 GLSL_SAMPLER_DIM_RECT
,
69 GLSL_SAMPLER_DIM_EXTERNAL
78 glsl_base_type base_type
;
80 unsigned sampler_dimensionality
:3; /**< \see glsl_sampler_dim */
81 unsigned sampler_shadow
:1;
82 unsigned sampler_array
:1;
83 unsigned sampler_type
:2; /**< Type of data returned using this sampler.
84 * only \c GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
85 * and \c GLSL_TYPE_UINT are valid.
88 /* Callers of this ralloc-based new need not call delete. It's
89 * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
90 static void* operator new(size_t size
)
92 if (glsl_type::mem_ctx
== NULL
) {
93 glsl_type::mem_ctx
= ralloc_context(NULL
);
94 assert(glsl_type::mem_ctx
!= NULL
);
99 type
= ralloc_size(glsl_type::mem_ctx
, size
);
100 assert(type
!= NULL
);
105 /* If the user *does* call delete, that's OK, we will just
106 * ralloc_free in that case. */
107 static void operator delete(void *type
)
113 * \name Vector and matrix element counts
115 * For scalars, each of these values will be 1. For non-numeric types
119 unsigned vector_elements
:3; /**< 1, 2, 3, or 4 vector elements. */
120 unsigned matrix_columns
:3; /**< 1, 2, 3, or 4 matrix columns. */
124 * Name of the data type
126 * This may be \c NULL for anonymous structures, for arrays, or for
132 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
133 * \c GLSL_TYPE_STRUCT, it is the number of elements in the structure and
134 * the number of values pointed to by \c fields.structure (below).
139 * Subtype of composite data types.
142 const struct glsl_type
*array
; /**< Type of array elements. */
143 const struct glsl_type
*parameters
; /**< Parameters to function. */
144 struct glsl_struct_field
*structure
; /**< List of struct fields. */
149 * \name Pointers to various public type singletons
152 static const glsl_type
*const error_type
;
153 static const glsl_type
*const void_type
;
154 static const glsl_type
*const int_type
;
155 static const glsl_type
*const ivec2_type
;
156 static const glsl_type
*const ivec3_type
;
157 static const glsl_type
*const ivec4_type
;
158 static const glsl_type
*const uint_type
;
159 static const glsl_type
*const uvec2_type
;
160 static const glsl_type
*const uvec3_type
;
161 static const glsl_type
*const uvec4_type
;
162 static const glsl_type
*const float_type
;
163 static const glsl_type
*const vec2_type
;
164 static const glsl_type
*const vec3_type
;
165 static const glsl_type
*const vec4_type
;
166 static const glsl_type
*const bool_type
;
167 static const glsl_type
*const bvec2_type
;
168 static const glsl_type
*const bvec3_type
;
169 static const glsl_type
*const bvec4_type
;
170 static const glsl_type
*const mat2_type
;
171 static const glsl_type
*const mat2x3_type
;
172 static const glsl_type
*const mat2x4_type
;
173 static const glsl_type
*const mat3x2_type
;
174 static const glsl_type
*const mat3_type
;
175 static const glsl_type
*const mat3x4_type
;
176 static const glsl_type
*const mat4x2_type
;
177 static const glsl_type
*const mat4x3_type
;
178 static const glsl_type
*const mat4_type
;
183 * For numeric and boolean derrived types returns the basic scalar type
185 * If the type is a numeric or boolean scalar, vector, or matrix type,
186 * this function gets the scalar type of the individual components. For
187 * all other types, including arrays of numeric or boolean types, the
188 * error type is returned.
190 const glsl_type
*get_base_type() const;
193 * Get the basic scalar type which this type aggregates.
195 * If the type is a numeric or boolean scalar, vector, or matrix, or an
196 * array of any of those, this function gets the scalar type of the
197 * individual components. For structs and arrays of structs, this function
198 * returns the struct type. For samplers and arrays of samplers, this
199 * function returns the sampler type.
201 const glsl_type
*get_scalar_type() const;
204 * Query the type of elements in an array
207 * Pointer to the type of elements in the array for array types, or \c NULL
208 * for non-array types.
210 const glsl_type
*element_type() const
212 return is_array() ? fields
.array
: NULL
;
216 * Get the instance of a built-in scalar, vector, or matrix type
218 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
222 * Get the instance of an array type
224 static const glsl_type
*get_array_instance(const glsl_type
*base
,
228 * Get the instance of a record type
230 static const glsl_type
*get_record_instance(const glsl_struct_field
*fields
,
235 * Query the total number of scalars that make up a scalar, vector or matrix
237 unsigned components() const
239 return vector_elements
* matrix_columns
;
243 * Calculate the number of components slots required to hold this type
245 * This is used to determine how many uniform or varying locations a type
248 unsigned component_slots() const;
251 * Alignment in bytes of the start of this type in a std140 uniform
254 unsigned std140_base_alignment(bool row_major
) const;
256 /** Size in bytes of this type in a std140 uniform block.
258 * Note that this is not GL_UNIFORM_SIZE (which is the number of
259 * elements in the array)
261 unsigned std140_size(bool row_major
) const;
264 * \brief Can this type be implicitly converted to another?
266 * \return True if the types are identical or if this type can be converted
267 * to \c desired according to Section 4.1.10 of the GLSL spec.
270 * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
271 * Implicit Conversions:
273 * In some situations, an expression and its type will be implicitly
274 * converted to a different type. The following table shows all allowed
275 * implicit conversions:
277 * Type of expression | Can be implicitly converted to
278 * --------------------------------------------------
291 * There are no implicit array or structure conversions. For example,
292 * an array of int cannot be implicitly converted to an array of float.
293 * There are no implicit conversions between signed and unsigned
297 bool can_implicitly_convert_to(const glsl_type
*desired
) const;
300 * Query whether or not a type is a scalar (non-vector and non-matrix).
302 bool is_scalar() const
304 return (vector_elements
== 1)
305 && (base_type
>= GLSL_TYPE_UINT
)
306 && (base_type
<= GLSL_TYPE_BOOL
);
310 * Query whether or not a type is a vector
312 bool is_vector() const
314 return (vector_elements
> 1)
315 && (matrix_columns
== 1)
316 && (base_type
>= GLSL_TYPE_UINT
)
317 && (base_type
<= GLSL_TYPE_BOOL
);
321 * Query whether or not a type is a matrix
323 bool is_matrix() const
325 /* GLSL only has float matrices. */
326 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
);
330 * Query whether or not a type is a non-array numeric type
332 bool is_numeric() const
334 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_FLOAT
);
338 * Query whether or not a type is an integral type
340 bool is_integer() const
342 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
346 * Query whether or not a type is a float type
348 bool is_float() const
350 return base_type
== GLSL_TYPE_FLOAT
;
354 * Query whether or not a type is a non-array boolean type
356 bool is_boolean() const
358 return base_type
== GLSL_TYPE_BOOL
;
362 * Query whether or not a type is a sampler
364 bool is_sampler() const
366 return base_type
== GLSL_TYPE_SAMPLER
;
370 * Query whether or not type is a sampler, or for struct and array
371 * types, contains a sampler.
373 bool contains_sampler() const;
376 * Get the Mesa texture target index for a sampler type.
378 gl_texture_index
sampler_index() const;
381 * Query whether or not a type is an array
383 bool is_array() const
385 return base_type
== GLSL_TYPE_ARRAY
;
389 * Query whether or not a type is a record
391 bool is_record() const
393 return base_type
== GLSL_TYPE_STRUCT
;
397 * Query whether or not a type is the void type singleton.
401 return base_type
== GLSL_TYPE_VOID
;
405 * Query whether or not a type is the error type singleton.
407 bool is_error() const
409 return base_type
== GLSL_TYPE_ERROR
;
413 * Query the full type of a matrix row
416 * If the type is not a matrix, \c glsl_type::error_type is returned.
417 * Otherwise a type matching the rows of the matrix is returned.
419 const glsl_type
*row_type() const
422 ? get_instance(base_type
, matrix_columns
, 1)
427 * Query the full type of a matrix column
430 * If the type is not a matrix, \c glsl_type::error_type is returned.
431 * Otherwise a type matching the columns of the matrix is returned.
433 const glsl_type
*column_type() const
436 ? get_instance(base_type
, vector_elements
, 1)
442 * Get the type of a structure field
445 * Pointer to the type of the named field. If the type is not a structure
446 * or the named field does not exist, \c glsl_type::error_type is returned.
448 const glsl_type
*field_type(const char *name
) const;
452 * Get the location of a filed within a record type
454 int field_index(const char *name
) const;
458 * Query the number of elements in an array type
461 * The number of elements in the array for array types or -1 for non-array
462 * types. If the number of elements in the array has not yet been declared,
465 int array_size() const
467 return is_array() ? length
: -1;
472 * ralloc context for all glsl_type allocations
474 * Set on the first call to \c glsl_type::new.
476 static void *mem_ctx
;
478 void init_ralloc_type_ctx(void);
480 /** Constructor for vector and matrix types */
481 glsl_type(GLenum gl_type
,
482 glsl_base_type base_type
, unsigned vector_elements
,
483 unsigned matrix_columns
, const char *name
);
485 /** Constructor for sampler types */
486 glsl_type(GLenum gl_type
,
487 enum glsl_sampler_dim dim
, bool shadow
, bool array
,
488 unsigned type
, const char *name
);
490 /** Constructor for record types */
491 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
494 /** Constructor for array types */
495 glsl_type(const glsl_type
*array
, unsigned length
);
497 /** Hash table containing the known array types. */
498 static struct hash_table
*array_types
;
500 /** Hash table containing the known record types. */
501 static struct hash_table
*record_types
;
503 static int record_key_compare(const void *a
, const void *b
);
504 static unsigned record_key_hash(const void *key
);
507 * \name Pointers to various type singletons
510 static const glsl_type _error_type
;
511 static const glsl_type _void_type
;
512 static const glsl_type _sampler3D_type
;
513 static const glsl_type builtin_core_types
[];
514 static const glsl_type builtin_structure_types
[];
515 static const glsl_type builtin_110_deprecated_structure_types
[];
516 static const glsl_type builtin_110_types
[];
517 static const glsl_type builtin_120_types
[];
518 static const glsl_type builtin_130_types
[];
519 static const glsl_type builtin_140_types
[];
520 static const glsl_type builtin_ARB_texture_rectangle_types
[];
521 static const glsl_type builtin_EXT_texture_array_types
[];
522 static const glsl_type builtin_EXT_texture_buffer_object_types
[];
523 static const glsl_type builtin_OES_EGL_image_external_types
[];
527 * \name Methods to populate a symbol table with built-in types.
530 * This is one of the truely annoying things about C++. Methods that are
531 * completely internal and private to a type still have to be advertised to
532 * the world in a public header file.
535 static void generate_100ES_types(glsl_symbol_table
*);
536 static void generate_110_types(glsl_symbol_table
*, bool add_deprecated
);
537 static void generate_120_types(glsl_symbol_table
*, bool add_deprecated
);
538 static void generate_130_types(glsl_symbol_table
*, bool add_deprecated
);
539 static void generate_140_types(glsl_symbol_table
*);
540 static void generate_ARB_texture_rectangle_types(glsl_symbol_table
*, bool);
541 static void generate_EXT_texture_array_types(glsl_symbol_table
*, bool);
542 static void generate_OES_texture_3D_types(glsl_symbol_table
*, bool);
543 static void generate_OES_EGL_image_external_types(glsl_symbol_table
*, bool);
547 * \name Friend functions.
549 * These functions are friends because they must have C linkage and the
550 * need to call various private methods or access various private static
554 friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*);
555 friend void _mesa_glsl_release_types(void);
559 struct glsl_struct_field
{
560 const struct glsl_type
*type
;
564 #endif /* __cplusplus */
566 #endif /* GLSL_TYPES_H */