mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
1a6db8cdfa
Some editors (emacs) rename file at startup to the backup version. Hence watching the original file tells one nothing.
152 lines
3.9 KiB
C++
152 lines
3.9 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2010-2010 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
fileMonitor
|
|
|
|
Description
|
|
Checking for changes to files.
|
|
|
|
Note
|
|
The default is to use inotify (Linux specific, since 2.6.13)
|
|
|
|
Compiling with FOAM_USE_STAT (or if /usr/include/sys/inotify.h
|
|
does not exist) uses the stat function call.
|
|
|
|
SourceFiles
|
|
fileMonitor.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef fileMonitor_H
|
|
#define fileMonitor_H
|
|
|
|
#include <sys/types.h>
|
|
#include "NamedEnum.H"
|
|
#include "className.H"
|
|
#include "DynamicList.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
class fileMonitor;
|
|
class fileMonitorWatcher;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class fileMonitor Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class fileMonitor
|
|
{
|
|
|
|
public:
|
|
|
|
// Public data types
|
|
|
|
//- Enumeration defining the file state.
|
|
enum fileState
|
|
{
|
|
UNMODIFIED = 0,
|
|
MODIFIED = 1,
|
|
DELETED = 2,
|
|
};
|
|
|
|
static const NamedEnum<fileState, 3> fileStateNames_;
|
|
|
|
private:
|
|
// Private data
|
|
|
|
//- State for all watchFds
|
|
mutable DynamicList<fileState> state_;
|
|
|
|
//- Filename for all watchFds
|
|
DynamicList<fileName> watchFile_;
|
|
|
|
//- Free watchFds
|
|
DynamicList<label> freeWatchFds_;
|
|
|
|
//- Watch mechanism (stat or inotify)
|
|
mutable autoPtr<fileMonitorWatcher> watcher_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Update state_ from any events.
|
|
void checkFiles() const;
|
|
|
|
//- Disallow default bitwise copy construct
|
|
fileMonitor(const fileMonitor&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const fileMonitor&);
|
|
|
|
|
|
public:
|
|
|
|
// Declare name of the class and its debug switch
|
|
ClassName("fileMonitor");
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
fileMonitor();
|
|
|
|
|
|
//- Destructor
|
|
~fileMonitor();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Add file to watch. Return watch descriptor
|
|
label addWatch(const fileName&);
|
|
|
|
//- Remove file to watch. Return true if successful
|
|
bool removeWatch(const label watchFd);
|
|
|
|
//- Get name of file being watched
|
|
const fileName& getFile(const label watchFd) const;
|
|
|
|
//- Check state using handle
|
|
fileState getState(const label watchFd) const;
|
|
|
|
//- Check state of all files. Updates state_.
|
|
void updateStates(const bool syncPar) const;
|
|
|
|
//- Reset state (e.g. after having read it) using handle
|
|
void setUnmodified(const label watchFd);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|