diff options
Diffstat (limited to 'src/strlib.h')
| -rw-r--r-- | src/strlib.h | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/src/strlib.h b/src/strlib.h new file mode 100644 index 0000000..cd70a62 --- /dev/null +++ b/src/strlib.h @@ -0,0 +1,108 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file strlib.h + @author N. Devillard + @date Jan 2001 + @version $Revision: 1.4 $ + @brief Various string handling routines to complement the C lib. + + This modules adds a few complementary string routines usually missing + in the standard C library. +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: strlib.h,v 1.4 2006-09-27 11:04:11 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2006-09-27 11:04:11 $ + $Revision: 1.4 $ +*/ + +#ifndef _STRLIB_H_ +#define _STRLIB_H_ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include <stdio.h> +#include <stdlib.h> + +/*--------------------------------------------------------------------------- + Function codes + ---------------------------------------------------------------------------*/ + +/*-------------------------------------------------------------------------*/ +/** + @brief Convert a string to lowercase. + @param s String to convert. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string + containing a lowercased version of the input string. Do not free + or modify the returned string! Since the returned string is statically + allocated, it will be modified at each function call (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strlwc(const char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Convert a string to uppercase. + @param s String to convert. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string + containing an uppercased version of the input string. Do not free + or modify the returned string! Since the returned string is statically + allocated, it will be modified at each function call (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strupc(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Skip blanks until the first non-blank character. + @param s String to parse. + @return Pointer to char inside given string. + + This function returns a pointer to the first non-blank character in the + given string. + */ +/*--------------------------------------------------------------------------*/ +char * strskp(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Remove blanks at the end of a string. + @param s String to parse. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string, + which is identical to the input string, except that all blank + characters at the end of the string have been removed. + Do not free or modify the returned string! Since the returned string + is statically allocated, it will be modified at each function call + (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strcrop(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Remove blanks at the beginning and the end of a string. + @param s String to parse. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string, + which is identical to the input string, except that all blank + characters at the end and the beg. of the string have been removed. + Do not free or modify the returned string! Since the returned string + is statically allocated, it will be modified at each function call + (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strstrip(char * s) ; + +#endif |