contrib/libarchive/libarchive/archive_string.h

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