428
|
1 /*
|
|
2 Copyright (C) 1995 Free Software Foundation, Inc.
|
2421
|
3 Copyright (C) 2000, 2001, 2002, 2004 Ben Wing.
|
428
|
4
|
|
5 This file is part of XEmacs.
|
|
6
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
8 under the terms of the GNU General Public License as published by the
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
10 later version.
|
|
11
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
15 for more details.
|
|
16
|
|
17 You should have received a copy of the GNU General Public License
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
20 Boston, MA 02111-1307, USA. */
|
|
21
|
|
22 /* Synched up with: Not really in FSF. */
|
|
23
|
440
|
24 #ifndef INCLUDED_sysfile_h_
|
|
25 #define INCLUDED_sysfile_h_
|
|
26
|
771
|
27 /* The anonymous voice of the past says:
|
|
28 Must come before sysfile.h
|
|
29
|
|
30 So instead we just put it here. --ben */
|
|
31 #ifdef HAVE_LIBGEN_H
|
|
32 #include <libgen.h>
|
|
33 #endif
|
|
34
|
428
|
35 #include <errno.h>
|
|
36
|
442
|
37 #ifndef WIN32_NATIVE
|
573
|
38 # include <sys/errno.h> /* <errno.h> does not always imply this */
|
428
|
39 #endif
|
|
40
|
|
41 #ifdef HAVE_UNISTD_H
|
558
|
42 # include <unistd.h>
|
428
|
43 #endif
|
|
44
|
|
45 #ifndef INCLUDED_FCNTL
|
|
46 # define INCLUDED_FCNTL
|
|
47 # include <fcntl.h>
|
|
48 #endif /* INCLUDED_FCNTL */
|
|
49
|
558
|
50 /* The anonymous voice of the past says:
|
428
|
51 In some systems loading it twice is suicidal. */
|
558
|
52 #ifndef INCLUDED_SYS_TYPES
|
|
53 # define INCLUDED_SYS_TYPES
|
|
54 # include <sys/types.h> /* some typedefs are used in sys/file.h */
|
|
55 #endif /* INCLUDED_SYS_TYPES */
|
442
|
56
|
|
57 #ifndef WIN32_NATIVE
|
558
|
58 # include <sys/file.h>
|
442
|
59 #endif
|
|
60
|
1467
|
61 /* Some systems (SCO 3.2v5) do #define stat ... in this header. So it
|
|
62 _must_ be included before any use of struct stat. Most emacs files
|
|
63 should include sysfile.h. The unex*.c include <sys/stat.h> directly. */
|
428
|
64 #include <sys/stat.h>
|
442
|
65
|
1315
|
66 #ifdef WIN32_ANY
|
558
|
67 # include <io.h>
|
|
68 #endif
|
|
69
|
|
70 #ifdef WIN32_NATIVE
|
|
71 # include <direct.h>
|
|
72 #else
|
442
|
73 /* Some configuration files' definitions for the LOAD_AVE_CVT macro
|
|
74 (like sparc.h's) use macros like FSCALE, defined here. */
|
558
|
75 # ifdef HAVE_GTK
|
462
|
76 /* I hate GTK */
|
558
|
77 # undef MIN
|
|
78 # undef MAX
|
|
79 # endif /* HAVE_GTK */
|
|
80 # include <sys/param.h>
|
609
|
81 /* As per Martin's recommendation, we do not include this. There was
|
|
82 a comment stating that stuff from here was needed on NeXT, Cygwin,
|
|
83 and sunplay.c. However, Cygwin includes this automatically from
|
|
84 fcntl.h, and Martin says that a "conforming" system should never
|
|
85 need this. We will put it back if necessary on systems requiring it. */
|
|
86 /* # include <sys/fcntl.h> */
|
777
|
87 #endif /* WIN32_NATIVE */
|
428
|
88
|
|
89 #ifndef STDERR_FILENO
|
|
90 #define STDIN_FILENO 0
|
|
91 #define STDOUT_FILENO 1
|
|
92 #define STDERR_FILENO 2
|
|
93 #endif
|
|
94
|
|
95 #ifndef O_RDONLY
|
|
96 #define O_RDONLY 0
|
|
97 #endif
|
|
98
|
|
99 #ifndef O_WRONLY
|
|
100 #define O_WRONLY 1
|
|
101 #endif
|
|
102
|
|
103 #ifndef O_RDWR
|
|
104 #define O_RDWR 2
|
|
105 #endif
|
|
106
|
|
107 /* file opening defaults */
|
|
108 #ifndef OPEN_BINARY
|
|
109 #ifdef O_BINARY
|
|
110 #define OPEN_BINARY O_BINARY
|
|
111 #else
|
|
112 #define OPEN_BINARY (0)
|
|
113 #endif
|
|
114 #endif
|
|
115
|
|
116 #ifndef OPEN_TEXT
|
|
117 #ifdef O_TEXT
|
|
118 #define OPEN_TEXT O_TEXT
|
|
119 #else
|
|
120 #define OPEN_TEXT (0)
|
|
121 #endif
|
|
122 #endif
|
|
123
|
|
124 #ifndef CREAT_MODE
|
442
|
125 #ifdef WIN32_NATIVE
|
428
|
126 #define CREAT_MODE (S_IREAD | S_IWRITE)
|
|
127 #else
|
|
128 #define CREAT_MODE (0666)
|
|
129 #endif
|
|
130 #endif
|
|
131
|
|
132 #ifndef READ_TEXT
|
|
133 #ifdef O_TEXT
|
|
134 #define READ_TEXT "rt"
|
|
135 #else
|
|
136 #define READ_TEXT "r"
|
|
137 #endif
|
|
138 #endif
|
|
139
|
|
140 #ifndef READ_BINARY
|
|
141 #ifdef O_BINARY
|
|
142 #define READ_BINARY "rb"
|
|
143 #else
|
|
144 #define READ_BINARY "r"
|
|
145 #endif
|
|
146 #endif
|
|
147
|
442
|
148 #ifndef READ_PLUS_TEXT
|
|
149 #ifdef O_TEXT
|
|
150 #define READ_PLUS_TEXT "r+t"
|
|
151 #else
|
|
152 #define READ_PLUS_TEXT "r+"
|
|
153 #endif
|
|
154 #endif
|
|
155
|
|
156 #ifndef READ_PLUS_BINARY
|
|
157 #ifdef O_BINARY
|
|
158 #define READ_PLUS_BINARY "r+b"
|
|
159 #else
|
|
160 #define READ_PLUS_BINARY "r+"
|
|
161 #endif
|
|
162 #endif
|
|
163
|
|
164 #ifndef WRITE_TEXT
|
|
165 #ifdef O_TEXT
|
|
166 #define WRITE_TEXT "wt"
|
|
167 #else
|
|
168 #define WRITE_TEXT "w"
|
|
169 #endif
|
|
170 #endif
|
|
171
|
428
|
172 #ifndef WRITE_BINARY
|
|
173 #ifdef O_BINARY
|
|
174 #define WRITE_BINARY "wb"
|
|
175 #else
|
|
176 #define WRITE_BINARY "w"
|
|
177 #endif
|
|
178 #endif
|
|
179
|
771
|
180 #ifndef APPEND_TEXT
|
|
181 #ifdef O_TEXT
|
|
182 #define APPEND_TEXT "at"
|
|
183 #else
|
|
184 #define APPEND_TEXT "a"
|
|
185 #endif
|
|
186 #endif
|
|
187
|
|
188 #ifndef APPEND_BINARY
|
|
189 #ifdef O_BINARY
|
|
190 #define APPEND_BINARY "ab"
|
|
191 #else
|
|
192 #define APPEND_BINARY "a"
|
|
193 #endif
|
|
194 #endif
|
|
195
|
428
|
196 #ifndef O_NONBLOCK
|
|
197 #ifdef O_NDELAY
|
|
198 #define O_NONBLOCK O_NDELAY
|
|
199 #else
|
|
200 #define O_NONBLOCK 04000
|
|
201 #endif
|
|
202 #endif
|
|
203
|
|
204 #if !S_IRUSR
|
|
205 # if S_IREAD
|
|
206 # define S_IRUSR S_IREAD
|
|
207 # else
|
|
208 # define S_IRUSR 00400
|
|
209 # endif
|
|
210 #endif
|
|
211
|
|
212 #if !S_IWUSR
|
|
213 # if S_IWRITE
|
|
214 # define S_IWUSR S_IWRITE
|
|
215 # else
|
|
216 # define S_IWUSR 00200
|
|
217 # endif
|
|
218 #endif
|
|
219
|
|
220 #if !S_IXUSR
|
|
221 # if S_IEXEC
|
|
222 # define S_IXUSR S_IEXEC
|
|
223 # else
|
|
224 # define S_IXUSR 00100
|
|
225 # endif
|
|
226 #endif
|
|
227
|
|
228 #ifdef STAT_MACROS_BROKEN
|
|
229 #undef S_ISBLK
|
|
230 #undef S_ISCHR
|
|
231 #undef S_ISDIR
|
|
232 #undef S_ISFIFO
|
|
233 #undef S_ISLNK
|
|
234 #undef S_ISMPB
|
|
235 #undef S_ISMPC
|
|
236 #undef S_ISNWK
|
|
237 #undef S_ISREG
|
|
238 #undef S_ISSOCK
|
|
239 #endif /* STAT_MACROS_BROKEN. */
|
|
240
|
|
241 #if !defined(S_ISBLK) && defined(S_IFBLK)
|
|
242 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
|
|
243 #endif
|
|
244 #if !defined(S_ISCHR) && defined(S_IFCHR)
|
|
245 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
|
|
246 #endif
|
|
247 #if !defined(S_ISDIR) && defined(S_IFDIR)
|
|
248 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
|
|
249 #endif
|
|
250 #if !defined(S_ISREG) && defined(S_IFREG)
|
|
251 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
|
|
252 #endif
|
|
253 #if !defined(S_ISFIFO) && defined(S_IFIFO)
|
|
254 #define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
|
|
255 #endif
|
|
256 #if !defined(S_ISLNK) && defined(S_IFLNK)
|
|
257 #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
|
|
258 #endif
|
|
259 #if !defined(S_ISSOCK) && defined(S_IFSOCK)
|
|
260 #define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
|
|
261 #endif
|
|
262 #if !defined(S_ISMPB) && defined(S_IFMPB) /* V7 */
|
|
263 #define S_ISMPB(m) (((m) & S_IFMT) == S_IFMPB)
|
|
264 #define S_ISMPC(m) (((m) & S_IFMT) == S_IFMPC)
|
|
265 #endif
|
|
266 #if !defined(S_ISNWK) && defined(S_IFNWK) /* HP/UX */
|
|
267 #define S_ISNWK(m) (((m) & S_IFMT) == S_IFNWK)
|
|
268 #endif
|
|
269
|
2421
|
270 /* Determining the maximum pathname length.
|
|
271
|
|
272 NOTE: IN GENERAL, YOU SHOULD NOT USE THIS.
|
|
273 If at all possible, avoid using fixed-length buffers of any sort.
|
|
274 You cannot guarantee on many systems that pathnames won't exceed
|
|
275 these limits for one reason or another.
|
|
276
|
|
277 Unfortunately, there is no universal agreement over whether these
|
|
278 values should include a final null-terminator or not. Even recent
|
|
279 versions of Linux (circa 2002) are switching from the not-including-
|
|
280 terminator kind to the including-terminator kind. So we assume that
|
|
281 the including-terminator kind will be even (usually is), and round
|
|
282 up as necessary. */
|
|
283
|
|
284 #define ROUND_UP_TO_EVEN_NUMBER(val) (((val + 1) >> 1) << 1)
|
|
285 #ifdef PATH_MAX
|
|
286 # define QXE_PATH_MAX ROUND_UP_TO_EVEN_NUMBER (PATH_MAX)
|
|
287 #elif defined (_MAX_PATH)
|
558
|
288 /* MS Win -- and preferable to _POSIX_PATH_MAX, which is also defined */
|
2421
|
289 # define QXE_PATH_MAX ROUND_UP_TO_EVEN_NUMBER (_MAX_PATH)
|
|
290 #elif defined (_POSIX_PATH_MAX)
|
|
291 # define QXE_PATH_MAX ROUND_UP_TO_EVEN_NUMBER (_POSIX_PATH_MAX)
|
|
292 #elif defined (MAXPATHLEN)
|
|
293 # define QXE_PATH_MAX ROUND_UP_TO_EVEN_NUMBER (MAXPATHLEN)
|
|
294 #else
|
|
295 # define QXE_PATH_MAX 1024
|
442
|
296 #endif
|
|
297
|
2421
|
298 /* Client .c files should use PATH_MAX_INTERNAL or PATH_MAX_EXTERNAL
|
|
299 if they must use either one at all. */
|
|
300
|
|
301 /* Use for internally formatted text, which can potentially have up to
|
|
302 four bytes per character */
|
|
303 #define PATH_MAX_INTERNAL (QXE_PATH_MAX * MAX_ICHAR_LEN)
|
|
304 /* Use for externally formatted text. */
|
|
305 #define PATH_MAX_EXTERNAL (QXE_PATH_MAX * MAX_XETCHAR_SIZE)
|
|
306
|
442
|
307 /* The following definitions are needed under Windows, at least */
|
|
308 #ifndef X_OK
|
|
309 # define X_OK 1
|
|
310 #endif
|
428
|
311
|
442
|
312 #ifndef R_OK
|
|
313 # define R_OK 4
|
|
314 #endif
|
|
315
|
771
|
316 #ifndef D_OK
|
|
317 # define D_OK 8
|
|
318 #endif
|
|
319
|
442
|
320 #ifndef W_OK
|
|
321 # define W_OK 2
|
|
322 #endif
|
|
323
|
|
324 #ifndef F_OK
|
|
325 # define F_OK 0
|
428
|
326 #endif
|
|
327
|
|
328 #ifndef FD_CLOEXEC
|
|
329 # define FD_CLOEXEC 1
|
|
330 #endif
|
|
331
|
771
|
332 #ifdef emacs
|
|
333
|
428
|
334 /* Emacs needs to use its own definitions of certain system calls on
|
|
335 some systems (like SunOS 4.1 and USG systems, where the read system
|
|
336 call is interruptible but Emacs expects it not to be; and under
|
|
337 MULE, where all filenames need to be converted to external format).
|
|
338
|
771
|
339 We used to play preprocessor games, but in the long run that just leads
|
|
340 you to ruin. So we explicitly put in the new calls, even if the source
|
|
341 gets marginally less pretty.
|
428
|
342
|
771
|
343 Current files where we don't use retry_ or qxe_ versions:
|
428
|
344
|
771
|
345 -- all sound files except ntplay.c (includes esd.c libsst.[ch] libst.h
|
|
346 linuxplay.c sgiplay.c sunplay.c
|
|
347 hpplay.c nas.c)
|
|
348 -- all unex* files
|
|
349 -- hftctl.c
|
|
350 -- lib-src files
|
|
351 */
|
428
|
352
|
771
|
353 ssize_t retry_read (int, void *, size_t);
|
|
354 ssize_t retry_write (int, const void *, size_t);
|
|
355 int retry_open (const Extbyte *path, int oflag, ...);
|
867
|
356 int qxe_open (const Ibyte *path, int oflag, ...);
|
|
357 int qxe_interruptible_open (const Ibyte *path, int oflag, int mode);
|
771
|
358 int retry_close (int);
|
|
359 Bytecount read_allowing_quit (int fildes, void *buf, Bytecount size);
|
|
360 Bytecount write_allowing_quit (int fildes, const void *buf,
|
|
361 Bytecount size);
|
428
|
362
|
|
363 /* Now the stdio versions ... */
|
|
364
|
771
|
365 size_t retry_fread (void *, size_t, size_t, FILE *);
|
|
366 size_t retry_fwrite (const void *, size_t, size_t, FILE *);
|
2367
|
367 FILE *retry_fopen (const Extbyte *path, const Ascbyte *mode);
|
|
368 FILE *qxe_fopen (const Ibyte *path, const Ascbyte *mode);
|
771
|
369 int retry_fclose (FILE *);
|
428
|
370
|
|
371 /* encapsulations: file-information calls */
|
|
372
|
867
|
373 int qxe_access (const Ibyte *path, int mode);
|
|
374 int qxe_eaccess (const Ibyte *path, int mode);
|
|
375 int qxe_lstat (const Ibyte *path, struct stat *buf);
|
|
376 int qxe_readlink (const Ibyte *path, Ibyte *buf, size_t bufsiz);
|
771
|
377 int qxe_fstat (int fd, struct stat *buf);
|
867
|
378 int qxe_stat (const Ibyte *path, struct stat *buf);
|
|
379 Ibyte *qxe_realpath (const Ibyte *path, Ibyte resolved_path []);
|
428
|
380
|
|
381 /* encapsulations: file-manipulation calls */
|
|
382
|
867
|
383 int qxe_chmod (const Ibyte *path, mode_t mode);
|
771
|
384
|
|
385 #if defined (HAVE_LINK)
|
867
|
386 int qxe_link (const Ibyte *existing, const Ibyte *new);
|
771
|
387 #endif /* defined (HAVE_LINK) */
|
|
388
|
867
|
389 int qxe_rename (const Ibyte *old, const Ibyte *new);
|
771
|
390
|
|
391 #if defined (HAVE_SYMLINK)
|
867
|
392 int qxe_symlink (const Ibyte *name1, const Ibyte *name2);
|
771
|
393 #endif /* defined (HAVE_SYMLINK) */
|
|
394
|
867
|
395 int qxe_unlink (const Ibyte *path);
|
771
|
396
|
1467
|
397 /* definition in filemode.c
|
|
398 must be declared here to ensure that struct stat is properly formed
|
|
399 on systems like SCO 3.2v5 */
|
|
400 void filemodestring (struct stat *, char *);
|
|
401
|
771
|
402 #endif /* emacs */
|
|
403
|
|
404
|
|
405 #ifndef HAVE_H_ERRNO
|
|
406 extern int h_errno;
|
428
|
407 #endif
|
|
408
|
771
|
409 #ifndef HAVE_DUP2
|
|
410 int dup2 (int oldd, int newd);
|
428
|
411 #endif
|
|
412
|
771
|
413 #ifndef HAVE_STRERROR
|
|
414 /* X11R6 defines strerror as a macro */
|
|
415 # ifdef strerror
|
|
416 # undef strerror
|
|
417 # endif
|
|
418 const char *strerror (int);
|
428
|
419 #endif
|
|
420
|
771
|
421
|
|
422
|
|
423 /*
|
|
424 DEFAULT_DIRECTORY_SEP is the default value of Vdirectory_sep_char.
|
|
425 DIRECTORY_SEP is the currently preferred separator between elements
|
|
426 of a path, when paths are canonicalized.
|
|
427 DEVICE_SEP is the separator between devices and paths (might not
|
|
428 be defined).
|
|
429 SEPCHAR is the separator between paths in a path search string
|
|
430 (e.g. the PATH environment variable).
|
|
431 IS_DIRECTORY_SEP() returns true if the character is any directory
|
|
432 separator (there might be more than one allowed on a system.).
|
|
433 IS_DEVICE_SEP() returns true if the character is a device separator.
|
|
434 IS_ANY_SEP() returns true if the character is a directory or device
|
|
435 separator.
|
|
436 */
|
|
437
|
|
438 #ifdef emacs
|
428
|
439
|
771
|
440 /* We used to put some of this stuff in the s+m files for the various
|
|
441 types of MS Windows, but that's disingenuous. The various definitions
|
|
442 above were specifically created for MS Windows, and the "if not, then
|
|
443 let's define the defaults" stuff (formerly in lisp.h) specifically knows
|
|
444 about what is going to get redefined and how, and code all over the
|
|
445 place that works with filenames has to conditionalize on WIN32_NATIVE
|
|
446 anyway. It's much clearer if we put all related definitions in one
|
|
447 place. (In fact, I discovered a number of bugs in the process.)
|
|
448
|
|
449 S+M files should be used for simple on-off or multiple-choice settings,
|
|
450 or possibly string settings. Anything that gets to the level of
|
|
451 programming should be elsewhere, and anything that ends up having
|
|
452 lots of complicated interactions scattered around in many files should
|
|
453 be consolidated. */
|
|
454
|
|
455 #ifdef WIN32_NATIVE
|
|
456
|
|
457 #define SEPCHAR ';'
|
|
458 #define DEFAULT_DIRECTORY_SEP '\\'
|
428
|
459
|
867
|
460 DECLARE_INLINE_HEADER (Ibyte sysfile_get_directory_sep (void))
|
771
|
461 {
|
|
462 if (!CHARP (Vdirectory_sep_char)
|
|
463 || (XCHAR (Vdirectory_sep_char) != '/'
|
|
464 && XCHAR (Vdirectory_sep_char) != '\\'))
|
|
465 {
|
|
466 warn_when_safe
|
|
467 (Qfile_name, Qerror,
|
|
468 "`directory-sep-char' set to invalid %s: resetting to %c.",
|
|
469 DEFAULT_DIRECTORY_SEP);
|
|
470 Vdirectory_sep_char = make_char (DEFAULT_DIRECTORY_SEP);
|
|
471 }
|
|
472
|
|
473 return XCHAR (Vdirectory_sep_char);
|
|
474 }
|
|
475 #define DIRECTORY_SEP sysfile_get_directory_sep()
|
|
476
|
|
477 #else /* not WIN32_NATIVE */
|
|
478
|
|
479 #define SEPCHAR ':'
|
|
480 #define DEFAULT_DIRECTORY_SEP '/'
|
|
481 #define DIRECTORY_SEP '/'
|
|
482
|
|
483 #endif /* WIN32_NATIVE */
|
|
484
|
428
|
485
|
1315
|
486 #ifdef WIN32_ANY
|
771
|
487
|
|
488 #define DEVICE_SEP ':'
|
|
489
|
|
490 #define IS_DEVICE_SEP(c) ((c) == DEVICE_SEP)
|
|
491
|
867
|
492 DECLARE_INLINE_HEADER (int IS_DIRECTORY_SEP (Ichar c))
|
771
|
493 {
|
|
494 return (c == '/' || c == '\\');
|
|
495 }
|
|
496
|
867
|
497 DECLARE_INLINE_HEADER (int IS_ANY_SEP (Ichar c))
|
771
|
498 {
|
|
499 return (c == '/' || c == '\\' || c == ':');
|
|
500 }
|
|
501
|
1315
|
502 #else /* not WIN32_ANY */
|
771
|
503
|
|
504 #define IS_DEVICE_SEP(c) 0
|
|
505 #define IS_DIRECTORY_SEP(c) ((c) == DIRECTORY_SEP)
|
|
506 #define IS_ANY_SEP(c) IS_DIRECTORY_SEP (c)
|
|
507
|
1315
|
508 #endif /* WIN32_ANY */
|
771
|
509
|
|
510 #endif /* emacs */
|
|
511
|
440
|
512 #endif /* INCLUDED_sysfile_h_ */
|