pintos-os.org Git - pspp/blob - src/libpspp/str.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2009, 2010, 2011, 2012, 2014 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
  33 #include "gl/xalloc.h"
  34 \f
  35 /* Miscellaneous. */
  36
  37 void buf_reverse (char *, size_t);
  38 int buf_compare_case (const char *, const char *, size_t);
  39 int buf_compare_rpad (const char *, size_t, const char *, size_t);
  40 void buf_copy_lpad (char *, size_t, const char *, size_t, char pad);
  41 void buf_copy_rpad (char *, size_t, const char *, size_t, char pad);
  42 void buf_copy_str_lpad (char *, size_t, const char *, char pad);
  43 void buf_copy_str_rpad (char *, size_t, const char *, char pad);
  44
  45 int str_compare_rpad (const char *, const char *);
  46 void str_copy_rpad (char *, size_t, const char *);
  47 void str_copy_trunc (char *, size_t, const char *);
  48 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
  49 void str_uppercase (char *);
  50 void str_lowercase (char *);
  51
  52 bool str_format_26adic (unsigned long int number, bool uppercase,
  53                         char buffer[], size_t);
  54
  55 static inline char *xstrdup_if_nonnull (const char *);
  56
  57 void *mempset (void *, int, size_t);
  58 \f
  59 /* Common character classes for use with substring and string functions. */
  60
  61 #define CC_SPACES " \t\v\r\n"
  62 #define CC_DIGITS "0123456789"
  63 #define CC_XDIGITS "0123456789abcdefABCDEF"
  64 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
  65 #define CC_ALNUM CC_LETTERS CC_DIGITS
  66 \f
  67 /* Substrings. */
  68 struct substring
  69   {
  70     char *string;
  71     size_t length;
  72   };
  73
  74 #define SS_EMPTY_INITIALIZER {NULL, 0}
  75 #define SS_LITERAL_INITIALIZER(LITERAL)                 \
  76         {(char *) LITERAL, (sizeof LITERAL) - 1}
  77
  78 /* Constructors.
  79    These functions do not allocate any memory, so the substrings
  80    they create should not normally be destroyed. */
  81 static inline struct substring ss_empty (void);
  82 static inline struct substring ss_cstr (const char *);
  83 static inline struct substring ss_buffer (const char *, size_t);
  84 struct substring ss_substr (struct substring, size_t start, size_t);
  85 struct substring ss_head (struct substring, size_t);
  86 struct substring ss_tail (struct substring, size_t);
  87
  88 /* Constructors and destructor that allocate and deallocate
  89    memory. */
  90 struct pool;
  91 void ss_alloc_substring (struct substring *, struct substring);
  92 void ss_alloc_uninit (struct substring *, size_t);
  93 void ss_realloc (struct substring *, size_t);
  94 void ss_alloc_substring_pool (struct substring *, struct substring,
  95                               struct pool *);
  96 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
  97 void ss_dealloc (struct substring *);
  98
  99 /* Mutators.
 100    Functions that advance the beginning of a string should not be
 101    used if a substring is to be deallocated. */
 102 void ss_truncate (struct substring *, size_t);
 103 size_t ss_rtrim (struct substring *, struct substring trim_set);
 104 size_t ss_ltrim (struct substring *, struct substring trim_set);
 105 void ss_trim (struct substring *, struct substring trim_set);
 106 bool ss_chomp_byte (struct substring *, char);
 107 bool ss_chomp (struct substring *, struct substring);
 108 bool ss_separate (struct substring src, struct substring delimiters,
 109                   size_t *save_idx, struct substring *token);
 110 bool ss_tokenize (struct substring src, struct substring delimiters,
 111                   size_t *save_idx, struct substring *token);
 112 void ss_advance (struct substring *, size_t);
 113 bool ss_match_byte (struct substring *, char);
 114 int ss_match_byte_in (struct substring *, struct substring);
 115 bool ss_match_string (struct substring *, const struct substring);
 116 int ss_get_byte (struct substring *);
 117 size_t ss_get_bytes (struct substring *, size_t cnt, struct substring *);
 118 bool ss_get_until (struct substring *, char delimiter, struct substring *);
 119 size_t ss_get_long (struct substring *, long *);
 120
 121 /* Inspectors. */
 122 bool ss_is_empty (struct substring);
 123 size_t ss_length (struct substring);
 124 char *ss_data (struct substring);
 125 char *ss_end (struct substring);
 126 int ss_at (struct substring, size_t idx);
 127 int ss_first (struct substring);
 128 int ss_last (struct substring);
 129 bool ss_starts_with (struct substring, struct substring prefix);
 130 bool ss_ends_with (struct substring, struct substring suffix);
 131 size_t ss_span (struct substring, struct substring skip_set);
 132 size_t ss_cspan (struct substring, struct substring stop_set);
 133 size_t ss_find_byte (struct substring, char);
 134 size_t ss_find_substring (struct substring, struct substring);
 135 int ss_compare (struct substring, struct substring);
 136 int ss_compare_case (struct substring, struct substring);
 137 int ss_equals (struct substring, struct substring);
 138 int ss_equals_case (struct substring, struct substring);
 139 size_t ss_pointer_to_position (struct substring, const char *);
 140 char *ss_xstrdup (struct substring);
 141
 142 /* UTF-8. */
 143 ucs4_t ss_first_mb (struct substring);
 144 int ss_first_mblen (struct substring);
 145 ucs4_t ss_get_mb (struct substring *);
 146 ucs4_t ss_at_mb (struct substring, size_t ofs);
 147 int ss_at_mblen (struct substring, size_t ofs);
 148 \f
 149 /* Variable length strings. */
 150
 151 struct string
 152   {
 153     struct substring ss;
 154
 155     size_t capacity;    /* Allocated capacity, not including one
 156                            extra byte allocated for null terminator. */
 157   };
 158
 159 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
 160
 161 /* Constructors, destructors. */
 162 void ds_init_empty (struct string *);
 163 void ds_init_string (struct string *, const struct string *);
 164 void ds_init_substring (struct string *, struct substring);
 165 void ds_init_cstr (struct string *, const char *);
 166 void ds_destroy (struct string *);
 167 void ds_swap (struct string *, struct string *);
 168
 169 /* Pools. */
 170 struct pool;
 171 void ds_register_pool (struct string *, struct pool *);
 172 void ds_unregister_pool (struct string *, struct pool *);
 173
 174 /* Replacement. */
 175 void ds_assign_string (struct string *, const struct string *);
 176 void ds_assign_substring (struct string *, struct substring);
 177 void ds_assign_cstr (struct string *, const char *);
 178
 179 /* Shrink, extend. */
 180 void ds_clear (struct string *);
 181 void ds_extend (struct string *, size_t);
 182 void ds_shrink (struct string *);
 183 void ds_truncate (struct string *, size_t);
 184
 185 /* Padding, trimming. */
 186 size_t ds_rtrim (struct string *, struct substring trim_set);
 187 size_t ds_ltrim (struct string *, struct substring trim_set);
 188 size_t ds_trim (struct string *, struct substring trim_set);
 189 bool ds_chomp_byte (struct string *, char);
 190 bool ds_chomp (struct string *, struct substring);
 191 bool ds_separate (const struct string *src, struct substring delimiters,
 192                   size_t *save_idx, struct substring *token);
 193 bool ds_tokenize (const struct string *src, struct substring delimiters,
 194                   size_t *save_idx, struct substring *token);
 195 void ds_rpad (struct string *, size_t length, char pad);
 196 void ds_set_length (struct string *, size_t new_length, char pad);
 197 void ds_remove (struct string *, size_t start, size_t n);
 198
 199 /* Extracting substrings. */
 200 struct substring ds_ss (const struct string *);
 201 struct substring ds_substr (const struct string *, size_t start, size_t);
 202 struct substring ds_head (const struct string *, size_t);
 203 struct substring ds_tail (const struct string *, size_t);
 204
 205 /* Inspectors. */
 206 bool ds_is_empty (const struct string *);
 207 size_t ds_length (const struct string *);
 208 char *ds_data (const struct string *);
 209 char *ds_end (const struct string *);
 210 int ds_at (const struct string *, size_t idx);
 211 int ds_first (const struct string *);
 212 int ds_last (const struct string *);
 213 bool ds_ends_with (const struct string *, struct substring suffix);
 214 size_t ds_span (const struct string *, struct substring skip_set);
 215 size_t ds_cspan (const struct string *, struct substring stop_set);
 216 size_t ds_find_byte (const struct string *, char);
 217 int ds_compare (const struct string *, const struct string *);
 218 size_t ds_pointer_to_position (const struct string *, const char *);
 219 char *ds_xstrdup (const struct string *);
 220
 221 size_t ds_capacity (const struct string *);
 222 char *ds_cstr (const struct string *);
 223 char *ds_steal_cstr (struct string *);
 224
 225 /* File input. */
 226 bool ds_read_line (struct string *, FILE *, size_t max_length);
 227 bool ds_read_config_line (struct string *, int *line_number, FILE *);
 228 bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
 229
 230 /* Append. */
 231 void ds_put_byte (struct string *, int ch);
 232 void ds_put_byte_multiple (struct string *, int ch, size_t);
 233 void ds_put_unichar (struct string *, ucs4_t uc);
 234 void ds_put_cstr (struct string *, const char *);
 235 void ds_put_substring (struct string *, struct substring);
 236 void ds_put_vformat (struct string *st, const char *, va_list)
 237      PRINTF_FORMAT (2, 0);
 238 void ds_put_c_vformat (struct string *st, const char *, va_list)
 239      PRINTF_FORMAT (2, 0);
 240
 241 void ds_put_format (struct string *, const char *, ...)
 242      PRINTF_FORMAT (2, 3);
 243 void ds_put_c_format (struct string *, const char *, ...)
 244      PRINTF_FORMAT (2, 3);
 245
 246 char *ds_put_uninit (struct string *st, size_t incr);
 247
 248 char *ds_splice_uninit (struct string *, size_t ofs, size_t old_len,
 249                         size_t new_len);
 250
 251 /* Other */
 252 /* calls relocate from gnulib on ST */
 253 void ds_relocate (struct string *st);
 254
 255
 256 void u8_buf_copy_rpad (uint8_t *dst, size_t dst_size,
 257                        const uint8_t *src, size_t src_size,
 258                        char pad);
 259 \f
 260 static inline struct substring
 261 ss_empty (void)
 262 {
 263   struct substring ss;
 264   ss.string = NULL;
 265   ss.length = 0;
 266   return ss;
 267 }
 268
 269 /* Returns a substring whose contents are the given C-style
 270    string CSTR. */
 271 static inline struct substring
 272 ss_cstr (const char *cstr)
 273 {
 274   return ss_buffer (cstr, strlen (cstr));
 275 }
 276
 277 /* Returns a substring whose contents are the CNT characters in
 278    BUFFER. */
 279 static inline struct substring
 280 ss_buffer (const char *buffer, size_t cnt)
 281 {
 282   struct substring ss;
 283   ss.string = (char *) buffer;
 284   ss.length = cnt;
 285   return ss;
 286 }
 287
 288 static inline char *
 289 xstrdup_if_nonnull (const char *s)
 290 {
 291   return s ? xstrdup (s) : NULL;
 292 }
 293
 294 #endif /* str_h */