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.
32 #define GLSL_TYPE_UINT 0
33 #define GLSL_TYPE_INT 1
34 #define GLSL_TYPE_FLOAT 2
35 #define GLSL_TYPE_BOOL 3
36 #define GLSL_TYPE_SAMPLER 4
37 #define GLSL_TYPE_STRUCT 5
38 #define GLSL_TYPE_ARRAY 6
39 #define GLSL_TYPE_FUNCTION 7
40 #define GLSL_TYPE_VOID 8
41 #define GLSL_TYPE_ERROR 9
43 enum glsl_sampler_dim
{
44 GLSL_SAMPLER_DIM_1D
= 0,
47 GLSL_SAMPLER_DIM_CUBE
,
48 GLSL_SAMPLER_DIM_RECT
,
56 unsigned sampler_dimensionality
:3;
57 unsigned sampler_shadow
:1;
58 unsigned sampler_array
:1;
59 unsigned sampler_type
:2; /**< Type of data returned using this sampler.
60 * only \c GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
61 * and \c GLSL_TYPE_UINT are valid.
65 * \name Vector and matrix element counts
67 * For scalars, each of these values will be 1. For non-numeric types
71 unsigned vector_elements
:3; /**< 1, 2, 3, or 4 vector elements. */
72 unsigned matrix_columns
:3; /**< 1, 2, 3, or 4 matrix columns. */
76 * Name of the data type
78 * This may be \c NULL for anonymous structures, for arrays, or for
84 * For \c GLSL_TYPE_ARRAY, this is the length of the array. For
85 * \c GLSL_TYPE_STRUCT, it is the number of elements in the structure and
86 * the number of values pointed to by \c fields.structure (below).
88 * For \c GLSL_TYPE_FUNCTION, it is the number of parameters to the
89 * function. The return value from a function is implicitly the first
90 * parameter. The types of the parameters are stored in
91 * \c fields.parameters (below).
96 * Subtype of composite data types.
99 const struct glsl_type
*array
; /**< Type of array elements. */
100 const struct glsl_type
*parameters
; /**< Parameters to function. */
101 const struct glsl_struct_field
*structure
;/**< List of struct fields. */
106 * \name Pointers to various public type singletons
109 static const glsl_type
*const error_type
;
110 static const glsl_type
*const int_type
;
111 static const glsl_type
*const ivec4_type
;
112 static const glsl_type
*const uint_type
;
113 static const glsl_type
*const uvec4_type
;
114 static const glsl_type
*const float_type
;
115 static const glsl_type
*const vec2_type
;
116 static const glsl_type
*const vec3_type
;
117 static const glsl_type
*const vec4_type
;
118 static const glsl_type
*const bool_type
;
119 static const glsl_type
*const mat2_type
;
120 static const glsl_type
*const mat2x3_type
;
121 static const glsl_type
*const mat2x4_type
;
122 static const glsl_type
*const mat3x2_type
;
123 static const glsl_type
*const mat3_type
;
124 static const glsl_type
*const mat3x4_type
;
125 static const glsl_type
*const mat4x2_type
;
126 static const glsl_type
*const mat4x3_type
;
127 static const glsl_type
*const mat4_type
;
131 glsl_type(unsigned base_type
, unsigned vector_elements
,
132 unsigned matrix_columns
, const char *name
) :
133 base_type(base_type
),
134 sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
136 vector_elements(vector_elements
), matrix_columns(matrix_columns
),
140 /* Neither dimension is zero or both dimensions are zero.
142 assert((vector_elements
== 0) == (matrix_columns
== 0));
143 memset(& fields
, 0, sizeof(fields
));
146 glsl_type(enum glsl_sampler_dim dim
, bool shadow
, bool array
,
147 unsigned type
, const char *name
) :
148 base_type(GLSL_TYPE_SAMPLER
),
149 sampler_dimensionality(dim
), sampler_shadow(shadow
),
150 sampler_array(array
), sampler_type(type
),
151 vector_elements(0), matrix_columns(0),
155 memset(& fields
, 0, sizeof(fields
));
158 glsl_type(const glsl_struct_field
*fields
, unsigned num_fields
,
160 base_type(GLSL_TYPE_STRUCT
),
161 sampler_dimensionality(0), sampler_shadow(0), sampler_array(0),
163 vector_elements(0), matrix_columns(0),
167 this->fields
.structure
= fields
;
171 * For numeric and boolean derrived types returns the basic scalar type
173 * If the type is a numeric or boolean scalar, vector, or matrix type,
174 * this function gets the scalar type of the individual components. For
175 * all other types, including arrays of numeric or boolean types, the
176 * error type is returned.
178 const glsl_type
*get_base_type() const;
181 * Query the type of elements in an array
184 * Pointer to the type of elements in the array for array types, or \c NULL
185 * for non-array types.
187 const glsl_type
*element_type() const
189 return is_array() ? fields
.array
: NULL
;
193 * Get the instance of a built-in scalar, vector, or matrix type
195 static const glsl_type
*get_instance(unsigned base_type
, unsigned rows
,
199 * Get the instance of an array type
201 static const glsl_type
*get_array_instance(const glsl_type
*base
,
205 * Generate the constructor for this type and add it to the symbol table
207 class ir_function
*generate_constructor(class glsl_symbol_table
*) const;
210 * Query the total number of scalars that make up a scalar, vector or matrix
212 unsigned components() const
214 return vector_elements
* matrix_columns
;
218 * Query whether or not a type is a scalar (non-vector and non-matrix).
220 bool is_scalar() const
222 return (vector_elements
== 1)
223 && (base_type
>= GLSL_TYPE_UINT
)
224 && (base_type
<= GLSL_TYPE_BOOL
);
228 * Query whether or not a type is a vector
230 bool is_vector() const
232 return (vector_elements
> 1)
233 && (matrix_columns
== 1)
234 && (base_type
>= GLSL_TYPE_UINT
)
235 && (base_type
<= GLSL_TYPE_BOOL
);
239 * Query whether or not a type is a matrix
241 bool is_matrix() const
243 /* GLSL only has float matrices. */
244 return (matrix_columns
> 1) && (base_type
== GLSL_TYPE_FLOAT
);
248 * Query whether or not a type is a non-array numeric type
250 bool is_numeric() const
252 return (base_type
>= GLSL_TYPE_UINT
) && (base_type
<= GLSL_TYPE_FLOAT
);
256 * Query whether or not a type is an integral type
258 bool is_integer() const
260 return (base_type
== GLSL_TYPE_UINT
) || (base_type
== GLSL_TYPE_INT
);
264 * Query whether or not a type is a float type
266 bool is_float() const
268 return base_type
== GLSL_TYPE_FLOAT
;
272 * Query whether or not a type is a non-array boolean type
274 bool is_boolean() const
276 return base_type
== GLSL_TYPE_BOOL
;
280 * Query whether or not a type is a sampler
282 bool is_sampler() const
284 return base_type
== GLSL_TYPE_SAMPLER
;
288 * Query whether or not a type is an array
290 bool is_array() const
292 return base_type
== GLSL_TYPE_ARRAY
;
296 * Query whether or not a type is a record
298 bool is_record() const
300 return base_type
== GLSL_TYPE_STRUCT
;
304 * Query whether or not a type is the void type singleton.
308 return base_type
== GLSL_TYPE_VOID
;
312 * Query whether or not a type is the error type singleton.
314 bool is_error() const
316 return base_type
== GLSL_TYPE_ERROR
;
320 * Query the full type of a matrix row
323 * If the type is not a matrix, \c glsl_type::error_type is returned.
324 * Otherwise a type matching the rows of the matrix is returned.
326 const glsl_type
*row_type() const
329 ? get_instance(base_type
, matrix_columns
, 1)
334 * Query the full type of a matrix column
337 * If the type is not a matrix, \c glsl_type::error_type is returned.
338 * Otherwise a type matching the columns of the matrix is returned.
340 const glsl_type
*column_type() const
343 ? get_instance(base_type
, vector_elements
, 1)
349 * Get the type of a structure field
352 * Pointer to the type of the named field. If the type is not a structure
353 * or the named field does not exist, \c glsl_type::error_type is returned.
355 const glsl_type
*field_type(const char *name
) const;
359 * Get the location of a filed within a record type
361 int field_index(const char *name
) const;
365 * Query the number of elements in an array type
368 * The number of elements in the array for array types or -1 for non-array
369 * types. If the number of elements in the array has not yet been declared,
372 int array_size() const
374 return is_array() ? length
: -1;
379 * Constructor for array types
381 glsl_type(const glsl_type
*array
, unsigned length
);
383 /** Hash table containing the known array types. */
384 static struct hash_table
*array_types
;
386 static int array_key_compare(const void *a
, const void *b
);
387 static unsigned array_key_hash(const void *key
);
390 struct glsl_struct_field
{
391 const struct glsl_type
*type
;
395 struct _mesa_glsl_parse_state
;
402 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state
*state
);
405 _mesa_glsl_initialize_constructors(struct exec_list
*instructions
,
406 struct _mesa_glsl_parse_state
*state
);
412 #endif /* GLSL_TYPES_H */