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
24 #include <boost/utility.hpp>
25 #include <boost/scoped_ptr.hpp>
26 #include <boost/signals/signal0.hpp>
28 class FileMonitor : boost::noncopyable {
30 /** Once monitoring begins, the file will be monitored every
33 FileMonitor(string const & file_with_path, int interval);
35 /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
39 void reset(string const & file_with_path) const;
42 string const & filename() const;
44 /// Begin monitoring the file
49 bool monitoring() const;
51 /** The checksum is recomputed whenever the file is modified.
52 * If the file is not being monitored, then the checksum will be
53 * recomputed each time this function is called.
55 unsigned long checksum() const;
57 /// Connect and you'll be informed when the file has changed.
58 typedef boost::signal0<void>::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 #endif // FILEMONITOR_H