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     wxString finalurl = url;
 537
 538     //if it isn't a full url, try appending http:// to it
 539     if(wxURI(url).IsReference())
 540         finalurl = wxString(wxT("http://")) + url;
 541
 542 #if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE
 543
 544     wxString command;
 545
 546     // ShellExecute() always opens in the same window,
 547     // so do it manually for new window (from Mahogany)
 548     wxRegKey key(wxRegKey::HKCR, url.BeforeFirst(':') + wxT("\\shell\\open"));
 549     if ( key.Exists() )
 550     {
 551         wxRegKey keyDDE(key, wxT("DDEExec"));
 552         if ( keyDDE.Exists() )
 553         {
 554             wxString ddeTopic = wxRegKey(keyDDE, wxT("topic"));
 555
 556             // we only know the syntax of WWW_OpenURL DDE request
 557             if ( ddeTopic == wxT("WWW_OpenURL") )
 558             {
 559                 wxString ddeCmd = keyDDE;
 560
 561                 // this is a bit naive but should work as -1 can't appear
 562                 // elsewhere in the DDE topic, normally
 563                 if ( ddeCmd.Replace(wxT("-1"), wxT("0"),
 564                                     false /* only first occurence */) == 1 )
 565                 {
 566                     // and also replace the parameters
 567                     if ( ddeCmd.Replace(wxT("%1"), url, false) == 1 )
 568                     {
 569                         // magic incantation understood by wxMSW
 570                         command << wxT("WX_DDE#")
 571                                 << wxRegKey(key, wxT("command")).QueryDefaultValue() << wxT('#')
 572                                 << wxRegKey(keyDDE, wxT("application")).QueryDefaultValue()
 573                                 << wxT('#') << ddeTopic << wxT('#')
 574                                 << ddeCmd;
 575                     }
 576                 }
 577             }
 578         }
 579     }
 580
 581     //Try wxExecute - if it doesn't work or the regkey stuff
 582     //above failed, fallback to opening the file in the same
 583     //browser window
 584     if ( command.empty() || wxExecute(command) == -1)
 585     {
 586         int nResult; //HINSTANCE error code
 587
 588 #if !defined(__WXWINCE__)
 589         // CYGWIN and MINGW may have problems - so load ShellExecute
 590         // dynamically
 591         typedef HINSTANCE (WINAPI *LPShellExecute)(HWND hwnd, const wxChar* lpOperation,
 592                                             const wxChar* lpFile,
 593                                             const wxChar* lpParameters,
 594                                             const wxChar* lpDirectory,
 595                                             INT nShowCmd);
 596
 597         HINSTANCE hShellDll = ::LoadLibrary(wxT("shell32.dll"));
 598         if(hShellDll == NULL)
 599             return false;
 600
 601         LPShellExecute lpShellExecute =
 602             (LPShellExecute) ::GetProcAddress(hShellDll,
 603             wxString::Format(wxT("ShellExecute%s"),
 604
 605 #ifdef __WXUNICODE__
 606             wxT("W")
 607 #else
 608             wxT("A")
 609 #endif
 610 #ifdef __WXWINCE__
 611                              )
 612 #else
 613                              ).mb_str(wxConvLocal)
 614 #endif
 615                              );
 616         if(lpShellExecute == NULL)
 617             return false;
 618
 619         // Windows sometimes doesn't open the browser correctly when using mime
 620         // types, so do ShellExecute - i.e. start <url> (from James Carroll)
 621         nResult = (int) (*lpShellExecute)(NULL, NULL, finalurl.c_str(),
 622                                                        NULL, wxT(""), SW_SHOWNORMAL);
 623         // Unload Shell32.dll
 624         ::FreeLibrary(hShellDll);
 625 #else
 626         //Windows CE does not have normal ShellExecute - but it has
 627         //ShellExecuteEx all the way back to version 1.0
 628
 629
 630         //Set up the SHELLEXECUTEINFO structure to pass to ShellExecuteEx
 631         SHELLEXECUTEINFO sei;
 632         sei.cbSize = sizeof(SHELLEXECUTEINFO);
 633         sei.dwHotKey = 0;
 634         sei.fMask = 0;
 635         sei.hIcon = NULL;
 636         sei.hInstApp = NULL;
 637         sei.hkeyClass = NULL;
 638         // Not in WinCE
 639 #if 0
 640         sei.hMonitor = NULL;
 641 #endif
 642         sei.hProcess = NULL;
 643         sei.hwnd = NULL;
 644         sei.lpClass = NULL;
 645         sei.lpDirectory = NULL;
 646         sei.lpFile = finalurl.c_str();
 647         sei.lpIDList = NULL;
 648         sei.lpParameters = NULL;
 649         sei.lpVerb = TEXT("open");
 650         sei.nShow = SW_SHOWNORMAL;
 651
 652         //Call ShellExecuteEx
 653         ShellExecuteEx(&sei);
 654
 655         //Get error code
 656         nResult = (int) sei.hInstApp;
 657 #endif
 658
 659         // Hack for Firefox (returns file not found for some reason)
 660         // from Angelo Mandato's wxHyperlinksCtrl
 661         // HINSTANCE_ERROR == 32 (HINSTANCE_ERROR does not exist on Windows CE)
 662         if (nResult <= 32 && nResult != SE_ERR_FNF)
 663             return false;
 664
 665 #ifdef __WXDEBUG__
 666         // Log something if SE_ERR_FNF happens
 667         if(nResult == SE_ERR_FNF)
 668             wxLogDebug(wxT("Got SE_ERR_FNF from ShellExecute - maybe FireFox"));
 669 #endif
 670     }
 671
 672 #elif wxUSE_MIMETYPE
 673
 674     // Non-windows way
 675     wxFileType *ft = wxTheMimeTypesManager->GetFileTypeFromExtension (_T("html"));
 676     if (!ft)
 677     {
 678         wxLogError(_T("No default application can open .html extension"));
 679         return false;
 680     }
 681
 682     wxString mt;
 683     ft->GetMimeType(&mt);
 684
 685     wxString cmd;
 686     bool ok = ft->GetOpenCommand (&cmd, wxFileType::MessageParameters(finalurl));
 687     delete ft;
 688
 689     if (ok)
 690     {
 691         if( wxExecute (cmd, wxEXEC_ASYNC) == -1 )
 692         {
 693             wxLogError(_T("Failed to launch application for wxLaunchDefaultBrowser"));
 694             return false;
 695         }
 696     }
 697     else
 698     {
 699         // fallback to checking for the BROWSER environment variable
 700         cmd = wxGetenv(wxT("BROWSER"));
 701         if ( cmd.empty() || wxExecute(cmd + wxT(" ") + finalurl) == -1)
 702             return false;
 703     }
 704
 705
 706 #else // !wxUSE_MIMETYPE && !(WXMSW && wxUSE_NATIVE_CONFIG)
 707
 708         return false;
 709
 710 #endif
 711
 712     //success - hopefully
 713     return true;
 714 }
 715
 716 // ----------------------------------------------------------------------------
 717 // wxApp::Yield() wrappers for backwards compatibility
 718 // ----------------------------------------------------------------------------
 719
 720 bool wxYield()
 721 {
 722     return wxTheApp && wxTheApp->Yield();
 723 }
 724
 725 bool wxYieldIfNeeded()
 726 {
 727     return wxTheApp && wxTheApp->Yield(true);
 728 }
 729
 730 #endif // wxUSE_BASE
 731
 732 // ============================================================================
 733 // GUI-only functions from now on
 734 // ============================================================================
 735
 736 #if wxUSE_GUI
 737
 738 // Id generation
 739 static long wxCurrentId = 100;
 740
 741 long wxNewId()
 742 {
 743     // skip the part of IDs space that contains hard-coded values:
 744     if (wxCurrentId == wxID_LOWEST)
 745         wxCurrentId = wxID_HIGHEST + 1;
 746
 747     return wxCurrentId++;
 748 }
 749
 750 long
 751 wxGetCurrentId(void) { return wxCurrentId; }
 752
 753 void
 754 wxRegisterId (long id)
 755 {
 756   if (id >= wxCurrentId)
 757     wxCurrentId = id + 1;
 758 }
 759
 760 #if wxUSE_MENUS
 761
 762 // ----------------------------------------------------------------------------
 763 // Menu accelerators related functions
 764 // ----------------------------------------------------------------------------
 765
 766 wxChar *wxStripMenuCodes(const wxChar *in, wxChar *out)
 767 {
 768     wxString s = wxMenuItem::GetLabelFromText(in);
 769     if ( out )
 770     {
 771         // go smash their buffer if it's not big enough - I love char * params
 772         memcpy(out, s.c_str(), s.length() * sizeof(wxChar));
 773     }
 774     else
 775     {
 776         // MYcopystring - for easier search...
 777         out = new wxChar[s.length() + 1];
 778         wxStrcpy(out, s.c_str());
 779     }
 780
 781     return out;
 782 }
 783
 784 wxString wxStripMenuCodes(const wxString& in)
 785 {
 786     wxString out;
 787
 788     size_t len = in.length();
 789     out.reserve(len);
 790
 791     for ( size_t n = 0; n < len; n++ )
 792     {
 793         wxChar ch = in[n];
 794         if ( ch == _T('&') )
 795         {
 796             // skip it, it is used to introduce the accel char (or to quote
 797             // itself in which case it should still be skipped): note that it
 798             // can't be the last character of the string
 799             if ( ++n == len )
 800             {
 801                 wxLogDebug(_T("Invalid menu string '%s'"), in.c_str());
 802             }
 803             else
 804             {
 805                 // use the next char instead
 806                 ch = in[n];
 807             }
 808         }
 809         else if ( ch == _T('\t') )
 810         {
 811             // everything after TAB is accel string, exit the loop
 812             break;
 813         }
 814
 815         out += ch;
 816     }
 817
 818     return out;
 819 }
 820
 821 #endif // wxUSE_MENUS
 822
 823 // ----------------------------------------------------------------------------
 824 // Window search functions
 825 // ----------------------------------------------------------------------------
 826
 827 /*
 828  * If parent is non-NULL, look through children for a label or title
 829  * matching the specified string. If NULL, look through all top-level windows.
 830  *
 831  */
 832
 833 wxWindow *
 834 wxFindWindowByLabel (const wxString& title, wxWindow * parent)
 835 {
 836     return wxWindow::FindWindowByLabel( title, parent );
 837 }
 838
 839
 840 /*
 841  * If parent is non-NULL, look through children for a name
 842  * matching the specified string. If NULL, look through all top-level windows.
 843  *
 844  */
 845
 846 wxWindow *
 847 wxFindWindowByName (const wxString& name, wxWindow * parent)
 848 {
 849     return wxWindow::FindWindowByName( name, parent );
 850 }
 851
 852 // Returns menu item id or wxNOT_FOUND if none.
 853 int
 854 wxFindMenuItemId (wxFrame * frame, const wxString& menuString, const wxString& itemString)
 855 {
 856 #if wxUSE_MENUS
 857   wxMenuBar *menuBar = frame->GetMenuBar ();
 858   if ( menuBar )
 859       return menuBar->FindMenuItem (menuString, itemString);
 860 #endif // wxUSE_MENUS
 861
 862   return wxNOT_FOUND;
 863 }
 864
 865 // Try to find the deepest child that contains 'pt'.
 866 // We go backwards, to try to allow for controls that are spacially
 867 // within other controls, but are still siblings (e.g. buttons within
 868 // static boxes). Static boxes are likely to be created _before_ controls
 869 // that sit inside them.
 870 wxWindow* wxFindWindowAtPoint(wxWindow* win, const wxPoint& pt)
 871 {
 872     if (!win->IsShown())
 873         return NULL;
 874
 875     // Hack for wxNotebook case: at least in wxGTK, all pages
 876     // claim to be shown, so we must only deal with the selected one.
 877 #if wxUSE_NOTEBOOK
 878     if (win->IsKindOf(CLASSINFO(wxNotebook)))
 879     {
 880       wxNotebook* nb = (wxNotebook*) win;
 881       int sel = nb->GetSelection();
 882       if (sel >= 0)
 883       {
 884         wxWindow* child = nb->GetPage(sel);
 885         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 886         if (foundWin)
 887            return foundWin;
 888       }
 889     }
 890 #endif
 891
 892     wxWindowList::compatibility_iterator node = win->GetChildren().GetLast();
 893     while (node)
 894     {
 895         wxWindow* child = node->GetData();
 896         wxWindow* foundWin = wxFindWindowAtPoint(child, pt);
 897         if (foundWin)
 898           return foundWin;
 899         node = node->GetPrevious();
 900     }
 901
 902     wxPoint pos = win->GetPosition();
 903     wxSize sz = win->GetSize();
 904     if (win->GetParent())
 905     {
 906         pos = win->GetParent()->ClientToScreen(pos);
 907     }
 908
 909     wxRect rect(pos, sz);
 910     if (rect.Inside(pt))
 911         return win;
 912     else
 913         return NULL;
 914 }
 915
 916 wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt)
 917 {
 918     // Go backwards through the list since windows
 919     // on top are likely to have been appended most
 920     // recently.
 921     wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetLast();
 922     while (node)
 923     {
 924         wxWindow* win = node->GetData();
 925         wxWindow* found = wxFindWindowAtPoint(win, pt);
 926         if (found)
 927             return found;
 928         node = node->GetPrevious();
 929     }
 930     return NULL;
 931 }
 932
 933 // ----------------------------------------------------------------------------
 934 // GUI helpers
 935 // ----------------------------------------------------------------------------
 936
 937 /*
 938  * N.B. these convenience functions must be separate from msgdlgg.cpp, textdlgg.cpp
 939  * since otherwise the generic code may be pulled in unnecessarily.
 940  */
 941
 942 #if wxUSE_MSGDLG
 943
 944 int wxMessageBox(const wxString& message, const wxString& caption, long style,
 945                  wxWindow *parent, int WXUNUSED(x), int WXUNUSED(y) )
 946 {
 947     long decorated_style = style;
 948
 949     if ( ( style & ( wxICON_EXCLAMATION | wxICON_HAND | wxICON_INFORMATION | wxICON_QUESTION ) ) == 0 )
 950     {
 951         decorated_style |= ( style & wxYES ) ? wxICON_QUESTION : wxICON_INFORMATION ;
 952     }
 953
 954     wxMessageDialog dialog(parent, message, caption, decorated_style);
 955
 956     int ans = dialog.ShowModal();
 957     switch ( ans )
 958     {
 959         case wxID_OK:
 960             return wxOK;
 961         case wxID_YES:
 962             return wxYES;
 963         case wxID_NO:
 964             return wxNO;
 965         case wxID_CANCEL:
 966             return wxCANCEL;
 967     }
 968
 969     wxFAIL_MSG( _T("unexpected return code from wxMessageDialog") );
 970
 971     return wxCANCEL;
 972 }
 973
 974 #endif // wxUSE_MSGDLG
 975
 976 #if wxUSE_TEXTDLG
 977
 978 wxString wxGetTextFromUser(const wxString& message, const wxString& caption,
 979                         const wxString& defaultValue, wxWindow *parent,
 980                         wxCoord x, wxCoord y, bool centre )
 981 {
 982     wxString str;
 983     long style = wxTextEntryDialogStyle;
 984
 985     if (centre)
 986         style |= wxCENTRE;
 987     else
 988         style &= ~wxCENTRE;
 989
 990     wxTextEntryDialog dialog(parent, message, caption, defaultValue, style, wxPoint(x, y));
 991
 992     if (dialog.ShowModal() == wxID_OK)
 993     {
 994         str = dialog.GetValue();
 995     }
 996
 997     return str;
 998 }
 999
1000 wxString wxGetPasswordFromUser(const wxString& message,
1001                                const wxString& caption,
1002                                const wxString& defaultValue,
1003                                wxWindow *parent,
1004                                wxCoord x, wxCoord y, bool centre )
1005 {
1006     wxString str;
1007     long style = wxTextEntryDialogStyle;
1008
1009     if (centre)
1010         style |= wxCENTRE;
1011     else
1012         style &= ~wxCENTRE;
1013
1014     wxPasswordEntryDialog dialog(parent, message, caption, defaultValue,
1015                              style, wxPoint(x, y));
1016     if ( dialog.ShowModal() == wxID_OK )
1017     {
1018         str = dialog.GetValue();
1019     }
1020
1021     return str;
1022 }
1023
1024 #endif // wxUSE_TEXTDLG
1025
1026 #if wxUSE_COLOURDLG
1027
1028 wxColour wxGetColourFromUser(wxWindow *parent, const wxColour& colInit)
1029 {
1030     wxColourData data;
1031     data.SetChooseFull(true);
1032     if ( colInit.Ok() )
1033     {
1034         data.SetColour((wxColour &)colInit); // const_cast
1035     }
1036
1037     wxColour colRet;
1038     wxColourDialog dialog(parent, &data);
1039     if ( dialog.ShowModal() == wxID_OK )
1040     {
1041         colRet = dialog.GetColourData().GetColour();
1042     }
1043     //else: leave it invalid
1044
1045     return colRet;
1046 }
1047
1048 #endif // wxUSE_COLOURDLG
1049
1050 #if wxUSE_FONTDLG
1051
1052 wxFont wxGetFontFromUser(wxWindow *parent, const wxFont& fontInit)
1053 {
1054     wxFontData data;
1055     if ( fontInit.Ok() )
1056     {
1057         data.SetInitialFont(fontInit);
1058     }
1059
1060     wxFont fontRet;
1061     wxFontDialog dialog(parent, data);
1062     if ( dialog.ShowModal() == wxID_OK )
1063     {
1064         fontRet = dialog.GetFontData().GetChosenFont();
1065     }
1066     //else: leave it invalid
1067
1068     return fontRet;
1069 }
1070
1071 #endif // wxUSE_FONTDLG
1072
1073 // ----------------------------------------------------------------------------
1074 // wxSafeYield and supporting functions
1075 // ----------------------------------------------------------------------------
1076
1077 void wxEnableTopLevelWindows(bool enable)
1078 {
1079     wxWindowList::compatibility_iterator node;
1080     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1081         node->GetData()->Enable(enable);
1082 }
1083
1084 wxWindowDisabler::wxWindowDisabler(wxWindow *winToSkip)
1085 {
1086     // remember the top level windows which were already disabled, so that we
1087     // don't reenable them later
1088     m_winDisabled = NULL;
1089
1090     wxWindowList::compatibility_iterator node;
1091     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1092     {
1093         wxWindow *winTop = node->GetData();
1094         if ( winTop == winToSkip )
1095             continue;
1096
1097         // we don't need to disable the hidden or already disabled windows
1098         if ( winTop->IsEnabled() && winTop->IsShown() )
1099         {
1100             winTop->Disable();
1101         }
1102         else
1103         {
1104             if ( !m_winDisabled )
1105             {
1106                 m_winDisabled = new wxWindowList;
1107             }
1108
1109             m_winDisabled->Append(winTop);
1110         }
1111     }
1112 }
1113
1114 wxWindowDisabler::~wxWindowDisabler()
1115 {
1116     wxWindowList::compatibility_iterator node;
1117     for ( node = wxTopLevelWindows.GetFirst(); node; node = node->GetNext() )
1118     {
1119         wxWindow *winTop = node->GetData();
1120         if ( !m_winDisabled || !m_winDisabled->Find(winTop) )
1121         {
1122             winTop->Enable();
1123         }
1124         //else: had been already disabled, don't reenable
1125     }
1126
1127     delete m_winDisabled;
1128 }
1129
1130 // Yield to other apps/messages and disable user input to all windows except
1131 // the given one
1132 bool wxSafeYield(wxWindow *win, bool onlyIfNeeded)
1133 {
1134     wxWindowDisabler wd(win);
1135
1136     bool rc;
1137     if (onlyIfNeeded)
1138         rc = wxYieldIfNeeded();
1139     else
1140         rc = wxYield();
1141
1142     return rc;
1143 }
1144
1145 // Don't synthesize KeyUp events holding down a key and producing KeyDown
1146 // events with autorepeat. On by default and always on in wxMSW. wxGTK version
1147 // in utilsgtk.cpp.
1148 #ifndef __WXGTK__
1149 bool wxSetDetectableAutoRepeat( bool WXUNUSED(flag) )
1150 {
1151     return true;    // detectable auto-repeat is the only mode MSW supports
1152 }
1153 #endif // !wxGTK
1154
1155 #endif // wxUSE_GUI
1156