*** empty log message ***
[gnulib.git] / lib / xstat.in
1 /* @IGNORE@ -*- c -*- */
2 /* @IGNORE@ This file is a template from which both stat.c and lstat.c
3    @IGNORE@ are generated. */
4 /* Work around the bug in some systems whereby @xstat@ succeeds when
5    given the zero-length file name argument.  The @xstat@ from SunOS4.1.4
6    has this bug.
7    Copyright (C) 1997-2001 Free Software Foundation, Inc.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2, or (at your option)
12    any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software Foundation,
21    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
22
23 /* written by Jim Meyering */
24
25 #include <config.h>
26
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #include <errno.h>
30 #ifndef errno
31 extern int errno;
32 #endif
33 @BEGIN_LSTAT_ONLY@
34
35 #if HAVE_STDLIB_H
36 # include <stdlib.h>
37 #endif
38
39 #ifdef STAT_MACROS_BROKEN
40 # undef S_ISLNK
41 #endif
42 #if !defined(S_ISLNK) && defined(S_IFLNK)
43 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
44 #endif
45
46 #ifndef HAVE_DECL_FREE
47 "this configure-time declaration test was not run"
48 #endif
49 #if !HAVE_DECL_FREE
50 void free ();
51 #endif
52
53 char *xmalloc ();
54
55 /* lstat works differently on Linux and Solaris systems.  POSIX (see
56    `pathname resolution' in the glossary) requires that programs like `ls'
57    take into consideration the fact that FILE has a trailing slash when
58    FILE is a symbolic link.  On Linux systems, the lstat function already
59    has the desired semantics (in treating `lstat("symlink/",sbuf)' just like
60    `lstat("symlink/.",sbuf)', but on Solaris it does not.
61
62    If FILE has a trailing slash and specifies a symbolic link,
63    then append a `.' to FILE and call lstat a second time.  */
64
65 static int
66 slash_aware_lstat (const char *file, struct stat *sbuf)
67 {
68   size_t len;
69   char *new_file;
70
71   int lstat_result = lstat (file, sbuf);
72
73   if (lstat_result != 0 || !S_ISLNK (sbuf->st_mode))
74     return lstat_result;
75
76   len = strlen (file);
77   if (file[len - 1] != '/')
78     return lstat_result;
79
80   /* FILE refers to a symbolic link and the name ends with a slash.
81      Append a `.' to FILE and repeat the lstat call.  */
82
83   /* Add one for the `.' we'll append, and one more for the trailing NUL.  */
84   new_file = xmalloc (len + 1 + 1);
85   memcpy (new_file, file, len);
86   new_file[len] = '.';
87   new_file[len + 1] = 0;
88
89   lstat_result = lstat (new_file, sbuf);
90   free (new_file);
91
92   return lstat_result;
93 }
94 @END_LSTAT_ONLY@
95
96 /* This is a wrapper for @xstat@(2).
97    If FILE is the empty string, fail with errno == ENOENT.
98    Otherwise, return the result of calling the real @xstat@.
99
100    This works around the bug in some systems whereby @xstat@ succeeds when
101    given the zero-length file name argument.  The @xstat@ from SunOS4.1.4
102    has this bug.  */
103 @BEGIN_LSTAT_ONLY@
104
105 /* This function also provides a version of lstat with consistent semantics
106    when FILE specifies a symbolic link and has a trailing slash.  */
107 @END_LSTAT_ONLY@
108
109 int
110 rpl_@xstat@ (const char *file, struct stat *sbuf)
111 {
112   if (file && *file == 0)
113     {
114       errno = ENOENT;
115       return -1;
116     }
117
118 @BEGIN_LSTAT_ONLY@
119   return slash_aware_lstat (file, sbuf);
120 @END_LSTAT_ONLY@
121 @BEGIN_STAT_ONLY@
122   return stat (file, sbuf);
123 @END_STAT_ONLY@
124 }