]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/mimetype.cpp
warning fix - only use the function in debug mode
[wxWidgets.git] / src / msw / mimetype.cpp
index a453c99079fd80138c9054de71807a9fb1bf9388..0e27060a7e06d33936710d027c06278f7e61b57d 100644 (file)
@@ -6,10 +6,10 @@
 // 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)
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef    __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma implementation "mimetype.h"
 #endif
 
@@ -22,9 +22,6 @@
 
 #if wxUSE_MIMETYPE
 
-// Doesn't compile in WIN16 mode
-#ifndef __WIN16__
-
 #ifndef WX_PRECOMP
     #include "wx/string.h"
     #if wxUSE_GUI
@@ -35,6 +32,7 @@
 
 #include "wx/log.h"
 #include "wx/file.h"
+#include "wx/iconloc.h"
 #include "wx/intl.h"
 #include "wx/dynarray.h"
 #include "wx/confbase.h"
@@ -76,6 +74,33 @@ class WXDLLEXPORT wxIcon;
 // location, uses it, so it isn't likely to change
 static const wxChar *MIME_DATABASE_KEY = wxT("MIME\\Database\\Content Type\\");
 
+// this function replaces Microsoft %1 with Unix-like %s
+static bool CanonicalizeParams(wxString& command)
+{
+    // transform it from '%1' to '%s' style format string (now also test for %L
+    // as apparently MS started using it as well for the same purpose)
+
+    // NB: we don't make any attempt to verify that the string is valid, i.e.
+    //     doesn't contain %2, or second %1 or .... But we do make sure that we
+    //     return a string with _exactly_ one '%s'!
+    bool foundFilename = false;
+    size_t len = command.length();
+    for ( size_t n = 0; (n < len) && !foundFilename; n++ )
+    {
+        if ( command[n] == wxT('%') &&
+                (n + 1 < len) &&
+                (command[n + 1] == wxT('1') || command[n + 1] == wxT('L')) )
+        {
+            // replace it with '%s'
+            command[n + 1] = wxT('s');
+
+            foundFilename = true;
+        }
+    }
+
+    return foundFilename;
+}
+
 void wxFileTypeImpl::Init(const wxString& strFileType, const wxString& ext)
 {
     // VZ: does it? (FIXME)
@@ -110,7 +135,7 @@ size_t wxFileTypeImpl::GetAllCommands(wxArrayString *verbs,
         // get it from the registry
         wxFileTypeImpl *self = wxConstCast(this, wxFileTypeImpl);
         wxRegKey rkey(wxRegKey::HKCR, m_ext);
-        if ( !rkey.Exists() || !rkey.QueryValue(_T(""), self->m_strFileType) )
+        if ( !rkey.Exists() || !rkey.QueryValue(wxEmptyString, self->m_strFileType) )
         {
             wxLogDebug(_T("Can't get the filetype for extension '%s'."),
                        m_ext.c_str());
@@ -163,15 +188,15 @@ bool wxFileTypeImpl::EnsureExtKeyExists()
     wxRegKey rkey(wxRegKey::HKCR, m_ext);
     if ( !rkey.Exists() )
     {
-        if ( !rkey.Create() || !rkey.SetValue(_T(""), m_strFileType) )
+        if ( !rkey.Create() || !rkey.SetValue(wxEmptyString, m_strFileType) )
         {
             wxLogError(_("Failed to create registry entry for '%s' files."),
                        m_ext.c_str());
-            return FALSE;
+            return false;
         }
     }
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -198,44 +223,25 @@ wxString wxFileTypeImpl::GetCommand(const wxChar *verb) const
     strKey << wxT("\\shell\\") << verb;
     wxRegKey key(wxRegKey::HKCR, strKey + _T("\\command"));
     wxString command;
-    if ( key.Open() ) {
+    if ( key.Open(wxRegKey::Read) ) {
         // it's the default value of the key
-        if ( key.QueryValue(wxT(""), command) ) {
-            // transform it from '%1' to '%s' style format string (now also
-            // test for %L - apparently MS started using it as well for the
-            // same purpose)
-
-            // NB: we don't make any attempt to verify that the string is valid,
-            //     i.e. doesn't contain %2, or second %1 or .... But we do make
-            //     sure that we return a string with _exactly_ one '%s'!
-            bool foundFilename = FALSE;
-            size_t len = command.Len();
-            for ( size_t n = 0; (n < len) && !foundFilename; n++ ) {
-                if ( command[n] == wxT('%') &&
-                     (n + 1 < len) &&
-                     (command[n + 1] == wxT('1') ||
-                      command[n + 1] == wxT('L')) ) {
-                    // replace it with '%s'
-                    command[n + 1] = wxT('s');
-
-                    foundFilename = TRUE;
-                }
-            }
+        if ( key.QueryValue(wxEmptyString, command) ) {
+            bool foundFilename = CanonicalizeParams(command);
 
 #if wxUSE_IPC
             // look whether we must issue some DDE requests to the application
             // (and not just launch it)
             strKey += _T("\\DDEExec");
             wxRegKey keyDDE(wxRegKey::HKCR, strKey);
-            if ( keyDDE.Open() ) {
+            if ( keyDDE.Open(wxRegKey::Read) ) {
                 wxString ddeCommand, ddeServer, ddeTopic;
-                keyDDE.QueryValue(_T(""), ddeCommand);
+                keyDDE.QueryValue(wxEmptyString, ddeCommand);
                 ddeCommand.Replace(_T("%1"), _T("%s"));
 
                 wxRegKey(wxRegKey::HKCR, strKey + _T("\\Application")).
-                    QueryValue(_T(""), ddeServer);
+                    QueryValue(wxEmptyString, ddeServer);
                 wxRegKey(wxRegKey::HKCR, strKey + _T("\\Topic")).
-                    QueryValue(_T(""), ddeTopic);
+                    QueryValue(wxEmptyString, ddeTopic);
 
                 if (ddeTopic.IsEmpty())
                     ddeTopic = wxT("System");
@@ -250,7 +256,8 @@ wxString wxFileTypeImpl::GetCommand(const wxChar *verb) const
             }
             else
 #endif // wxUSE_IPC
-                if ( !foundFilename ) {
+            if ( !foundFilename )
+            {
                 // we didn't find any '%1' - the application doesn't know which
                 // file to open (note that we only do it if there is no DDEExec
                 // subkey)
@@ -299,14 +306,14 @@ bool wxFileTypeImpl::GetExtensions(wxArrayString& extensions)
     if ( m_ext.IsEmpty() ) {
         // the only way to get the list of extensions from the file type is to
         // scan through all extensions in the registry - too slow...
-        return FALSE;
+        return false;
     }
     else {
         extensions.Empty();
         extensions.Add(m_ext);
 
         // it's a lie too, we don't return _all_ extensions...
-        return TRUE;
+        return true;
     }
 }
 
@@ -316,7 +323,8 @@ bool wxFileTypeImpl::GetMimeType(wxString *mimeType) const
     wxLogNull nolog;
     wxRegKey key(wxRegKey::HKCR, m_ext);
 
-    return key.Open() && key.QueryValue(wxT("Content Type"), *mimeType);
+    return key.Open(wxRegKey::Read) &&
+                key.QueryValue(wxT("Content Type"), *mimeType);
 }
 
 bool wxFileTypeImpl::GetMimeTypes(wxArrayString& mimeTypes) const
@@ -325,20 +333,17 @@ bool wxFileTypeImpl::GetMimeTypes(wxArrayString& mimeTypes) const
 
     if ( !GetMimeType(&s) )
     {
-        return FALSE;
+        return false;
     }
 
     mimeTypes.Clear();
     mimeTypes.Add(s);
-    return TRUE;
+    return true;
 }
 
 
-bool wxFileTypeImpl::GetIcon(wxIcon *icon,
-                             wxString *iconFile,
-                             int *iconIndex) const
+bool wxFileTypeImpl::GetIcon(wxIconLocation *iconLoc) const
 {
-#if wxUSE_GUI
     wxString strIconKey;
     strIconKey << m_strFileType << wxT("\\DefaultIcon");
 
@@ -346,10 +351,10 @@ bool wxFileTypeImpl::GetIcon(wxIcon *icon,
     wxLogNull nolog;
     wxRegKey key(wxRegKey::HKCR, strIconKey);
 
-    if ( key.Open() ) {
+    if ( key.Open(wxRegKey::Read) ) {
         wxString strIcon;
         // it's the default value of the key
-        if ( key.QueryValue(wxT(""), strIcon) ) {
+        if ( key.QueryValue(wxEmptyString, strIcon) ) {
             // the format is the following: <full path to file>, <icon index>
             // NB: icon index may be negative as well as positive and the full
             //     path may contain the environment variables inside '%'
@@ -363,35 +368,19 @@ bool wxFileTypeImpl::GetIcon(wxIcon *icon,
                 strIndex = wxT("0");
             }
 
-            wxString strExpPath = wxExpandEnvVars(strFullPath);
-            // here we need C based counting!
-            int nIndex = wxAtoi(strIndex);
-
-            HICON hIcon = ExtractIcon(GetModuleHandle(NULL), strExpPath, nIndex);
-            switch ( (int)hIcon ) {
-                case 0: // means no icons were found
-                case 1: // means no such file or it wasn't a DLL/EXE/OCX/ICO/...
-                    wxLogDebug(wxT("incorrect registry entry '%s': no such icon."),
-                               key.GetName().c_str());
-                    break;
-
-                default:
-                    icon->SetHICON((WXHICON)hIcon);
-                    wxSize size = wxGetHiconSize(hIcon);
-                    icon->SetSize(size);
-                    if ( iconIndex )
-                        *iconIndex = nIndex;
-                    if ( iconFile )
-                        *iconFile = strFullPath;
-                    return TRUE;
+            if ( iconLoc )
+            {
+                iconLoc->SetFileName(wxExpandEnvVars(strFullPath));
+
+                iconLoc->SetIndex(wxAtoi(strIndex));
             }
+
+            return true;
         }
     }
 
     // no such file type or no value or incorrect icon entry
-#endif // wxUSE_GUI
-
-    return FALSE;
+    return false;
 }
 
 bool wxFileTypeImpl::GetDescription(wxString *desc) const
@@ -400,14 +389,14 @@ bool wxFileTypeImpl::GetDescription(wxString *desc) const
     wxLogNull nolog;
     wxRegKey key(wxRegKey::HKCR, m_strFileType);
 
-    if ( key.Open() ) {
+    if ( key.Open(wxRegKey::Read) ) {
         // it's the default value of the key
-        if ( key.QueryValue(wxT(""), *desc) ) {
-            return TRUE;
+        if ( key.QueryValue(wxEmptyString, *desc) ) {
+            return true;
         }
     }
 
-    return FALSE;
+    return false;
 }
 
 // helper function
@@ -433,13 +422,13 @@ wxMimeTypesManagerImpl::GetFileTypeFromExtension(const wxString& ext)
     // suppress possible error messages
     wxLogNull nolog;
 
-    bool knownExtension = FALSE;
+    bool knownExtension = false;
 
     wxString strFileType;
     wxRegKey key(wxRegKey::HKCR, str);
-    if ( key.Open() ) {
+    if ( key.Open(wxRegKey::Read) ) {
         // it's the default value of the key
-        if ( key.QueryValue(wxT(""), strFileType) ) {
+        if ( key.QueryValue(wxEmptyString, strFileType) ) {
             // create the new wxFileType object
             return CreateFileType(strFileType, ext);
         }
@@ -447,7 +436,7 @@ wxMimeTypesManagerImpl::GetFileTypeFromExtension(const wxString& ext)
             // this extension doesn't have a filetype, but it's known to the
             // system and may be has some other useful keys (open command or
             // content-type), so still return a file type object for it
-            knownExtension = TRUE;
+            knownExtension = true;
         }
     }
 
@@ -486,7 +475,7 @@ wxMimeTypesManagerImpl::GetFileTypeFromMimeType(const wxString& mimeType)
 
     wxString ext;
     wxRegKey key(wxRegKey::HKCR, strKey);
-    if ( key.Open() ) {
+    if ( key.Open(wxRegKey::Read) ) {
         if ( key.QueryValue(wxT("Extension"), ext) ) {
             return GetFileTypeFromExtension(ext);
         }
@@ -523,7 +512,7 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
     wxCHECK_MSG( !ftInfo.GetExtensions().IsEmpty(), NULL,
                  _T("Associate() needs extension") );
 
-    bool ok = FALSE ;
+    bool ok;
     int iExtCount = 0 ;
     wxString filetype;
     wxString extWithDot;
@@ -560,7 +549,7 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
                 filetype = filetypeOrig;
             }
 
-            ok = key.SetValue(_T(""), filetype);
+            key.SetValue(wxEmptyString, filetype);
         }
         }
         else
@@ -569,11 +558,11 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
             if (!filetypeOrig.empty())
                 {
                     filetype = filetypeOrig;
-                    ok = key.SetValue(_T(""), filetype);
+                    key.SetValue(wxEmptyString, filetype);
                 }
             else
                 {
-                    ok = key.QueryValue(_T(""), filetype);
+                    key.QueryValue(wxEmptyString, filetype);
                 }
         }
         // now set a mimetypeif we have it, but ignore it if none
@@ -594,7 +583,7 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
                 if ( ok )
                 {
                     // and provide a back link to the extension
-                    ok = keyMIME.SetValue(_T("Extension"), extWithDot);
+                    keyMIME.SetValue(_T("Extension"), extWithDot);
                 }
             }
         }
@@ -610,8 +599,8 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
             extWithDot += ext;
 
             wxRegKey key(wxRegKey::HKCR, extWithDot);
-            if ( !key.Exists() ) ok = key.Create();
-            ok = key.SetValue(_T(""), filetype);
+            if ( !key.Exists() ) key.Create();
+            key.SetValue(wxEmptyString, filetype);
 
         // now set any mimetypes we may have, but ignore it if none
         const wxString& mimetype = ftInfo.GetMimeType();
@@ -631,7 +620,7 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
         if ( ok )
         {
                     // and provide a back link to the extension
-                    ok = keyMIME.SetValue(_T("Extension"), extWithDot);
+                    keyMIME.SetValue(_T("Extension"), extWithDot);
         }
         }
     }
@@ -642,10 +631,9 @@ wxFileType *wxMimeTypesManagerImpl::Associate(const wxFileTypeInfo& ftInfo)
     // create the filetype key itself (it will be empty for now, but
     // SetCommand(), SetDefaultIcon() &c will use it later)
     wxRegKey keyFT(wxRegKey::HKCR, filetype);
-    ok = keyFT.Create();
+    keyFT.Create();
 
-    wxFileType *ft = NULL;
-    ft = CreateFileType(filetype, extWithDot);
+    wxFileType *ft = CreateFileType(filetype, extWithDot);
 
     if (ft)
     {
@@ -663,11 +651,11 @@ bool wxFileTypeImpl::SetCommand(const wxString& cmd,
                                 const wxString& verb,
                                 bool WXUNUSED(overwriteprompt))
 {
-    wxCHECK_MSG( !m_ext.IsEmpty() && !verb.IsEmpty(), FALSE,
+    wxCHECK_MSG( !m_ext.IsEmpty() && !verb.IsEmpty(), false,
                  _T("SetCommand() needs an extension and a verb") );
 
     if ( !EnsureExtKeyExists() )
-        return FALSE;
+        return false;
 
     wxRegKey rkey(wxRegKey::HKCR, GetVerbPath(verb));
 #if 0
@@ -675,7 +663,7 @@ bool wxFileTypeImpl::SetCommand(const wxString& cmd,
     {
 #if wxUSE_GUI
         wxString old;
-        rkey.QueryValue(wxT(""), old);
+        rkey.QueryValue(wxEmptyString, old);
         if ( wxMessageBox
              (
                 wxString::Format(
@@ -692,23 +680,23 @@ bool wxFileTypeImpl::SetCommand(const wxString& cmd,
 #endif // wxUSE_GUI
         {
             // cancelled by user
-            return FALSE;
+            return false;
         }
     }
 #endif
     // TODO:
     // 1. translate '%s' to '%1' instead of always adding it
     // 2. create DDEExec value if needed (undo GetCommand)
-    return rkey.Create() && rkey.SetValue(_T(""), cmd + _T(" \"%1\"") );
+    return rkey.Create() && rkey.SetValue(wxEmptyString, cmd + _T(" \"%1\"") );
 }
 
 /* // no longer used
 bool wxFileTypeImpl::SetMimeType(const wxString& mimeTypeOrig)
 {
-    wxCHECK_MSG( !m_ext.IsEmpty(), FALSE, _T("SetMimeType() needs extension") );
+    wxCHECK_MSG( !m_ext.IsEmpty(), false, _T("SetMimeType() needs extension") );
 
     if ( !EnsureExtKeyExists() )
-        return FALSE;
+        return false;
 
     // VZ: is this really useful? (FIXME)
     wxString mimeType;
@@ -731,33 +719,33 @@ bool wxFileTypeImpl::SetMimeType(const wxString& mimeTypeOrig)
 
 bool wxFileTypeImpl::SetDefaultIcon(const wxString& cmd, int index)
 {
-    wxCHECK_MSG( !m_ext.IsEmpty(), FALSE, _T("SetDefaultIcon() needs extension") );
-    wxCHECK_MSG( !m_strFileType.IsEmpty(), FALSE, _T("File key not found") );
+    wxCHECK_MSG( !m_ext.IsEmpty(), false, _T("SetDefaultIcon() needs extension") );
+    wxCHECK_MSG( !m_strFileType.IsEmpty(), false, _T("File key not found") );
 //    the next line fails on a SMBshare, I think because it is case mangled
-//    wxCHECK_MSG( !wxFileExists(cmd), FALSE, _T("Icon file not found.") );
+//    wxCHECK_MSG( !wxFileExists(cmd), false, _T("Icon file not found.") );
 
     if ( !EnsureExtKeyExists() )
-        return FALSE;
+        return false;
 
     wxRegKey rkey(wxRegKey::HKCR, m_strFileType + _T("\\DefaultIcon"));
 
     return rkey.Create() &&
-           rkey.SetValue(_T(""),
+           rkey.SetValue(wxEmptyString,
                          wxString::Format(_T("%s,%d"), cmd.c_str(), index));
 }
 
 bool wxFileTypeImpl::SetDescription (const wxString& desc)
 {
-    wxCHECK_MSG( !m_strFileType.IsEmpty(), FALSE, _T("File key not found") );
-    wxCHECK_MSG( !desc.IsEmpty(), FALSE, _T("No file description supplied") );
+    wxCHECK_MSG( !m_strFileType.IsEmpty(), false, _T("File key not found") );
+    wxCHECK_MSG( !desc.IsEmpty(), false, _T("No file description supplied") );
 
     if ( !EnsureExtKeyExists() )
-        return FALSE;
+        return false;
 
     wxRegKey rkey(wxRegKey::HKCR, m_strFileType );
 
     return rkey.Create() &&
-           rkey.SetValue(_T(""), desc);
+           rkey.SetValue(wxEmptyString, desc);
 }
 
 // ----------------------------------------------------------------------------
@@ -766,15 +754,15 @@ bool wxFileTypeImpl::SetDescription (const wxString& desc)
 
 bool wxFileTypeImpl::Unassociate()
 {
-    bool result = TRUE;
+    bool result = true;
     if ( !RemoveOpenCommand() )
-        result = FALSE;
+        result = false;
     if ( !RemoveDefaultIcon() )
-        result = FALSE;
+        result = false;
     if ( !RemoveMimeType() )
-        result = FALSE;
+        result = false;
    if ( !RemoveDescription() )
-        result = FALSE;
+        result = false;
 
 /*
     //this might hold other keys, eg some have CSLID keys
@@ -796,7 +784,7 @@ bool wxFileTypeImpl::RemoveOpenCommand()
 
 bool wxFileTypeImpl::RemoveCommand(const wxString& verb)
 {
-    wxCHECK_MSG( !m_ext.IsEmpty() && !verb.IsEmpty(), FALSE,
+    wxCHECK_MSG( !m_ext.IsEmpty() && !verb.IsEmpty(), false,
                  _T("RemoveCommand() needs an extension and a verb") );
 
     wxString  sKey = m_strFileType;
@@ -808,7 +796,7 @@ bool wxFileTypeImpl::RemoveCommand(const wxString& verb)
 
 bool wxFileTypeImpl::RemoveMimeType()
 {
-    wxCHECK_MSG( !m_ext.IsEmpty(), FALSE, _T("RemoveMimeType() needs extension") );
+    wxCHECK_MSG( !m_ext.IsEmpty(), false, _T("RemoveMimeType() needs extension") );
 
     wxRegKey rkey(wxRegKey::HKCR, m_ext);
     return !rkey.Exists() || rkey.DeleteSelf();
@@ -816,7 +804,7 @@ bool wxFileTypeImpl::RemoveMimeType()
 
 bool wxFileTypeImpl::RemoveDefaultIcon()
 {
-    wxCHECK_MSG( !m_ext.IsEmpty(), FALSE,
+    wxCHECK_MSG( !m_ext.IsEmpty(), false,
                  _T("RemoveDefaultIcon() needs extension") );
 
     wxRegKey rkey (wxRegKey::HKCR, m_strFileType  + _T("\\DefaultIcon"));
@@ -825,14 +813,11 @@ bool wxFileTypeImpl::RemoveDefaultIcon()
 
 bool wxFileTypeImpl::RemoveDescription()
 {
-    wxCHECK_MSG( !m_ext.IsEmpty(), FALSE,
+    wxCHECK_MSG( !m_ext.IsEmpty(), false,
                  _T("RemoveDescription() needs extension") );
 
     wxRegKey rkey (wxRegKey::HKCR, m_strFileType );
     return !rkey.Exists() || rkey.DeleteSelf();
 }
 
-#endif
-  // __WIN16__
-
 #endif // wxUSE_MIMETYPE