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., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, 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 \f
 130 /* Lengthed strings. */
 131 struct len_string
 132   {
 133     char *string;
 134     size_t length;
 135   };
 136
 137 void ls_create (struct len_string *, const char *);
 138 void ls_create_buffer (struct len_string *,
 139                        const char *, size_t len);
 140 void ls_init (struct len_string *, const char *, size_t);
 141 void ls_shallow_copy (struct len_string *, const struct len_string *);
 142 void ls_destroy (struct len_string *);
 143
 144 void ls_null (struct len_string *);
 145 int ls_null_p (const struct len_string *);
 146 int ls_empty_p (const struct len_string *);
 147
 148 size_t ls_length (const struct len_string *);
 149 char *ls_c_str (const struct len_string *);
 150 char *ls_end (const struct len_string *);
 151
 152 #if __GNUC__ > 1
 153 extern inline size_t
 154 ls_length (const struct len_string *st)
 155 {
 156   return st->length;
 157 }
 158
 159 extern inline char *
 160 ls_c_str (const struct len_string *st)
 161 {
 162   return st->string;
 163 }
 164
 165 extern inline char *
 166 ls_end (const struct len_string *st)
 167 {
 168   return st->string + st->length;
 169 }
 170 #endif
 171 \f
 172 /* Dynamic strings. */
 173
 174 struct string
 175   {
 176     size_t length;      /* Length, not including a null terminator. */
 177     size_t capacity;    /* Allocated capacity, not including one
 178                            extra byte allocated for null terminator. */
 179     char *string;       /* String data, not necessarily null
 180                            terminated. */
 181   };
 182
 183 /* Constructors, destructors. */
 184 void ds_create (struct string *, const char *);
 185 void ds_init (struct string *, size_t);
 186 void ds_destroy (struct string *);
 187
 188 /* Copy, shrink, extend. */
 189 void ds_replace (struct string *, const char *);
 190 void ds_clear (struct string *);
 191 void ds_extend (struct string *, size_t);
 192 void ds_shrink (struct string *);
 193 void ds_truncate (struct string *, size_t);
 194 void ds_rpad (struct string *, size_t length, char pad);
 195
 196 /* Inspectors. */
 197 size_t ds_length (const struct string *);
 198 char *ds_c_str (const struct string *);
 199 char *ds_data (const struct string *);
 200 char *ds_end (const struct string *);
 201 size_t ds_capacity (const struct string *);
 202
 203 /* File input. */
 204 struct file_locator;
 205 int ds_gets (struct string *, FILE *);
 206 int ds_get_config_line (FILE *, struct string *, struct file_locator *);
 207
 208 /* Append. */
 209 void ds_putc (struct string *, int ch);
 210 void ds_puts (struct string *, const char *);
 211 void ds_concat (struct string *, const char *, size_t);
 212 void ds_vprintf (struct string *st, const char *, va_list);
 213 void ds_printf (struct string *, const char *, ...)
 214      PRINTF_FORMAT (2, 3);
 215
 216 #if __GNUC__ > 1
 217 extern inline void
 218 ds_putc (struct string *st, int ch)
 219 {
 220   if (st->length == st->capacity)
 221     ds_extend (st, st->length + 1);
 222   st->string[st->length++] = ch;
 223 }
 224
 225 extern inline size_t
 226 ds_length (const struct string *st)
 227 {
 228   return st->length;
 229 }
 230
 231 extern inline char *
 232 ds_c_str (const struct string *st)
 233 {
 234   ((char *) st->string)[st->length] = '\0';
 235   return st->string;
 236 }
 237
 238 extern inline char *
 239 ds_data (const struct string *st)
 240 {
 241   return st->string;
 242 }
 243
 244 extern inline char *
 245 ds_end (const struct string *st)
 246 {
 247   return st->string + st->length;
 248 }
 249 #endif
 250
 251 #endif /* str_h */