2 * Mesa 3-D graphics library
5 * Copyright (C) 2005-2006 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
25 #if !defined SLANG_STORAGE_H
26 #define SLANG_STORAGE_H
28 #include "slang_compile.h"
29 #include "slang_assemble_typeinfo.h"
31 #if defined __cplusplus
36 * Program variable data storage is kept completely transparent to the front-end compiler. It is
37 * up to the back-end how the data is actually allocated. The slang_storage_type enum
38 * provides the basic information about how the memory is interpreted. This abstract piece
39 * of memory is called a data slot. A data slot of a particular type has a fixed size.
41 * For now, only the three basic types are supported, that is bool, int and float. Other built-in
42 * types like vector or matrix can easily be decomposed into a series of basic types.
44 * If the vec4 module is enabled, 4-component vectors of floats are used when possible. 4x4 matrices
45 * are constructed of 4 vec4 slots.
47 typedef enum slang_storage_type_
59 * The slang_storage_array structure groups data slots of the same type into an array. This
60 * array has a fixed length. Arrays are required to have a size equal to the sum of sizes of its
61 * elements. They are also required to support indirect addressing. That is, if B references
62 * first data slot in the array, S is the size of the data slot and I is the integral index that
63 * is not known at compile time, B+I*S references I-th data slot.
65 * This structure is also used to break down built-in data types that are not supported directly.
66 * Vectors, like vec3, are constructed from arrays of their basic types. Matrices are formed of
67 * an array of column vectors, which are in turn processed as other vectors.
69 typedef struct slang_storage_array_
71 slang_storage_type type
;
72 struct slang_storage_aggregate_
*aggregate
; /* slang_stor_aggregate */
74 } slang_storage_array
;
76 GLboolean
slang_storage_array_construct (slang_storage_array
*);
77 GLvoid
slang_storage_array_destruct (slang_storage_array
*);
80 * The slang_storage_aggregate structure relaxes the indirect addressing requirement for
81 * slang_storage_array structure. Aggregates are always accessed statically - its member
82 * addresses are well-known at compile time. For example, user-defined types are implemented as
83 * aggregates. Aggregates can collect data of a different type.
85 typedef struct slang_storage_aggregate_
87 slang_storage_array
*arrays
;
89 } slang_storage_aggregate
;
91 GLboolean
slang_storage_aggregate_construct (slang_storage_aggregate
*);
92 GLvoid
slang_storage_aggregate_destruct (slang_storage_aggregate
*);
95 _slang_aggregate_variable(slang_storage_aggregate
*agg
,
96 slang_type_specifier
*spec
,
98 slang_function_scope
*funcs
,
99 slang_struct_scope
*structs
,
100 slang_variable_scope
*vars
,
102 slang_assembly_file
*file
,
104 slang_atom_pool
*atoms
);
107 * Returns the size (in machine units) of the given storage type.
108 * It is an error to pass-in slang_stor_aggregate.
109 * Returns 0 on error.
112 _slang_sizeof_type (slang_storage_type
);
115 * Returns total size (in machine units) of the given aggregate.
116 * Returns 0 on error.
118 GLuint
_slang_sizeof_aggregate (const slang_storage_aggregate
*);
121 * Converts structured aggregate to a flat one, with arrays of generic type being
123 * Returns GL_TRUE on success.
124 * Returns GL_FALSE otherwise.
126 GLboolean
_slang_flatten_aggregate (slang_storage_aggregate
*, const slang_storage_aggregate
*);