3 * uce-dirent.h - operating system independent dirent implementation
5 * Copyright (C) 1998-2002 Toni Ronkko
7 * Permission is hereby granted, free of charge, to any person obtaining
8 * a copy of this software and associated documentation files (the
9 * ``Software''), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sublicense, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21 * IN NO EVENT SHALL TONI RONKKO BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
27 * May 28 1998, Toni Ronkko <tronkko@messi.uku.fi>
29 * $Id: uce-dirent.h,v 1.7 2002/05/13 10:48:35 tr Exp $
31 * $Log: uce-dirent.h,v $
32 * Revision 1.7 2002/05/13 10:48:35 tr
33 * embedded some source code directly to the header so that no source
34 * modules need to be included in the MS Visual C project using the
35 * interface, removed all the dependencies to other headers of the `uce'
36 * library so that the header can be made public
38 * Revision 1.6 2002/04/12 16:22:04 tr
39 * Unified Compiling Environment (UCE) replaced `std' library
41 * Revision 1.5 2001/07/20 16:33:40 tr
42 * moved to `std' library and re-named defines accordingly
44 * Revision 1.4 2001/07/10 16:47:18 tronkko
47 * Revision 1.3 2001/01/11 13:16:43 tr
48 * using ``uce-machine.h'' for finding out defines such as `FREEBSD'
50 * Revision 1.2 2000/10/08 16:00:41 tr
51 * copy of FreeBSD man page
53 * Revision 1.1 2000/07/10 05:53:16 tr
56 * Revision 1.2 1998/07/19 18:29:14 tr
57 * Added error reporting capabilities and some asserts.
59 * Revision 1.1 1998/07/04 16:27:51 tr
63 * MSVC 1.0 scans automatic dependencies incorrectly when your project
64 * contains this very header. The problem is that MSVC cannot handle
65 * include directives inside #if..#endif block those are never entered.
66 * Since this header ought to compile in many different operating systems,
67 * there had to be several conditional blocks that are compiled only in
68 * operating systems for what they were designed for. MSVC 1.0 cannot
69 * handle inclusion of sys/dir.h in a part that is compiled only in Apollo
70 * operating system. To fix the problem you need to insert DIR.H into
71 * SYSINCL.DAT located in MSVC\BIN directory and restart visual C++.
72 * Consult manuals for more informaton about the problem.
74 * Since many UNIX systems have dirent.h we assume to have one also.
75 * However, if your UNIX system does not have dirent.h you can download one
76 * for example at: http://ftp.uni-mannheim.de/ftp/GNU/dirent/dirent.tar.gz.
77 * You can also see if you have one of dirent.h, direct.h, dir.h, ndir.h,
78 * sys/dir.h and sys/ndir.h somewhere. Try defining HAVE_DIRENT_H,
79 * HAVE_DIRECT_H, HAVE_DIR_H, HAVE_NDIR_H, HAVE_SYS_DIR_H and
80 * HAVE_SYS_NDIR_H according to the files found.
84 #define DIRENT_H_INCLUDED
86 /* find out platform */
87 #if defined(MSDOS) /* MS-DOS */
88 #elif defined(__MSDOS__) /* Turbo C/Borland */
90 #elif defined(__DOS__) /* Watcom */
94 #if defined(WIN32) /* MS-Windows */
95 #elif defined(__NT__) /* Watcom */
97 #elif defined(_WIN32) /* Microsoft */
99 #elif defined(__WIN32__) /* Borland */
104 * See what kind of dirent interface we have unless autoconf has already
107 #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)
108 # if defined(_MSC_VER) /* Microsoft C/C++ */
110 # elif defined(__MINGW32__) /* MinGW */
112 # elif defined(__BORLANDC__) /* Borland C/C++ */
113 # define HAVE_DIRENT_H
114 # define VOID_CLOSEDIR
115 # elif defined(__TURBOC__) /* Borland Turbo C */
117 # elif defined(__WATCOMC__) /* Watcom C/C++ */
118 # define HAVE_DIRECT_H
119 # elif defined(__apollo) /* Apollo */
120 # define HAVE_SYS_DIR_H
121 # elif defined(__hpux) /* HP-UX */
122 # define HAVE_DIRENT_H
123 # elif (defined(__alpha) || defined(__alpha__)) && !defined(__linux__) /* Alpha OSF1 */
124 # error "not implemented"
125 # elif defined(__sgi) /* Silicon Graphics */
126 # define HAVE_DIRENT_H
127 # elif defined(sun) || defined(__sun) /* Sun Solaris */
128 # define HAVE_DIRENT_H
129 # elif defined(__FreeBSD__) /* FreeBSD */
130 # define HAVE_DIRENT_H
131 # elif defined(__linux__) /* Linux */
132 # define HAVE_DIRENT_H
133 # elif defined(__GNUC__) /* GNU C/C++ */
134 # define HAVE_DIRENT_H
136 # error "not implemented"
140 /* include proper interface headers */
141 #if defined(HAVE_DIRENT_H)
144 # define NAMLEN(dp) ((int)((dp)->d_namlen))
146 # define NAMLEN(dp) ((int)(strlen((dp)->d_name)))
149 #elif defined(HAVE_NDIR_H)
151 # define NAMLEN(dp) ((int)((dp)->d_namlen))
153 #elif defined(HAVE_SYS_NDIR_H)
154 # include <sys/ndir.h>
155 # define NAMLEN(dp) ((int)((dp)->d_namlen))
157 #elif defined(HAVE_DIRECT_H)
159 # define NAMLEN(dp) ((int)((dp)->d_namlen))
161 #elif defined(HAVE_DIR_H)
163 # define NAMLEN(dp) ((int)((dp)->d_namlen))
165 #elif defined(HAVE_SYS_DIR_H)
166 # include <sys/types.h>
167 # include <sys/dir.h>
169 # define dirent direct
171 # define NAMLEN(dp) ((int)((dp)->d_namlen))
173 #elif defined(MSDOS) || defined(WIN32)
175 /* figure out type of underlaying directory interface to be used */
177 # define DIRENT_WIN32_INTERFACE
178 # elif defined(MSDOS)
179 # define DIRENT_MSDOS_INTERFACE
181 # error "missing native dirent interface"
184 /*** WIN32 specifics ***/
185 # if defined(DIRENT_WIN32_INTERFACE)
186 # include <windows.h>
187 # if !defined(DIRENT_MAXNAMLEN)
188 # define DIRENT_MAXNAMLEN (MAX_PATH)
192 /*** MS-DOS specifics ***/
193 # elif defined(DIRENT_MSDOS_INTERFACE)
196 /* Borland defines file length macros in dir.h */
197 # if defined(__BORLANDC__)
199 # if !defined(DIRENT_MAXNAMLEN)
200 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
202 # if !defined(_find_t)
203 # define _find_t find_t
206 /* Turbo C defines ffblk structure in dir.h */
207 # elif defined(__TURBOC__)
209 # if !defined(DIRENT_MAXNAMLEN)
210 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
212 # define DIRENT_USE_FFBLK
215 # elif defined(_MSC_VER)
216 # if !defined(DIRENT_MAXNAMLEN)
217 # define DIRENT_MAXNAMLEN (12)
221 # elif defined(__WATCOMC__)
222 # if !defined(DIRENT_MAXNAMLEN)
223 # if defined(__OS2__) || defined(__NT__)
224 # define DIRENT_MAXNAMLEN (255)
226 # define DIRENT_MAXNAMLEN (12)
233 /*** generic MS-DOS and MS-Windows stuff ***/
234 # if !defined(NAME_MAX) && defined(DIRENT_MAXNAMLEN)
235 # define NAME_MAX DIRENT_MAXNAMLEN
237 # if NAME_MAX < DIRENT_MAXNAMLEN
238 # error "assertion failed: NAME_MAX >= DIRENT_MAXNAMLEN"
243 * Substitute for real dirent structure. Note that `d_name' field is a
244 * true character array although we have it copied in the implementation
245 * dependent data. We could save some memory if we had declared `d_name'
246 * as a pointer referring the name within implementation dependent data.
247 * We have not done that since some code may rely on sizeof(d_name) to be
248 * something other than four. Besides, directory entries are typically so
249 * small that it takes virtually no time to copy them from place to place.
251 typedef struct dirent {
252 char d_name[NAME_MAX + 1];
254 /*** Operating system specific part ***/
255 # if defined(DIRENT_WIN32_INTERFACE) /*WIN32*/
256 WIN32_FIND_DATA data;
257 # elif defined(DIRENT_MSDOS_INTERFACE) /*MSDOS*/
258 # if defined(DIRENT_USE_FFBLK)
266 /* DIR substitute structure containing directory name. The name is
267 * essential for the operation of ``rewinndir'' function. */
269 char *dirname; /* directory being scanned */
270 dirent current; /* current entry */
271 int dirent_filled; /* is current un-processed? */
273 /*** Operating system specific part ***/
274 # if defined(DIRENT_WIN32_INTERFACE)
275 HANDLE search_handle;
276 # elif defined(DIRENT_MSDOS_INTERFACE)
284 /* supply prototypes for dirent functions */
285 static DIR *opendir (const char *dirname);
286 static struct dirent *readdir (DIR *dirp);
287 static int closedir (DIR *dirp);
288 static void rewinddir (DIR *dirp);
291 * Implement dirent interface as static functions so that the user does not
292 * need to change his project in any way to use dirent function. With this
293 * it is sufficient to include this very header from source modules using
294 * dirent functions and the functions will be pulled in automatically.
302 /* use ffblk instead of _find_t if requested */
303 #if defined(DIRENT_USE_FFBLK)
304 # define _A_ARCH (FA_ARCH)
305 # define _A_HIDDEN (FA_HIDDEN)
306 # define _A_NORMAL (0)
307 # define _A_RDONLY (FA_RDONLY)
308 # define _A_SUBDIR (FA_DIREC)
309 # define _A_SYSTEM (FA_SYSTEM)
310 # define _A_VOLID (FA_LABEL)
311 # define _dos_findnext(dest) findnext(dest)
312 # define _dos_findfirst(name,flags,dest) findfirst(name,dest,flags)
315 static int _initdir (DIR *p);
316 static const char *_getdirname (const struct dirent *dp);
317 static void _setdirname (struct DIR *dirp);
320 * <function name="opendir">
321 * <intro>open directory stream for reading
322 * <syntax>DIR *opendir (const char *dirname);
324 * <desc>Open named directory stream for read and return pointer to the
325 * internal working area that is used for retrieving individual directory
326 * entries. The internal working area has no fields of your interest.
328 * <ret>Returns a pointer to the internal working area or NULL in case the
329 * directory stream could not be opened. Global `errno' variable will set
330 * in case of error as follows:
333 * [EACESS |Permission denied.
334 * [EMFILE |Too many open files used by the process.
335 * [ENFILE |Too many open files in system.
336 * [ENOENT |Directory does not exist.
337 * [ENOMEM |Insufficient memory.
338 * [ENOTDIR |dirname does not refer to directory. This value is not
339 * reliable on MS-DOS and MS-Windows platforms. Many
340 * implementations return ENOENT even when the name refers to a
345 static DIR *opendir(const char *dirname)
348 assert (dirname != NULL);
350 dirp = (DIR*)malloc (sizeof (struct DIR));
354 /* allocate room for directory name */
355 dirp->dirname = (char*) malloc (strlen (dirname) + 1 + strlen ("\\*.*"));
356 if (dirp->dirname == NULL) {
357 /* failed to duplicate directory name. errno set by malloc() */
361 /* Copy directory name while appending directory separator and "*.*".
362 * Directory separator is not appended if the name already ends with
363 * drive or directory separator. Directory separator is assumed to be
364 * '/' or '\' and drive separator is assumed to be ':'. */
365 strcpy (dirp->dirname, dirname);
366 p = strchr (dirp->dirname, '\0');
367 if (dirp->dirname < p &&
368 *(p - 1) != '\\' && *(p - 1) != '/' && *(p - 1) != ':')
372 # ifdef DIRENT_WIN32_INTERFACE
373 strcpy (p, "*"); /*scan files with and without extension in win32*/
375 strcpy (p, "*.*"); /*scan files with and without extension in DOS*/
379 if (_initdir (dirp) == 0) {
380 /* initialization failed */
381 free (dirp->dirname);
391 * <function name="readdir">
392 * <intro>read a directory entry
393 * <syntax>struct dirent *readdir (DIR *dirp);
395 * <desc>Read individual directory entry and return pointer to a structure
396 * containing the name of the entry. Individual directory entries returned
397 * include normal files, sub-directories, pseudo-directories "." and ".."
398 * and also volume labels, hidden files and system files in MS-DOS and
399 * MS-Windows. You might want to use stat(2) function to determinate which
400 * one are you dealing with. Many dirent implementations already contain
401 * equivalent information in dirent structure but you cannot depend on
404 * The dirent structure contains several system dependent fields that
405 * generally have no interest to you. The only interesting one is char
406 * d_name[] that is also portable across different systems. The d_name
407 * field contains the name of the directory entry without leading path.
408 * While d_name is portable across different systems the actual storage
409 * capacity of d_name varies from system to system and there is no portable
410 * way to find out it at compile time as different systems define the
411 * capacity of d_name with different macros and some systems do not define
412 * capacity at all (besides actual declaration of the field). If you really
413 * need to find out storage capacity of d_name then you might want to try
414 * NAME_MAX macro. The NAME_MAX is defined in POSIX standard although
415 * there are many MS-DOS and MS-Windows implementations those do not define
416 * it. There are also systems that declare d_name as "char d_name[1]" and
417 * then allocate suitable amount of memory at run-time. Thanks to Alain
418 * Decamps (Alain.Decamps@advalvas.be) for pointing it out to me.
420 * This all leads to the fact that it is difficult to allocate space
421 * for the directory names when the very same program is being compiled on
422 * number of operating systems. Therefore I suggest that you always
423 * allocate space for directory names dynamically.
426 * Returns a pointer to a structure containing name of the directory entry
427 * in `d_name' field or NULL if there was an error. In case of an error the
428 * global `errno' variable will set as follows:
431 * [EBADF |dir parameter refers to an invalid directory stream. This value
432 * is not set reliably on all implementations.]
436 static struct dirent *
439 assert(dirp != NULL);
445 #if defined(DIRENT_WIN32_INTERFACE)
446 if (dirp->search_handle == INVALID_HANDLE_VALUE) {
447 /* directory stream was opened/rewound incorrectly or it ended normally */
453 if (dirp->dirent_filled != 0) {
455 * Directory entry has already been retrieved and there is no need to
456 * retrieve a new one. Directory entry will be retrieved in advance
457 * when the user calls readdir function for the first time. This is so
458 * because real dirent has separate functions for opening and reading
459 * the stream whereas Win32 and DOS dirents open the stream
460 * automatically when we retrieve the first file. Therefore, we have to
461 * save the first file when opening the stream and later we have to
462 * return the saved entry when the user tries to read the first entry.
464 dirp->dirent_filled = 0;
466 /* fill in entry and return that */
467 #if defined(DIRENT_WIN32_INTERFACE)
468 if (FindNextFile (dirp->search_handle, &dirp->current.data) == FALSE) {
469 /* Last file has been processed or an error occurred */
470 FindClose (dirp->search_handle);
471 dirp->search_handle = INVALID_HANDLE_VALUE;
476 # elif defined(DIRENT_MSDOS_INTERFACE)
477 if (_dos_findnext (&dirp->current.data) != 0) {
478 /* _dos_findnext and findnext will set errno to ENOENT when no
479 * more entries could be retrieved. */
485 assert (dirp->dirent_filled == 0);
487 return &dirp->current;
492 * <function name="closedir">
493 * <intro>close directory stream.
494 * <syntax>int closedir (DIR *dirp);
496 * <desc>Close directory stream opened by the `opendir' function. Close of
497 * directory stream invalidates the DIR structure as well as previously read
500 * <ret>The function typically returns 0 on success and -1 on failure but
501 * the function may be declared to return void on same systems. At least
502 * Borland C/C++ and some UNIX implementations use void as a return type.
503 * The dirent wrapper tries to define VOID_CLOSEDIR whenever closedir is
504 * known to return nothing. The very same definition is made by the GNU
505 * autoconf if you happen to use it.
507 * The global `errno' variable will set to EBADF in case of error.
515 /* make sure that dirp points to legal structure */
516 assert (dirp != NULL);
522 /* free directory name and search handles */
523 if (dirp->dirname != NULL) free (dirp->dirname);
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.
568 rewinddir (DIR *dirp)
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)
624 /* _dos_findfirst and findfirst will set errno to ENOENT when no
625 * more entries could be retrieved. */
630 /* initialize DIR and it's first entry */
632 dirp->dirent_filled = 1;
638 * Return implementation dependent name of the current directory entry.
641 _getdirname (const struct dirent *dp)
643 #if defined(DIRENT_WIN32_INTERFACE)
644 return dp->data.cFileName;
646 #elif defined(DIRENT_USE_FFBLK)
647 return dp->data.ff_name;
650 return dp->data.name;
656 * Copy name of implementation dependent directory entry to the d_name field.
659 _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"