Fixed typo.

[wxWidgets.git] / include / wx / filesys.h

diff --git a/include/wx/filesys.h b/include/wx/filesys.h
index d37a4b2975e84dfc86dba6ef916281d9435cd787..e3df47187a0738c0ec19721ea2a68e139fb9a9e0 100644 (file)
--- a/include/wx/filesys.h
+++ b/include/wx/filesys.h
@@ -4,17 +4,13 @@
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik
 // RCS-ID:      $Id$
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __FILESYS_H__
 #define __FILESYS_H__
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "filesys.h"
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"
 
 #if !wxUSE_STREAMS
 #error You cannot compile virtual file systems without wxUSE_STREAMS
@@ -29,10 +25,11 @@
 #include "wx/stream.h"
 #include "wx/datetime.h"
 #include "wx/filename.h"
+#include "wx/hashmap.h"
 
-class wxFSFile;
-class wxFileSystemHandler;
-class wxFileSystem;
+class WXDLLIMPEXP_BASE wxFSFile;
+class WXDLLIMPEXP_BASE wxFileSystemHandler;
+class WXDLLIMPEXP_BASE wxFileSystem;
 
 //--------------------------------------------------------------------------------
 // wxFSFile
@@ -60,22 +57,36 @@ public:
 #endif // wxUSE_DATETIME
     }
 
-    virtual ~wxFSFile() { if (m_Stream) delete m_Stream; }
+    virtual ~wxFSFile() { delete m_Stream; }
+
+    // returns stream. This doesn't give away ownership of the stream object.
+    wxInputStream *GetStream() const { return m_Stream; }
+
+    // gives away the ownership of the current stream.
+    wxInputStream *DetachStream()
+    {
+        wxInputStream *stream = m_Stream;
+        m_Stream = NULL;
+        return stream;
+    }
 
-    // returns stream. This doesn't _create_ stream, it only returns
-    // pointer to it.
-    wxInputStream *GetStream() const {return m_Stream;}
+    // deletes the current stream and takes ownership of another.
+    void SetStream(wxInputStream *stream)
+    {
+        delete m_Stream;
+        m_Stream = stream;
+    }
 
     // returns file's mime type
-    const wxString& GetMimeType() const {return m_MimeType;}
+    const wxString& GetMimeType() const { return m_MimeType; }
 
     // returns the original location (aka filename) of the file
-    const wxString& GetLocation() const {return m_Location;}
+    const wxString& GetLocation() const { return m_Location; }
 
-    const wxString& GetAnchor() const {return m_Anchor;}
+    const wxString& GetAnchor() const { return m_Anchor; }
 
 #if wxUSE_DATETIME
-    wxDateTime GetModificationTime() const {return m_Modif;}
+    wxDateTime GetModificationTime() const { return m_Modif; }
 #endif // wxUSE_DATETIME
 
 private:
@@ -107,7 +118,7 @@ class WXDLLIMPEXP_BASE wxFileSystemHandler : public wxObject
 public:
     wxFileSystemHandler() : wxObject() {}
 
-    // returns TRUE if this handler is able to open given location
+    // returns true if this handler is able to open given location
     virtual bool CanOpen(const wxString& location) = 0;
 
     // opens given file and returns pointer to input stream.
@@ -156,19 +167,28 @@ protected:
 //                  kinds of files (HTPP, FTP, local, tar.gz etc..)
 //--------------------------------------------------------------------------------
 
+// Open Bit Flags
+enum {
+    wxFS_READ = 1,      // Open for reading
+    wxFS_WRITE = 2,     // Open for writing
+    wxFS_SEEKABLE = 4   // Returned stream will be seekable
+};
+
+WX_DECLARE_VOIDPTR_HASH_MAP_WITH_DECL(wxFileSystemHandler*, wxFSHandlerHash, class WXDLLIMPEXP_BASE);
+
 class WXDLLIMPEXP_BASE wxFileSystem : public wxObject
 {
 public:
     wxFileSystem() : wxObject() { m_FindFileHandler = NULL;}
-    virtual ~wxFileSystem() { }
+    virtual ~wxFileSystem();
 
     // sets the current location. Every call to OpenFile is
     // relative to this location.
     // NOTE !!
-    // unless is_dir = TRUE 'location' is *not* the directory but
+    // unless is_dir = true 'location' is *not* the directory but
     // file contained in this directory
     // (so ChangePathTo("dir/subdir/xh.htm") sets m_Path to "dir/subdir/")
-    void ChangePathTo(const wxString& location, bool is_dir = FALSE);
+    void ChangePathTo(const wxString& location, bool is_dir = false);
 
     wxString GetPath() const {return m_Path;}
 
@@ -177,7 +197,7 @@ public:
     // It first tries to open the file in relative scope
     // (based on ChangePathTo()'s value) and then as an absolute
     // path.
-    wxFSFile* OpenFile(const wxString& location);
+    wxFSFile* OpenFile(const wxString& location, int flags = wxFS_READ);
 
     // Finds first/next file that matches spec wildcard. flags can be wxDIR for restricting
     // the query to directories or wxFILE for files only or 0 for either.
@@ -185,10 +205,19 @@ public:
     wxString FindFirst(const wxString& spec, int flags = 0);
     wxString FindNext();
 
+    // find a file in a list of directories, returns false if not found
+    bool FindFileInPath(wxString *pStr, const wxChar *path, const wxChar *file);
+
     // Adds FS handler.
-    // In fact, this class is only front-end to the FS hanlers :-)
+    // In fact, this class is only front-end to the FS handlers :-)
     static void AddHandler(wxFileSystemHandler *handler);
 
+    // Removes FS handler
+    static wxFileSystemHandler* RemoveHandler(wxFileSystemHandler *handler);
+
+    // Returns true if there is a handler which can open the given location.
+    static bool HasHandlerForPath(const wxString& location);
+
     // remove all items from the m_Handlers list
     static void CleanUpHandlers();
 
@@ -200,6 +229,8 @@ public:
 
 
 protected:
+    wxFileSystemHandler *MakeLocal(wxFileSystemHandler *h);
+
     wxString m_Path;
             // the path (location) we are currently in
             // this is path, not file!
@@ -211,6 +242,8 @@ protected:
             // list of FS handlers
     wxFileSystemHandler *m_FindFileHandler;
             // handler that succeed in FindFirst query
+    wxFSHandlerHash m_LocalHandlers;
+            // Handlers local to this instance
 
     DECLARE_DYNAMIC_CLASS(wxFileSystem)
     DECLARE_NO_COPY_CLASS(wxFileSystem)