src/mesa/slang/slang_storage.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5
   4  *
   5  * Copyright (C) 2005-2006  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #ifndef SLANG_STORAGE_H
  26 #define SLANG_STORAGE_H
  27
  28 #include "slang_compile.h"
  29
  30
  31 /*
  32  * Program variable data storage is kept completely transparent to the
  33  * front-end compiler. It is up to the back-end how the data is
  34  * actually allocated. The slang_storage_type enum provides the basic
  35  * information about how the memory is interpreted. This abstract
  36  * piece of memory is called a data slot. A data slot of a particular
  37  * type has a fixed size.
  38  *
  39  * For now, only the three basic types are supported, that is bool,
  40  * int and float. Other built-in types like vector or matrix can
  41  * easily be decomposed into a series of basic types.
  42  *
  43  * If the vec4 module is enabled, 4-component vectors of floats are
  44  * used when possible. 4x4 matrices are constructed of 4 vec4 slots.
  45  */
  46 typedef enum slang_storage_type_
  47 {
  48    /* core */
  49    SLANG_STORE_AGGREGATE,
  50    SLANG_STORE_BOOL,
  51    SLANG_STORE_INT,
  52    SLANG_STORE_FLOAT,
  53    /* vec4 */
  54    SLANG_STORE_VEC4
  55 } slang_storage_type;
  56
  57
  58 /**
  59  * The slang_storage_array structure groups data slots of the same
  60  * type into an array. This array has a fixed length. Arrays are
  61  * required to have a size equal to the sum of sizes of its
  62  * elements. They are also required to support indirect
  63  * addressing. That is, if B references first data slot in the array,
  64  * S is the size of the data slot and I is the integral index that is
  65  * not known at compile time, B+I*S references I-th data slot.
  66  *
  67  * This structure is also used to break down built-in data types that
  68  * are not supported directly.  Vectors, like vec3, are constructed
  69  * from arrays of their basic types. Matrices are formed of an array
  70  * of column vectors, which are in turn processed as other vectors.
  71  */
  72 typedef struct slang_storage_array_
  73 {
  74    slang_storage_type type;
  75    struct slang_storage_aggregate_ *aggregate;
  76    GLuint length;
  77 } slang_storage_array;
  78
  79 GLboolean slang_storage_array_construct (slang_storage_array *);
  80 GLvoid slang_storage_array_destruct (slang_storage_array *);
  81
  82
  83 /**
  84  * The slang_storage_aggregate structure relaxes the indirect
  85  * addressing requirement for slang_storage_array
  86  * structure. Aggregates are always accessed statically - its member
  87  * addresses are well-known at compile time. For example, user-defined
  88  * types are implemented as aggregates. Aggregates can collect data of
  89  * a different type.
  90  */
  91 typedef struct slang_storage_aggregate_
  92 {
  93    slang_storage_array *arrays;
  94    GLuint count;
  95 } slang_storage_aggregate;
  96
  97 GLboolean slang_storage_aggregate_construct (slang_storage_aggregate *);
  98 GLvoid slang_storage_aggregate_destruct (slang_storage_aggregate *);
  99
 100
 101 extern GLboolean
 102 _slang_aggregate_variable(slang_storage_aggregate *agg,
 103                           slang_type_specifier *spec,
 104                           GLuint array_len,
 105                           slang_function_scope *funcs,
 106                           slang_struct_scope *structs,
 107                           slang_variable_scope *vars,
 108                           slang_atom_pool *atoms);
 109
 110 /*
 111  * Returns the size (in machine units) of the given storage type.
 112  * It is an error to pass-in SLANG_STORE_AGGREGATE.
 113  * Returns 0 on error.
 114  */
 115 extern GLuint
 116 _slang_sizeof_type (slang_storage_type);
 117
 118
 119 /**
 120  * Returns total size (in machine units) of the given aggregate.
 121  * Returns 0 on error.
 122  */
 123 extern GLuint
 124 _slang_sizeof_aggregate (const slang_storage_aggregate *);
 125
 126
 127 #if 0
 128 /**
 129  * Converts structured aggregate to a flat one, with arrays of generic
 130  * type being one-element long.  Returns GL_TRUE on success.  Returns
 131  * GL_FALSE otherwise.
 132  */
 133 extern GLboolean
 134 _slang_flatten_aggregate (slang_storage_aggregate *,
 135                           const slang_storage_aggregate *);
 136
 137 #endif
 138
 139 #endif /* SLANG_STORAGE_H */