1  /* Return the canonical absolute name of a given file.
       2     Copyright (C) 1996-2007, 2009-2023 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 <https://www.gnu.org/licenses/>.  */
      16  
      17  #ifndef CANONICALIZE_H_
      18  # define CANONICALIZE_H_
      19  
      20  /* This file uses _GL_ATTRIBUTE_MALLOC.  */
      21  #if !_GL_CONFIG_H_INCLUDED
      22   #error "Please include config.h first."
      23  #endif
      24  
      25  #include <stdlib.h> /* for canonicalize_file_name */
      26  
      27  #define CAN_MODE_MASK (CAN_EXISTING | CAN_ALL_BUT_LAST | CAN_MISSING)
      28  
      29  #ifdef __cplusplus
      30  extern "C" {
      31  #endif
      32  
      33  enum canonicalize_mode_t
      34    {
      35      /* All components must exist.  */
      36      CAN_EXISTING = 0,
      37  
      38      /* All components excluding last one must exist.  */
      39      CAN_ALL_BUT_LAST = 1,
      40  
      41      /* No requirements on components existence.  */
      42      CAN_MISSING = 2,
      43  
      44      /* Don't expand symlinks.  */
      45      CAN_NOLINKS = 4
      46    };
      47  typedef enum canonicalize_mode_t canonicalize_mode_t;
      48  
      49  /* Return the canonical absolute name of file NAME, while treating
      50     missing elements according to CAN_MODE.  A canonical name
      51     does not contain any `.', `..' components nor any repeated file name
      52     separators ('/') or, depending on other CAN_MODE flags, symlinks.
      53     Whether components must exist or not depends on canonicalize mode.
      54     The result is malloc'd.
      55     Upon failure, return NULL with errno set.  */
      56  char *canonicalize_filename_mode (const char *, canonicalize_mode_t)
      57    _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE;
      58  
      59  #ifdef __cplusplus
      60  }
      61  #endif
      62  
      63  #endif /* !CANONICALIZE_H_ */