strapi.h File Reference

Detailed Description

This file attempts to provide a "standardized" set of C library functions that operate on C null terminated strings.

In a perfect world there would be no need for this interface since all compilers would follow the ISO standards - however there are some compilers (VS comes to mind) that still do no compile with C99 or C99 support as part of C++11. It also facilities solutions for embedded platforms that need alternate implementation of snprintf.

#include "colony_map.h"

Include dependency graph for strapi.h:

Go to the source code of this file.

Macros
#define	strcasecmp   strcasecmp_MAP
	Compares two string ignoring case.
#define	strncasecmp   strncasecmp_MAP
	Same as strcasecmp, but only compares up to 'n' bytes.
#define	strupr   strupr_MAP
	Converts the entire string to upper case letters.
#define	strlwr   strlwr_MAP
	Converts the entire string to lower case letters.
#define	strset   strset_MAP
	Fill a string with a given character.
#define	strnset   strnset_MAP
	Fill a string with a given character, to a given length.
#define	strrev   strrev_MAP
	Reverse the specified string.
#define	strtok_r   strtok_r_MAP
	Break a string into tokens, i.e.
#define	snprintf   snprintf_MAP
	Same functionality as snprintf(), except at most 'count-1' character will be stored in the output string.
#define	vsnprintf   vsnprintf_MAP
	Same as snprintf except uses vaargs arguments.

Macro Definition Documentation

snprintf

#define snprintf   snprintf_MAP

Same functionality as snprintf(), except at most 'count-1' character will be stored in the output string.

The result is guaranteed to be null terminated.

Returns the number of characters that would have been written into the array, not counting the terminating null character, had count been large enough. It does this even if count is zero; in this case buf can be NULL. If an error occurred, snprintf() returns a negative value and sets errno.

Prototype: int snprintf( char* buf, size_t count, const char* format, ... );

strcasecmp

#define strcasecmp   strcasecmp_MAP

Compares two string ignoring case.

It has the same semantics as strcmp.

Prototype: int strcasecmp(const char *s1, const char *s2);

strlwr

#define strlwr   strlwr_MAP

Converts the entire string to lower case letters.

Returns the converted string (i.e. same pointer that is/was passed in)

Prototype: char* strlwr( char* s1 );

strncasecmp

#define strncasecmp   strncasecmp_MAP

Same as strcasecmp, but only compares up to 'n' bytes.

It has the same semantics as strncmp.

Prototype: int strncasecmp(const char *s1, const char *s2, size_t n);

strnset

#define strnset   strnset_MAP

Fill a string with a given character, to a given length.

Returns the converted string (i.e. same pointer that is/was passed in)

Prototype: char* strnset( char* s1, int fill, size_t len );

strrev

#define strrev   strrev_MAP

Reverse the specified string.

Returns the reversed string (i.e. same pointer that is/was passed in)

Prototype: char* strrev( char* s1 );

strset

#define strset   strset_MAP

Fill a string with a given character.

Returns the converted string (i.e. same pointer that is/was passed in)

Prototype: char* strset( char* s1, int fill );

strtok_r

#define strtok_r   strtok_r_MAP

Break a string into tokens, i.e.

same as strtok(), but strtok_r is a reentrant implementation. 'lasts' is the address of a pointer to a character, which the function can use to store information necessary for it to continue scanning the same string.

Prototype: char* strtok_r( char* s, const char* sep, char** lasts );

strupr

#define strupr   strupr_MAP

Converts the entire string to upper case letters.

Returns the converted string (i.e. same pointer that is/was passed in)

Prototype: char* strupr( char* s1 );

vsnprintf

#define vsnprintf   vsnprintf_MAP

Same as snprintf except uses vaargs arguments.

Prototype: int vsnprintf(char *str, size_t size, const char *format, va_list ap);