lib/modechange.h

   1 /* modechange.h -- definitions for file mode manipulation
   2    Copyright (C) 1989, 1990, 1997, 2003 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* Masks for the `flags' field in a `struct mode_change'. */
  19
  20 #if ! defined MODECHANGE_H_
  21 # define MODECHANGE_H_
  22
  23 # include <sys/types.h>
  24
  25 /* Affect the execute bits only if at least one execute bit is set already,
  26    or if the file is a directory. */
  27 # define MODE_X_IF_ANY_X 01
  28
  29 /* If set, copy some existing permissions for u, g, or o onto the other two.
  30    Which of u, g, or o is copied is determined by which bits are set in the
  31    `value' field. */
  32 # define MODE_COPY_EXISTING 02
  33
  34 struct mode_change
  35 {
  36   char op;                      /* One of "=+-". */
  37   char flags;                   /* Special operations. */
  38   mode_t affected;              /* Set for u/g/o/s/s/t, if to be affected. */
  39   mode_t value;                 /* Bits to add/remove. */
  40   struct mode_change *next;     /* Link to next change in list. */
  41 };
  42
  43 /* Masks for mode_compile argument. */
  44 # define MODE_MASK_EQUALS 1
  45 # define MODE_MASK_PLUS 2
  46 # define MODE_MASK_MINUS 4
  47 # define MODE_MASK_ALL (MODE_MASK_EQUALS | MODE_MASK_PLUS | MODE_MASK_MINUS)
  48
  49 /* Error return values for mode_compile. */
  50 # define MODE_INVALID (struct mode_change *) 0
  51 # define MODE_MEMORY_EXHAUSTED (struct mode_change *) 1
  52 # define MODE_BAD_REFERENCE (struct mode_change *) 2
  53
  54 struct mode_change *mode_compile (const char *, unsigned);
  55 struct mode_change *mode_create_from_ref (const char *);
  56 mode_t mode_adjust (mode_t, const struct mode_change *);
  57 void mode_free (struct mode_change *);
  58
  59 #endif