X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6b8ef0b35d674bc262eb2005ac1321762c831d31..cc4d5638c66a409e421420ed7110917755a66788:/src/common/fswatchercmn.cpp?ds=sidebyside diff --git a/src/common/fswatchercmn.cpp b/src/common/fswatchercmn.cpp index 295f7a105e..1de2422183 100644 --- a/src/common/fswatchercmn.cpp +++ b/src/common/fswatchercmn.cpp @@ -1,9 +1,8 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: common/fswatchercmn.cpp +// Name: src/common/fswatchercmn.cpp // Purpose: wxMswFileSystemWatcher // Author: Bartosz Bekier // Created: 2009-05-26 -// RCS-ID: $Id$ // Copyright: (c) 2009 Bartosz Bekier // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -40,6 +39,16 @@ static wxString GetFSWEventChangeTypeName(int type) return "MODIFY"; case wxFSW_EVENT_ACCESS: return "ACCESS"; + case wxFSW_EVENT_ATTRIB: // Currently this is wxGTK-only + return "ATTRIBUTE"; +#ifdef wxHAS_INOTIFY + case wxFSW_EVENT_UNMOUNT: // Currently this is wxGTK-only + return "UNMOUNT"; +#endif + case wxFSW_EVENT_WARNING: + return "WARNING"; + case wxFSW_EVENT_ERROR: + return "ERROR"; } // should never be reached! @@ -52,6 +61,8 @@ static wxString GetFSWEventChangeTypeName(int type) // wxFileSystemWatcherEvent implementation // ============================================================================ +IMPLEMENT_DYNAMIC_CLASS(wxFileSystemWatcherEvent, wxEvent); + wxString wxFileSystemWatcherEvent::ToString() const { return wxString::Format("FSW_EVT type=%d (%s) path='%s'", m_changeType, @@ -79,25 +90,60 @@ wxFileSystemWatcherBase::~wxFileSystemWatcherBase() bool wxFileSystemWatcherBase::Add(const wxFileName& path, int events) { - // args validation & consistency checks - if (!path.FileExists() && !path.DirExists()) + wxFSWPathType type = wxFSWPath_None; + if ( path.FileExists() ) + { + type = wxFSWPath_File; + } + else if ( path.DirExists() ) + { + type = wxFSWPath_Dir; + } + else + { + // Don't overreact to being passed a non-existent item. It may have + // only just been deleted, in which case doing nothing is correct + wxLogTrace(wxTRACE_FSWATCHER, + "Can't monitor non-existent path \"%s\" for changes.", + path.GetFullPath()); return false; + } + return AddAny(path, events, type); +} + +bool +wxFileSystemWatcherBase::AddAny(const wxFileName& path, + int events, + wxFSWPathType type, + const wxString& filespec) +{ wxString canonical = GetCanonicalPath(path); if (canonical.IsEmpty()) return false; - wxCHECK_MSG(m_watches.find(canonical) == m_watches.end(), false, - wxString::Format("Path '%s' is already watched", canonical)); - // adding a path in a platform specific way - wxFSWatchInfo watch(canonical, events); + wxFSWatchInfo watch(canonical, events, type, filespec); if ( !m_service->Add(watch) ) return false; - // on success, add path to our 'watch-list' - wxFSWatchInfoMap::value_type val(canonical, watch); - return m_watches.insert(val).second; + // on success, either add path to our 'watch-list' + // or, if already watched, inc the refcount. This may happen if + // a dir is Add()ed, then later AddTree() is called on a parent dir + wxFSWatchInfoMap::iterator it = m_watches.find(canonical); + if ( it == m_watches.end() ) + { + wxFSWatchInfoMap::value_type val(canonical, watch); + m_watches.insert(val); + } + else + { + wxFSWatchInfo& watch = it->second; + int count = watch.IncRef(); + wxLogTrace(wxTRACE_FSWATCHER, + "'%s' is now watched %d times", canonical, count); + } + return true; } bool wxFileSystemWatcherBase::Remove(const wxFileName& path) @@ -111,16 +157,21 @@ bool wxFileSystemWatcherBase::Remove(const wxFileName& path) wxCHECK_MSG(it != m_watches.end(), false, wxString::Format("Path '%s' is not watched", canonical)); - // remove from watch-list - wxFSWatchInfo watch = it->second; - m_watches.erase(it); + // Decrement the watch's refcount and remove from watch-list if 0 + bool ret = true; + wxFSWatchInfo& watch = it->second; + if ( !watch.DecRef() ) + { + // remove in a platform specific way + ret = m_service->Remove(watch); - // remove in a platform specific way - return m_service->Remove(watch); + m_watches.erase(it); + } + return ret; } bool wxFileSystemWatcherBase::AddTree(const wxFileName& path, int events, - const wxString& filter) + const wxString& filespec) { if (!path.DirExists()) return false; @@ -130,38 +181,48 @@ bool wxFileSystemWatcherBase::AddTree(const wxFileName& path, int events, class AddTraverser : public wxDirTraverser { public: - AddTraverser(wxFileSystemWatcherBase* watcher, int events) : - m_watcher(watcher), m_events(events) + AddTraverser(wxFileSystemWatcherBase* watcher, int events, + const wxString& filespec) : + m_watcher(watcher), m_events(events), m_filespec(filespec) { } - // CHECK we choose which files to delegate to Add(), maybe we should pass - // all of them to Add() and let it choose? this is useful when adding a - // file to a dir that is already watched, then not only should we know - // about that, but Add() should also behave well then virtual wxDirTraverseResult OnFile(const wxString& WXUNUSED(filename)) { + // There is no need to watch individual files as we watch the + // parent directory which will notify us about any changes in them. return wxDIR_CONTINUE; } virtual wxDirTraverseResult OnDir(const wxString& dirname) { - wxLogTrace(wxTRACE_FSWATCHER, "--- AddTree adding '%s' ---", - dirname); - // we add as much as possible and ignore errors - m_watcher->Add(wxFileName(dirname), m_events); + if ( m_watcher->AddAny(wxFileName::DirName(dirname), + m_events, wxFSWPath_Tree, m_filespec) ) + { + wxLogTrace(wxTRACE_FSWATCHER, + "--- AddTree adding directory '%s' ---", dirname); + } return wxDIR_CONTINUE; } private: wxFileSystemWatcherBase* m_watcher; int m_events; - wxString m_filter; + wxString m_filespec; }; wxDir dir(path.GetFullPath()); - AddTraverser traverser(this, events); - dir.Traverse(traverser, filter); + // Prevent asserts or infinite loops in trees containing symlinks + int flags = wxDIR_DIRS; + if ( !path.ShouldFollowLink() ) + { + flags |= wxDIR_NO_FOLLOW; + } + AddTraverser traverser(this, events, filespec); + dir.Traverse(traverser, filespec, flags); + + // Add the path itself explicitly as Traverse() doesn't return it. + AddAny(path.GetPathWithSep(), events, wxFSWPath_Tree, filespec); return true; } @@ -176,30 +237,63 @@ bool wxFileSystemWatcherBase::RemoveTree(const wxFileName& path) class RemoveTraverser : public wxDirTraverser { public: - RemoveTraverser(wxFileSystemWatcherBase* watcher) : - m_watcher(watcher) + RemoveTraverser(wxFileSystemWatcherBase* watcher, + const wxString& filespec) : + m_watcher(watcher), m_filespec(filespec) { } - virtual wxDirTraverseResult OnFile(const wxString& filename) + virtual wxDirTraverseResult OnFile(const wxString& WXUNUSED(filename)) { - m_watcher->Remove(wxFileName(filename)); + // We never watch the individual files when watching the tree, so + // nothing to do here. return wxDIR_CONTINUE; } virtual wxDirTraverseResult OnDir(const wxString& dirname) { - m_watcher->RemoveTree(wxFileName(dirname)); + m_watcher->Remove(wxFileName::DirName(dirname)); return wxDIR_CONTINUE; } private: wxFileSystemWatcherBase* m_watcher; + wxString m_filespec; }; + // If AddTree() used a filespec, we must use the same one + wxString canonical = GetCanonicalPath(path); + wxFSWatchInfoMap::iterator it = m_watches.find(canonical); + wxCHECK_MSG( it != m_watches.end(), false, + wxString::Format("Path '%s' is not watched", canonical) ); + wxFSWatchInfo watch = it->second; + const wxString filespec = watch.GetFilespec(); + +#if defined(__WINDOWS__) + // When there's no filespec, the wxMSW AddTree() would have set a watch + // on only the passed 'path'. We must therefore remove only this + if (filespec.empty()) + { + return Remove(path); + } + // Otherwise fall through to the generic implementation +#endif // __WINDOWS__ + wxDir dir(path.GetFullPath()); - RemoveTraverser traverser(this); - dir.Traverse(traverser); + // AddTree() might have used the wxDIR_NO_FOLLOW to prevent asserts or + // infinite loops in trees containing symlinks. We need to do the same + // or we'll try to remove unwatched items. Let's hope the caller used + // the same ShouldFollowLink() setting as in AddTree()... + int flags = wxDIR_DIRS; + if ( !path.ShouldFollowLink() ) + { + flags |= wxDIR_NO_FOLLOW; + } + RemoveTraverser traverser(this, filespec); + dir.Traverse(traverser, filespec, flags); + + // As in AddTree() above, handle the path itself explicitly. + Remove(path); return true; }