source3/iniparser/src/strlib.h

   1
   2 /*-------------------------------------------------------------------------*/
   3 /**
   4   @file     strlib.h
   5   @author   N. Devillard
   6   @date     Jan 2001
   7   @version  $Revision: 1.4 $
   8   @brief    Various string handling routines to complement the C lib.
   9
  10   This modules adds a few complementary string routines usually missing
  11   in the standard C library.
  12 */
  13 /*--------------------------------------------------------------------------*/
  14
  15 /*
  16         $Id: strlib.h,v 1.4 2006-09-27 11:04:11 ndevilla Exp $
  17         $Author: ndevilla $
  18         $Date: 2006-09-27 11:04:11 $
  19         $Revision: 1.4 $
  20 */
  21
  22 #ifndef _STRLIB_H_
  23 #define _STRLIB_H_
  24
  25 /*---------------------------------------------------------------------------
  26                                                                 Includes
  27  ---------------------------------------------------------------------------*/
  28
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31
  32 /*---------------------------------------------------------------------------
  33                                                         Function codes
  34  ---------------------------------------------------------------------------*/
  35
  36 /*-------------------------------------------------------------------------*/
  37 /**
  38   @brief    Convert a string to lowercase.
  39   @param    s   String to convert.
  40   @return   ptr to statically allocated string.
  41
  42   This function returns a pointer to a statically allocated string
  43   containing a lowercased version of the input string. Do not free
  44   or modify the returned string! Since the returned string is statically
  45   allocated, it will be modified at each function call (not re-entrant).
  46  */
  47 /*--------------------------------------------------------------------------*/
  48 char * strlwc(const char * s);
  49
  50 /*-------------------------------------------------------------------------*/
  51 /**
  52   @brief    Convert a string to uppercase.
  53   @param    s   String to convert.
  54   @return   ptr to statically allocated string.
  55
  56   This function returns a pointer to a statically allocated string
  57   containing an uppercased version of the input string. Do not free
  58   or modify the returned string! Since the returned string is statically
  59   allocated, it will be modified at each function call (not re-entrant).
  60  */
  61 /*--------------------------------------------------------------------------*/
  62 char * strupc(char * s);
  63
  64 /*-------------------------------------------------------------------------*/
  65 /**
  66   @brief    Skip blanks until the first non-blank character.
  67   @param    s   String to parse.
  68   @return   Pointer to char inside given string.
  69
  70   This function returns a pointer to the first non-blank character in the
  71   given string.
  72  */
  73 /*--------------------------------------------------------------------------*/
  74 char * strskp(char * s);
  75
  76 /*-------------------------------------------------------------------------*/
  77 /**
  78   @brief    Remove blanks at the end of a string.
  79   @param    s   String to parse.
  80   @return   ptr to statically allocated string.
  81
  82   This function returns a pointer to a statically allocated string,
  83   which is identical to the input string, except that all blank
  84   characters at the end of the string have been removed.
  85   Do not free or modify the returned string! Since the returned string
  86   is statically allocated, it will be modified at each function call
  87   (not re-entrant).
  88  */
  89 /*--------------------------------------------------------------------------*/
  90 char * strcrop(char * s);
  91
  92 /*-------------------------------------------------------------------------*/
  93 /**
  94   @brief    Remove blanks at the beginning and the end of a string.
  95   @param    s   String to parse.
  96   @return   ptr to statically allocated string.
  97
  98   This function returns a pointer to a statically allocated string,
  99   which is identical to the input string, except that all blank
 100   characters at the end and the beg. of the string have been removed.
 101   Do not free or modify the returned string! Since the returned string
 102   is statically allocated, it will be modified at each function call
 103   (not re-entrant).
 104  */
 105 /*--------------------------------------------------------------------------*/
 106 char * strstrip(char * s) ;
 107
 108 #endif