diff options
Diffstat (limited to 'gl/lib/canonicalize.h')
-rw-r--r-- | gl/lib/canonicalize.h | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/gl/lib/canonicalize.h b/gl/lib/canonicalize.h new file mode 100644 index 0000000..ea09c66 --- /dev/null +++ b/gl/lib/canonicalize.h @@ -0,0 +1,63 @@ +/* Return the canonical absolute name of a given file. + Copyright (C) 1996-2007, 2009-2023 Free Software Foundation, Inc. + + 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 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 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. */ + +#ifndef CANONICALIZE_H_ +# define CANONICALIZE_H_ + +/* This file uses _GL_ATTRIBUTE_MALLOC. */ +#if !_GL_CONFIG_H_INCLUDED + #error "Please include config.h first." +#endif + +#include <stdlib.h> /* for canonicalize_file_name */ + +#define CAN_MODE_MASK (CAN_EXISTING | CAN_ALL_BUT_LAST | CAN_MISSING) + +#ifdef __cplusplus +extern "C" { +#endif + +enum canonicalize_mode_t + { + /* All components must exist. */ + CAN_EXISTING = 0, + + /* All components excluding last one must exist. */ + CAN_ALL_BUT_LAST = 1, + + /* No requirements on components existence. */ + 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. + Upon failure, return NULL with errno set. */ +char *canonicalize_filename_mode (const char *, canonicalize_mode_t) + _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE; + +#ifdef __cplusplus +} +#endif + +#endif /* !CANONICALIZE_H_ */ |