minor refactoring of menu UpdateUI handling

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

diff --git a/src/common/utilscmn.cpp b/src/common/utilscmn.cpp
index 8c42075b45ceb308c5d9f60fab9946c91b9867b5..b048ccd3c6e617ebffabefdb593d7a95d3b15872 100644 (file)
--- a/src/common/utilscmn.cpp
+++ b/src/common/utilscmn.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     Miscellaneous utility functions and classes
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     Miscellaneous utility functions and classes
 // Author:      Julian Smart
 // Modified by:


@@ -17,17 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
-// Some older compilers (such as EMX) cannot handle
-// #pragma interface/implementation correctly, iff
-// #pragma implementation is used in _two_ translation
-// units (as created by e.g. event.cpp compiled for
-// libwx_base and event.cpp compiled for libwx_gui_core).
-// So we must not use those pragmas for those compilers in
-// such files.
-    #pragma implementation "utils.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -100,6 +89,7 @@
 
 #if defined(__WXMSW__)
     #include "wx/msw/private.h"
 
 #if defined(__WXMSW__)
     #include "wx/msw/private.h"

+    #include "wx/msw/registry.h"

 #endif
 
 #if wxUSE_BASE
 #endif
 
 #if wxUSE_BASE


@@ -108,11 +98,6 @@
 // common data
 // ----------------------------------------------------------------------------
 
 // common data
 // ----------------------------------------------------------------------------
 

-#if WXWIN_COMPATIBILITY_2_2
-    const wxChar *wxInternalErrorStr = wxT("wxWidgets Internal Error");
-    const wxChar *wxFatalErrorStr = wxT("wxWidgets Fatal Error");
-#endif // WXWIN_COMPATIBILITY_2_2
-

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -122,13 +107,13 @@
 wxChar *
 copystring (const wxChar *s)
 {
 wxChar *
 copystring (const wxChar *s)
 {

-  if (s == NULL) s = wxEmptyString;
-  size_t len = wxStrlen (s) + 1;
+    if (s == NULL) s = wxEmptyString;
+    size_t len = wxStrlen (s) + 1;

 
 

-  wxChar *news = new wxChar[len];
-  memcpy (news, s, len * sizeof(wxChar));    // Should be the fastest
+    wxChar *news = new wxChar[len];
+    memcpy (news, s, len * sizeof(wxChar));    // Should be the fastest

 
 

-  return news;
+    return news;

 }
 
 #endif // WXWIN_COMPATIBILITY_2_4
 }
 
 #endif // WXWIN_COMPATIBILITY_2_4


@@ -145,65 +130,65 @@ WXDLLIMPEXP_DATA_BASE(const wxChar *) wxDoubleToStringStr = wxT("%.2f");
 void
 StringToFloat (const wxChar *s, float *number)
 {
 void
 StringToFloat (const wxChar *s, float *number)
 {

-  if (s && *s && number)
-    *number = (float) wxStrtod (s, (wxChar **) NULL);
+    if (s && *s && number)
+        *number = (float) wxStrtod (s, (wxChar **) NULL);

 }
 
 void
 StringToDouble (const wxChar *s, double *number)
 {
 }
 
 void
 StringToDouble (const wxChar *s, double *number)
 {

-  if (s && *s && number)
-    *number = wxStrtod (s, (wxChar **) NULL);
+    if (s && *s && number)
+        *number = wxStrtod (s, (wxChar **) NULL);

 }
 
 wxChar *
 FloatToString (float number, const wxChar *fmt)
 {
 }
 
 wxChar *
 FloatToString (float number, const wxChar *fmt)
 {

-  static wxChar buf[256];
+    static wxChar buf[256];

 
 

-  wxSprintf (buf, fmt, number);
-  return buf;
+    wxSprintf (buf, fmt, number);
+    return buf;

 }
 
 wxChar *
 DoubleToString (double number, const wxChar *fmt)
 {
 }
 
 wxChar *
 DoubleToString (double number, const wxChar *fmt)
 {

-  static wxChar buf[256];
+    static wxChar buf[256];

 
 

-  wxSprintf (buf, fmt, number);
-  return buf;
+    wxSprintf (buf, fmt, number);
+    return buf;

 }
 
 void
 StringToInt (const wxChar *s, int *number)
 {
 }
 
 void
 StringToInt (const wxChar *s, int *number)
 {

-  if (s && *s && number)
-    *number = (int) wxStrtol (s, (wxChar **) NULL, 10);
+    if (s && *s && number)
+        *number = (int) wxStrtol (s, (wxChar **) NULL, 10);

 }
 
 void
 StringToLong (const wxChar *s, long *number)
 {
 }
 
 void
 StringToLong (const wxChar *s, long *number)
 {

-  if (s && *s && number)
-    *number = wxStrtol (s, (wxChar **) NULL, 10);
+    if (s && *s && number)
+        *number = wxStrtol (s, (wxChar **) NULL, 10);

 }
 
 wxChar *
 IntToString (int number)
 {
 }
 
 wxChar *
 IntToString (int number)
 {

-  static wxChar buf[20];
+    static wxChar buf[20];

 
 

-  wxSprintf (buf, wxT("%d"), number);
-  return buf;
+    wxSprintf (buf, wxT("%d"), number);
+    return buf;

 }
 
 wxChar *
 LongToString (long number)
 {
 }
 
 wxChar *
 LongToString (long number)
 {

-  static wxChar buf[20];
+    static wxChar buf[20];

 
 

-  wxSprintf (buf, wxT("%ld"), number);
-  return buf;
+    wxSprintf (buf, wxT("%ld"), number);
+    return buf;

 }
 
 #endif // WXWIN_COMPATIBILITY_2_4
 }
 
 #endif // WXWIN_COMPATIBILITY_2_4


@@ -214,29 +199,29 @@ static wxChar hexArray[] = wxT("0123456789ABCDEF");
 // Convert 2-digit hex number to decimal
 int wxHexToDec(const wxString& buf)
 {
 // Convert 2-digit hex number to decimal
 int wxHexToDec(const wxString& buf)
 {

-  int firstDigit, secondDigit;
+    int firstDigit, secondDigit;

 
 

-  if (buf.GetChar(0) >= wxT('A'))
-    firstDigit = buf.GetChar(0) - wxT('A') + 10;
-  else
-    firstDigit = buf.GetChar(0) - wxT('0');
+    if (buf.GetChar(0) >= wxT('A'))
+        firstDigit = buf.GetChar(0) - wxT('A') + 10;
+    else
+       firstDigit = buf.GetChar(0) - wxT('0');

 
 

-  if (buf.GetChar(1) >= wxT('A'))
-    secondDigit = buf.GetChar(1) - wxT('A') + 10;
-  else
-    secondDigit = buf.GetChar(1) - wxT('0');
+    if (buf.GetChar(1) >= wxT('A'))
+        secondDigit = buf.GetChar(1) - wxT('A') + 10;
+    else
+        secondDigit = buf.GetChar(1) - wxT('0');

 
 

-  return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
+    return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );

 }
 
 // Convert decimal integer to 2-character hex string
 void wxDecToHex(int dec, wxChar *buf)
 {
 }
 
 // Convert decimal integer to 2-character hex string
 void wxDecToHex(int dec, wxChar *buf)
 {

-  int firstDigit = (int)(dec/16.0);
-  int secondDigit = (int)(dec - (firstDigit*16.0));
-  buf[0] = hexArray[firstDigit];
-  buf[1] = hexArray[secondDigit];
-  buf[2] = 0;
+    int firstDigit = (int)(dec/16.0);
+    int secondDigit = (int)(dec - (firstDigit*16.0));
+    buf[0] = hexArray[firstDigit];
+    buf[1] = hexArray[secondDigit];
+    buf[2] = 0;

 }
 
 // Convert decimal integer to 2-character hex string
 }
 
 // Convert decimal integer to 2-character hex string


@@ -531,147 +516,130 @@ long wxExecute(const wxString& command,
 // Launch default browser
 // ----------------------------------------------------------------------------
 
 // Launch default browser
 // ----------------------------------------------------------------------------
 

-bool wxLaunchDefaultBrowser(const wxString& url)
+bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)

 {
 {

-    wxString finalurl = url;
+    wxUnusedVar(flags);

 
 

-    //if it isn't a full url, try appending http:// to it
-    if(wxURI(url).IsReference())
-        finalurl = wxString(wxT("http://")) + url;
+    // set the scheme of url to http if it does not have one
+    wxString url(urlOrig);
+    if ( !wxURI(url).HasScheme() )
+        url.Prepend(wxT("http://"));

 
 

-#ifdef __WINDOWS__
-    wxString command;
+#if defined(__WXMSW__)

 
 

-    // ShellExecute() always opens in the same window,
-    // so do it manually for new window (from Mahogany)
-    wxRegKey key(wxRegKey::HKCR, url.BeforeFirst(':') + wxT("\\shell\\open"));
-    if ( key.Exists() )
+#if wxUSE_IPC
+    if ( flags & wxBROWSER_NEW_WINDOW )

     {
     {

-        wxRegKey keyDDE(key, wxT("DDEExec"));
-        if ( keyDDE.Exists() )
+        // ShellExecuteEx() opens the URL in an existing window by default so
+        // we can't use it if we need a new window
+        wxRegKey key(wxRegKey::HKCR, url.BeforeFirst(':') + _T("\\shell\\open"));
+        if ( key.Exists() )

         {
         {

-           wxString ddeTopic = wxRegKey(keyDDE, wxT("topic"));
-
-           // we only know the syntax of WWW_OpenURL DDE request
-           if ( ddeTopic == wxT("WWW_OpenURL") )
-           {
-              wxString ddeCmd = keyDDE;
-
-              // this is a bit naive but should work as -1 can't appear
-              // elsewhere in the DDE topic, normally
-              if ( ddeCmd.Replace(wxT("-1"), wxT("0"),
-                                  FALSE /* only first occurence */) == 1 )
-              {
-                 // and also replace the parameters
-                 if ( ddeCmd.Replace(wxT("%1"), url, FALSE) == 1 )
-                 {
-                    // magic incantation understood by wxMSW
-                    command << wxT("WX_DDE#")
-                            << wxRegKey(key, wxT("command")).QueryDefaultValue() << wxT('#')
-                            << wxRegKey(keyDDE, wxT("application")).QueryDefaultValue()
-                            << wxT('#') << ddeTopic << wxT('#')
-                            << ddeCmd;
-                 }
-              }
-           }
+            wxRegKey keyDDE(key, wxT("DDEExec"));
+            if ( keyDDE.Exists() )
+            {
+                const wxString ddeTopic = wxRegKey(keyDDE, wxT("topic"));
+
+                // we only know the syntax of WWW_OpenURL DDE request for IE,
+                // optimistically assume that all other browsers are compatible
+                // with it
+                wxString ddeCmd;
+                bool ok = ddeTopic == wxT("WWW_OpenURL");
+                if ( ok )
+                {
+                    ddeCmd = keyDDE.QueryDefaultValue();
+                    ok = !ddeCmd.empty();
+                }
+
+                if ( ok )
+                {
+                    // for WWW_OpenURL, the index of the window to open the URL
+                    // in is -1 (meaning "current") by default, replace it with
+                    // 0 which means "new" (see KB article 160957)
+                    ok = ddeCmd.Replace(wxT("-1"), wxT("0"),
+                                        false /* only first occurence */) == 1;
+                }
+
+                if ( ok )
+                {
+                    // and also replace the parameters: the topic should
+                    // contain a placeholder for the URL
+                    ok = ddeCmd.Replace(wxT("%1"), url, false) == 1;
+                }
+
+                if ( ok )
+                {
+                    // try to send it the DDE request now but ignore the errors
+                    wxLogNull noLog;
+
+                    const wxString ddeServer = wxRegKey(keyDDE, wxT("application"));
+                    if ( wxExecuteDDE(ddeServer, ddeTopic, ddeCmd) )
+                        return true;
+
+                    // this is not necessarily an error: maybe browser is
+                    // simply not running, but no matter, in any case we're
+                    // going to launch it using ShellExecuteEx() below now and
+                    // we shouldn't try to open a new window if we open a new
+                    // browser anyhow
+                }
+            }

         }
     }
         }
     }

+#endif // wxUSE_IPC

 
 

-      //Try wxExecute - if it doesn't work or the regkey stuff
-      //above failed, fallback to opening the file in the same
-      //browser window
-      if ( command.empty() || wxExecute(command) == -1)
-      {
-          // CYGWIN and MINGW may have problems - so load ShellExecute
-          // dynamically
-         typedef HINSTANCE (*LPShellExecute)(HWND hwnd, const wxChar* lpOperation,
-                                             const wxChar* lpFile, 
-                                             const wxChar* lpParameters, 
-                                             const wxChar* lpDirectory, 
-                                             INT nShowCmd);
-
-         HINSTANCE hShellDll = ::LoadLibrary(wxT("shell32.dll"));
-         if(hShellDll == NULL)
-             return false;
-
-         LPShellExecute lpShellExecute = 
-             (LPShellExecute) ::GetProcAddress(hShellDll, 
-             wxString::Format(wxT("ShellExecute%s"), 
-
-#ifdef __WXUNICODE__
-             wxT("W")
-#else
-             wxT("A")
-#endif
-#ifdef __WXWINCE__
-                             )
-#else
-                             ).mb_str(wxConvLocal)
-#endif
-                             );
-         if(lpShellExecute == NULL)
-             return false;
-
-        // Windows sometimes doesn't open the browser correctly when using mime
-        // types, so do ShellExecute - i.e. start <url> (from James Carroll)
-        unsigned int nResult = (int) (*lpShellExecute)(NULL, NULL, finalurl.c_str(), 
-                          NULL, wxT(""), SW_SHOWNORMAL);
+    WinStruct<SHELLEXECUTEINFO> sei;
+    sei.lpFile = url.c_str();
+    sei.lpVerb = _T("open");
+    sei.nShow = SW_SHOWNORMAL;

 
 

-        // Unload Shell32.dll
-        ::FreeLibrary(hShellDll);
+    ::ShellExecuteEx(&sei);

 
 

-        // Hack for Firefox (returns file not found for some reason)
-        // from Angelo Mandato's wxHyperlinksCtrl
-        // HINSTANCE_ERROR == 32
-        if (nResult <= HINSTANCE_ERROR && nResult != SE_ERR_FNF)
-            return false;    
+    const int nResult = (int) sei.hInstApp;

 
 

-    #   ifdef __WXDEBUG__
+    // Firefox returns file not found for some reason, so make an exception
+    // for it
+    if ( nResult > 32 || nResult == SE_ERR_FNF )
+    {
+#ifdef __WXDEBUG__

         // Log something if SE_ERR_FNF happens
         // Log something if SE_ERR_FNF happens

-        if(nResult == SE_ERR_FNF)
-            wxLogDebug(wxT("Got SE_ERR_FNF from ShellExecute - maybe FireFox"));
-    #   endif
-      }
-
-#else
-#if wxUSE_MIMETYPE
+        if ( nResult == SE_ERR_FNF )
+            wxLogDebug(wxT("SE_ERR_FNF from ShellExecute -- maybe FireFox?"));
+#endif // __WXDEBUG__
+        return true;
+    }
+#elif wxUSE_MIMETYPE

     // Non-windows way
     // Non-windows way

-    wxFileType *ft = 
-    wxTheMimeTypesManager->GetFileTypeFromExtension (_T("html")); 
-    if (!ft) 
-    { 
-        wxLogError(_T("No default application can open .html extension")); 
-        return false; 
-    } 
-
-    wxString mt;
-    ft->GetMimeType(&mt);
-
-    wxString cmd; 
-    bool ok = 
-    ft->GetOpenCommand (&cmd, 
-        wxFileType::MessageParameters (finalurl.c_str(), 
-                                       _T(""))); 
-    delete ft; 
-    
-    if (ok) 
+    wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension (_T("html"));
+    if ( ft )

     {
     {

-        if( wxExecute (cmd, wxEXEC_ASYNC) == -1 )
+        wxString mt;
+        ft->GetMimeType(&mt);
+
+        wxString cmd;
+        bool ok = ft->GetOpenCommand(&cmd, wxFileType::MessageParameters(url));
+        delete ft;
+
+        if ( !ok || cmd.empty() )

         {
         {

-            wxLogError(_T("Failed to launch application for wxLaunchDefaultBrowser"));
-            return false;
+            // fallback to checking for the BROWSER environment variable
+            cmd = wxGetenv(wxT("BROWSER"));
+            if ( !cmd.empty() )
+                cmd << _T(' ') << url;

         }
         }

+
+        if ( !cmd.empty() && wxExecute(cmd) )
+            return true;

     }
     }

-    else
-      return false;
-#else
-      return false;
-#endif //!wxUSE_MIMETYPE
+    else // no file type for html extension
+    {
+        wxLogError(_T("No default application configured for HTML files."));
+    }
+#endif // !wxUSE_MIMETYPE && !__WXMSW__

 
 

-#endif
+    wxLogSysError(_T("Failed to open URL \"%s\" in default browser."),
+                  url.c_str());

 
 

-    //success - hopefully
-    return true;
+    return false;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -1114,4 +1082,3 @@ bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
 #endif // !wxGTK
 
 #endif // wxUSE_GUI
 #endif // !wxGTK
 
 #endif // wxUSE_GUI

-