2 * uce-dirent.h - operating system independent dirent implementation
4 * Copyright (C) 1998-2002 Toni Ronkko
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * ``Software''), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 * IN NO EVENT SHALL TONI RONKKO BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
26 * May 28 1998, Toni Ronkko <tronkko@messi.uku.fi>
28 * $Id: uce-dirent.h,v 1.7 2002/05/13 10:48:35 tr Exp $
30 * $Log: uce-dirent.h,v $
31 * Revision 1.7 2002/05/13 10:48:35 tr
32 * embedded some source code directly to the header so that no source
33 * modules need to be included in the MS Visual C project using the
34 * interface, removed all the dependencies to other headers of the `uce'
35 * library so that the header can be made public
37 * Revision 1.6 2002/04/12 16:22:04 tr
38 * Unified Compiling Environment (UCE) replaced `std' library
40 * Revision 1.5 2001/07/20 16:33:40 tr
41 * moved to `std' library and re-named defines accordingly
43 * Revision 1.4 2001/07/10 16:47:18 tronkko
46 * Revision 1.3 2001/01/11 13:16:43 tr
47 * using ``uce-machine.h'' for finding out defines such as `FREEBSD'
49 * Revision 1.2 2000/10/08 16:00:41 tr
50 * copy of FreeBSD man page
52 * Revision 1.1 2000/07/10 05:53:16 tr
55 * Revision 1.2 1998/07/19 18:29:14 tr
56 * Added error reporting capabilities and some asserts.
58 * Revision 1.1 1998/07/04 16:27:51 tr
62 * MSVC 1.0 scans automatic dependencies incorrectly when your project
63 * contains this very header. The problem is that MSVC cannot handle
64 * include directives inside #if..#endif block those are never entered.
65 * Since this header ought to compile in many different operating systems,
66 * there had to be several conditional blocks that are compiled only in
67 * operating systems for what they were designed for. MSVC 1.0 cannot
68 * handle inclusion of sys/dir.h in a part that is compiled only in Apollo
69 * operating system. To fix the problem you need to insert DIR.H into
70 * SYSINCL.DAT located in MSVC\BIN directory and restart visual C++.
71 * Consult manuals for more informaton about the problem.
73 * Since many UNIX systems have dirent.h we assume to have one also.
74 * However, if your UNIX system does not have dirent.h you can download one
75 * for example at: http://ftp.uni-mannheim.de/ftp/GNU/dirent/dirent.tar.gz.
76 * You can also see if you have one of dirent.h, direct.h, dir.h, ndir.h,
77 * sys/dir.h and sys/ndir.h somewhere. Try defining HAVE_DIRENT_H,
78 * HAVE_DIRECT_H, HAVE_DIR_H, HAVE_NDIR_H, HAVE_SYS_DIR_H and
79 * HAVE_SYS_NDIR_H according to the files found.
83 #define DIRENT_H_INCLUDED
85 /* find out platform */
86 #if defined(MSDOS) /* MS-DOS */
87 #elif defined(__MSDOS__) /* Turbo C/Borland */
89 #elif defined(__DOS__) /* Watcom */
93 #if defined(WIN32) /* MS-Windows */
94 #elif defined(__NT__) /* Watcom */
96 #elif defined(_WIN32) /* Microsoft */
98 #elif defined(__WIN32__) /* Borland */
103 * See what kind of dirent interface we have unless autoconf has already
106 #if !defined(HAVE_DIRENT_H) && !defined(HAVE_DIRECT_H) && !defined(HAVE_SYS_DIR_H) && !defined(HAVE_NDIR_H) && !defined(HAVE_SYS_NDIR_H) && !defined(HAVE_DIR_H)
107 # if defined(_MSC_VER) /* Microsoft C/C++ */
109 # elif defined(__MINGW32__) /* MinGW */
111 # elif defined(__BORLANDC__) /* Borland C/C++ */
112 # define HAVE_DIRENT_H
113 # define VOID_CLOSEDIR
114 # elif defined(__TURBOC__) /* Borland Turbo C */
116 # elif defined(__WATCOMC__) /* Watcom C/C++ */
117 # define HAVE_DIRECT_H
118 # elif defined(__apollo) /* Apollo */
119 # define HAVE_SYS_DIR_H
120 # elif defined(__hpux) /* HP-UX */
121 # define HAVE_DIRENT_H
122 # elif defined(__alpha) || defined(__alpha__) /* Alpha OSF1 */
123 # error "not implemented"
124 # elif defined(__sgi) /* Silicon Graphics */
125 # define HAVE_DIRENT_H
126 # elif defined(sun) || defined(_sun) /* Sun Solaris */
127 # define HAVE_DIRENT_H
128 # elif defined(__FreeBSD__) /* FreeBSD */
129 # define HAVE_DIRENT_H
130 # elif defined(__linux__) /* Linux */
131 # define HAVE_DIRENT_H
132 # elif defined(__GNUC__) /* GNU C/C++ */
133 # define HAVE_DIRENT_H
135 # error "not implemented"
139 /* include proper interface headers */
140 #if defined(HAVE_DIRENT_H)
143 # define NAMLEN(dp) ((int)((dp)->d_namlen))
145 # define NAMLEN(dp) ((int)(strlen((dp)->d_name)))
148 #elif defined(HAVE_NDIR_H)
150 # define NAMLEN(dp) ((int)((dp)->d_namlen))
152 #elif defined(HAVE_SYS_NDIR_H)
153 # include <sys/ndir.h>
154 # define NAMLEN(dp) ((int)((dp)->d_namlen))
156 #elif defined(HAVE_DIRECT_H)
158 # define NAMLEN(dp) ((int)((dp)->d_namlen))
160 #elif defined(HAVE_DIR_H)
162 # define NAMLEN(dp) ((int)((dp)->d_namlen))
164 #elif defined(HAVE_SYS_DIR_H)
165 # include <sys/types.h>
166 # include <sys/dir.h>
168 # define dirent direct
170 # define NAMLEN(dp) ((int)((dp)->d_namlen))
172 #elif defined(MSDOS) || defined(WIN32)
174 /* figure out type of underlaying directory interface to be used */
176 # define DIRENT_WIN32_INTERFACE
177 # elif defined(MSDOS)
178 # define DIRENT_MSDOS_INTERFACE
180 # error "missing native dirent interface"
183 /*** WIN32 specifics ***/
184 # if defined(DIRENT_WIN32_INTERFACE)
185 # include <windows.h>
186 # if !defined(DIRENT_MAXNAMLEN)
187 # define DIRENT_MAXNAMLEN (MAX_PATH)
191 /*** MS-DOS specifics ***/
192 # elif defined(DIRENT_MSDOS_INTERFACE)
195 /* Borland defines file length macros in dir.h */
196 # if defined(__BORLANDC__)
198 # if !defined(DIRENT_MAXNAMLEN)
199 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
201 # if !defined(_find_t)
202 # define _find_t find_t
205 /* Turbo C defines ffblk structure in dir.h */
206 # elif defined(__TURBOC__)
208 # if !defined(DIRENT_MAXNAMLEN)
209 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
211 # define DIRENT_USE_FFBLK
214 # elif defined(_MSC_VER)
215 # if !defined(DIRENT_MAXNAMLEN)
216 # define DIRENT_MAXNAMLEN (12)
220 # elif defined(__WATCOMC__)
221 # if !defined(DIRENT_MAXNAMLEN)
222 # if defined(__OS2__) || defined(__NT__)
223 # define DIRENT_MAXNAMLEN (255)
225 # define DIRENT_MAXNAMLEN (12)
232 /*** generic MS-DOS and MS-Windows stuff ***/
233 # if !defined(NAME_MAX) && defined(DIRENT_MAXNAMLEN)
234 # define NAME_MAX DIRENT_MAXNAMLEN
236 # if NAME_MAX < DIRENT_MAXNAMLEN
237 # error "assertion failed: NAME_MAX >= DIRENT_MAXNAMLEN"
242 * Substitute for real dirent structure. Note that `d_name' field is a
243 * true character array although we have it copied in the implementation
244 * dependent data. We could save some memory if we had declared `d_name'
245 * as a pointer referring the name within implementation dependent data.
246 * We have not done that since some code may rely on sizeof(d_name) to be
247 * something other than four. Besides, directory entries are typically so
248 * small that it takes virtually no time to copy them from place to place.
250 typedef struct dirent {
251 char d_name[NAME_MAX + 1];
253 /*** Operating system specific part ***/
254 # if defined(DIRENT_WIN32_INTERFACE) /*WIN32*/
255 WIN32_FIND_DATA data;
256 # elif defined(DIRENT_MSDOS_INTERFACE) /*MSDOS*/
257 # if defined(DIRENT_USE_FFBLK)
265 /* DIR substitute structure containing directory name. The name is
266 * essential for the operation of ``rewinndir'' function. */
268 char *dirname; /* directory being scanned */
269 dirent current; /* current entry */
270 int dirent_filled; /* is current un-processed? */
272 /*** Operating system specific part ***/
273 # if defined(DIRENT_WIN32_INTERFACE)
274 HANDLE search_handle;
275 # elif defined(DIRENT_MSDOS_INTERFACE)
283 /* supply prototypes for dirent functions */
284 static DIR *opendir(const char *dirname);
285 static struct dirent *readdir(DIR *dirp);
286 static int closedir(DIR *dirp);
287 static void rewinddir(DIR *dirp);
290 * Implement dirent interface as static functions so that the user does not
291 * need to change his project in any way to use dirent function. With this
292 * it is sufficient to include this very header from source modules using
293 * dirent functions and the functions will be pulled in automatically.
301 /* use ffblk instead of _find_t if requested */
302 #if defined(DIRENT_USE_FFBLK)
303 # define _A_ARCH (FA_ARCH)
304 # define _A_HIDDEN (FA_HIDDEN)
305 # define _A_NORMAL (0)
306 # define _A_RDONLY (FA_RDONLY)
307 # define _A_SUBDIR (FA_DIREC)
308 # define _A_SYSTEM (FA_SYSTEM)
309 # define _A_VOLID (FA_LABEL)
310 # define _dos_findnext(dest) findnext(dest)
311 # define _dos_findfirst(name,flags,dest) findfirst(name,dest,flags)
314 static int _initdir(DIR *p);
315 static const char *_getdirname(const struct dirent *dp);
316 static void _setdirname(struct DIR *dirp);
319 * <function name="opendir">
320 * <intro>open directory stream for reading
321 * <syntax>DIR *opendir (const char *dirname);
323 * <desc>Open named directory stream for read and return pointer to the
324 * internal working area that is used for retrieving individual directory
325 * entries. The internal working area has no fields of your interest.
327 * <ret>Returns a pointer to the internal working area or NULL in case the
328 * directory stream could not be opened. Global `errno' variable will set
329 * in case of error as follows:
332 * [EACESS |Permission denied.
333 * [EMFILE |Too many open files used by the process.
334 * [ENFILE |Too many open files in system.
335 * [ENOENT |Directory does not exist.
336 * [ENOMEM |Insufficient memory.
337 * [ENOTDIR |dirname does not refer to directory. This value is not
338 * reliable on MS-DOS and MS-Windows platforms. Many
339 * implementations return ENOENT even when the name refers to a
344 static DIR *opendir(const char *dirname)
347 assert(dirname != NULL);
349 dirp = (DIR*)malloc(sizeof(struct DIR));
353 /* allocate room for directory name */
354 dirp->dirname = (char*) malloc(strlen(dirname) + 1 + strlen("\\*.*"));
355 if (dirp->dirname == NULL) {
356 /* failed to duplicate directory name. errno set by malloc() */
360 /* Copy directory name while appending directory separator and "*.*".
361 * Directory separator is not appended if the name already ends with
362 * drive or directory separator. Directory separator is assumed to be
363 * '/' or '\' and drive separator is assumed to be ':'. */
364 strcpy(dirp->dirname, dirname);
365 p = strchr(dirp->dirname, '\0');
366 if (dirp->dirname < p &&
367 *(p - 1) != '\\' && *(p - 1) != '/' && *(p - 1) != ':') {
370 # ifdef DIRENT_WIN32_INTERFACE
371 strcpy(p, "*"); /*scan files with and without extension in win32*/
373 strcpy(p, "*.*"); /*scan files with and without extension in DOS*/
377 if (_initdir(dirp) == 0) {
378 /* initialization failed */
389 * <function name="readdir">
390 * <intro>read a directory entry
391 * <syntax>struct dirent *readdir (DIR *dirp);
393 * <desc>Read individual directory entry and return pointer to a structure
394 * containing the name of the entry. Individual directory entries returned
395 * include normal files, sub-directories, pseudo-directories "." and ".."
396 * and also volume labels, hidden files and system files in MS-DOS and
397 * MS-Windows. You might want to use stat(2) function to determinate which
398 * one are you dealing with. Many dirent implementations already contain
399 * equivalent information in dirent structure but you cannot depend on
402 * The dirent structure contains several system dependent fields that
403 * generally have no interest to you. The only interesting one is char
404 * d_name[] that is also portable across different systems. The d_name
405 * field contains the name of the directory entry without leading path.
406 * While d_name is portable across different systems the actual storage
407 * capacity of d_name varies from system to system and there is no portable
408 * way to find out it at compile time as different systems define the
409 * capacity of d_name with different macros and some systems do not define
410 * capacity at all (besides actual declaration of the field). If you really
411 * need to find out storage capacity of d_name then you might want to try
412 * NAME_MAX macro. The NAME_MAX is defined in POSIX standard although
413 * there are many MS-DOS and MS-Windows implementations those do not define
414 * it. There are also systems that declare d_name as "char d_name[1]" and
415 * then allocate suitable amount of memory at run-time. Thanks to Alain
416 * Decamps (Alain.Decamps@advalvas.be) for pointing it out to me.
418 * This all leads to the fact that it is difficult to allocate space
419 * for the directory names when the very same program is being compiled on
420 * number of operating systems. Therefore I suggest that you always
421 * allocate space for directory names dynamically.
424 * Returns a pointer to a structure containing name of the directory entry
425 * in `d_name' field or NULL if there was an error. In case of an error the
426 * global `errno' variable will set as follows:
429 * [EBADF |dir parameter refers to an invalid directory stream. This value
430 * is not set reliably on all implementations.]
434 static struct dirent *
437 assert(dirp != NULL);
443 #if defined(DIRENT_WIN32_INTERFACE)
444 if (dirp->search_handle == INVALID_HANDLE_VALUE) {
445 /* directory stream was opened/rewound incorrectly or it ended normally */
451 if (dirp->dirent_filled != 0) {
453 * Directory entry has already been retrieved and there is no need to
454 * retrieve a new one. Directory entry will be retrieved in advance
455 * when the user calls readdir function for the first time. This is so
456 * because real dirent has separate functions for opening and reading
457 * the stream whereas Win32 and DOS dirents open the stream
458 * automatically when we retrieve the first file. Therefore, we have to
459 * save the first file when opening the stream and later we have to
460 * return the saved entry when the user tries to read the first entry.
462 dirp->dirent_filled = 0;
464 /* fill in entry and return that */
465 #if defined(DIRENT_WIN32_INTERFACE)
466 if (FindNextFile(dirp->search_handle, &dirp->current.data) == FALSE) {
467 /* Last file has been processed or an error occurred */
468 FindClose(dirp->search_handle);
469 dirp->search_handle = INVALID_HANDLE_VALUE;
474 # elif defined(DIRENT_MSDOS_INTERFACE)
475 if (_dos_findnext(&dirp->current.data) != 0) {
476 /* _dos_findnext and findnext will set errno to ENOENT when no
477 * more entries could be retrieved. */
483 assert(dirp->dirent_filled == 0);
485 return &dirp->current;
490 * <function name="closedir">
491 * <intro>close directory stream.
492 * <syntax>int closedir (DIR *dirp);
494 * <desc>Close directory stream opened by the `opendir' function. Close of
495 * directory stream invalidates the DIR structure as well as previously read
498 * <ret>The function typically returns 0 on success and -1 on failure but
499 * the function may be declared to return void on same systems. At least
500 * Borland C/C++ and some UNIX implementations use void as a return type.
501 * The dirent wrapper tries to define VOID_CLOSEDIR whenever closedir is
502 * known to return nothing. The very same definition is made by the GNU
503 * autoconf if you happen to use it.
505 * The global `errno' variable will set to EBADF in case of error.
513 /* make sure that dirp points to legal structure */
514 assert(dirp != NULL);
520 /* free directory name and search handles */
521 if (dirp->dirname != NULL) {
525 #if defined(DIRENT_WIN32_INTERFACE)
526 if (dirp->search_handle != INVALID_HANDLE_VALUE) {
527 if (FindClose(dirp->search_handle) == FALSE) {
535 /* clear dirp structure to make sure that it cannot be used anymore*/
536 memset(dirp, 0, sizeof(*dirp));
537 # if defined(DIRENT_WIN32_INTERFACE)
538 dirp->search_handle = INVALID_HANDLE_VALUE;
547 * <function name="rewinddir">
548 * <intro>rewind directory stream to the beginning
549 * <syntax>void rewinddir (DIR *dirp);
551 * <desc>Rewind directory stream to the beginning so that the next call of
552 * readdir() returns the very first directory entry again. However, note
553 * that next call of readdir() may not return the same directory entry as it
554 * did in first time. The directory stream may have been affected by newly
557 * Almost every dirent implementation ensure that rewinddir will update
558 * the directory stream to reflect any changes made to the directory entries
559 * since the previous ``opendir'' or ``rewinddir'' call. Keep an eye on
560 * this if your program depends on the feature. I know at least one dirent
561 * implementation where you are required to close and re-open the stream to
564 * <ret>Returns nothing. If something went wrong while rewinding, you will
565 * notice it later when you try to retrieve the first directory entry.
570 /* make sure that dirp is legal */
571 assert(dirp != NULL);
576 assert(dirp->dirname != NULL);
578 /* close previous stream */
579 #if defined(DIRENT_WIN32_INTERFACE)
580 if (dirp->search_handle != INVALID_HANDLE_VALUE) {
581 if (FindClose(dirp->search_handle) == FALSE) {
588 /* re-open previous stream */
589 if (_initdir(dirp) == 0) {
590 /* initialization failed but we cannot deal with error. User will notice
591 * error later when she tries to retrieve first directory enty. */
598 * Open native directory stream object and retrieve first file.
599 * Be sure to close previous stream before opening new one.
604 assert(dirp != NULL);
605 assert(dirp->dirname != NULL);
606 dirp->dirent_filled = 0;
608 # if defined(DIRENT_WIN32_INTERFACE)
609 /* Open stream and retrieve first file */
610 dirp->search_handle = FindFirstFile(dirp->dirname, &dirp->current.data);
611 if (dirp->search_handle == INVALID_HANDLE_VALUE) {
612 /* something went wrong but we don't know what. GetLastError() could
613 * give us more information about the error, but then we should map
614 * the error code into errno. */
619 # elif defined(DIRENT_MSDOS_INTERFACE)
620 if (_dos_findfirst(dirp->dirname,
621 _A_SUBDIR | _A_RDONLY | _A_ARCH | _A_SYSTEM | _A_HIDDEN,
622 &dirp->current.data) != 0) {
623 /* _dos_findfirst and findfirst will set errno to ENOENT when no
624 * more entries could be retrieved. */
629 /* initialize DIR and it's first entry */
631 dirp->dirent_filled = 1;
637 * Return implementation dependent name of the current directory entry.
640 _getdirname(const struct dirent *dp)
642 #if defined(DIRENT_WIN32_INTERFACE)
643 return dp->data.cFileName;
645 #elif defined(DIRENT_USE_FFBLK)
646 return dp->data.ff_name;
649 return dp->data.name;
655 * Copy name of implementation dependent directory entry to the d_name field.
658 _setdirname(struct DIR *dirp)
660 /* make sure that d_name is long enough */
661 assert(strlen(_getdirname(&dirp->current)) <= NAME_MAX);
663 strncpy(dirp->current.d_name,
664 _getdirname(&dirp->current),
666 dirp->current.d_name[NAME_MAX] = '\0'; /*char d_name[NAME_MAX+1]*/
672 # define NAMLEN(dp) ((int)(strlen((dp)->d_name)))
675 # error "missing dirent interface"