43891c17e99185ce3311d593082270a057649cc2
[pspp-builds.git] / 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 \f
41 /* Miscellaneous. */
42
43 void buf_reverse (char *, size_t);
44 char *buf_find_reverse (const char *, size_t, const char *, size_t);
45 int buf_compare_case (const char *, const char *, size_t);
46 int buf_compare_rpad (const char *, size_t, const char *, size_t);
47 void buf_copy_lpad (char *, size_t, const char *, size_t);
48 void buf_copy_rpad (char *, size_t, const char *, size_t);
49 void buf_copy_str_lpad (char *, size_t, const char *);
50 void buf_copy_str_rpad (char *, size_t, const char *);
51
52 int str_compare_rpad (const char *, const char *);
53 void str_copy_rpad (char *, size_t, const char *);
54 void str_copy_trunc (char *, size_t, const char *);
55 void str_copy_buf_trunc (char *, size_t, const char *, size_t);
56 void str_uppercase (char *);
57 void str_lowercase (char *);
58
59 char *spprintf (char *dst, const char *format, ...);
60
61 void *mempset (void *, int, size_t);
62 \f
63 /* Common character classes for use with substring and string functions. */
64
65 #define CC_SPACES " \t\v\r\n"
66 #define CC_DIGITS "0123456789"
67 #define CC_XDIGITS "0123456789abcdefABCDEF"
68 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
69 #define CC_ALNUM CC_LETTERS CC_DIGITS
70 \f
71 /* Substrings. */
72 struct substring 
73   {
74     char *string;
75     size_t length;
76   };
77
78 #define SS_EMPTY_INITIALIZER {NULL, 0}
79 #define SS_LITERAL_INITIALIZER(LITERAL)                 \
80         {(char *) LITERAL, (sizeof LITERAL) - 1}
81
82 /* Constructors.
83    These functions do not allocate any memory, so the substrings
84    they create should not normally be destroyed. */
85 struct substring ss_empty (void);
86 struct substring ss_cstr (const char *);
87 struct substring ss_buffer (const char *, size_t);
88 struct substring ss_substr (struct substring, size_t start, size_t);
89 struct substring ss_head (struct substring, size_t);
90 struct substring ss_tail (struct substring, size_t);
91
92 /* Constructors and destructor that allocate and deallocate
93    memory. */
94 struct pool;
95 void ss_alloc_substring (struct substring *, struct substring);
96 void ss_alloc_uninit (struct substring *, size_t);
97 void ss_alloc_substring_pool (struct substring *, struct substring,
98                               struct pool *);
99 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
100 void ss_dealloc (struct substring *);
101
102 /* Mutators.
103    Functions that advance the beginning of a string should not be
104    used if a substring is to be deallocated. */
105 void ss_truncate (struct substring *, size_t);
106 size_t ss_rtrim (struct substring *, struct substring trim_set);
107 size_t ss_ltrim (struct substring *, struct substring trim_set);
108 void ss_trim (struct substring *, struct substring trim_set);
109 bool ss_chomp (struct substring *, char);
110 bool ss_separate (struct substring src, struct substring delimiters,
111                   size_t *save_idx, struct substring *token);
112 bool ss_tokenize (struct substring src, struct substring delimiters,
113                   size_t *save_idx, struct substring *token);
114 void ss_advance (struct substring *, size_t);
115 bool ss_match_char (struct substring *, char);
116 bool ss_match_string (struct substring *, const struct substring);
117 int ss_get_char (struct substring *);
118 size_t ss_get_chars (struct substring *, size_t cnt, struct substring *);
119 bool ss_get_until (struct substring *, char delimiter, struct substring *);
120 size_t ss_get_long (struct substring *, long *);
121
122 /* Inspectors. */
123 bool ss_is_empty (struct substring);
124 size_t ss_length (struct substring);
125 char *ss_data (struct substring);
126 char *ss_end (struct substring);
127 int ss_at (struct substring, size_t idx);
128 int ss_first (struct substring);
129 int ss_last (struct substring);
130 size_t ss_span (struct substring, struct substring skip_set);
131 size_t ss_cspan (struct substring, struct substring stop_set);
132 size_t ss_find_char (struct substring, char);
133 int ss_compare (struct substring, struct substring);
134 int ss_compare_case (struct substring, struct substring);
135 int ss_equals (struct substring, struct substring);
136 int ss_equals_case (struct substring, struct substring);
137 size_t ss_pointer_to_position (struct substring, const char *);
138 char *ss_xstrdup (struct substring);
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 (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
188 /* Extracting substrings. */
189 struct substring ds_ss (const struct string *);
190 struct substring ds_substr (const struct string *, size_t start, size_t);
191 struct substring ds_head (const struct string *, size_t);
192 struct substring ds_tail (const struct string *, size_t);
193
194 /* Inspectors. */
195 bool ds_is_empty (const struct string *);
196 size_t ds_length (const struct string *);
197 char *ds_data (const struct string *);
198 char *ds_end (const struct string *);
199 int ds_at (const struct string *, size_t idx);
200 int ds_first (const struct string *);
201 int ds_last (const struct string *);
202 size_t ds_span (const struct string *, struct substring skip_set);
203 size_t ds_cspan (const struct string *, struct substring stop_set);
204 size_t ds_find_char (const struct string *, char);
205 int ds_compare (const struct string *, const struct string *);
206 size_t ds_pointer_to_position (const struct string *, const char *);
207 char *ds_xstrdup (const struct string *);
208
209 size_t ds_capacity (const struct string *);
210 char *ds_cstr (const struct string *);
211
212 /* File input. */
213 bool ds_read_line (struct string *, FILE *);
214 bool ds_read_config_line (struct string *, int *line_number, FILE *);
215 size_t ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
216
217 /* Append. */
218 void ds_put_char (struct string *, int ch);
219 void ds_put_char_multiple (struct string *, int ch, size_t);
220 void ds_put_cstr (struct string *, const char *);
221 void ds_put_substring (struct string *, struct substring);
222 void ds_put_vformat (struct string *st, const char *, va_list)
223      PRINTF_FORMAT (2, 0);
224 void ds_put_format (struct string *, const char *, ...)
225      PRINTF_FORMAT (2, 3);
226 char *ds_put_uninit (struct string *st, size_t incr);
227
228 #endif /* str_h */