]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/mimecmn.cpp
Forbid creation of wxStandardPaths object directly.
[wxWidgets.git] / src / common / mimecmn.cpp
index 80457d0b612606c9f4eb8c5e7dfa39bb1ad1baf1..930f70a31edb9b75f8c07e77eaed0065407388c2 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        common/mimecmn.cpp
+// Name:        src/common/mimecmn.cpp
 // Purpose:     classes and functions to manage MIME types
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -7,7 +7,7 @@
 // Created:     23.09.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license (part of wxExtra library)
+// Licence:     wxWindows licence (part of wxExtra library)
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef    __GNUG__
-    #pragma implementation "mimetypebase.h"
-#endif
-
 // for compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
-#include "wx/module.h"
 
 #ifdef __BORLANDC__
-  #pragma hdrstop
+    #pragma hdrstop
 #endif
 
-#ifndef WX_PRECOMP
-  #include "wx/defs.h"
-#endif
+#if wxUSE_MIMETYPE
+
+#include "wx/mimetype.h"
 
 #ifndef WX_PRECOMP
-  #include "wx/string.h"
-  #if wxUSE_GUI
-    #include "wx/icon.h"
-  #endif
+    #include "wx/dynarray.h"
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/module.h"
+    #include "wx/crt.h"
 #endif //WX_PRECOMP
 
-#include "wx/log.h"
 #include "wx/file.h"
-#include "wx/intl.h"
-#include "wx/dynarray.h"
+#include "wx/iconloc.h"
 #include "wx/confbase.h"
 
-#include "wx/mimetype.h"
-
 // other standard headers
 #include <ctype.h>
 
 // implementation classes:
-#if defined(__WXMSW__)
+#if defined(__WINDOWS__)
     #include "wx/msw/mimetype.h"
-#elif defined (__WXMAC__)
-    #include "wx/mac/mimetype.h"
-#elif defined (__WXPM__)
+#elif ( defined(__DARWIN__) )
+    #include "wx/osx/mimetype.h"
+#elif defined(__WXPM__) || defined (__EMX__)
     #include "wx/os2/mimetype.h"
+    #undef __UNIX__
+#elif defined(__DOS__)
+    #include "wx/msdos/mimetype.h"
 #else // Unix
     #include "wx/unix/mimetype.h"
 #endif
 // common classes
 // ============================================================================
 
+// ----------------------------------------------------------------------------
+// wxMimeTypeCommands
+// ----------------------------------------------------------------------------
+
+void
+wxMimeTypeCommands::AddOrReplaceVerb(const wxString& verb, const wxString& cmd)
+{
+    int n = m_verbs.Index(verb, false /* ignore case */);
+    if ( n == wxNOT_FOUND )
+    {
+        m_verbs.Add(verb);
+        m_commands.Add(cmd);
+    }
+    else
+    {
+        m_commands[n] = cmd;
+    }
+}
+
+wxString
+wxMimeTypeCommands::GetCommandForVerb(const wxString& verb, size_t *idx) const
+{
+    wxString s;
+
+    int n = m_verbs.Index(verb);
+    if ( n != wxNOT_FOUND )
+    {
+        s = m_commands[(size_t)n];
+        if ( idx )
+            *idx = n;
+    }
+    else if ( idx )
+    {
+        // different from any valid index
+        *idx = (size_t)-1;
+    }
+
+    return s;
+}
+
+wxString wxMimeTypeCommands::GetVerbCmd(size_t n) const
+{
+    return m_verbs[n] + wxT('=') + m_commands[n];
+}
+
 // ----------------------------------------------------------------------------
 // wxFileTypeInfo
 // ----------------------------------------------------------------------------
 
-wxFileTypeInfo::wxFileTypeInfo(const char *mimeType,
-                               const char *openCmd,
-                               const char *printCmd,
-                               const char *desc,
-                               ...)
-              : m_mimeType(mimeType),
-                m_openCmd(openCmd),
-                m_printCmd(printCmd),
-                m_desc(desc)
+void wxFileTypeInfo::DoVarArgInit(const wxString& mimeType,
+                                  const wxString& openCmd,
+                                  const wxString& printCmd,
+                                  const wxString& desc,
+                                  va_list argptr)
 {
-    va_list argptr;
-    va_start(argptr, desc);
+    m_mimeType = mimeType;
+    m_openCmd = openCmd;
+    m_printCmd = printCmd;
+    m_desc = desc;
 
     for ( ;; )
     {
-        const char *ext = va_arg(argptr, const char *);
+        // icc gives this warning in its own va_arg() macro, argh
+#ifdef __INTELC__
+    #pragma warning(push)
+    #pragma warning(disable: 1684)
+#endif
+
+        wxArgNormalizedString ext(WX_VA_ARG_STRING(argptr));
+
+#ifdef __INTELC__
+    #pragma warning(pop)
+#endif
         if ( !ext )
         {
             // NULL terminates the list
             break;
         }
 
-        m_exts.Add(ext);
+        m_exts.Add(ext.GetString());
     }
+}
+
+void wxFileTypeInfo::VarArgInit(const wxString *mimeType,
+                                const wxString *openCmd,
+                                const wxString *printCmd,
+                                const wxString *desc,
+                                ...)
+{
+    va_list argptr;
+    va_start(argptr, desc);
+
+    DoVarArgInit(*mimeType, *openCmd, *printCmd, *desc, 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);
+WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo)
 
 // ============================================================================
 // implementation of the wrapper classes
@@ -114,25 +190,31 @@ WX_DEFINE_OBJARRAY(wxArrayFileTypeInfo);
 wxString wxFileType::ExpandCommand(const wxString& command,
                                    const wxFileType::MessageParameters& params)
 {
-    bool hasFilename = FALSE;
+    bool hasFilename = false;
+
+    // We consider that only the file names with spaces in them need to be
+    // handled specially. This is not perfect, but this can be done easily
+    // under all platforms while handling the file names with quotes in them,
+    // for example, needs to be done differently.
+    const bool needToQuoteFilename = params.GetFileName().find_first_of(" \t")
+                                        != wxString::npos;
 
     wxString str;
     for ( const wxChar *pc = command.c_str(); *pc != wxT('\0'); pc++ ) {
         if ( *pc == wxT('%') ) {
             switch ( *++pc ) {
                 case wxT('s'):
-                    // '%s' expands into file name (quoted because it might
-                    // contain spaces) - except if there are already quotes
-                    // there because otherwise some programs may get confused
-                    // by double double quotes
-#if 0
-                    if ( *(pc - 2) == wxT('"') )
-                        str << params.GetFileName();
-                    else
+                    // don't quote the file name if it's already quoted: notice
+                    // that we check for a quote following it and not preceding
+                    // it as at least under Windows we can have commands
+                    // containing "file://%s" (with quotes) in them so the
+                    // argument may be quoted even if there is no quote
+                    // directly before "%s" itself
+                    if ( needToQuoteFilename && pc[1] != '"' )
                         str << wxT('"') << params.GetFileName() << wxT('"');
-#endif
-                    str << params.GetFileName();
-                    hasFilename = TRUE;
+                    else
+                        str << params.GetFileName();
+                    hasFilename = true;
                     break;
 
                 case wxT('t'):
@@ -182,12 +264,20 @@ wxString wxFileType::ExpandCommand(const wxString& command,
     // 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.
-    if ( !hasFilename && !str.IsEmpty()
+
+    // test now carried out on reading file so test should never get here
+    if ( !hasFilename && !str.empty()
 #ifdef __UNIX__
-                      && !str.StartsWith(_T("test "))
+                      && !str.StartsWith(wxT("test "))
 #endif // Unix
-       ) {
-        str << wxT(" < '") << params.GetFileName() << wxT('\'');
+       )
+    {
+        str << wxT(" < ");
+        if ( needToQuoteFilename )
+            str << '"';
+        str << params.GetFileName();
+        if ( needToQuoteFilename )
+            str << '"';
     }
 
     return str;
@@ -216,7 +306,7 @@ bool wxFileType::GetExtensions(wxArrayString& extensions)
     if ( m_info )
     {
         extensions = m_info->GetExtensions();
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetExtensions(extensions);
@@ -224,13 +314,13 @@ bool wxFileType::GetExtensions(wxArrayString& extensions)
 
 bool wxFileType::GetMimeType(wxString *mimeType) const
 {
-    wxCHECK_MSG( mimeType, FALSE, _T("invalid parameter in GetMimeType") );
+    wxCHECK_MSG( mimeType, false, wxT("invalid parameter in GetMimeType") );
 
     if ( m_info )
     {
         *mimeType = m_info->GetMimeType();
 
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetMimeType(mimeType);
@@ -243,50 +333,58 @@ bool wxFileType::GetMimeTypes(wxArrayString& mimeTypes) const
         mimeTypes.Clear();
         mimeTypes.Add(m_info->GetMimeType());
 
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetMimeTypes(mimeTypes);
 }
 
-bool wxFileType::GetIcon(wxIcon *icon,
-                         wxString *iconFile,
-                         int *iconIndex) const
+bool wxFileType::GetIcon(wxIconLocation *iconLoc) 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() )
+        if ( iconLoc )
         {
-            // FIXME: what about the index?
-            icon->LoadFile(m_info->GetIconFile());
+            iconLoc->SetFileName(m_info->GetIconFile());
+#ifdef __WINDOWS__
+            iconLoc->SetIndex(m_info->GetIconIndex());
+#endif // __WINDOWS__
         }
-#endif // wxUSE_GUI
 
-        return TRUE;
+        return true;
     }
 
-#ifdef __WXMSW__
-    return m_impl->GetIcon(icon, iconFile, iconIndex);
-#else
-    return m_impl->GetIcon(icon);
-#endif
+    return m_impl->GetIcon(iconLoc);
+}
+
+bool
+wxFileType::GetIcon(wxIconLocation *iconloc,
+                    const MessageParameters& params) const
+{
+    if ( !GetIcon(iconloc) )
+    {
+        return false;
+    }
+
+    // we may have "%s" in the icon location string, at least under Windows, so
+    // expand this
+    if ( iconloc )
+    {
+        iconloc->SetFileName(ExpandCommand(iconloc->GetFileName(), params));
+    }
+
+    return true;
 }
 
 bool wxFileType::GetDescription(wxString *desc) const
 {
-    wxCHECK_MSG( desc, FALSE, _T("invalid parameter in GetDescription") );
+    wxCHECK_MSG( desc, false, wxT("invalid parameter in GetDescription") );
 
     if ( m_info )
     {
         *desc = m_info->GetDescription();
 
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetDescription(desc);
@@ -296,29 +394,41 @@ bool
 wxFileType::GetOpenCommand(wxString *openCmd,
                            const wxFileType::MessageParameters& params) const
 {
-    wxCHECK_MSG( openCmd, FALSE, _T("invalid parameter in GetOpenCommand") );
+    wxCHECK_MSG( openCmd, false, wxT("invalid parameter in GetOpenCommand") );
 
     if ( m_info )
     {
         *openCmd = ExpandCommand(m_info->GetOpenCommand(), params);
 
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetOpenCommand(openCmd, params);
 }
 
+wxString wxFileType::GetOpenCommand(const wxString& filename) const
+{
+    wxString cmd;
+    if ( !GetOpenCommand(&cmd, filename) )
+    {
+        // return empty string to indicate an error
+        cmd.clear();
+    }
+
+    return cmd;
+}
+
 bool
 wxFileType::GetPrintCommand(wxString *printCmd,
                             const wxFileType::MessageParameters& params) const
 {
-    wxCHECK_MSG( printCmd, FALSE, _T("invalid parameter in GetPrintCommand") );
+    wxCHECK_MSG( printCmd, false, wxT("invalid parameter in GetPrintCommand") );
 
     if ( m_info )
     {
         *printCmd = ExpandCommand(m_info->GetPrintCommand(), params);
 
-        return TRUE;
+        return true;
     }
 
     return m_impl->GetPrintCommand(printCmd, params);
@@ -334,9 +444,9 @@ size_t wxFileType::GetAllCommands(wxArrayString *verbs,
     if ( commands )
         commands->Clear();
 
-#ifdef __WXMSW__
+#if defined (__WINDOWS__)  || defined(__UNIX__)
     return m_impl->GetAllCommands(verbs, commands, params);
-#else // !__WXMSW__
+#else // !__WINDOWS__ || __UNIX__
     // we don't know how to retrieve all commands, so just try the 2 we know
     // about
     size_t count = 0;
@@ -344,7 +454,7 @@ size_t wxFileType::GetAllCommands(wxArrayString *verbs,
     if ( GetOpenCommand(&cmd, params) )
     {
         if ( verbs )
-            verbs->Add(_T("Open"));
+            verbs->Add(wxT("Open"));
         if ( commands )
             commands->Add(cmd);
         count++;
@@ -353,7 +463,7 @@ size_t wxFileType::GetAllCommands(wxArrayString *verbs,
     if ( GetPrintCommand(&cmd, params) )
     {
         if ( verbs )
-            verbs->Add(_T("Print"));
+            verbs->Add(wxT("Print"));
         if ( commands )
             commands->Add(cmd);
 
@@ -361,19 +471,84 @@ size_t wxFileType::GetAllCommands(wxArrayString *verbs,
     }
 
     return count;
-#endif // __WXMSW__/!__WXMSW__
+#endif // __WINDOWS__/| __UNIX__
 }
 
 bool wxFileType::Unassociate()
 {
-#if defined(__WXMSW__) || defined(__UNIX__)
+#if defined(__WINDOWS__)
     return m_impl->Unassociate();
+#elif defined(__UNIX__)
+    return m_impl->Unassociate(this);
+#else
+    wxFAIL_MSG( wxT("not implemented") ); // TODO
+    return false;
+#endif
+}
+
+bool wxFileType::SetCommand(const wxString& cmd,
+                            const wxString& verb,
+                            bool overwriteprompt)
+{
+#if defined (__WINDOWS__)  || defined(__UNIX__)
+    return m_impl->SetCommand(cmd, verb, overwriteprompt);
+#else
+    wxUnusedVar(cmd);
+    wxUnusedVar(verb);
+    wxUnusedVar(overwriteprompt);
+    wxFAIL_MSG(wxT("not implemented"));
+    return false;
+#endif
+}
+
+bool wxFileType::SetDefaultIcon(const wxString& cmd, int index)
+{
+    wxString sTmp = cmd;
+#ifdef __WINDOWS__
+    // VZ: should we do this?
+    // chris elliott : only makes sense in MS windows
+    if ( sTmp.empty() )
+        GetOpenCommand(&sTmp, wxFileType::MessageParameters(wxEmptyString, wxEmptyString));
+#endif
+    wxCHECK_MSG( !sTmp.empty(), false, wxT("need the icon file") );
+
+#if defined (__WINDOWS__) || defined(__UNIX__)
+    return m_impl->SetDefaultIcon (cmd, index);
 #else
-    wxFAIL_MSG( _T("not implemented") ); // TODO
-    return FALSE;
+    wxUnusedVar(index);
+    wxFAIL_MSG(wxT("not implemented"));
+    return false;
 #endif
 }
 
+// ----------------------------------------------------------------------------
+// wxMimeTypesManagerFactory
+// ----------------------------------------------------------------------------
+
+wxMimeTypesManagerFactory *wxMimeTypesManagerFactory::m_factory = NULL;
+
+/* static */
+void wxMimeTypesManagerFactory::Set(wxMimeTypesManagerFactory *factory)
+{
+    delete m_factory;
+
+    m_factory = factory;
+}
+
+/* static */
+wxMimeTypesManagerFactory *wxMimeTypesManagerFactory::Get()
+{
+    if ( !m_factory )
+        m_factory = new wxMimeTypesManagerFactory;
+
+    return m_factory;
+}
+
+wxMimeTypesManagerImpl *wxMimeTypesManagerFactory::CreateMimeTypesManagerImpl()
+{
+    return new wxMimeTypesManagerImpl;
+}
+
 // ----------------------------------------------------------------------------
 // wxMimeTypesManager
 // ----------------------------------------------------------------------------
@@ -381,7 +556,7 @@ bool wxFileType::Unassociate()
 void wxMimeTypesManager::EnsureImpl()
 {
     if ( !m_impl )
-        m_impl = new wxMimeTypesManagerImpl;
+        m_impl = wxMimeTypesManagerFactory::Get()->CreateMimeTypesManagerImpl();
 }
 
 bool wxMimeTypesManager::IsOfType(const wxString& mimeType,
@@ -390,21 +565,21 @@ bool wxMimeTypesManager::IsOfType(const wxString& mimeType,
     wxASSERT_MSG( mimeType.Find(wxT('*')) == wxNOT_FOUND,
                   wxT("first MIME type can't contain wildcards") );
 
-    // all comparaisons are case insensitive (2nd arg of IsSameAs() is FALSE)
+    // all comparaisons are case insensitive (2nd arg of IsSameAs() is false)
     if ( wildcard.BeforeFirst(wxT('/')).
-            IsSameAs(mimeType.BeforeFirst(wxT('/')), FALSE) )
+            IsSameAs(mimeType.BeforeFirst(wxT('/')), false) )
     {
         wxString strSubtype = wildcard.AfterFirst(wxT('/'));
 
         if ( strSubtype == wxT("*") ||
-             strSubtype.IsSameAs(mimeType.AfterFirst(wxT('/')), FALSE) )
+             strSubtype.IsSameAs(mimeType.AfterFirst(wxT('/')), false) )
         {
             // matches (either exactly or it's a wildcard)
-            return TRUE;
+            return true;
         }
     }
 
-    return FALSE;
+    return false;
 }
 
 wxMimeTypesManager::wxMimeTypesManager()
@@ -418,15 +593,28 @@ wxMimeTypesManager::~wxMimeTypesManager()
         delete m_impl;
 }
 
+bool wxMimeTypesManager::Unassociate(wxFileType *ft)
+{
+    EnsureImpl();
+
+#if defined(__UNIX__) && !defined(__CYGWIN__) && !defined(__WINE__)
+    return m_impl->Unassociate(ft);
+#else
+    return ft->Unassociate();
+#endif
+}
+
+
 wxFileType *
 wxMimeTypesManager::Associate(const wxFileTypeInfo& ftInfo)
 {
     EnsureImpl();
 
-#if defined(__WXMSW__) || defined(__UNIX__)
+#if defined(__WINDOWS__) || defined(__UNIX__)
     return m_impl->Associate(ftInfo);
 #else // other platforms
-    wxFAIL_MSG( _T("not implemented") ); // TODO
+    wxUnusedVar(ftInfo);
+    wxFAIL_MSG( wxT("not implemented") ); // TODO
     return NULL;
 #endif // platforms
 }
@@ -435,7 +623,18 @@ wxFileType *
 wxMimeTypesManager::GetFileTypeFromExtension(const wxString& ext)
 {
     EnsureImpl();
-    wxFileType *ft = m_impl->GetFileTypeFromExtension(ext);
+
+    wxString::const_iterator i = ext.begin();
+    const wxString::const_iterator end = ext.end();
+    wxString extWithoutDot;
+    if ( i != end && *i == '.' )
+        extWithoutDot.assign(++i, ext.end());
+    else
+        extWithoutDot = ext;
+
+    wxCHECK_MSG( !ext.empty(), NULL, wxT("extension can't be empty") );
+
+    wxFileType *ft = m_impl->GetFileTypeFromExtension(extWithoutDot);
 
     if ( !ft ) {
         // check the fallbacks
@@ -461,11 +660,11 @@ wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
     EnsureImpl();
     wxFileType *ft = m_impl->GetFileTypeFromMimeType(mimeType);
 
-    if ( ft ) {
+    if ( !ft ) {
         // check the fallbacks
         //
-        // TODO linear search is potentially slow, perhaps we should use a sorted
-        //      array?
+        // 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,
@@ -480,18 +679,6 @@ wxMimeTypesManager::GetFileTypeFromMimeType(const wxString& mimeType)
     return ft;
 }
 
-bool wxMimeTypesManager::ReadMailcap(const wxString& filename, bool fallback)
-{
-    EnsureImpl();
-    return m_impl->ReadMailcap(filename, fallback);
-}
-
-bool wxMimeTypesManager::ReadMimeTypes(const wxString& filename)
-{
-    EnsureImpl();
-    return m_impl->ReadMimeTypes(filename);
-}
-
 void wxMimeTypesManager::AddFallbacks(const wxFileTypeInfo *filetypes)
 {
     EnsureImpl();
@@ -517,6 +704,29 @@ size_t wxMimeTypesManager::EnumAllFileTypes(wxArrayString& mimetypes)
     return countAll;
 }
 
+void wxMimeTypesManager::Initialize(int mcapStyle,
+                                    const wxString& sExtraDir)
+{
+#if defined(__UNIX__) && !defined(__CYGWIN__) && !defined(__WINE__)
+    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(__CYGWIN__) && !defined(__WINE__)
+    EnsureImpl();
+
+    m_impl->ClearData();
+#endif // Unix
+}
+
 // ----------------------------------------------------------------------------
 // global data and wxMimeTypeCmnModule
 // ----------------------------------------------------------------------------
@@ -531,14 +741,16 @@ class wxMimeTypeCmnModule: public wxModule
 {
 public:
     wxMimeTypeCmnModule() : wxModule() { }
-    virtual bool OnInit() { return TRUE; }
+
+    virtual bool OnInit() { return true; }
     virtual void OnExit()
     {
-        // this avoids false memory leak allerts:
+        wxMimeTypesManagerFactory::Set(NULL);
+
         if ( gs_mimeTypesManager.m_impl != NULL )
         {
-            delete gs_mimeTypesManager.m_impl;
-            gs_mimeTypesManager.m_impl = NULL;
+            wxDELETE(gs_mimeTypesManager.m_impl);
+            gs_mimeTypesManager.m_fallbacks.Clear();
         }
     }
 
@@ -547,3 +759,4 @@ public:
 
 IMPLEMENT_DYNAMIC_CLASS(wxMimeTypeCmnModule, wxModule)
 
+#endif // wxUSE_MIMETYPE