(U-00024532): Use `->denotational' and `->subsumptive'.
[chise/xemacs-chise.git-] / src / filemode.c
1 /* filemode.c -- make a string describing file modes
2    Copyright (C) 1985, 1990, 1993 Free Software Foundation, Inc.
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING.  If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 /* Synched up with: FSF 19.30. */
22
23 #include <config.h>
24 #include "lisp.h"
25
26 #include "sysfile.h"
27
28 static void mode_string (unsigned short mode, char *str);
29 static char ftypelet (mode_t bits);
30 static void rwx (unsigned short bits, char *chars);
31 static void setst (unsigned short bits, char *chars);
32
33 /* filemodestring - fill in string STR with an ls-style ASCII
34    representation of the st_mode field of file stats block STATP.
35    10 characters are stored in STR; no terminating null is added.
36    The characters stored in STR are:
37
38    0    File type.  'd' for directory, 'c' for character
39         special, 'b' for block special, 'm' for multiplex,
40         'l' for symbolic link, 's' for socket, 'p' for fifo,
41         '-' for regular, '?' for any other file type
42
43    1    'r' if the owner may read, '-' otherwise.
44
45    2    'w' if the owner may write, '-' otherwise.
46
47    3    'x' if the owner may execute, 's' if the file is
48         set-user-id, '-' otherwise.
49         'S' if the file is set-user-id, but the execute
50         bit isn't set.
51
52    4    'r' if group members may read, '-' otherwise.
53
54    5    'w' if group members may write, '-' otherwise.
55
56    6    'x' if group members may execute, 's' if the file is
57         set-group-id, '-' otherwise.
58         'S' if it is set-group-id but not executable.
59
60    7    'r' if any user may read, '-' otherwise.
61
62    8    'w' if any user may write, '-' otherwise.
63
64    9    'x' if any user may execute, 't' if the file is "sticky"
65         (will be retained in swap space after execution), '-'
66         otherwise.
67         'T' if the file is sticky but not executable. */
68
69 void
70 filemodestring (struct stat *statp, char *str)
71 {
72   mode_string (statp->st_mode, str);
73 }
74
75 /* Like filemodestring, but only the relevant part of the `struct stat'
76    is given as an argument. */
77
78 static void
79 mode_string (unsigned short mode, char *str)
80 {
81   str[0] = ftypelet (mode);
82   rwx ((unsigned short) ((mode & 0700) << 0), &str[1]);
83   rwx ((unsigned short) ((mode & 0070) << 3), &str[4]);
84   rwx ((unsigned short) ((mode & 0007) << 6), &str[7]);
85   setst (mode, str);
86 }
87
88 /* Return a character indicating the type of file described by
89    file mode BITS:
90    'd' for directories
91    'b' for block special files
92    'c' for character special files
93    'm' for multiplexor files
94    'l' for symbolic links
95    's' for sockets
96    'p' for fifos
97    '-' for regular files
98    '?' for any other file type. */
99
100 static char
101 ftypelet (mode_t bits)
102 {
103 #ifdef S_ISBLK
104   if (S_ISBLK (bits))
105     return 'b';
106 #endif
107   if (S_ISCHR (bits))
108     return 'c';
109   if (S_ISDIR (bits))
110     return 'd';
111   if (S_ISREG (bits))
112     return '-';
113 #ifdef S_ISFIFO
114   if (S_ISFIFO (bits))
115     return 'p';
116 #endif
117 #ifdef S_ISLNK
118   if (S_ISLNK (bits))
119     return 'l';
120 #endif
121 #ifdef S_ISSOCK
122   if (S_ISSOCK (bits))
123     return 's';
124 #endif
125 #ifdef S_ISMPC
126   if (S_ISMPC (bits))
127     return 'm';
128 #endif
129 #ifdef S_ISNWK
130   if (S_ISNWK (bits))
131     return 'n';
132 #endif
133   return '?';
134 }
135
136 /* Look at read, write, and execute bits in BITS and set
137    flags in CHARS accordingly. */
138
139 static void
140 rwx (unsigned short bits, char *chars)
141 {
142   chars[0] = (bits & S_IRUSR) ? 'r' : '-';
143   chars[1] = (bits & S_IWUSR) ? 'w' : '-';
144   chars[2] = (bits & S_IXUSR) ? 'x' : '-';
145 }
146
147 /* Set the 's' and 't' flags in file attributes string CHARS,
148    according to the file mode BITS. */
149
150 static void
151 setst (unsigned short bits, char *chars)
152 {
153 #ifdef S_ISUID
154   if (bits & S_ISUID)
155     {
156       if (chars[3] != 'x')
157         /* Set-uid, but not executable by owner. */
158         chars[3] = 'S';
159       else
160         chars[3] = 's';
161     }
162 #endif
163 #ifdef S_ISGID
164   if (bits & S_ISGID)
165     {
166       if (chars[6] != 'x')
167         /* Set-gid, but not executable by group. */
168         chars[6] = 'S';
169       else
170         chars[6] = 's';
171     }
172 #endif
173 #ifdef S_ISVTX
174   if (bits & S_ISVTX)
175     {
176       if (chars[9] != 'x')
177         /* Sticky, but not executable by others. */
178         chars[9] = 'T';
179       else
180         chars[9] = 't';
181     }
182 #endif
183 }