/*-

 * 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: head/lib/libarchive/archive_write_private.h 201155 2009-12-29 05:20:12Z kientzle $

 */

#ifndef __LIBARCHIVE_BUILD

#ifndef __LIBARCHIVE_TEST

#error This header is only to be used internally to libarchive.

#endif

#endif

#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_write_filter {

	int64_t bytes_written;

	struct archive *archive; /* Associated archive. */

	struct archive_write_filter *next_filter; /* Who I write to. */

	int	(*options)(struct archive_write_filter *,

	    const char *key, const char *value);

	int	(*open)(struct archive_write_filter *);

	int	(*write)(struct archive_write_filter *, const void *, size_t);

	int	(*close)(struct archive_write_filter *);

	int	(*free)(struct archive_write_filter *);

	void	 *data;

	const char *name;

	int	  code;

	int	  bytes_per_block;

	int	  bytes_in_last_block;

};

#if ARCHIVE_VERSION < 4000000

void __archive_write_filters_free(struct archive *);

#endif

struct archive_write_filter *__archive_write_allocate_filter(struct archive *);

int __archive_write_output(struct archive_write *, const void *, size_t);

int __archive_write_nulls(struct archive_write *, size_t);

int __archive_write_filter(struct archive_write_filter *, const void *, size_t);

int __archive_write_open_filter(struct archive_write_filter *);

int __archive_write_close_filter(struct archive_write_filter *);

struct archive_write {

	struct archive	archive;

	/* Dev/ino of the archive being written. */

	int		  skip_file_set;

	int64_t		  skip_file_dev;

	int64_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;

	/*

	 * First and last write filters in the pipeline.

	 */

	struct archive_write_filter *filter_first;

	struct archive_write_filter *filter_last;

	/*

	 * 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_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);

	int	(*format_close)(struct archive_write *);

	int	(*format_free)(struct archive_write *);

	/*

	 * Encryption passphrase.

	 */

	char		*passphrase;

	archive_passphrase_callback *passphrase_callback;

	void		*passphrase_client_data;

};

/*

 * 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,

    struct archive_string_conv *);

struct archive_write_program_data;

struct archive_write_program_data * __archive_write_program_allocate(const char *program_name);

int	__archive_write_program_free(struct archive_write_program_data *);

int	__archive_write_program_open(struct archive_write_filter *,

	    struct archive_write_program_data *, const char *);

int	__archive_write_program_close(struct archive_write_filter *,

	    struct archive_write_program_data *);

int	__archive_write_program_write(struct archive_write_filter *,

	    struct archive_write_program_data *, const void *, size_t);

/*

 * Get a encryption passphrase.

 */

const char * __archive_write_get_passphrase(struct archive_write *a);

#endif