[apple/file_cmds.git] / pax / options.h

/*      $OpenBSD: options.h,v 1.4 2003/06/13 17:51:14 millert Exp $     */
/*      $NetBSD: options.h,v 1.3 1995/03/21 09:07:32 cgd Exp $  */

/*-
 * Copyright (c) 1992 Keith Muller.
 * Copyright (c) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Keith Muller of the University of California, San Diego.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)options.h   8.2 (Berkeley) 4/18/94
 */

#ifndef _OPTIONS_H_
#define _OPTIONS_H_

/*
 * argv[0] names. Used for tar and cpio emulation
 */

#define NM_TAR  "tar"
#define NM_CPIO "cpio"
#define NM_PAX  "pax"

/*
 * Constants used to specify the legal sets of flags in pax. For each major
 * operation mode of pax, a set of illegal flags is defined. If any one of
 * those illegal flags are found set, we scream and exit
 */
#define NONE    "none"

/*
 * flags (one for each option).
 */
#define AF      0x00000001
#define BF      0x00000002
#define CF      0x00000004
#define DF      0x00000008
#define FF      0x00000010
#define IF      0x00000020
#define KF      0x00000040
#define LF      0x00000080
#define NF      0x00000100
#define OF      0x00000200
#define PF      0x00000400
#define RF      0x00000800
#define SF      0x00001000
#define TF      0x00002000
#define UF      0x00004000
#define VF      0x00008000
#define WF      0x00010000
#define XF      0x00020000
#define CBF     0x00040000      /* nonstandard extension */
#define CDF     0x00080000      /* nonstandard extension */
#define CEF     0x00100000      /* nonstandard extension */
#define CGF     0x00200000      /* nonstandard extension */
#define CHF     0x00400000      /* nonstandard extension */
#define CLF     0x00800000      /* nonstandard extension */
#define CPF     0x01000000      /* nonstandard extension */
#define CTF     0x02000000      /* nonstandard extension */
#define CUF     0x04000000      /* nonstandard extension */
#define CXF     0x08000000
#define CYF     0x10000000      /* nonstandard extension */
#define CZF     0x20000000      /* nonstandard extension */
#define C0F     0x40000000      /* nonstandard extension */

/*
 * ascii string indexed by bit position above (alter the above and you must
 * alter this string) used to tell the user what flags caused us to complain
 */
#define FLGCH   "abcdfiklnoprstuvwxBDEGHLPTUXYZ0"

/*
 * legal pax operation bit patterns
 */

#define ISLIST(x)       (((x) & (RF|WF)) == 0)
#define ISEXTRACT(x)    (((x) & (RF|WF)) == RF)
#define ISARCHIVE(x)    (((x) & (AF|RF|WF)) == WF)
#define ISAPPND(x)      (((x) & (AF|RF|WF)) == (AF|WF))
#define ISCOPY(x)       (((x) & (RF|WF)) == (RF|WF))
#define ISWRITE(x)      (((x) & (RF|WF)) == WF)

/*
 * Illegal option flag subsets based on pax operation
 */

#define BDEXTR  (AF|BF|LF|TF|WF|XF|CBF|CHF|CLF|CPF|CXF)
#define BDARCH  (CF|KF|LF|NF|PF|RF|CDF|CEF|CYF|CZF)
#define BDCOPY  (AF|BF|FF|CBF|CEF)
#define BDLIST (AF|BF|IF|KF|LF|PF|RF|TF|UF|WF|XF|CBF|CDF|CHF|CLF|CPF|CXF|CYF|CZF)

#endif /* _OPTIONS_H_ */