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(__BORLANDC__) /* Borland C/C++ */
110 # define HAVE_DIRENT_H
111 # define VOID_CLOSEDIR
112 # elif defined(__TURBOC__) /* Borland Turbo C */
114 # elif defined(__WATCOMC__) /* Watcom C/C++ */
115 # define HAVE_DIRECT_H
116 # elif defined(__apollo) /* Apollo */
117 # define HAVE_SYS_DIR_H
118 # elif defined(__hpux) /* HP-UX */
119 # define HAVE_DIRENT_H
120 # elif defined(__alpha) || defined(__alpha__) /* Alpha OSF1 */
121 # error "not implemented"
122 # elif defined(__sgi) /* Silicon Graphics */
123 # define HAVE_DIRENT_H
124 # elif defined(sun) || defined(_sun) /* Sun Solaris */
125 # define HAVE_DIRENT_H
126 # elif defined(__FreeBSD__) /* FreeBSD */
127 # define HAVE_DIRENT_H
128 # elif defined(__linux__) /* Linux */
129 # define HAVE_DIRENT_H
130 # elif defined(__GNUC__) /* GNU C/C++ */
131 # define HAVE_DIRENT_H
133 # error "not implemented"
137 /* include proper interface headers */
138 #if defined(HAVE_DIRENT_H)
141 # define NAMLEN(dp) ((int)((dp)->d_namlen))
143 # define NAMLEN(dp) ((int)(strlen((dp)->d_name)))
146 #elif defined(HAVE_NDIR_H)
148 # define NAMLEN(dp) ((int)((dp)->d_namlen))
150 #elif defined(HAVE_SYS_NDIR_H)
151 # include <sys/ndir.h>
152 # define NAMLEN(dp) ((int)((dp)->d_namlen))
154 #elif defined(HAVE_DIRECT_H)
156 # define NAMLEN(dp) ((int)((dp)->d_namlen))
158 #elif defined(HAVE_DIR_H)
160 # define NAMLEN(dp) ((int)((dp)->d_namlen))
162 #elif defined(HAVE_SYS_DIR_H)
163 # include <sys/types.h>
164 # include <sys/dir.h>
166 # define dirent direct
168 # define NAMLEN(dp) ((int)((dp)->d_namlen))
170 #elif defined(MSDOS) || defined(WIN32)
172 /* figure out type of underlaying directory interface to be used */
174 # define DIRENT_WIN32_INTERFACE
175 # elif defined(MSDOS)
176 # define DIRENT_MSDOS_INTERFACE
178 # error "missing native dirent interface"
181 /*** WIN32 specifics ***/
182 # if defined(DIRENT_WIN32_INTERFACE)
183 # include <windows.h>
184 # if !defined(DIRENT_MAXNAMLEN)
185 # define DIRENT_MAXNAMLEN (MAX_PATH)
189 /*** MS-DOS specifics ***/
190 # elif defined(DIRENT_MSDOS_INTERFACE)
193 /* Borland defines file length macros in dir.h */
194 # if defined(__BORLANDC__)
196 # if !defined(DIRENT_MAXNAMLEN)
197 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
199 # if !defined(_find_t)
200 # define _find_t find_t
203 /* Turbo C defines ffblk structure in dir.h */
204 # elif defined(__TURBOC__)
206 # if !defined(DIRENT_MAXNAMLEN)
207 # define DIRENT_MAXNAMLEN ((MAXFILE)+(MAXEXT))
209 # define DIRENT_USE_FFBLK
212 # elif defined(_MSC_VER)
213 # if !defined(DIRENT_MAXNAMLEN)
214 # define DIRENT_MAXNAMLEN (12)
218 # elif defined(__WATCOMC__)
219 # if !defined(DIRENT_MAXNAMLEN)
220 # if defined(__OS2__) || defined(__NT__)
221 # define DIRENT_MAXNAMLEN (255)
223 # define DIRENT_MAXNAMLEN (12)
230 /*** generic MS-DOS and MS-Windows stuff ***/
231 # if !defined(NAME_MAX) && defined(DIRENT_MAXNAMLEN)
232 # define NAME_MAX DIRENT_MAXNAMLEN
234 # if NAME_MAX < DIRENT_MAXNAMLEN
235 # error "assertion failed: NAME_MAX >= DIRENT_MAXNAMLEN"
240 * Substitute for real dirent structure. Note that `d_name' field is a
241 * true character array although we have it copied in the implementation
242 * dependent data. We could save some memory if we had declared `d_name'
243 * as a pointer refering the name within implementation dependent data.
244 * We have not done that since some code may rely on sizeof(d_name) to be
245 * something other than four. Besides, directory entries are typically so
246 * small that it takes virtually no time to copy them from place to place.
248 typedef struct dirent {
249 char d_name[NAME_MAX + 1];
251 /*** Operating system specific part ***/
252 # if defined(DIRENT_WIN32_INTERFACE) /*WIN32*/
253 WIN32_FIND_DATA data;
254 # elif defined(DIRENT_MSDOS_INTERFACE) /*MSDOS*/
255 # if defined(DIRENT_USE_FFBLK)
263 /* DIR substitute structure containing directory name. The name is
264 * essential for the operation of ``rewinndir'' function. */
266 char *dirname; /* directory being scanned */
267 dirent current; /* current entry */
268 int dirent_filled; /* is current un-processed? */
270 /*** Operating system specific part ***/
271 # if defined(DIRENT_WIN32_INTERFACE)
272 HANDLE search_handle;
273 # elif defined(DIRENT_MSDOS_INTERFACE)
281 /* supply prototypes for dirent functions */
282 static DIR *opendir (const char *dirname);
283 static struct dirent *readdir (DIR *dirp);
284 static int closedir (DIR *dirp);
285 static void rewinddir (DIR *dirp);
288 * Implement dirent interface as static functions so that the user does not
289 * need to change his project in any way to use dirent function. With this
290 * it is sufficient to include this very header from source modules using
291 * dirent functions and the functions will be pulled in automatically.
299 /* use ffblk instead of _find_t if requested */
300 #if defined(DIRENT_USE_FFBLK)
301 # define _A_ARCH (FA_ARCH)
302 # define _A_HIDDEN (FA_HIDDEN)
303 # define _A_NORMAL (0)
304 # define _A_RDONLY (FA_RDONLY)
305 # define _A_SUBDIR (FA_DIREC)
306 # define _A_SYSTEM (FA_SYSTEM)
307 # define _A_VOLID (FA_LABEL)
308 # define _dos_findnext(dest) findnext(dest)
309 # define _dos_findfirst(name,flags,dest) findfirst(name,dest,flags)
312 static int _initdir (DIR *p);
313 static const char *_getdirname (const struct dirent *dp);
314 static void _setdirname (struct DIR *dirp);
317 * <function name="opendir">
318 * <intro>open directory stream for reading
319 * <syntax>DIR *opendir (const char *dirname);
321 * <desc>Open named directory stream for read and return pointer to the
322 * internal working area that is used for retrieving individual directory
323 * entries. The internal working area has no fields of your interest.
325 * <ret>Returns a pointer to the internal working area or NULL in case the
326 * directory stream could not be opened. Global `errno' variable will set
327 * in case of error as follows:
330 * [EACESS |Permission denied.
331 * [EMFILE |Too many open files used by the process.
332 * [ENFILE |Too many open files in system.
333 * [ENOENT |Directory does not exist.
334 * [ENOMEM |Insufficient memory.
335 * [ENOTDIR |dirname does not refer to directory. This value is not
336 * reliable on MS-DOS and MS-Windows platforms. Many
337 * implementations return ENOENT even when the name refers to a
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) != ':')
371 # ifdef DIRENT_WIN32_INTERFACE
372 strcpy (p, "*"); /*scan files with and without extension in win32*/
374 strcpy (p, "*.*"); /*scan files with and without extension in DOS*/
378 if (_initdir (dirp) == 0) {
379 /* initialization failed */
380 free (dirp->dirname);
390 * <function name="readdir">
391 * <intro>read a directory entry
392 * <syntax>struct dirent *readdir (DIR *dirp);
394 * <desc>Read individual directory entry and return pointer to a structure
395 * containing the name of the entry. Individual directory entries returned
396 * include normal files, sub-directories, pseudo-directories "." and ".."
397 * and also volume labels, hidden files and system files in MS-DOS and
398 * MS-Windows. You might want to use stat(2) function to determinate which
399 * one are you dealing with. Many dirent implementations already contain
400 * equivalent information in dirent structure but you cannot depend on
403 * The dirent structure contains several system dependent fields that
404 * generally have no interest to you. The only interesting one is char
405 * d_name[] that is also portable across different systems. The d_name
406 * field contains the name of the directory entry without leading path.
407 * While d_name is portable across different systems the actual storage
408 * capacity of d_name varies from system to system and there is no portable
409 * way to find out it at compile time as different systems define the
410 * capacity of d_name with different macros and some systems do not define
411 * capacity at all (besides actual declaration of the field). If you really
412 * need to find out storage capacity of d_name then you might want to try
413 * NAME_MAX macro. The NAME_MAX is defined in POSIX standard althought
414 * there are many MS-DOS and MS-Windows implementations those do not define
415 * it. There are also systems that declare d_name as "char d_name[1]" and
416 * then allocate suitable amount of memory at run-time. Thanks to Alain
417 * Decamps (Alain.Decamps@advalvas.be) for pointing it out to me.
419 * This all leads to the fact that it is difficult to allocate space
420 * for the directory names when the very same program is being compiled on
421 * number of operating systems. Therefore I suggest that you always
422 * allocate space for directory names dynamically.
425 * Returns a pointer to a structure containing name of the directory entry
426 * in `d_name' field or NULL if there was an error. In case of an error the
427 * global `errno' variable will set as follows:
430 * [EBADF |dir parameter refers to an invalid directory stream. This value
431 * is not set reliably on all implementations.]
435 static struct dirent *
438 assert (dirp != NULL);
444 #if defined(DIRENT_WIN32_INTERFACE)
445 if (dirp->search_handle == INVALID_HANDLE_VALUE) {
446 /* directory stream was opened/rewound incorrectly or it ended normally */
452 if (dirp->dirent_filled != 0) {
454 * Directory entry has already been retrieved and there is no need to
455 * retrieve a new one. Directory entry will be retrieved in advance
456 * when the user calls readdir function for the first time. This is so
457 * because real dirent has separate functions for opening and reading
458 * the stream whereas Win32 and DOS dirents open the stream
459 * automatically when we retrieve the first file. Therefore, we have to
460 * save the first file when opening the stream and later we have to
461 * return the saved entry when the user tries to read the first entry.
463 dirp->dirent_filled = 0;
465 /* fill in entry and return that */
466 #if defined(DIRENT_WIN32_INTERFACE)
467 if (FindNextFile (dirp->search_handle, &dirp->current.data) == FALSE) {
468 /* Last file has been processed or an error occured */
469 FindClose (dirp->search_handle);
470 dirp->search_handle = INVALID_HANDLE_VALUE;
475 # elif defined(DIRENT_MSDOS_INTERFACE)
476 if (_dos_findnext (&dirp->current.data) != 0) {
477 /* _dos_findnext and findnext will set errno to ENOENT when no
478 * more entries could be retrieved. */
484 assert (dirp->dirent_filled == 0);
486 return &dirp->current;
491 * <function name="closedir">
492 * <intro>close directory stream.
493 * <syntax>int closedir (DIR *dirp);
495 * <desc>Close directory stream opened by the `opendir' function. Close of
496 * directory stream invalidates the DIR structure as well as previously read
499 * <ret>The function typically returns 0 on success and -1 on failure but
500 * the function may be declared to return void on same systems. At least
501 * Borland C/C++ and some UNIX implementations use void as a return type.
502 * The dirent wrapper tries to define VOID_CLOSEDIR whenever closedir is
503 * known to return nothing. The very same definition is made by the GNU
504 * autoconf if you happen to use it.
506 * The global `errno' variable will set to EBADF in case of error.
514 /* make sure that dirp points to legal structure */
515 assert (dirp != NULL);
521 /* free directory name and search handles */
522 if (dirp->dirname != NULL) free (dirp->dirname);
524 #if defined(DIRENT_WIN32_INTERFACE)
525 if (dirp->search_handle != INVALID_HANDLE_VALUE) {
526 if (FindClose (dirp->search_handle) == FALSE) {
534 /* clear dirp structure to make sure that it cannot be used anymore*/
535 memset (dirp, 0, sizeof (*dirp));
536 # if defined(DIRENT_WIN32_INTERFACE)
537 dirp->search_handle = INVALID_HANDLE_VALUE;
546 * <function name="rewinddir">
547 * <intro>rewind directory stream to the beginning
548 * <syntax>void rewinddir (DIR *dirp);
550 * <desc>Rewind directory stream to the beginning so that the next call of
551 * readdir() returns the very first directory entry again. However, note
552 * that next call of readdir() may not return the same directory entry as it
553 * did in first time. The directory stream may have been affected by newly
556 * Almost every dirent implementation ensure that rewinddir will update
557 * the directory stream to reflect any changes made to the directory entries
558 * since the previous ``opendir'' or ``rewinddir'' call. Keep an eye on
559 * this if your program depends on the feature. I know at least one dirent
560 * implementation where you are required to close and re-open the stream to
563 * <ret>Returns nothing. If something went wrong while rewinding, you will
564 * notice it later when you try to retrieve the first directory entry.
567 rewinddir (DIR *dirp)
569 /* make sure that dirp is legal */
570 assert (dirp != NULL);
575 assert (dirp->dirname != NULL);
577 /* close previous stream */
578 #if defined(DIRENT_WIN32_INTERFACE)
579 if (dirp->search_handle != INVALID_HANDLE_VALUE) {
580 if (FindClose (dirp->search_handle) == FALSE) {
587 /* re-open previous stream */
588 if (_initdir (dirp) == 0) {
589 /* initialization failed but we cannot deal with error. User will notice
590 * error later when she tries to retrieve first directory enty. */
597 * Open native directory stream object and retrieve first file.
598 * Be sure to close previous stream before opening new one.
603 assert (dirp != NULL);
604 assert (dirp->dirname != NULL);
605 dirp->dirent_filled = 0;
607 # if defined(DIRENT_WIN32_INTERFACE)
608 /* Open stream and retrieve first file */
609 dirp->search_handle = FindFirstFile (dirp->dirname, &dirp->current.data);
610 if (dirp->search_handle == INVALID_HANDLE_VALUE) {
611 /* something went wrong but we don't know what. GetLastError() could
612 * give us more information about the error, but then we should map
613 * the error code into errno. */
618 # elif defined(DIRENT_MSDOS_INTERFACE)
619 if (_dos_findfirst (dirp->dirname,
620 _A_SUBDIR | _A_RDONLY | _A_ARCH | _A_SYSTEM | _A_HIDDEN,
621 &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) {
659 /* make sure that d_name is long enough */
660 assert (strlen (_getdirname (&dirp->current)) <= NAME_MAX);
662 strncpy (dirp->current.d_name,
663 _getdirname (&dirp->current),
665 dirp->current.d_name[NAME_MAX] = '\0'; /*char d_name[NAME_MAX+1]*/
671 # define NAMLEN(dp) ((int)(strlen((dp)->d_name)))
674 # error "missing dirent interface"