719b503b8e66d8fc69fc665a94aed4cdcf11ca6e
[pspp] / src / 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., 59 Temple Place - Suite 330, Boston, MA
18    02111-1307, USA. */
19
20 #if !str_h
21 #define str_h 1
22
23 /* Headers and miscellaneous. */
24
25 #include <stdarg.h>
26 #include <stdio.h>
27
28 #if STDC_HEADERS
29   #include <string.h>
30 #else
31   #ifndef HAVE_STRCHR 
32     #define strchr index
33     #define strrchr rindex
34   #endif
35
36   char *strchr (), *strrchr ();
37 #endif
38
39 #if !HAVE_STRTOK_R
40   char *strtok_r (char *, const char *, char **);
41 #endif
42
43 #if !HAVE_STPCPY && !__linux__
44   char *stpcpy (char *dest, const char *src);
45 #endif
46
47 #if !HAVE_STRCASECMP
48   int strcasecmp (const char *s1, const char *s2);
49 #endif
50
51 #if !HAVE_STRNCASECMP
52   int strncasecmp (const char *s1, const char *s2, size_t n);
53 #endif
54
55 #if !HAVE_MEMMEM
56   void *memmem (const void *haystack, size_t haystack_len,
57                 const void *needle, size_t needle_len);
58 #endif
59 \f
60 /* sprintf() wrapper functions for convenience. */
61
62 /* spprintf() calls sprintf() and returns the address of the null
63    terminator in the resulting string.  It should be portable the way
64    it's been implemented. */
65 #if __GNUC__
66   #if HAVE_GOOD_SPRINTF
67     #define spprintf(BUF, FORMAT, ARGS...)                      \
68             ((BUF) + sprintf ((BUF), (FORMAT) , ## ARGS))
69   #else
70     #define spprintf(BUF, FORMAT, ARGS...)              \
71             ({ sprintf ((BUF), (FORMAT) , ## ARGS);     \
72                strchr ((BUF), 0); })
73   #endif
74 #else /* Not GNU C. */
75   char *spprintf (char *buf, const char *format, ...);
76 #endif /* Not GNU C. */
77
78 /* nsprintf() calls sprintf() and returns the strlen() of the
79    resulting string.  It should be portable the way it's been
80    implemented. */
81 #if __GNUC__
82   #if HAVE_GOOD_SPRINTF
83     #define nsprintf(BUF, FORMAT, ARGS...)              \
84             (sprintf ((BUF), (FORMAT) , ## ARGS))
85     #define nvsprintf(BUF, FORMAT, ARGS)                \
86             (vsprintf ((BUF), (FORMAT), (ARGS)))
87   #else /* Not good sprintf(). */
88     #define nsprintf(BUF, FORMAT, ARGS...)              \
89             ({                                          \
90               char *pbuf = BUF;                         \
91               sprintf ((pbuf), (FORMAT) , ## ARGS);     \
92               strlen (pbuf);                            \
93             })
94     #define nvsprintf(BUF, FORMAT, ARGS)                \
95             ({                                          \
96               char *pbuf = BUF;                         \
97               vsprintf ((pbuf), (FORMAT), (ARGS));      \
98               strlen (pbuf);                            \
99             })
100   #endif /* Not good sprintf(). */
101 #else /* Not GNU C. */
102   #if HAVE_GOOD_SPRINTF
103     #define nsprintf sprintf
104     #define nvsprintf vsprintf
105   #else /* Not good sprintf(). */
106     int nsprintf (char *buf, const char *format, ...);
107     int nvsprintf (char *buf, const char *format, va_list args);
108   #endif /* Not good sprintf(). */
109 #endif /* Not GNU C. */
110
111 #if !HAVE_GETLINE
112 long getline (char **lineptr, size_t *n, FILE *stream);
113 #endif
114
115 #if !HAVE_GETDELIM
116 long getdelim (char **lineptr, size_t * n, int delimiter, FILE * stream);
117 #endif
118 \f
119 /* Miscellaneous. */
120
121 void mm_reverse (void *, size_t);
122 char *mm_find_reverse (const char *, size_t, const char *, size_t);
123
124 int st_compare_pad (const char *, int, const char *, int);
125 char *st_spaces (int);
126 void st_bare_pad_copy (char *dest, const char *src, size_t n);
127 void st_bare_pad_len_copy (char *dest, const char *src, size_t n, size_t len);
128 void st_pad_copy (char *dest, const char *src, size_t n);
129 \f
130 /* Lengthed strings. */
131 struct len_string 
132   {
133     char *string;
134     size_t length;
135   };
136
137 struct pool;
138 void ls_create (struct pool *, struct len_string *, const char *);
139 void ls_create_buffer (struct pool *, struct len_string *,
140                        const char *, size_t len);
141 void ls_init (struct len_string *, const char *, size_t);
142 void ls_shallow_copy (struct len_string *, const struct len_string *);
143 void ls_destroy (struct pool *, struct len_string *);
144
145 void ls_null (struct len_string *);
146 int ls_null_p (const struct len_string *);
147 int ls_empty_p (const struct len_string *);
148
149 size_t ls_length (const struct len_string *);
150 char *ls_value (const struct len_string *);
151 char *ls_end (const struct len_string *);
152 \f
153 /* Dynamic strings. */
154
155 struct string
156   {
157     struct pool *pool;
158     size_t length;
159     size_t size;
160     char *string;
161   };
162
163 void ds_create (struct pool *, struct string *, const char *);
164 void ds_init (struct pool *, struct string *, size_t size);
165 void ds_replace (struct string *, const char *);
166 void ds_destroy (struct string *);
167 void ds_clear (struct string *);
168 void ds_extend (struct string *, size_t min_size);
169 void ds_shrink (struct string *);
170 void ds_truncate (struct string *, size_t length);
171
172 size_t ds_length (const struct string *);
173 char *ds_value (const struct string *);
174 char *ds_end (const struct string *);
175 size_t ds_size (const struct string *);
176
177 struct file_locator;
178 int ds_getline (struct string *st, FILE *stream);
179 int ds_get_config_line (FILE *, struct string *, struct file_locator *);
180 void ds_putchar (struct string *, int ch);
181 void ds_concat (struct string *, const char *);
182 void ds_concat_buffer (struct string *, const char *buf, size_t len);
183 void ds_printf (struct string *, const char *, ...)
184      PRINTF_FORMAT (2, 3);
185
186 #if __GNUC__ > 1
187 extern inline void
188 ds_putchar (struct string *st, int ch)
189 {
190   if (st->length == st->size)
191     ds_extend (st, st->length + 1);
192   st->string[st->length++] = ch;
193 }
194
195 extern inline size_t
196 ds_length (const struct string *st)
197 {
198   return st->length;
199 }
200
201 extern inline char *
202 ds_value (const struct string *st)
203 {
204   ((char *) st->string)[st->length] = '\0';
205   return st->string;
206 }
207
208 extern inline char *
209 ds_end (const struct string *st)
210 {
211   return st->string + st->length;
212 }
213 #endif
214
215 #endif /* str_h */