src/str.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18    02110-1301, USA. */
  19
  20 #if !str_h
  21 #define str_h 1
  22
  23 /* Headers and miscellaneous. */
  24
  25 #include <stdarg.h>
  26 #include <stdio.h>
  27
  28 #if STDC_HEADERS
  29   #include <string.h>
  30 #else
  31   #ifndef HAVE_STRCHR
  32     #define strchr index
  33     #define strrchr rindex
  34   #endif
  35
  36   char *strchr (), *strrchr ();
  37 #endif
  38
  39 #if !HAVE_STRTOK_R
  40   char *strtok_r (char *, const char *, char **);
  41 #endif
  42
  43 #if !HAVE_STPCPY
  44   char *stpcpy (char *dest, const char *src);
  45 #endif
  46
  47 #if !HAVE_STRCASECMP
  48   int strcasecmp (const char *s1, const char *s2);
  49 #endif
  50
  51 #if !HAVE_STRNCASECMP
  52   int strncasecmp (const char *s1, const char *s2, size_t n);
  53 #endif
  54
  55 #if !HAVE_MEMMEM
  56   void *memmem (const void *haystack, size_t haystack_len,
  57                 const void *needle, size_t needle_len);
  58 #endif
  59 \f
  60 /* sprintf() wrapper functions for convenience. */
  61
  62 /* spprintf() calls sprintf() and returns the address of the null
  63    terminator in the resulting string.  It should be portable the way
  64    it's been implemented. */
  65 #if __GNUC__
  66   #if HAVE_GOOD_SPRINTF
  67     #define spprintf(BUF, FORMAT, ARGS...)                      \
  68             ((BUF) + sprintf ((BUF), (FORMAT) , ## ARGS))
  69   #else
  70     #define spprintf(BUF, FORMAT, ARGS...)              \
  71             ({ sprintf ((BUF), (FORMAT) , ## ARGS);     \
  72                strchr ((BUF), 0); })
  73   #endif
  74 #else /* Not GNU C. */
  75   char *spprintf (char *buf, const char *format, ...);
  76 #endif /* Not GNU C. */
  77
  78 /* nsprintf() calls sprintf() and returns the strlen() of the
  79    resulting string.  It should be portable the way it's been
  80    implemented. */
  81 #if __GNUC__
  82   #if HAVE_GOOD_SPRINTF
  83     #define nsprintf(BUF, FORMAT, ARGS...)              \
  84             (sprintf ((BUF), (FORMAT) , ## ARGS))
  85     #define nvsprintf(BUF, FORMAT, ARGS)                \
  86             (vsprintf ((BUF), (FORMAT), (ARGS)))
  87   #else /* Not good sprintf(). */
  88     #define nsprintf(BUF, FORMAT, ARGS...)              \
  89             ({                                          \
  90               char *pbuf = BUF;                         \
  91               sprintf ((pbuf), (FORMAT) , ## ARGS);     \
  92               strlen (pbuf);                            \
  93             })
  94     #define nvsprintf(BUF, FORMAT, ARGS)                \
  95             ({                                          \
  96               char *pbuf = BUF;                         \
  97               vsprintf ((pbuf), (FORMAT), (ARGS));      \
  98               strlen (pbuf);                            \
  99             })
 100   #endif /* Not good sprintf(). */
 101 #else /* Not GNU C. */
 102   #if HAVE_GOOD_SPRINTF
 103     #define nsprintf sprintf
 104     #define nvsprintf vsprintf
 105   #else /* Not good sprintf(). */
 106     int nsprintf (char *buf, const char *format, ...);
 107     int nvsprintf (char *buf, const char *format, va_list args);
 108   #endif /* Not good sprintf(). */
 109 #endif /* Not GNU C. */
 110
 111 #if !HAVE_GETLINE
 112 long getline (char **lineptr, size_t *n, FILE *stream);
 113 #endif
 114
 115 #if !HAVE_GETDELIM
 116 long getdelim (char **lineptr, size_t * n, int delimiter, FILE * stream);
 117 #endif
 118 \f
 119 /* Miscellaneous. */
 120
 121 void mm_reverse (void *, size_t);
 122 char *mm_find_reverse (const char *, size_t, const char *, size_t);
 123
 124 int st_compare_pad (const char *, size_t, const char *, size_t);
 125 char *st_spaces (int);
 126 void st_bare_pad_copy (char *dest, const char *src, size_t n);
 127 void st_bare_pad_len_copy (char *dest, const char *src, size_t n, size_t len);
 128 void st_pad_copy (char *dest, const char *src, size_t n);
 129 void st_trim_copy (char *dest, const char *src, size_t n);
 130 void st_uppercase (char *);
 131 \f
 132 /* Fixed-length strings. */
 133 struct fixed_string
 134   {
 135     char *string;
 136     size_t length;
 137   };
 138
 139 void ls_create (struct fixed_string *, const char *);
 140 void ls_create_buffer (struct fixed_string *,
 141                        const char *, size_t len);
 142 void ls_init (struct fixed_string *, const char *, size_t);
 143 void ls_shallow_copy (struct fixed_string *, const struct fixed_string *);
 144 void ls_destroy (struct fixed_string *);
 145
 146 void ls_null (struct fixed_string *);
 147 int ls_null_p (const struct fixed_string *);
 148 int ls_empty_p (const struct fixed_string *);
 149
 150 size_t ls_length (const struct fixed_string *);
 151 char *ls_c_str (const struct fixed_string *);
 152 char *ls_end (const struct fixed_string *);
 153
 154 #if __GNUC__ > 1
 155 extern inline size_t
 156 ls_length (const struct fixed_string *st)
 157 {
 158   return st->length;
 159 }
 160
 161 extern inline char *
 162 ls_c_str (const struct fixed_string *st)
 163 {
 164   return st->string;
 165 }
 166
 167 extern inline char *
 168 ls_end (const struct fixed_string *st)
 169 {
 170   return st->string + st->length;
 171 }
 172 #endif
 173 \f
 174 /* Variable length strings. */
 175
 176 struct string
 177   {
 178     size_t length;      /* Length, not including a null terminator. */
 179     size_t capacity;    /* Allocated capacity, not including one
 180                            extra byte allocated for null terminator. */
 181     char *string;       /* String data, not necessarily null
 182                            terminated. */
 183   };
 184
 185 /* Constructors, destructors. */
 186 void ds_create (struct string *, const char *);
 187 void ds_init (struct string *, size_t);
 188 void ds_destroy (struct string *);
 189
 190 /* Copy, shrink, extend. */
 191 void ds_replace (struct string *, const char *);
 192 void ds_clear (struct string *);
 193 void ds_extend (struct string *, size_t);
 194 void ds_shrink (struct string *);
 195 void ds_truncate (struct string *, size_t);
 196 void ds_rpad (struct string *, size_t length, char pad);
 197
 198 /* Inspectors. */
 199 size_t ds_length (const struct string *);
 200 char *ds_c_str (const struct string *);
 201 char *ds_data (const struct string *);
 202 char *ds_end (const struct string *);
 203 size_t ds_capacity (const struct string *);
 204
 205 /* File input. */
 206 struct file_locator;
 207 int ds_gets (struct string *, FILE *);
 208 int ds_get_config_line (FILE *, struct string *, struct file_locator *);
 209
 210 /* Append. */
 211 void ds_putc (struct string *, int ch);
 212 void ds_puts (struct string *, const char *);
 213 void ds_concat (struct string *, const char *, size_t);
 214 void ds_vprintf (struct string *st, const char *, va_list);
 215 void ds_printf (struct string *, const char *, ...)
 216      PRINTF_FORMAT (2, 3);
 217
 218 #if __GNUC__ > 1
 219 extern inline void
 220 ds_putc (struct string *st, int ch)
 221 {
 222   if (st->length == st->capacity)
 223     ds_extend (st, st->length + 1);
 224   st->string[st->length++] = ch;
 225 }
 226
 227 extern inline size_t
 228 ds_length (const struct string *st)
 229 {
 230   return st->length;
 231 }
 232
 233 extern inline char *
 234 ds_c_str (const struct string *st)
 235 {
 236   ((char *) st->string)[st->length] = '\0';
 237   return st->string;
 238 }
 239
 240 extern inline char *
 241 ds_data (const struct string *st)
 242 {
 243   return st->string;
 244 }
 245
 246 extern inline char *
 247 ds_end (const struct string *st)
 248 {
 249   return st->string + st->length;
 250 }
 251 #endif
 252
 253 #endif /* str_h */