contrib/libarchive/libarchive/archive_read_disk_private.h

   1 /*-
   2  * Copyright (c) 2003-2009 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  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD: head/lib/libarchive/archive_read_disk_private.h 201105 2009-12-28 03:20:54Z kientzle $
  27  */
  28
  29 #ifndef __LIBARCHIVE_BUILD
  30 #error This header is only to be used internally to libarchive.
  31 #endif
  32
  33 #ifndef ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
  34 #define ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
  35
  36 struct tree;
  37 struct archive_entry;
  38
  39 struct archive_read_disk {
  40         struct archive  archive;
  41
  42         /*
  43          * Symlink mode is one of 'L'ogical, 'P'hysical, or 'H'ybrid,
  44          * following an old BSD convention.  'L' follows all symlinks,
  45          * 'P' follows none, 'H' follows symlinks only for the first
  46          * item.
  47          */
  48         char    symlink_mode;
  49
  50         /*
  51          * Since symlink interaction changes, we need to track whether
  52          * we're following symlinks for the current item.  'L' mode above
  53          * sets this true, 'P' sets it false, 'H' changes it as we traverse.
  54          */
  55         char    follow_symlinks;  /* Either 'L' or 'P'. */
  56
  57         /* Directory traversals. */
  58         struct tree *tree;
  59         int     (*open_on_current_dir)(struct tree*, const char *, int);
  60         int     (*tree_current_dir_fd)(struct tree*);
  61         int     (*tree_enter_working_dir)(struct tree*);
  62
  63         /* Set 1 if users request to restore atime . */
  64         int              restore_time;
  65         /* Set 1 if users request to honor nodump flag . */
  66         int              honor_nodump;
  67         /* Set 1 if users request to enable mac copyfile. */
  68         int              enable_copyfile;
  69         /* Set 1 if users request to traverse mount points. */
  70         int              traverse_mount_points;
  71
  72         const char * (*lookup_gname)(void *private, int64_t gid);
  73         void    (*cleanup_gname)(void *private);
  74         void     *lookup_gname_data;
  75         const char * (*lookup_uname)(void *private, int64_t uid);
  76         void    (*cleanup_uname)(void *private);
  77         void     *lookup_uname_data;
  78
  79         int     (*metadata_filter_func)(struct archive *, void *,
  80                         struct archive_entry *);
  81         void    *metadata_filter_data;
  82
  83         /* ARCHIVE_MATCH object. */
  84         struct archive  *matching;
  85         /* Callback function, this will be invoked when ARCHIVE_MATCH
  86          * archive_match_*_excluded_ae return true. */
  87         void    (*excluded_cb_func)(struct archive *, void *,
  88                          struct archive_entry *);
  89         void    *excluded_cb_data;
  90 };
  91
  92 #endif