use wxWindows zlib.h instead of Mac OS X system zlib.h directly

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

diff --git a/src/common/mimecmn.cpp b/src/common/mimecmn.cpp
index 9dedb8ec86d308400d63c55e76b0fdf3d1b73d11..8a16ced893591f3c2bd0bfedbf94587588b1b72f 100644 (file)
--- a/src/common/mimecmn.cpp
+++ b/src/common/mimecmn.cpp
@@ -3,28 +3,39 @@
 // Purpose:     classes and functions to manage MIME types
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     classes and functions to manage MIME types
 // Author:      Vadim Zeitlin
 // Modified by:

+//  Chris Elliott (biol75@york.ac.uk) 5 Dec 00: write support for Win32

 // Created:     23.09.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license (part of wxExtra library)
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     23.09.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Licence:     wxWindows license (part of wxExtra library)
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef    __GNUG__
 #ifdef    __GNUG__

-#pragma implementation "mimetypebase.h"
+    #pragma implementation "mimetypebase.h"

 #endif
 
 // for compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // for compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-  #pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_MIMETYPE
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-  #include "wx/defs.h"
+    #include "wx/module.h"

 #endif
 #endif

-
-#if (wxUSE_FILE && wxUSE_TEXTFILE) || defined(__WXMSW__)
+// this one is needed for MSVC5
+#include "wx/module.h"

 
 #ifndef WX_PRECOMP
   #include "wx/string.h"
 
 #ifndef WX_PRECOMP
   #include "wx/string.h"


@@ -33,43 +44,26 @@
   #endif
 #endif //WX_PRECOMP
 
   #endif
 #endif //WX_PRECOMP
 

-// Doesn't compile in WIN16 mode
-#ifndef __WIN16__
-

 #include "wx/log.h"
 #include "wx/file.h"
 #include "wx/intl.h"
 #include "wx/dynarray.h"
 #include "wx/confbase.h"
 
 #include "wx/log.h"
 #include "wx/file.h"
 #include "wx/intl.h"
 #include "wx/dynarray.h"
 #include "wx/confbase.h"
 

-#ifdef __WXMSW__
-    #include "wx/msw/registry.h"
-    #include "windows.h"
-#elif defined(__UNIX__)  || defined(__WXPM__)
-    #include "wx/ffile.h"
-    #include "wx/textfile.h"
-    #include "wx/dir.h"
-    #include "wx/utils.h"
-    #include "wx/tokenzr.h"
-#endif // OS
-

 #include "wx/mimetype.h"
 
 // other standard headers
 #include <ctype.h>
 
 #include "wx/mimetype.h"
 
 // other standard headers
 #include <ctype.h>
 

-// in case we're compiling in non-GUI mode
-class WXDLLEXPORT wxIcon;
-
-

 // implementation classes:
 // implementation classes:

-

 #if defined(__WXMSW__)
 #if defined(__WXMSW__)

-#include "wx/msw/mimetype.h"
-#elif defined (__WXMAC__)
-#include "wx/mac/mimetype.h"
-#else
-#include "wx/unix/mimetype.h"
+    #include "wx/msw/mimetype.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/mimetype.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/mimetype.h"
+#else // Unix
+    #include "wx/unix/mimetype.h"

 #endif
 
 // ============================================================================
 #endif
 
 // ============================================================================


@@ -108,10 +102,24 @@ wxFileTypeInfo::wxFileTypeInfo(const char *mimeType,
     va_end(argptr);
 }
 
     va_end(argptr);
 }
 

+
+wxFileTypeInfo::wxFileTypeInfo(const wxArrayString& sArray)
+{
+    m_mimeType = sArray [0u];
+    m_openCmd  = sArray [1u];
+    m_printCmd = sArray [2u];
+    m_desc     = sArray [3u];
+
+    size_t count = sArray.GetCount();
+    for ( size_t i = 4; i < count; i++ )
+    {
+        m_exts.Add(sArray[i]);
+    }
+}
+

 #include "wx/arrimpl.cpp"
 WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
 
 #include "wx/arrimpl.cpp"
 WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
 

-

 // ============================================================================
 // implementation of the wrapper classes
 // ============================================================================
 // ============================================================================
 // implementation of the wrapper classes
 // ============================================================================


@@ -120,6 +128,7 @@ WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
 // wxFileType
 // ----------------------------------------------------------------------------
 
 // wxFileType
 // ----------------------------------------------------------------------------
 

+/* static */

 wxString wxFileType::ExpandCommand(const wxString& command,
                                    const wxFileType::MessageParameters& params)
 {
 wxString wxFileType::ExpandCommand(const wxString& command,
                                    const wxFileType::MessageParameters& params)
 {


@@ -155,8 +164,7 @@ wxString wxFileType::ExpandCommand(const wxString& command,
                         const wxChar *pEnd = wxStrchr(pc, wxT('}'));
                         if ( pEnd == NULL ) {
                             wxString mimetype;
                         const wxChar *pEnd = wxStrchr(pc, wxT('}'));
                         if ( pEnd == NULL ) {
                             wxString mimetype;

-                            wxLogWarning(_("Unmatched '{' in an entry for "
-                                           "mime type %s."),
+                            wxLogWarning(_("Unmatched '{' in an entry for mime type %s."),

                                          params.GetMimeType().c_str());
                             str << wxT("%{");
                         }
                                          params.GetMimeType().c_str());
                             str << wxT("%{");
                         }


@@ -187,41 +195,120 @@ wxString wxFileType::ExpandCommand(const wxString& command,
     }
 
     // metamail(1) man page states that if the mailcap entry doesn't have '%s'
     }
 
     // metamail(1) man page states that if the mailcap entry doesn't have '%s'

-    // the program will accept the data on stdin: so give it to it!
-    if ( !hasFilename && !str.IsEmpty() ) {
+    // the program will accept the data on stdin so normally we should append
+    // "< %s" to the end of the command in such case, but not all commands
+    // behave like this, in particular a common test is 'test -n "$DISPLAY"'
+    // and appending "< %s" to this command makes the test fail... I don't
+    // know of the correct solution, try to guess what we have to do.
+
+    // test now carried out on reading file so test should never get here
+    if ( !hasFilename && !str.IsEmpty()
+#ifdef __UNIX__
+                      && !str.StartsWith(_T("test "))
+#endif // Unix
+       ) {

         str << wxT(" < '") << params.GetFileName() << wxT('\'');
     }
 
     return str;
 }
 
         str << wxT(" < '") << params.GetFileName() << wxT('\'');
     }
 
     return str;
 }
 

+wxFileType::wxFileType(const wxFileTypeInfo& info)
+{
+    m_info = &info;
+    m_impl = NULL;
+}
+

 wxFileType::wxFileType()
 {
 wxFileType::wxFileType()
 {

+    m_info = NULL;

     m_impl = new wxFileTypeImpl;
 }
 
 wxFileType::~wxFileType()
 {
     m_impl = new wxFileTypeImpl;
 }
 
 wxFileType::~wxFileType()
 {

-    delete m_impl;
+    if ( m_impl )
+        delete m_impl;

 }
 
 bool wxFileType::GetExtensions(wxArrayString& extensions)
 {
 }
 
 bool wxFileType::GetExtensions(wxArrayString& extensions)
 {

+    if ( m_info )
+    {
+        extensions = m_info->GetExtensions();
+        return TRUE;
+    }
+

     return m_impl->GetExtensions(extensions);
 }
 
 bool wxFileType::GetMimeType(wxString *mimeType) const
 {
     return m_impl->GetExtensions(extensions);
 }
 
 bool wxFileType::GetMimeType(wxString *mimeType) const
 {

+    wxCHECK_MSG( mimeType, FALSE, _T("invalid parameter in GetMimeType") );
+
+    if ( m_info )
+    {
+        *mimeType = m_info->GetMimeType();
+
+        return TRUE;
+    }
+

     return m_impl->GetMimeType(mimeType);
 }
 
     return m_impl->GetMimeType(mimeType);
 }
 

-bool wxFileType::GetIcon(wxIcon *icon) const
+bool wxFileType::GetMimeTypes(wxArrayString& mimeTypes) const

 {
 {

+    if ( m_info )
+    {
+        mimeTypes.Clear();
+        mimeTypes.Add(m_info->GetMimeType());
+
+        return TRUE;
+    }
+
+    return m_impl->GetMimeTypes(mimeTypes);
+}
+
+bool wxFileType::GetIcon(wxIcon *icon,
+                         wxString *iconFile,
+                         int *iconIndex) const
+{
+    if ( m_info )
+    {
+        if ( iconFile )
+            *iconFile = m_info->GetIconFile();
+        if ( iconIndex )
+            *iconIndex = m_info->GetIconIndex();
+
+#if wxUSE_GUI
+        if ( icon && !m_info->GetIconFile().empty() )
+        {
+            // FIXME: what about the index?
+            icon->LoadFile(m_info->GetIconFile());
+        }
+#endif // wxUSE_GUI
+
+        return TRUE;
+    }
+
+#if defined(__WXMSW__) || defined(__UNIX__)
+    return m_impl->GetIcon(icon, iconFile, iconIndex);
+#else

     return m_impl->GetIcon(icon);
     return m_impl->GetIcon(icon);

+#endif

 }
 
 bool wxFileType::GetDescription(wxString *desc) const
 {
 }
 
 bool wxFileType::GetDescription(wxString *desc) const
 {

+    wxCHECK_MSG( desc, FALSE, _T("invalid parameter in GetDescription") );
+
+    if ( m_info )
+    {
+        *desc = m_info->GetDescription();
+
+        return TRUE;
+    }
+

     return m_impl->GetDescription(desc);
 }
 
     return m_impl->GetDescription(desc);
 }
 


@@ -229,6 +316,15 @@ bool
 wxFileType::GetOpenCommand(wxString *openCmd,
                            const wxFileType::MessageParameters& params) const
 {
 wxFileType::GetOpenCommand(wxString *openCmd,
                            const wxFileType::MessageParameters& params) const
 {

+    wxCHECK_MSG( openCmd, FALSE, _T("invalid parameter in GetOpenCommand") );
+
+    if ( m_info )
+    {
+        *openCmd = ExpandCommand(m_info->GetOpenCommand(), params);
+
+        return TRUE;
+    }
+

     return m_impl->GetOpenCommand(openCmd, params);
 }
 
     return m_impl->GetOpenCommand(openCmd, params);
 }
 


@@ -236,16 +332,109 @@ bool
 wxFileType::GetPrintCommand(wxString *printCmd,
                             const wxFileType::MessageParameters& params) const
 {
 wxFileType::GetPrintCommand(wxString *printCmd,
                             const wxFileType::MessageParameters& params) const
 {

+    wxCHECK_MSG( printCmd, FALSE, _T("invalid parameter in GetPrintCommand") );
+
+    if ( m_info )
+    {
+        *printCmd = ExpandCommand(m_info->GetPrintCommand(), params);
+
+        return TRUE;
+    }
+

     return m_impl->GetPrintCommand(printCmd, params);
 }
 
     return m_impl->GetPrintCommand(printCmd, params);
 }
 

+
+size_t wxFileType::GetAllCommands(wxArrayString *verbs,
+                                  wxArrayString *commands,
+                                  const wxFileType::MessageParameters& params) const
+{
+    if ( verbs )
+        verbs->Clear();
+    if ( commands )
+        commands->Clear();
+
+#if defined (__WXMSW__)  || defined(__UNIX__)
+    return m_impl->GetAllCommands(verbs, commands, params);
+#else // !__WXMSW__ || Unix
+    // we don't know how to retrieve all commands, so just try the 2 we know
+    // about
+    size_t count = 0;
+    wxString cmd;
+    if ( GetOpenCommand(&cmd, params) )
+    {
+        if ( verbs )
+            verbs->Add(_T("Open"));
+        if ( commands )
+            commands->Add(cmd);
+        count++;
+    }
+
+    if ( GetPrintCommand(&cmd, params) )
+    {
+        if ( verbs )
+            verbs->Add(_T("Print"));
+        if ( commands )
+            commands->Add(cmd);
+
+        count++;
+    }
+
+    return count;
+#endif // __WXMSW__/| __UNIX__
+}
+
+bool wxFileType::Unassociate()
+{
+#if defined(__WXMSW__)
+    return m_impl->Unassociate();
+#elif defined(__UNIX__) && !defined(__WXPM__)
+    return m_impl->Unassociate(this);
+#else
+    wxFAIL_MSG( _T("not implemented") ); // TODO
+    return FALSE;
+#endif
+}
+
+bool wxFileType::SetCommand(const wxString& cmd, const wxString& verb,
+bool overwriteprompt)
+{
+#if defined (__WXMSW__)  || defined(__UNIX__)
+    return m_impl->SetCommand(cmd, verb, overwriteprompt);
+#else
+    wxFAIL_MSG(_T("not implemented"));
+    return FALSE;
+#endif
+}
+
+bool wxFileType::SetDefaultIcon(const wxString& cmd, int index)
+{
+    wxString sTmp = cmd;
+#ifdef __WXMSW__
+    // VZ: should we do this?
+    // chris elliott : only makes sense in MS windows
+    if ( sTmp.empty() )
+        GetOpenCommand(&sTmp, wxFileType::MessageParameters("", ""));
+#endif
+    wxCHECK_MSG( !sTmp.empty(), FALSE, _T("need the icon file") );
+
+#if defined (__WXMSW__) || defined(__UNIX__)
+    return m_impl->SetDefaultIcon (cmd, index);
+#else
+    wxFAIL_MSG(_T("not implemented"));
+
+    return FALSE;
+#endif
+}
+
+

 // ----------------------------------------------------------------------------
 // wxMimeTypesManager
 // ----------------------------------------------------------------------------
 
 void wxMimeTypesManager::EnsureImpl()
 {
 // ----------------------------------------------------------------------------
 // wxMimeTypesManager
 // ----------------------------------------------------------------------------
 
 void wxMimeTypesManager::EnsureImpl()
 {

-    if (m_impl == NULL)
+    if ( !m_impl )

         m_impl = new wxMimeTypesManagerImpl;
 }
 
         m_impl = new wxMimeTypesManagerImpl;
 }
 


@@ -256,7 +445,8 @@ bool wxMimeTypesManager::IsOfType(const wxString& mimeType,
                   wxT("first MIME type can't contain wildcards") );
 
     // all comparaisons are case insensitive (2nd arg of IsSameAs() is FALSE)
                   wxT("first MIME type can't contain wildcards") );
 
     // all comparaisons are case insensitive (2nd arg of IsSameAs() is FALSE)

-    if ( wildcard.BeforeFirst(wxT('/')).IsSameAs(mimeType.BeforeFirst(wxT('/')), FALSE) )
+    if ( wildcard.BeforeFirst(wxT('/')).
+            IsSameAs(mimeType.BeforeFirst(wxT('/')), FALSE) )

     {
         wxString strSubtype = wildcard.AfterFirst(wxT('/'));
 
     {
         wxString strSubtype = wildcard.AfterFirst(wxT('/'));
 


@@ -278,22 +468,80 @@ wxMimeTypesManager::wxMimeTypesManager()
 
 wxMimeTypesManager::~wxMimeTypesManager()
 {
 
 wxMimeTypesManager::~wxMimeTypesManager()
 {

-    if (m_impl != NULL)
+    if ( m_impl )

         delete m_impl;
 }
 
         delete m_impl;
 }
 

+bool wxMimeTypesManager::Unassociate(wxFileType *ft)
+{
+#if defined(__UNIX__) && !defined(__WXPM__)
+    return m_impl->Unassociate(ft);
+#else
+    return ft->Unassociate();
+#endif
+}
+
+
+wxFileType *
+wxMimeTypesManager::Associate(const wxFileTypeInfo& ftInfo)
+{
+    EnsureImpl();
+
+#if defined(__WXMSW__) || (defined(__UNIX__) && !defined(__WXPM__))
+    return m_impl->Associate(ftInfo);
+#else // other platforms
+    wxFAIL_MSG( _T("not implemented") ); // TODO
+    return NULL;
+#endif // platforms
+}
+

 wxFileType *
 wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
 {
     EnsureImpl();
 wxFileType *
 wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
 {
     EnsureImpl();

-    return m_impl->GetFileTypeFromExtension(ext);
+    wxFileType *ft = m_impl->GetFileTypeFromExtension(ext);
+
+    if ( !ft ) {
+        // check the fallbacks
+        //
+        // TODO linear search is potentially slow, perhaps we should use a
+        //       sorted array?
+        size_t count = m_fallbacks.GetCount();
+        for ( size_t n = 0; n < count; n++ ) {
+            if ( m_fallbacks[n].GetExtensions().Index(ext) != wxNOT_FOUND ) {
+                ft = new wxFileType(m_fallbacks[n]);
+
+                break;
+            }
+        }
+    }
+
+    return ft;

 }
 
 wxFileType *
 wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
 {
     EnsureImpl();
 }
 
 wxFileType *
 wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
 {
     EnsureImpl();

-    return m_impl->GetFileTypeFromMimeType(mimeType);
+    wxFileType *ft = m_impl->GetFileTypeFromMimeType(mimeType);
+
+    if ( ft ) {
+        // check the fallbacks
+        //
+        // TODO linear search is potentially slow, perhaps we should use a sorted
+        //      array?
+        size_t count = m_fallbacks.GetCount();
+        for ( size_t n = 0; n < count; n++ ) {
+            if ( wxMimeTypesManager::IsOfType(mimeType,
+                                              m_fallbacks[n].GetMimeType()) ) {
+                ft = new wxFileType(m_fallbacks[n]);
+
+                break;
+            }
+        }
+    }
+
+    return ft;

 }
 
 bool wxMimeTypesManager::ReadMailcap(const wxString& filename, bool fallback)
 }
 
 bool wxMimeTypesManager::ReadMailcap(const wxString& filename, bool fallback)


@@ -311,31 +559,79 @@ bool wxMimeTypesManager::ReadMimeTypes(const wxString& filename)
 void wxMimeTypesManager::AddFallbacks(const wxFileTypeInfo *filetypes)
 {
     EnsureImpl();
 void wxMimeTypesManager::AddFallbacks(const wxFileTypeInfo *filetypes)
 {
     EnsureImpl();

-    for ( const wxFileTypeInfo *ft = filetypes; ft->IsValid(); ft++ ) {
-        m_impl->AddFallback(*ft);
+    for ( const wxFileTypeInfo *ft = filetypes; ft && ft->IsValid(); ft++ ) {
+        AddFallback(*ft);

     }
 }
 
 size_t wxMimeTypesManager::EnumAllFileTypes(wxArrayString& mimetypes)
 {
     EnsureImpl();
     }
 }
 
 size_t wxMimeTypesManager::EnumAllFileTypes(wxArrayString& mimetypes)
 {
     EnsureImpl();

-    return m_impl->EnumAllFileTypes(mimetypes);
+    size_t countAll = m_impl->EnumAllFileTypes(mimetypes);
+
+    // add the fallback filetypes
+    size_t count = m_fallbacks.GetCount();
+    for ( size_t n = 0; n < count; n++ ) {
+        if ( mimetypes.Index(m_fallbacks[n].GetMimeType()) == wxNOT_FOUND ) {
+            mimetypes.Add(m_fallbacks[n].GetMimeType());
+            countAll++;
+        }
+    }
+
+    return countAll;

 }
 
 }
 

+void wxMimeTypesManager::Initialize(int mcapStyle,
+                                    const wxString& sExtraDir)
+{
+#if defined(__UNIX__) && !defined(__WXPM__)
+    EnsureImpl();
+
+    m_impl->Initialize(mcapStyle, sExtraDir);
+#else
+       (void)mcapStyle;        
+       (void)sExtraDir;        
+#endif // Unix
+}
+
+// and this function clears all the data from the manager
+void wxMimeTypesManager::ClearData()
+{
+#if defined(__UNIX__) && !defined(__WXPM__)
+    EnsureImpl();
+
+    m_impl->ClearData();
+#endif // Unix
+}

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

-// global data
+// global data and wxMimeTypeCmnModule

 // ----------------------------------------------------------------------------
 
 // private object
 static wxMimeTypesManager gs_mimeTypesManager;
 
 // and public pointer
 // ----------------------------------------------------------------------------
 
 // private object
 static wxMimeTypesManager gs_mimeTypesManager;
 
 // and public pointer

-wxMimeTypesManager * wxTheMimeTypesManager = &gs_mimeTypesManager;
+wxMimeTypesManager *wxTheMimeTypesManager = &gs_mimeTypesManager;

 
 

+class wxMimeTypeCmnModule: public wxModule
+{
+public:
+    wxMimeTypeCmnModule() : wxModule() { }
+    virtual bool OnInit() { return TRUE; }
+    virtual void OnExit()
+    {
+        // this avoids false memory leak allerts:
+        if ( gs_mimeTypesManager.m_impl != NULL )
+        {
+            delete gs_mimeTypesManager.m_impl;
+            gs_mimeTypesManager.m_impl = NULL;
+        }
+    }

 
 

-#endif
-  // wxUSE_FILE && wxUSE_TEXTFILE
+    DECLARE_DYNAMIC_CLASS(wxMimeTypeCmnModule)
+};

 
 

-#endif
-  // __WIN16__
+IMPLEMENT_DYNAMIC_CLASS(wxMimeTypeCmnModule, wxModule)
+
+#endif // wxUSE_MIMETYPE