src/libpspp/str.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #if !str_h
  18 #define str_h 1
  19
  20 #include <assert.h>
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <stdio.h>
  24 #include <string.h>
  25
  26 #include "compiler.h"
  27 #include "memcasecmp.h"
  28 #include "xstrndup.h"
  29 #include "xvasprintf.h"
  30 \f
  31 /* Miscellaneous. */
  32
  33 void buf_reverse (char *, size_t);
  34 char *buf_find_reverse (const char *, size_t, const char *, size_t);
  35 int buf_compare_case (const char *, const char *, size_t);
  36 int buf_compare_rpad (const char *, size_t, const char *, size_t);
  37 void buf_copy_lpad (char *, size_t, const char *, size_t, char pad);
  38 void buf_copy_rpad (char *, size_t, const char *, size_t, char pad);
  39 void buf_copy_str_lpad (char *, size_t, const char *, char pad);
  40 void buf_copy_str_rpad (char *, size_t, const char *, char pad);
  41
  42 int str_compare_rpad (const char *, const char *);
  43 void str_copy_rpad (char *, size_t, const char *);
  44 void str_copy_trunc (char *, size_t, const char *);
  45 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
  46 void str_uppercase (char *);
  47 void str_lowercase (char *);
  48
  49 bool str_format_26adic (unsigned long int number, char buffer[], size_t);
  50
  51 char *spprintf (char *dst, const char *format, ...);
  52
  53 void *mempset (void *, int, size_t);
  54 \f
  55 /* Common character classes for use with substring and string functions. */
  56
  57 #define CC_SPACES " \t\v\r\n"
  58 #define CC_DIGITS "0123456789"
  59 #define CC_XDIGITS "0123456789abcdefABCDEF"
  60 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
  61 #define CC_ALNUM CC_LETTERS CC_DIGITS
  62 \f
  63 /* Substrings. */
  64 struct substring
  65   {
  66     char *string;
  67     size_t length;
  68   };
  69
  70 #define SS_EMPTY_INITIALIZER {NULL, 0}
  71 #define SS_LITERAL_INITIALIZER(LITERAL)                 \
  72         {(char *) LITERAL, (sizeof LITERAL) - 1}
  73
  74 /* Constructors.
  75    These functions do not allocate any memory, so the substrings
  76    they create should not normally be destroyed. */
  77 struct substring ss_empty (void);
  78 struct substring ss_cstr (const char *);
  79 struct substring ss_buffer (const char *, size_t);
  80 struct substring ss_substr (struct substring, size_t start, size_t);
  81 struct substring ss_head (struct substring, size_t);
  82 struct substring ss_tail (struct substring, size_t);
  83
  84 /* Constructors and destructor that allocate and deallocate
  85    memory. */
  86 struct pool;
  87 void ss_alloc_substring (struct substring *, struct substring);
  88 void ss_alloc_uninit (struct substring *, size_t);
  89 void ss_alloc_substring_pool (struct substring *, struct substring,
  90                               struct pool *);
  91 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
  92 void ss_dealloc (struct substring *);
  93
  94 /* Mutators.
  95    Functions that advance the beginning of a string should not be
  96    used if a substring is to be deallocated. */
  97 void ss_truncate (struct substring *, size_t);
  98 size_t ss_rtrim (struct substring *, struct substring trim_set);
  99 size_t ss_ltrim (struct substring *, struct substring trim_set);
 100 void ss_trim (struct substring *, struct substring trim_set);
 101 bool ss_chomp (struct substring *, char);
 102 bool ss_separate (struct substring src, struct substring delimiters,
 103                   size_t *save_idx, struct substring *token);
 104 bool ss_tokenize (struct substring src, struct substring delimiters,
 105                   size_t *save_idx, struct substring *token);
 106 void ss_advance (struct substring *, size_t);
 107 bool ss_match_char (struct substring *, char);
 108 int ss_match_char_in (struct substring *, struct substring);
 109 bool ss_match_string (struct substring *, const struct substring);
 110 int ss_get_char (struct substring *);
 111 size_t ss_get_chars (struct substring *, size_t cnt, struct substring *);
 112 bool ss_get_until (struct substring *, char delimiter, struct substring *);
 113 size_t ss_get_long (struct substring *, long *);
 114
 115 /* Inspectors. */
 116 bool ss_is_empty (struct substring);
 117 size_t ss_length (struct substring);
 118 char *ss_data (struct substring);
 119 char *ss_end (struct substring);
 120 int ss_at (struct substring, size_t idx);
 121 int ss_first (struct substring);
 122 int ss_last (struct substring);
 123 size_t ss_span (struct substring, struct substring skip_set);
 124 size_t ss_cspan (struct substring, struct substring stop_set);
 125 size_t ss_find_char (struct substring, char);
 126 int ss_compare (struct substring, struct substring);
 127 int ss_compare_case (struct substring, struct substring);
 128 int ss_equals (struct substring, struct substring);
 129 int ss_equals_case (struct substring, struct substring);
 130 size_t ss_pointer_to_position (struct substring, const char *);
 131 char *ss_xstrdup (struct substring);
 132 \f
 133 /* Variable length strings. */
 134
 135 struct string
 136   {
 137     struct substring ss;
 138
 139     size_t capacity;    /* Allocated capacity, not including one
 140                            extra byte allocated for null terminator. */
 141   };
 142
 143 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
 144
 145 /* Constructors, destructors. */
 146 void ds_init_empty (struct string *);
 147 void ds_init_string (struct string *, const struct string *);
 148 void ds_init_substring (struct string *, struct substring);
 149 void ds_init_cstr (struct string *, const char *);
 150 void ds_destroy (struct string *);
 151 void ds_swap (struct string *, struct string *);
 152
 153 /* Pools. */
 154 struct pool;
 155 void ds_register_pool (struct string *, struct pool *);
 156 void ds_unregister_pool (struct string *, struct pool *);
 157
 158 /* Replacement. */
 159 void ds_assign_string (struct string *, const struct string *);
 160 void ds_assign_substring (struct string *, struct substring);
 161 void ds_assign_cstr (struct string *, const char *);
 162
 163 /* Shrink, extend. */
 164 void ds_clear (struct string *);
 165 void ds_extend (struct string *, size_t);
 166 void ds_shrink (struct string *);
 167 void ds_truncate (struct string *, size_t);
 168
 169 /* Padding, trimming. */
 170 size_t ds_rtrim (struct string *, struct substring trim_set);
 171 size_t ds_ltrim (struct string *, struct substring trim_set);
 172 size_t ds_trim (struct string *, struct substring trim_set);
 173 bool ds_chomp (struct string *, char);
 174 bool ds_separate (const struct string *src, struct substring delimiters,
 175                   size_t *save_idx, struct substring *token);
 176 bool ds_tokenize (const struct string *src, struct substring delimiters,
 177                   size_t *save_idx, struct substring *token);
 178 void ds_rpad (struct string *, size_t length, char pad);
 179 void ds_set_length (struct string *, size_t new_length, char pad);
 180 void ds_remove (struct string *, size_t start, size_t n);
 181
 182 /* Extracting substrings. */
 183 struct substring ds_ss (const struct string *);
 184 struct substring ds_substr (const struct string *, size_t start, size_t);
 185 struct substring ds_head (const struct string *, size_t);
 186 struct substring ds_tail (const struct string *, size_t);
 187
 188 /* Inspectors. */
 189 bool ds_is_empty (const struct string *);
 190 size_t ds_length (const struct string *);
 191 char *ds_data (const struct string *);
 192 char *ds_end (const struct string *);
 193 int ds_at (const struct string *, size_t idx);
 194 int ds_first (const struct string *);
 195 int ds_last (const struct string *);
 196 size_t ds_span (const struct string *, struct substring skip_set);
 197 size_t ds_cspan (const struct string *, struct substring stop_set);
 198 size_t ds_find_char (const struct string *, char);
 199 int ds_compare (const struct string *, const struct string *);
 200 size_t ds_pointer_to_position (const struct string *, const char *);
 201 char *ds_xstrdup (const struct string *);
 202
 203 size_t ds_capacity (const struct string *);
 204 char *ds_cstr (const struct string *);
 205
 206 /* File input. */
 207 bool ds_read_line (struct string *, FILE *, size_t max_length);
 208 bool ds_read_config_line (struct string *, int *line_number, FILE *);
 209 bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
 210
 211 /* Append. */
 212 void ds_put_char (struct string *, int ch);
 213 void ds_put_char_multiple (struct string *, int ch, size_t);
 214 void ds_put_cstr (struct string *, const char *);
 215 void ds_put_substring (struct string *, struct substring);
 216 void ds_put_vformat (struct string *st, const char *, va_list)
 217      PRINTF_FORMAT (2, 0);
 218 void ds_put_format (struct string *, const char *, ...)
 219      PRINTF_FORMAT (2, 3);
 220 char *ds_put_uninit (struct string *st, size_t incr);
 221
 222 /* Other */
 223 /* calls relocate from gnulib on ST */
 224 void ds_relocate (struct string *st);
 225
 226 #endif /* str_h */