adding constants

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

diff --git a/include/wx/filesys.h b/include/wx/filesys.h
index 071b33ebe9dc3bcaf72adacb19849d7f929f7da4..354d940275d8bfdc8ba94c6e1ccba26737610e9a 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:     wxWindows Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __FILESYS_H__
 #define __FILESYS_H__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"
 
 #if !wxUSE_STREAMS
 #error You cannot compile virtual file systems without wxUSE_STREAMS
@@ -27,12 +23,12 @@
 #if wxUSE_FILESYSTEM
 
 #include "wx/stream.h"
-#include "wx/url.h"
 #include "wx/datetime.h"
+#include "wx/filename.h"
 
-class wxFSFile;
-class wxFileSystemHandler;
-class wxFileSystem;
+class WXDLLIMPEXP_BASE wxFSFile;
+class WXDLLIMPEXP_BASE wxFileSystemHandler;
+class WXDLLIMPEXP_BASE wxFileSystem;
 
 //--------------------------------------------------------------------------------
 // wxFSFile
@@ -41,23 +37,29 @@ class wxFileSystem;
 //                  (in 'index.htm#chapter2', 'chapter2' is anchor)
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFSFile : public wxObject
+class WXDLLIMPEXP_BASE wxFSFile : public wxObject
 {
 public:
-    wxFSFile(wxInputStream *stream, const wxString& loc, 
-             const wxString& mimetype, const wxString& anchor,
-             wxDateTime modif)
+    wxFSFile(wxInputStream *stream, const wxString& loc,
+             const wxString& mimetype, const wxString& anchor
+#if wxUSE_DATETIME
+             , wxDateTime modif
+#endif // wxUSE_DATETIME
+             )
     {
         m_Stream = stream;
         m_Location = loc;
         m_MimeType = mimetype; m_MimeType.MakeLower();
         m_Anchor = anchor;
+#if wxUSE_DATETIME
         m_Modif = modif;
+#endif // wxUSE_DATETIME
     }
+
     virtual ~wxFSFile() { if (m_Stream) delete m_Stream; }
 
     // returns stream. This doesn't _create_ stream, it only returns
-    // pointer to it!!
+    // pointer to it.
     wxInputStream *GetStream() const {return m_Stream;}
 
     // returns file's mime type
@@ -68,14 +70,21 @@ public:
 
     const wxString& GetAnchor() const {return m_Anchor;}
 
+#if wxUSE_DATETIME
     wxDateTime GetModificationTime() const {return m_Modif;}
+#endif // wxUSE_DATETIME
 
 private:
     wxInputStream *m_Stream;
     wxString m_Location;
     wxString m_MimeType;
     wxString m_Anchor;
+#if wxUSE_DATETIME
     wxDateTime m_Modif;
+#endif // wxUSE_DATETIME
+
+    DECLARE_ABSTRACT_CLASS(wxFSFile)
+    DECLARE_NO_COPY_CLASS(wxFSFile)
 };
 
 
@@ -89,12 +98,12 @@ private:
 //                  kinds of files (HTPP, FTP, local, tar.gz etc..)
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFileSystemHandler : public wxObject
+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.
@@ -143,18 +152,19 @@ protected:
 //                  kinds of files (HTPP, FTP, local, tar.gz etc..)
 //--------------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFileSystem : public wxObject
+class WXDLLIMPEXP_BASE wxFileSystem : public wxObject
 {
 public:
-    wxFileSystem() : wxObject() {m_Path = m_LastName = wxEmptyString; m_Handlers.DeleteContents(TRUE); m_FindFileHandler = NULL;}
+    wxFileSystem() : wxObject() { m_FindFileHandler = NULL;}
+    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;}
 
@@ -171,13 +181,26 @@ 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);
 
+    // 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();
 
+    // Returns the native path for a file URL
+    static wxFileName URLToFileName(const wxString& url);
+
+    // Returns the file URL for a native path
+    static wxString FileNameToURL(const wxFileName& filename);
+
+
 protected:
     wxString m_Path;
             // the path (location) we are currently in
@@ -192,6 +215,7 @@ protected:
             // handler that succeed in FindFirst query
 
     DECLARE_DYNAMIC_CLASS(wxFileSystem)
+    DECLARE_NO_COPY_CLASS(wxFileSystem)
 };
 
 
@@ -219,20 +243,20 @@ special characters :
 */
 
 
-class wxLocalFSHandler : public wxFileSystemHandler
+class WXDLLIMPEXP_BASE wxLocalFSHandler : public wxFileSystemHandler
 {
 public:
     virtual bool CanOpen(const wxString& location);
     virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location);
     virtual wxString FindFirst(const wxString& spec, int flags = 0);
     virtual wxString FindNext();
-    
+
     // wxLocalFSHandler will prefix all filenames with 'root' before accessing
     // files on disk. This effectively makes 'root' the top-level directory
-    // and prevents access to files outside this directory.  
+    // and prevents access to files outside this directory.
     // (This is similar to Unix command 'chroot'.)
     static void Chroot(const wxString& root) { ms_root = root; }
-    
+
 protected:
     static wxString ms_root;
 };