blob: 6a4c438779eb3f24acd784d6ccf724ed2b108888 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// Dirent.h
//
// = DESCRIPTION
// Define a portable directory-entry manipulation interface.
//
// = AUTHOR
// Douglas C. Schmidt <schmidt@cs.wustl.edu>
//
// ============================================================================
#ifndef ACE_DIRENT_H
#define ACE_DIRENT_H
#include "ace/OS.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
class ACE_Export ACE_Dirent
{
// = TITLE
// Define a portable UNIX directory-entry iterator.
public:
// = Initialization and termination methods.
ACE_Dirent (void);
// Default constructor.
ACE_Dirent (const char *dirname);
// Constructor calls <opendir>
int open (const char *filename);
// Opens the directory named by filename and associates a directory
// stream with it.
~ACE_Dirent (void);
// Destructor calls <closedir>.
void close (void);
// Closes the directory stream and frees the DIR structure.
// = Iterator methods.
dirent *read (void);
// Returns a pointer to a structure representing the directory entry
// at the current position in the directory stream to which dirp
// refers, and positions the directory stream at the next entry,
// except on read-only filesystems. It returns a NULL pointer upon
// reaching the end of the directory stream, or upon detecting an
// invalid location in the directory. <readdir> shall not return
// directory entries containing empty names. It is unspecified
// whether entries are returned for dot or dot-dot. The pointer
// returned by <readdir> points to data that may be overwritten by
// another call to <readdir> on the same directory stream. This
// data shall not be overwritten by another call to <readdir> on a
// different directory stream. <readdir> may buffer several
// directory entries per actual read operation; <readdir> marks for
// update the st_atime field of the directory each time the
// directory is actually read.
int read (struct dirent *entry,
struct dirent **result);
// Has the equivalent functionality as <readdir> except that an
// <entry> and <result> buffer must be supplied by the caller to
// store the result.
// = Manipulators.
long tell (void);
// Returns the current location associated with the directory
// stream.
void seek (long loc);
// Sets the position of the next <readdir> operation on the
// directory stream. The new position reverts to the position
// associated with the directory stream at the time the <telldir>
// operation that provides loc was performed. Values returned by
// <telldir> are good only for the lifetime of the DIR pointer from
// which they are derived. If the directory is closed and then
// reopened, the <telldir> value may be invalidated due to
// undetected directory compaction. It is safe to use a previous
// <telldir> value immediately after a call to <opendir> and before
// any calls to readdir.
void rewind (void);
// Resets the position of the directory stream to the beginning of
// the directory. It also causes the directory stream to refer to
// the current state of the corresponding directory, as a call to
// <opendir> would.
private:
DIR *dirp_;
// Pointer to the directory stream.
};
#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/Dirent.i"
#endif /* ACE_LACKS_INLINE_FUNCTIONS */
#endif /* ACE_DIRENT_H */
|
