Home | History | Annotate | Line # | Download | only in cpio
cpio.h revision 1.1.1.1.12.2 
      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.2 2008/06/21 02:20:20 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 #define	DEFAULT_BYTES_PER_BLOCK	(20*512)
     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 	/* Options */
     46 	char		 *filename;
     47 	char		  mode; /* -i -o -p */
     48 	char		  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		  quiet;   /* --quiet */
     53 	int		  extract_flags; /* Flags for extract operation */
     54 	char		  symlink_mode; /* H or L, per BSD conventions */
     55 	const char	 *compress_program;
     56 	char		  line_separator; /* --null ? '\0' : '\n' */
     57 	int		  option_append; /* -A, only relevant for -o */
     58 	int		  option_atime_restore; /* -a */
     59 	int		  option_follow_links; /* -L */
     60 	int		  option_link; /* -l */
     61 	int		  option_list; /* -t */
     62 	int		  option_rename; /* -r */
     63 	char		 *destdir;
     64 	size_t		  pass_destpath_alloc;
     65 	char		 *pass_destpath;
     66 	int		  uid_override;
     67 	int		  gid_override;
     68 
     69 	/* If >= 0, then close this when done. */
     70 	int		  fd;
     71 
     72 	/* Miscellaneous state information */
     73 	struct archive	 *archive;
     74 	int		  argc;
     75 	char		**argv;
     76 	int		  return_value; /* Value returned by main() */
     77 	struct archive_entry_linkresolver *linkresolver;
     78 
     79 	/* Work data. */
     80 	struct matching  *matching;
     81 	char		 *buff;
     82 	size_t		  buff_size;
     83 };
     84 
     85 /* Name of this program; used in error reporting, initialized in main(). */
     86 const char *cpio_progname;
     87 
     88 void	cpio_errc(int _eval, int _code, const char *fmt, ...);
     89 void	cpio_warnc(int _code, const char *fmt, ...);
     90 
     91 int	owner_parse(const char *, int *, int *);
     92 
     93 
     94 /* Fake short equivalents for long options that otherwise lack them. */
     95 enum {
     96 	OPTION_INSECURE = 1,
     97 	OPTION_QUIET,
     98 	OPTION_VERSION
     99 };
    100 
    101 struct line_reader;
    102 
    103 struct line_reader *process_lines_init(const char *, char separator);
    104 const char *process_lines_next(struct line_reader *);
    105 void	process_lines_free(struct line_reader *);
    106 
    107 int	cpio_getopt(struct cpio *cpio);
    108 int	include_from_file(struct cpio *, const char *);
    109 
    110 #endif
    111