Asterisk.org: Developer Documentation (1 Nov 2008)

Go to the source code of this file.


Data Structures
struct	ast_realloca
Defines
#define	ast_restrdupa(ra, s)
Functions
size_t const char	__attribute__ ((format(printf, 3, 4)))
int	ast_build_string_va (char *buffer, size_t space, const char *fmt, va_list ap)
	Build a string in a buffer, designed to be called repeatedly.
int	ast_false (const char *val)
	AST_INLINE_API (void ast_copy_string(char dst, const char src, size_t size),{while(src &&size){dst++=src++;size--;}if(__builtin_expect(!size, 0)) dst--;dst= '\0';}) int ast_build_string(char **buffer
	Size-limited null-terminating string copy. Build a string in a buffer, designed to be called repeatedly.
	AST_INLINE_API (char ast_skip_blanks(char str),{while(str &&str< 33) str++;return str;}) AST_INLINE_API(char ast_trim_blanks(char str)
	Gets a pointer to the first non-whitespace character in a string. Trims trailing whitespace characters from a string.
static force_inline int	ast_strlen_zero (const char *s)
int	ast_true (const char *val)
char *	strcasestr (const char , const char )
char *	strndup (const char *, size_t)
size_t	strnlen (const char *, size_t)
uint64_t	strtoq (const char nptr, char *endptr, int base)
int	vasprintf (char *strp, const char fmt, va_list ap)
Variables
size_t const char *	fmt
size_t *	space

Detailed Description

Define Documentation

#define ast_restrdupa	(	ra,
		s		)

Definition at line 220 of file strings.h.

Function Documentation

size_t const char __attribute__ ( (format(printf, 3, 4)) )

Referenced by get_unaligned_uint16(), get_unaligned_uint32(), put_unaligned_uint16(), and put_unaligned_uint32().

int ast_build_string_va	(	char **	buffer,
		size_t *	space,
		const char *	fmt,
		va_list	ap
	)

Build a string in a buffer, designed to be called repeatedly.

This is a wrapper for snprintf, that properly handles the buffer pointer and buffer space available.

Returns:: 0 on success, non-zero on failure.

Parameters:

	buffer	current position in buffer to place string into (will be updated on return)
	space	remaining space in buffer (will be updated on return)
	fmt	printf-style format string
	ap	varargs list of arguments for format

Definition at line 536 of file utils.c.

Referenced by ast_build_string(), and manager_event().

00537 {
00538    int result;
00539 
00540    if (!buffer || !*buffer || !space || !*space)
00541       return -1;
00542 
00543    result = vsnprintf(*buffer, *space, fmt, ap);
00544 
00545    if (result < 0)
00546       return -1;
00547    else if (result > *space)
00548       result = *space;
00549 
00550    *buffer += result;
00551    *space -= result;
00552    return 0;
00553 }

int ast_false ( const char * val )

Determine if a string containing a boolean value is "false". This function checks to see whether a string passed to it is an indication of an "false" value. It checks to see if the string is "no", "false", "n", "f", "off" or "0".

Returns 0 if val is a NULL pointer, -1 if "false", and 0 otherwise.

Definition at line 584 of file utils.c.

References ast_strlen_zero().

Referenced by ast_rtp_reload(), ast_strings_to_mask(), handle_common_options(), and pbx_load_module().

00585 {
00586    if (ast_strlen_zero(s))
00587       return 0;
00588 
00589    /* Determine if this is a false value */
00590    if (!strcasecmp(s, "no") ||
00591        !strcasecmp(s, "false") ||
00592        !strcasecmp(s, "n") ||
00593        !strcasecmp(s, "f") ||
00594        !strcasecmp(s, "0") ||
00595        !strcasecmp(s, "off"))
00596       return -1;
00597 
00598    return 0;
00599 }

AST_INLINE_API ( void ast_copy_string(char *dst, const char *src, size_t size) )

Size-limited null-terminating string copy. Build a string in a buffer, designed to be called repeatedly.

This is a wrapper for snprintf, that properly handles the buffer pointer and buffer space available.

Parameters:

	buffer	current position in buffer to place string into (will be updated on return)
	space	remaining space in buffer (will be updated on return)
	fmt	printf-style format string

Returns:: 0 on success, non-zero on failure.

AST_INLINE_API ( char * ast_skip_blanks(char *str) )

Gets a pointer to the first non-whitespace character in a string. Trims trailing whitespace characters from a string.

Parameters:

	ast_trim_blanks	function being used
	str	the input string

Returns:: a pointer to the modified string

static force_inline int ast_strlen_zero ( const char * s ) [static]

Definition at line 33 of file strings.h.

00034 {
00035    return (!s || (*s == '\0'));
00036 }

int ast_true ( const char * val )

Determine if a string containing a boolean value is "true". This function checks to see whether a string passed to it is an indication of an "true" value. It checks to see if the string is "yes", "true", "y", "t", "on" or "1".

Returns 0 if val is a NULL pointer, -1 if "true", and 0 otherwise.

Definition at line 567 of file utils.c.

References ast_strlen_zero().

Referenced by __load_resource(), __login_exec(), _parse(), action_agent_callback_login(), action_agent_logoff(), action_originate(), action_setcdruserfield(), apply_option(), ast_readconfig(), ast_strings_to_mask(), build_device(), build_gateway(), build_peer(), build_user(), config_load(), dial_exec_full(), do_reload(), festival_exec(), function_ilink(), get_encrypt_methods(), handle_common_options(), init_logger_chain(), init_manager(), load_config(), load_module(), load_moh_classes(), load_odbc_config(), loadconfigurationfile(), manager_add_queue_member(), manager_pause_queue_member(), odbc_load_module(), parse_config(), pbx_load_module(), queue_set_param(), read_agent_config(), reload_config(), reload_queues(), rpt_master(), set_config(), setup_zap(), start_monitor_action(), and update_common_options().

00568 {
00569    if (ast_strlen_zero(s))
00570       return 0;
00571 
00572    /* Determine if this is a true value */
00573    if (!strcasecmp(s, "yes") ||
00574        !strcasecmp(s, "true") ||
00575        !strcasecmp(s, "y") ||
00576        !strcasecmp(s, "t") ||
00577        !strcasecmp(s, "1") ||
00578        !strcasecmp(s, "on"))
00579       return -1;
00580 
00581    return 0;
00582 }

char* strcasestr	(	const char *	,
		const char *
	)

Definition at line 665 of file utils.c.

References ast_log(), LOG_ERROR, offset, and upper().

Referenced by anti_injection(), do_directory(), find_sdp(), gettag(), handle_response_register(), handle_show_applications(), modlist_modentry(), parse_register_contact(), playback_exec(), realtime_multi_odbc(), realtime_odbc(), reqprep(), respprep(), and sip_sipredirect().

00666 {
00667    char *u1, *u2;
00668    int u1len = strlen(haystack) + 1, u2len = strlen(needle) + 1;
00669 
00670    u1 = alloca(u1len);
00671    u2 = alloca(u2len);
00672    if (u1 && u2) {
00673       char *offset;
00674       if (u2len > u1len) {
00675          /* Needle bigger than haystack */
00676          return NULL;
00677       }
00678       offset = strstr(upper(haystack, u1, u1len), upper(needle, u2, u2len));
00679       if (offset) {
00680          /* Return the offset into the original string */
00681          return ((char *)((unsigned long)haystack + (unsigned long)(offset - u1)));
00682       } else {
00683          return NULL;
00684       }
00685    } else {
00686       ast_log(LOG_ERROR, "Out of memory\n");
00687       return NULL;
00688    }
00689 }

char* strndup	(	const char *	,
		size_t
	)

Definition at line 706 of file utils.c.

References malloc, and strnlen().

00707 {
00708    size_t len = strnlen(s, n);
00709    char *new = malloc(len + 1);
00710 
00711    if (!new)
00712       return NULL;
00713 
00714    new[len] = '\0';
00715    return memcpy(new, s, len);
00716 }

size_t strnlen	(	const char *	,
		size_t
	)

Definition at line 693 of file utils.c.

Referenced by strndup().

00694 {
00695    size_t len;
00696 
00697    for (len=0; len < n; len++)
00698       if (s[len] == '\0')
00699          break;
00700 
00701    return len;
00702 }

uint64_t strtoq	(	const char *	nptr,
		char **	endptr,
		int	base
	)

Definition at line 755 of file utils.c.

References LONG_MAX, LONG_MIN, and s.

00756 {
00757     const char *s;
00758     uint64_t acc;
00759     unsigned char c;
00760     uint64_t qbase, cutoff;
00761     int neg, any, cutlim;
00762 
00763     /*
00764      * Skip white space and pick up leading +/- sign if any.
00765      * If base is 0, allow 0x for hex and 0 for octal, else
00766      * assume decimal; if base is already 16, allow 0x.
00767      */
00768     s = nptr;
00769     do {
00770             c = *s++;
00771     } while (isspace(c));
00772     if (c == '-') {
00773             neg = 1;
00774             c = *s++;
00775     } else {
00776             neg = 0;
00777             if (c == '+')
00778                     c = *s++;
00779     }
00780     if ((base == 0 || base == 16) &&
00781         c == '\0' && (*s == 'x' || *s == 'X')) {
00782             c = s[1];
00783             s += 2;
00784             base = 16;
00785     }
00786     if (base == 0)
00787             base = c == '\0' ? 8 : 10;
00788 
00789     /*
00790      * Compute the cutoff value between legal numbers and illegal
00791      * numbers.  That is the largest legal value, divided by the
00792      * base.  An input number that is greater than this value, if
00793      * followed by a legal input character, is too big.  One that
00794      * is equal to this value may be valid or not; the limit
00795      * between valid and invalid numbers is then based on the last
00796      * digit.  For instance, if the range for quads is
00797      * [-9223372036854775808..9223372036854775807] and the input base
00798      * is 10, cutoff will be set to 922337203685477580 and cutlim to
00799      * either 7 (neg==0) or 8 (neg==1), meaning that if we have
00800      * accumulated a value > 922337203685477580, or equal but the
00801      * next digit is > 7 (or 8), the number is too big, and we will
00802      * return a range error.
00803      *
00804      * Set any if any `digits' consumed; make it negative to indicate
00805      * overflow.
00806      */
00807     qbase = (unsigned)base;
00808     cutoff = neg ? (uint64_t)-(LONG_MIN + LONG_MAX) + LONG_MAX : LONG_MAX;
00809     cutlim = cutoff % qbase;
00810     cutoff /= qbase;
00811     for (acc = 0, any = 0;; c = *s++) {
00812             if (!isascii(c))
00813                     break;
00814             if (isdigit(c))
00815                     c -= '\0';
00816             else if (isalpha(c))
00817                     c -= isupper(c) ? 'A' - 10 : 'a' - 10;
00818             else
00819                     break;
00820             if (c >= base)
00821                     break;
00822             if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
00823                     any = -1;
00824             else {
00825                     any = 1;
00826                     acc *= qbase;
00827                     acc += c;
00828             }
00829     }
00830     if (any < 0) {
00831             acc = neg ? LONG_MIN : LONG_MAX;
00832     } else if (neg)
00833             acc = -acc;
00834     if (endptr != 0)
00835             *((const char **)endptr) = any ? s - 1 : nptr;
00836     return acc;
00837 }

int vasprintf	(	char **	strp,
		const char *	fmt,
		va_list	ap
	)

Definition at line 720 of file utils.c.

References malloc, and s.

00721 {
00722    int size;
00723    va_list ap2;
00724    char s;
00725 
00726    *strp = NULL;
00727    va_copy(ap2, ap);
00728    size = vsnprintf(&s, 1, fmt, ap2);
00729    va_end(ap2);
00730    *strp = malloc(size + 1);
00731    if (!*strp)
00732       return -1;
00733    vsnprintf(*strp, size + 1, fmt, ap);
00734 
00735    return size;
00736 }

Asterisk developer's documentation

strings.h File Reference

Data Structures

Defines

Functions

Variables

Detailed Description

Define Documentation

Function Documentation

Variable Documentation