Diffstat (limited to 'libopie2/opiecore/ofilenotify.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie2/opiecore/ofilenotify.h | 42 |
1 files changed, 39 insertions, 3 deletions
diff --git a/libopie2/opiecore/ofilenotify.h b/libopie2/opiecore/ofilenotify.h index ea525e9..41ba84d 100644 --- a/libopie2/opiecore/ofilenotify.h +++ b/libopie2/opiecore/ofilenotify.h | |||
@@ -77,120 +77,156 @@ enum OFileNotificationType | |||
77 | Attrib = IN_ATTRIB, | 77 | Attrib = IN_ATTRIB, |
78 | CloseWrite = IN_CLOSE_WRITE, | 78 | CloseWrite = IN_CLOSE_WRITE, |
79 | CloseNoWrite = IN_CLOSE_NOWRITE, | 79 | CloseNoWrite = IN_CLOSE_NOWRITE, |
80 | Open = IN_OPEN, | 80 | Open = IN_OPEN, |
81 | MovedFrom = IN_MOVED_FROM, | 81 | MovedFrom = IN_MOVED_FROM, |
82 | MovedTo = IN_MOVED_TO, | 82 | MovedTo = IN_MOVED_TO, |
83 | DeleteSubdir = IN_DELETE_SUBDIR, | 83 | DeleteSubdir = IN_DELETE_SUBDIR, |
84 | DeleteFile = IN_DELETE_FILE, | 84 | DeleteFile = IN_DELETE_FILE, |
85 | CreateSubdir = IN_CREATE_SUBDIR, | 85 | CreateSubdir = IN_CREATE_SUBDIR, |
86 | CreateFile = IN_CREATE_FILE, | 86 | CreateFile = IN_CREATE_FILE, |
87 | DeleteSelf = IN_DELETE_SELF, | 87 | DeleteSelf = IN_DELETE_SELF, |
88 | Unmount = IN_UNMOUNT, | 88 | Unmount = IN_UNMOUNT, |
89 | _QueueOverflow = IN_Q_OVERFLOW, /* Internal, don't use this in client code */ | 89 | _QueueOverflow = IN_Q_OVERFLOW, /* Internal, don't use this in client code */ |
90 | _Ignored = IN_IGNORED, /* Internal, don't use this in client code */ | 90 | _Ignored = IN_IGNORED, /* Internal, don't use this in client code */ |
91 | }; | 91 | }; |
92 | 92 | ||
93 | /*====================================================================================== | 93 | /*====================================================================================== |
94 | * OFileNotification | 94 | * OFileNotification |
95 | *======================================================================================*/ | 95 | *======================================================================================*/ |
96 | 96 | ||
97 | /** | 97 | /** |
98 | * @brief Represents a file notification | 98 | * @brief Represents a file notification |
99 | * | 99 | * |
100 | * This class allows to watch for events happening to files. | 100 | * This class allows to watch for events happening to files. |
101 | * It uses the inotify kernel interface | 101 | * It uses the inotify linux (2.6.x) kernel interface. |
102 | * | 102 | * |
103 | * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ | 103 | * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ |
104 | * | 104 | * |
105 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> | 105 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> |
106 | * | 106 | * |
107 | **/ | 107 | **/ |
108 | 108 | ||
109 | class OFileNotification : public QObject | 109 | class OFileNotification : public QObject |
110 | { | 110 | { |
111 | Q_OBJECT | 111 | Q_OBJECT |
112 | 112 | ||
113 | public: | 113 | public: |
114 | OFileNotification( QObject* parent = 0, const char* name = 0 ); | 114 | OFileNotification( QObject* parent = 0, const char* name = 0 ); |
115 | ~OFileNotification(); | 115 | ~OFileNotification(); |
116 | /** | 116 | /** |
117 | * This static function calls a slot when an event with @a type happens to file @a path. | 117 | * This static function calls a slot when an event with @a type happens to file @a path. |
118 | * | 118 | * |
119 | * It is very convenient to use this function because you do not need to | 119 | * It is very convenient to use this function because you do not need to |
120 | * bother with a timerEvent or to create a local QTimer object. | 120 | * bother with a timerEvent or to create a local QTimer object. |
121 | * | 121 | * |
122 | * Example: | 122 | * Example: |
123 | * <pre> | 123 | * <pre> |
124 | * | 124 | * |
125 | * #include <opie2/oapplication.h> | 125 | * #include <opie2/oapplication.h> |
126 | * #include <opie2/ofilenotify.h> | 126 | * #include <opie2/ofilenotify.h> |
127 | * using namespace Opie::Core; | 127 | * using namespace Opie::Core; |
128 | * | 128 | * |
129 | * int main( int argc, char **argv ) | 129 | * int main( int argc, char **argv ) |
130 | * { | 130 | * { |
131 | * OApplication a( argc, argv, "File Notification Example" ); | 131 | * OApplication a( argc, argv, "File Notification Example" ); |
132 | * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Create ); | 132 | * OFileNotification::singleShot( "/tmp/quit", &a, SLOT(quit()), Create ); |
133 | * ... // create and show your widgets | 133 | * ... // create and show your widgets |
134 | * return a.exec(); | 134 | * return a.exec(); |
135 | * } | 135 | * } |
136 | * </pre> | 136 | * </pre> |
137 | * | 137 | * |
138 | * This sample program automatically terminates when the file "/tmp/quit" has been created. | 138 | * This sample program automatically terminates when the file "/tmp/quit" has been created. |
139 | * | 139 | * |
140 | * | 140 | * |
141 | * The @a receiver is the receiving object and the @a member is the slot. | 141 | * The @a receiver is the receiving object and the @a member is the slot. |
142 | **/ | 142 | **/ |
143 | static void singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify ); | 143 | static bool singleShot( const QString& path, QObject* receiver, const char* member, OFileNotificationType type = Modify ); |
144 | /** | 144 | /** |
145 | * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once. | 145 | * Starts to watch for @a type changes to @a path. Set @a sshot to True if you want to be notified only once. |
146 | * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then. | 146 | * Note that in that case it may be more convenient to use @ref OFileNotification::singleShot() then. |
147 | **/ | 147 | **/ |
148 | int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); | 148 | int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); |
149 | /** | 149 | /** |
150 | * Stop watching for file events. | 150 | * Stop watching for file events. |
151 | **/ | 151 | **/ |
152 | void stop(); | 152 | void stop(); |
153 | /** | 153 | /** |
154 | * @returns the notification type as set by @ref start(). | 154 | * @returns the notification type as set by @ref start(). |
155 | **/ | 155 | **/ |
156 | OFileNotificationType type() const; | 156 | OFileNotificationType type() const; |
157 | /** | 157 | /** |
158 | * @returns the path to the file being watched by this instance. | 158 | * @returns the path to the file being watched by this instance. |
159 | **/ | 159 | **/ |
160 | QString path() const; | 160 | QString path() const; |
161 | /** | 161 | /** |
162 | * @returns if a file is currently being watched. | 162 | * @returns if a file is currently being watched. |
163 | **/ | 163 | **/ |
164 | bool isActive() const; | 164 | bool isActive() const; |
165 | /** | ||
166 | * @internal | ||
167 | */ | ||
168 | int startWatching( const QString& path, bool sshot = false, OFileNotificationType type = Modify ); | ||
165 | 169 | ||
166 | signals: | 170 | signals: |
167 | /** | 171 | /** |
168 | * This signal is emitted if an event happens of the specified type happens to the file being watched. | 172 | * This signal is emitted if an event happens of the specified type happens to the file being watched. |
169 | **/ | 173 | **/ |
170 | void triggered(); | 174 | void triggered( const QString& name ); |
171 | 175 | ||
172 | protected: | 176 | protected: |
173 | bool activate(); | 177 | bool activate(); |
174 | 178 | ||
175 | private slots: | 179 | private slots: |
176 | void inotifyEventHandler(); | 180 | void inotifyEventHandler(); |
177 | 181 | ||
178 | private: | 182 | private: |
179 | bool registerEventHandler(); | 183 | bool registerEventHandler(); |
180 | void unregisterEventHandler(); | 184 | void unregisterEventHandler(); |
181 | 185 | ||
182 | QString _path; | 186 | QString _path; |
183 | OFileNotificationType _type; | 187 | OFileNotificationType _type; |
184 | QSignal _signal; | 188 | QSignal _signal; |
185 | bool _active; | 189 | bool _active; |
186 | bool _multi; | 190 | bool _multi; |
187 | static QSocketNotifier* _sn; | 191 | static QSocketNotifier* _sn; |
188 | int _wd; // inotify watch descriptor | 192 | int _wd; // inotify watch descriptor |
189 | static int _fd; // inotify device descriptor | 193 | static int _fd; // inotify device descriptor |
190 | }; | 194 | }; |
191 | 195 | ||
196 | /*====================================================================================== | ||
197 | * ODirNotification | ||
198 | *======================================================================================*/ | ||
199 | |||
200 | /** | ||
201 | * @brief Represents a directory notification | ||
202 | * | ||
203 | * This class allows to watch for events happening to directories | ||
204 | * It uses the OFileNotification class | ||
205 | * | ||
206 | * @see http://www.kernel.org/pub/linux/kernel/people/rml/inotify/ | ||
207 | * | ||
208 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> | ||
209 | * | ||
210 | **/ | ||
211 | |||
212 | class ODirNotification : public QObject | ||
213 | { | ||
214 | Q_OBJECT | ||
215 | |||
216 | public: | ||
217 | ODirNotification( QObject* parent = 0, const char* name = 0 ); | ||
218 | ~ODirNotification(); | ||
219 | /** | ||
220 | * Starts to watch for @a type changes to @a path. Recurse @a recurse levels down the filesystem tree, | ||
221 | * use 0 for no recursion and -1 for unlimited recursion. | ||
222 | * Set @a sshot to True if you want to be notified only once. | ||
223 | **/ | ||
224 | int watch( const QString& path, bool sshot = false, OFileNotificationType type = Modify, int recurse = 0 ); | ||
225 | }; | ||
226 | |||
227 | |||
192 | } | 228 | } |
193 | } | 229 | } |
194 | 230 | ||
195 | #endif | 231 | #endif |
196 | 232 | ||