]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/filesys.cpp
regen ReST docs
[wxWidgets.git] / src / common / filesys.cpp
index cb0b0a3035fb44b9ebe1cba2c5d664675391155a..57fc6e3712e92e001da5e259d84a77f10a6eba5d 100644 (file)
@@ -1,31 +1,32 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        filesys.cpp
+// Name:        src/common/filesys.cpp
 // Purpose:     wxFileSystem class - interface for opening files
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik
 // CVS-ID:      $Id$
-// Licence:     wxWindows Licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "filesys.h"
-#endif
-
 #include "wx/wxprec.h"
 
-#ifdef __BORDLANDC__
-#pragma hdrstop
+#ifdef __BORLANDC__
+    #pragma hdrstop
 #endif
 
 
 #if wxUSE_FILESYSTEM
 
-#include "wx/wfstream.h"
-#include "wx/module.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/tokenzr.h"
 
 
 //--------------------------------------------------------------------------------
 IMPLEMENT_ABSTRACT_CLASS(wxFileSystemHandler, wxObject)
 
 
-#if wxUSE_MIMETYPE
-static wxFileTypeInfo *gs_FSMimeFallbacks = NULL;
-#endif
-
 wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
 {
     wxString ext, mime;
     wxString loc = GetRightLocation(location);
-    char c;
-    int l = loc.Length(), l2;
+    wxChar c;
+    int l = loc.length(), l2;
 
     l2 = l;
     for (int i = l-1; i >= 0; i--)
@@ -62,10 +59,41 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
     }
 
 #if wxUSE_MIMETYPE
-    static bool s_MinimalMimeEnsured = FALSE;
-    if (!s_MinimalMimeEnsured) {
-        wxTheMimeTypesManager->AddFallbacks(gs_FSMimeFallbacks);
-        s_MinimalMimeEnsured = TRUE;
+    static bool s_MinimalMimeEnsured = false;
+    if (!s_MinimalMimeEnsured)
+    {
+        static const wxFileTypeInfo fallbacks[] =
+        {
+            wxFileTypeInfo(_T("image/jpeg"),
+                           wxEmptyString,
+                           wxEmptyString,
+                           _T("JPEG image (from fallback)"),
+                           _T("jpg"), _T("jpeg"), _T("JPG"), _T("JPEG"), NULL),
+            wxFileTypeInfo(_T("image/gif"),
+                           wxEmptyString,
+                           wxEmptyString,
+                           _T("GIF image (from fallback)"),
+                           _T("gif"), _T("GIF"), NULL),
+            wxFileTypeInfo(_T("image/png"),
+                           wxEmptyString,
+                           wxEmptyString,
+                           _T("PNG image (from fallback)"),
+                           _T("png"), _T("PNG"), NULL),
+            wxFileTypeInfo(_T("image/bmp"),
+                           wxEmptyString,
+                           wxEmptyString,
+                           _T("windows bitmap image (from fallback)"),
+                           _T("bmp"), _T("BMP"), NULL),
+            wxFileTypeInfo(_T("text/html"),
+                           wxEmptyString,
+                           wxEmptyString,
+                           _T("HTML document (from fallback)"),
+                           _T("htm"), _T("html"), _T("HTM"), _T("HTML"), NULL),
+            // must terminate the table with this!
+            wxFileTypeInfo()
+        };
+        wxTheMimeTypesManager->AddFallbacks(fallbacks);
+        s_MinimalMimeEnsured = true;
     }
 
     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(ext);
@@ -78,15 +106,15 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
 
     return mime;
 #else
-    if ( ext.IsSameAs(wxT("htm"), FALSE) || ext.IsSameAs(_T("html"), FALSE) )
+    if ( ext.IsSameAs(wxT("htm"), false) || ext.IsSameAs(_T("html"), false) )
         return wxT("text/html");
-    if ( ext.IsSameAs(wxT("jpg"), FALSE) || ext.IsSameAs(_T("jpeg"), FALSE) )
+    if ( ext.IsSameAs(wxT("jpg"), false) || ext.IsSameAs(_T("jpeg"), false) )
         return wxT("image/jpeg");
-    if ( ext.IsSameAs(wxT("gif"), FALSE) )
+    if ( ext.IsSameAs(wxT("gif"), false) )
         return wxT("image/gif");
-    if ( ext.IsSameAs(wxT("png"), FALSE) )
+    if ( ext.IsSameAs(wxT("png"), false) )
         return wxT("image/png");
-    if ( ext.IsSameAs(wxT("bmp"), FALSE) )
+    if ( ext.IsSameAs(wxT("bmp"), false) )
         return wxT("image/bmp");
     return wxEmptyString;
 #endif
@@ -97,12 +125,11 @@ wxString wxFileSystemHandler::GetMimeTypeFromExt(const wxString& location)
 wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
 {
     wxString s = wxEmptyString;
-    int i, l = location.Length();
-    bool fnd;
+    int i, l = location.length();
+    bool fnd = false;
 
-    fnd = FALSE;
     for (i = l-1; (i >= 0) && ((location[i] != wxT('#')) || (!fnd)); i--) {
-        if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
+        if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = true;
     }
     if (!fnd) return wxT("file");
     for (++i; (i < l) && (location[i] != wxT(':')); i++) s << location[i];
@@ -113,11 +140,10 @@ wxString wxFileSystemHandler::GetProtocol(const wxString& location) const
 wxString wxFileSystemHandler::GetLeftLocation(const wxString& location) const
 {
     int i;
-    bool fnd;
+    bool fnd = false;
 
-    fnd = FALSE;
-    for (i = location.Length()-1; i >= 0; i--) {
-        if ((location[i] == wxT(':')) && (i != 1 /*win: C:\path*/)) fnd = TRUE;
+    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);
     }
     return wxEmptyString;
@@ -125,17 +151,24 @@ wxString wxFileSystemHandler::GetLeftLocation(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; (i >= 0) && ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':'))); i--) {if (location[i] == wxT('#')) l2 = i + 1;}
+
+    for (i = l-1;
+         (i >= 0) &&
+         ((location[i] != wxT(':')) || (i == 1) || (location[i-2] == wxT(':')));
+         i--)
+    {
+        if (location[i] == wxT('#')) l2 = i + 1;
+    }
     if (i == 0) return wxEmptyString;
     else return location.Mid(i + 1, l2 - i - 2);
 }
 
 wxString wxFileSystemHandler::GetAnchor(const wxString& location) const
 {
-    char c;
-    int l = location.Length();
+    wxChar c;
+    int l = location.length();
 
     for (int i = l-1; i >= 0; i--) {
         c = location[i];
@@ -172,24 +205,42 @@ bool wxLocalFSHandler::CanOpen(const wxString& location)
 wxFSFile* wxLocalFSHandler::OpenFile(wxFileSystem& WXUNUSED(fs), const wxString& location)
 {
     // location has Unix path separators
-    wxString right = ms_root + GetRightLocation(location);
-    wxFileName fn(right, wxPATH_UNIX);
+    wxString right = GetRightLocation(location);
+    wxFileName fn = wxFileSystem::URLToFileName(right);
+    wxString fullpath = ms_root + fn.GetFullPath();
+
+    if (!wxFileExists(fullpath))
+        return (wxFSFile*) NULL;
 
-    if (!wxFileExists(fn.GetFullPath()))
+    // 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);
+#else
+#error One of wxUSE_FILE or wxUSE_FFILE must be set to 1 for wxFSHandler to work
+#endif
+    if ( !is->Ok() )
+    {
+        delete is;
         return (wxFSFile*) NULL;
+    }
 
-    return new wxFSFile(new wxFileInputStream(fn.GetFullPath()),
+    return new wxFSFile(is,
                         right,
                         GetMimeTypeFromExt(location),
-                        GetAnchor(location),
-                        wxDateTime(wxFileModificationTime(fn.GetFullPath())));
-
+                        GetAnchor(location)
+#if wxUSE_DATETIME
+                        ,wxDateTime(wxFileModificationTime(fullpath))
+#endif // wxUSE_DATETIME
+                        );
 }
 
 wxString wxLocalFSHandler::FindFirst(const wxString& spec, int flags)
 {
-    wxString right = ms_root + GetRightLocation(spec);
-    return wxFindFirstFile(right, flags);
+    wxFileName fn = wxFileSystem::URLToFileName(GetRightLocation(spec));
+    return wxFindFirstFile(ms_root + fn.GetFullPath(), flags);
 }
 
 wxString wxLocalFSHandler::FindNext()
@@ -216,7 +267,7 @@ static wxString MakeCorrectPath(const wxString& 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
 
@@ -235,7 +286,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('.'))
         {
-            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--) {}
@@ -258,23 +309,23 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
 
     if (is_dir)
     {
-        if (m_Path.Length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
-               m_Path << wxT('/');
+        if (m_Path.length() > 0 && m_Path.Last() != wxT('/') && m_Path.Last() != wxT(':'))
+            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 ((i > 1) && (m_Path[(unsigned int) (i-1)] == wxT('/')) && (m_Path[(unsigned int) (i-2)] == wxT(':')))
-                       {
+                {
                     i -= 2;
                     continue;
                 }
                 else
-                       {
+                {
                     pathpos = i;
                     break;
                 }
@@ -285,20 +336,20 @@ void wxFileSystem::ChangePathTo(const wxString& location, bool is_dir)
             }
         }
         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(':'))
-                       {
+                {
                     m_Path.Remove(i+1);
                     break;
                 }
             }
-            if (i == (int) m_Path.Length())
-               m_Path = wxEmptyString;
+            if (i == (int) m_Path.length())
+                m_Path = wxEmptyString;
         }
         else
-       {
+        {
             m_Path.Remove(pathpos+1);
         }
     }
@@ -310,11 +361,11 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
 {
     wxString loc = MakeCorrectPath(location);
     unsigned i, ln;
-    char meta;
+    wxChar meta;
     wxFSFile *s = NULL;
-    wxNode *node;
+    wxList::compatibility_iterator node;
 
-    ln = loc.Length();
+    ln = loc.length();
     meta = 0;
     for (i = 0; i < ln; i++)
     {
@@ -333,10 +384,10 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
     {
         node = m_Handlers.GetFirst();
         while (node)
-       {
+        {
             wxFileSystemHandler *h = (wxFileSystemHandler*) node -> GetData();
             if (h->CanOpen(m_Path + loc))
-               {
+            {
                 s = h->OpenFile(*this, m_Path + loc);
                 if (s) { m_LastName = m_Path + loc; break; }
             }
@@ -349,10 +400,10 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
     {
         node = m_Handlers.GetFirst();
         while (node)
-       {
+        {
             wxFileSystemHandler *h = (wxFileSystemHandler*) node->GetData();
             if (h->CanOpen(loc))
-           {
+            {
                 s = h->OpenFile(*this, loc);
                 if (s) { m_LastName = loc; break; }
             }
@@ -366,12 +417,12 @@ wxFSFile* wxFileSystem::OpenFile(const wxString& location)
 
 wxString wxFileSystem::FindFirst(const wxString& spec, int flags)
 {
-    wxNode *node;
+    wxList::compatibility_iterator node;
     wxString spec2(spec);
 
     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();
@@ -403,21 +454,152 @@ wxString wxFileSystem::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)
 {
-    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()
 {
-    m_Handlers.DeleteContents(TRUE);
-    m_Handlers.Clear();
+    WX_CLEAR_LIST(wxList, m_Handlers);
+}
+
+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)
+{
+    wxString path = url;
+
+    if ( path.Find(wxT("file://")) == 0 )
+    {
+        path = path.Mid(7);
+    }
+    else if ( path.Find(wxT("file:")) == 0 )
+    {
+        path = path.Mid(5);
+    }
+    // Remove preceding double slash on Mac Classic
+#if defined(__WXMAC__) && !defined(__UNIX__)
+    else if ( path.Find(wxT("//")) == 0 )
+        path = path.Mid(2);
+#endif
+
+    path.Replace(wxT("%25"), wxT("%"));
+    path.Replace(wxT("%3A"), wxT(":"));
+
+#ifdef __WXMSW__
+    // file urls either start with a forward slash (local harddisk),
+    // otherwise they have a servername/sharename notation,
+    // which only exists on msw and corresponds to a unc
+    if ( path[0u] == wxT('/') && path [1u] != wxT('/'))
+    {
+        path = path.Mid(1);
+    }
+    else if ( (url.Find(wxT("file://")) == 0) &&
+              (path.Find(wxT('/')) != wxNOT_FOUND) &&
+              (path.length() > 1) && (path[1u] != wxT(':')) )
+    {
+        path = wxT("//") + path;
+    }
+#endif
+
+    path.Replace(g_unixPathString, g_nativePathString);
+
+    return wxFileName(path, wxPATH_NATIVE);
 }
 
+// Returns the file URL for a native path
+wxString wxFileSystem::FileNameToURL(const wxFileName& filename)
+{
+    wxFileName fn = filename;
+    fn.Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE);
+    wxString url = fn.GetFullPath(wxPATH_NATIVE);
+
+#ifndef __UNIX__
+    // unc notation, wxMSW
+    if ( url.Find(wxT("\\\\")) == 0 )
+    {
+        url = wxT("//") + url.Mid(2);
+    }
+    else
+    {
+        url = wxT("/") + url;
+#ifdef __WXMAC__
+        url = wxT("/") + url;
+#endif
+
+    }
+#endif
 
+    url.Replace(g_nativePathString, g_unixPathString);
+    url.Replace(wxT("%"), wxT("%25"));
+    url.Replace(wxT(":"), wxT("%3A"));
+    url = wxT("file:") + url;
+    return url;
+}
 
 
 ///// Module:
@@ -427,61 +609,31 @@ class wxFileSystemModule : public wxModule
     DECLARE_DYNAMIC_CLASS(wxFileSystemModule)
 
     public:
+        wxFileSystemModule() :
+            wxModule(),
+            m_handler(NULL)
+        {
+        }
+
         virtual bool OnInit()
         {
-            wxFileSystem::AddHandler(new wxLocalFSHandler);
-
-        #if wxUSE_MIMETYPE
-            gs_FSMimeFallbacks = new wxFileTypeInfo[6];
-            gs_FSMimeFallbacks[0] =
-            wxFileTypeInfo("image/jpeg",
-                           "",
-                           "",
-                           "JPEG image (from fallback)",
-                           "jpg", "jpeg", NULL);
-            gs_FSMimeFallbacks[1] =
-            wxFileTypeInfo("image/gif",
-                           "",
-                           "",
-                           "GIF image (from fallback)",
-                           "gif", NULL);
-            gs_FSMimeFallbacks[2] =
-            wxFileTypeInfo("image/png",
-                           "",
-                           "",
-                           "PNG image (from fallback)",
-                           "png", NULL);
-            gs_FSMimeFallbacks[3] =
-            wxFileTypeInfo("image/bmp",
-                           "",
-                           "",
-                           "windows bitmap image (from fallback)",
-                           "bmp", NULL);
-            gs_FSMimeFallbacks[4] =
-            wxFileTypeInfo("text/html",
-                           "",
-                           "",
-                           "HTML document (from fallback)",
-                           "htm", "html", NULL);
-            gs_FSMimeFallbacks[5] =
-            // must terminate the table with this!
-            wxFileTypeInfo();
-        #endif
-            return TRUE;
+            m_handler = new wxLocalFSHandler;
+            wxFileSystem::AddHandler(m_handler);
+            return true;
         }
         virtual void OnExit()
-       {
-        #if wxUSE_MIMETYPE
-            delete [] gs_FSMimeFallbacks;
-        #endif
+        {
+            delete wxFileSystem::RemoveHandler(m_handler);
+
             wxFileSystem::CleanUpHandlers();
-       }
+        }
+
+    private:
+        wxFileSystemHandler* m_handler;
+
 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxFileSystemModule, wxModule)
 
 #endif
   // wxUSE_FILESYSTEM
-
-
-