diff options
Diffstat (limited to 'storage/xtradb/include/eval0eval.h')
-rw-r--r-- | storage/xtradb/include/eval0eval.h | 59 |
1 files changed, 30 insertions, 29 deletions
diff --git a/storage/xtradb/include/eval0eval.h b/storage/xtradb/include/eval0eval.h index 75cf9b38c3a..60aefd8d453 100644 --- a/storage/xtradb/include/eval0eval.h +++ b/storage/xtradb/include/eval0eval.h @@ -16,7 +16,8 @@ Place, Suite 330, Boston, MA 02111-1307 USA *****************************************************************************/ -/****************************************************** +/**************************************************//** +@file include/eval0eval.h SQL evaluator: evaluates simple data structures, like expressions, in a query graph @@ -31,7 +32,7 @@ Created 12/29/1997 Heikki Tuuri #include "pars0sym.h" #include "pars0pars.h" -/********************************************************************* +/*****************************************************************//** Free the buffer from global dynamic memory for a value of a que_node, if it has been allocated in the above function. The freeing for pushed column values is done in sel_col_prefetch_buf_free. */ @@ -39,71 +40,71 @@ UNIV_INTERN void eval_node_free_val_buf( /*===================*/ - que_node_t* node); /* in: query graph node */ -/********************************************************************* + que_node_t* node); /*!< in: query graph node */ +/*****************************************************************//** Evaluates a symbol table symbol. */ UNIV_INLINE void eval_sym( /*=====*/ - sym_node_t* sym_node); /* in: symbol table node */ -/********************************************************************* + sym_node_t* sym_node); /*!< in: symbol table node */ +/*****************************************************************//** Evaluates an expression. */ UNIV_INLINE void eval_exp( /*=====*/ - que_node_t* exp_node); /* in: expression */ -/********************************************************************* + que_node_t* exp_node); /*!< in: expression */ +/*****************************************************************//** Sets an integer value as the value of an expression node. */ UNIV_INLINE void eval_node_set_int_val( /*==================*/ - que_node_t* node, /* in: expression node */ - lint val); /* in: value to set */ -/********************************************************************* -Gets an integer value from an expression node. */ + que_node_t* node, /*!< in: expression node */ + lint val); /*!< in: value to set */ +/*****************************************************************//** +Gets an integer value from an expression node. +@return integer value */ UNIV_INLINE lint eval_node_get_int_val( /*==================*/ - /* out: integer value */ - que_node_t* node); /* in: expression node */ -/********************************************************************* + que_node_t* node); /*!< in: expression node */ +/*****************************************************************//** Copies a binary string value as the value of a query graph node. Allocates a new buffer if necessary. */ UNIV_INLINE void eval_node_copy_and_alloc_val( /*=========================*/ - que_node_t* node, /* in: query graph node */ - const byte* str, /* in: binary string */ - ulint len); /* in: string length or UNIV_SQL_NULL */ -/********************************************************************* + que_node_t* node, /*!< in: query graph node */ + const byte* str, /*!< in: binary string */ + ulint len); /*!< in: string length or UNIV_SQL_NULL */ +/*****************************************************************//** Copies a query node value to another node. */ UNIV_INLINE void eval_node_copy_val( /*===============*/ - que_node_t* node1, /* in: node to copy to */ - que_node_t* node2); /* in: node to copy from */ -/********************************************************************* -Gets a iboolean value from a query node. */ + que_node_t* node1, /*!< in: node to copy to */ + que_node_t* node2); /*!< in: node to copy from */ +/*****************************************************************//** +Gets a iboolean value from a query node. +@return iboolean value */ UNIV_INLINE ibool eval_node_get_ibool_val( /*====================*/ - /* out: iboolean value */ - que_node_t* node); /* in: query graph node */ -/********************************************************************* -Evaluates a comparison node. */ + que_node_t* node); /*!< in: query graph node */ +/*****************************************************************//** +Evaluates a comparison node. +@return the result of the comparison */ UNIV_INTERN ibool eval_cmp( /*=====*/ - /* out: the result of the comparison */ - func_node_t* cmp_node); /* in: comparison node */ + func_node_t* cmp_node); /*!< in: comparison node */ #ifndef UNIV_NONINL |