1/* Macros for taking apart, interpreting and processing file names.
2
3   These are here because some non-Posix (a.k.a. DOSish) systems have
4   drive letter brain-damage at the beginning of an absolute file name,
5   use forward- and back-slash in path names interchangeably, and
6   some of them have case-insensitive file names.
7
8   Copyright 2000, 2001, 2007, 2010 Free Software Foundation, Inc.
9
10This file is part of BFD, the Binary File Descriptor library.
11
12This program is free software; you can redistribute it and/or modify
13it under the terms of the GNU General Public License as published by
14the Free Software Foundation; either version 2 of the License, or
15(at your option) any later version.
16
17This program is distributed in the hope that it will be useful,
18but WITHOUT ANY WARRANTY; without even the implied warranty of
19MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20GNU General Public License for more details.
21
22You should have received a copy of the GNU General Public License
23along with this program; if not, write to the Free Software
24Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
25
26#ifndef FILENAMES_H
27#define FILENAMES_H
28
29#include "hashtab.h" /* for hashval_t */
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35#if defined(__MSDOS__) || defined(_WIN32) || defined(__OS2__) || defined (__CYGWIN__)
36#  ifndef HAVE_DOS_BASED_FILE_SYSTEM
37#    define HAVE_DOS_BASED_FILE_SYSTEM 1
38#  endif
39#  ifndef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
40#    define HAVE_CASE_INSENSITIVE_FILE_SYSTEM 1
41#  endif
42#  define HAS_DRIVE_SPEC(f) HAS_DOS_DRIVE_SPEC (f)
43#  define IS_DIR_SEPARATOR(c) IS_DOS_DIR_SEPARATOR (c)
44#  define IS_ABSOLUTE_PATH(f) IS_DOS_ABSOLUTE_PATH (f)
45#else /* not DOSish */
46#  if defined(__APPLE__)
47/*
48#    ifndef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
49#      define HAVE_CASE_INSENSITIVE_FILE_SYSTEM 1
50#    endif
51*/
52#  endif /* __APPLE__ */
53#  define HAS_DRIVE_SPEC(f) (0)
54#  define IS_DIR_SEPARATOR(c) IS_UNIX_DIR_SEPARATOR (c)
55#  define IS_ABSOLUTE_PATH(f) IS_UNIX_ABSOLUTE_PATH (f)
56#endif
57
58#define IS_DIR_SEPARATOR_1(dos_based, c)				\
59  (((c) == '/')								\
60   || (((c) == '\\') && (dos_based)))
61
62#define HAS_DRIVE_SPEC_1(dos_based, f)			\
63  ((f)[0] && ((f)[1] == ':') && (dos_based))
64
65/* Remove the drive spec from F, assuming HAS_DRIVE_SPEC (f).
66   The result is a pointer to the remainder of F.  */
67#define STRIP_DRIVE_SPEC(f)	((f) + 2)
68
69#define IS_DOS_DIR_SEPARATOR(c) IS_DIR_SEPARATOR_1 (1, c)
70#define IS_DOS_ABSOLUTE_PATH(f) IS_ABSOLUTE_PATH_1 (1, f)
71#define HAS_DOS_DRIVE_SPEC(f) HAS_DRIVE_SPEC_1 (1, f)
72
73#define IS_UNIX_DIR_SEPARATOR(c) IS_DIR_SEPARATOR_1 (0, c)
74#define IS_UNIX_ABSOLUTE_PATH(f) IS_ABSOLUTE_PATH_1 (0, f)
75
76/* Note that when DOS_BASED is true, IS_ABSOLUTE_PATH accepts d:foo as
77   well, although it is only semi-absolute.  This is because the users
78   of IS_ABSOLUTE_PATH want to know whether to prepend the current
79   working directory to a file name, which should not be done with a
80   name like d:foo.  */
81#define IS_ABSOLUTE_PATH_1(dos_based, f)		 \
82  (IS_DIR_SEPARATOR_1 (dos_based, (f)[0])		 \
83   || HAS_DRIVE_SPEC_1 (dos_based, f))
84
85extern int filename_cmp (const char *s1, const char *s2);
86#define FILENAME_CMP(s1, s2)	filename_cmp(s1, s2)
87
88extern int filename_ncmp (const char *s1, const char *s2,
89			  size_t n);
90
91extern hashval_t filename_hash (const void *s);
92
93extern int filename_eq (const void *s1, const void *s2);
94
95extern int canonical_filename_eq (const char *a, const char *b);
96
97#ifdef __cplusplus
98}
99#endif
100
101#endif /* FILENAMES_H */
102