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
20 #include <boost/utility.hpp>
21 #include <boost/scoped_ptr.hpp>
22 #include <boost/signals/signal0.hpp>
24 class FileMonitor : boost::noncopyable {
26 /** Once monitoring begins, the file will be monitored every
29 FileMonitor(string const & file_with_path, int interval);
31 /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
35 void reset(string const & file_with_path) const;
38 string const & filename() const;
40 /// Begin monitoring the file
45 bool monitoring() const;
47 /** The checksum is recomputed whenever the file is modified.
48 * If the file is not being monitored, then the checksum will be
49 * recomputed each time this function is called.
51 unsigned long checksum() const;
53 /// Connect and you'll be informed when the file has changed.
54 typedef boost::signal0<void>::slot_type slot_type;
56 boost::signals::connection connect(slot_type const &) const;
59 /// Use the Pimpl idiom to hide the internals.
62 /// The pointer never changes although *pimpl_'s contents may.
63 boost::scoped_ptr<Impl> const pimpl_;
66 #endif // FILEMONITOR_H