src/libpspp/str.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010, 2011 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 <stdint.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <unitypes.h>
  27
  28 #include "compiler.h"
  29 #include "memcasecmp.h"
  30 #include "xstrndup.h"
  31 #include "xvasprintf.h"
  32 \f
  33 /* Miscellaneous. */
  34
  35 void buf_reverse (char *, size_t);
  36 int buf_compare_case (const char *, const char *, size_t);
  37 int buf_compare_rpad (const char *, size_t, const char *, size_t);
  38 void buf_copy_lpad (char *, size_t, const char *, size_t, char pad);
  39 void buf_copy_rpad (char *, size_t, const char *, size_t, char pad);
  40 void buf_copy_str_lpad (char *, size_t, const char *, char pad);
  41 void buf_copy_str_rpad (char *, size_t, const char *, char pad);
  42
  43 int str_compare_rpad (const char *, const char *);
  44 void str_copy_rpad (char *, size_t, const char *);
  45 void str_copy_trunc (char *, size_t, const char *);
  46 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
  47 void str_uppercase (char *);
  48 void str_lowercase (char *);
  49
  50 bool str_format_26adic (unsigned long int number, char buffer[], size_t);
  51
  52 void *mempset (void *, int, size_t);
  53 \f
  54 /* Common character classes for use with substring and string functions. */
  55
  56 #define CC_SPACES " \t\v\r\n"
  57 #define CC_DIGITS "0123456789"
  58 #define CC_XDIGITS "0123456789abcdefABCDEF"
  59 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
  60 #define CC_ALNUM CC_LETTERS CC_DIGITS
  61 \f
  62 /* Substrings. */
  63 struct substring
  64   {
  65     char *string;
  66     size_t length;
  67   };
  68
  69 #define SS_EMPTY_INITIALIZER {NULL, 0}
  70 #define SS_LITERAL_INITIALIZER(LITERAL)                 \
  71         {(char *) LITERAL, (sizeof LITERAL) - 1}
  72
  73 /* Constructors.
  74    These functions do not allocate any memory, so the substrings
  75    they create should not normally be destroyed. */
  76 static inline struct substring ss_empty (void);
  77 static inline struct substring ss_cstr (const char *);
  78 static inline struct substring ss_buffer (const char *, size_t);
  79 struct substring ss_substr (struct substring, size_t start, size_t);
  80 struct substring ss_head (struct substring, size_t);
  81 struct substring ss_tail (struct substring, size_t);
  82
  83 /* Constructors and destructor that allocate and deallocate
  84    memory. */
  85 struct pool;
  86 void ss_alloc_substring (struct substring *, struct substring);
  87 void ss_alloc_uninit (struct substring *, size_t);
  88 void ss_realloc (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_byte (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_byte (struct substring *, char);
 108 int ss_match_byte_in (struct substring *, struct substring);
 109 bool ss_match_string (struct substring *, const struct substring);
 110 int ss_get_byte (struct substring *);
 111 size_t ss_get_bytes (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_byte (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
 133 /* UTF-8. */
 134 ucs4_t ss_first_mb (struct substring);
 135 int ss_first_mblen (struct substring);
 136 ucs4_t ss_get_mb (struct substring *);
 137 ucs4_t ss_at_mb (struct substring, size_t ofs);
 138 int ss_at_mblen (struct substring, size_t ofs);
 139 \f
 140 /* Variable length strings. */
 141
 142 struct string
 143   {
 144     struct substring ss;
 145
 146     size_t capacity;    /* Allocated capacity, not including one
 147                            extra byte allocated for null terminator. */
 148   };
 149
 150 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
 151
 152 /* Constructors, destructors. */
 153 void ds_init_empty (struct string *);
 154 void ds_init_string (struct string *, const struct string *);
 155 void ds_init_substring (struct string *, struct substring);
 156 void ds_init_cstr (struct string *, const char *);
 157 void ds_destroy (struct string *);
 158 void ds_swap (struct string *, struct string *);
 159
 160 /* Pools. */
 161 struct pool;
 162 void ds_register_pool (struct string *, struct pool *);
 163 void ds_unregister_pool (struct string *, struct pool *);
 164
 165 /* Replacement. */
 166 void ds_assign_string (struct string *, const struct string *);
 167 void ds_assign_substring (struct string *, struct substring);
 168 void ds_assign_cstr (struct string *, const char *);
 169
 170 /* Shrink, extend. */
 171 void ds_clear (struct string *);
 172 void ds_extend (struct string *, size_t);
 173 void ds_shrink (struct string *);
 174 void ds_truncate (struct string *, size_t);
 175
 176 /* Padding, trimming. */
 177 size_t ds_rtrim (struct string *, struct substring trim_set);
 178 size_t ds_ltrim (struct string *, struct substring trim_set);
 179 size_t ds_trim (struct string *, struct substring trim_set);
 180 bool ds_chomp_byte (struct string *, char);
 181 bool ds_separate (const struct string *src, struct substring delimiters,
 182                   size_t *save_idx, struct substring *token);
 183 bool ds_tokenize (const struct string *src, struct substring delimiters,
 184                   size_t *save_idx, struct substring *token);
 185 void ds_rpad (struct string *, size_t length, char pad);
 186 void ds_set_length (struct string *, size_t new_length, char pad);
 187 void ds_remove (struct string *, size_t start, size_t n);
 188
 189 /* Extracting substrings. */
 190 struct substring ds_ss (const struct string *);
 191 struct substring ds_substr (const struct string *, size_t start, size_t);
 192 struct substring ds_head (const struct string *, size_t);
 193 struct substring ds_tail (const struct string *, size_t);
 194
 195 /* Inspectors. */
 196 bool ds_is_empty (const struct string *);
 197 size_t ds_length (const struct string *);
 198 char *ds_data (const struct string *);
 199 char *ds_end (const struct string *);
 200 int ds_at (const struct string *, size_t idx);
 201 int ds_first (const struct string *);
 202 int ds_last (const struct string *);
 203 size_t ds_span (const struct string *, struct substring skip_set);
 204 size_t ds_cspan (const struct string *, struct substring stop_set);
 205 size_t ds_find_byte (const struct string *, char);
 206 int ds_compare (const struct string *, const struct string *);
 207 size_t ds_pointer_to_position (const struct string *, const char *);
 208 char *ds_xstrdup (const struct string *);
 209
 210 size_t ds_capacity (const struct string *);
 211 char *ds_cstr (const struct string *);
 212 char *ds_steal_cstr (struct string *);
 213
 214 /* File input. */
 215 bool ds_read_line (struct string *, FILE *, size_t max_length);
 216 bool ds_read_config_line (struct string *, int *line_number, FILE *);
 217 bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
 218
 219 /* Append. */
 220 void ds_put_byte (struct string *, int ch);
 221 void ds_put_byte_multiple (struct string *, int ch, size_t);
 222 void ds_put_cstr (struct string *, const char *);
 223 void ds_put_substring (struct string *, struct substring);
 224 void ds_put_vformat (struct string *st, const char *, va_list)
 225      PRINTF_FORMAT (2, 0);
 226 void ds_put_format (struct string *, const char *, ...)
 227      PRINTF_FORMAT (2, 3);
 228 char *ds_put_uninit (struct string *st, size_t incr);
 229
 230 /* Other */
 231 /* calls relocate from gnulib on ST */
 232 void ds_relocate (struct string *st);
 233
 234
 235 void u8_buf_copy_rpad (uint8_t *dst, size_t dst_size,
 236                        const uint8_t *src, size_t src_size,
 237                        char pad);
 238 \f
 239 struct substring
 240 ss_empty (void)
 241 {
 242   struct substring ss;
 243   ss.string = NULL;
 244   ss.length = 0;
 245   return ss;
 246 }
 247
 248 /* Returns a substring whose contents are the given C-style
 249    string CSTR. */
 250 static inline struct substring
 251 ss_cstr (const char *cstr)
 252 {
 253   return ss_buffer (cstr, strlen (cstr));
 254 }
 255
 256 /* Returns a substring whose contents are the CNT characters in
 257    BUFFER. */
 258 static inline struct substring
 259 ss_buffer (const char *buffer, size_t cnt)
 260 {
 261   struct substring ss;
 262   ss.string = (char *) buffer;
 263   ss.length = cnt;
 264   return ss;
 265 }
 266
 267 #endif /* str_h */