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