xref: /freebsd/contrib/libarchive/cpio/cpio.h (revision 7447ca0eb235974642312b9555caec00b57d8fc1)
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$
26  */
27 
28 #ifndef CPIO_H_INCLUDED
29 #define CPIO_H_INCLUDED
30 
31 #include "cpio_platform.h"
32 #include <stdio.h>
33 
34 /*
35  * The internal state for the "cpio" program.
36  *
37  * Keeping all of the state in a structure like this simplifies memory
38  * leak testing (at exit, anything left on the heap is suspect).  A
39  * pointer to this structure is passed to most cpio internal
40  * functions.
41  */
42 struct cpio {
43 	/* Option parsing */
44 	const char	 *argument;
45 
46 	/* Options */
47 	int		  add_filter; /* --uuencode */
48 	const char	 *filename;
49 	int		  mode; /* -i -o -p */
50 	int		  compress; /* -j, -y, or -z */
51 	const char	 *format; /* -H format */
52 	int		  bytes_per_block; /* -b block_size */
53 	int		  verbose;   /* -v */
54 	int		  dot;  /* -V */
55 	int		  quiet;   /* --quiet */
56 	int		  extract_flags; /* Flags for extract operation */
57 	const char	 *compress_program;
58 	int		  option_append; /* -A, only relevant for -o */
59 	int		  option_atime_restore; /* -a */
60 	int		  option_follow_links; /* -L */
61 	int		  option_link; /* -l */
62 	int		  option_list; /* -t */
63 	char		  option_null; /* --null */
64 	int		  option_numeric_uid_gid; /* -n */
65 	int		  option_rename; /* -r */
66 	char		 *destdir;
67 	size_t		  pass_destpath_alloc;
68 	char		 *pass_destpath;
69 	int		  uid_override;
70 	char		 *uname_override;
71 	int		  gid_override;
72 	char		 *gname_override;
73 	int		  day_first; /* true if locale prefers day/mon */
74 	const char	 *passphrase;
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 archive   *matching;
92 	char		 *buff;
93 	size_t		  buff_size;
94 	char		 *ppbuff;
95 };
96 
97 const char *owner_parse(const char *, int *, int *);
98 
99 
100 /* Fake short equivalents for long options that otherwise lack them. */
101 enum {
102 	OPTION_B64ENCODE = 1,
103 	OPTION_GRZIP,
104 	OPTION_INSECURE,
105 	OPTION_LRZIP,
106 	OPTION_LZ4,
107 	OPTION_LZMA,
108 	OPTION_LZOP,
109 	OPTION_PASSPHRASE,
110 	OPTION_NO_PRESERVE_OWNER,
111 	OPTION_PRESERVE_OWNER,
112 	OPTION_QUIET,
113 	OPTION_UUENCODE,
114 	OPTION_VERSION
115 };
116 
117 int	cpio_getopt(struct cpio *cpio);
118 
119 #endif
120