src/libpspp/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 #include <assert.h>
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28
  29 #include "compiler.h"
  30 #include "memcasecmp.h"
  31 #include "memmem.h"
  32 #include "snprintf.h"
  33 #include "stpcpy.h"
  34 #include "strcase.h"
  35 #include "strftime.h"
  36 #include "strstr.h"
  37 #include "strtok_r.h"
  38 #include "vsnprintf.h"
  39 #include "xvasprintf.h"
  40
  41 #ifndef HAVE_STRCHR
  42 #define strchr index
  43 #endif
  44 #ifndef HAVE_STRRCHR
  45 #define strrchr rindex
  46 #endif
  47 \f
  48 /* Miscellaneous. */
  49
  50 void buf_reverse (char *, size_t);
  51 char *buf_find_reverse (const char *, size_t, const char *, size_t);
  52 int buf_compare_case (const char *, const char *, size_t);
  53 int buf_compare_rpad (const char *, size_t, const char *, size_t);
  54 void buf_copy_rpad (char *, size_t, const char *, size_t);
  55 void buf_copy_str_lpad (char *, size_t, const char *);
  56 void buf_copy_str_rpad (char *, size_t, const char *);
  57
  58 int str_compare_rpad (const char *, const char *);
  59 void str_copy_rpad (char *, size_t, const char *);
  60 void str_copy_trunc (char *, size_t, const char *);
  61 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
  62 void str_uppercase (char *);
  63 void str_lowercase (char *);
  64
  65 char *spprintf (char *dst, const char *format, ...);
  66 \f
  67 /* Fixed-length strings. */
  68 struct fixed_string
  69   {
  70     char *string;
  71     size_t length;
  72   };
  73
  74 void ls_create (struct fixed_string *, const char *);
  75 void ls_create_buffer (struct fixed_string *,
  76                        const char *, size_t len);
  77 void ls_init (struct fixed_string *, const char *, size_t);
  78 void ls_shallow_copy (struct fixed_string *, const struct fixed_string *);
  79 void ls_destroy (struct fixed_string *);
  80
  81 void ls_null (struct fixed_string *);
  82 int ls_null_p (const struct fixed_string *);
  83 int ls_empty_p (const struct fixed_string *);
  84
  85 size_t ls_length (const struct fixed_string *);
  86 char *ls_c_str (const struct fixed_string *);
  87 char *ls_end (const struct fixed_string *);
  88
  89 #if __GNUC__ > 1
  90 extern inline size_t
  91 ls_length (const struct fixed_string *st)
  92 {
  93   return st->length;
  94 }
  95
  96 extern inline char *
  97 ls_c_str (const struct fixed_string *st)
  98 {
  99   return st->string;
 100 }
 101
 102 extern inline char *
 103 ls_end (const struct fixed_string *st)
 104 {
 105   return st->string + st->length;
 106 }
 107 #endif
 108 \f
 109 /* Variable length strings. */
 110
 111 struct string
 112   {
 113     char *string;       /* String data, not necessarily null terminated. */
 114     size_t length;      /* Length, not including a null terminator. */
 115     size_t capacity;    /* Allocated capacity, not including one
 116                            extra byte allocated for null terminator. */
 117   };
 118
 119 #define DS_INITIALIZER {NULL, 0, 0}
 120
 121 /* Constructors, destructors. */
 122 void ds_init (struct string *);
 123 void ds_init_substring (struct string *,
 124                         const struct string *src, size_t start, size_t cnt);
 125 void ds_create (struct string *, const char *);
 126 void ds_destroy (struct string *);
 127 void ds_swap (struct string *, struct string *);
 128
 129 /* Replacement. */
 130 void ds_assign_string (struct string *, const struct string *);
 131 void ds_assign_substring (struct string *,
 132                           const struct string *, size_t start, size_t cnt);
 133 void ds_assign_buffer (struct string *, const char *, size_t);
 134 void ds_assign_c_str (struct string *, const char *);
 135
 136 /* Shrink, extend. */
 137 void ds_clear (struct string *);
 138 void ds_extend (struct string *, size_t);
 139 void ds_shrink (struct string *);
 140 void ds_truncate (struct string *, size_t);
 141
 142 /* Padding, trimming. */
 143 void ds_rpad (struct string *, size_t length, char pad);
 144 int ds_rtrim_spaces (struct string *);
 145 int ds_ltrim_spaces (struct string *);
 146 void ds_trim_spaces (struct string *);
 147 bool ds_chomp (struct string *, char);
 148 bool ds_separate (const struct string *src, struct string *token,
 149                   const char *delimiters, size_t *save_idx);
 150 bool ds_tokenize (const struct string *src, struct string *token,
 151                   const char *delimiters, size_t *save_idx);
 152
 153 /* Inspectors. */
 154 bool ds_is_empty (const struct string *);
 155 size_t ds_length (const struct string *);
 156 char *ds_c_str (const struct string *);
 157 char *ds_data (const struct string *);
 158 char *ds_end (const struct string *);
 159 size_t ds_capacity (const struct string *);
 160 int ds_at (const struct string *, size_t idx);
 161 int ds_first (const struct string *);
 162 int ds_last (const struct string *);
 163 size_t ds_span (const struct string *st, size_t ofs, const char skip_set[]);
 164 size_t ds_cspan (const struct string *st, size_t ofs, const char stop_set[]);
 165
 166 /* File input. */
 167 bool ds_gets (struct string *, FILE *);
 168 bool ds_get_config_line (FILE *, struct string *, int *line_number);
 169
 170 /* Append. */
 171 void ds_putc (struct string *, int ch);
 172 void ds_putc_multiple (struct string *, int ch, size_t);
 173 void ds_puts (struct string *, const char *);
 174 void ds_concat (struct string *, const char *, size_t);
 175 void ds_vprintf (struct string *st, const char *, va_list);
 176 void ds_printf (struct string *, const char *, ...)
 177      PRINTF_FORMAT (2, 3);
 178 char *ds_append_uninit (struct string *st, size_t incr);
 179
 180 #if __GNUC__ > 1
 181 extern inline void
 182 ds_putc (struct string *st, int ch)
 183 {
 184   if (st->length == st->capacity)
 185     ds_extend (st, st->length + 1);
 186   st->string[st->length++] = ch;
 187 }
 188
 189 extern inline size_t
 190 ds_length (const struct string *st)
 191 {
 192   return st->length;
 193 }
 194
 195 extern inline char *
 196 ds_data (const struct string *st)
 197 {
 198   return st->string;
 199 }
 200
 201 extern inline char *
 202 ds_end (const struct string *st)
 203 {
 204   return st->string + st->length;
 205 }
 206 #endif
 207
 208 #endif /* str_h */