// Purpose: wxFileSystemWatcherBase
// Author: Bartosz Bekier
// Created: 2009-05-23
-// RCS-ID: $Id$
// Copyright: (c) 2009 Bartosz Bekier <bartosz.bekier@gmail.com>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
wxFSW_EVENT_RENAME = 0x04,
wxFSW_EVENT_MODIFY = 0x08,
wxFSW_EVENT_ACCESS = 0x10,
+ wxFSW_EVENT_ATTRIB = 0x20, // Currently this is wxGTK-only
// error events
- wxFSW_EVENT_WARNING = 0x20,
- wxFSW_EVENT_ERROR = 0x40,
-
+ wxFSW_EVENT_WARNING = 0x40,
+ wxFSW_EVENT_ERROR = 0x80,
wxFSW_EVENT_ALL = wxFSW_EVENT_CREATE | wxFSW_EVENT_DELETE |
wxFSW_EVENT_RENAME | wxFSW_EVENT_MODIFY |
- wxFSW_EVENT_ACCESS |
+ wxFSW_EVENT_ACCESS | wxFSW_EVENT_ATTRIB |
wxFSW_EVENT_WARNING | wxFSW_EVENT_ERROR
+#ifdef wxHAS_INOTIFY
+ ,wxFSW_EVENT_UNMOUNT = 0x2000
+#endif
};
// Type of the path watched, used only internally for now.
class WXDLLIMPEXP_BASE wxFileSystemWatcherEvent: public wxEvent
{
public:
- wxFileSystemWatcherEvent(int changeType, int watchid = wxID_ANY) :
+ wxFileSystemWatcherEvent(int changeType = 0, int watchid = wxID_ANY) :
wxEvent(watchid, wxEVT_FSWATCHER),
m_changeType(changeType)
{
virtual wxEventCategory GetEventCategory() const
{
- // TODO this has to be merged with "similiar" categories and changed
+ // TODO this has to be merged with "similar" categories and changed
return wxEVT_CATEGORY_UNKNOWN;
}
wxFileName m_path;
wxFileName m_newPath;
wxString m_errorMsg;
+private:
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxFileSystemWatcherEvent)
};
typedef void (wxEvtHandler::*wxFileSystemWatcherEventFunction)
#define wxFileSystemWatcherEventHandler(func) \
wxEVENT_HANDLER_CAST(wxFileSystemWatcherEventFunction, func)
+#define EVT_FSWATCHER(winid, func) \
+ wx__DECLARE_EVT1(wxEVT_FSWATCHER, winid, wxFileSystemWatcherEventHandler(func))
// ----------------------------------------------------------------------------
// wxFileSystemWatcherBase: interface for wxFileSystemWatcher
{
public:
wxFSWatchInfo() :
- m_events(-1), m_type(wxFSWPath_None)
+ m_events(-1), m_type(wxFSWPath_None), m_refcount(-1)
{
}
- wxFSWatchInfo(const wxString& path, int events, wxFSWPathType type) :
- m_path(path), m_events(events), m_type(type)
+ wxFSWatchInfo(const wxString& path,
+ int events,
+ wxFSWPathType type,
+ const wxString& filespec = wxString()) :
+ m_path(path), m_filespec(filespec), m_events(events), m_type(type),
+ m_refcount(1)
{
}
return m_path;
}
+ const wxString& GetFilespec() const { return m_filespec; }
+
int GetFlags() const
{
return m_events;
return m_type;
}
+ // Reference counting of watch entries is used to avoid watching the same
+ // file system path multiple times (this can happen even accidentally, e.g.
+ // when you have a recursive watch and then decide to watch some file or
+ // directory under it separately).
+ int IncRef()
+ {
+ return ++m_refcount;
+ }
+
+ int DecRef()
+ {
+ wxASSERT_MSG( m_refcount > 0, wxS("Trying to decrement a zero count") );
+ return --m_refcount;
+ }
+
protected:
wxString m_path;
+ wxString m_filespec; // For tree watches, holds any filespec to apply
int m_events;
wxFSWPathType m_type;
+ int m_refcount;
};
WX_DECLARE_STRING_HASH_MAP(wxFSWatchInfo, wxFSWatchInfoMap);
* of particular type.
*/
virtual bool AddTree(const wxFileName& path, int events = wxFSW_EVENT_ALL,
- const wxString& filter = wxEmptyString);
+ const wxString& filespec = wxEmptyString);
/**
* Removes path from the list of watched paths.
m_owner = handler;
}
+
+ // This is a semi-private function used by wxWidgets itself only.
+ //
+ // Delegates the real work of adding the path to wxFSWatcherImpl::Add() and
+ // updates m_watches if the new path was successfully added.
+ bool AddAny(const wxFileName& path, int events, wxFSWPathType type,
+ const wxString& filespec = wxString());
+
protected:
static wxString GetCanonicalPath(const wxFileName& path)
return path_copy.GetFullPath();
}
- // Delegates the real work of adding the path to wxFSWatcherImpl::Add() and
- // updates m_watches if the new path was successfully added.
- bool DoAdd(const wxFileName& path, int events, wxFSWPathType type);
-
wxFSWatchInfoMap m_watches; // path=>wxFSWatchInfo map
wxFSWatcherImpl* m_service; // file system events service
#elif defined(wxHAS_KQUEUE)
#include "wx/unix/fswatcher_kqueue.h"
#define wxFileSystemWatcher wxKqueueFileSystemWatcher
-#elif defined(__WXMSW__)
+#elif defined(__WINDOWS__)
#include "wx/msw/fswatcher.h"
#define wxFileSystemWatcher wxMSWFileSystemWatcher
#else