cpio.h revision 228759 
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 */
44struct cpio {
45	/* Option parsing */
46	const char	 *optarg;
47
48	/* Options */
49	const char	 *filename;
50	char		  mode; /* -i -o -p */
51	char		  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		  quiet;   /* --quiet */
56	int		  extract_flags; /* Flags for extract operation */
57	char		  symlink_mode; /* H or L, per BSD conventions */
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	int		  gid_override;
72	int		  day_first; /* true if locale prefers day/mon */
73
74	/* If >= 0, then close this when done. */
75	int		  fd;
76
77	/* Miscellaneous state information */
78	struct archive	 *archive;
79	struct archive	 *archive_read_disk;
80	int		  argc;
81	char		**argv;
82	int		  return_value; /* Value returned by main() */
83	struct archive_entry_linkresolver *linkresolver;
84
85	struct name_cache *uname_cache;
86	struct name_cache *gname_cache;
87
88	/* Work data. */
89	struct lafe_matching  *matching;
90	char		 *buff;
91	size_t		  buff_size;
92};
93
94const char *owner_parse(const char *, int *, int *);
95
96
97/* Fake short equivalents for long options that otherwise lack them. */
98enum {
99	OPTION_INSECURE = 1,
100	OPTION_LZMA,
101	OPTION_NO_PRESERVE_OWNER,
102	OPTION_PRESERVE_OWNER,
103	OPTION_QUIET,
104	OPTION_VERSION
105};
106
107int	cpio_getopt(struct cpio *cpio);
108
109#endif
110