Home | History | Annotate | Line # | Download | only in cpio
cpio.h revision 1.1.1.5 
      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 
     26 #ifndef CPIO_H_INCLUDED
     27 #define CPIO_H_INCLUDED
     28 
     29 #include "cpio_platform.h"
     30 #include <stdio.h>
     31 
     32 /*
     33  * The internal state for the "cpio" program.
     34  *
     35  * Keeping all of the state in a structure like this simplifies memory
     36  * leak testing (at exit, anything left on the heap is suspect).  A
     37  * pointer to this structure is passed to most cpio internal
     38  * functions.
     39  */
     40 struct cpio {
     41 	/* Option parsing */
     42 	const char	 *argument;
     43 
     44 	/* Options */
     45 	int		  add_filter; /* --uuencode */
     46 	const char	 *filename;
     47 	int		  mode; /* -i -o -p */
     48 	int		  compress; /* -j, -y, or -z */
     49 	const char	 *format; /* -H format */
     50 	int		  bytes_per_block; /* -b block_size */
     51 	int		  verbose;   /* -v */
     52 	int		  dot;  /* -V */
     53 	int		  quiet;   /* --quiet */
     54 	int		  extract_flags; /* Flags for extract operation */
     55 	const char	 *compress_program;
     56 	int		  option_append; /* -A, only relevant for -o */
     57 	int		  option_atime_restore; /* -a */
     58 	int		  option_follow_links; /* -L */
     59 	int		  option_link; /* -l */
     60 	int		  option_list; /* -t */
     61 	char		  option_null; /* --null */
     62 	int		  option_numeric_uid_gid; /* -n */
     63 	int		  option_pwb; /* -6 */
     64 	int		  option_rename; /* -r */
     65 	char		 *destdir;
     66 	size_t		  destdir_len;
     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 	OPTION_ZSTD,
    116 };
    117 
    118 int	cpio_getopt(struct cpio *cpio);
    119 
    120 #endif
    121