gl/dirname.h

   1 /*  Take file names apart into directory and base names.
   2
   3     Copyright (C) 1998, 2001, 2003-2006, 2009-2010 Free Software Foundation,
   4     Inc.
   5
   6     This program is free software: you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 3 of the License, or
   9     (at your option) any later version.
  10
  11     This program 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 General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef DIRNAME_H_
  20 # define DIRNAME_H_ 1
  21
  22 # include <stdbool.h>
  23 # include <stddef.h>
  24
  25 # ifndef DIRECTORY_SEPARATOR
  26 #  define DIRECTORY_SEPARATOR '/'
  27 # endif
  28
  29 # ifndef ISSLASH
  30 #  define ISSLASH(C) ((C) == DIRECTORY_SEPARATOR)
  31 # endif
  32
  33 # ifndef FILE_SYSTEM_PREFIX_LEN
  34 #  if FILE_SYSTEM_ACCEPTS_DRIVE_LETTER_PREFIX
  35     /* This internal macro assumes ASCII, but all hosts that support drive
  36        letters use ASCII.  */
  37 #   define _IS_DRIVE_LETTER(c) (((unsigned int) (c) | ('a' - 'A')) - 'a' \
  38                                 <= 'z' - 'a')
  39 #   define FILE_SYSTEM_PREFIX_LEN(Filename) \
  40            (_IS_DRIVE_LETTER ((Filename)[0]) && (Filename)[1] == ':' ? 2 : 0)
  41 #  else
  42 #   define FILE_SYSTEM_PREFIX_LEN(Filename) 0
  43 #  endif
  44 # endif
  45
  46 # ifndef FILE_SYSTEM_DRIVE_PREFIX_CAN_BE_RELATIVE
  47 #  define FILE_SYSTEM_DRIVE_PREFIX_CAN_BE_RELATIVE 0
  48 # endif
  49
  50 # ifndef DOUBLE_SLASH_IS_DISTINCT_ROOT
  51 #  define DOUBLE_SLASH_IS_DISTINCT_ROOT 0
  52 # endif
  53
  54 # if FILE_SYSTEM_DRIVE_PREFIX_CAN_BE_RELATIVE
  55 #  define IS_ABSOLUTE_FILE_NAME(F) ISSLASH ((F)[FILE_SYSTEM_PREFIX_LEN (F)])
  56 # else
  57 #  define IS_ABSOLUTE_FILE_NAME(F) \
  58           (ISSLASH ((F)[0]) || 0 < FILE_SYSTEM_PREFIX_LEN (F))
  59 # endif
  60 # define IS_RELATIVE_FILE_NAME(F) (! IS_ABSOLUTE_FILE_NAME (F))
  61
  62 # if GNULIB_DIRNAME
  63 char *base_name (char const *file);
  64 char *dir_name (char const *file);
  65 # endif
  66
  67 char *mdir_name (char const *file);
  68 size_t base_len (char const *file);
  69 size_t dir_len (char const *file);
  70 char *last_component (char const *file);
  71
  72 bool strip_trailing_slashes (char *file);
  73
  74 #endif /* not DIRNAME_H_ */