634fb9dd48
This implements the new generic options framework that provides a way to override format- and compression-specific parameters.
119 lines
4.1 KiB
C
119 lines
4.1 KiB
C
/*-
|
|
* Copyright (c) 2003-2007 Tim Kientzle
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef ARCHIVE_WRITE_PRIVATE_H_INCLUDED
|
|
#define ARCHIVE_WRITE_PRIVATE_H_INCLUDED
|
|
|
|
#include "archive.h"
|
|
#include "archive_string.h"
|
|
#include "archive_private.h"
|
|
|
|
struct archive_write {
|
|
struct archive archive;
|
|
|
|
/* Dev/ino of the archive being written. */
|
|
dev_t skip_file_dev;
|
|
ino_t skip_file_ino;
|
|
|
|
/* Utility: Pointer to a block of nulls. */
|
|
const unsigned char *nulls;
|
|
size_t null_length;
|
|
|
|
/* Callbacks to open/read/write/close archive stream. */
|
|
archive_open_callback *client_opener;
|
|
archive_write_callback *client_writer;
|
|
archive_close_callback *client_closer;
|
|
void *client_data;
|
|
|
|
/*
|
|
* Blocking information. Note that bytes_in_last_block is
|
|
* misleadingly named; I should find a better name. These
|
|
* control the final output from all compressors, including
|
|
* compression_none.
|
|
*/
|
|
int bytes_per_block;
|
|
int bytes_in_last_block;
|
|
|
|
/*
|
|
* These control whether data within a gzip/bzip2 compressed
|
|
* stream gets padded or not. If pad_uncompressed is set,
|
|
* the data will be padded to a full block before being
|
|
* compressed. The pad_uncompressed_byte determines the value
|
|
* that will be used for padding. Note that these have no
|
|
* effect on compression "none."
|
|
*/
|
|
int pad_uncompressed;
|
|
int pad_uncompressed_byte; /* TODO: Support this. */
|
|
|
|
/*
|
|
* On write, the client just invokes an archive_write_set function
|
|
* which sets up the data here directly.
|
|
*/
|
|
struct {
|
|
void *data;
|
|
void *config;
|
|
int (*init)(struct archive_write *);
|
|
int (*options)(struct archive_write *,
|
|
const char *key, const char *value);
|
|
int (*finish)(struct archive_write *);
|
|
int (*write)(struct archive_write *, const void *, size_t);
|
|
} compressor;
|
|
|
|
/*
|
|
* Pointers to format-specific functions for writing. They're
|
|
* initialized by archive_write_set_format_XXX() calls.
|
|
*/
|
|
void *format_data;
|
|
const char *format_name;
|
|
int (*format_init)(struct archive_write *);
|
|
int (*format_options)(struct archive_write *,
|
|
const char *key, const char *value);
|
|
int (*format_finish)(struct archive_write *);
|
|
int (*format_destroy)(struct archive_write *);
|
|
int (*format_finish_entry)(struct archive_write *);
|
|
int (*format_write_header)(struct archive_write *,
|
|
struct archive_entry *);
|
|
ssize_t (*format_write_data)(struct archive_write *,
|
|
const void *buff, size_t);
|
|
};
|
|
|
|
/*
|
|
* Utility function to format a USTAR header into a buffer. If
|
|
* "strict" is set, this tries to create the absolutely most portable
|
|
* version of a ustar header. If "strict" is set to 0, then it will
|
|
* relax certain requirements.
|
|
*
|
|
* Generally, format-specific declarations don't belong in this
|
|
* header; this is a rare example of a function that is shared by
|
|
* two very similar formats (ustar and pax).
|
|
*/
|
|
int
|
|
__archive_write_format_header_ustar(struct archive_write *, char buff[512],
|
|
struct archive_entry *, int tartype, int strict);
|
|
|
|
#endif
|