added explanatory comment

[wxWidgets.git] / src / common / filesys.cpp

diff --git a/src/common/filesys.cpp b/src/common/filesys.cpp
index 4fe96086a7916d31357f5e060143f57828746666..94a229f49c5d280494719a6459c3b710e94d5534 100644 (file)
--- a/src/common/filesys.cpp
+++ b/src/common/filesys.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        filesys.cpp
+// Name:        src/common/filesys.cpp

 // Purpose:     wxFileSystem class - interface for opening files
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik
 // Purpose:     wxFileSystem class - interface for opening files
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik


@@ -7,25 +7,27 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "filesys.h"
-#endif
-

 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 
 #if wxUSE_FILESYSTEM
 
 #endif
 
 
 #if wxUSE_FILESYSTEM
 

-#include "wx/wfstream.h"
-#include "wx/module.h"

 #include "wx/filesys.h"
 #include "wx/filesys.h"

+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/module.h"
+#endif
+
+#include "wx/wfstream.h"

 #include "wx/mimetype.h"
 #include "wx/filename.h"
 #include "wx/mimetype.h"
 #include "wx/filename.h"

-#include "wx/log.h"
+#include "wx/tokenzr.h"
+#include "wx/private/fileback.h"

 
 
 //--------------------------------------------------------------------------------
 
 
 //--------------------------------------------------------------------------------


@@ -40,7 +42,7 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
     wxString ext, mime;
     wxString loc = GetRightLocation(location);
     wxChar c;
     wxString ext, mime;
     wxString loc = GetRightLocation(location);
     wxChar c;

-    int l = loc.Length(), l2;
+    int l = loc.length(), l2;

 
     l2 = l;
     for (int i = l-1; i >= 0; i--)
 
     l2 = l;
     for (int i = l-1; i >= 0; i--)


@@ -64,30 +66,30 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
         static const wxFileTypeInfo fallbacks[] =
         {
             wxFileTypeInfo(_T("image/jpeg"),
         static const wxFileTypeInfo fallbacks[] =
         {
             wxFileTypeInfo(_T("image/jpeg"),

-                           _T(""),
-                           _T(""),
+                           wxEmptyString,
+                           wxEmptyString,

                            _T("JPEG image (from fallback)"),
                            _T("JPEG image (from fallback)"),

-                           _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), NULL),
+                           _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), 0),

             wxFileTypeInfo(_T("image/gif"),
             wxFileTypeInfo(_T("image/gif"),

-                           _T(""),
-                           _T(""),
+                           wxEmptyString,
+                           wxEmptyString,

                            _T("GIF image (from fallback)"),
                            _T("GIF image (from fallback)"),

-                           _T("gif"), _T("GIF"), NULL),
+                           _T("gif"), _T("GIF"), 0),

             wxFileTypeInfo(_T("image/png"),
             wxFileTypeInfo(_T("image/png"),

-                           _T(""),
-                           _T(""),
+                           wxEmptyString,
+                           wxEmptyString,

                            _T("PNG image (from fallback)"),
                            _T("PNG image (from fallback)"),

-                           _T("png"), _T("PNG"), NULL),
+                           _T("png"), _T("PNG"), 0),

             wxFileTypeInfo(_T("image/bmp"),
             wxFileTypeInfo(_T("image/bmp"),

-                           _T(""),
-                           _T(""),
+                           wxEmptyString,
+                           wxEmptyString,

                            _T("windows bitmap image (from fallback)"),
                            _T("windows bitmap image (from fallback)"),

-                           _T("bmp"), _T("BMP"), NULL),
+                           _T("bmp"), _T("BMP"), 0),

             wxFileTypeInfo(_T("text/html"),
             wxFileTypeInfo(_T("text/html"),

-                           _T(""),
-                           _T(""),
+                           wxEmptyString,
+                           wxEmptyString,

                            _T("HTML document (from fallback)"),
                            _T("HTML document (from fallback)"),

-                           _T("htm"), _T("html"), _T("HTM"), _T("HTML"), NULL),
+                           _T("htm"), _T("html"), _T("HTM"), _T("HTML"), 0),

             // must terminate the table with this!
             wxFileTypeInfo()
         };
             // must terminate the table with this!
             wxFileTypeInfo()
         };


@@ -124,7 +126,7 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
 {
     wxString s = wxEmptyString;
 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
 {
     wxString s = wxEmptyString;

-    int i, l = location.Length();
+    int i, l = location.length();

     bool fnd = false;
 
     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
     bool fnd = false;
 
     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {


@@ -141,7 +143,7 @@ wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
     int i;
     bool fnd = false;
 
     int i;
     bool fnd = false;
 

-    for (i = location.Length()-1; i >= 0; i--) {
+    for (i = location.length()-1; i >= 0; i--) {

         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
         else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
     }
         if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
         else if (fnd && (location[i] == wxT('#'))) return location.Left(i);
     }


@@ -150,7 +152,7 @@ wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
 
 wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 {
 
 wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 {

-    int i, l = location.Length();
+    int i, l = location.length();

     int l2 = l + 1;
 
     for (i = l-1;
     int l2 = l + 1;
 
     for (i = l-1;


@@ -167,7 +169,7 @@ wxString wxFileSystemHandler::GetRightLocation(const wxString& location) const
 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 {
     wxChar c;
 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 {
     wxChar c;

-    int l = location.Length();
+    int l = location.length();

 
     for (int i = l-1; i >= 0; i--) {
         c = location[i];
 
     for (int i = l-1; i >= 0; i--) {
         c = location[i];


@@ -213,7 +215,13 @@ wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString&
 
     // we need to check whether we can really read from this file, otherwise
     // wxFSFile is not going to work
 
     // we need to check whether we can really read from this file, otherwise
     // wxFSFile is not going to work

+#if wxUSE_FILE
+    wxFileInputStream *is = new wxFileInputStream(fullpath);
+#elif wxUSE_FFILE

     wxFFileInputStream *is = new wxFFileInputStream(fullpath);
     wxFFileInputStream *is = new wxFFileInputStream(fullpath);

+#else
+#error One of wxUSE_FILE or wxUSE_FFILE must be set to 1 for wxFSHandler to work
+#endif

     if ( !is->Ok() )
     {
         delete is;
     if ( !is->Ok() )
     {
         delete is;


@@ -254,13 +262,19 @@ IMPLEMENT_ABSTRACT_CLASS(wxFSFile, wxObject)
 wxList wxFileSystem::m_Handlers;
 
 
 wxList wxFileSystem::m_Handlers;
 
 

+wxFileSystem::~wxFileSystem()
+{
+    WX_CLEAR_HASH_MAP(wxFSHandlerHash, m_LocalHandlers)
+}
+
+

 static wxString MakeCorrectPath(const wxString& path)
 {
     wxString p(path);
     wxString r;
     int i, j, cnt;
 
 static wxString MakeCorrectPath(const wxString& path)
 {
     wxString p(path);
     wxString r;
     int i, j, cnt;
 

-    cnt = p.Length();
+    cnt = p.length();

     for (i = 0; i < cnt; i++)
       if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 
     for (i = 0; i < cnt; i++)
       if (p.GetChar(i) == wxT('\\')) p.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 


@@ -279,7 +293,7 @@ static wxString MakeCorrectPath(const wxString& path)
         r << p.GetChar(i);
         if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
         {
         r << p.GetChar(i);
         if (p.GetChar(i) == wxT('/') && p.GetChar(i-1) == wxT('.') && p.GetChar(i-2) == wxT('.'))
         {

-            for (j = r.Length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
+            for (j = r.length() - 2; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}

             if (j >= 0 && r.GetChar(j) != wxT(':'))
             {
                 for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}
             if (j >= 0 && r.GetChar(j) != wxT(':'))
             {
                 for (j = j - 1; j >= 0 && r.GetChar(j) != wxT('/') && r.GetChar(j) != wxT(':'); j--) {}


@@ -302,13 +316,13 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 
     if (is_dir)
     {
 
     if (is_dir)
     {

-        if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
+        if (m_Path.length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))

             m_Path << wxT('/');
     }
 
     else
     {
             m_Path << wxT('/');
     }
 
     else
     {

-        for (i = m_Path.Length()-1; i >= 0; i--)
+        for (i = m_Path.length()-1; i >= 0; i--)

         {
             if (m_Path[(unsigned int) i] == wxT('/'))
             {
         {
             if (m_Path[(unsigned int) i] == wxT('/'))
             {


@@ -330,7 +344,7 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
         }
         if (pathpos == -1)
         {
         }
         if (pathpos == -1)
         {

-            for (i = 0; i < (int) m_Path.Length(); i++)
+            for (i = 0; i < (int) m_Path.length(); i++)

             {
                 if (m_Path[(unsigned int) i] == wxT(':'))
                 {
             {
                 if (m_Path[(unsigned int) i] == wxT(':'))
                 {


@@ -338,7 +352,7 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
                     break;
                 }
             }
                     break;
                 }
             }

-            if (i == (int) m_Path.Length())
+            if (i == (int) m_Path.length())

                 m_Path = wxEmptyString;
         }
         else
                 m_Path = wxEmptyString;
         }
         else


@@ -350,19 +364,41 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 
 
 
 
 
 

-wxFSFile* wxFileSystem::OpenFile(const wxString& location)
+wxFileSystemHandler *wxFileSystem::MakeLocal(wxFileSystemHandler *h)

 {
 {

+    wxClassInfo *classinfo = h->GetClassInfo();
+
+    if (classinfo->IsDynamic())
+    {
+        wxFileSystemHandler*& local = m_LocalHandlers[classinfo];
+        if (!local)
+            local = (wxFileSystemHandler*)classinfo->CreateObject();
+        return local;
+    }
+    else
+    {
+        return h;
+    }
+}
+
+
+
+wxFSFile* wxFileSystem::OpenFile(const wxString& location, int flags)
+{
+    if ((flags & wxFS_READ) == 0)
+        return NULL;
+

     wxString loc = MakeCorrectPath(location);
     unsigned i, ln;
     wxChar meta;
     wxFSFile *s = NULL;
     wxList::compatibility_iterator node;
 
     wxString loc = MakeCorrectPath(location);
     unsigned i, ln;
     wxChar meta;
     wxFSFile *s = NULL;
     wxList::compatibility_iterator node;
 

-    ln = loc.Length();
+    ln = loc.length();

     meta = 0;
     for (i = 0; i < ln; i++)
     {
     meta = 0;
     for (i = 0; i < ln; i++)
     {

-        switch (loc[i])
+        switch ( loc[i].GetValue() )

         {
             case wxT('/') : case wxT(':') : case wxT('#') :
                 meta = loc[i];
         {
             case wxT('/') : case wxT(':') : case wxT('#') :
                 meta = loc[i];


@@ -381,7 +417,7 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
             if (h->CanOpen(m_Path + loc))
             {
             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
             if (h->CanOpen(m_Path + loc))
             {

-                s = h->OpenFile(*this, m_Path + loc);
+                s = MakeLocal(h)->OpenFile(*this, m_Path + loc);

                 if (s) { m_LastName = m_Path + loc; break; }
             }
             node = node->GetNext();
                 if (s) { m_LastName = m_Path + loc; break; }
             }
             node = node->GetNext();


@@ -397,12 +433,21 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
             if (h->CanOpen(loc))
             {
             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
             if (h->CanOpen(loc))
             {

-                s = h->OpenFile(*this, loc);
+                s = MakeLocal(h)->OpenFile(*this, loc);

                 if (s) { m_LastName = loc; break; }
             }
             node = node->GetNext();
         }
     }
                 if (s) { m_LastName = loc; break; }
             }
             node = node->GetNext();
         }
     }

+
+    if (s && (flags & wxFS_SEEKABLE) != 0 && !s->GetStream()->IsSeekable())
+    {
+        wxBackedInputStream *stream;
+        stream = new wxBackedInputStream(s->DetachStream());
+        stream->FindLength();
+        s->SetStream(stream);
+    }
+

     return (s);
 }
 
     return (s);
 }
 


@@ -415,24 +460,30 @@ wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
 
     m_FindFileHandler = NULL;
 
 
     m_FindFileHandler = NULL;
 

-    for (int i = spec2.Length()-1; i >= 0; i--)
+    for (int i = spec2.length()-1; i >= 0; i--)

         if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 
     node = m_Handlers.GetFirst();
     while (node)
     {
         if (spec2[(unsigned int) i] == wxT('\\')) spec2.GetWritableChar(i) = wxT('/'); // Want to be windows-safe
 
     node = m_Handlers.GetFirst();
     while (node)
     {

-        m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
-        if (m_FindFileHandler -> CanOpen(m_Path + spec2))
+        wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
+        if (h -> CanOpen(m_Path + spec2))
+        {
+            m_FindFileHandler = MakeLocal(h);

             return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);
             return m_FindFileHandler -> FindFirst(m_Path + spec2, flags);

+        }

         node = node->GetNext();
     }
 
     node = m_Handlers.GetFirst();
     while (node)
     {
         node = node->GetNext();
     }
 
     node = m_Handlers.GetFirst();
     while (node)
     {

-        m_FindFileHandler = (wxFileSystemHandler*) node -> GetData();
-        if (m_FindFileHandler -> CanOpen(spec2))
+        wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
+        if (h -> CanOpen(spec2))
+        {
+            m_FindFileHandler = MakeLocal(h);

             return m_FindFileHandler -> FindFirst(spec2, flags);
             return m_FindFileHandler -> FindFirst(spec2, flags);

+        }

         node = node->GetNext();
     }
 
         node = node->GetNext();
     }
 


@@ -447,21 +498,79 @@ wxString wxFileSystem::FindNext()
     else return m_FindFileHandler -> FindNext();
 }
 
     else return m_FindFileHandler -> FindNext();
 }
 

+bool wxFileSystem::FindFileInPath(wxString *pStr,
+                                  const wxChar *path,
+                                  const wxChar *basename)
+{
+    // we assume that it's not empty
+    wxCHECK_MSG( !wxIsEmpty(basename), false,
+                _T("empty file name in wxFileSystem::FindFileInPath"));
+
+    // skip path separator in the beginning of the file name if present
+    if ( wxIsPathSeparator(*basename) )
+       basename++;
+
+    wxStringTokenizer tokenizer(path, wxPATH_SEP);
+    while ( tokenizer.HasMoreTokens() )
+    {
+        wxString strFile = tokenizer.GetNextToken();
+        if ( !wxEndsWithPathSeparator(strFile) )
+            strFile += wxFILE_SEP_PATH;
+        strFile += basename;
+
+        wxFSFile *file = OpenFile(strFile);
+        if ( file )
+        {
+            delete file;
+            *pStr = strFile;
+            return true;
+        }
+    }

 
 

+    return false;
+}

 
 void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
 {
 
 void wxFileSystem::AddHandler(wxFileSystemHandler *handler)
 {

-    m_Handlers.Append(handler);
+    // prepend the handler to the beginning of the list because handlers added
+    // last should have the highest priority to allow overriding them
+    m_Handlers.Insert((size_t)0, handler);

 }
 
 }
 

+wxFileSystemHandler* wxFileSystem::RemoveHandler(wxFileSystemHandler *handler)
+{
+    // if handler has already been removed (or deleted)
+    // we return NULL. This is by design in case
+    // CleanUpHandlers() is called before RemoveHandler
+    // is called, as we cannot control the order
+    // which modules are unloaded
+    if (!m_Handlers.DeleteObject(handler))
+        return NULL;
+
+    return handler;
+}
+
+
+bool wxFileSystem::HasHandlerForPath(const wxString &location)
+{
+    for ( wxList::compatibility_iterator node = m_Handlers.GetFirst();
+           node; node = node->GetNext() )
+    {
+        wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
+        if (h->CanOpen(location))
+            return true;
+    }
+
+    return false;
+}

 
 void wxFileSystem::CleanUpHandlers()
 {
     WX_CLEAR_LIST(wxList, m_Handlers);
 }
 
 
 void wxFileSystem::CleanUpHandlers()
 {
     WX_CLEAR_LIST(wxList, m_Handlers);
 }
 

-const static wxString g_unixPathString(wxT("/"));
-const static wxString g_nativePathString(wxFILE_SEP_PATH);
+static const wxString g_unixPathString(wxT("/"));
+static const wxString g_nativePathString(wxFILE_SEP_PATH);

 
 // Returns the native path for a file URL
 wxFileName wxFileSystem::URLToFileName(const wxString& url)
 
 // Returns the native path for a file URL
 wxFileName wxFileSystem::URLToFileName(const wxString& url)


@@ -495,7 +604,7 @@ wxFileName wxFileSystem::URLToFileName(const wxString& url)
     }
     else if ( (url.Find(wxT("file://")) == 0) &&
               (path.Find(wxT('/')) != wxNOT_FOUND) &&
     }
     else if ( (url.Find(wxT("file://")) == 0) &&
               (path.Find(wxT('/')) != wxNOT_FOUND) &&

-              (path.Length() > 1) && (path[1u] != wxT(':')) )
+              (path.length() > 1) && (path[1u] != wxT(':')) )

     {
         path = wxT("//") + path;
     }
     {
         path = wxT("//") + path;
     }


@@ -544,21 +653,31 @@ class wxFileSystemModule : public wxModule
     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 
     public:
     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 
     public:

+        wxFileSystemModule() :
+            wxModule(),
+            m_handler(NULL)
+        {
+        }
+

         virtual bool OnInit()
         {
         virtual bool OnInit()
         {

-            wxFileSystem::AddHandler(new wxLocalFSHandler);
+            m_handler = new wxLocalFSHandler;
+            wxFileSystem::AddHandler(m_handler);

             return true;
         }
         virtual void OnExit()
         {
             return true;
         }
         virtual void OnExit()
         {

+            delete wxFileSystem::RemoveHandler(m_handler);
+

             wxFileSystem::CleanUpHandlers();
         }
             wxFileSystem::CleanUpHandlers();
         }

+
+    private:
+        wxFileSystemHandler* m_handler;
+

 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 
 #endif
   // wxUSE_FILESYSTEM
 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 
 #endif
   // wxUSE_FILESYSTEM

-
-
-