Import upstream version 1.28
[debian/tar] / gnu / pathmax.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* Define PATH_MAX somehow.  Requires sys/types.h.
4    Copyright (C) 1992, 1999, 2001, 2003, 2005, 2009-2014 Free Software
5    Foundation, Inc.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3, or (at your option)
10    any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, see <http://www.gnu.org/licenses/>.  */
19
20 #ifndef _PATHMAX_H
21 # define _PATHMAX_H
22
23 /* POSIX:2008 defines PATH_MAX to be the maximum number of bytes in a filename,
24    including the terminating NUL byte.
25    <http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/limits.h.html>
26    PATH_MAX is not defined on systems which have no limit on filename length,
27    such as GNU/Hurd.
28
29    This file does *not* define PATH_MAX always.  Programs that use this file
30    can handle the GNU/Hurd case in several ways:
31      - Either with a package-wide handling, or with a per-file handling,
32      - Either through a
33          #ifdef PATH_MAX
34        or through a fallback like
35          #ifndef PATH_MAX
36          # define PATH_MAX 8192
37          #endif
38        or through a fallback like
39          #ifndef PATH_MAX
40          # define PATH_MAX pathconf ("/", _PC_PATH_MAX)
41          #endif
42  */
43
44 # include <unistd.h>
45
46 # include <limits.h>
47
48 # ifndef _POSIX_PATH_MAX
49 #  define _POSIX_PATH_MAX 256
50 # endif
51
52 /* Don't include sys/param.h if it already has been.  */
53 # if defined HAVE_SYS_PARAM_H && !defined PATH_MAX && !defined MAXPATHLEN
54 #  include <sys/param.h>
55 # endif
56
57 # if !defined PATH_MAX && defined MAXPATHLEN
58 #  define PATH_MAX MAXPATHLEN
59 # endif
60
61 # ifdef __hpux
62 /* On HP-UX, PATH_MAX designates the maximum number of bytes in a filename,
63    *not* including the terminating NUL byte, and is set to 1023.
64    Additionally, when _XOPEN_SOURCE is defined to 500 or more, PATH_MAX is
65    not defined at all any more.  */
66 #  undef PATH_MAX
67 #  define PATH_MAX 1024
68 # endif
69
70 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
71 /* The page "Naming Files, Paths, and Namespaces" on msdn.microsoft.com,
72    section "Maximum Path Length Limitation",
73    <http://msdn.microsoft.com/en-us/library/aa365247(v=vs.85).aspx#maxpath>
74    explains that the maximum size of a filename, including the terminating
75    NUL byte, is 260 = 3 + 256 + 1.
76    This is the same value as
77      - FILENAME_MAX in <stdio.h>,
78      - _MAX_PATH in <stdlib.h>,
79      - MAX_PATH in <windef.h>.
80    Undefine the original value, because mingw's <limits.h> gets it wrong.  */
81 #  undef PATH_MAX
82 #  define PATH_MAX 260
83 # endif
84
85 #endif /* _PATHMAX_H */