4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
11 * FileMonitor monitors a file and informs a listener when that file has
18 #include <boost/utility.hpp>
19 #include <boost/scoped_ptr.hpp>
20 #include <boost/signal.hpp>
27 class FileMonitor : boost::noncopyable {
29 /** Once monitoring begins, the file will be monitored every
32 FileMonitor(FileName const & file_with_path, int interval);
34 /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
38 void reset(FileName const & file_with_path) const;
41 FileName const & filename() const;
43 /// Begin monitoring the file
48 bool monitoring() const;
50 /** The checksum is recomputed whenever the file is modified.
51 * If the file is not being monitored, then the checksum will be
52 * recomputed each time this function is called.
54 unsigned long checksum() const;
56 /// Connect and you'll be informed when the file has changed.
57 typedef boost::signal<void()> FileChangedSig;
58 typedef FileChangedSig::slot_type slot_type;
60 boost::signals::connection connect(slot_type const &) const;
63 /// Use the Pimpl idiom to hide the internals.
66 /// The pointer never changes although *pimpl_'s contents may.
67 boost::scoped_ptr<Impl> const pimpl_;
70 } // namespace support
73 #endif // FILEMONITOR_H