tagmanager/vstring.h

   1 /*
   2 *   Copyright (c) 1998-2002, Darren Hiebert
   3 *
   4 *   This source code is released for free distribution under the terms of the
   5 *   GNU General Public License.
   6 *
   7 *   Provides the external interface for resizeable strings.
   8 */
   9 #ifndef _VSTRING_H
  10 #define _VSTRING_H
  11
  12 /*
  13 *   INCLUDE FILES
  14 */
  15 #include "general.h"    /* must always come first */
  16
  17 #if defined(HAVE_STDLIB_H)
  18 # include <stdlib.h>    /* to define size_t */
  19 #endif
  20
  21 /*
  22 *   MACROS
  23 */
  24 #ifndef DEBUG
  25 # define VSTRING_PUTC_MACRO 1
  26 #endif
  27 #ifdef VSTRING_PUTC_MACRO
  28 #define vStringPut(s,c) \
  29         (void)(((s)->length + 1 == (s)->size ? vStringAutoResize (s) : 0), \
  30         ((s)->buffer [(s)->length] = (c)), \
  31         ((c) == '\0' ? 0 : ((s)->buffer [++(s)->length] = '\0')))
  32 #endif
  33
  34 #define vStringValue(vs)        ((vs)->buffer)
  35 #define vStringItem(vs,i)       ((vs)->buffer[i])
  36 #define vStringLength(vs)       ((vs)->length)
  37 #define vStringSize(vs)         ((vs)->size)
  38 #define vStringCat(vs,s)        vStringCatS((vs), vStringValue((s)))
  39 #define vStringNCat(vs,s,l)     vStringNCatS((vs), vStringValue((s)), (l))
  40 #define vStringCopy(vs,s)       vStringCopyS((vs), vStringValue((s)))
  41 #define vStringNCopy(vs,s,l)    vStringNCopyS((vs), vStringValue((s)), (l))
  42 #define vStringChar(vs,i)       ((vs)->buffer[i])
  43 #define vStringTerminate(vs)    vStringPut(vs, '\0')
  44 #define vStringLower(vs)        toLowerString((vs)->buffer)
  45 #define vStringUpper(vs)        toUpperString((vs)->buffer)
  46
  47 /*
  48 *   DATA DECLARATIONS
  49 */
  50
  51 typedef struct sVString {
  52     size_t      length;         /* size of buffer used */
  53     size_t      size;           /* allocated size of buffer */
  54     char *      buffer;         /* location of buffer */
  55 } vString;
  56
  57 /*
  58 *   FUNCTION PROTOTYPES
  59 */
  60 extern boolean vStringAutoResize (vString *const string);
  61 extern void vStringClear (vString *const string);
  62 extern vString *vStringNew (void);
  63 extern void vStringDelete (vString *const string);
  64 #ifndef VSTRING_PUTC_MACRO
  65 extern void vStringPut (vString *const string, const int c);
  66 #endif
  67 extern void vStringStripNewline (vString *const string);
  68 extern void vStringStripLeading (vString *const string);
  69 extern void vStringChop (vString *const string);
  70 extern void vStringStripTrailing (vString *const string);
  71 extern void vStringCatS (vString *const string, const char *const s);
  72 extern void vStringNCatS (vString *const string, const char *const s, const size_t length);
  73 extern vString *vStringNewCopy (const vString *const string);
  74 extern vString *vStringNewInit (const char *const s);
  75 extern void vStringCopyS (vString *const string, const char *const s);
  76 extern void vStringNCopyS (vString *const string, const char *const s, const size_t length);
  77 extern void vStringCopyToLower (vString *const dest, const vString *const src);
  78 extern void vStringSetLength (vString *const string);
  79
  80 #endif  /* _VSTRING_H */
  81
  82 /* vi:set tabstop=4 shiftwidth=4: */