[sr-dev] git:andrei/rve_f_params: core: ut.h: added sint2strbuf()

Module: sip-router Branch: andrei/rve_f_params Commit: e9380311afbab7366c55cc3f143f10547e6f40ff URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e938031… Author: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Committer: Andrei Pelinescu-Onciul &lt;andrei(a)iptel.org&gt; Date: Tue Mar 16 19:28:36 2010 +0100 core: ut.h: added sint2strbuf() - added sint2strbuf() that works like sint2str(), but isntead of using a static buffer, requires a buffer to be provided by the called (hence being much safer). - increased INST2STR_MAX_LEN to accommodate for sign. --- ut.h | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 files changed, 64 insertions(+), 11 deletions(-) diff --git a/ut.h b/ut.h index 2328824..d8c4cf2 100644 --- a/ut.h +++ b/ut.h @@ -42,6 +42,11 @@ * 2007-05-14 added get_sys_ver() (andrei) * 2007-06-05 added MAX_UVAR_VALUE(), MAX_int(a,b) MIN_int(a,b) (andrei) * 2008-05-21 added ushort2sbuf(), ushort2str() (andrei) + * 2009-03-16 added sint2strbuf() and incremented INST2STR_MAX_LEN to account + * for sign (andrei) + */ +/** various helper functions. + * @file */ @@ -245,7 +250,8 @@ static inline int btostr( char *p, unsigned char val) } -#define INT2STR_MAX_LEN (19+1+1) /* 2^64~= 16*10^18 => 19+1 digits + \0 */ +#define INT2STR_MAX_LEN (19+1+1+1) /* 2^64~= 16*10^18 => + 19+1 digits + sign + \0 */ /* * returns a pointer to a static buffer containing l in asciiz (with base "base") & sets len @@ -292,9 +298,19 @@ static inline char* int2str_base(unsigned int l, int* len, int base) -/* print int to asciiz in a string buffer - * - be sure result buffer is at least INT2STR_MAX_LEN in size */ -static inline char* int2strbuf(unsigned int l, char *r, int r_size, int* len) +/** unsigned long to str conversion using a provided buffer. + * Converts/prints an unsigned long to a string. The result buffer must be + * provided and its length must be at least INT2STR_MAX_LEN. + * @param l - unsigned long to be converted + * @param r - pointer to result buffer + * @param r_size - result buffer size, must be at least INT2STR_MAX_LEN. + * @param *len - length of the written string, _without_ the terminating 0. + * @return pointer _inside_ r, to the converted string (note: the string + * is written from the end of the buffer and not from the start and hence + * the returned pointer will most likely not be equal to r). In case of error + * it returns 0 (the only error being insufficient provided buffer size). + */ +static inline char* int2strbuf(unsigned long l, char *r, int r_size, int* len) { int i; @@ -318,33 +334,70 @@ static inline char* int2strbuf(unsigned int l, char *r, int r_size, int* len) } extern char ut_buf_int2str[INT2STR_MAX_LEN]; -/* returns a pointer to a static buffer containing l in asciiz & sets len */ +/** interger(long) to string conversion. + * This version uses a static buffer (shared with sint2str()). + * WARNING: other function calls might overwrite the static buffer, so + * either always save the result immediately or use int2strbuf(...). + * @param l - unsigned long to be converted/printed. + * @param *len - will be filled with the final length (without the terminating + * 0). + * @return a pointer to a static buffer containing l in asciiz & sets len. + */ static inline char* int2str(unsigned long l, int* len) { return int2strbuf(l, ut_buf_int2str, INT2STR_MAX_LEN, len); } -/* Signed INTeger-TO-STRing: convers a long to a string - * returns a pointer to a static buffer containing l in asciiz & sets len */ -static inline char* sint2str(long l, int* len) + + +/** signed long to str conversion using a provided buffer. + * Converts a long to a signed string. The result buffer must be provided + * and its length must be at least INT2STR_MAX_LEN. + * @param l - long to be converted + * @param r - pointer to result buffer + * @param r_size - result buffer size, must be at least INT2STR_MAX_LEN. + * @param *len - length of the written string, _without_ the terminating 0. + * @return pointer _inside_ r, to the converted string (note: the string + * is written from the end of the buffer and not from the start and hence + * the returned pointer will most likely not be equal to r). In case of error + * it returns 0 (the only error being insufficient provided buffer size). + */ +static inline char* sint2strbuf(long l, char* r, int r_size, int* len) { int sign; char *p; + int p_len; sign = 0; if(l<0) { sign = 1; l = -l; } - p = int2str((unsigned long)l, len); - if(sign && *len<(INT2STR_MAX_LEN-1)) { + p = int2strbuf((unsigned long)l, r, r_size, &p_len); + if(sign && *len<(r_size-1)) { *(--p) = '-'; - if (len) (*len)++; + p_len++;; } + if (likely(len)) + *len = p_len; return p; } +/** Signed INTeger-TO-STRing: converts a long to a string. + * This version uses a static buffer, shared with int2str(). + * WARNING: other function calls might overwrite the static buffer, so + * either always save the result immediately or use sint2strbuf(...). + * @param l - long to be converted/printed. + * @param *len - will be filled with the final length (without the terminating + * 0). + * @return a pointer to a static buffer containing l in asciiz & sets len. + */ +static inline char* sint2str(long l, int* len) +{ + return sint2strbuf(l, ut_buf_int2str, INT2STR_MAX_LEN, len); +} + #define USHORT2SBUF_MAX_LEN 5 /* 65535*/