Flush the journal after every write.
[pspp] / 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 <stdint.h>
24 #include <stdio.h>
25 #include <string.h>
26
27 #include "compiler.h"
28 #include "memcasecmp.h"
29 #include "xstrndup.h"
30 #include "xvasprintf.h"
31 \f
32 /* Miscellaneous. */
33
34 void buf_reverse (char *, size_t);
35 char *buf_find_reverse (const char *, size_t, const 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 char *spprintf (char *dst, const char *format, ...);
53
54 void *mempset (void *, int, size_t);
55 \f
56 /* Common character classes for use with substring and string functions. */
57
58 #define CC_SPACES " \t\v\r\n"
59 #define CC_DIGITS "0123456789"
60 #define CC_XDIGITS "0123456789abcdefABCDEF"
61 #define CC_LETTERS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
62 #define CC_ALNUM CC_LETTERS CC_DIGITS
63 \f
64 /* Substrings. */
65 struct substring
66   {
67     char *string;
68     size_t length;
69   };
70
71 #define SS_EMPTY_INITIALIZER {NULL, 0}
72 #define SS_LITERAL_INITIALIZER(LITERAL)                 \
73         {(char *) LITERAL, (sizeof LITERAL) - 1}
74
75 /* Constructors.
76    These functions do not allocate any memory, so the substrings
77    they create should not normally be destroyed. */
78 struct substring ss_empty (void);
79 struct substring ss_cstr (const char *);
80 struct substring ss_buffer (const char *, size_t);
81 struct substring ss_substr (struct substring, size_t start, size_t);
82 struct substring ss_head (struct substring, size_t);
83 struct substring ss_tail (struct substring, size_t);
84
85 /* Constructors and destructor that allocate and deallocate
86    memory. */
87 struct pool;
88 void ss_alloc_substring (struct substring *, struct substring);
89 void ss_alloc_uninit (struct substring *, size_t);
90 void ss_alloc_substring_pool (struct substring *, struct substring,
91                               struct pool *);
92 void ss_alloc_uninit_pool (struct substring *, size_t, struct pool *);
93 void ss_dealloc (struct substring *);
94
95 /* Mutators.
96    Functions that advance the beginning of a string should not be
97    used if a substring is to be deallocated. */
98 void ss_truncate (struct substring *, size_t);
99 size_t ss_rtrim (struct substring *, struct substring trim_set);
100 size_t ss_ltrim (struct substring *, struct substring trim_set);
101 void ss_trim (struct substring *, struct substring trim_set);
102 bool ss_chomp (struct substring *, char);
103 bool ss_separate (struct substring src, struct substring delimiters,
104                   size_t *save_idx, struct substring *token);
105 bool ss_tokenize (struct substring src, struct substring delimiters,
106                   size_t *save_idx, struct substring *token);
107 void ss_advance (struct substring *, size_t);
108 bool ss_match_char (struct substring *, char);
109 int ss_match_char_in (struct substring *, struct substring);
110 bool ss_match_string (struct substring *, const struct substring);
111 int ss_get_char (struct substring *);
112 size_t ss_get_chars (struct substring *, size_t cnt, struct substring *);
113 bool ss_get_until (struct substring *, char delimiter, struct substring *);
114 size_t ss_get_long (struct substring *, long *);
115
116 /* Inspectors. */
117 bool ss_is_empty (struct substring);
118 size_t ss_length (struct substring);
119 char *ss_data (struct substring);
120 char *ss_end (struct substring);
121 int ss_at (struct substring, size_t idx);
122 int ss_first (struct substring);
123 int ss_last (struct substring);
124 size_t ss_span (struct substring, struct substring skip_set);
125 size_t ss_cspan (struct substring, struct substring stop_set);
126 size_t ss_find_char (struct substring, char);
127 int ss_compare (struct substring, struct substring);
128 int ss_compare_case (struct substring, struct substring);
129 int ss_equals (struct substring, struct substring);
130 int ss_equals_case (struct substring, struct substring);
131 size_t ss_pointer_to_position (struct substring, const char *);
132 char *ss_xstrdup (struct substring);
133 \f
134 /* Variable length strings. */
135
136 struct string
137   {
138     struct substring ss;
139
140     size_t capacity;    /* Allocated capacity, not including one
141                            extra byte allocated for null terminator. */
142   };
143
144 #define DS_EMPTY_INITIALIZER {SS_EMPTY_INITIALIZER, 0}
145
146 /* Constructors, destructors. */
147 void ds_init_empty (struct string *);
148 void ds_init_string (struct string *, const struct string *);
149 void ds_init_substring (struct string *, struct substring);
150 void ds_init_cstr (struct string *, const char *);
151 void ds_destroy (struct string *);
152 void ds_swap (struct string *, struct string *);
153
154 /* Pools. */
155 struct pool;
156 void ds_register_pool (struct string *, struct pool *);
157 void ds_unregister_pool (struct string *, struct pool *);
158
159 /* Replacement. */
160 void ds_assign_string (struct string *, const struct string *);
161 void ds_assign_substring (struct string *, struct substring);
162 void ds_assign_cstr (struct string *, const char *);
163
164 /* Shrink, extend. */
165 void ds_clear (struct string *);
166 void ds_extend (struct string *, size_t);
167 void ds_shrink (struct string *);
168 void ds_truncate (struct string *, size_t);
169
170 /* Padding, trimming. */
171 size_t ds_rtrim (struct string *, struct substring trim_set);
172 size_t ds_ltrim (struct string *, struct substring trim_set);
173 size_t ds_trim (struct string *, struct substring trim_set);
174 bool ds_chomp (struct string *, char);
175 bool ds_separate (const struct string *src, struct substring delimiters,
176                   size_t *save_idx, struct substring *token);
177 bool ds_tokenize (const struct string *src, struct substring delimiters,
178                   size_t *save_idx, struct substring *token);
179 void ds_rpad (struct string *, size_t length, char pad);
180 void ds_set_length (struct string *, size_t new_length, char pad);
181 void ds_remove (struct string *, size_t start, size_t n);
182
183 /* Extracting substrings. */
184 struct substring ds_ss (const struct string *);
185 struct substring ds_substr (const struct string *, size_t start, size_t);
186 struct substring ds_head (const struct string *, size_t);
187 struct substring ds_tail (const struct string *, size_t);
188
189 /* Inspectors. */
190 bool ds_is_empty (const struct string *);
191 size_t ds_length (const struct string *);
192 char *ds_data (const struct string *);
193 char *ds_end (const struct string *);
194 int ds_at (const struct string *, size_t idx);
195 int ds_first (const struct string *);
196 int ds_last (const struct string *);
197 size_t ds_span (const struct string *, struct substring skip_set);
198 size_t ds_cspan (const struct string *, struct substring stop_set);
199 size_t ds_find_char (const struct string *, char);
200 int ds_compare (const struct string *, const struct string *);
201 size_t ds_pointer_to_position (const struct string *, const char *);
202 char *ds_xstrdup (const struct string *);
203
204 size_t ds_capacity (const struct string *);
205 char *ds_cstr (const struct string *);
206 char *ds_steal_cstr (struct string *);
207
208 /* File input. */
209 bool ds_read_line (struct string *, FILE *, size_t max_length);
210 bool ds_read_config_line (struct string *, int *line_number, FILE *);
211 bool ds_read_stream (struct string *, size_t size, size_t cnt, FILE *stream);
212
213 /* Append. */
214 void ds_put_char (struct string *, int ch);
215 void ds_put_char_multiple (struct string *, int ch, size_t);
216 void ds_put_cstr (struct string *, const char *);
217 void ds_put_substring (struct string *, struct substring);
218 void ds_put_vformat (struct string *st, const char *, va_list)
219      PRINTF_FORMAT (2, 0);
220 void ds_put_format (struct string *, const char *, ...)
221      PRINTF_FORMAT (2, 3);
222 char *ds_put_uninit (struct string *st, size_t incr);
223
224 /* Other */
225 /* calls relocate from gnulib on ST */
226 void ds_relocate (struct string *st);
227
228
229 void u8_buf_copy_rpad (uint8_t *dst, size_t dst_size,
230                        const uint8_t *src, size_t src_size,
231                        char pad);
232
233
234 #endif /* str_h */