gl/dirname.h

   1 /* Take file names apart into directory and base names.
   2
   3    Copyright (C) 1998, 2001, 2003-2006, 2009-2024 Free Software Foundation,
   4    Inc.
   5
   6    This file is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU Lesser General Public License as
   8    published by the Free Software Foundation; either version 2.1 of the
   9    License, or (at your option) any later version.
  10
  11    This file is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public License
  17    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef DIRNAME_H_
  20 # define DIRNAME_H_ 1
  21
  22 /* This file uses _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_PURE,
  23    _GL_ATTRIBUTE_RETURNS_NONNULL.  */
  24 #if !_GL_CONFIG_H_INCLUDED
  25  #error "Please include config.h first."
  26 #endif
  27
  28 # include <stdlib.h>
  29 # include "filename.h"
  30 # include "basename-lgpl.h"
  31
  32 # ifndef DIRECTORY_SEPARATOR
  33 #  define DIRECTORY_SEPARATOR '/'
  34 # endif
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 # if GNULIB_DIRNAME
  41 char *base_name (char const *file)
  42   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  43   _GL_ATTRIBUTE_RETURNS_NONNULL;
  44 char *dir_name (char const *file)
  45   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE
  46   _GL_ATTRIBUTE_RETURNS_NONNULL;
  47 # endif
  48
  49 char *mdir_name (char const *file)
  50   _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE;
  51 size_t dir_len (char const *file) _GL_ATTRIBUTE_PURE;
  52
  53 bool strip_trailing_slashes (char *file);
  54
  55 #ifdef __cplusplus
  56 } /* extern "C" */
  57 #endif
  58
  59 #endif /* not DIRNAME_H_ */