chmod a-x
[mesa.git] / src / mesa / shader / slang / slang_compile_function.h
index 96a6598da67753ff3969d23a270837bb3dc90b97..8f0e3b326d43743953112fec7c9b55abcc23e5a6 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * Mesa 3-D graphics library
- * Version:  6.5
+ * Version:  6.5.2
  *
  * Copyright (C) 2005-2006  Brian Paul   All Rights Reserved.
  *
@@ -22,7 +22,7 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-#if !defined SLANG_COMPILE_FUNCTION_H
+#ifndef SLANG_COMPILE_FUNCTION_H
 #define SLANG_COMPILE_FUNCTION_H
 
 #if defined __cplusplus
@@ -30,59 +30,86 @@ extern "C" {
 #endif
 
 struct slang_code_unit_;
-struct slang_translation_unit_;
 
+/**
+ * Types of functions.
+ */
 typedef enum slang_function_kind_
 {
-       slang_func_ordinary,
-       slang_func_constructor,
-       slang_func_operator
+   slang_func_ordinary,
+   slang_func_constructor,
+   slang_func_operator
 } slang_function_kind;
 
+
+/**
+ * When we need to fill in addresses which we won't know until the future,
+ * we keep track of them with a fix-up table.
+ */
 typedef struct slang_fixup_table_
 {
-       GLuint *table;
-       GLuint count;
+   GLuint *table;     /**< array[count] of addresses */
+   GLuint count;
 } slang_fixup_table;
 
-void slang_fixup_table_init (slang_fixup_table *);
-void slang_fixup_table_free (slang_fixup_table *);
+extern void slang_fixup_table_init(slang_fixup_table *);
+extern void slang_fixup_table_free(slang_fixup_table *);
+extern GLboolean slang_fixup_save(slang_fixup_table *fixups, GLuint address);
+
 
+/**
+ * Description of a compiled shader function.
+ */
 typedef struct slang_function_
 {
-       slang_function_kind kind;
-       slang_variable header;
-       slang_variable_scope *parameters;
-       unsigned int param_count;
-       slang_operation *body;
-       unsigned int address;
-       slang_fixup_table fixups;
+   slang_function_kind kind;
+   slang_variable header;      /**< The function's name and return type */
+   slang_variable_scope *parameters; /**< formal parameters AND local vars */
+   unsigned int param_count;   /**< number of formal params (no locals) */
+   slang_operation *body;      /**< The instruction tree */
+   unsigned int address;       /**< Address of this func in memory */
+   slang_fixup_table fixups;   /**< Mem locations which need func's address */
+   slang_atom end_label;       /**< The end-of-function label */
 } slang_function;
 
-int slang_function_construct (slang_function *);
-void slang_function_destruct (slang_function *);
+extern int slang_function_construct(slang_function *);
+extern void slang_function_destruct(slang_function *);
+
 
+/**
+ * Basically, a list of compiled functions.
+ */
 typedef struct slang_function_scope_
 {
-       slang_function *functions;
+   slang_function *functions;
    GLuint num_functions;
-       struct slang_function_scope_ *outer_scope;
+   struct slang_function_scope_ *outer_scope;
 } slang_function_scope;
 
+
 extern GLvoid
-_slang_function_scope_ctr (slang_function_scope *);
+_slang_function_scope_ctr(slang_function_scope *);
 
-void slang_function_scope_destruct (slang_function_scope *);
-int slang_function_scope_find_by_name (slang_function_scope *, slang_atom, int);
-slang_function *slang_function_scope_find (slang_function_scope *, slang_function *, int);
+extern void
+slang_function_scope_destruct(slang_function_scope *);
 
 extern GLboolean
-_slang_build_export_code_table (slang_export_code_table *, slang_function_scope *,
-                                struct slang_code_unit_ *);
+_slang_function_has_return_value(const slang_function *fun);
+
+extern int
+slang_function_scope_find_by_name(slang_function_scope *, slang_atom, int);
+
+extern slang_function *
+slang_function_scope_find(slang_function_scope *, slang_function *, int);
+
+extern GLboolean
+_slang_build_export_code_table(slang_export_code_table *,
+                               slang_function_scope *,
+                               struct slang_code_unit_ *);
+
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-
+#endif /* SLANG_COMPILE_FUNCTION_H */