mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-22 07:57:22 +00:00
69 lines
1.5 KiB
C
69 lines
1.5 KiB
C
|
// -*- C++ -*-
|
||
|
|
/*
|
||
|
|
* \file FileMonitor.h
|
||
|
|
* Copyright 2002 the LyX Team
|
||
|
|
* Read the file COPYING
|
||
|
|
*
|
||
|
|
* \author Angus Leeming <leeming@lyx.org>
|
||
|
|
*
|
||
|
|
* FileMonitor monitors a file and informs a listener when that file has
|
||
|
|
* changed.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef FILEMONITOR_H
|
||
|
|
#define FILEMONITOR_H
|
||
|
|
|
||
|
|
#ifdef __GNUG__
|
||
|
|
#pragma interface
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#include "LString.h"
|
||
|
|
|
||
|
|
#include <boost/utility.hpp>
|
||
|
|
#include <boost/scoped_ptr.hpp>
|
||
|
|
#include <boost/signals/signal0.hpp>
|
||
|
|
|
||
|
|
class FileMonitor : boost::noncopyable {
|
||
|
|
public:
|
||
|
|
/** Once monitoring begins, the file will be monitored every
|
||
|
|
* interval ms.
|
||
|
|
*/
|
||
|
|
FileMonitor(string const & file_with_path, int interval);
|
||
|
|
|
||
|
|
/// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
|
||
|
|
~FileMonitor();
|
||
|
|
|
||
|
|
///
|
||
|
|
void reset(string const & file_with_path) const;
|
||
|
|
|
||
|
|
///
|
||
|
|
string const & filename() const;
|
||
|
|
|
||
|
|
/// Begin monitoring the file
|
||
|
|
void start() const;
|
||
|
|
///
|
||
|
|
void stop() const;
|
||
|
|
///
|
||
|
|
bool monitoring() const;
|
||
|
|
|
||
|
|
/** The checksum is recomputed whenever the file is modified.
|
||
|
|
* If the file is not being monitored, then the checksum will be
|
||
|
|
* recomputed each time this function is called.
|
||
|
|
*/
|
||
|
|
unsigned long checksum() const;
|
||
|
|
|
||
|
|
/// Connect and you'll be informed when the file has changed.
|
||
|
|
typedef boost::signal0<void>::slot_type slot_type;
|
||
|
|
///
|
||
|
|
boost::signals::connection connect(slot_type const &) const;
|
||
|
|
|
||
|
|
private:
|
||
|
|
/// Use the Pimpl idiom to hide the internals.
|
||
|
|
class Impl;
|
||
|
|
|
||
|
|
/// The pointer never changes although *pimpl_'s contents may.
|
||
|
|
boost::scoped_ptr<Impl> const pimpl_;
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // FILEMONITOR_H
|