cdp_avp: added README file
[sip-router] / rvalue.h
index 8e67c2e..14675af 100644 (file)
--- a/rvalue.h
+++ b/rvalue.h
@@ -1,6 +1,4 @@
 /* 
- * $Id$
- * 
  * Copyright (C) 2008 iptelorg GmbH
  *
  * Permission to use, copy, modify, and distribute this software for any
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 /**
  * @file 
- * @brief rvalue expressions
+ * @brief SIP-router core :: rvalue expressions
+ * @ingroup core
+ * Module: \ref core
  */
 /* 
  * History:
  * --------
@@ -48,41 +50,45 @@ enum rval_type{
 };
 
 enum rval_expr_op{
-       RVE_NONE_OP,  /* uninit / empty */
-       RVE_RVAL_OP,  /* special op, means that the expr. is in fact a rval */
-       RVE_UMINUS_OP, /* one member expression, returns -(val) */
-       RVE_BOOL_OP,  /* one member evaluate as bool. : (val!=0)*/
-       RVE_LNOT_OP,  /* one member evaluate as bool. : (!val)*/
-       RVE_MUL_OP,   /* 2 members, returns left * right */
-       RVE_DIV_OP,   /* 2 members, returns left / right */
-       RVE_MOD_OP,   /* 2 members, returns left % right */
-       RVE_MINUS_OP, /* 2 members, returns left - right */
-       RVE_BAND_OP,  /* 2 members, returns left | right */
-       RVE_BOR_OP,   /* 2 members, returns left & right */
-       RVE_LAND_OP,  /* 2 members, returns left && right */
-       RVE_LOR_OP,   /* 2 members, returns left || right */
-       RVE_GT_OP,    /*  2 members, returns left > right */
-       RVE_GTE_OP,   /*  2 members, returns left >= right */
-       RVE_LT_OP,    /*  2 members, returns left  < right */
-       RVE_LTE_OP,   /*  2 members, returns left <= right */
-       RVE_IEQ_OP, /*  2 members, int == version, returns left == right */
-       RVE_IDIFF_OP,/* 2 members, int != version, returns left != right */
-       RVE_IPLUS_OP, /* 2 members, integer +, returns int(a)+int(b) */
+       RVE_NONE_OP,  /**< uninit / empty */
+       RVE_RVAL_OP,  /**< special op, means that the expr. is in fact a rval */
+       RVE_UMINUS_OP, /**< one member expression, returns -(val) */
+       RVE_BOOL_OP,  /**< one member evaluate as bool. : (val!=0)*/
+       RVE_LNOT_OP,  /**< one member evaluate as bool. : (!val)*/
+       RVE_BNOT_OP,  /**< one member evaluate as binary : (~ val)*/
+       RVE_MUL_OP,   /**< 2 members, returns left * right */
+       RVE_DIV_OP,   /**< 2 members, returns left / right */
+       RVE_MOD_OP,   /**< 2 members, returns left % right */
+       RVE_MINUS_OP, /**< 2 members, returns left - right */
+       RVE_BAND_OP,  /**< 2 members, returns left | right */
+       RVE_BOR_OP,   /**< 2 members, returns left & right */
+       RVE_BXOR_OP,   /**< 2 members, returns left XOR right */
+       RVE_BLSHIFT_OP, /**< 2 members, returns left << right */
+       RVE_BRSHIFT_OP, /**< 2 members, returns left >> right */
+       RVE_LAND_OP,  /**< 2 members, returns left && right */
+       RVE_LOR_OP,   /**< 2 members, returns left || right */
+       RVE_GT_OP,    /**<  2 members, returns left > right */
+       RVE_GTE_OP,   /**<  2 members, returns left >= right */
+       RVE_LT_OP,    /**<  2 members, returns left  < right */
+       RVE_LTE_OP,   /**<  2 members, returns left <= right */
+       RVE_IEQ_OP,   /**<  2 members, int == version, returns left == right */
+       RVE_IDIFF_OP, /**< 2 members, int != version, returns left != right */
+       RVE_IPLUS_OP, /**< 2 members, integer +, returns int(a)+int(b) */
        /* common int & str */
-       RVE_PLUS_OP,  /* generic plus (int or str) returns left + right */
-       RVE_EQ_OP,    /*  2 members, returns left == right  (int)*/
-       RVE_DIFF_OP,  /*  2 members, returns left != right  (int)*/
+       RVE_PLUS_OP,  /**< generic plus (int or str) returns left + right */
+       RVE_EQ_OP,    /**<  2 members, returns left == right  (int)*/
+       RVE_DIFF_OP,  /**<  2 members, returns left != right  (int)*/
        /* str only */
-       RVE_CONCAT_OP,/* 2 members, string concat, returns left . right (str)*/
-       RVE_STRLEN_OP, /* one member, string length:, returns strlen(val) (int)*/
-       RVE_STREMPTY_OP, /* one member, returns val=="" (bool) */
-       RVE_STREQ_OP,  /* 2 members, string == , returns left == right (bool)*/
-       RVE_STRDIFF_OP,/* 2 members, string != , returns left != right (bool)*/
-       RVE_MATCH_OP,  /* 2 members, string ~),  returns left matches re(right) */
+       RVE_CONCAT_OP, /**< 2 members, string concat, returns left . right (str)*/
+       RVE_STRLEN_OP, /**< one member, string length:, returns strlen(val) (int)*/
+       RVE_STREMPTY_OP, /**< one member, returns val=="" (bool) */
+       RVE_STREQ_OP,  /**< 2 members, string == , returns left == right (bool)*/
+       RVE_STRDIFF_OP,/**< 2 members, string != , returns left != right (bool)*/
+       RVE_MATCH_OP,  /**< 2 members, string ~),  returns left matches re(right) */
        /* avp, pvars a.s.o */
-       RVE_DEFINED_OP, /* one member, returns is_defined(val) (bool) */
-       RVE_INT_OP,   /* one member, returns (int)val  (int) */
-       RVE_STR_OP    /* one member, returns (str)val  (str) */
+       RVE_DEFINED_OP, /**< one member, returns is_defined(val) (bool) */
+       RVE_INT_OP,   /**< one member, returns (int)val  (int) */
+       RVE_STR_OP    /**< one member, returns (str)val  (str) */
 };
 
 
@@ -115,12 +121,11 @@ struct rvalue{
 
 
 /* rvalue flags */
-#define RV_CNT_ALLOCED_F  1  /* free contents  (pkg mem allocated) */
-#define RV_RV_ALLOCED_F   2  /* free rv itself (pkg_free(rv)) */
+#define RV_CNT_ALLOCED_F  1  /**< free contents  (pkg mem allocated) */
+#define RV_RV_ALLOCED_F   2  /**< free rv itself (pkg_free(rv)) */
 #define RV_ALL_ALLOCED_F  (RV_CNT_ALLOCED|RV_RV_ALLOCED)
-#define RV_RE_F  4 /* string is a RE with a valid v->re member */
-#define RV_RE_ALLOCED_F 8 /* v->re.regex must be freed */
-
+#define RV_RE_F  4 /**< string is a RE with a valid v->re member */
+#define RV_RE_ALLOCED_F 8 /**< v->re.regex must be freed */
 
 struct rval_expr{
        enum rval_expr_op op;
@@ -163,6 +168,15 @@ struct rval_cache{
 /** allocates a new rval (should be freed by rval_destroy()). */
 struct rvalue* rval_new_empty(int extra_size);
 struct rvalue* rval_new_str(str* s, int extra_size);
+
+/**
+ * @brief create a new pk_malloc'ed rvalue from a rval_val union
+ * @param t rvalue type
+ * @param v rvalue value
+ * @param extra_size extra space to allocate
+ * (so that future string operation can reuse the space)
+ * @return new rv or 0 on error
+ */
 struct rvalue* rval_new(enum rval_type t, union rval_val* v, int extra_size);
 
 /** inits a rvalue structure- */
@@ -182,7 +196,23 @@ void rval_clean(struct rvalue* rv);
 void rval_cache_clean(struct rval_cache* rvc);
 
 
-/** convert a rvalue to another type.  */
+/**
+ * @brief Convert a rvalue to another rvalue, of a specific type
+ *
+ * Convert a rvalue to another rvalue, of a specific type.
+ * The result is read-only in most cases (can be a reference
+ * to another rvalue, can be checked by using rv_chg_in_place()) and
+ * _must_ be rval_destroy()'ed.
+ *
+ * @param h run action context
+ * @param msg SIP mesasge
+ * @param type - type to convert to
+ * @param v - rvalue to convert
+ * @param c - rval_cache (cached v value if known/filled by another
+ *            function), can be 0 (unknown/not needed)
+ * @return pointer to a rvalue (reference to an existing one or a new
+ * one, @see rv_chg_in_place() and the above comment), or 0 on error.
+ */
 struct rvalue* rval_convert(struct run_act_ctx* h, struct sip_msg* msg, 
                                                        enum rval_type type, struct rvalue* v,
                                                        struct rval_cache* c);
@@ -203,10 +233,37 @@ int rval_get_tmp_str(struct run_act_ctx* h, struct sip_msg* msg,
 /** evals an integer expr  to an int. */
 int rval_expr_eval_int( struct run_act_ctx* h, struct sip_msg* msg,
                                                int* res, struct rval_expr* rve);
-/** evals a rval expr.. */
+
+/**
+ * @brief Evals a rval expression
+ * @warning result must be rval_destroy()'ed if non-null (it might be
+ * a reference to another rval). The result can be modified only
+ * if rv_chg_in_place() returns true.
+ * @param h run action context
+ * @param msg SIP message
+ * @param rve rvalue expression
+ * @return rvalue on success, 0 on error
+ */
 struct rvalue* rval_expr_eval(struct run_act_ctx* h, struct sip_msg* msg,
                                                                struct rval_expr* rve);
-/** evals an integer expr  to an int or rvalue. */
+
+/**
+ * @brief Evals a rval expression into an int or another rv(str)
+ * @warning rv result (rv_res) must be rval_destroy()'ed if non-null
+ * (it might be a reference to another rval). The result can be
+ * modified only if rv_chg_in_place() returns true.
+ * @param h run action context
+ * @param msg SIP message
+ * @param res_rv pointer to rvalue result, if non-null it means the 
+ * expression evaluated to a non-int (str), which will be stored here.
+ * @param res_i pointer to int result, if res_rv==0 and the function
+ * returns success => the result is an int which will be stored here.
+ * @param rve expression that will be evaluated.
+ * @param cache write-only value cache, it might be filled if non-null and
+ * empty (rval_cache_init()). If non-null, it _must_ be rval_cache_clean()'ed
+ * when done. 
+ * @return 0 on success, -1 on error, sets *res_rv or *res_i.
+ */
 int rval_expr_eval_rvint( struct run_act_ctx* h, struct sip_msg* msg,
                                                 struct rvalue** rv_res, int* i_res,
                                                 struct rval_expr* rve, struct rval_cache* cache);
@@ -218,7 +275,20 @@ enum rval_type rve_guess_type(struct rval_expr* rve);
 int rve_is_constant(struct rval_expr* rve);
 /** returns true if the expression can have side-effect */
 int rve_has_side_effects(struct rval_expr* rve);
-/** returns 1 if expression is valid (type-wise).*/
+
+/**
+ * @brief Returns 1 if expression is valid (type-wise)
+ * @param type filled with the type of the expression (RV_INT, RV_STR or
+ *                RV_NONE if it's dynamic)
+ * @param rve  checked expression
+ * @param bad_rve set on failure to the subexpression for which the 
+ * type check failed
+ * @param bad_t set on failure to the type of the bad subexpression
+ * @param exp_t set on failure to the expected type for the bad
+ * subexpression
+ * @return 0 or 1 and sets *type to the resulting type
+ * (RV_INT, RV_STR or RV_NONE if it can be found only at runtime)
+ */
 int rve_check_type(enum rval_type* type, struct rval_expr* rve,
                                        struct rval_expr** bad_rve, enum rval_type* bad_type,
                                        enum rval_type* exp_type);
@@ -229,10 +299,27 @@ char* rval_type_name(enum rval_type type);
   */
 struct rval_expr* mk_rval_expr_v(enum rval_type rv_type, void* val,
                                                                        struct cfg_pos* pos);
-/** create a unary op. rval_expr.. */
+
+/**
+ * @brief Create a unary op. rval_expr
+ * ret= op rve1
+ * @param op   - rval expr. unary operator
+ * @param rve1 - rval expr. on which the operator will act.
+ * @param pos configuration position
+ * @return new pkg_malloc'ed rval_expr or 0 on error.
+ */
 struct rval_expr* mk_rval_expr1(enum rval_expr_op op, struct rval_expr* rve1,
                                                                        struct cfg_pos* pos);
-/** create a rval_expr. from 2 other rval exprs, using op. */
+
+/**
+ * @brief Create a rval_expr. from 2 other rval exprs, using op
+ * ret = rve1 op rve2
+ * @param op   - rval expr. operator
+ * @param rve1 - rval expr. on which the operator will act.
+ * @param rve2 - rval expr. on which the operator will act.
+ * @param pos configuration position
+ * @return new pkg_malloc'ed rval_expr or 0 on error.
+ */
 struct rval_expr* mk_rval_expr2(enum rval_expr_op op, struct rval_expr* rve1,
                                                                                                          struct rval_expr* rve2,
                                                                                                          struct cfg_pos* pos);