]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/utilscmn.cpp
Make wxPORTRAIT and wxLANDSCAPE elements of wxPrintOrientation enum.
[wxWidgets.git] / src / common / utilscmn.cpp
index f2ad803605b37c70fdb9535a6cc176f291aaffbc..ad0c64ef16df9226de2c51702fee578f505e438f 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>
 
 #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/osx/private.h"
+    #include "wx/osx/private.h"
 #endif
 
 #ifndef __WXPALMOS5__
@@ -96,8 +96,7 @@
 
 #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_GUI && defined(__WXGTK__)
 // ============================================================================
 
 // Array used in DecToHex conversion routine.
-static wxChar hexArray[] = wxT("0123456789ABCDEF");
+static const wxChar hexArray[] = wxT("0123456789ABCDEF");
 
 // Convert 2-digit hex number to decimal
 int wxHexToDec(const wxString& buf)
@@ -162,16 +161,6 @@ 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()
 {
@@ -183,17 +172,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()
 {
@@ -544,7 +535,7 @@ wxString wxGetCurrentDir()
         {
             if ( errno != ERANGE )
             {
-                wxLogSysError(_T("Failed to get current directory"));
+                wxLogSysError(wxT("Failed to get current directory"));
 
                 return wxEmptyString;
             }
@@ -572,7 +563,7 @@ wxString wxGetCurrentDir()
 #if wxUSE_STREAMS
 static bool ReadAll(wxInputStream *is, wxArrayString& output)
 {
-    wxCHECK_MSG( is, false, _T("NULL stream in wxExecute()?") );
+    wxCHECK_MSG( is, false, wxT("NULL stream in wxExecute()?") );
 
     // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
     is->Reset();
@@ -932,227 +923,43 @@ void wxQsort(void *const pbase, size_t total_elems,
 
 #if wxUSE_GUI
 
-// ----------------------------------------------------------------------------
-// Launch document with default app
-// ----------------------------------------------------------------------------
-
-bool wxLaunchDefaultApplication(const wxString& document, int flags)
+// this function is only really implemented for X11-based ports, including GTK1
+// (GTK2 sets detectable auto-repeat automatically anyhow)
+#if !(defined(__WXX11__) || defined(__WXMOTIF__) || \
+        (defined(__WXGTK__) && !defined(__WXGTK20__)))
+bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
 {
-    wxUnusedVar(flags);
-
-#ifdef __WXMAC__
-    static const char * const OPEN_CMD = "/usr/bin/open";
-    if ( wxFileExists(OPEN_CMD) &&
-            wxExecute(wxString(OPEN_CMD) + " " + document) )
-        return true;
-#elif defined(__UNIX__)
-    // Our best best is to use xdg-open from freedesktop.org cross-desktop
-    // compatibility suite xdg-utils
-    // (see http://portland.freedesktop.org/wiki/) -- this is installed on
-    // most modern distributions and may be tweaked by them to handle
-    // distribution specifics.
-    wxString path, xdg_open;
-    if ( wxGetEnv("PATH", &path) &&
-         wxFindFileInPath(&xdg_open, path, "xdg-open") )
-    {
-        if ( wxExecute(xdg_open + " " + document) )
-            return true;
-    }
-#elif defined(__WXMSW__)
-    WinStruct<SHELLEXECUTEINFO> sei;
-    sei.lpFile = document.wx_str();
-    sei.lpVerb = _T("open");
-#ifdef __WXWINCE__
-    sei.nShow = SW_SHOWNORMAL; // SW_SHOWDEFAULT not defined under CE (#10216)
-#else
-    sei.nShow = SW_SHOWDEFAULT;
-#endif
-
-    // avoid Windows message box in case of error for consistency with
-    // wxLaunchDefaultBrowser() even if don't show the error ourselves in this
-    // function
-    sei.fMask = SEE_MASK_FLAG_NO_UI;
-
-    if ( ::ShellExecuteEx(&sei) )
-        return true;
-#endif
-
-    return false;
+    return true;
 }
+#endif // !X11-based port
 
 // ----------------------------------------------------------------------------
 // Launch default browser
 // ----------------------------------------------------------------------------
 
-#ifdef __WXCOCOA__
-// Private method in Objective-C++ source file.
-bool wxCocoaLaunchDefaultBrowser(const wxString& url, int flags);
-#endif
-
-static bool DoLaunchDefaultBrowser(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"));
-        }
+// implemented in a port-specific utils source file:
+bool wxDoLaunchDefaultBrowser(const wxString& url, const wxString& scheme, int flags);
 
-        if ( key.Exists() )
-        {
-            wxRegKey keyDDE(key, wxT("DDEExec"));
-            if ( keyDDE.Exists() )
-            {
-                // we only know the syntax of WWW_OpenURL DDE request for IE,
-                // optimistically assume that all other browsers are compatible
-                // with it
-                static const wxChar *TOPIC_OPEN_URL = wxT("WWW_OpenURL");
-                wxString ddeCmd;
-                wxRegKey keyTopic(keyDDE, wxT("topic"));
-                bool ok = keyTopic.Exists() &&
-                            keyTopic.QueryDefaultValue() == TOPIC_OPEN_URL;
-                if ( ok )
-                {
-                    ddeCmd = keyDDE.QueryDefaultValue();
-                    ok = !ddeCmd.empty();
-                }
+#elif defined(__WXX11__) || defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXCOCOA__) || \
+      (defined(__WXMAC__) && !defined(__WXOSX_IPHONE__))
 
-                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 occurrence */) == 1;
-                }
+// implemented in a port-specific utils source file:
+bool wxDoLaunchDefaultBrowser(const wxString& url, int flags);
 
-                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, TOPIC_OPEN_URL, 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;
-    sei.fMask = SEE_MASK_FLAG_NO_UI; // we give error message ourselves
-
-    if ( ::ShellExecuteEx(&sei) )
-        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__) && !defined(__WXOSX_IPHONE__)
-    wxCFRef< CFURLRef > curl( CFURLCreateWithString( kCFAllocatorDefault,
-            wxCFStringRef( url ), NULL ) );
-    OSStatus err = LSOpenCFURLRef( curl , NULL );
-
-    if (err == noErr)
-    {
-        return true;
-    }
-    else
-    {
-        wxLogDebug(wxT("Browser Launch error %d"), (int) err);
-        return false;
-    }
 #else
-    // (non-Mac, non-MSW)
-
-#ifdef __UNIX__
-
-    // Our best best is to use xdg-open from freedesktop.org cross-desktop
-    // compatibility suite xdg-utils
-    // (see http://portland.freedesktop.org/wiki/) -- this is installed on
-    // most modern distributions and may be tweaked by them to handle
-    // distribution specifics. Only if that fails, try to find the right
-    // browser ourselves.
-    wxString path, xdg_open;
-    if ( wxGetEnv("PATH", &path) &&
-         wxFindFileInPath(&xdg_open, path, "xdg-open") )
-    {
-        if ( wxExecute(xdg_open + " " + url) )
-            return true;
-    }
-
-    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;
 
 #if wxUSE_MIMETYPE
-    wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(_T("html"));
+    wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension(wxT("html"));
     if ( ft )
     {
         wxString mt;
@@ -1166,9 +973,8 @@ static bool DoLaunchDefaultBrowser(const wxString& urlOrig, int flags)
     if ( !ok || cmd.empty() )
     {
         // fallback to checking for the BROWSER environment variable
-        cmd = wxGetenv(wxT("BROWSER"));
-        if ( !cmd.empty() )
-            cmd << _T(' ') << url;
+        if ( !wxGetEnv(wxT("BROWSER"), &cmd) || cmd.empty() )
+            cmd << wxT(' ') << url;
     }
 
     ok = ( !cmd.empty() && wxExecute(cmd) );
@@ -1178,7 +984,89 @@ static bool DoLaunchDefaultBrowser(const wxString& urlOrig, int flags)
     // no file type for HTML extension
     wxLogError(_("No default application configured for HTML files."));
 
-#endif // !wxUSE_MIMETYPE && !__WXMSW__
+    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);
+
+    // 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().length() > 1;
+
+#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++)
+    // {
+    //   // test arguments without a valid URL scheme:
+    //   wxLaunchDefaultBrowser("C:\\test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //
+    //   // test arguments with different valid schemes:
+    //   wxLaunchDefaultBrowser("file:/C%3A/test.txt", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("http://wxwidgets.org", i==0 ? 0 : wxBROWSER_NEW_WINDOW);
+    //   wxLaunchDefaultBrowser("mailto:user@host.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();
+
+        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());
@@ -1188,17 +1076,21 @@ static bool DoLaunchDefaultBrowser(const wxString& urlOrig, int flags)
 
 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 DoLaunchDefaultBrowser(url, flags);
+        return DoLaunchDefaultBrowserHelper(url, flags);
 
     wxBusyCursor bc;
-    return DoLaunchDefaultBrowser(url, flags);
+    return DoLaunchDefaultBrowserHelper(url, flags);
 }
 
 // ----------------------------------------------------------------------------
 // Menu accelerators related functions
 // ----------------------------------------------------------------------------
 
+#if WXWIN_COMPATIBILITY_2_6
 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 {
 #if wxUSE_MENUS
@@ -1220,10 +1112,11 @@ wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 
     return out;
 }
+#endif
 
 wxString wxStripMenuCodes(const wxString& in, int flags)
 {
-    wxASSERT_MSG( flags, _T("this is useless to call without any flags") );
+    wxASSERT_MSG( flags, wxT("this is useless to call without any flags") );
 
     wxString out;
 
@@ -1233,14 +1126,14 @@ wxString wxStripMenuCodes(const wxString& in, int flags)
     for ( size_t n = 0; n < len; n++ )
     {
         wxChar ch = in[n];
-        if ( (flags & wxStrip_Mnemonics) && ch == _T('&') )
+        if ( (flags & wxStrip_Mnemonics) && ch == wxT('&') )
         {
             // skip it, it is used to introduce the accel char (or to quote
             // itself in which case it should still be skipped): note that it
             // can't be the last character of the string
             if ( ++n == len )
             {
-                wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
+                wxLogDebug(wxT("Invalid menu string '%s'"), in.c_str());
             }
             else
             {
@@ -1248,7 +1141,7 @@ wxString wxStripMenuCodes(const wxString& in, int flags)
                 ch = in[n];
             }
         }
-        else if ( (flags & wxStrip_Accel) && ch == _T('\t') )
+        else if ( (flags & wxStrip_Accel) && ch == wxT('\t') )
         {
             // everything after TAB is accel string, exit the loop
             break;
@@ -1390,14 +1283,14 @@ wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
 int wxMessageBox(const wxString& message, const wxString& caption, long style,
                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 {
-    long decorated_style = style;
-
-    if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
+    // add the appropriate icon unless this was explicitly disabled by use of
+    // wxICON_NONE
+    if ( !(style & wxICON_NONE) && !(style & wxICON_MASK) )
     {
-        decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
+        style |= style & wxYES ? wxICON_QUESTION : wxICON_INFORMATION;
     }
 
-    wxMessageDialog dialog(parent, message, caption, decorated_style);
+    wxMessageDialog dialog(parent, message, caption, style);
 
     int ans = dialog.ShowModal();
     switch ( ans )
@@ -1412,7 +1305,7 @@ int wxMessageBox(const wxString& message, const wxString& caption, long style,
             return wxCANCEL;
     }
 
-    wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
+    wxFAIL_MSG( wxT("unexpected return code from wxMessageDialog") );
 
     return wxCANCEL;
 }
@@ -1421,38 +1314,38 @@ 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-2008 wxWidgets team"),
-               wxPlatformInfo::Get().GetPortIdName().c_str(),
+    msg.Printf(wxS("wxWidgets Library (%s port)\n")
+               wxS("Version %d.%d.%d (Unicode: %s, debug level: %d),\n")
+               wxS("compiled at %s %s\n\n")
+               wxS("Runtime version of toolkit used is %d.%d.\n"),
+               wxPlatformInfo::Get().GetPortIdName(),
                wxMAJOR_VERSION,
                wxMINOR_VERSION,
                wxRELEASE_NUMBER,
-#if wxUSE_UNICODE
-               L" (Unicode)",
+#if wxUSE_UNICODE_UTF8
+               "UTF-8",
+#elif wxUSE_UNICODE
+               "wchar_t",
 #else
-               wxEmptyString,
-#endif
-#ifdef __WXDEBUG__
-               _T(" Debug build"),
-#else
-               wxEmptyString,
+               "none",
 #endif
+               wxDEBUG_LEVEL,
                __TDATE__,
                __TTIME__,
                wxPlatformInfo::Get().GetToolkitMajorVersion(),
-               wxPlatformInfo::Get().GetToolkitMinorVersion(),
+               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"),
+    msg += wxString::Format("Compile-time GTK+ version is %d.%d.%d.\n",
+                            GTK_MAJOR_VERSION,
+                            GTK_MINOR_VERSION,
+                            GTK_MICRO_VERSION);
+#endif // __WXGTK__
+
+    msg += wxS("\nCopyright (c) 1995-2009 wxWidgets team");
+
+    wxMessageBox(msg, wxT("wxWidgets information"),
                  wxICON_INFORMATION | wxOK,
                  parent);
 }