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_write_private.h 201155 2009-12-29 05:20:12Z kientzle $ 26 */ 27 28 #ifndef __LIBARCHIVE_BUILD 29 #error This header is only to be used internally to libarchive. 30 #endif 31 32 #ifndef ARCHIVE_WRITE_PRIVATE_H_INCLUDED 33 #define ARCHIVE_WRITE_PRIVATE_H_INCLUDED 34 35 #include "archive.h" 36 #include "archive_string.h" 37 #include "archive_private.h" 38 39 struct archive_write; 40 41 struct archive_write_filter { 42 int64_t bytes_written; 43 struct archive *archive; /* Associated archive. */ 44 struct archive_write_filter *next_filter; /* Who I write to. */ 45 int (*options)(struct archive_write_filter *, 46 const char *key, const char *value); 47 int (*open)(struct archive_write_filter *); 48 int (*write)(struct archive_write_filter *, const void *, size_t); 49 int (*close)(struct archive_write_filter *); 50 int (*free)(struct archive_write_filter *); 51 void *data; 52 const char *name; 53 int code; 54 int bytes_per_block; 55 int bytes_in_last_block; 56 }; 57 58 #if ARCHIVE_VERSION < 4000000 59 void __archive_write_filters_free(struct archive *); 60 #endif 61 62 struct archive_write_filter *__archive_write_allocate_filter(struct archive *); 63 64 int __archive_write_output(struct archive_write *, const void *, size_t); 65 int __archive_write_nulls(struct archive_write *, size_t); 66 int __archive_write_filter(struct archive_write_filter *, const void *, size_t); 67 int __archive_write_open_filter(struct archive_write_filter *); 68 int __archive_write_close_filter(struct archive_write_filter *); 69 70 struct archive_write { 71 struct archive archive; 72 73 /* Dev/ino of the archive being written. */ 74 int skip_file_set; 75 dev_t skip_file_dev; 76 int64_t skip_file_ino; 77 78 /* Utility: Pointer to a block of nulls. */ 79 const unsigned char *nulls; 80 size_t null_length; 81 82 /* Callbacks to open/read/write/close archive stream. */ 83 archive_open_callback *client_opener; 84 archive_write_callback *client_writer; 85 archive_close_callback *client_closer; 86 void *client_data; 87 88 /* 89 * Blocking information. Note that bytes_in_last_block is 90 * misleadingly named; I should find a better name. These 91 * control the final output from all compressors, including 92 * compression_none. 93 */ 94 int bytes_per_block; 95 int bytes_in_last_block; 96 97 /* 98 * First and last write filters in the pipeline. 99 */ 100 struct archive_write_filter *filter_first; 101 struct archive_write_filter *filter_last; 102 103 /* 104 * Pointers to format-specific functions for writing. They're 105 * initialized by archive_write_set_format_XXX() calls. 106 */ 107 void *format_data; 108 const char *format_name; 109 int (*format_init)(struct archive_write *); 110 int (*format_options)(struct archive_write *, 111 const char *key, const char *value); 112 int (*format_finish_entry)(struct archive_write *); 113 int (*format_write_header)(struct archive_write *, 114 struct archive_entry *); 115 ssize_t (*format_write_data)(struct archive_write *, 116 const void *buff, size_t); 117 int (*format_close)(struct archive_write *); 118 int (*format_free)(struct archive_write *); 119 }; 120 121 /* 122 * Utility function to format a USTAR header into a buffer. If 123 * "strict" is set, this tries to create the absolutely most portable 124 * version of a ustar header. If "strict" is set to 0, then it will 125 * relax certain requirements. 126 * 127 * Generally, format-specific declarations don't belong in this 128 * header; this is a rare example of a function that is shared by 129 * two very similar formats (ustar and pax). 130 */ 131 int 132 __archive_write_format_header_ustar(struct archive_write *, char buff[512], 133 struct archive_entry *, int tartype, int strict, 134 struct archive_string_conv *); 135 136 #endif 137