1 /*- 2 * Copyright (c) 2003-2007 Tim Kientzle 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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. 24 * 25 * $FreeBSD: src/lib/libarchive/archive_string.h,v 1.13 2008/12/06 05:56:43 kientzle Exp $ 26 * 27 */ 28 29 #ifndef ARCHIVE_STRING_H_INCLUDED 30 #define ARCHIVE_STRING_H_INCLUDED 31 32 #include <stdarg.h> 33 #ifdef HAVE_STDLIB_H 34 #include <stdlib.h> /* required for wchar_t on some systems */ 35 #endif 36 #ifdef HAVE_STRING_H 37 #include <string.h> 38 #endif 39 #ifdef HAVE_WCHAR_H 40 #include <wchar.h> 41 #endif 42 43 /* 44 * Basic resizable/reusable string support a la Java's "StringBuffer." 45 * 46 * Unlike sbuf(9), the buffers here are fully reusable and track the 47 * length throughout. 48 * 49 * Note that all visible symbols here begin with "__archive" as they 50 * are internal symbols not intended for anyone outside of this library 51 * to see or use. 52 */ 53 54 struct archive_string { 55 char *s; /* Pointer to the storage */ 56 size_t length; /* Length of 's' */ 57 size_t buffer_length; /* Length of malloc-ed storage */ 58 }; 59 60 /* Initialize an archive_string object on the stack or elsewhere. */ 61 #define archive_string_init(a) \ 62 do { (a)->s = NULL; (a)->length = 0; (a)->buffer_length = 0; } while(0) 63 64 /* Append a C char to an archive_string, resizing as necessary. */ 65 struct archive_string * 66 __archive_strappend_char(struct archive_string *, char); 67 #define archive_strappend_char __archive_strappend_char 68 69 /* Convert a wide-char string to UTF-8 and append the result. */ 70 struct archive_string * 71 __archive_strappend_w_utf8(struct archive_string *, const wchar_t *); 72 #define archive_strappend_w_utf8 __archive_strappend_w_utf8 73 74 /* Convert a wide-char string to current locale and append the result. */ 75 /* Returns NULL if conversion fails. */ 76 struct archive_string * 77 __archive_strappend_w_mbs(struct archive_string *, const wchar_t *); 78 #define archive_strappend_w_mbs __archive_strappend_w_mbs 79 80 /* Basic append operation. */ 81 struct archive_string * 82 __archive_string_append(struct archive_string *as, const char *p, size_t s); 83 84 /* Copy one archive_string to another */ 85 void 86 __archive_string_copy(struct archive_string *dest, struct archive_string *src); 87 #define archive_string_copy(dest, src) \ 88 __archive_string_copy(dest, src) 89 90 /* Concatenate one archive_string to another */ 91 void 92 __archive_string_concat(struct archive_string *dest, struct archive_string *src); 93 #define archive_string_concat(dest, src) \ 94 __archive_string_concat(dest, src) 95 96 /* Ensure that the underlying buffer is at least as large as the request. */ 97 struct archive_string * 98 __archive_string_ensure(struct archive_string *, size_t); 99 #define archive_string_ensure __archive_string_ensure 100 101 /* Append C string, which may lack trailing \0. */ 102 /* The source is declared void * here because this gets used with 103 * "signed char *", "unsigned char *" and "char *" arguments. 104 * Declaring it "char *" as with some of the other functions just 105 * leads to a lot of extra casts. */ 106 struct archive_string * 107 __archive_strncat(struct archive_string *, const void *, size_t); 108 #define archive_strncat __archive_strncat 109 110 /* Append a C string to an archive_string, resizing as necessary. */ 111 #define archive_strcat(as,p) __archive_string_append((as),(p),strlen(p)) 112 113 /* Copy a C string to an archive_string, resizing as necessary. */ 114 #define archive_strcpy(as,p) \ 115 ((as)->length = 0, __archive_string_append((as), (p), p == NULL ? 0 : strlen(p))) 116 117 /* Copy a C string to an archive_string with limit, resizing as necessary. */ 118 #define archive_strncpy(as,p,l) \ 119 ((as)->length=0, archive_strncat((as), (p), (l))) 120 121 /* Return length of string. */ 122 #define archive_strlen(a) ((a)->length) 123 124 /* Set string length to zero. */ 125 #define archive_string_empty(a) ((a)->length = 0) 126 127 /* Release any allocated storage resources. */ 128 void __archive_string_free(struct archive_string *); 129 #define archive_string_free __archive_string_free 130 131 /* Like 'vsprintf', but resizes the underlying string as necessary. */ 132 void __archive_string_vsprintf(struct archive_string *, const char *, 133 va_list); 134 #define archive_string_vsprintf __archive_string_vsprintf 135 136 void __archive_string_sprintf(struct archive_string *, const char *, ...); 137 #define archive_string_sprintf __archive_string_sprintf 138 139 /* Allocates a fresh buffer and converts as (assumed to be UTF-8) into it. 140 * Returns NULL if conversion failed in any way. */ 141 wchar_t *__archive_string_utf8_w(struct archive_string *as); 142 143 144 #endif 145