gettimeofday: port recent C++ fix to Emacs
[gnulib.git] / lib / canonicalize.h
index 4cae3c5..41ff311 100644 (file)
@@ -1,10 +1,10 @@
 /* Return the canonical absolute name of a given file.
-   Copyright (C) 1996-2005 Free Software Foundation, Inc.
+   Copyright (C) 1996-2007, 2009-2013 Free Software Foundation, Inc.
 
-   This program is free software; you can redistribute it and/or modify
+   This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.
-   If not, write to the Free Software Foundation,
-   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #ifndef CANONICALIZE_H_
 # define CANONICALIZE_H_
 
+#include <stdlib.h> /* for canonicalize_file_name */
+
+#define CAN_MODE_MASK (CAN_EXISTING | CAN_ALL_BUT_LAST | CAN_MISSING)
+
 enum canonicalize_mode_t
   {
     /* All components must exist.  */
@@ -28,14 +30,19 @@ enum canonicalize_mode_t
     CAN_ALL_BUT_LAST = 1,
 
     /* No requirements on components existence.  */
-    CAN_MISSING = 2
+    CAN_MISSING = 2,
+
+    /* Don't expand symlinks.  */
+    CAN_NOLINKS = 4
   };
 typedef enum canonicalize_mode_t canonicalize_mode_t;
 
+/* Return the canonical absolute name of file NAME, while treating
+   missing elements according to CAN_MODE.  A canonical name
+   does not contain any `.', `..' components nor any repeated file name
+   separators ('/') or, depending on other CAN_MODE flags, symlinks.
+   Whether components must exist or not depends on canonicalize mode.
+   The result is malloc'd.  */
 char *canonicalize_filename_mode (const char *, canonicalize_mode_t);
 
-# if !HAVE_CANONICALIZE_FILE_NAME
-char *canonicalize_file_name (const char *);
-# endif
-
 #endif /* !CANONICALIZE_H_ */