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
  32 extern "C" {
  33 #include "GL/gl.h"
  34 }
  35
  36 #include "ralloc.h"
  37
  38 struct _mesa_glsl_parse_state;
  39 struct glsl_symbol_table;
  40
  41 extern "C" void
  42 _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *state);
  43
  44 extern "C" void
  45 _mesa_glsl_release_types(void);
  46
  47 enum glsl_base_type {
  48    GLSL_TYPE_UINT = 0,
  49    GLSL_TYPE_INT,
  50    GLSL_TYPE_FLOAT,
  51    GLSL_TYPE_BOOL,
  52    GLSL_TYPE_SAMPLER,
  53    GLSL_TYPE_STRUCT,
  54    GLSL_TYPE_ARRAY,
  55    GLSL_TYPE_VOID,
  56    GLSL_TYPE_ERROR
  57 };
  58
  59 enum glsl_sampler_dim {
  60    GLSL_SAMPLER_DIM_1D = 0,
  61    GLSL_SAMPLER_DIM_2D,
  62    GLSL_SAMPLER_DIM_3D,
  63    GLSL_SAMPLER_DIM_CUBE,
  64    GLSL_SAMPLER_DIM_RECT,
  65    GLSL_SAMPLER_DIM_BUF
  66 };
  67
  68
  69 struct glsl_type {
  70    GLenum gl_type;
  71    glsl_base_type base_type;
  72
  73    unsigned sampler_dimensionality:3; /**< \see glsl_sampler_dim */
  74    unsigned sampler_shadow:1;
  75    unsigned sampler_array:1;
  76    unsigned sampler_type:2;    /**< Type of data returned using this sampler.
  77                                 * only \c GLSL_TYPE_FLOAT, \c GLSL_TYPE_INT,
  78                                 * and \c GLSL_TYPE_UINT are valid.
  79                                 */
  80
  81    /* Callers of this ralloc-based new need not call delete. It's
  82     * easier to just ralloc_free 'mem_ctx' (or any of its ancestors). */
  83    static void* operator new(size_t size)
  84    {
  85       if (glsl_type::mem_ctx == NULL) {
  86          glsl_type::mem_ctx = ralloc_context(NULL);
  87          assert(glsl_type::mem_ctx != NULL);
  88       }
  89
  90       void *type;
  91
  92       type = ralloc_size(glsl_type::mem_ctx, size);
  93       assert(type != NULL);
  94
  95       return type;
  96    }
  97
  98    /* If the user *does* call delete, that's OK, we will just
  99     * ralloc_free in that case. */
 100    static void operator delete(void *type)
 101    {
 102       ralloc_free(type);
 103    }
 104
 105    /**
 106     * \name Vector and matrix element counts
 107     *
 108     * For scalars, each of these values will be 1.  For non-numeric types
 109     * these will be 0.
 110     */
 111    /*@{*/
 112    unsigned vector_elements:3; /**< 1, 2, 3, or 4 vector elements. */
 113    unsigned matrix_columns:3;  /**< 1, 2, 3, or 4 matrix columns. */
 114    /*@}*/
 115
 116    /**
 117     * Name of the data type
 118     *
 119     * This may be \c NULL for anonymous structures, for arrays, or for
 120     * function types.
 121     */
 122    const char *name;
 123
 124    /**
 125     * For \c GLSL_TYPE_ARRAY, this is the length of the array.  For
 126     * \c GLSL_TYPE_STRUCT, it is the number of elements in the structure and
 127     * the number of values pointed to by \c fields.structure (below).
 128     */
 129    unsigned length;
 130
 131    /**
 132     * Subtype of composite data types.
 133     */
 134    union {
 135       const struct glsl_type *array;            /**< Type of array elements. */
 136       const struct glsl_type *parameters;       /**< Parameters to function. */
 137       struct glsl_struct_field *structure;      /**< List of struct fields. */
 138    } fields;
 139
 140
 141    /**
 142     * \name Pointers to various public type singletons
 143     */
 144    /*@{*/
 145    static const glsl_type *const error_type;
 146    static const glsl_type *const void_type;
 147    static const glsl_type *const int_type;
 148    static const glsl_type *const ivec4_type;
 149    static const glsl_type *const uint_type;
 150    static const glsl_type *const uvec2_type;
 151    static const glsl_type *const uvec3_type;
 152    static const glsl_type *const uvec4_type;
 153    static const glsl_type *const float_type;
 154    static const glsl_type *const vec2_type;
 155    static const glsl_type *const vec3_type;
 156    static const glsl_type *const vec4_type;
 157    static const glsl_type *const bool_type;
 158    static const glsl_type *const mat2_type;
 159    static const glsl_type *const mat2x3_type;
 160    static const glsl_type *const mat2x4_type;
 161    static const glsl_type *const mat3x2_type;
 162    static const glsl_type *const mat3_type;
 163    static const glsl_type *const mat3x4_type;
 164    static const glsl_type *const mat4x2_type;
 165    static const glsl_type *const mat4x3_type;
 166    static const glsl_type *const mat4_type;
 167    /*@}*/
 168
 169
 170    /**
 171     * For numeric and boolean derrived types returns the basic scalar type
 172     *
 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.
 177     */
 178    const glsl_type *get_base_type() const;
 179
 180    /**
 181     * Query the type of elements in an array
 182     *
 183     * \return
 184     * Pointer to the type of elements in the array for array types, or \c NULL
 185     * for non-array types.
 186     */
 187    const glsl_type *element_type() const
 188    {
 189       return is_array() ? fields.array : NULL;
 190    }
 191
 192    /**
 193     * Get the instance of a built-in scalar, vector, or matrix type
 194     */
 195    static const glsl_type *get_instance(unsigned base_type, unsigned rows,
 196                                         unsigned columns);
 197
 198    /**
 199     * Get the instance of an array type
 200     */
 201    static const glsl_type *get_array_instance(const glsl_type *base,
 202                                               unsigned elements);
 203
 204    /**
 205     * Get the instance of a record type
 206     */
 207    static const glsl_type *get_record_instance(const glsl_struct_field *fields,
 208                                                unsigned num_fields,
 209                                                const char *name);
 210
 211    /**
 212     * Query the total number of scalars that make up a scalar, vector or matrix
 213     */
 214    unsigned components() const
 215    {
 216       return vector_elements * matrix_columns;
 217    }
 218
 219    /**
 220     * Calculate the number of components slots required to hold this type
 221     *
 222     * This is used to determine how many uniform or varying locations a type
 223     * might occupy.
 224     */
 225    unsigned component_slots() const;
 226
 227
 228    /**
 229     * Query whether or not a type is a scalar (non-vector and non-matrix).
 230     */
 231    bool is_scalar() const
 232    {
 233       return (vector_elements == 1)
 234          && (base_type >= GLSL_TYPE_UINT)
 235          && (base_type <= GLSL_TYPE_BOOL);
 236    }
 237
 238    /**
 239     * Query whether or not a type is a vector
 240     */
 241    bool is_vector() const
 242    {
 243       return (vector_elements > 1)
 244          && (matrix_columns == 1)
 245          && (base_type >= GLSL_TYPE_UINT)
 246          && (base_type <= GLSL_TYPE_BOOL);
 247    }
 248
 249    /**
 250     * Query whether or not a type is a matrix
 251     */
 252    bool is_matrix() const
 253    {
 254       /* GLSL only has float matrices. */
 255       return (matrix_columns > 1) && (base_type == GLSL_TYPE_FLOAT);
 256    }
 257
 258    /**
 259     * Query whether or not a type is a non-array numeric type
 260     */
 261    bool is_numeric() const
 262    {
 263       return (base_type >= GLSL_TYPE_UINT) && (base_type <= GLSL_TYPE_FLOAT);
 264    }
 265
 266    /**
 267     * Query whether or not a type is an integral type
 268     */
 269    bool is_integer() const
 270    {
 271       return (base_type == GLSL_TYPE_UINT) || (base_type == GLSL_TYPE_INT);
 272    }
 273
 274    /**
 275     * Query whether or not a type is a float type
 276     */
 277    bool is_float() const
 278    {
 279       return base_type == GLSL_TYPE_FLOAT;
 280    }
 281
 282    /**
 283     * Query whether or not a type is a non-array boolean type
 284     */
 285    bool is_boolean() const
 286    {
 287       return base_type == GLSL_TYPE_BOOL;
 288    }
 289
 290    /**
 291     * Query whether or not a type is a sampler
 292     */
 293    bool is_sampler() const
 294    {
 295       return base_type == GLSL_TYPE_SAMPLER;
 296    }
 297
 298    /**
 299     * Query whether or not type is a sampler, or for struct and array
 300     * types, contains a sampler.
 301     */
 302    bool contains_sampler() const;
 303
 304    /**
 305     * Query whether or not a type is an array
 306     */
 307    bool is_array() const
 308    {
 309       return base_type == GLSL_TYPE_ARRAY;
 310    }
 311
 312    /**
 313     * Query whether or not a type is a record
 314     */
 315    bool is_record() const
 316    {
 317       return base_type == GLSL_TYPE_STRUCT;
 318    }
 319
 320    /**
 321     * Query whether or not a type is the void type singleton.
 322     */
 323    bool is_void() const
 324    {
 325       return base_type == GLSL_TYPE_VOID;
 326    }
 327
 328    /**
 329     * Query whether or not a type is the error type singleton.
 330     */
 331    bool is_error() const
 332    {
 333       return base_type == GLSL_TYPE_ERROR;
 334    }
 335
 336    /**
 337     * Query the full type of a matrix row
 338     *
 339     * \return
 340     * If the type is not a matrix, \c glsl_type::error_type is returned.
 341     * Otherwise a type matching the rows of the matrix is returned.
 342     */
 343    const glsl_type *row_type() const
 344    {
 345       return is_matrix()
 346          ? get_instance(base_type, matrix_columns, 1)
 347          : error_type;
 348    }
 349
 350    /**
 351     * Query the full type of a matrix column
 352     *
 353     * \return
 354     * If the type is not a matrix, \c glsl_type::error_type is returned.
 355     * Otherwise a type matching the columns of the matrix is returned.
 356     */
 357    const glsl_type *column_type() const
 358    {
 359       return is_matrix()
 360          ? get_instance(base_type, vector_elements, 1)
 361          : error_type;
 362    }
 363
 364
 365    /**
 366     * Get the type of a structure field
 367     *
 368     * \return
 369     * Pointer to the type of the named field.  If the type is not a structure
 370     * or the named field does not exist, \c glsl_type::error_type is returned.
 371     */
 372    const glsl_type *field_type(const char *name) const;
 373
 374
 375    /**
 376     * Get the location of a filed within a record type
 377     */
 378    int field_index(const char *name) const;
 379
 380
 381    /**
 382     * Query the number of elements in an array type
 383     *
 384     * \return
 385     * The number of elements in the array for array types or -1 for non-array
 386     * types.  If the number of elements in the array has not yet been declared,
 387     * zero is returned.
 388     */
 389    int array_size() const
 390    {
 391       return is_array() ? length : -1;
 392    }
 393
 394 private:
 395    /**
 396     * ralloc context for all glsl_type allocations
 397     *
 398     * Set on the first call to \c glsl_type::new.
 399     */
 400    static void *mem_ctx;
 401
 402    void init_ralloc_type_ctx(void);
 403
 404    /** Constructor for vector and matrix types */
 405    glsl_type(GLenum gl_type,
 406              glsl_base_type base_type, unsigned vector_elements,
 407              unsigned matrix_columns, const char *name);
 408
 409    /** Constructor for sampler types */
 410    glsl_type(GLenum gl_type,
 411              enum glsl_sampler_dim dim, bool shadow, bool array,
 412              unsigned type, const char *name);
 413
 414    /** Constructor for record types */
 415    glsl_type(const glsl_struct_field *fields, unsigned num_fields,
 416              const char *name);
 417
 418    /** Constructor for array types */
 419    glsl_type(const glsl_type *array, unsigned length);
 420
 421    /** Hash table containing the known array types. */
 422    static struct hash_table *array_types;
 423
 424    /** Hash table containing the known record types. */
 425    static struct hash_table *record_types;
 426
 427    static int record_key_compare(const void *a, const void *b);
 428    static unsigned record_key_hash(const void *key);
 429
 430    /**
 431     * \name Pointers to various type singletons
 432     */
 433    /*@{*/
 434    static const glsl_type _error_type;
 435    static const glsl_type _void_type;
 436    static const glsl_type _sampler3D_type;
 437    static const glsl_type builtin_core_types[];
 438    static const glsl_type builtin_structure_types[];
 439    static const glsl_type builtin_110_deprecated_structure_types[];
 440    static const glsl_type builtin_110_types[];
 441    static const glsl_type builtin_120_types[];
 442    static const glsl_type builtin_130_types[];
 443    static const glsl_type builtin_ARB_texture_rectangle_types[];
 444    static const glsl_type builtin_EXT_texture_array_types[];
 445    static const glsl_type builtin_EXT_texture_buffer_object_types[];
 446    /*@}*/
 447
 448    /**
 449     * \name Methods to populate a symbol table with built-in types.
 450     *
 451     * \internal
 452     * This is one of the truely annoying things about C++.  Methods that are
 453     * completely internal and private to a type still have to be advertised to
 454     * the world in a public header file.
 455     */
 456    /*@{*/
 457    static void generate_100ES_types(glsl_symbol_table *);
 458    static void generate_110_types(glsl_symbol_table *);
 459    static void generate_120_types(glsl_symbol_table *);
 460    static void generate_130_types(glsl_symbol_table *);
 461    static void generate_ARB_texture_rectangle_types(glsl_symbol_table *, bool);
 462    static void generate_EXT_texture_array_types(glsl_symbol_table *, bool);
 463    static void generate_OES_texture_3D_types(glsl_symbol_table *, bool);
 464    /*@}*/
 465
 466    /**
 467     * \name Friend functions.
 468     *
 469     * These functions are friends because they must have C linkage and the
 470     * need to call various private methods or access various private static
 471     * data.
 472     */
 473    /*@{*/
 474    friend void _mesa_glsl_initialize_types(struct _mesa_glsl_parse_state *);
 475    friend void _mesa_glsl_release_types(void);
 476    /*@}*/
 477 };
 478
 479 struct glsl_struct_field {
 480    const struct glsl_type *type;
 481    const char *name;
 482 };
 483
 484 #endif /* GLSL_TYPES_H */