src/common/utilscmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        utilscmn.cpp
   3 // Purpose:     Miscellaneous utility functions and classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     29/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
  21 // Some older compilers (such as EMX) cannot handle
  22 // #pragma interface/implementation correctly, iff
  23 // #pragma implementation is used in _two_ translation
  24 // units (as created by e.g. event.cpp compiled for
  25 // libwx_base and event.cpp compiled for libwx_gui_core).
  26 // So we must not use those pragmas for those compilers in
  27 // such files.
  28     #pragma implementation "utils.h"
  29 #endif
  30
  31 // For compilers that support precompilation, includes "wx.h".
  32 #include "wx/wxprec.h"
  33
  34 #ifdef __BORLANDC__
  35     #pragma hdrstop
  36 #endif
  37
  38 #ifndef WX_PRECOMP
  39     #include "wx/app.h"
  40     #include "wx/string.h"
  41     #include "wx/utils.h"
  42     #include "wx/intl.h"
  43     #include "wx/log.h"
  44
  45     #if wxUSE_GUI
  46         #include "wx/window.h"
  47         #include "wx/frame.h"
  48         #include "wx/menu.h"
  49         #include "wx/msgdlg.h"
  50         #include "wx/textdlg.h"
  51         #include "wx/textctrl.h"    // for wxTE_PASSWORD
  52         #if wxUSE_ACCEL
  53             #include "wx/menuitem.h"
  54             #include "wx/accel.h"
  55         #endif // wxUSE_ACCEL
  56     #endif // wxUSE_GUI
  57 #endif // WX_PRECOMP
  58
  59 #include "wx/apptrait.h"
  60
  61 #include "wx/process.h"
  62 #include "wx/txtstrm.h"
  63 #include "wx/uri.h"
  64 #include "wx/mimetype.h"
  65 #include "wx/config.h"
  66
  67 #if defined(__WXWINCE__) && wxUSE_DATETIME
  68 #include "wx/datetime.h"
  69 #endif
  70
  71 #include <ctype.h>
  72 #include <stdio.h>
  73 #include <stdlib.h>
  74 #include <string.h>
  75
  76 #if !defined(__WATCOMC__)
  77     #if !(defined(_MSC_VER) && (_MSC_VER > 800))
  78         #include <errno.h>
  79     #endif
  80 #endif
  81
  82 #if wxUSE_GUI
  83     #include "wx/colordlg.h"
  84     #include "wx/fontdlg.h"
  85     #include "wx/notebook.h"
  86     #include "wx/frame.h"
  87     #include "wx/statusbr.h"
  88 #endif // wxUSE_GUI
  89
  90 #ifndef __WXWINCE__
  91 #include <time.h>
  92 #else
  93 #include "wx/msw/wince/time.h"
  94 #endif
  95
  96 #if !defined(__MWERKS__) && !defined(__WXWINCE__)
  97     #include <sys/types.h>
  98     #include <sys/stat.h>
  99 #endif
 100
 101 #if defined(__WXMSW__)
 102     #include "wx/msw/private.h"
 103 #endif
 104
 105 #if wxUSE_BASE
 106
 107 // ----------------------------------------------------------------------------
 108 // common data
 109 // ----------------------------------------------------------------------------
 110
 111 #if WXWIN_COMPATIBILITY_2_2
 112     const wxChar *wxInternalErrorStr = wxT("wxWidgets Internal Error");
 113     const wxChar *wxFatalErrorStr = wxT("wxWidgets Fatal Error");
 114 #endif // WXWIN_COMPATIBILITY_2_2
 115
 116 // ============================================================================
 117 // implementation
 118 // ============================================================================
 119
 120 #if WXWIN_COMPATIBILITY_2_4
 121
 122 wxChar *
 123 copystring (const wxChar *s)
 124 {
 125     if (s == NULL) s = wxEmptyString;
 126     size_t len = wxStrlen (s) + 1;
 127
 128     wxChar *news = new wxChar[len];
 129     memcpy (news, s, len * sizeof(wxChar));    // Should be the fastest
 130
 131     return news;
 132 }
 133
 134 #endif // WXWIN_COMPATIBILITY_2_4
 135
 136 // ----------------------------------------------------------------------------
 137 // String <-> Number conversions (deprecated)
 138 // ----------------------------------------------------------------------------
 139
 140 #if WXWIN_COMPATIBILITY_2_4
 141
 142 WXDLLIMPEXP_DATA_BASE(const wxChar *) wxFloatToStringStr = wxT("%.2f");
 143 WXDLLIMPEXP_DATA_BASE(const wxChar *) wxDoubleToStringStr = wxT("%.2f");
 144
 145 void
 146 StringToFloat (const wxChar *s, float *number)
 147 {
 148     if (s && *s && number)
 149         *number = (float) wxStrtod (s, (wxChar **) NULL);
 150 }
 151
 152 void
 153 StringToDouble (const wxChar *s, double *number)
 154 {
 155     if (s && *s && number)
 156         *number = wxStrtod (s, (wxChar **) NULL);
 157 }
 158
 159 wxChar *
 160 FloatToString (float number, const wxChar *fmt)
 161 {
 162     static wxChar buf[256];
 163
 164     wxSprintf (buf, fmt, number);
 165     return buf;
 166 }
 167
 168 wxChar *
 169 DoubleToString (double number, const wxChar *fmt)
 170 {
 171     static wxChar buf[256];
 172
 173     wxSprintf (buf, fmt, number);
 174     return buf;
 175 }
 176
 177 void
 178 StringToInt (const wxChar *s, int *number)
 179 {
 180     if (s && *s && number)
 181         *number = (int) wxStrtol (s, (wxChar **) NULL, 10);
 182 }
 183
 184 void
 185 StringToLong (const wxChar *s, long *number)
 186 {
 187     if (s && *s && number)
 188         *number = wxStrtol (s, (wxChar **) NULL, 10);
 189 }
 190
 191 wxChar *
 192 IntToString (int number)
 193 {
 194     static wxChar buf[20];
 195
 196     wxSprintf (buf, wxT("%d"), number);
 197     return buf;
 198 }
 199
 200 wxChar *
 201 LongToString (long number)
 202 {
 203     static wxChar buf[20];
 204
 205     wxSprintf (buf, wxT("%ld"), number);
 206     return buf;
 207 }
 208
 209 #endif // WXWIN_COMPATIBILITY_2_4
 210
 211 // Array used in DecToHex conversion routine.
 212 static wxChar hexArray[] = wxT("0123456789ABCDEF");
 213
 214 // Convert 2-digit hex number to decimal
 215 int wxHexToDec(const wxString& buf)
 216 {
 217     int firstDigit, secondDigit;
 218
 219     if (buf.GetChar(0) >= wxT('A'))
 220         firstDigit = buf.GetChar(0) - wxT('A') + 10;
 221     else
 222        firstDigit = buf.GetChar(0) - wxT('0');
 223
 224     if (buf.GetChar(1) >= wxT('A'))
 225         secondDigit = buf.GetChar(1) - wxT('A') + 10;
 226     else
 227         secondDigit = buf.GetChar(1) - wxT('0');
 228
 229     return (firstDigit & 0xF) * 16 + (secondDigit & 0xF );
 230 }
 231
 232 // Convert decimal integer to 2-character hex string
 233 void wxDecToHex(int dec, wxChar *buf)
 234 {
 235     int firstDigit = (int)(dec/16.0);
 236     int secondDigit = (int)(dec - (firstDigit*16.0));
 237     buf[0] = hexArray[firstDigit];
 238     buf[1] = hexArray[secondDigit];
 239     buf[2] = 0;
 240 }
 241
 242 // Convert decimal integer to 2-character hex string
 243 wxString wxDecToHex(int dec)
 244 {
 245     wxChar buf[3];
 246     wxDecToHex(dec, buf);
 247     return wxString(buf);
 248 }
 249
 250 // ----------------------------------------------------------------------------
 251 // misc functions
 252 // ----------------------------------------------------------------------------
 253
 254 // Return the current date/time
 255 wxString wxNow()
 256 {
 257 #ifdef __WXWINCE__
 258 #if wxUSE_DATETIME
 259     wxDateTime now = wxDateTime::Now();
 260     return now.Format();
 261 #else
 262     return wxEmptyString;
 263 #endif
 264 #else
 265     time_t now = time((time_t *) NULL);
 266     char *date = ctime(&now);
 267     date[24] = '\0';
 268     return wxString::FromAscii(date);
 269 #endif
 270 }
 271
 272 void wxUsleep(unsigned long milliseconds)
 273 {
 274     wxMilliSleep(milliseconds);
 275 }
 276
 277 const wxChar *wxGetInstallPrefix()
 278 {
 279     wxString prefix;
 280
 281     if ( wxGetEnv(wxT("WXPREFIX"), &prefix) )
 282         return prefix.c_str();
 283
 284 #ifdef wxINSTALL_PREFIX
 285     return wxT(wxINSTALL_PREFIX);
 286 #else
 287     return wxEmptyString;
 288 #endif
 289 }
 290
 291 wxString wxGetDataDir()
 292 {
 293     wxString dir = wxGetInstallPrefix();
 294     dir <<  wxFILE_SEP_PATH << wxT("share") << wxFILE_SEP_PATH << wxT("wx");
 295     return dir;
 296 }
 297
 298 int wxGetOsVersion(int *verMaj, int *verMin)
 299 {
 300     // we want this function to work even if there is no wxApp
 301     wxConsoleAppTraits traitsConsole;
 302     wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
 303     if ( ! traits )
 304         traits = &traitsConsole;
 305
 306     wxToolkitInfo& info = traits->GetToolkitInfo();
 307     if ( verMaj )
 308         *verMaj = info.versionMajor;
 309     if ( verMin )
 310         *verMin = info.versionMinor;
 311     return info.os;
 312 }
 313
 314 // ----------------------------------------------------------------------------
 315 // network and user id functions
 316 // ----------------------------------------------------------------------------
 317
 318 // Get Full RFC822 style email address
 319 bool wxGetEmailAddress(wxChar *address, int maxSize)
 320 {
 321     wxString email = wxGetEmailAddress();
 322     if ( !email )
 323         return false;
 324
 325     wxStrncpy(address, email, maxSize - 1);
 326     address[maxSize - 1] = wxT('\0');
 327
 328     return true;
 329 }
 330
 331 wxString wxGetEmailAddress()
 332 {
 333     wxString email;
 334
 335     wxString host = wxGetFullHostName();
 336     if ( !host.empty() )
 337     {
 338         wxString user = wxGetUserId();
 339         if ( !user.empty() )
 340         {
 341             email << user << wxT('@') << host;
 342         }
 343     }
 344
 345     return email;
 346 }
 347
 348 wxString wxGetUserId()
 349 {
 350     static const int maxLoginLen = 256; // FIXME arbitrary number
 351
 352     wxString buf;
 353     bool ok = wxGetUserId(wxStringBuffer(buf, maxLoginLen), maxLoginLen);
 354
 355     if ( !ok )
 356         buf.Empty();
 357
 358     return buf;
 359 }
 360
 361 wxString wxGetUserName()
 362 {
 363     static const int maxUserNameLen = 1024; // FIXME arbitrary number
 364
 365     wxString buf;
 366     bool ok = wxGetUserName(wxStringBuffer(buf, maxUserNameLen), maxUserNameLen);
 367
 368     if ( !ok )
 369         buf.Empty();
 370
 371     return buf;
 372 }
 373
 374 wxString wxGetHostName()
 375 {
 376     static const size_t hostnameSize = 257;
 377
 378     wxString buf;
 379     bool ok = wxGetHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
 380
 381     if ( !ok )
 382         buf.Empty();
 383
 384     return buf;
 385 }
 386
 387 wxString wxGetFullHostName()
 388 {
 389     static const size_t hostnameSize = 257;
 390
 391     wxString buf;
 392     bool ok = wxGetFullHostName(wxStringBuffer(buf, hostnameSize), hostnameSize);
 393
 394     if ( !ok )
 395         buf.Empty();
 396
 397     return buf;
 398 }
 399
 400 wxString wxGetHomeDir()
 401 {
 402     wxString home;
 403     wxGetHomeDir(&home);
 404
 405     return home;
 406 }
 407
 408 #if 0
 409
 410 wxString wxGetCurrentDir()
 411 {
 412     wxString dir;
 413     size_t len = 1024;
 414     bool ok;
 415     do
 416     {
 417         ok = getcwd(dir.GetWriteBuf(len + 1), len) != NULL;
 418         dir.UngetWriteBuf();
 419
 420         if ( !ok )
 421         {
 422             if ( errno != ERANGE )
 423             {
 424                 wxLogSysError(_T("Failed to get current directory"));
 425
 426                 return wxEmptyString;
 427             }
 428             else
 429             {
 430                 // buffer was too small, retry with a larger one
 431                 len *= 2;
 432             }
 433         }
 434         //else: ok
 435     } while ( !ok );
 436
 437     return dir;
 438 }
 439
 440 #endif // 0
 441
 442 // ----------------------------------------------------------------------------
 443 // wxExecute
 444 // ----------------------------------------------------------------------------
 445
 446 // wxDoExecuteWithCapture() helper: reads an entire stream into one array
 447 //
 448 // returns true if ok, false if error
 449 #if wxUSE_STREAMS
 450 static bool ReadAll(wxInputStream *is, wxArrayString& output)
 451 {
 452     wxCHECK_MSG( is, false, _T("NULL stream in wxExecute()?") );
 453
 454     // the stream could be already at EOF or in wxSTREAM_BROKEN_PIPE state
 455     is->Reset();
 456
 457     wxTextInputStream tis(*is);
 458
 459     bool cont = true;
 460     while ( cont )
 461     {
 462         wxString line = tis.ReadLine();
 463         if ( is->Eof() )
 464             break;
 465
 466         if ( !*is )
 467         {
 468             cont = false;
 469         }
 470         else
 471         {
 472             output.Add(line);
 473         }
 474     }
 475
 476     return cont;
 477 }
 478 #endif // wxUSE_STREAMS
 479
 480 // this is a private function because it hasn't a clean interface: the first
 481 // array is passed by reference, the second by pointer - instead we have 2
 482 // public versions of wxExecute() below
 483 static long wxDoExecuteWithCapture(const wxString& command,
 484                                    wxArrayString& output,
 485                                    wxArrayString* error,
 486                                    int flags)
 487 {
 488     // create a wxProcess which will capture the output
 489     wxProcess *process = new wxProcess;
 490     process->Redirect();
 491
 492     long rc = wxExecute(command, wxEXEC_SYNC | flags, process);
 493
 494 #if wxUSE_STREAMS
 495     if ( rc != -1 )
 496     {
 497         if ( !ReadAll(process->GetInputStream(), output) )
 498             rc = -1;
 499
 500         if ( error )
 501         {
 502             if ( !ReadAll(process->GetErrorStream(), *error) )
 503                 rc = -1;
 504         }
 505
 506     }
 507 #else
 508     wxUnusedVar(output);
 509     wxUnusedVar(error);
 510 #endif // wxUSE_STREAMS/!wxUSE_STREAMS
 511
 512     delete process;
 513
 514     return rc;
 515 }
 516
 517 long wxExecute(const wxString& command, wxArrayString& output, int flags)
 518 {
 519     return wxDoExecuteWithCapture(command, output, NULL, flags);
 520 }
 521
 522 long wxExecute(const wxString& command,
 523                wxArrayString& output,
 524                wxArrayString& error,
 525                int flags)
 526 {
 527     return wxDoExecuteWithCapture(command, output, &error, flags);
 528 }
 529
 530 // ----------------------------------------------------------------------------
 531 // Launch default browser
 532 // ----------------------------------------------------------------------------
 533
 534 bool wxLaunchDefaultBrowser(const wxString& url)
 535 {
 536     bool success = true;
 537
 538     wxString finalurl = url;
 539
 540     //if it isn't a full url, try appending http:// to it
 541     if(wxURI(url).IsReference())
 542         finalurl = wxString(wxT("http://")) + url;
 543
 544 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
 545
 546     wxString command;
 547
 548     // ShellExecute() always opens in the same window,
 549     // so do it manually for new window (from Mahogany)
 550     wxRegKey key(wxRegKey::HKCR, url.BeforeFirst(':') + wxT("\\shell\\open"));
 551     if ( key.Exists() )
 552     {
 553         wxRegKey keyDDE(key, wxT("DDEExec"));
 554         if ( keyDDE.Exists() )
 555         {
 556             wxRegKey keyTopic(keyDDE, wxT("topic"));
 557             wxString ddeTopic = keyTopic.QueryDefaultValue();
 558
 559             // we only know the syntax of WWW_OpenURL DDE request
 560             if ( ddeTopic == wxT("WWW_OpenURL") )
 561             {
 562                 wxString ddeCmd = keyDDE.QueryDefaultValue();
 563
 564                 // this is a bit naive but should work as -1 can't appear
 565                 // elsewhere in the DDE topic, normally
 566                 if ( ddeCmd.Replace(wxT("-1"), wxT("0"),
 567                                     false /* only first occurence */) == 1 )
 568                 {
 569                     // and also replace the parameters
 570                     if ( ddeCmd.Replace(wxT("%1"), url, false) == 1 )
 571                     {
 572                         // magic incantation understood by wxMSW
 573                         command << wxT("WX_DDE#")
 574                                 << wxRegKey(key, wxT("command")).QueryDefaultValue() << wxT('#')
 575                                 << wxRegKey(keyDDE, wxT("application")).QueryDefaultValue()
 576                                 << wxT('#') << ddeTopic << wxT('#')
 577                                 << ddeCmd;
 578                     }
 579                 }
 580             }
 581         }
 582     }
 583
 584     //Try wxExecute - if it doesn't work or the regkey stuff
 585     //above failed, fallback to opening the file in the same
 586     //browser window
 587     if ( command.empty() || wxExecute(command) == -1)
 588     {
 589         int nResult; //HINSTANCE error code
 590
 591 #if !defined(__WXWINCE__)
 592         // CYGWIN and MINGW may have problems - so load ShellExecute
 593         // dynamically
 594         typedef HINSTANCE (WINAPI *LPShellExecute)(HWND hwnd, const wxChar* lpOperation,
 595                                             const wxChar* lpFile,
 596                                             const wxChar* lpParameters,
 597                                             const wxChar* lpDirectory,
 598                                             INT nShowCmd);
 599
 600         HINSTANCE hShellDll = ::LoadLibrary(wxT("shell32.dll"));
 601         if(hShellDll == NULL)
 602             return false;
 603
 604         LPShellExecute lpShellExecute =
 605             (LPShellExecute) ::GetProcAddress(hShellDll,
 606             wxString::Format(wxT("ShellExecute%s"),
 607
 608 #if wxUSE_UNICODE
 609             wxT("W")
 610 #else
 611             wxT("A")
 612 #endif
 613 #ifdef __WXWINCE__
 614                              )
 615 #else
 616                              ).mb_str(wxConvLocal)
 617 #endif
 618                              );
 619         if(lpShellExecute == NULL)
 620             return false;
 621
 622         // Windows sometimes doesn't open the browser correctly when using mime
 623         // types, so do ShellExecute - i.e. start <url> (from James Carroll)
 624         nResult = (int) (*lpShellExecute)(NULL, NULL, finalurl.c_str(),
 625                                           NULL, wxT(""), SW_SHOWNORMAL);
 626         // Unload Shell32.dll
 627         ::FreeLibrary(hShellDll);
 628 #else
 629         //Windows CE does not have normal ShellExecute - but it has
 630         //ShellExecuteEx all the way back to version 1.0
 631
 632
 633         //Set up the SHELLEXECUTEINFO structure to pass to ShellExecuteEx
 634         SHELLEXECUTEINFO sei;
 635         sei.cbSize = sizeof(SHELLEXECUTEINFO);
 636         sei.dwHotKey = 0;
 637         sei.fMask = 0;
 638         sei.hIcon = NULL;
 639         sei.hInstApp = NULL;
 640         sei.hkeyClass = NULL;
 641         // Not in WinCE
 642 #if 0
 643         sei.hMonitor = NULL;
 644 #endif
 645         sei.hProcess = NULL;
 646         sei.hwnd = NULL;
 647         sei.lpClass = NULL;
 648         sei.lpDirectory = NULL;
 649         sei.lpFile = finalurl.c_str();
 650         sei.lpIDList = NULL;
 651         sei.lpParameters = NULL;
 652         sei.lpVerb = TEXT("open");
 653         sei.nShow = SW_SHOWNORMAL;
 654
 655         //Call ShellExecuteEx
 656         ShellExecuteEx(&sei);
 657
 658         //Get error code
 659         nResult = (int) sei.hInstApp;
 660 #endif
 661
 662         // Hack for Firefox (returns file not found for some reason)
 663         // from Angelo Mandato's wxHyperlinksCtrl
 664         // HINSTANCE_ERROR == 32 (HINSTANCE_ERROR does not exist on Windows CE)
 665         if (nResult <= 32 && nResult != SE_ERR_FNF)
 666             return false;
 667
 668 #ifdef __WXDEBUG__
 669         // Log something if SE_ERR_FNF happens
 670         if(nResult == SE_ERR_FNF)
 671             wxLogDebug(wxT("Got SE_ERR_FNF from ShellExecute - maybe FireFox"));
 672 #endif
 673     }
 674
 675 #elif wxUSE_MIMETYPE
 676
 677     // Non-windows way
 678     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension (_T("html"));
 679     if (!ft)
 680     {
 681         wxLogError(_T("No default application can open .html extension"));
 682         return false;
 683     }
 684
 685     wxString mt;
 686     ft->GetMimeType(&mt);
 687
 688     wxString cmd;
 689     bool ok = ft->GetOpenCommand (&cmd, wxFileType::MessageParameters(finalurl));
 690     delete ft;
 691
 692     if (ok)
 693     {
 694         if( wxExecute (cmd, wxEXEC_ASYNC) == -1 )
 695         {
 696             wxLogError(_T("Failed to launch application for wxLaunchDefaultBrowser"));
 697             return false;
 698         }
 699     }
 700     else
 701     {
 702         // fallback to checking for the BROWSER environment variable
 703         cmd = wxGetenv(wxT("BROWSER"));
 704         if ( cmd.empty() || wxExecute(cmd + wxT(" ") + finalurl) == -1)
 705             return false;
 706     }
 707
 708
 709 #else // !wxUSE_MIMETYPE && !(WXMSW && wxUSE_NATIVE_CONFIG)
 710
 711     success = false;
 712
 713 #endif
 714
 715     //success - hopefully
 716     return success;
 717 }
 718
 719 // ----------------------------------------------------------------------------
 720 // wxApp::Yield() wrappers for backwards compatibility
 721 // ----------------------------------------------------------------------------
 722
 723 bool wxYield()
 724 {
 725     return wxTheApp && wxTheApp->Yield();
 726 }
 727
 728 bool wxYieldIfNeeded()
 729 {
 730     return wxTheApp && wxTheApp->Yield(true);
 731 }
 732
 733 #endif // wxUSE_BASE
 734
 735 // ============================================================================
 736 // GUI-only functions from now on
 737 // ============================================================================
 738
 739 #if wxUSE_GUI
 740
 741 // Id generation
 742 static long wxCurrentId = 100;
 743
 744 long wxNewId()
 745 {
 746     // skip the part of IDs space that contains hard-coded values:
 747     if (wxCurrentId == wxID_LOWEST)
 748         wxCurrentId = wxID_HIGHEST + 1;
 749
 750     return wxCurrentId++;
 751 }
 752
 753 long
 754 wxGetCurrentId(void) { return wxCurrentId; }
 755
 756 void
 757 wxRegisterId (long id)
 758 {
 759   if (id >= wxCurrentId)
 760     wxCurrentId = id + 1;
 761 }
 762
 763 #if wxUSE_MENUS
 764
 765 // ----------------------------------------------------------------------------
 766 // Menu accelerators related functions
 767 // ----------------------------------------------------------------------------
 768
 769 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 770 {
 771     wxString s = wxMenuItem::GetLabelFromText(in);
 772     if ( out )
 773     {
 774         // go smash their buffer if it's not big enough - I love char * params
 775         memcpy(out, s.c_str(), s.length() * sizeof(wxChar));
 776     }
 777     else
 778     {
 779         // MYcopystring - for easier search...
 780         out = new wxChar[s.length() + 1];
 781         wxStrcpy(out, s.c_str());
 782     }
 783
 784     return out;
 785 }
 786
 787 wxString wxStripMenuCodes(const wxString& in)
 788 {
 789     wxString out;
 790
 791     size_t len = in.length();
 792     out.reserve(len);
 793
 794     for ( size_t n = 0; n < len; n++ )
 795     {
 796         wxChar ch = in[n];
 797         if ( ch == _T('&') )
 798         {
 799             // skip it, it is used to introduce the accel char (or to quote
 800             // itself in which case it should still be skipped): note that it
 801             // can't be the last character of the string
 802             if ( ++n == len )
 803             {
 804                 wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
 805             }
 806             else
 807             {
 808                 // use the next char instead
 809                 ch = in[n];
 810             }
 811         }
 812         else if ( ch == _T('\t') )
 813         {
 814             // everything after TAB is accel string, exit the loop
 815             break;
 816         }
 817
 818         out += ch;
 819     }
 820
 821     return out;
 822 }
 823
 824 #endif // wxUSE_MENUS
 825
 826 // ----------------------------------------------------------------------------
 827 // Window search functions
 828 // ----------------------------------------------------------------------------
 829
 830 /*
 831  * If parent is non-NULL, look through children for a label or title
 832  * matching the specified string. If NULL, look through all top-level windows.
 833  *
 834  */
 835
 836 wxWindow *
 837 wxFindWindowByLabel (const wxString& title, wxWindow * parent)
 838 {
 839     return wxWindow::FindWindowByLabel( title, parent );
 840 }
 841
 842
 843 /*
 844  * If parent is non-NULL, look through children for a name
 845  * matching the specified string. If NULL, look through all top-level windows.
 846  *
 847  */
 848
 849 wxWindow *
 850 wxFindWindowByName (const wxString& name, wxWindow * parent)
 851 {
 852     return wxWindow::FindWindowByName( name, parent );
 853 }
 854
 855 // Returns menu item id or wxNOT_FOUND if none.
 856 int
 857 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 858 {
 859 #if wxUSE_MENUS
 860   wxMenuBar *menuBar = frame->GetMenuBar ();
 861   if ( menuBar )
 862       return menuBar->FindMenuItem (menuString, itemString);
 863 #endif // wxUSE_MENUS
 864
 865   return wxNOT_FOUND;
 866 }
 867
 868 // Try to find the deepest child that contains 'pt'.
 869 // We go backwards, to try to allow for controls that are spacially
 870 // within other controls, but are still siblings (e.g. buttons within
 871 // static boxes). Static boxes are likely to be created _before_ controls
 872 // that sit inside them.
 873 wxWindow* wxFindWindowAtPoint(wxWindow* win, const wxPoint& pt)
 874 {
 875     if (!win->IsShown())
 876         return NULL;
 877
 878     // Hack for wxNotebook case: at least in wxGTK, all pages
 879     // claim to be shown, so we must only deal with the selected one.
 880 #if wxUSE_NOTEBOOK
 881     if (win->IsKindOf(CLASSINFO(wxNotebook)))
 882     {
 883       wxNotebook* nb = (wxNotebook*) win;
 884       int sel = nb->GetSelection();
 885       if (sel >= 0)
 886       {
 887         wxWindow* child = nb->GetPage(sel);
 888         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 889         if (foundWin)
 890            return foundWin;
 891       }
 892     }
 893 #endif
 894
 895     wxWindowList::compatibility_iterator node = win->GetChildren().GetLast();
 896     while (node)
 897     {
 898         wxWindow* child = node->GetData();
 899         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 900         if (foundWin)
 901           return foundWin;
 902         node = node->GetPrevious();
 903     }
 904
 905     wxPoint pos = win->GetPosition();
 906     wxSize sz = win->GetSize();
 907     if (win->GetParent())
 908     {
 909         pos = win->GetParent()->ClientToScreen(pos);
 910     }
 911
 912     wxRect rect(pos, sz);
 913     if (rect.Inside(pt))
 914         return win;
 915     else
 916         return NULL;
 917 }
 918
 919 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
 920 {
 921     // Go backwards through the list since windows
 922     // on top are likely to have been appended most
 923     // recently.
 924     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetLast();
 925     while (node)
 926     {
 927         wxWindow* win = node->GetData();
 928         wxWindow* found = wxFindWindowAtPoint(win, pt);
 929         if (found)
 930             return found;
 931         node = node->GetPrevious();
 932     }
 933     return NULL;
 934 }
 935
 936 // ----------------------------------------------------------------------------
 937 // GUI helpers
 938 // ----------------------------------------------------------------------------
 939
 940 /*
 941  * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
 942  * since otherwise the generic code may be pulled in unnecessarily.
 943  */
 944
 945 #if wxUSE_MSGDLG
 946
 947 int wxMessageBox(const wxString& message, const wxString& caption, long style,
 948                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 949 {
 950     long decorated_style = style;
 951
 952     if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
 953     {
 954         decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
 955     }
 956
 957     wxMessageDialog dialog(parent, message, caption, decorated_style);
 958
 959     int ans = dialog.ShowModal();
 960     switch ( ans )
 961     {
 962         case wxID_OK:
 963             return wxOK;
 964         case wxID_YES:
 965             return wxYES;
 966         case wxID_NO:
 967             return wxNO;
 968         case wxID_CANCEL:
 969             return wxCANCEL;
 970     }
 971
 972     wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
 973
 974     return wxCANCEL;
 975 }
 976
 977 #endif // wxUSE_MSGDLG
 978
 979 #if wxUSE_TEXTDLG
 980
 981 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
 982                         const wxString& defaultValue, wxWindow *parent,
 983                         wxCoord x, wxCoord y, bool centre )
 984 {
 985     wxString str;
 986     long style = wxTextEntryDialogStyle;
 987
 988     if (centre)
 989         style |= wxCENTRE;
 990     else
 991         style &= ~wxCENTRE;
 992
 993     wxTextEntryDialog dialog(parent, message, caption, defaultValue, style, wxPoint(x, y));
 994
 995     if (dialog.ShowModal() == wxID_OK)
 996     {
 997         str = dialog.GetValue();
 998     }
 999
1000     return str;
1001 }
1002
1003 wxString wxGetPasswordFromUser(const wxString& message,
1004                                const wxString& caption,
1005                                const wxString& defaultValue,
1006                                wxWindow *parent,
1007                                wxCoord x, wxCoord y, bool centre )
1008 {
1009     wxString str;
1010     long style = wxTextEntryDialogStyle;
1011
1012     if (centre)
1013         style |= wxCENTRE;
1014     else
1015         style &= ~wxCENTRE;
1016
1017     wxPasswordEntryDialog dialog(parent, message, caption, defaultValue,
1018                              style, wxPoint(x, y));
1019     if ( dialog.ShowModal() == wxID_OK )
1020     {
1021         str = dialog.GetValue();
1022     }
1023
1024     return str;
1025 }
1026
1027 #endif // wxUSE_TEXTDLG
1028
1029 #if wxUSE_COLOURDLG
1030
1031 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
1032 {
1033     wxColourData data;
1034     data.SetChooseFull(true);
1035     if ( colInit.Ok() )
1036     {
1037         data.SetColour((wxColour &)colInit); // const_cast
1038     }
1039
1040     wxColour colRet;
1041     wxColourDialog dialog(parent, &data);
1042     if ( dialog.ShowModal() == wxID_OK )
1043     {
1044         colRet = dialog.GetColourData().GetColour();
1045     }
1046     //else: leave it invalid
1047
1048     return colRet;
1049 }
1050
1051 #endif // wxUSE_COLOURDLG
1052
1053 #if wxUSE_FONTDLG
1054
1055 wxFont wxGetFontFromUser(wxWindow *parent, const wxFont& fontInit)
1056 {
1057     wxFontData data;
1058     if ( fontInit.Ok() )
1059     {
1060         data.SetInitialFont(fontInit);
1061     }
1062
1063     wxFont fontRet;
1064     wxFontDialog dialog(parent, data);
1065     if ( dialog.ShowModal() == wxID_OK )
1066     {
1067         fontRet = dialog.GetFontData().GetChosenFont();
1068     }
1069     //else: leave it invalid
1070
1071     return fontRet;
1072 }
1073
1074 #endif // wxUSE_FONTDLG
1075
1076 // ----------------------------------------------------------------------------
1077 // wxSafeYield and supporting functions
1078 // ----------------------------------------------------------------------------
1079
1080 void wxEnableTopLevelWindows(bool enable)
1081 {
1082     wxWindowList::compatibility_iterator node;
1083     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1084         node->GetData()->Enable(enable);
1085 }
1086
1087 wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
1088 {
1089     // remember the top level windows which were already disabled, so that we
1090     // don't reenable them later
1091     m_winDisabled = NULL;
1092
1093     wxWindowList::compatibility_iterator node;
1094     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1095     {
1096         wxWindow *winTop = node->GetData();
1097         if ( winTop == winToSkip )
1098             continue;
1099
1100         // we don't need to disable the hidden or already disabled windows
1101         if ( winTop->IsEnabled() && winTop->IsShown() )
1102         {
1103             winTop->Disable();
1104         }
1105         else
1106         {
1107             if ( !m_winDisabled )
1108             {
1109                 m_winDisabled = new wxWindowList;
1110             }
1111
1112             m_winDisabled->Append(winTop);
1113         }
1114     }
1115 }
1116
1117 wxWindowDisabler::~wxWindowDisabler()
1118 {
1119     wxWindowList::compatibility_iterator node;
1120     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1121     {
1122         wxWindow *winTop = node->GetData();
1123         if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
1124         {
1125             winTop->Enable();
1126         }
1127         //else: had been already disabled, don't reenable
1128     }
1129
1130     delete m_winDisabled;
1131 }
1132
1133 // Yield to other apps/messages and disable user input to all windows except
1134 // the given one
1135 bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
1136 {
1137     wxWindowDisabler wd(win);
1138
1139     bool rc;
1140     if (onlyIfNeeded)
1141         rc = wxYieldIfNeeded();
1142     else
1143         rc = wxYield();
1144
1145     return rc;
1146 }
1147
1148 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1149 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1150 // in utilsgtk.cpp.
1151 #ifndef __WXGTK__
1152 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
1153 {
1154     return true;    // detectable auto-repeat is the only mode MSW supports
1155 }
1156 #endif // !wxGTK
1157
1158 #endif // wxUSE_GUI