src/glsl/glsl_types.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2009 Intel Corporation
   4  *
   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:
  11  *
  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
  14  * Software.
  15  *
  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.
  23  */
  24
  25 #pragma once
  26 #ifndef GLSL_TYPES_H
  27 #define GLSL_TYPES_H
  28
  29 #include <string.h>
  30 #include <assert.h>
  31 #include "main/mtypes.h" /* for gl_texture_index, C++'s enum rules are broken */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct _mesa_glsl_parse_state;
  38 struct glsl_symbol_table;
  39
  40 extern void
  41 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
  42
  43 extern void
  44 _mesa_glsl_release_types(void);
  45
  46 #ifdef __cplusplus
  47 }
  48 #endif
  49
  50 enum glsl_base_type {
  51    GLSL_TYPE_UINT = 0,
  52    GLSL_TYPE_INT,
  53    GLSL_TYPE_FLOAT,
  54    GLSL_TYPE_BOOL,
  55    GLSL_TYPE_SAMPLER,
  56    GLSL_TYPE_STRUCT,
  57    GLSL_TYPE_ARRAY,
  58    GLSL_TYPE_VOID,
  59    GLSL_TYPE_ERROR
  60 };
  61
  62 enum glsl_sampler_dim {
  63    GLSL_SAMPLER_DIM_1D = 0,
  64    GLSL_SAMPLER_DIM_2D,
  65    GLSL_SAMPLER_DIM_3D,
  66    GLSL_SAMPLER_DIM_CUBE,
  67    GLSL_SAMPLER_DIM_RECT,
  68    GLSL_SAMPLER_DIM_BUF,
  69    GLSL_SAMPLER_DIM_EXTERNAL
  70 };
  71
  72 #ifdef __cplusplus
  73 #include "GL/gl.h"
  74 #include "ralloc.h"
  75
  76 struct glsl_type {
  77    GLenum gl_type;
  78    glsl_base_type base_type;
  79
  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.
  86                                 */
  87
  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)
  91    {
  92       if (glsl_type::mem_ctx == NULL) {
  93          glsl_type::mem_ctx = ralloc_context(NULL);
  94          assert(glsl_type::mem_ctx != NULL);
  95       }
  96
  97       void *type;
  98
  99       type = ralloc_size(glsl_type::mem_ctx, size);
 100       assert(type != NULL);
 101
 102       return type;
 103    }
 104
 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)
 108    {
 109       ralloc_free(type);
 110    }
 111
 112    /**
 113     * \name Vector and matrix element counts
 114     *
 115     * For scalars, each of these values will be 1.  For non-numeric types
 116     * these will be 0.
 117     */
 118    /*@{*/
 119    unsigned vector_elements:3; /**< 1, 2, 3, or 4 vector elements. */
 120    unsigned matrix_columns:3;  /**< 1, 2, 3, or 4 matrix columns. */
 121    /*@}*/
 122
 123    /**
 124     * Name of the data type
 125     *
 126     * This may be \c NULL for anonymous structures, for arrays, or for
 127     * function types.
 128     */
 129    const char *name;
 130
 131    /**
 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).
 135     */
 136    unsigned length;
 137
 138    /**
 139     * Subtype of composite data types.
 140     */
 141    union {
 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. */
 145    } fields;
 146
 147
 148    /**
 149     * \name Pointers to various public type singletons
 150     */
 151    /*@{*/
 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 ivec4_type;
 156    static const glsl_type *const uint_type;
 157    static const glsl_type *const uvec2_type;
 158    static const glsl_type *const uvec3_type;
 159    static const glsl_type *const uvec4_type;
 160    static const glsl_type *const float_type;
 161    static const glsl_type *const vec2_type;
 162    static const glsl_type *const vec3_type;
 163    static const glsl_type *const vec4_type;
 164    static const glsl_type *const bool_type;
 165    static const glsl_type *const mat2_type;
 166    static const glsl_type *const mat2x3_type;
 167    static const glsl_type *const mat2x4_type;
 168    static const glsl_type *const mat3x2_type;
 169    static const glsl_type *const mat3_type;
 170    static const glsl_type *const mat3x4_type;
 171    static const glsl_type *const mat4x2_type;
 172    static const glsl_type *const mat4x3_type;
 173    static const glsl_type *const mat4_type;
 174    /*@}*/
 175
 176
 177    /**
 178     * For numeric and boolean derrived types returns the basic scalar type
 179     *
 180     * If the type is a numeric or boolean scalar, vector, or matrix type,
 181     * this function gets the scalar type of the individual components.  For
 182     * all other types, including arrays of numeric or boolean types, the
 183     * error type is returned.
 184     */
 185    const glsl_type *get_base_type() const;
 186
 187    /**
 188     * Get the basic scalar type which this type aggregates.
 189     *
 190     * If the type is a numeric or boolean scalar, vector, or matrix, or an
 191     * array of any of those, this function gets the scalar type of the
 192     * individual components.  For structs and arrays of structs, this function
 193     * returns the struct type.  For samplers and arrays of samplers, this
 194     * function returns the sampler type.
 195     */
 196    const glsl_type *get_scalar_type() const;
 197
 198    /**
 199     * Query the type of elements in an array
 200     *
 201     * \return
 202     * Pointer to the type of elements in the array for array types, or \c NULL
 203     * for non-array types.
 204     */
 205    const glsl_type *element_type() const
 206    {
 207       return is_array() ? fields.array : NULL;
 208    }
 209
 210    /**
 211     * Get the instance of a built-in scalar, vector, or matrix type
 212     */
 213    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 214                                         unsigned columns);
 215
 216    /**
 217     * Get the instance of an array type
 218     */
 219    static const glsl_type *get_array_instance(const glsl_type *base,
 220                                               unsigned elements);
 221
 222    /**
 223     * Get the instance of a record type
 224     */
 225    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 226                                                unsigned num_fields,
 227                                                const char *name);
 228
 229    /**
 230     * Query the total number of scalars that make up a scalar, vector or matrix
 231     */
 232    unsigned components() const
 233    {
 234       return vector_elements * matrix_columns;
 235    }
 236
 237    /**
 238     * Calculate the number of components slots required to hold this type
 239     *
 240     * This is used to determine how many uniform or varying locations a type
 241     * might occupy.
 242     */
 243    unsigned component_slots() const;
 244
 245    /**
 246     * \brief Can this type be implicitly converted to another?
 247     *
 248     * \return True if the types are identical or if this type can be converted
 249     *         to \c desired according to Section 4.1.10 of the GLSL spec.
 250     *
 251     * \verbatim
 252     * From page 25 (31 of the pdf) of the GLSL 1.50 spec, Section 4.1.10
 253     * Implicit Conversions:
 254     *
 255     *     In some situations, an expression and its type will be implicitly
 256     *     converted to a different type. The following table shows all allowed
 257     *     implicit conversions:
 258     *
 259     *     Type of expression | Can be implicitly converted to
 260     *     --------------------------------------------------
 261     *     int                  float
 262     *     uint
 263     *
 264     *     ivec2                vec2
 265     *     uvec2
 266     *
 267     *     ivec3                vec3
 268     *     uvec3
 269     *
 270     *     ivec4                vec4
 271     *     uvec4
 272     *
 273     *     There are no implicit array or structure conversions. For example,
 274     *     an array of int cannot be implicitly converted to an array of float.
 275     *     There are no implicit conversions between signed and unsigned
 276     *     integers.
 277     * \endverbatim
 278     */
 279    bool can_implicitly_convert_to(const glsl_type *desired) const;
 280
 281    /**
 282     * Query whether or not a type is a scalar (non-vector and non-matrix).
 283     */
 284    bool is_scalar() const
 285    {
 286       return (vector_elements == 1)
 287          && (base_type >= GLSL_TYPE_UINT)
 288          && (base_type <= GLSL_TYPE_BOOL);
 289    }
 290
 291    /**
 292     * Query whether or not a type is a vector
 293     */
 294    bool is_vector() const
 295    {
 296       return (vector_elements > 1)
 297          && (matrix_columns == 1)
 298          && (base_type >= GLSL_TYPE_UINT)
 299          && (base_type <= GLSL_TYPE_BOOL);
 300    }
 301
 302    /**
 303     * Query whether or not a type is a matrix
 304     */
 305    bool is_matrix() const
 306    {
 307       /* GLSL only has float matrices. */
 308       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT);
 309    }
 310
 311    /**
 312     * Query whether or not a type is a non-array numeric type
 313     */
 314    bool is_numeric() const
 315    {
 316       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_FLOAT);
 317    }
 318
 319    /**
 320     * Query whether or not a type is an integral type
 321     */
 322    bool is_integer() const
 323    {
 324       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 325    }
 326
 327    /**
 328     * Query whether or not a type is a float type
 329     */
 330    bool is_float() const
 331    {
 332       return base_type == GLSL_TYPE_FLOAT;
 333    }
 334
 335    /**
 336     * Query whether or not a type is a non-array boolean type
 337     */
 338    bool is_boolean() const
 339    {
 340       return base_type == GLSL_TYPE_BOOL;
 341    }
 342
 343    /**
 344     * Query whether or not a type is a sampler
 345     */
 346    bool is_sampler() const
 347    {
 348       return base_type == GLSL_TYPE_SAMPLER;
 349    }
 350
 351    /**
 352     * Query whether or not type is a sampler, or for struct and array
 353     * types, contains a sampler.
 354     */
 355    bool contains_sampler() const;
 356
 357    /**
 358     * Get the Mesa texture target index for a sampler type.
 359     */
 360    gl_texture_index sampler_index() const;
 361
 362    /**
 363     * Query whether or not a type is an array
 364     */
 365    bool is_array() const
 366    {
 367       return base_type == GLSL_TYPE_ARRAY;
 368    }
 369
 370    /**
 371     * Query whether or not a type is a record
 372     */
 373    bool is_record() const
 374    {
 375       return base_type == GLSL_TYPE_STRUCT;
 376    }
 377
 378    /**
 379     * Query whether or not a type is the void type singleton.
 380     */
 381    bool is_void() const
 382    {
 383       return base_type == GLSL_TYPE_VOID;
 384    }
 385
 386    /**
 387     * Query whether or not a type is the error type singleton.
 388     */
 389    bool is_error() const
 390    {
 391       return base_type == GLSL_TYPE_ERROR;
 392    }
 393
 394    /**
 395     * Query the full type of a matrix row
 396     *
 397     * \return
 398     * If the type is not a matrix, \c glsl_type::error_type is returned.
 399     * Otherwise a type matching the rows of the matrix is returned.
 400     */
 401    const glsl_type *row_type() const
 402    {
 403       return is_matrix()
 404          ? get_instance(base_type, matrix_columns, 1)
 405          : error_type;
 406    }
 407
 408    /**
 409     * Query the full type of a matrix column
 410     *
 411     * \return
 412     * If the type is not a matrix, \c glsl_type::error_type is returned.
 413     * Otherwise a type matching the columns of the matrix is returned.
 414     */
 415    const glsl_type *column_type() const
 416    {
 417       return is_matrix()
 418          ? get_instance(base_type, vector_elements, 1)
 419          : error_type;
 420    }
 421
 422
 423    /**
 424     * Get the type of a structure field
 425     *
 426     * \return
 427     * Pointer to the type of the named field.  If the type is not a structure
 428     * or the named field does not exist, \c glsl_type::error_type is returned.
 429     */
 430    const glsl_type *field_type(const char *name) const;
 431
 432
 433    /**
 434     * Get the location of a filed within a record type
 435     */
 436    int field_index(const char *name) const;
 437
 438
 439    /**
 440     * Query the number of elements in an array type
 441     *
 442     * \return
 443     * The number of elements in the array for array types or -1 for non-array
 444     * types.  If the number of elements in the array has not yet been declared,
 445     * zero is returned.
 446     */
 447    int array_size() const
 448    {
 449       return is_array() ? length : -1;
 450    }
 451
 452 private:
 453    /**
 454     * ralloc context for all glsl_type allocations
 455     *
 456     * Set on the first call to \c glsl_type::new.
 457     */
 458    static void *mem_ctx;
 459
 460    void init_ralloc_type_ctx(void);
 461
 462    /** Constructor for vector and matrix types */
 463    glsl_type(GLenum gl_type,
 464              glsl_base_type base_type, unsigned vector_elements,
 465              unsigned matrix_columns, const char *name);
 466
 467    /** Constructor for sampler types */
 468    glsl_type(GLenum gl_type,
 469              enum glsl_sampler_dim dim, bool shadow, bool array,
 470              unsigned type, const char *name);
 471
 472    /** Constructor for record types */
 473    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 474              const char *name);
 475
 476    /** Constructor for array types */
 477    glsl_type(const glsl_type *array, unsigned length);
 478
 479    /** Hash table containing the known array types. */
 480    static struct hash_table *array_types;
 481
 482    /** Hash table containing the known record types. */
 483    static struct hash_table *record_types;
 484
 485    static int record_key_compare(const void *a, const void *b);
 486    static unsigned record_key_hash(const void *key);
 487
 488    /**
 489     * \name Pointers to various type singletons
 490     */
 491    /*@{*/
 492    static const glsl_type _error_type;
 493    static const glsl_type _void_type;
 494    static const glsl_type _sampler3D_type;
 495    static const glsl_type builtin_core_types[];
 496    static const glsl_type builtin_structure_types[];
 497    static const glsl_type builtin_110_deprecated_structure_types[];
 498    static const glsl_type builtin_110_types[];
 499    static const glsl_type builtin_120_types[];
 500    static const glsl_type builtin_130_types[];
 501    static const glsl_type builtin_140_types[];
 502    static const glsl_type builtin_ARB_texture_rectangle_types[];
 503    static const glsl_type builtin_EXT_texture_array_types[];
 504    static const glsl_type builtin_EXT_texture_buffer_object_types[];
 505    static const glsl_type builtin_OES_EGL_image_external_types[];
 506    /*@}*/
 507
 508    /**
 509     * \name Methods to populate a symbol table with built-in types.
 510     *
 511     * \internal
 512     * This is one of the truely annoying things about C++.  Methods that are
 513     * completely internal and private to a type still have to be advertised to
 514     * the world in a public header file.
 515     */
 516    /*@{*/
 517    static void generate_100ES_types(glsl_symbol_table *);
 518    static void generate_110_types(glsl_symbol_table *, bool add_deprecated);
 519    static void generate_120_types(glsl_symbol_table *, bool add_deprecated);
 520    static void generate_130_types(glsl_symbol_table *, bool add_deprecated);
 521    static void generate_140_types(glsl_symbol_table *);
 522    static void generate_ARB_texture_rectangle_types(glsl_symbol_table *, bool);
 523    static void generate_EXT_texture_array_types(glsl_symbol_table *, bool);
 524    static void generate_OES_texture_3D_types(glsl_symbol_table *, bool);
 525    static void generate_OES_EGL_image_external_types(glsl_symbol_table *, bool);
 526    /*@}*/
 527
 528    /**
 529     * \name Friend functions.
 530     *
 531     * These functions are friends because they must have C linkage and the
 532     * need to call various private methods or access various private static
 533     * data.
 534     */
 535    /*@{*/
 536    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 537    friend void _mesa_glsl_release_types(void);
 538    /*@}*/
 539 };
 540
 541 struct glsl_struct_field {
 542    const struct glsl_type *type;
 543    const char *name;
 544 };
 545
 546 #endif /* __cplusplus */
 547
 548 #endif /* GLSL_TYPES_H */