lib/canonicalize.h

   1 /* Return the canonical absolute name of a given file.
   2    Copyright (C) 1996-2007, 2009-2010 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 3 of the License, or
   7    (at your option) 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, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef CANONICALIZE_H_
  18 # define CANONICALIZE_H_
  19
  20 #include <stdlib.h> /* for canonicalize_file_name */
  21
  22 enum canonicalize_mode_t
  23   {
  24     /* All components must exist.  */
  25     CAN_EXISTING = 0,
  26
  27     /* All components excluding last one must exist.  */
  28     CAN_ALL_BUT_LAST = 1,
  29
  30     /* No requirements on components existence.  */
  31     CAN_MISSING = 2
  32   };
  33 typedef enum canonicalize_mode_t canonicalize_mode_t;
  34
  35 /* Return a malloc'd string containing the canonical absolute name of
  36    the named file.  This acts like canonicalize_file_name, except that
  37    whether components must exist depends on the canonicalize_mode_t
  38    argument.  */
  39 char *canonicalize_filename_mode (const char *, canonicalize_mode_t);
  40
  41 #endif /* !CANONICALIZE_H_ */