Hopefully fixed library names generated by wx-config for OS/2's PM port.
[wxWidgets.git] / src / common / utilscmn.cpp
index 449bafe65fea735a240a8776d68455f8c0dd87dc..8bb3fcd9828b168a830bfe0dd36be814cfe721da 100644 (file)
@@ -19,7 +19,7 @@
 
 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
 // Some older compilers (such as EMX) cannot handle
-// #pragma interface/implementation correctly, iff 
+// #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).
@@ -60,6 +60,9 @@
 
 #include "wx/process.h"
 #include "wx/txtstrm.h"
+#include "wx/uri.h"
+#include "wx/mimetype.h"
+#include "wx/config.h"
 
 #if defined(__WXWINCE__) && wxUSE_DATETIME
 #include "wx/datetime.h"
@@ -95,7 +98,7 @@
     #include <sys/stat.h>
 #endif
 
-#ifdef __WXMSW__
+#if defined(__WXMSW__)
     #include "wx/msw/private.h"
 #endif
 
 // ----------------------------------------------------------------------------
 
 #if WXWIN_COMPATIBILITY_2_2
-    const wxChar *wxInternalErrorStr = wxT("wxWindows Internal Error");
-    const wxChar *wxFatalErrorStr = wxT("wxWindows Fatal Error");
+    const wxChar *wxInternalErrorStr = wxT("wxWidgets Internal Error");
+    const wxChar *wxFatalErrorStr = wxT("wxWidgets Fatal Error");
 #endif // WXWIN_COMPATIBILITY_2_2
 
 // ============================================================================
 wxChar *
 copystring (const wxChar *s)
 {
-  if (s == NULL) s = wxT("");
-  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
@@ -142,65 +145,65 @@ WXDLLIMPEXP_DATA_BASE(const wxChar *) wxDoubleToStringStr = wxT("%.2f");
 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)
 {
-  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)
 {
-  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)
 {
-  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)
 {
-  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)
 {
-  if (s && *s && number)
-    *number = wxStrtol (s, (wxChar **) NULL, 10);
+    if (s && *s && number)
+        *number = wxStrtol (s, (wxChar **) NULL, 10);
 }
 
 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)
 {
-  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
@@ -211,29 +214,29 @@ static wxChar hexArray[] = wxT("0123456789ABCDEF");
 // 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)
 {
-  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
@@ -266,6 +269,11 @@ wxString wxNow()
 #endif
 }
 
+void wxUsleep(unsigned long milliseconds)
+{
+    wxMilliSleep(milliseconds);
+}
+
 const wxChar *wxGetInstallPrefix()
 {
     wxString prefix;
@@ -276,19 +284,14 @@ const wxChar *wxGetInstallPrefix()
 #ifdef wxINSTALL_PREFIX
     return wxT(wxINSTALL_PREFIX);
 #else
-    return wxT("");
+    return wxEmptyString;
 #endif
 }
 
 wxString wxGetDataDir()
 {
-    wxString format = wxGetInstallPrefix();
-    format <<  wxFILE_SEP_PATH
-           << wxT("share") << wxFILE_SEP_PATH
-           << wxT("wx") << wxFILE_SEP_PATH
-           << wxT("%i.%i");
-    wxString dir;
-    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
+    wxString dir = wxGetInstallPrefix();
+    dir <<  wxFILE_SEP_PATH << wxT("share") << wxFILE_SEP_PATH << wxT("wx");
     return dir;
 }
 
@@ -317,12 +320,12 @@ bool wxGetEmailAddress(wxChar *address, int maxSize)
 {
     wxString email = wxGetEmailAddress();
     if ( !email )
-        return FALSE;
+        return false;
 
     wxStrncpy(address, email, maxSize - 1);
     address[maxSize - 1] = wxT('\0');
 
-    return TRUE;
+    return true;
 }
 
 wxString wxGetEmailAddress()
@@ -330,10 +333,10 @@ wxString wxGetEmailAddress()
     wxString email;
 
     wxString host = wxGetFullHostName();
-    if ( !!host )
+    if ( !host.empty() )
     {
         wxString user = wxGetUserId();
-        if ( !!user )
+        if ( !user.empty() )
         {
             email << user << wxT('@') << host;
         }
@@ -442,18 +445,18 @@ wxString wxGetCurrentDir()
 
 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
 //
-// returns TRUE if ok, FALSE if error
+// returns true if ok, false if error
 #if wxUSE_STREAMS
 static bool ReadAll(wxInputStream *is, wxArrayString& output)
 {
-    wxCHECK_MSG( is, FALSE, _T("NULL stream in wxExecute()?") );
+    wxCHECK_MSG( is, false, _T("NULL stream in wxExecute()?") );
 
     // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
     is->Reset();
 
     wxTextInputStream tis(*is);
 
-    bool cont = TRUE;
+    bool cont = true;
     while ( cont )
     {
         wxString line = tis.ReadLine();
@@ -462,7 +465,7 @@ static bool ReadAll(wxInputStream *is, wxArrayString& output)
 
         if ( !*is )
         {
-            cont = FALSE;
+            cont = false;
         }
         else
         {
@@ -479,13 +482,14 @@ static bool ReadAll(wxInputStream *is, wxArrayString& output)
 // public versions of wxExecute() below
 static long wxDoExecuteWithCapture(const wxString& command,
                                    wxArrayString& output,
-                                   wxArrayString* error)
+                                   wxArrayString* error,
+                                   int flags)
 {
     // create a wxProcess which will capture the output
     wxProcess *process = new wxProcess;
     process->Redirect();
 
-    long rc = wxExecute(command, wxEXEC_SYNC, process);
+    long rc = wxExecute(command, wxEXEC_SYNC | flags, process);
 
 #if wxUSE_STREAMS
     if ( rc != -1 )
@@ -500,23 +504,213 @@ static long wxDoExecuteWithCapture(const wxString& command,
         }
 
     }
-#endif // wxUSE_STREAMS
+#else
+    wxUnusedVar(output);
+    wxUnusedVar(error);
+#endif // wxUSE_STREAMS/!wxUSE_STREAMS
 
     delete process;
 
     return rc;
 }
 
-long wxExecute(const wxString& command, wxArrayString& output)
+long wxExecute(const wxString& command, wxArrayString& output, int flags)
 {
-    return wxDoExecuteWithCapture(command, output, NULL);
+    return wxDoExecuteWithCapture(command, output, NULL, flags);
 }
 
 long wxExecute(const wxString& command,
                wxArrayString& output,
-               wxArrayString& error)
+               wxArrayString& error,
+               int flags)
 {
-    return wxDoExecuteWithCapture(command, output, &error);
+    return wxDoExecuteWithCapture(command, output, &error, flags);
+}
+
+// ----------------------------------------------------------------------------
+// Launch default browser
+// ----------------------------------------------------------------------------
+
+bool wxLaunchDefaultBrowser(const wxString& url)
+{
+    wxString finalurl = url;
+
+    //if it isn't a full url, try appending http:// to it
+    if(wxURI(url).IsReference())
+        finalurl = wxString(wxT("http://")) + url;
+
+#if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
+
+    wxString command;
+
+    // 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() )
+    {
+        wxRegKey keyDDE(key, wxT("DDEExec"));
+        if ( keyDDE.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;
+                    }
+                }
+            }
+        }
+    }
+
+    //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)
+    {
+        int nResult; //HINSTANCE error code
+
+#if !defined(__WXWINCE__)
+        // CYGWIN and MINGW may have problems - so load ShellExecute
+        // dynamically
+        typedef HINSTANCE (WINAPI *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)
+        nResult = (int) (*lpShellExecute)(NULL, NULL, finalurl.c_str(),
+                                                       NULL, wxT(""), SW_SHOWNORMAL);
+        // Unload Shell32.dll
+        ::FreeLibrary(hShellDll);
+#else
+        //Windows CE does not have normal ShellExecute - but it has
+        //ShellExecuteEx all the way back to version 1.0
+
+
+        //Set up the SHELLEXECUTEINFO structure to pass to ShellExecuteEx
+        SHELLEXECUTEINFO sei;
+        sei.cbSize = sizeof(SHELLEXECUTEINFO);
+        sei.dwHotKey = 0;
+        sei.fMask = 0;
+        sei.hIcon = NULL;
+        sei.hInstApp = NULL;
+        sei.hkeyClass = NULL;
+        // Not in WinCE
+#if 0
+        sei.hMonitor = NULL;
+#endif
+        sei.hProcess = NULL;
+        sei.hwnd = NULL;
+        sei.lpClass = NULL;
+        sei.lpDirectory = NULL;
+        sei.lpFile = finalurl.c_str();
+        sei.lpIDList = NULL;
+        sei.lpParameters = NULL;
+        sei.lpVerb = TEXT("open");
+        sei.nShow = SW_SHOWNORMAL;
+
+        //Call ShellExecuteEx
+        ShellExecuteEx(&sei);
+
+        //Get error code
+        nResult = (int) sei.hInstApp;
+#endif
+
+        // Hack for Firefox (returns file not found for some reason)
+        // from Angelo Mandato's wxHyperlinksCtrl
+        // HINSTANCE_ERROR == 32 (HINSTANCE_ERROR does not exist on Windows CE)
+        if (nResult <= 32 && nResult != SE_ERR_FNF)
+            return false;
+
+#ifdef __WXDEBUG__
+        // Log something if SE_ERR_FNF happens
+        if(nResult == SE_ERR_FNF)
+            wxLogDebug(wxT("Got SE_ERR_FNF from ShellExecute - maybe FireFox"));
+#endif
+    }
+
+#elif wxUSE_MIMETYPE
+
+    // 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));
+    delete ft;
+
+    if (ok)
+    {
+        if( wxExecute (cmd, wxEXEC_ASYNC) == -1 )
+        {
+            wxLogError(_T("Failed to launch application for wxLaunchDefaultBrowser"));
+            return false;
+        }
+    }
+    else
+    {
+        // fallback to checking for the BROWSER environment variable
+        cmd = wxGetenv(wxT("BROWSER"));
+        if ( cmd.empty() || wxExecute(cmd + wxT(" ") + finalurl) == -1)
+            return false;
+    }
+     
+
+#else // !wxUSE_MIMETYPE && !(WXMSW && wxUSE_NATIVE_CONFIG)
+
+        return false;
+
+#endif
+
+    //success - hopefully
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -530,7 +724,7 @@ bool wxYield()
 
 bool wxYieldIfNeeded()
 {
-    return wxTheApp && wxTheApp->Yield(TRUE);
+    return wxTheApp && wxTheApp->Yield(true);
 }
 
 #endif // wxUSE_BASE
@@ -544,10 +738,13 @@ bool wxYieldIfNeeded()
 // Id generation
 static long wxCurrentId = 100;
 
-long
-wxNewId (void)
+long wxNewId()
 {
-  return wxCurrentId++;
+    // skip the part of IDs space that contains hard-coded values:
+    if (wxCurrentId == wxID_LOWEST)
+        wxCurrentId = wxID_HIGHEST + 1;
+
+    return wxCurrentId++;
 }
 
 long
@@ -652,7 +849,7 @@ wxFindWindowByName (const wxString& name, wxWindow * parent)
     return wxWindow::FindWindowByName( name, parent );
 }
 
-// Returns menu item id or -1 if none.
+// Returns menu item id or wxNOT_FOUND if none.
 int
 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 {
@@ -662,7 +859,7 @@ wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& i
       return menuBar->FindMenuItem (menuString, itemString);
 #endif // wxUSE_MENUS
 
-  return -1;
+  return wxNOT_FOUND;
 }
 
 // Try to find the deepest child that contains 'pt'.
@@ -747,7 +944,14 @@ wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
 int wxMessageBox(const wxString& message, const wxString& caption, long style,
                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 {
-    wxMessageDialog dialog(parent, message, caption, style);
+    long decorated_style = style;
+
+    if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
+    {
+        decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
+    }
+
+    wxMessageDialog dialog(parent, message, caption, decorated_style);
 
     int ans = dialog.ShowModal();
     switch ( ans )
@@ -773,10 +977,18 @@ int wxMessageBox(const wxString& message, const wxString& caption, long style,
 
 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
                         const wxString& defaultValue, wxWindow *parent,
-                        int x, int y, bool WXUNUSED(centre) )
+                        wxCoord x, wxCoord y, bool centre )
 {
     wxString str;
-    wxTextEntryDialog dialog(parent, message, caption, defaultValue, wxOK|wxCANCEL, wxPoint(x, y));
+    long style = wxTextEntryDialogStyle;
+
+    if (centre)
+        style |= wxCENTRE;
+    else
+        style &= ~wxCENTRE;
+
+    wxTextEntryDialog dialog(parent, message, caption, defaultValue, style, wxPoint(x, y));
+
     if (dialog.ShowModal() == wxID_OK)
     {
         str = dialog.GetValue();
@@ -788,11 +1000,19 @@ wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
 wxString wxGetPasswordFromUser(const wxString& message,
                                const wxString& caption,
                                const wxString& defaultValue,
-                               wxWindow *parent)
+                               wxWindow *parent,
+                               wxCoord x, wxCoord y, bool centre )
 {
     wxString str;
-    wxTextEntryDialog dialog(parent, message, caption, defaultValue,
-                             wxOK | wxCANCEL | wxTE_PASSWORD);
+    long style = wxTextEntryDialogStyle;
+
+    if (centre)
+        style |= wxCENTRE;
+    else
+        style &= ~wxCENTRE;
+
+    wxPasswordEntryDialog dialog(parent, message, caption, defaultValue,
+                             style, wxPoint(x, y));
     if ( dialog.ShowModal() == wxID_OK )
     {
         str = dialog.GetValue();
@@ -808,7 +1028,7 @@ wxString wxGetPasswordFromUser(const wxString& message,
 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
 {
     wxColourData data;
-    data.SetChooseFull(TRUE);
+    data.SetChooseFull(true);
     if ( colInit.Ok() )
     {
         data.SetColour((wxColour &)colInit); // const_cast
@@ -928,7 +1148,7 @@ bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
 #ifndef __WXGTK__
 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
 {
-    return TRUE;    // detectable auto-repeat is the only mode MSW supports
+    return true;    // detectable auto-repeat is the only mode MSW supports
 }
 #endif // !wxGTK