cpio.h revision 358926 
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: stable/11/contrib/libarchive/cpio/cpio.h 358926 2020-03-13 01:05:55Z mm $
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 */
42struct 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		  destdir_len;
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	const char	 *passphrase;
76
77	/* If >= 0, then close this when done. */
78	int		  fd;
79
80	/* Miscellaneous state information */
81	struct archive	 *archive;
82	struct archive	 *archive_read_disk;
83	int		  argc;
84	char		**argv;
85	int		  return_value; /* Value returned by main() */
86	struct archive_entry_linkresolver *linkresolver;
87
88	struct name_cache *uname_cache;
89	struct name_cache *gname_cache;
90
91	/* Work data. */
92	struct archive   *matching;
93	char		 *buff;
94	size_t		  buff_size;
95	char		 *ppbuff;
96};
97
98const char *owner_parse(const char *, int *, int *);
99
100
101/* Fake short equivalents for long options that otherwise lack them. */
102enum {
103	OPTION_B64ENCODE = 1,
104	OPTION_GRZIP,
105	OPTION_INSECURE,
106	OPTION_LRZIP,
107	OPTION_LZ4,
108	OPTION_LZMA,
109	OPTION_LZOP,
110	OPTION_PASSPHRASE,
111	OPTION_NO_PRESERVE_OWNER,
112	OPTION_PRESERVE_OWNER,
113	OPTION_QUIET,
114	OPTION_UUENCODE,
115	OPTION_VERSION,
116	OPTION_ZSTD,
117};
118
119int	cpio_getopt(struct cpio *cpio);
120
121#endif
122