]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/utilscmn.cpp
fixed wxXmlResource::Load's detection of filenames to be done as early as possible
[wxWidgets.git] / src / common / utilscmn.cpp
index 96b872759342db6c5defab8a45f83ab20f82f7a2..02befc3f4381b7239c687fcadc762e401d20984b 100644 (file)
@@ -54,7 +54,7 @@
 #include "wx/config.h"
 
 #if defined(__WXWINCE__) && wxUSE_DATETIME
-#include "wx/datetime.h"
+    #include "wx/datetime.h"
 #endif
 
 #include <ctype.h>
     #include "wx/statusbr.h"
 #endif // wxUSE_GUI
 
+#ifndef __WXPALMOS5__
 #ifndef __WXWINCE__
-#include <time.h>
+    #include <time.h>
 #else
-#include "wx/msw/wince/time.h"
+    #include "wx/msw/wince/time.h"
 #endif
+#endif // ! __WXPALMOS5__
 
 #ifdef __WXMAC__
-#include "wx/mac/private.h"
-#ifndef __DARWIN__
-#include "InternetConfig.h"
-#endif
+    #include "wx/osx/private.h"
 #endif
 
+#ifndef __WXPALMOS5__
 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
     #include <sys/types.h>
     #include <sys/stat.h>
 #endif
+#endif // ! __WXPALMOS5__
 
 #if defined(__WXMSW__)
     #include "wx/msw/private.h"
-    #include "wx/msw/registry.h"
-    #include <shellapi.h> // needed for SHELLEXECUTEINFO
+    #include "wx/filesys.h"
 #endif
 
-#if wxUSE_BASE
+#if wxUSE_GUI && defined(__WXGTK__)
+    #include <gtk/gtk.h>    // for GTK_XXX_VERSION constants
+#endif
 
-// ----------------------------------------------------------------------------
-// common data
-// ----------------------------------------------------------------------------
+#if wxUSE_BASE
 
 // ============================================================================
 // implementation
@@ -120,7 +120,7 @@ int wxHexToDec(const wxString& buf)
     if (buf.GetChar(0) >= wxT('A'))
         firstDigit = buf.GetChar(0) - wxT('A') + 10;
     else
-       firstDigit = buf.GetChar(0) - wxT('0');
+        firstDigit = buf.GetChar(0) - wxT('0');
 
     if (buf.GetChar(1) >= wxT('A'))
         secondDigit = buf.GetChar(1) - wxT('A') + 10;
@@ -161,6 +161,16 @@ wxString wxDecToHex(int dec)
 // misc functions
 // ----------------------------------------------------------------------------
 
+// Don't synthesize KeyUp events holding down a key and producing KeyDown
+// events with autorepeat. On by default and always on in wxMSW. wxGTK version
+// in utilsgtk.cpp.
+#ifndef __WXGTK__
+bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
+{
+    return true;    // detectable auto-repeat is the only mode MSW supports
+}
+#endif // !wxGTK
+
 // Return the current date/time
 wxString wxNow()
 {
@@ -172,17 +182,19 @@ wxString wxNow()
     return wxEmptyString;
 #endif
 #else
-    time_t now = time((time_t *) NULL);
+    time_t now = time(NULL);
     char *date = ctime(&now);
     date[24] = '\0';
     return wxString::FromAscii(date);
 #endif
 }
 
+#if WXWIN_COMPATIBILITY_2_8
 void wxUsleep(unsigned long milliseconds)
 {
     wxMilliSleep(milliseconds);
 }
+#endif
 
 const wxChar *wxGetInstallPrefix()
 {
@@ -219,6 +231,10 @@ bool wxIsPlatformLittleEndian()
 }
 
 
+// ----------------------------------------------------------------------------
+// wxPlatform
+// ----------------------------------------------------------------------------
+
 /*
  * Class to make it easier to specify platform-dependent values
  */
@@ -431,8 +447,7 @@ bool wxGetEmailAddress(wxChar *address, int maxSize)
     if ( !email )
         return false;
 
-    wxStrncpy(address, email, maxSize - 1);
-    address[maxSize - 1] = wxT('\0');
+    wxStrlcpy(address, email.t_str(), maxSize);
 
     return true;
 }
@@ -640,19 +655,9 @@ long wxExecute(const wxString& command,
 }
 
 // ----------------------------------------------------------------------------
-// wxApp::Yield() wrappers for backwards compatibility
+// Id functions
 // ----------------------------------------------------------------------------
 
-bool wxYield()
-{
-    return wxTheApp && wxTheApp->Yield();
-}
-
-bool wxYieldIfNeeded()
-{
-    return wxTheApp && wxTheApp->Yield(true);
-}
-
 // Id generation
 static long wxCurrentId = 100;
 
@@ -706,16 +711,16 @@ Thanks,
 
 /* Byte-wise swap two items of size SIZE. */
 #define SWAP(a, b, size)                                                      \
-  do                                                                              \
-    {                                                                              \
-      register size_t __size = (size);                                              \
-      register char *__a = (a), *__b = (b);                                      \
+  do                                                                          \
+    {                                                                         \
+      register size_t __size = (size);                                        \
+      register char *__a = (a), *__b = (b);                                   \
       do                                                                      \
-        {                                                                      \
-          char __tmp = *__a;                                                      \
+        {                                                                     \
+          char __tmp = *__a;                                                  \
           *__a++ = *__b;                                                      \
-          *__b++ = __tmp;                                                      \
-        } while (--__size > 0);                                                      \
+          *__b++ = __tmp;                                                     \
+        } while (--__size > 0);                                               \
     } while (0)
 
 /* Discontinue quicksort algorithm when partition gets below this size.
@@ -918,9 +923,9 @@ void wxQsort(void *const pbase, size_t total_elems,
   }
 }
 
+#endif // wxUSE_BASE
 
 
-#endif // wxUSE_BASE
 
 // ============================================================================
 // GUI-only functions from now on
@@ -932,181 +937,23 @@ void wxQsort(void *const pbase, size_t total_elems,
 // Launch default browser
 // ----------------------------------------------------------------------------
 
-#ifdef __WXCOCOA__
-// Private method in Objective-C++ source file.
-bool wxCocoaLaunchDefaultBrowser(const wxString& url, int flags);
-#endif
-
-bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)
-{
-    wxUnusedVar(flags);
-
-    // set the scheme of url to http if it does not have one
-    // RR: This doesn't work if the url is just a local path
-    wxString url(urlOrig);
-    wxURI uri(url);
-    if ( !uri.HasScheme() )
-    {
-        if (wxFileExists(urlOrig))
-            url.Prepend( wxT("file://") );
-        else
-            url.Prepend(wxT("http://"));
-    }
-
-
 #if defined(__WXMSW__)
 
-#if wxUSE_IPC
-    if ( flags & wxBROWSER_NEW_WINDOW )
-    {
-        // 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, uri.GetScheme() + _T("\\shell\\open"));
-        if ( !key.Exists() )
-        {
-            // try default browser, it must be registered at least for http URLs
-            key.SetName(wxRegKey::HKCR, _T("http\\shell\\open"));
-        }
-
-        if ( key.Exists() )
-        {
-            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();
-                }
+// implemented in a port-specific utils source file:
+bool wxDoLaunchDefaultBrowser(const wxString& url, const wxString& scheme, int flags);
 
-                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;
-                }
+#elif defined(__WXX11__) || defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXCOCOA__) || \
+      (defined(__WXMAC__) && !defined(__WXOSX_IPHONE__))
 
-                if ( ok )
-                {
-                    // and also replace the parameters: the topic should
-                    // contain a placeholder for the URL
-                    ok = ddeCmd.Replace(wxT("%1"), url, false) == 1;
-                }
+// implemented in a port-specific utils source file:
+bool wxDoLaunchDefaultBrowser(const wxString& url, int flags);
 
-                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
-
-    WinStruct<SHELLEXECUTEINFO> sei;
-    sei.lpFile = url.c_str();
-    sei.lpVerb = _T("open");
-    sei.nShow = SW_SHOWNORMAL;
-
-    ::ShellExecuteEx(&sei);
-
-    const int nResult = (int) sei.hInstApp;
-
-    // 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
-        if ( nResult == SE_ERR_FNF )
-            wxLogDebug(wxT("SE_ERR_FNF from ShellExecute -- maybe FireFox?"));
-#endif // __WXDEBUG__
-        return true;
-    }
-#elif defined(__WXCOCOA__)
-    // NOTE: We need to call the real implementation from src/cocoa/utils.mm
-    // because the code must use Objective-C features.
-    return wxCocoaLaunchDefaultBrowser(url, flags);
-#elif defined(__WXMAC__)
-    OSStatus err;
-    ICInstance inst;
-    long int startSel;
-    long int endSel;
-
-    err = ICStart(&inst, 'STKA'); // put your app creator code here
-    if (err == noErr)
-    {
-#if !TARGET_CARBON
-        err = ICFindConfigFile(inst, 0, NULL);
-#endif
-        if (err == noErr)
-        {
-            ConstStr255Param hint = 0;
-            startSel = 0;
-            endSel = url.length();
-            err = ICLaunchURL(inst, hint, url.fn_str(), endSel, &startSel, &endSel);
-            if (err != noErr)
-                wxLogDebug(wxT("ICLaunchURL error %d"), (int) err);
-        }
-        ICStop(inst);
-        return true;
-    }
-    else
-    {
-        wxLogDebug(wxT("ICStart error %d"), (int) err);
-        return false;
-    }
 #else
-    // (non-Mac, non-MSW)
 
-#ifdef __UNIX__
-
-    wxString desktop = wxTheApp->GetTraits()->GetDesktopEnvironment();
-
-    // GNOME and KDE desktops have some applications which should be always installed
-    // together with their main parts, which give us the
-    if (desktop == wxT("GNOME"))
-    {
-        wxArrayString errors;
-        wxArrayString output;
-
-        // gconf will tell us the path of the application to use as browser
-        long res = wxExecute( wxT("gconftool-2 --get /desktop/gnome/applications/browser/exec"),
-                              output, errors, wxEXEC_NODISABLE );
-        if (res >= 0 && errors.GetCount() == 0)
-        {
-            wxString cmd = output[0];
-            cmd << _T(' ') << url;
-            if (wxExecute(cmd))
-                return true;
-        }
-    }
-    else if (desktop == wxT("KDE"))
-    {
-        // kfmclient directly opens the given URL
-        if (wxExecute(wxT("kfmclient openURL ") + url))
-            return true;
-    }
-#endif
+// a "generic" implementation:
+bool wxDoLaunchDefaultBrowser(const wxString& url, int flags)
+{
+    // on other platforms try to use mime types or wxExecute...
 
     bool ok = false;
     wxString cmd;
@@ -1126,8 +973,7 @@ bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)
     if ( !ok || cmd.empty() )
     {
         // fallback to checking for the BROWSER environment variable
-        cmd = wxGetenv(wxT("BROWSER"));
-        if ( !cmd.empty() )
+        if ( !wxGetEnv(wxT("BROWSER"), &cmd) || cmd.empty() )
             cmd << _T(' ') << url;
     }
 
@@ -1136,24 +982,116 @@ bool wxLaunchDefaultBrowser(const wxString& urlOrig, int flags)
         return ok;
 
     // no file type for HTML extension
-    wxLogError(_T("No default application configured for HTML files."));
+    wxLogError(_("No default application configured for HTML files."));
+
+    return false;
+}
+#endif
+
+static bool DoLaunchDefaultBrowserHelper(const wxString& urlOrig, int flags)
+{
+    // NOTE: we don't have to care about the wxBROWSER_NOBUSYCURSOR flag
+    //       as it was already handled by wxLaunchDefaultBrowser
+
+    wxUnusedVar(flags);
+
+    wxString url(urlOrig), scheme;
+    wxURI uri(url);
 
-#endif // !wxUSE_MIMETYPE && !__WXMSW__
+    // this check is useful to avoid that wxURI recognizes as scheme parts of
+    // the filename, in case urlOrig is a local filename
+    // (e.g. "C:\\test.txt" when parsed by wxURI reports a scheme == "C")
+    bool hasValidScheme = uri.HasScheme() && 
+            (uri.GetScheme() == "http" || uri.GetScheme() == "file");
+
+#if defined(__WXMSW__)
+
+    // NOTE: when testing wxMSW's wxLaunchDefaultBrowser all possible forms
+    //       of the URL/flags should be tested; e.g.:
+    //
+    // for (int i=0; i<2; i++)
+    // {
+    //   wxLaunchDefaultBrowser("C:\\test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("file:/C%3A/test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("http://wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    // }
+    // (assuming you have a C:\test.txt file)
+
+    if ( !hasValidScheme )
+    {
+        if (wxFileExists(urlOrig) || wxDirExists(urlOrig))
+        {
+            scheme = "file";
+            // do not prepend the file scheme to the URL as ShellExecuteEx() doesn't like it
+        }
+        else
+        {
+            url.Prepend(wxS("http://"));
+            scheme = "http";
+        }
+    }
+    else if ( hasValidScheme )
+    {
+        scheme = uri.GetScheme();
 
-    wxLogSysError(_T("Failed to open URL \"%s\" in default browser."),
+        if ( uri.GetScheme() == "file" )
+        {
+            // TODO: extract URLToFileName() to some always compiled in
+            //       function
+#if wxUSE_FILESYSTEM
+            // ShellExecuteEx() doesn't like the "file" scheme when opening local files; 
+            // remove it
+            url = wxFileSystem::URLToFileName(url).GetFullPath();
+#endif // wxUSE_FILESYSTEM
+        }
+    }
+
+    if (wxDoLaunchDefaultBrowser(url, scheme, flags))
+        return true;
+    //else: call wxLogSysError
+#else
+    if ( !hasValidScheme )
+    {
+        // set the scheme of url to "http" or "file" if it does not have one
+        if (wxFileExists(urlOrig) || wxDirExists(urlOrig))
+            url.Prepend(wxS("file://"));
+        else
+            url.Prepend(wxS("http://"));
+    }
+
+    if (wxDoLaunchDefaultBrowser(url, flags))
+        return true;
+    //else: call wxLogSysError
+#endif
+
+    wxLogSysError(_("Failed to open URL \"%s\" in default browser."),
                   url.c_str());
 
     return false;
 }
 
+bool wxLaunchDefaultBrowser(const wxString& url, int flags)
+{
+    // NOTE: as documented, "url" may be both a real well-formed URL
+    //       and a local file name
+
+    if ( flags & wxBROWSER_NOBUSYCURSOR )
+        return DoLaunchDefaultBrowserHelper(url, flags);
+
+    wxBusyCursor bc;
+    return DoLaunchDefaultBrowserHelper(url, flags);
+}
+
 // ----------------------------------------------------------------------------
 // Menu accelerators related functions
 // ----------------------------------------------------------------------------
 
+#if WXWIN_COMPATIBILITY_2_6
 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 {
 #if wxUSE_MENUS
-    wxString s = wxMenuItem::GetLabelFromText(in);
+    wxString s = wxMenuItem::GetLabelText(in);
 #else
     wxString str(in);
     wxString s = wxStripMenuCodes(str);
@@ -1171,6 +1109,7 @@ wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 
     return out;
 }
+#endif
 
 wxString wxStripMenuCodes(const wxString& in, int flags)
 {
@@ -1242,13 +1181,19 @@ wxFindWindowByName (const wxString& name, wxWindow * parent)
 
 // Returns menu item id or wxNOT_FOUND if none.
 int
-wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
+wxFindMenuItemId(wxFrame *frame,
+                 const wxString& menuString,
+                 const wxString& itemString)
 {
 #if wxUSE_MENUS
     wxMenuBar *menuBar = frame->GetMenuBar ();
     if ( menuBar )
         return menuBar->FindMenuItem (menuString, itemString);
-#endif // wxUSE_MENUS
+#else // !wxUSE_MENUS
+    wxUnusedVar(frame);
+    wxUnusedVar(menuString);
+    wxUnusedVar(itemString);
+#endif // wxUSE_MENUS/!wxUSE_MENUS
 
     return wxNOT_FOUND;
 }
@@ -1362,6 +1307,46 @@ int wxMessageBox(const wxString& message, const wxString& caption, long style,
     return wxCANCEL;
 }
 
+void wxInfoMessageBox(wxWindow* parent)
+{
+    // don't translate these strings, they're for diagnostics purposes only
+    wxString msg;
+    msg.Printf(_T("wxWidgets Library (%s port)\n")
+               _T("Version %d.%d.%d%s%s, compiled at %s %s\n")
+               _T("Runtime version of toolkit used is %d.%d.%s\n")
+               _T("Copyright (c) 1995-2009 wxWidgets team"),
+               wxPlatformInfo::Get().GetPortIdName().c_str(),
+               wxMAJOR_VERSION,
+               wxMINOR_VERSION,
+               wxRELEASE_NUMBER,
+#if wxUSE_UNICODE
+               L" (Unicode)",
+#else
+               wxEmptyString,
+#endif
+#ifdef __WXDEBUG__
+               _T(" Debug build"),
+#else
+               wxEmptyString,
+#endif
+               __TDATE__,
+               __TTIME__,
+               wxPlatformInfo::Get().GetToolkitMajorVersion(),
+               wxPlatformInfo::Get().GetToolkitMinorVersion(),
+#ifdef __WXGTK__
+               wxString::Format("\nThe compile-time GTK+ version is %d.%d.%d.",
+                                GTK_MAJOR_VERSION,
+                                GTK_MINOR_VERSION,
+                                GTK_MICRO_VERSION).c_str()
+#else
+               wxEmptyString
+#endif
+               );
+    wxMessageBox(msg, _T("wxWidgets information"),
+                 wxICON_INFORMATION | wxOK,
+                 parent);
+}
+
 #endif // wxUSE_MSGDLG
 
 #if wxUSE_TEXTDLG
@@ -1416,24 +1401,56 @@ wxString wxGetPasswordFromUser(const wxString& message,
 
 #if wxUSE_COLOURDLG
 
-wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit, const wxString& caption)
+wxColour wxGetColourFromUser(wxWindow *parent,
+                             const wxColour& colInit,
+                             const wxString& caption,
+                             wxColourData *ptrData)
 {
+    // contains serialized representation of wxColourData used the last time
+    // the dialog was shown: we want to reuse it the next time in order to show
+    // the same custom colours to the user (and we can't just have static
+    // wxColourData itself because it's a GUI object and so should be destroyed
+    // before GUI shutdown and doing it during static cleanup is too late)
+    static wxString s_strColourData;
+
     wxColourData data;
-    data.SetChooseFull(true);
-    if ( colInit.Ok() )
+    if ( !ptrData )
     {
-        data.SetColour((wxColour &)colInit); // const_cast
+        ptrData = &data;
+        if ( !s_strColourData.empty() )
+        {
+            if ( !data.FromString(s_strColourData) )
+            {
+                wxFAIL_MSG( "bug in wxColourData::FromString()?" );
+            }
+
+#ifdef __WXMSW__
+            // we don't get back the "choose full" flag value from the native
+            // dialog and so we can't preserve it between runs, so we decide to
+            // always use it as it seems better than not using it (user can
+            // just ignore the extra controls in the dialog but having to click
+            // a button each time to show them would be very annoying
+            data.SetChooseFull(true);
+#endif // __WXMSW__
+        }
+    }
+
+    if ( colInit.IsOk() )
+    {
+        ptrData->SetColour(colInit);
     }
 
     wxColour colRet;
-    wxColourDialog dialog(parent, &data);
+    wxColourDialog dialog(parent, ptrData);
     if (!caption.empty())
         dialog.SetTitle(caption);
     if ( dialog.ShowModal() == wxID_OK )
     {
-        colRet = dialog.GetColourData().GetColour();
+        *ptrData = dialog.GetColourData();
+        colRet = ptrData->GetColour();
+        s_strColourData = ptrData->ToString();
     }
-    //else: leave it invalid
+    //else: leave colRet invalid
 
     return colRet;
 }
@@ -1476,7 +1493,20 @@ void wxEnableTopLevelWindows(bool enable)
         node->GetData()->Enable(enable);
 }
 
+wxWindowDisabler::wxWindowDisabler(bool disable)
+{
+    m_disabled = disable;
+    if ( disable )
+        DoDisable();
+}
+
 wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
+{
+    m_disabled = true;
+    DoDisable(winToSkip);
+}
+
+void wxWindowDisabler::DoDisable(wxWindow *winToSkip)
 {
     // remember the top level windows which were already disabled, so that we
     // don't reenable them later
@@ -1508,6 +1538,9 @@ wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
 
 wxWindowDisabler::~wxWindowDisabler()
 {
+    if ( !m_disabled )
+        return;
+
     wxWindowList::compatibility_iterator node;
     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
     {
@@ -1537,14 +1570,18 @@ bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
     return rc;
 }
 
-// Don't synthesize KeyUp events holding down a key and producing KeyDown
-// events with autorepeat. On by default and always on in wxMSW. wxGTK version
-// in utilsgtk.cpp.
-#ifndef __WXGTK__
-bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
+// ----------------------------------------------------------------------------
+// wxApp::Yield() wrappers for backwards compatibility
+// ----------------------------------------------------------------------------
+
+bool wxYield()
 {
-    return true;    // detectable auto-repeat is the only mode MSW supports
+    return wxTheApp && wxTheApp->Yield();
+}
+
+bool wxYieldIfNeeded()
+{
+    return wxTheApp && wxTheApp->Yield(true);
 }
-#endif // !wxGTK
 
 #endif // wxUSE_GUI