2 * Copyright (c) 2003-2010 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 * $FreeBSD: head/lib/libarchive/archive_string.h 201092 2009-12-28 02:26:06Z kientzle $
29 #ifndef ARCHIVE_STRING_H_INCLUDED
30 #define ARCHIVE_STRING_H_INCLUDED
32 #ifndef __LIBARCHIVE_BUILD
33 #ifndef __LIBARCHIVE_TEST
34 #error This header is only to be used internally to libarchive.
40 #include <stdlib.h> /* required for wchar_t on some systems */
52 * Basic resizable/reusable string support similar to Java's "StringBuffer."
54 * Unlike sbuf(9), the buffers here are fully reusable and track the
58 struct archive_string {
59 char *s; /* Pointer to the storage */
60 size_t length; /* Length of 's' in characters */
61 size_t buffer_length; /* Length of malloc-ed storage in bytes. */
64 struct archive_wstring {
65 wchar_t *s; /* Pointer to the storage */
66 size_t length; /* Length of 's' in characters */
67 size_t buffer_length; /* Length of malloc-ed storage in bytes. */
70 struct archive_string_conv;
72 /* Initialize an archive_string object on the stack or elsewhere. */
73 #define archive_string_init(a) \
74 do { (a)->s = NULL; (a)->length = 0; (a)->buffer_length = 0; } while(0)
76 /* Append a C char to an archive_string, resizing as necessary. */
77 struct archive_string *
78 archive_strappend_char(struct archive_string *, char);
80 /* Ditto for a wchar_t and an archive_wstring. */
81 struct archive_wstring *
82 archive_wstrappend_wchar(struct archive_wstring *, wchar_t);
84 /* Append a raw array to an archive_string, resizing as necessary */
85 struct archive_string *
86 archive_array_append(struct archive_string *, const char *, size_t);
88 /* Convert a Unicode string to current locale and append the result. */
89 /* Returns -1 if conversion fails. */
91 archive_string_append_from_wcs(struct archive_string *, const wchar_t *, size_t);
94 /* Create a string conversion object.
95 * Return NULL and set a error message if the conversion is not supported
97 struct archive_string_conv *
98 archive_string_conversion_to_charset(struct archive *, const char *, int);
99 struct archive_string_conv *
100 archive_string_conversion_from_charset(struct archive *, const char *, int);
101 /* Create the default string conversion object for reading/writing an archive.
102 * Return NULL if the conversion is unneeded.
103 * Note: On non Windows platform this always returns NULL.
105 struct archive_string_conv *
106 archive_string_default_conversion_for_read(struct archive *);
107 struct archive_string_conv *
108 archive_string_default_conversion_for_write(struct archive *);
109 /* Dispose of a string conversion object. */
111 archive_string_conversion_free(struct archive *);
113 archive_string_conversion_charset_name(struct archive_string_conv *);
115 archive_string_conversion_set_opt(struct archive_string_conv *, int);
116 #define SCONV_SET_OPT_UTF8_LIBARCHIVE2X 1
117 #define SCONV_SET_OPT_NORMALIZATION_C 2
118 #define SCONV_SET_OPT_NORMALIZATION_D 4
121 /* Copy one archive_string to another in locale conversion.
122 * Return -1 if conversion fails. */
124 archive_strncpy_l(struct archive_string *, const void *, size_t,
125 struct archive_string_conv *);
127 /* Copy one archive_string to another in locale conversion.
128 * Return -1 if conversion fails. */
130 archive_strncat_l(struct archive_string *, const void *, size_t,
131 struct archive_string_conv *);
134 /* Copy one archive_string to another */
135 #define archive_string_copy(dest, src) \
136 ((dest)->length = 0, archive_string_concat((dest), (src)))
137 #define archive_wstring_copy(dest, src) \
138 ((dest)->length = 0, archive_wstring_concat((dest), (src)))
140 /* Concatenate one archive_string to another */
141 void archive_string_concat(struct archive_string *dest, struct archive_string *src);
142 void archive_wstring_concat(struct archive_wstring *dest, struct archive_wstring *src);
144 /* Ensure that the underlying buffer is at least as large as the request. */
145 struct archive_string *
146 archive_string_ensure(struct archive_string *, size_t);
147 struct archive_wstring *
148 archive_wstring_ensure(struct archive_wstring *, size_t);
150 /* Append C string, which may lack trailing \0. */
151 /* The source is declared void * here because this gets used with
152 * "signed char *", "unsigned char *" and "char *" arguments.
153 * Declaring it "char *" as with some of the other functions just
154 * leads to a lot of extra casts. */
155 struct archive_string *
156 archive_strncat(struct archive_string *, const void *, size_t);
157 struct archive_wstring *
158 archive_wstrncat(struct archive_wstring *, const wchar_t *, size_t);
160 /* Append a C string to an archive_string, resizing as necessary. */
161 struct archive_string *
162 archive_strcat(struct archive_string *, const void *);
163 struct archive_wstring *
164 archive_wstrcat(struct archive_wstring *, const wchar_t *);
166 /* Copy a C string to an archive_string, resizing as necessary. */
167 #define archive_strcpy(as,p) \
168 archive_strncpy((as), (p), ((p) == NULL ? 0 : strlen(p)))
169 #define archive_wstrcpy(as,p) \
170 archive_wstrncpy((as), (p), ((p) == NULL ? 0 : wcslen(p)))
171 #define archive_strcpy_l(as,p,lo) \
172 archive_strncpy_l((as), (p), ((p) == NULL ? 0 : strlen(p)), (lo))
174 /* Copy a C string to an archive_string with limit, resizing as necessary. */
175 #define archive_strncpy(as,p,l) \
176 ((as)->length=0, archive_strncat((as), (p), (l)))
177 #define archive_wstrncpy(as,p,l) \
178 ((as)->length = 0, archive_wstrncat((as), (p), (l)))
180 /* Return length of string. */
181 #define archive_strlen(a) ((a)->length)
183 /* Set string length to zero. */
184 #define archive_string_empty(a) ((a)->length = 0)
185 #define archive_wstring_empty(a) ((a)->length = 0)
187 /* Release any allocated storage resources. */
188 void archive_string_free(struct archive_string *);
189 void archive_wstring_free(struct archive_wstring *);
191 /* Like 'vsprintf', but resizes the underlying string as necessary. */
192 /* Note: This only implements a small subset of standard printf functionality. */
193 void archive_string_vsprintf(struct archive_string *, const char *,
194 va_list) __LA_PRINTF(2, 0);
195 void archive_string_sprintf(struct archive_string *, const char *, ...)
198 /* Translates from MBS to Unicode. */
199 /* Returns non-zero if conversion failed in any way. */
200 int archive_wstring_append_from_mbs(struct archive_wstring *dest,
201 const char *, size_t);
204 /* A "multistring" can hold Unicode, UTF8, or MBS versions of
205 * the string. If you set and read the same version, no translation
206 * is done. If you set and read different versions, the library
207 * will attempt to transparently convert.
209 struct archive_mstring {
210 struct archive_string aes_mbs;
211 struct archive_string aes_utf8;
212 struct archive_wstring aes_wcs;
213 struct archive_string aes_mbs_in_locale;
214 /* Bitmap of which of the above are valid. Because we're lazy
215 * about malloc-ing and reusing the underlying storage, we
216 * can't rely on NULL pointers to indicate whether a string
219 #define AES_SET_MBS 1
220 #define AES_SET_UTF8 2
221 #define AES_SET_WCS 4
224 void archive_mstring_clean(struct archive_mstring *);
225 void archive_mstring_copy(struct archive_mstring *dest, struct archive_mstring *src);
226 int archive_mstring_get_mbs(struct archive *, struct archive_mstring *, const char **);
227 int archive_mstring_get_utf8(struct archive *, struct archive_mstring *, const char **);
228 int archive_mstring_get_wcs(struct archive *, struct archive_mstring *, const wchar_t **);
229 int archive_mstring_get_mbs_l(struct archive_mstring *, const char **,
230 size_t *, struct archive_string_conv *);
231 int archive_mstring_copy_mbs(struct archive_mstring *, const char *mbs);
232 int archive_mstring_copy_mbs_len(struct archive_mstring *, const char *mbs,
234 int archive_mstring_copy_utf8(struct archive_mstring *, const char *utf8);
235 int archive_mstring_copy_wcs(struct archive_mstring *, const wchar_t *wcs);
236 int archive_mstring_copy_wcs_len(struct archive_mstring *,
237 const wchar_t *wcs, size_t);
238 int archive_mstring_copy_mbs_len_l(struct archive_mstring *,
239 const char *mbs, size_t, struct archive_string_conv *);
240 int archive_mstring_update_utf8(struct archive *, struct archive_mstring *aes, const char *utf8);