dc68e66a6fed5fbd7ae61ce04e9294a0ac98b833
[dragonfly.git] / contrib / libarchive / cpio / cpio.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: src/usr.bin/cpio/cpio.h,v 1.7 2008/12/06 07:30:40 kientzle Exp $
26  */
27
28 #ifndef CPIO_H_INCLUDED
29 #define CPIO_H_INCLUDED
30
31 #include "cpio_platform.h"
32 #include <stdio.h>
33
34 #include "matching.h"
35
36 /*
37  * The internal state for the "cpio" program.
38  *
39  * Keeping all of the state in a structure like this simplifies memory
40  * leak testing (at exit, anything left on the heap is suspect).  A
41  * pointer to this structure is passed to most cpio internal
42  * functions.
43  */
44 struct cpio {
45         /* Option parsing */
46         const char       *argument;
47
48         /* Options */
49         const char       *filename;
50         int               mode; /* -i -o -p */
51         int               compress; /* -j, -y, or -z */
52         const char       *format; /* -H format */
53         int               bytes_per_block; /* -b block_size */
54         int               verbose;   /* -v */
55         int               dot;  /* -V */
56         int               quiet;   /* --quiet */
57         int               extract_flags; /* Flags for extract operation */
58         const char       *compress_program;
59         int               option_append; /* -A, only relevant for -o */
60         int               option_atime_restore; /* -a */
61         int               option_follow_links; /* -L */
62         int               option_link; /* -l */
63         int               option_list; /* -t */
64         char              option_null; /* --null */
65         int               option_numeric_uid_gid; /* -n */
66         int               option_rename; /* -r */
67         char             *destdir;
68         size_t            pass_destpath_alloc;
69         char             *pass_destpath;
70         int               uid_override;
71         char             *uname_override;
72         int               gid_override;
73         char             *gname_override;
74         int               day_first; /* true if locale prefers day/mon */
75
76         /* If >= 0, then close this when done. */
77         int               fd;
78
79         /* Miscellaneous state information */
80         struct archive   *archive;
81         struct archive   *archive_read_disk;
82         int               argc;
83         char            **argv;
84         int               return_value; /* Value returned by main() */
85         struct archive_entry_linkresolver *linkresolver;
86
87         struct name_cache *uname_cache;
88         struct name_cache *gname_cache;
89
90         /* Work data. */
91         struct lafe_matching  *matching;
92         char             *buff;
93         size_t            buff_size;
94 };
95
96 const char *owner_parse(const char *, int *, int *);
97
98
99 /* Fake short equivalents for long options that otherwise lack them. */
100 enum {
101         OPTION_INSECURE = 1,
102         OPTION_LZMA,
103         OPTION_NO_PRESERVE_OWNER,
104         OPTION_PRESERVE_OWNER,
105         OPTION_QUIET,
106         OPTION_VERSION
107 };
108
109 int     cpio_getopt(struct cpio *cpio);
110
111 #endif